Skip to main content

Mopidy-MPRIS

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.

Project resources

Changelog

v1.0.0 (2013-10-08)

  • Moved extension out of the main Mopidy project.

Metadata

Release files for mopidy-mpris 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mopidy-mpris 1.0.0
File Size Uploaded
Mopidy-MPRIS-1.0.0.tar.gz 12.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mopidy-mpris 1.0.0
File Interpreter ABI Platform
Mopidy_MPRIS-1.0.0-py27-none-any.whl Python 2.7 none any Details

Total release size: 24.2 kB

Release files / Mopidy-MPRIS-1.0.0.tar.gz

Download URL Mopidy-MPRIS-1.0.0.tar.gz
Size 12.4 kB
Tags Source
SHA-256 checksum
How to use checksums
8fe649408fd3b4bf0ef1be1a4e9fd476c99dae0f7d1cd6551944efa8d341099c
BLAKE2b-256 checksum
How to use checksums
ff6599c215e6e1bdbd4ea5f56af203c5d0d4d40a94702d2554aeee1bb7caae80
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / Mopidy_MPRIS-1.0.0-py27-none-any.whl

Download URL Mopidy_MPRIS-1.0.0-py27-none-any.whl
Size 11.9 kB
Tags Python 2.7
SHA-256 checksum
How to use checksums
72b16ae1aeaabb280845009c6b2248d5eeb03907ca1a103cc6937aa2e6c83b52
BLAKE2b-256 checksum
How to use checksums
1280c8aa25fcf85caf682860a124ba5be6b6645867ceccc059c7dd6a408319ea
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page