MPRIS D-Bus Interface Specification

Interfaces (Compact) | Full Index

Version 2.0

Copyright © 2006-2010 the VideoLAN team (Mirsal Ennaime, Rafaël Carré, Jean-Paul Saman)
Copyright © 2005-2008 Milosz Derezynski
Copyright © 2008 Nick Welch
Copyright © 2010 Alex Merry

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

About (Permalink)

The Media Player Remote Interfacing Specification is a standard D-Bus interface which aims to provide a common programmatic API for controlling media players.

It provides a mechanism for compliant media players discovery, basic playback and media player state control as well as a tracklist interface which is used to add context to the current item.

Bus Name Policy (Permalink)

Each media player must request a unique bus name which begins with org.mpris.MediaPlayer2. For example:

This allows clients to list available media players (either already running or which can be started via D-Bus activation)

In the case where the media player allows multiple instances running simultaneously, each additional instance should request a unique bus name, adding a dot and a unique identifier (such as a UNIX process id) to its usual bus name. For example, this could be

Entry point (Permalink)

The media player must expose the /org/mpris/MediaPlayer2 object path, which must implement the following interfaces:

The /org/mpris/MediaPlayer2 object may implement the org.mpris.MediaPlayer2.TrackList interface.

The PropertiesChanged signal (Permalink)

The MPRIS uses the org.freedesktop.DBus.Properties.PropertiesChanged signal to notify clients of changes in the media player state. If a client implementation uses D-Bus bindings which do not support this signal, then it should connect to it manually. If a media player implementation uses D-Bus bindings which do not support this signal, then it should send it manually

Interfaces (Permalink)