MPRIS D-Bus Interface Specification

https://specifications.freedesktop.org/mpris/latest/
Admin
The Media Player Remote Interfacing Specification (MPRIS) is a standard D-Bus interface providing a...
Tokens:14,874
Snippets:65
Trust Score:7.9
Update:10 months ago
Show doc for...
Tokens:
Raw
### GetPlaylists

Source: https://specifications.freedesktop.org/mpris/latest/Playlists_Interface

Retrieves a list of playlists based on specified criteria such as starting index, maximum count, and ordering.

```APIDOC
## POST /org/mpris/MediaPlayer2/{objectPath}

### Description
Retrieves a paginated list of playlists according to the specified ordering and filtering criteria.

### Method
POST

### Endpoint
`/org/mpris/MediaPlayer2/{objectPath}`

### Parameters
#### Path Parameters
- **objectPath** (string) - Required - The D-Bus object path for the media player.

#### Query Parameters
None

#### Request Body
- **method** (string) - Required - The method name, should be `GetPlaylists`.
- **signature** (string) - Required - The D-Bus method signature, should be `(uu s b)`.
- **params** (array) - Required - An array containing the parameters for the method.
  - **Index** (unsigned integer) - Required - The index of the first playlist to fetch.
  - **MaxCount** (unsigned integer) - Required - The maximum number of playlists to return.
  - **Order** (string, Playlist_Ordering) - Required - The desired ordering for the playlists.
  - **ReverseOrder** (boolean) - Required - Whether to reverse the specified order.

### Request Example
```json
{
  "method": "GetPlaylists",
  "signature": "(uu s b)",
  "params": [
    0, 
    10, 
    "Alphabetical", 
    false
  ]
}
```

### Response
#### Success Response (200)
- **result** (array) - An array containing the list of playlists.
  - **Playlists** (array of objects) - A list of playlist objects. Each playlist object may contain:
    - **Id** (object id) - The unique identifier of the playlist.
    - **Name** (string) - The name of the playlist.
    - **Icon** (string) - The URI of the playlist's icon.

#### Response Example
```json
{
  "result": [
    [
      {
        "Id": "<playlist_id_1>",
        "Name": "My Favorites",
        "Icon": "file:///path/to/icon1.png"
      },
      {
        "Id": "<playlist_id_2>",
        "Name": "Workout Mix",
        "Icon": "file:///path/to/icon2.png"
      }
    ]
  ]
}
```

#### Error Response
- **error** (object) - Contains error details if the request fails.
  - **code** (integer) - The error code.
  - **message** (string) - A human-readable error message.
```

--------------------------------

### CanPlay Property

Source: https://specifications.freedesktop.org/mpris/latest/Player_Interface

A boolean indicating whether playback can be started using Play or PlayPause. This property is related to the existence of a 'current track' and is true if playback can be initiated when CanControl is true. If CanControl is false, this property must also be false.

```APIDOC
## CanPlay

### Description
Whether playback can be started using Play or PlayPause. When this property changes, the `org.freedesktop.DBus.Properties.PropertiesChanged` signal is emitted with the new value.

Note that this is related to whether there is a "current track": the value should not depend on whether the track is currently paused or playing. In fact, if a track is currently playing (and CanControl is **true**), this should be **true**. If CanControl is **false**, this property should also be **false**.

##### Rationale:
Even when playback can generally be controlled, it may not be possible to enter a "playing" state, for example if there is no "current track".

### Method
Read only

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **CanPlay** (b) - True if playback can be started, false otherwise.

#### Response Example
```json
{
  "CanPlay": true
}
```
```

--------------------------------

### org.mpris.MediaPlayer2 Methods

Source: https://specifications.freedesktop.org/mpris/latest/Media_Player

This section details the methods available for interacting with the media player, such as bringing its interface to the front or quitting the application.

```APIDOC
## Raise

### Description
Brings the media player's user interface to the front using any appropriate mechanism available. The media player may be unable to control how its user interface is displayed, or it may not have a graphical user interface at all. In this case, the CanRaise property is false and this method does nothing.

### Method
`Raise`

### Parameters
None

### Response
#### Success Response
(nothing)

## Quit

### Description
Causes the media player to stop running. The media player may refuse to allow clients to shut it down. In this case, the CanQuit property is false and this method does nothing.

### Method
`Quit`

### Parameters
None

### Response
#### Success Response
(nothing)
```

--------------------------------

### ActivatePlaylist

