Mopidy Documentation

177 Pages·2014·2.08 MB·English

Mopidy Documentation
Release 0.19.2
Stein Magnus Jodal and contributors
July26,2014

Contents
1 Usage 3
1.1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.2 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.3 RunningMopidy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
1.4 Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
1.5 Debianpackage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
2 Extensions 19
2.1 Mopidy-Local . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
2.2 Mopidy-Stream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
2.3 Mopidy-HTTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
2.4 Mopidy-MPD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
2.5 Mopidy-SoftwareMixer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
2.6 Mixerextensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
2.7 Backendextensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
2.8 Frontendextensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
2.9 Webextensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
3 Clients 33
3.1 HTTPclients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
3.2 MPDclients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
3.3 MPRISclients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
3.4 UPnPclients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
4 About 51
4.1 Authors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
4.2 Changelog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
4.3 Versioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
5 Development 89
5.1 Contributing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
5.2 Developmenttools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
5.3 Codestyle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
5.4 Extensiondevelopment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
6 Reference 103
6.1 Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
6.2 mopidycommand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
6.3 APIreference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
i
6.4 Modulereference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
7 Indicesandtables 171
PythonModuleIndex 173
ii
MopidyDocumentation,Release0.19.2
Mopidyisamusicserverwhichcanplaymusicbothfrommultiplesources,likeyourlocalharddrive,radiostreams,
andfromSpotifyandSoundCloud. Searchescombinesresultsfromallmusicsources, andyoucanmixtracksfrom
allsourcesinyourplayqueue. YourplaylistsfromSpotifyorSoundCloudarealsoavailableforuse.
TocontrolyourMopidymusicserver,youcanuseoneofMopidy’swebclients,theUbuntuSoundMenu,anydevice
on the same network which can control UPnP MediaRenderers, or any MPD client. MPD clients are available for
manyplatforms,includingWindows,OSX,Linux,AndroidandiOS.
TogetstartedwithMopidy,startbyreadingInstallation.
Ifyougetstuck,weusuallyhangaroundat#mopidyatirc.freenode.netandalsohaveamailinglistatGoogleGroups.
Ifyoustumbleintoabugorgotafeaturerequest,pleasecreateanissueintheissuetracker. Thesourcecodemayalso
beofhelp. IfyouwanttostayuptodateonMopidydevelopments,youcanfollow@mopidyonTwitter.
Contents 1
MopidyDocumentation,Release0.19.2
2 Contents
1
CHAPTER
Usage
1.1 Installation
ThereareseveralwaystoinstallMopidy. WhatwayisbestdependsuponyourOSand/ordistribution.
IfyouwanttocontributetothedevelopmentofMopidy,youshouldfirstreadthegeneralinstallationinstructions,then
havealookatRunningMopidyfromGit.
1.1.1 Debian/Ubuntu: Install from apt.mopidy.com
IfyourunaDebianbasedLinuxdistribution,likeUbuntu,theeasiestwaytoinstallMopidyisfromtheMopidyAPT
archive. WheninstallingfromtheAPTarchive,youwillautomaticallygetupdatestoMopidyinthesamewayasyou
getupdatestotherestofyoursystem.
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
RaspberryPi: Mopidyonacreditcard.
1. Addthearchive’sGPGkey:
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/,addittoafilecalledmopidy.listinthatdirectory:
# Mopidy APT archive
deb http://apt.mopidy.com/ stable main contrib non-free
deb-src http://apt.mopidy.com/ stable main contrib non-free
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. InstallMopidyandalldependencies:
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
installadditionalpackages.
Tolistalltheextensionsavailablefromapt.mopidy.com,youcanrun:
3
MopidyDocumentation,Release0.19.2
apt-cache search mopidy
Toinstalloneofthelistedpackages,e.g. mopidy-spotify,simplyrun:
sudo apt-get install mopidy-spotify
ForafulllistofavailableMopidyextensions,includingthosenotinstallablefromapt.mopidy.com,seeExten-
sions.
5. Before continuing, make sure you’ve read the Debian package section to learn about the differences between
runningMopidyasasystemserviceandmanuallyasyourownsystemuser.
6. Finally,youneedtosetacoupleofconfigvalues,andthenyou’rereadytorunMopidy.
WhenanewreleaseofMopidyisout,andyoucan’twaitforyousystemtofigureitoutforitself,runthefollowingto
upgraderightaway:
sudo apt-get update
sudo apt-get dist-upgrade
1.1.2 Arch Linux: Install from AUR
IfyouarerunningArchLinux,youcaninstallMopidyusingthemopidypackagefoundinAUR.
1. ToinstallMopidywithalldependencies,youcanuseforexampleyaourt:
yaourt -S mopidy
ToupgradeMopidytofuturereleases,justupgradeyoursystemusing:
yaourt -Syu
2. Optional: IfyouwanttouseanyMopidyextensions,likeSpotifysupportorLast.fmscrobbling,AURalsohas
packagesforseveralMopidyextensions.
ForafulllistofavailableMopidyextensions,includingthosenotinstallablefromAUR,seeExtensions.
3. Finally,youneedtosetacoupleofconfigvalues,andthenyou’rereadytorunMopidy.
1.1.3 OS X: Install from Homebrew
IfyouarerunningOSX,youcaninstalleverythingneededwithHomebrew.
1. InstallXcodecommandlinedevelopertools. DothisevenifyoualreadyhaveXcodeinstalled:
xcode-select --install
2. InstallXQuartz. ThisisneededbyGStreamerwhichMopidyuseheavily.
3. InstallHomebrew.
4. IfyouarealreadyusingHomebrew,makesureyourinstallationisuptodatebeforeyoucontinue:
brew update
brew upgrade
NoticethatthiswillupgradeallsoftwareonyoursystemthathavebeeninstalledwithHomebrew.
5. MopidyworksoutofboxifyouhaveinstalledPythonfromHomebrew:
4 Chapter1. Usage
MopidyDocumentation,Release0.19.2
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
dependenciesandwillcrash.
YoucaneitheramendyourPYTHONPATHpermanently,byaddingthefollowingstatementtoyourshell’sinit
file,e.g. ~/.bashrc:
export PYTHONPATH=$(brew --prefix)/lib/python2.7/site-packages:$PYTHONPATH
Andthenreloadtheshell’sinitfileorrestartyourterminal:
source ~/.bashrc
Or,youcanprefixtheMopidycommandeverytimeyourunit:
PYTHONPATH=$(brew --prefix)/lib/python2.7/site-packages mopidy
6. MopidyhasitsownHomebrewformularepo,calleda“tap”. ToenableourHomebrewtap,run:
brew tap mopidy/mopidy
7. ToinstallMopidy,run:
brew install mopidy
8. Optional: IfyouwanttouseanyMopidyextensions,likeSpotifysupportorLast.fmscrobbling,theHomebrew
taphasformulasforseveralMopidyextensionsaswell.
Tolistalltheextensionsavailablefromourtap,youcanrun:
brew search mopidy
ForafulllistofavailableMopidyextensions,includingthosenotinstallablefromHomebrew,seeExtensions.
9. Finally,youneedtosetacoupleofconfigvalues,andthenyou’rereadytorunMopidy.
1.1.4 Install from source
IfyouareonLinux,butcan’tinstallfromtheAPTarchiveorfromAUR,youcaninstallMopidyfromsourcebyhand.
1. Firstofall,youneedPython2.7. CheckifyouhavePythonandwhatversionbyrunning:
python --version
2. You need to make sure you have pip, the Python package installer. You’ll also need a C compiler and the
Pythondevelopmentheaderstobuildpyspotifylater.
ThisishowyouinstallitonDebian/Ubuntu:
sudo apt-get install build-essential python-dev python-pip
AndonArchLinuxfromtheofficialrepository:
sudo pacman -S base-devel python2-pip
AndonFedoraLinuxfromtheofficialrepositories:
1.1. Installation 5
MopidyDocumentation,Release0.19.2
sudo yum install -y gcc python-devel python-pip
Note: OnFedoraLinux,youmustreplacepipwithpip-pythoninthefollowingsteps.
3. Thenyou’llneedtoinstallGStreamer0.10(>=0.10.31,<0.11),withPythonbindings. GStreamerispackaged
formostpopularLinuxdistributions. SearchforGStreamerinyourpackagemanager,andmakesuretoinstall
thePythonbindings,andthe“good”and“ugly”pluginsets.
IfyouuseDebian/UbuntuyoucaninstallGStreamerlikethis:
sudo apt-get install python-gst0.10 gstreamer0.10-plugins-good \
gstreamer0.10-plugins-ugly gstreamer0.10-tools
IfyouuseArchLinux,installthefollowingpackagesfromtheofficialrepository:
sudo pacman -S gstreamer0.10-python gstreamer0.10-good-plugins \
gstreamer0.10-ugly-plugins
IfyouuseFedorayoucaninstallGStreamerlikethis:
sudo yum install -y python-gst0.10 gstreamer0.10-plugins-good \
gstreamer0.10-plugins-ugly gstreamer0.10-tools
IfyouuseGentooyouneedtobecarefulbecauseGStreamer0.10isinadifferentlowerslotthan1.0,thedefault.
Youremergecommandswillneedtoincludetheslot:
emerge -av gst-python gst-plugins-bad:0.10 gst-plugins-good:0.10 \
gst-plugins-ugly:0.10 gst-plugins-meta:0.10
gst-plugins-meta:0.10istheonethatactuallypullsinthepluginsyouwant,sopayattentiontotheuse
flags,e.g. alsa,mp3,etc.
4. InstallthelatestreleaseofMopidy:
sudo pip install -U mopidy
ToupgradeMopidytofuturereleases,justrerunthiscommand.
Alternatively, if you want to track Mopidy development closer, you may install a snapshot of Mopidy’s
developGitbranchusingpip:
sudo pip install --allow-unverified=mopidy mopidy==dev
5. Optional: If you want Spotify support in Mopidy, you’ll need to install libspotify and the Mopidy-Spotify
extension.
(a) DownloadandinstallthelatestversionoflibspotifyforyourOSandCPUarchitecturefromSpotify.
Forlibspotify12.1.51for64-bitLinuxtheprocessisasfollows:
wget https://developer.spotify.com/download/libspotify/libspotify-12.1.51-Linux-x86_64-release.tar.gz
tar zxfv libspotify-12.1.51-Linux-x86_64-release.tar.gz
cd libspotify-12.1.51-Linux-x86_64-release/
sudo make install prefix=/usr/local
Remembertoadjusttheaboveexampleforthelatestlibspotifyversionsupportedbypyspotify,yourOS,
andyourCPUarchitecture.
(b) Ifyou’reonFedora,youmustaddaconfigurationfilesolibspotify.socanbefound:
6 Chapter1. Usage