Mopidy Documentation Release 3.2.0-3-gb10f3115 Stein Magnus Jodal and contributors 2021 USAGE 1 Installation 3 1.1 Debian/Ubuntu..............................................3 1.2 Arch Linux................................................4 1.3 Fedora..................................................5 1.4 macOS..................................................6 1.5 Install from PyPI.............................................7 1.6 Raspberry Pi...............................................9 2 Running 11 2.1 Running in a terminal.......................................... 11 2.2 Running as a service........................................... 12 3 Configuration 17 3.1 Configuration file location........................................ 17 3.2 Editing the configuration......................................... 17 3.3 View effective configuration....................................... 17 3.4 Core configuration............................................ 18 3.5 Extension configuration......................................... 21 3.6 Adding new configuration values.................................... 21 4 Clients 23 4.1 Web clients................................................ 23 4.2 MPD clients............................................... 24 4.3 MPRIS clients.............................................. 24 5 Troubleshooting 25 5.1 Getting help............................................... 25 5.2 Show effective configuration....................................... 25 5.3 Show installed dependencies....................................... 25 5.4 Debug logging.............................................. 26 5.5 Track metadata.............................................. 26 5.6 Debugging deadlocks.......................................... 27 5.7 Debugging GStreamer.......................................... 27 6 Mopidy-File 29 6.1 Configuration............................................... 29 7 Mopidy-M3U 31 7.1 Editing playlists............................................. 31 7.2 Configuration............................................... 31 i 8 Mopidy-Stream 33 8.1 Configuration............................................... 33 9 Mopidy-HTTP 35 9.1 Hosting web clients............................................ 35 9.2 Configuration............................................... 35 10 Mopidy-SoftwareMixer 37 10.1 Configuration............................................... 37 11 Audio sinks 39 12 Icecast 41 12.1 Known issues............................................... 42 12.2 Fallback stream.............................................. 42 13 UPnP 43 13.1 UPnP MediaRenderer.......................................... 43 13.2 UPnP clients............................................... 44 14 Changelog 45 14.1 v3.2.0 (2021-07-08)........................................... 45 14.2 v3.1.1 (2020-12-26)........................................... 45 14.3 v3.1.0 (2020-12-16)........................................... 45 14.4 v3.0.2 (2020-04-02)........................................... 46 14.5 v3.0.1 (2019-12-22)........................................... 46 14.6 v3.0.0 (2019-12-22)........................................... 46 15 History 51 15.1 Changelog 2.x series........................................... 51 15.2 Changelog 1.x series........................................... 58 15.3 Changelog 0.x series........................................... 71 16 Versioning 109 16.1 Release schedule............................................. 109 17 Authors 111 18 Sponsors 115 18.1 Discourse................................................. 115 19 Contributing 117 19.1 Asking questions............................................. 117 19.2 Helping users............................................... 117 19.3 Issue guidelines............................................. 117 19.4 Pull request guidelines.......................................... 118 20 Development environment 119 20.1 Initial setup................................................ 120 20.2 Running Mopidy from Git........................................ 123 20.3 Running tests............................................... 123 20.4 Writing documentation.......................................... 125 20.5 Working on extensions.......................................... 126 20.6 Contribution workflow.......................................... 127 ii 21 Extension development 129 21.1 Anatomy of an extension......................................... 129 21.2 cookiecutter project template...................................... 130 21.3 Example README.rst.......................................... 130 21.4 Example setup.py............................................. 131 21.5 Example __init__.py........................................... 132 21.6 Example frontend............................................ 134 21.7 Example backend............................................. 134 21.8 Example command............................................ 135 21.9 Example web application......................................... 135 21.10 Running an extension.......................................... 135 21.11 Python conventions............................................ 135 21.12 Use of Mopidy APIs........................................... 136 21.13 Logging in extensions.......................................... 136 21.14 Making HTTP requests from extensions................................. 136 21.15 Testing extensions............................................ 138 22 Code style 143 23 Release procedures 145 23.1 Releasing extensions........................................... 145 23.2 Releasing Mopidy itself......................................... 146 24 API reference 149 24.1 Concepts................................................. 149 24.2 Basics................................................... 159 24.3 Web/JavaScript.............................................. 181 24.4 Audio................................................... 186 24.5 Utilities.................................................. 192 25 mopidy command 199 25.1 Synopsis................................................. 199 25.2 Description................................................ 199 25.3 Options.................................................. 199 25.4 Built in commands............................................ 200 25.5 Extension commands........................................... 200 25.6 Files................................................... 200 25.7 Examples................................................. 200 25.8 Reporting bugs.............................................. 201 26 Glossary 203 27 Indices and tables 205 Python Module Index 207 Index 209 iii iv Mopidy Documentation, Release 3.2.0-3-gb10f3115 Mopidy is an extensible music server written in Python. Mopidy plays music from local disk, Spotify, SoundCloud, Google Play Music, and more. You edit the playlist from any phone, tablet, or computer using a variety of MPD and web clients. Stream music from the cloud Vanilla Mopidy only plays music from files and radio streams. Through extensions, Mopidy can play music from cloud services like Spotify, SoundCloud, and Google Play Music. With Mopidy’s extension support, backends for new music sources can be easily added. Mopidy is just a server Mopidy is a Python application that runs in a terminal or in the background on Linux computers or Macs that have network connectivity and audio output. Out of the box, Mopidy is an HTTP server. If you install the Mopidy-MPD extension, it becomes an MPD server too. Many additional frontends for controlling Mopidy are available as extensions. Pick your favorite client You and the people around you can all connect their favorite MPD or web client to the Mopidy server to search for music and manage the playlist together. With a browser or MPD client, which is available for all popular operating systems, you can control the music from any phone, tablet, or computer. Mopidy on Raspberry Pi The Raspberry Pi is an popular device to run Mopidy on, either using Raspbian, Ubuntu, or Arch Linux. Pimoroni recommends Mopidy for use with their Pirate Audio audio gear for Raspberry Pi. Mopidy is also a significant building block in the Pi Musicbox integrated audio jukebox system for Raspberry Pi. Mopidy is hackable Mopidy’s extension support and Python, JSON-RPC, and JavaScript APIs make Mopidy a perfect base for your projects. In one hack, a Raspberry Pi was embedded in an old cassette player. The buttons and volume control are wired up with GPIO on the Raspberry Pi, and is used to control playback through a custom Mopidy extension. The cassettes have NFC tags used to select playlists from Spotify. Getting started To get started with Mopidy, begin by reading Installation. Getting help If you get stuck, you can get help at the our Discourse forum or in the #mopidy-users stream on Zulip chat. If you stumble into a bug or have a feature request, please create an issue in the issue tracker. If you’re unsure if it’s a bug or not, ask for help in the forum or the chat first. The source code may also be of help. If you want to stay up to date on Mopidy developments, you can follow the #mopidy-dev stream on Zulip chat or watch out for announcements on the Discourse forum. USAGE 1 Mopidy Documentation, Release 3.2.0-3-gb10f3115 2 USAGE CHAPTER ONE INSTALLATION There are several ways to install Mopidy. What way is best depends upon your operating system and/or distribution: 1.1 Debian/Ubuntu If you run a Debian based Linux distribution, like Ubuntu or Raspbian, the easiest way to install Mopidy