Source: https://specifications.freedesktop.org/mpris/latest/Playlists_Interface

Activates a specified playlist, initiating playback. Implementations can choose to replace the current tracklist or append the playlist.

```APIDOC
## POST /org/mpris/MediaPlayer2/{objectPath}

### Description
Activates the specified playlist, initiating playback. Implementations have the flexibility to either completely replace the current tracklist or append the playlist to the upcoming tracks.

### Method
POST

### Endpoint
`/org/mpris/MediaPlayer2/{objectPath}`

### Parameters
#### Path Parameters
- **objectPath** (string) - Required - The D-Bus object path for the media player.

#### Query Parameters
None

#### Request Body
- **method** (string) - Required - The method name, should be `ActivatePlaylist`.
- **signature** (string) - Required - The D-Bus method signature, should be `(o)`.
- **params** (array) - Required - An array containing the parameters for the method.
  - **PlaylistId** (object id) - Required - The unique identifier of the playlist to activate.

### Request Example
```json
{
  "method": "ActivatePlaylist",
  "signature": "(o)",
  "params": [
    "<playlist_object_id>"
  ]
}
```

### Response
#### Success Response (200)
- **result** (null) - Indicates successful activation.

#### Response Example
```json
{
  "result": null
}
```

#### Error Response
- **error** (object) - Contains error details if the activation fails.
  - **code** (integer) - The error code.
  - **message** (string) - A human-readable error message.
```

--------------------------------

### MPRIS MediaPlayer2 Interface

Source: https://specifications.freedesktop.org/mpris/latest/fullindex

Provides general properties and methods for a media player.

```APIDOC
## Interface: org.mpris.MediaPlayer2

### Description
General properties and methods for a media player.

### Methods
#### Quit
- **Description**: Quits the media player.
- **Endpoint**: `org.mpris.MediaPlayer2.Quit`

#### Raise
- **Description**: Raises the media player window or brings it to the foreground.
- **Endpoint**: `org.mpris.MediaPlayer2.Raise`

### Properties
#### Identity (string)
- **Description**: The identity or name of the media player.

#### DesktopEntry (string)
- **Description**: The desktop entry file name for the media player.

#### CanQuit (boolean)
- **Description**: Indicates if the player can be quit.

#### CanRaise (boolean)
- **Description**: Indicates if the player can be raised.

#### HasTrackList (boolean)
- **Description**: Indicates if the player has a track list.

#### SupportedUriSchemes (array of string)
- **Description**: Supported URI schemes for media playback.

#### SupportedMimeTypes (array of string)
- **Description**: Supported MIME types for media playback.

#### Fullscreen (boolean)
- **Description**: Indicates if the player is currently in fullscreen mode.

```

--------------------------------

### MPRIS Playlists Interface

Source: https://specifications.freedesktop.org/mpris/latest/fullindex

Provides methods and properties for managing playlists.

```APIDOC
## Interface: org.mpris.MediaPlayer2.Playlists

### Description
Methods and properties for managing playlists.

### Methods
#### ActivatePlaylist
- **Description**: Activates a playlist.
- **Parameters**: 
  - **playlist**: (Playlist) - The playlist to activate.
- **Endpoint**: `org.mpris.MediaPlayer2.Playlists.ActivatePlaylist`

#### GetPlaylists
- **Description**: Retrieves a list of available playlists.
- **Returns**: 
  - **playlists**: (array of Playlist) - An array of playlists.
- **Endpoint**: `org.mpris.MediaPlayer2.Playlists.GetPlaylists`

### Properties
#### Orderings (array of string)
- **Description**: Supported orderings for playlists.

#### PlaylistCount (uint32)
- **Description**: The total number of playlists.

### Signals
#### PlaylistChanged (Playlist)
- **Description**: Emitted when a playlist has changed.

```

--------------------------------

### org.mpris.MediaPlayer2 Properties

Source: https://specifications.freedesktop.org/mpris/latest/Media_Player

This section describes the properties that provide information about the media player's state and capabilities, including whether it can be quit, its fullscreen status, and its identity.

