API reference

Note

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

Concepts

• Architecture
  • Frontends
  • Core
  • Backends
  • Audio
  • Mixer
• mopidy.models — Data models
  • Data model relations
  • Data model API
    • Ref
      • Ref.ALBUM
      • Ref.ARTIST
      • Ref.DIRECTORY
      • Ref.PLAYLIST
      • Ref.TRACK
      • Ref.album()
      • Ref.artist()
      • Ref.directory()
      • Ref.name
      • Ref.playlist()
      • Ref.track()
      • Ref.type
      • Ref.uri
    • Track
      • Track.album
      • Track.artists
      • Track.bitrate
      • Track.comment
      • Track.composers
      • Track.date
      • Track.disc_no
      • Track.genre
      • Track.last_modified
      • Track.length
      • Track.musicbrainz_id
      • Track.name
      • Track.performers
      • Track.track_no
      • Track.uri
    • Album
      • Album.artists
      • Album.date
      • Album.musicbrainz_id
      • Album.name
      • Album.num_discs
      • Album.num_tracks
      • Album.uri
    • Artist
      • Artist.musicbrainz_id
      • Artist.name
      • Artist.sortname
      • Artist.uri
    • Playlist
      • Playlist.last_modified
      • Playlist.length
      • Playlist.name
      • Playlist.tracks
      • Playlist.uri
    • Image
      • Image.height
      • Image.uri
      • Image.width
    • TlTrack
      • TlTrack.tlid
      • TlTrack.track
    • SearchResult
      • SearchResult.albums
      • SearchResult.artists
      • SearchResult.tracks
      • SearchResult.uri
  • Data model helpers
    • ImmutableObject
      • ImmutableObject.replace()
    • ValidatedImmutableObject
      • ValidatedImmutableObject.replace()
    • Data model (de)serialization
      • model_json_decoder()
      • ModelJSONEncoder
    • Data model field types
      • Field
      • String
      • Identifier
      • URI
      • Date
      • Integer
      • Collection

Basics

• mopidy.core — Core API
  • Core
    • Core.tracklist
    • Core.playback
    • Core.library
    • Core.playlists
    • Core.mixer
    • Core.history
    • Core.get_uri_schemes()
    • Core.get_version()
  • Tracklist controller
    • TracklistController
    • Manipulating
      • TracklistController.add()
      • TracklistController.remove()
      • TracklistController.clear()
      • TracklistController.move()
      • TracklistController.shuffle()
    • Current state
      • TracklistController.get_tl_tracks()
      • TracklistController.index()
      • TracklistController.get_version()
      • TracklistController.get_length()
      • TracklistController.get_tracks()
      • TracklistController.slice()
      • TracklistController.filter()
    • Future state
      • TracklistController.get_eot_tlid()
      • TracklistController.get_next_tlid()
      • TracklistController.get_previous_tlid()
      • TracklistController.eot_track()
      • TracklistController.next_track()
      • TracklistController.previous_track()
    • Options
      • TracklistController.get_consume()
      • TracklistController.set_consume()
      • TracklistController.get_random()
      • TracklistController.set_random()
      • TracklistController.get_repeat()
      • TracklistController.set_repeat()
      • TracklistController.get_single()
      • TracklistController.set_single()
  • Playback controller
    • PlaybackController
    • Playback control
      • PlaybackController.play()
      • PlaybackController.next()
      • PlaybackController.previous()
      • PlaybackController.stop()
      • PlaybackController.pause()
      • PlaybackController.resume()
      • PlaybackController.seek()
    • Current track
      • PlaybackController.get_current_tl_track()
      • PlaybackController.get_current_track()
      • PlaybackController.get_current_tlid()
      • PlaybackController.get_stream_title()
      • PlaybackController.get_time_position()
    • Playback states
      • PlaybackController.get_state()
      • PlaybackController.set_state()
      • mopidy.core.PlaybackState
        • mopidy.core.PlaybackState.STOPPED
        • mopidy.core.PlaybackState.PLAYING
        • mopidy.core.PlaybackState.PAUSED
  • Library controller
    • mopidy.core.LibraryController
    • LibraryController.browse()
    • LibraryController.search()
    • LibraryController.lookup()
    • LibraryController.refresh()
    • LibraryController.get_images()
    • LibraryController.get_distinct()
  • Playlists controller
    • mopidy.core.PlaylistsController
    • PlaylistsController.get_uri_schemes()
    • Fetching
      • PlaylistsController.as_list()
      • PlaylistsController.get_items()
      • PlaylistsController.lookup()
      • PlaylistsController.refresh()
    • Manipulating
      • PlaylistsController.create()
      • PlaylistsController.save()
      • PlaylistsController.delete()
  • Mixer controller
    • mopidy.core.MixerController
    • MixerController.get_mute()
    • MixerController.set_mute()
    • MixerController.get_volume()
    • MixerController.set_volume()
  • History controller
    • mopidy.core.HistoryController
    • HistoryController.get_history()
    • HistoryController.get_length()
  • 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
  • Frontend implementations
