Mopidy Documentation

Mopidy Documentation

Release 0.14.2 Stein Magnus Jodal

January 03, 2014

Contents

1 Usage

3

1.1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

1.2 Installation on Raspberry Pi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

1.3 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

1.4 Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

1.5 Running Mopidy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

1.6 Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

1.7 Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

2 About

43

2.1 Authors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

2.2 Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

2.3 Changelog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

2.4 Versioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

3 Development

69

3.1 Contributing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

3.2 Development tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

3.3 Code style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

3.4 Extension development . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

4 Reference

81

4.1 Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

4.2 API reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

4.3 Module reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

5 Indices and tables

139

Python Module Index

141

i

ii

Mopidy Documentation, Release 0.14.2

Mopidy is a music server which can play music both from multiple sources, like your local hard drive, radio streams, and from Spotify and SoundCloud. Searches combines results from all music sources, and you can mix tracks from all sources in your play queue. Your playlists from Spotify or SoundCloud are also available for use. To control your Mopidy music server, you can use one of Mopidy's web clients, the Ubuntu Sound Menu, any device on the same network which can control UPnP MediaRenderers, or any MPD client. MPD clients are available for many platforms, including Windows, OS X, Linux, Android and iOS. To get started with Mopidy, start by reading Installation. If you get stuck, we usually hang around at #mopidy at irc. and also have a mailing list at Google Groups. If you stumble into a bug or got a feature request, please create an issue in the issue tracker. 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.

Contents

1

Mopidy Documentation, Release 0.14.2

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 this page, then have a look at Running Mopidy from Git.

Installation guides ? Debian/Ubuntu: Install from apt. ? Raspberry Pi running Debian ? Vagrant virtual machine running Ubuntu ? Arch Linux: Install from AUR ? OS X: Install from Homebrew and Pip ? Otherwise: Install from source using Pip

1.1.1 Debian/Ubuntu: Install from apt.

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 distribution.

1. Add the archive's GPG key: wget -q -O - | 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 stable main contrib non-free deb-src stable main contrib non-free For the lazy, you can simply run the following command to create /etc/apt/sources.list.d/mopidy.list:

3

Mopidy Documentation, Release 0.14.2

sudo wget -q -O /etc/apt/sources.list.d/mopidy.list

3. Install Mopidy and all dependencies: sudo apt-get update sudo apt-get install mopidy

4. 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

Raspberry Pi running Debian

Fred Hatfull has created a guide for installing a Raspberry Pi from scratch with Debian and Mopidy. See Installation on Raspberry Pi.

Vagrant virtual machine running Ubuntu

Paul Sturgess has created a Vagrant and Chef setup that automatically creates and sets up a virtual machine which runs Mopidy. Check out if you're interested in trying it out.

1.1.2 Arch Linux: Install from AUR

If you are running Arch Linux, you can install the latest release of Mopidy using the mopidy-git package found in AUR. The package installs from the master branch of the Mopidy Git repo, which always corresponds to the latest release.

1. To install Mopidy with GStreamer, libspotify and pyspotify, you can use packer, yaourt, or do it by hand like this: wget tar xf mopidy-git.tar.gz cd mopidy-git/ makepkg -si

To upgrade Mopidy to future releases, just rerun makepkg. 2. Optional: If you want to scrobble your played tracks to Last.fm, you need to install python2-pylast from AUR. 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 and Pip

If you are running OS X, you can install everything needed with Homebrew and Pip. 1. Install Homebrew. If you are already using Homebrew, make sure your installation is up to date before you continue: brew update brew upgrade

4

Chapter 1. Usage

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download