```APIDOC
## CanQuit

### Description
If false, calling Quit will have no effect, and may raise a NotSupported error. If true, calling Quit will cause the media application to attempt to quit (although it may still be prevented from quitting by the user, for example).

### Property Type
boolean (b)

### Access
Read only

## Fullscreen

### Description
Whether the media player is occupying the fullscreen. This is typically used for videos. A value of true indicates that the media player is taking up the full screen. If CanSetFullscreen is true, clients may set this property to true to tell the media player to enter fullscreen mode, or to false to return to windowed mode.

### Property Type
boolean (b)

### Access
Read/Write

## CanSetFullscreen

### Description
If false, attempting to set Fullscreen will have no effect, and may raise an error. If true, attempting to set Fullscreen will not raise an error, and (if it is different from the current value) will cause the media player to attempt to enter or exit fullscreen mode.

### Property Type
boolean (b)

### Access
Read only

## CanRaise

### Description
If false, calling Raise will have no effect, and may raise a NotSupported error. If true, calling Raise will cause the media application to attempt to bring its user interface to the front, although it may be prevented from doing so (by the window manager, for example).

### Property Type
boolean (b)

### Access
Read only

## HasTrackList

### Description
Indicates whether the /org/mpris/MediaPlayer2 object implements the org.mpris.MediaPlayer2.TrackList interface.

### Property Type
boolean (b)

### Access
Read only

## Identity

### Description
A friendly name to identify the media player to users. This should usually match the name found in .desktop files (eg: "VLC media player").

### Property Type
string (s)

### Access
Read only

## DesktopEntry

### Description
The "name" field from the application's .desktop file, if available.

### Property Type
string (s)

### Access
Read only

## SupportedUriSchemes

### Description
A list of URI schemes (e.g. "http", "file") that the media player can handle.

### Property Type
array of strings (as)

### Access
Read only

## SupportedMimeTypes

### Description
A list of MIME types (e.g. "audio/mpeg", "video/x-matroska") that the media player can handle.

### Property Type
array of strings (as)

### Access
Read only
```

--------------------------------

### MPRIS Player Interface

Source: https://specifications.freedesktop.org/mpris/latest/fullindex

Provides methods and properties for controlling the playback state of a media player.

```APIDOC
## Interface: org.mpris.MediaPlayer2.Player

### Description
Methods and properties for controlling media playback.

### Methods
#### Play
- **Description**: Starts playback.
- **Endpoint**: `org.mpris.MediaPlayer2.Player.Play`

#### Pause
- **Description**: Pauses playback.
- **Endpoint**: `org.mpris.MediaPlayer2.Player.Pause`

#### PlayPause
- **Description**: Toggles between play and pause.
- **Endpoint**: `org.mpris.MediaPlayer2.Player.PlayPause`

#### Stop
- **Description**: Stops playback.
- **Endpoint**: `org.mpris.MediaPlayer2.Player.Stop`

#### Next
- **Description**: Skips to the next track.
- **Endpoint**: `org.mpris.MediaPlayer2.Player.Next`

#### Previous
- **Description**: Skips to the previous track.
- **Endpoint**: `org.mpris.MediaPlayer2.Player.Previous`

#### Seek
- **Description**: Seeks within the current track. Requires a `Position` argument (microseconds).
- **Endpoint**: `org.mpris.MediaPlayer2.Player.Seek`

#### SetPosition
- **Description**: Sets the playback position to a specific time. Requires `TrackId` and `Position` arguments (microseconds).
- **Endpoint**: `org.mpris.MediaPlayer2.Player.SetPosition`

#### OpenUri
- **Description**: Opens a media URI for playback.
- **Endpoint**: `org.mpris.MediaPlayer2.Player.OpenUri`

### Properties
#### CanControl (boolean)
- **Description**: Indicates if the player can be controlled.

#### CanPause (boolean)
- **Description**: Indicates if the player supports pausing.

#### CanPlay (boolean)
- **Description**: Indicates if the player supports playing.

#### CanSeek (boolean)
- **Description**: Indicates if seeking is supported.

#### CanGoNext (boolean)
- **Description**: Indicates if skipping to the next track is supported.

#### CanGoPrevious (boolean)
- **Description**: Indicates if skipping to the previous track is supported.

#### PlaybackStatus (string - Enum: 'Playing', 'Paused', 'Stopped')
- **Description**: The current playback status.

#### LoopStatus (string - Enum: 'None', 'Loop', 'Playlist')
- **Description**: The current loop status.

#### Rate (double)
- **Description**: The current playback rate.

#### Buffering (uint64)
- **Description**: Buffering progress in percent.

#### Error (string)
- **Description**: Error message if an error occurred.

#### PercentPosition (uint32)
- **Description**: Current playback position in percent.

#### Position (int64)
- **Description**: Current playback position in microseconds.

#### Metadata (dict)
- **Description**: Metadata for the current track.

### Signals
#### Seeked (uint64)
- **Description**: Emitted when the playback position has changed.

#### TrackMetadataChanged (dict)
- **Description**: Emitted when the track metadata has changed.

```