• mopidy.backend — Backend API
  • URIs and routing of requests to the backend
  • Backend class
    • Backend
      • Backend.library
      • Backend.ping()
      • Backend.playback
      • Backend.playlists
      • Backend.uri_schemes
  • 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
    • PlaylistsProvider
      • PlaylistsProvider.as_list()
      • PlaylistsProvider.create()
      • PlaylistsProvider.delete()
      • PlaylistsProvider.get_items()
      • PlaylistsProvider.lookup()
      • PlaylistsProvider.refresh()
      • PlaylistsProvider.save()
  • Library provider
    • LibraryProvider
      • LibraryProvider.browse()
      • LibraryProvider.get_distinct()
      • LibraryProvider.get_images()
      • LibraryProvider.lookup()
      • LibraryProvider.refresh()
      • LibraryProvider.root_directory
      • LibraryProvider.search()
  • Backend listener
    • BackendListener
      • BackendListener.playlists_loaded()
      • BackendListener.send()
  • Backend implementations
• mopidy.ext – Extension API
  • Extension
    • Extension.dist_name
    • Extension.ext_name
    • Extension.get_cache_dir()
    • Extension.get_command()
    • Extension.get_config_dir()
    • Extension.get_config_schema()
    • Extension.get_data_dir()
    • Extension.get_default_config()
    • Extension.setup()
    • Extension.validate_environment()
    • Extension.version
  • ExtensionData
    • ExtensionData.command
    • ExtensionData.config_defaults
    • ExtensionData.config_schema
    • ExtensionData.entry_point
    • ExtensionData.extension
  • Registry
    • Registry.add()
  • load_extensions()
  • validate_extension_data()

Web/JavaScript

• 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

Audio

• mopidy.audio — Audio API
  • Audio
    • Audio.emit_data()
    • 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_appsrc()
    • Audio.set_metadata()
    • 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
    • AudioListener
      • AudioListener.position_changed()
      • AudioListener.reached_end_of_stream()
      • AudioListener.send()
      • AudioListener.state_changed()
      • AudioListener.stream_changed()
      • AudioListener.tags_changed()
  • Audio scanner
    • Scanner
      • Scanner.scan()
  • Audio utils
    • Signals
      • Signals.clear()
      • Signals.connect()
      • Signals.disconnect()
    • calculate_duration()
    • clocktime_to_millisecond()
    • create_buffer()
    • millisecond_to_clocktime()
    • setup_proxy()
    • supported_uri_schemes()
• mopidy.mixer — Audio mixer API
  • Mixer
    • Mixer.get_mute()
    • Mixer.get_volume()
    • Mixer.name
    • Mixer.ping()
    • Mixer.set_mute()
    • Mixer.set_volume()
    • Mixer.trigger_mute_changed()
    • Mixer.trigger_volume_changed()
  • MixerListener
    • MixerListener.mute_changed()
    • MixerListener.send()
    • MixerListener.volume_changed()
  • Mixer implementations

Utilities

• mopidy.commands — Commands API
  • Command
    • Command.add_argument()
    • Command.add_child()
    • Command.exit()
    • Command.format_help()
    • Command.format_usage()
    • Command.parse()
    • Command.run()
    • Command.set()
  • ConfigCommand
    • ConfigCommand.run()
  • DepsCommand
    • DepsCommand.run()
  • RootCommand
    • RootCommand.run()
• mopidy.config — Config API
  • ConfigValue
    • ConfigValue.deserialize()
    • ConfigValue.serialize()
  • Float
    • Float.deserialize()
  • List
    • List.deserialize()
    • List.serialize()
  • Pair
    • Pair.deserialize()
    • Pair.serialize()
  • Config section schemas
    • ConfigSchema
      • ConfigSchema.deserialize()
      • ConfigSchema.serialize()
    • MapConfigSchema
  • Config value types
    • Boolean
      • Boolean.deserialize()
      • Boolean.serialize()
    • ConfigValue
      • ConfigValue.deserialize()
      • ConfigValue.serialize()
    • Deprecated
      • Deprecated.deserialize()
      • Deprecated.serialize()
    • Float
      • Float.deserialize()
    • Hostname
      • Hostname.deserialize()
    • Integer
      • Integer.deserialize()
    • List
      • List.deserialize()
      • List.serialize()
    • LogColor
      • LogColor.deserialize()
      • LogColor.serialize()
    • LogLevel
      • LogLevel.deserialize()
      • LogLevel.serialize()
    • Pair
      • Pair.deserialize()
      • Pair.serialize()
    • Path
      • Path.deserialize()
      • Path.serialize()
    • Port
    • Secret
      • Secret.serialize()
    • String
      • String.deserialize()
      • String.serialize()
  • Config value validators
    • validate_choice()
    • validate_maximum()
    • validate_minimum()
    • validate_required()
• mopidy.httpclient — HTTP Client helpers
  • format_proxy()
  • format_user_agent()
• mopidy.zeroconf — Zeroconf API
  • Zeroconf
    • Zeroconf.publish()
    • Zeroconf.unpublish()