API reference
Note
Only APIs documented here are public and open for use by Mopidy extensions.
Concepts
Basics
- mopidy.core— Core API- Core
- Tracklist controller
- Playback controller
- Library controller
- Playlists controller
- Mixer controller
- History controller
- Core events- CoreListener- CoreListener.mute_changed()
- CoreListener.on_event()
- CoreListener.options_changed()
- CoreListener.playback_state_changed()
- CoreListener.playlist_changed()
- CoreListener.playlist_deleted()
- CoreListener.playlists_loaded()
- CoreListener.seeked()
- CoreListener.send()
- CoreListener.stream_title_changed()
- CoreListener.track_playback_ended()
- CoreListener.track_playback_paused()
- CoreListener.track_playback_resumed()
- CoreListener.track_playback_started()
- CoreListener.tracklist_changed()
- CoreListener.volume_changed()
 
 
 
- Frontend API
- mopidy.backend— Backend API- URIs and routing of requests to the backend
- Backend class
- Playback provider- PlaybackProvider- PlaybackProvider.change_track()
- PlaybackProvider.get_time_position()
- PlaybackProvider.is_live()
- PlaybackProvider.on_source_setup()
- PlaybackProvider.pause()
- PlaybackProvider.play()
- PlaybackProvider.prepare_change()
- PlaybackProvider.resume()
- PlaybackProvider.seek()
- PlaybackProvider.should_download()
- PlaybackProvider.stop()
- PlaybackProvider.translate_uri()
 
 
- Playlists provider
- Library provider
- Backend listener
- Backend implementations
 
- mopidy.ext– Extension API
Web/JavaScript
Audio
- mopidy.audio— Audio API- Audio- Audio.enable_sync_handler()
- Audio.get_current_tags()
- Audio.get_position()
- Audio.mixer
- Audio.on_start()
- Audio.on_stop()
- Audio.pause_playback()
- Audio.prepare_change()
- Audio.set_about_to_finish_callback()
- Audio.set_position()
- Audio.set_source_setup_callback()
- Audio.set_uri()
- Audio.start_playback()
- Audio.state
- Audio.stop_playback()
- Audio.wait_for_state_change()
 
- Audio listener
- Audio scanner
- Audio utils
 
- mopidy.mixer— Audio mixer API
Utilities
- mopidy.commands— Commands API
- mopidy.config— Config API
- mopidy.httpclient— HTTP Client helpers
- mopidy.zeroconf— Zeroconf API