--------------------------------

### MPRIS TrackList Interface

Source: https://specifications.freedesktop.org/mpris/latest/fullindex

Provides methods and properties for managing the track list.

```APIDOC
## Interface: org.mpris.MediaPlayer2.TrackList

### Description
Methods and properties for managing the track list.

### Methods
#### AddTrack
- **Description**: Adds a track to the track list.
- **Parameters**: 
  - **uri**: (string) - The URI of the track to add.
  - **position**: (uint32) - The position to insert the track at.
  - **metadata**: (dict) - Optional metadata for the track.
- **Endpoint**: `org.mpris.MediaPlayer2.TrackList.AddTrack`

#### RemoveTrack
- **Description**: Removes a track from the track list.
- **Parameters**: 
  - **trackId**: (TrackId) - The ID of the track to remove.
- **Endpoint**: `org.mpris.MediaPlayer2.TrackList.RemoveTrack`

#### GoTo
- **Description**: Jumps to a specific track in the track list.
- **Parameters**: 
  - **trackId**: (TrackId) - The ID of the track to jump to.
- **Endpoint**: `org.mpris.MediaPlayer2.TrackList.GoTo`

#### GetTracksMetadata
- **Description**: Retrieves metadata for a range of tracks.
- **Parameters**: 
  - **startIndex**: (uint32) - The starting index of the track range.
  - **endIndex**: (uint32) - The ending index of the track range.
  - **direction**: (string - Enum: 'forward', 'backward') - The direction to retrieve tracks.
  - **Shuffle**: (boolean) - Whether to shuffle the tracks.
- **Returns**: 
  - **metadata**: (array of dict) - An array of track metadata.
- **Endpoint**: `org.mpris.MediaPlayer2.TrackList.GetTracksMetadata`

### Properties
#### CanEditTracks (boolean)
- **Description**: Indicates if the track list can be edited.

#### Tracks (array of dict)
- **Description**: The current list of tracks.

### Signals
#### TrackAdded (uint32, TrackId, dict)
- **Description**: Emitted when a track is added.

#### TrackRemoved (uint32, TrackId)
- **Description**: Emitted when a track is removed.

#### TrackMetadataChanged (uint32, dict)
- **Description**: Emitted when track metadata has changed.

#### TrackListReplaced (array of dict, boolean)
- **Description**: Emitted when the track list has been replaced.

```

--------------------------------

### MediaPlayer2 Interface Properties

Source: https://specifications.freedesktop.org/mpris/latest/Media_Player

This section details the read-only properties available through the org.mpris.MediaPlayer2 DBus interface.

```APIDOC
## DesktopEntry

### Description
The basename of an installed .desktop file which complies with the Desktop entry specification, with the ".desktop" extension stripped. For example, if the desktop entry file is "/usr/share/applications/vlc.desktop", this property contains "vlc".

### Method
Read only

### Endpoint
N/A (DBus Property)

### Parameters
None

### Request Example
N/A

### Response
#### Success Response (200)
- **desktop_entry** (string) - The basename of the desktop entry file.

#### Response Example
```json
{
  "desktop_entry": "vlc"
}
```

## SupportedUriSchemes

### Description
The URI schemes supported by the media player. This can be viewed as protocols supported by the player. Almost every media player will include support for the "file" scheme. Other common schemes are "http" and "rtsp". URI schemes should be lower-case.

### Method
Read only

### Endpoint
N/A (DBus Property)

### Parameters
None

### Request Example
N/A

### Response
#### Success Response (200)
- **supported_uri_schemes** (array of strings) - A list of supported URI schemes.

#### Response Example
```json
{
  "supported_uri_schemes": ["file", "http", "rtsp"]
}
```

## SupportedMimeTypes

### Description
The mime-types supported by the media player. Mime-types should be in the standard format (e.g., audio/mpeg or application/ogg).

### Method
Read only

### Endpoint
N/A (DBus Property)

### Parameters
None

### Request Example
N/A

### Response
#### Success Response (200)
- **supported_mime_types** (array of strings) - A list of supported MIME types.

#### Response Example
```json
{
  "supported_mime_types": ["audio/mpeg", "application/ogg"]
}
```
```

--------------------------------

