Skip to main content
Help us improve Python packaging – donate today!

Mopidy extension for controlling Mopidy through the MPRIS D-Bus interface

Project Description

Latest PyPI version Number of PyPI downloads Travis CI build status Test coverage

Mopidy extension for controlling Mopidy through the MPRIS D-Bus interface.

An example of an MPRIS client is the Ubuntu Sound Menu.

Dependencies

  • D-Bus Python bindings. The package is named python-dbus in Ubuntu/Debian.
  • libindicate Python bindings is needed to expose Mopidy in e.g. the Ubuntu Sound Menu. The package is named python-indicate in Ubuntu/Debian.
  • An .desktop file for Mopidy installed at the path set in the mpris/desktop_file config value. Mopidy installs this by default. See usage section below for details.

Installation

Install by running:

pip install Mopidy-MPRIS

Or, if available, install the Debian/Ubuntu package from apt.mopidy.com.

Configuration

There’s no configuration needed for the MPRIS extension to work.

The following configuration values are available:

  • mpris/enabled: If the MPRIS extension should be enabled or not.
  • mpris/desktop_file: Path to Mopidy’s .desktop file.

Usage

The extension is enabled by default if all dependencies are available.

Controlling Mopidy through the Ubuntu Sound Menu

If you are running Ubuntu and installed Mopidy using the Debian package from APT you should be able to control Mopidy through the Ubuntu Sound Menu without any changes.

If you installed Mopidy in any other way and want to control Mopidy through the Ubuntu Sound Menu, you must install the mopidy.desktop file which can be found in the data/ dir of the Mopidy source repo into the /usr/share/applications dir by hand:

cd /path/to/mopidy/source
sudo cp data/mopidy.desktop /usr/share/applications/

If the correct path to the installed mopidy.desktop file on your system isn’t /usr/share/applications/mopidy.conf, you’ll need to set the mpris/desktop_file config value.

After you have installed the file, start Mopidy in any way, and Mopidy should appear in the Ubuntu Sound Menu. When you quit Mopidy, it will still be listed in the Ubuntu Sound Menu, and may be restarted by selecting it there.

The Ubuntu Sound Menu interacts with Mopidy’s MPRIS frontend. The MPRIS frontend supports the minimum requirements of the MPRIS specification. The TrackList interface of the spec is not supported.

Testing the MPRIS API directly

To use the MPRIS API directly, start Mopidy, and then run the following in a Python shell:

import dbus
bus = dbus.SessionBus()
player = bus.get_object('org.mpris.MediaPlayer2.mopidy',
    '/org/mpris/MediaPlayer2')

Now you can control Mopidy through the player object. Examples:

  • To get some properties from Mopidy, run:

    props = player.GetAll('org.mpris.MediaPlayer2',
        dbus_interface='org.freedesktop.DBus.Properties')
    
  • To quit Mopidy through D-Bus, run:

    player.Quit(dbus_interface='org.mpris.MediaPlayer2')
    

For details on the API, please refer to the MPRIS specification.

Changelog

v1.1.0 (2014-01-20)

  • Updated extension API to match Mopidy 0.18.

v1.0.1 (2013-11-20)

  • Update to work with Mopidy 0.16 which changed some APIs.
  • Remove redundant event loop setup already done by the mopidy process.

v1.0.0 (2013-10-08)

  • Moved extension out of the main Mopidy project.

Release history Release notifications

History Node

1.4.0

History Node

1.3.1

History Node

1.3.0

History Node

1.2.0

History Node

1.1.1

This version
History Node

1.1.0

History Node

1.0.1

History Node

1.0.0

History Node

0.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
Mopidy_MPRIS-1.1.0-py2.py3-none-any.whl (12.0 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Jan 20, 2014
Mopidy-MPRIS-1.1.0.tar.gz (18.8 kB) Copy SHA256 hash SHA256 Source None Jan 20, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page