API reference

Warning

API stability

Only APIs documented here are public and open for use by Mopidy extensions. We will change these APIs, but will keep the changelog up to date with all breaking changes.

From Mopidy 1.0 and onwards, we intend to keep these APIs far more stable.

• Architecture and concepts
  • Frontends
  • Core
  • Backends
  • Audio
• Data models
  • Data model relations
  • Data model API
• Backend API
  • URIs and routing of requests to the backend
  • Backend class
  • Playback provider
  • Playlists provider
  • Library provider
  • Backend listener
  • Backend implementations
• Core API
  • Playback controller
  • Tracklist controller
  • Playlists controller
  • Library controller
  • Core listener
• Audio API
  • Audio listener
  • Audio scanner
• Audio mixer API
  • Mixer implementations
• Frontend API
  • Frontend implementations
• Commands API
• Extension API
• Config API
  • Config section schemas
  • Config value types
  • Config value validators
• Zeroconf API
• HTTP server side API
  • Static web client example
  • Tornado application example
  • WSGI application example
  • API implementors
• HTTP JSON-RPC API
  • HTTP POST API
  • WebSocket API
  • JSON-RPC 2.0 messages
  • Event messages
• Mopidy.js JavaScript library
  • Getting the library for browser use
  • Getting the library for Node.js or Browserify use
  • Getting the library for development on the library
  • Creating an instance
  • Hooking up to events
  • Calling core API methods
  • Cleaning up
  • Example to get started with