### org.mpris.MediaPlayer2.Player Interface Properties

Source: https://specifications.freedesktop.org/mpris/latest/Player_Interface

This section details the read-only and read-write properties available on the org.mpris.MediaPlayer2.Player interface, which allow clients to query and control media playback.

```APIDOC
## Properties of org.mpris.MediaPlayer2.Player

### CanControl

#### Description
Indicates whether the media player can be controlled via this interface. If false, all properties and methods are considered read-only.

#### Type
`b` (boolean)

#### Readability
Read-only

### Track_Id

#### Description
A unique identifier for the current track within the tracklist. Must be a valid D-Bus object ID.

#### Type
`o` (object path)

#### Readability
Read-only

### Playback_Rate

#### Description
Represents the current playback speed as a multiplier. For example, 0.5 means half speed, 1.5 means 1.5 times the normal speed.

#### Type
`d` (double)

#### Readability
Read-write

### Volume

#### Description
The current audio volume level. 0.0 is mute, 1.0 is a sensible maximum. Values above 1.0 may be possible but clients should generally not attempt to set them.

#### Type
`d` (double)

#### Readability
Read-write

### Time_In_Us

#### Description
Represents the current playback time in microseconds.

#### Type
`x` (64-bit integer)

#### Readability
Read-only

### Playback_Status

#### Description
Indicates the current playback state: Playing, Paused, or Stopped.

#### Type
`s` (string)

#### Readability
Read-only

### Loop_Status

#### Description
Indicates the current repeat or loop mode: None, Track, or Playlist.

#### Type
`s` (string)

#### Readability
Read-write
```

--------------------------------

### MinimumRate Property

Source: https://specifications.freedesktop.org/mpris/latest/Player_Interface

Specifies the minimum playback rate allowed. This is a read-only property. Clients should not set the Rate property below this value, even if it's negative or zero. The value should generally be 1.0 or less.

```APIDOC
## MinimumRate

### Description
The minimum value which the Rate property can take. When this property changes, the `org.freedesktop.DBus.Properties.PropertiesChanged` signal is emitted with the new value.

Clients should not attempt to set the Rate property below this value. Note that even if this value is 0.0 or negative, clients should not attempt to set the Rate property to 0.0. This value should always be 1.0 or less.

### Method
Read only

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **MinimumRate** (d) - The minimum playback rate.

#### Response Example
```json
{
  "MinimumRate": 0.5
}
```
```

--------------------------------

### Properties API

Source: https://specifications.freedesktop.org/mpris/latest/Playlists_Interface

Accesses read-only properties of the Playlists interface, including the total count of playlists, available ordering options, and the currently active playlist.

```APIDOC
## GET /org/mpris/MediaPlayer2/{objectPath}?property={propertyName}

### Description
Accesses read-only properties of the Playlists interface using the `org.freedesktop.DBus.Properties` interface. Properties include `PlaylistCount`, `Orderings`, and `ActivePlaylist`.

### Method
GET

### Endpoint
`/org/mpris/MediaPlayer2/{objectPath}`

### Parameters
#### Path Parameters
- **objectPath** (string) - Required - The D-Bus object path for the media player.

#### Query Parameters
- **property** (string) - Required - The name of the property to retrieve (e.g., `PlaylistCount`, `Orderings`, `ActivePlaylist`).

### Request Example
```http
GET /org/mpris/MediaPlayer2/player0?property=PlaylistCount
```

### Response
#### Success Response (200)
- **value** (type) - The value of the requested property.
  - For `PlaylistCount`: `unsigned integer` - The total number of playlists.
  - For `Orderings`: `array of strings` - The available ordering options (e.g., `["Alphabetical", "CreationDate"]`).
  - For `ActivePlaylist`: `struct` - Details of the active playlist.
    - **Valid** (boolean) - True if an active playlist exists, false otherwise.
    - **Playlist** (struct) - Details of the active playlist (if `Valid` is true).
      - **Id** (object id) - The unique identifier of the active playlist.
      - **Name** (string) - The name of the active playlist.
      - **Icon** (string) - The icon URI of the active playlist.

#### Response Example for PlaylistCount
```json
{
  "value": 50
}
```

#### Response Example for Orderings
```json
{
  "value": [
    "Alphabetical",
    "CreationDate",
    "ModifiedDate",
    "LastPlayDate",
    "UserDefined"
  ]
}
```

#### Response Example for ActivePlaylist (with active playlist)
```json
{
  "value": {
    "Valid": true,
    "Playlist": {
      "Id": "<active_playlist_id>",
      "Name": "Now Playing",
      "Icon": "file:///path/to/now_playing.png"
    }
  }
}
```

#### Response Example for ActivePlaylist (no active playlist)
```json
{
  "value": {
    "Valid": false
  }
}
```

#### Error Response
- **error** (object) - Contains error details if the property retrieval fails.
  - **code** (integer) - The error code.
  - **message** (string) - A human-readable error message.
```

