org.bluez.MediaPlayer(5) Linux System Administration org.bluez.MediaPlayer(5)

org.bluez.MediaPlayer - BlueZ D-Bus MediaPlayer API documentation

org.bluez (Controller role)
org.bluez.MediaPlayer1
[variable prefix]/{hci0,hci1,...}/dev_{BDADDR}/player#
bluetoothctl-player(1)

Resume playback.

Possible Errors:

Examples:

> player.play [item]

Pause playback.

Possible Errors:

Examples:

> player.pause

Stop playback.

Possible Errors:

Examples:

> player.stop

Next item.

Possible Errors:

Examples:

> player.next

Previous item.

Possible Errors:

Examples:

> player.previous

Fast forward playback, this action is only stopped when another method in this interface is called.

Possible Errors:

Examples:

> player.fast-forward

Rewind playback, this action is only stopped when another method in this interface is called.

Possible Errors:

Examples:

> player.rewind

Press a specific key to send as passthrough command.

The key will be released automatically. Use Hold() instead if the intention is to hold down the key.

Possible Errors:

Press and hold a specific key to send as passthrough command. It is the responsibility of the caller to make sure that Release() is called after calling this method.

The held key will also be released when any other method in this interface is called.

Possible Errors:

Release the previously held key invoked using Hold().

Possible Errors:

Indicates Player Equalizer setting.

Possible values:

"off"
"on"

Examples:

[player] > equalizer <on/off>

Indicates Player Repeat setting.

Possible values:

"off"
"singletrack"
"alltracks"
"group"

Examples:

[player] > repeat <singletrack/alltracks/group/off>

Indicates Player Suffle setting.

Possible values:

"off"
"alltracks"
"group"

Examples:

[player] > shuffle <alltracks/group/off>

Indicates Player Scan setting.

Possible values:

"off"
"alltracks"
"group"

Examples:

[player] > scan <alltracks/group/off>

Indicates Player Status setting.

Possible status:

"playing"
"stopped"
"paused"
"forward-seek"
"reverse-seek"
"error"

Playback position in milliseconds.

Changing the position may generate additional events that will be sent to the remote device. When position is 0 it means the track is starting and when it's greater than or equal to track's duration the track has ended.

Note that even if duration is not available in metadata it's possible to signal its end by setting position to the maximum uint32 value.

Track metadata.

Possible values:

Track title name
Track artist name
Track album name
Track genre name
Number of tracks in total
Track number
Track duration in milliseconds
[experimental]

Track image handle, available and valid only during the lifetime of an OBEX BIP connection to the ObexPort.

Device object path.

Player name.

Player type.

Possible values:

"Audio"
"Video"
"Audio Broadcasting"
"Video Broadcasting"

Player subtype.

Possible values:

"Audio Book"
"Podcast"

If present indicates the player can be browsed using MediaFolder interface.

Possible values:

Supported and active
Supported but inactive

Note: If supported but inactive clients can enable it by using org.bluez.MediaFolder(5) interface but it might interfere in the playback of other players.

If present indicates the player can be searched using MediaFolder interface.

Possible values:

Supported and active
Supported but inactive

Note: If supported but inactive clients can enable it by using org.bluez.MediaFolder(5) interface but it might interfere in the playback of other players.

Playlist object path.

If present indicates the player can get cover art using BIP over OBEX on this PSM port.

September 2023 BlueZ