Mopidy Documentation Release 0.19.5 Stein Magnus Jodal and contributors September 07, 2015 Contents 1 Usage 3 1.1 Installation................................................3 1.2 Configuration............................................... 10 1.3 Running Mopidy............................................. 14 1.4 Troubleshooting............................................. 15 1.5 Debian package............................................. 16 2 Extensions 19 2.1 Mopidy-Local.............................................. 19 2.2 Mopidy-Stream.............................................. 20 2.3 Mopidy-HTTP.............................................. 21 2.4 Mopidy-MPD.............................................. 22 2.5 Mopidy-SoftwareMixer......................................... 24 2.6 Mixer extensions............................................. 24 2.7 Backend extensions........................................... 25 2.8 Frontend extensions........................................... 28 2.9 Web extensions.............................................. 30 3 Clients 35 3.1 HTTP clients............................................... 35 3.2 MPD clients............................................... 35 3.3 MPRIS clients.............................................. 46 3.4 UPnP clients............................................... 47 4 About 51 4.1 Authors.................................................. 51 4.2 Sponsors................................................. 52 4.3 Changelog................................................ 53 4.4 Versioning................................................ 89 5 Development 91 5.1 Contributing............................................... 91 5.2 Development tools............................................ 93 5.3 Code style................................................ 96 5.4 Extension development.......................................... 97 6 Reference 105 6.1 Glossary................................................. 105 6.2 mopidy command............................................ 105 i 6.3 API reference............................................... 107 6.4 Module reference............................................. 151 7 Indices and tables 173 Python Module Index 175 ii Mopidy Documentation, Release 0.19.5 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 range of MPD and web clients. Stream music from the cloud Vanilla Mopidy only plays music from your local disk 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 MPD and HTTP server. Additional frontends for controlling Mopidy can be installed from extensions. Everybody use their 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 a popular device to run Mopidy on, either using Raspbian or Arch Linux. It is quite slow, but it is very affordable. In fact, the Kickstarter funded Gramofon: Modern Cloud Jukebox project used Mopidy on a Raspberry Pi to prototype the Gramofon device. Mopidy is also a major 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 makes Mopidy perfect for building your own hacks. In one project, 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, start by reading Installation. Getting help If you get stuck, you can get help at the Mopidy discussion forum. We also hang around at IRC on the #mopidy channel at irc.freenode.net. The IRC channel has public searchable logs. 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 at IRC first. The source code may also be of help. If you want to stay up to date on Mopidy developments, you can follow @mopidy on Twitter. There’s also a mailing list used for announcements related to Mopidy and Mopidy extensions. Contents 1 Mopidy Documentation, Release 0.19.5 2 Contents CHAPTER 1 Usage 1.1 Installation There are several ways to install Mopidy. What way is best depends upon your OS and/or distribution. If you want to contribute to the development of Mopidy, you should first read the general installation instructions, then have a look at Running Mopidy from Git. 1.1.1 Debian/Ubuntu: Install from apt.mopidy.com If you run a Debian based Linux distribution, like Ubuntu, the easiest way to install Mopidy is from the Mopidy APT archive. When installing from the APT archive, you will automatically get updates to Mopidy in the same way as you get updates to the rest of your system. If you’re on a Raspberry Pi running Debian or Raspbian, the following instructions should work for you as well. If you’re setting up a Raspberry Pi from scratch, we have a guide for installing Debian/Raspbian and Mopidy. See Raspberry Pi: Mopidy on a credit card. Note: The packages should work with: • Debian stable and testing, • Raspbian stable and testing, • Ubuntu 14.04 LTS and later. Some of the packages, including the core “mopidy” packages, does not work on Ubuntu 12.04 LTS. This is just what we currently support, not a promise to continue to support the same in the future. We will drop support for older distributions when supporting those stops us from moving forward with the project. 1. Add the archive’s GPG key: wget -q -O - https://apt.mopidy.com/mopidy.gpg | sudo apt-key add - 2. Add the following to /etc/apt/sources.list, or if you have the directory /etc/apt/sources.list.d/, add it to a file called mopidy.list in that directory: # Mopidy APT archive deb http://apt.mopidy.com/ stable main contrib non-free deb-src http://apt.mopidy.com/ stable main contrib non-free 3 Mopidy Documentation, Release 0.19.5 For the lazy, you can simply run the following command to create /etc/apt/sources.list.d/mopidy.list: sudo wget -q -O /etc/apt/sources.list.d/mopidy.list https://apt.mopidy.com/mopidy.list 3. Install Mopidy and all dependencies: sudo apt-get update sudo apt-get install mopidy 4. Optional: If you want to use any Mopidy extensions, like Spotify support or Last.fm scrobbling, you need to install additional packages. To list all the extensions available from apt.mopidy.com, you can run: apt-cache search mopidy To install one of the listed packages, e.g. mopidy-spotify, simply run: sudo apt-get install mopidy-spotify For a full list of available Mopidy extensions, including those not installable from apt.mopidy.com, see Exten- sions. 5. Before continuing, make sure you’ve read the Debian package section to learn about the differences between running Mopidy as a system service and manually as your own system user. 6. Finally, you need to set a couple of config values, and then you’re ready to run Mopidy. When a new release of Mopidy is out, and you can’t wait for you system to figure it out for itself, run the following to upgrade right away: sudo apt-get update sudo apt-get dist-upgrade 1.1.2 Arch Linux: Install from AUR If you are running Arch Linux, you can install Mopidy using the mopidy package found in AUR. 1. To install Mopidy with all dependencies, you can use for example yaourt: yaourt -S mopidy To upgrade Mopidy to future releases, just upgrade your system using: yaourt-Syu 2. Optional: If you want to use any Mopidy extensions, like Spotify support or Last.fm scrobbling, AUR also has packages for several Mopidy extensions. For a full list of available Mopidy extensions, including those not installable from AUR, see Extensions. 3. Finally, you need to set a couple of config values, and then you’re ready to run Mopidy. 1.1.3 OS X: Install from Homebrew If you are running OS X, you can install everything needed with Homebrew. 1. Install Xcode command line developer tools. Do this even if you already have Xcode installed: 4 Chapter 1. Usage Mopidy Documentation, Release 0.19.5 xcode-select--install 2. Install XQuartz. This is needed by GStreamer which Mopidy use heavily. 3. Install Homebrew. 4. If you are already using Homebrew, make sure your installation is up to date before you continue: brew update brew upgrade Notice that this will upgrade all software on your system that have been installed with Homebrew. 5. Mopidy works out of box if you have installed Python from Homebrew: brew install python Note: If you want to use the Python version bundled with OS X, you’ll need to include Python packages installed by Homebrew in your PYTHONPATH. If you don’t do this, the mopidy executable will not find its dependencies and will crash. You can either amend your PYTHONPATH permanently, by adding the following