--------------------------------

### Types

Source: https://specifications.freedesktop.org/mpris/latest/Playlists_Interface

Defines the custom data types used within the MPRIS Playlists interface, including Playlist IDs, URIs, ordering enums, and struct representations for playlists.

```APIDOC
## Types

### Playlist_Id (o)
- **Description**: A unique identifier for a playlist, represented as a D-Bus object ID.
- **Rationale**: Ensures uniqueness even if multiple playlists share the same name, and allows for future D-Bus object expansions.

### Uri (s)
- **Description**: A Uniform Resource Identifier (URI) string.

### Playlist_Ordering (s)
- **Description**: An enumeration string specifying the desired ordering for playlists.
- **Possible Values**:
  - `"Alphabetical"`: Order playlists alphabetically by name, ascending.
  - `"CreationDate"`: Order playlists by their creation date, oldest first.
  - `"ModifiedDate"`: Order playlists by their last modified date, oldest first.
  - `"LastPlayDate"`: Order playlists by the date of their last playback, oldest first.
  - `"UserDefined"`: Use a user-defined ordering.

### Playlist (oss)
- **Description**: A structure representing a playlist with its core details.
- **Fields**:
  - **Id** (o): The unique `Playlist_Id` of the playlist.
  - **Name** (s): The name of the playlist.
  - **Icon** (s): A URI pointing to the playlist's icon.

### Maybe_Playlist (b(oss))
- **Description**: A structure indicating whether a playlist is currently active. It includes a validity flag and optional playlist details.
- **Fields**:
  - **Valid** (b): A boolean flag. `true` if an active playlist is present, `false` otherwise.
  - **Playlist** (oss): The `Playlist` structure containing details of the active playlist. This field is only defined and relevant if `Valid` is `true`.
```

--------------------------------

### MaximumRate Property

Source: https://specifications.freedesktop.org/mpris/latest/Player_Interface

Specifies the maximum playback rate allowed. This is a read-only property. Clients should not set the Rate property above this value. The value should generally be 1.0 or greater.

```APIDOC
## MaximumRate

### Description
The maximum value which the Rate property can take. When this property changes, the `org.freedesktop.DBus.Properties.PropertiesChanged` signal is emitted with the new value.

Clients should not attempt to set the Rate property above this value. This value should always be 1.0 or greater.

### Method
Read only

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **MaximumRate** (d) - The maximum playback rate.

#### Response Example
```json
{
  "MaximumRate": 2.0
}
```
```

--------------------------------

### CanGoNext Property

Source: https://specifications.freedesktop.org/mpris/latest/Player_Interface

A boolean indicating whether the client can call the Next method. If unknown, it should be true. If CanControl is false, this property must also be false.

```APIDOC
## CanGoNext

### Description
Whether the client can call the Next method on this interface and expect the current track to change. When this property changes, the `org.freedesktop.DBus.Properties.PropertiesChanged` signal is emitted with the new value.

If it is unknown whether a call to Next will be successful (for example, when streaming tracks), this property should be set to **true**. If CanControl is **false**, this property should also be **false**.

##### Rationale:
Even when playback can generally be controlled, there may not always be a next track to move to.

### Method
Read only

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **CanGoNext** (b) - True if the client can go to the next track, false otherwise.

#### Response Example
```json
{
  "CanGoNext": true
}
```
```

--------------------------------

### Properties: Tracks

Source: https://specifications.freedesktop.org/mpris/latest/Track_List_Interface

A read-only property representing an array of track identifiers in the tracklist, in order. Changes to this property emit PropertiesChanged signals, but the new value is not sent.

```APIDOC
## Property: Tracks

### Description
A read-only property that holds an array containing the identifier of each track in the tracklist, in order. When this property changes, the `org.freedesktop.DBus.Properties.PropertiesChanged` signal is emitted, but the new value is not included in the signal message. Clients should rely on `TrackAdded`, `TrackRemoved`, and `TrackListReplaced` signals to keep their tracklist representation updated.

### Type
`ao` (Track_Id_List)
```

