Reference

Only APIs documented here are public and open for use by Mopidy extensions.

• mopidy command — command-line reference for the mopidy executable.
• Glossary — definitions of terms used throughout the docs.

Concepts

• Architecture — how Mopidy's frontends, core, backends, and audio layer fit together.
• Data models — the immutable data objects passed between all layers of Mopidy.
• Supporting types — enumerations and other types used across the APIs.

Framework APIs

• Core API — the main API used by frontends to control playback, manage the tracklist, and browse libraries.
• Frontend API — the interface for building frontends that react to playback events and control Mopidy.
• Backend API — the interface for building backends that provide music libraries and playback.
• Extension API — how extensions register themselves and expose configuration, actors, and commands.
• Exceptions — exceptions raised by Mopidy's APIs.

Web

• HTTP server side API — how extensions can serve static files or Tornado apps through Mopidy's built-in web server.
• HTTP JSON-RPC API — the JSON-RPC protocol for controlling Mopidy over HTTP and WebSockets.
• Mopidy.js JavaScript library — the official JavaScript client library wrapping the WebSocket API.

Audio

• Audio API — low-level audio playback control for backends.
• Audio mixer API — the interface for building mixer extensions that control volume.

Utilities

• Config API — helpers for declaring and validating extension configuration.
• HTTP client helpers — shared utilities for making HTTP requests from extensions, with proxy support.
• Zeroconf API — helpers for announcing services on the local network via DNS-SD/mDNS.