Mopidy
3.12

Usage

  • Installation
  • Running
  • Configuration
  • Clients
  • Troubleshooting

Bundled extensions

  • Mopidy-File
  • Mopidy-M3U
  • Mopidy-Stream
  • Mopidy-HTTP
  • Mopidy-SoftwareMixer

Advanced setups

  • Audio sinks
  • Icecast
  • UPnP

About

  • Changelog
  • History
  • Versioning
  • Authors
  • Sponsors

Development

  • Contributing
  • Development environment
  • Extension development
  • Code style
  • Release procedures

Reference

  • API reference
    • Concepts
      • Architecture
      • mopidy.models --- Data models
    • Basics
      • mopidy.core --- Core API
      • Frontend API
      • mopidy.backend --- Backend API
      • mopidy.ext -- Extension API
    • Web/JavaScript
      • HTTP server side API
      • HTTP JSON-RPC API
      • Mopidy.js JavaScript library
    • Audio
      • mopidy.audio --- Audio API
      • mopidy.mixer --- Audio mixer API
    • Utilities
      • mopidy.commands --- Commands API
      • mopidy.config --- Config API
      • mopidy.httpclient --- HTTP Client helpers
      • mopidy.zeroconf --- Zeroconf API
  • mopidy command
  • Glossary
Mopidy
  • Docs »
  • API reference
  • View page source

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
    • Data model helpers
      • Data model (de)serialization
      • Data model field types

Basics¶

  • mopidy.core --- Core API
    • Tracklist controller
      • Manipulating
      • Current state
      • Future state
      • Options
    • Playback controller
      • Playback control
      • Current track
      • Playback states
    • Library controller
    • Playlists controller
      • Fetching
      • Manipulating
    • Mixer controller
    • History controller
    • Core events
  • Frontend API
    • Frontend implementations
  • mopidy.backend --- Backend API
    • URIs and routing of requests to the backend
    • Backend class
    • Playback provider
    • Playlists provider
    • Library provider
    • Backend listener
    • Backend implementations
  • mopidy.ext -- Extension API

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 listener
    • Audio scanner
    • Audio utils
  • mopidy.mixer --- Audio mixer API
    • Mixer implementations

Utilities¶

  • mopidy.commands --- Commands API
  • mopidy.config --- Config API
    • Config section schemas
    • Config value types
    • Config value validators
  • mopidy.httpclient --- HTTP Client helpers
  • mopidy.zeroconf --- Zeroconf API
Next Previous

© Copyright 2009-2020, Stein Magnus Jodal and contributors

Built with Sphinx using a theme provided by Read the Docs.