--------------------------------

### CanGoPrevious Property

Source: https://specifications.freedesktop.org/mpris/latest/Player_Interface

A boolean indicating whether the client can call the Previous method. If unknown, it should be true. If CanControl is false, this property must also be false.

```APIDOC
## CanGoPrevious

### Description
Whether the client can call the Previous method on this interface and expect the current track to change. When this property changes, the `org.freedesktop.DBus.Properties.PropertiesChanged` signal is emitted with the new value.

If it is unknown whether a call to Previous will be successful (for example, when streaming tracks), this property should be set to **true**. If CanControl is **false**, this property should also be **false**.

##### Rationale:
Even when playback can generally be controlled, there may not always be a previous track to move to.

### Method
Read only

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **CanGoPrevious** (b) - True if the client can go to the previous track, false otherwise.

#### Response Example
```json
{
  "CanGoPrevious": true
}
```
```

--------------------------------

### Volume Property

Source: https://specifications.freedesktop.org/mpris/latest/Player_Interface

Represents the current volume level of the media player. Changing this property emits a PropertiesChanged signal. Negative values are treated as 0.0. Setting this property when CanControl is false has no effect and raises an error.

```APIDOC
## Volume

### Description
The volume level. When this property changes, the `org.freedesktop.DBus.Properties.PropertiesChanged` signal is emitted with the new value.

When setting, if a negative value is passed, the volume should be set to 0.0. If CanControl is **false**, attempting to set this property should have no effect and raise an error.

### Method
Read/Write

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **Volume** (d) - Required - The desired volume level (0.0 to 1.0).

### Request Example
(Not applicable for direct property setting in this format, typically done via DBus API calls)

### Response
#### Success Response (200)
- **Volume** (d) - The current volume level.

#### Response Example
```json
{
  "Volume": 0.8
}
```
```

--------------------------------

### Position Property

Source: https://specifications.freedesktop.org/mpris/latest/Player_Interface

Indicates the current playback position in microseconds. This is a read-only property and does not emit a PropertiesChanged signal on change. The position is between 0 and the 'mpris:length' metadata entry. Changing the position can be done via SetPosition or Seek methods if CanSeek is true.

```APIDOC
## Position

### Description
The current track position in microseconds, between 0 and the 'mpris:length' metadata entry (see Metadata). The `org.freedesktop.DBus.Properties.PropertiesChanged` signal is **not** emitted when this property changes.

Note: If the media player allows it, the current playback position can be changed either the SetPosition method or the Seek method on this interface. If this is not the case, the CanSeek property is false, and setting this property has no effect and can raise an error. If the playback progresses in a way that is inconsistent with the Rate property, the Seeked signal is emitted.

### Method
Read only

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **Position** (x) - The current playback position in microseconds.

#### Response Example
```json
{
  "Position": 123456789
}
```
```

--------------------------------

### PlaylistChanged Signal

Source: https://specifications.freedesktop.org/mpris/latest/Playlists_Interface

Emitted when the Name or Icon attribute of a playlist has changed. Clients should be aware this signal may not always be implemented.

```APIDOC
## PlaylistChanged Signal

### Description
This signal is emitted when the `Name` or `Icon` attribute of a playlist is modified. Clients should be prepared for this signal potentially not being implemented by all media players.

### Parameters
- **Playlist** ((oss) Playlist) - The playlist object whose details have changed.
  - **Id** (object id) - The unique identifier of the playlist.
  - **Name** (string) - The updated name of the playlist.
  - **Icon** (string) - The updated icon URI of the playlist.
```

--------------------------------

### CanSeek Property

Source: https://specifications.freedesktop.org/mpris/latest/Player_Interface

A boolean indicating whether the client can control the playback position using Seek and SetPosition. This may vary per track. If CanControl is false, this property must also be false.

```APIDOC
## CanSeek

### Description
Whether the client can control the playback position using Seek and SetPosition. When this property changes, the `org.freedesktop.DBus.Properties.PropertiesChanged` signal is emitted with the new value.

This may be different for different tracks. If CanControl is **false**, this property should also be **false**.

##### Rationale:
Not all media is seekable: it may not be possible to seek when playing some streamed media, for example.

### Method
Read only

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **CanSeek** (b) - True if the media is seekable, false otherwise.

#### Response Example
```json
{
  "CanSeek": true
}
```
```

--------------------------------

### TrackAdded Signal

Source: https://specifications.freedesktop.org/mpris/latest/Track_List_Interface

Emitted when a track has been added to the track list. Includes metadata of the new track and the identifier of the track after which it was inserted.

```APIDOC
## TrackAdded Signal

### Description
Indicates that a track has been added to the track list.

### Parameters

#### Path Parameters
- **Metadata** (a{sv}: Metadata_Map) - Required - The metadata of the newly added item. Must include a `mpris:trackid` entry.
- **AfterTrack** (o: Track_Id) - Required - The identifier of the track after which the new track was inserted. `/org/mpris/MediaPlayer2/TrackList/NoTrack` indicates insertion at the start.
```

--------------------------------

### Properties: CanEditTracks

Source: https://specifications.freedesktop.org/mpris/latest/Track_List_Interface

A read-only boolean property indicating whether track editing (AddTrack, RemoveTrack) is supported. If false, these operations may have no effect or raise a NotSupported error.

```APIDOC
## Property: CanEditTracks

### Description
A read-only property that indicates whether the tracklist can be edited. If `false`, calling `AddTrack` or `RemoveTrack` operations will have no effect and may raise a `NotSupported` error.

### Type
`b` (Boolean)
```

--------------------------------

### CanPause Property

Source: https://specifications.freedesktop.org/mpris/latest/Player_Interface

A boolean indicating whether playback can be paused using Pause or PlayPause. This is an intrinsic property of the current track. If CanControl is false, this property must also be false.

```APIDOC
## CanPause

### Description
Whether playback can be paused using Pause or PlayPause. When this property changes, the `org.freedesktop.DBus.Properties.PropertiesChanged` signal is emitted with the new value.

Note that this is an intrinsic property of the current track: its value should not depend on whether the track is currently paused or playing. In fact, if playback is currently paused (and CanControl is **true**), this should be **true**. If CanControl is **false**, this property should also be **false**.

##### Rationale:
Not all media is pausable: it may not be possible to pause some streamed media, for example.

### Method
Read only

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **CanPause** (b) - True if playback can be paused, false otherwise.

#### Response Example
```json
{
  "CanPause": true
}
```
```

--------------------------------

### TrackListReplaced Signal

Source: https://specifications.freedesktop.org/mpris/latest/Track_List_Interface

Emitted when the entire tracklist has been replaced. It's up to the implementation to decide when a change is invasive enough to emit this signal instead of individual TrackAdded/TrackRemoved signals.

```APIDOC
## TrackListReplaced Signal

### Description
Indicates that the entire tracklist has been replaced. This signal is emitted when a change to the track list is considered invasive enough by the implementation, rather than emitting a series of TrackAdded and TrackRemoved signals.

### Parameters

#### Path Parameters
- **Tracks** (ao: Track_Id_List) - Required - The new content of the tracklist.
- **CurrentTrack** (o: Track_Id) - Required - The identifier of the track to be considered as current. `/org/mpris/MediaPlayer2/TrackList/NoTrack` indicates no current track.
```

--------------------------------

### TrackMetadataChanged Signal

Source: https://specifications.freedesktop.org/mpris/latest/Track_List_Interface

Emitted when the metadata of a track in the tracklist has changed. It includes the TrackId and the new Metadata.

```APIDOC
## TrackMetadataChanged Signal

### Description
Indicates that the metadata of a track in the tracklist has changed. This may indicate a track replacement if the `mpris:trackid` metadata entry differs from the provided `TrackId` argument.

### Parameters

#### Path Parameters
- **TrackId** (o: Track_Id) - Required - The id of the track whose metadata has changed. If the track id has changed, this will be the old value. `/org/mpris/MediaPlayer2/TrackList/NoTrack` is not a valid value.
- **Metadata** (a{sv}: Metadata_Map) - Required - The new track metadata. Must include a `mpris:trackid` entry. If the track id has changed, this will be the new value.
```

--------------------------------

### TrackRemoved Signal

Source: https://specifications.freedesktop.org/mpris/latest/Track_List_Interface

Emitted when a track has been removed from the track list, identified by its TrackId.

```APIDOC
## TrackRemoved Signal

### Description
Indicates that a track has been removed from the track list.

### Parameters

#### Path Parameters
- **TrackId** (o: Track_Id) - Required - The identifier of the track being removed. `/org/mpris/MediaPlayer2/TrackList/NoTrack` is not a valid value.
```
Tokens:
Raw