org.bluez.MediaPlayer - BlueZ D-Bus MediaPlayer API documentation
Contents
Interface
Service
org.bluez (Controller role)
Interface
org.bluez.MediaPlayer1
Objectpath
[variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX/playerX
MethodsvoidPlay()
Resume playback.
Possible Errors:
org.bluez.Error.NotSupportedorg.bluez.Error.FailedvoidPause()
Pause playback.
Possible Errors:
org.bluez.Error.NotSupportedorg.bluez.Error.FailedvoidStop()
Stop playback.
Possible Errors:
org.bluez.Error.NotSupportedorg.bluez.Error.FailedvoidNext()
Next item.
Possible Errors:
org.bluez.Error.NotSupportedorg.bluez.Error.FailedvoidPrevious()
Previous item.
Possible Errors:
org.bluez.Error.NotSupportedorg.bluez.Error.FailedvoidFastForward()
Fast forward playback, this action is only stopped when another method in this interface is called.
Possible Errors:
org.bluez.Error.NotSupportedorg.bluez.Error.FailedvoidRewind()
Rewind playback, this action is only stopped when another method in this interface is called.
Possible Errors:
org.bluez.Error.NotSupportedorg.bluez.Error.FailedvoidPress(byteavc_key)
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:
org.bluez.Error.InvalidArgumentsorg.bluez.Error.NotSupportedorg.bluez.Error.FailedvoidHold(byteavc_key)
Press and hold a specific key to send as passthrough command. It is your responsibility 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:
org.bluez.Error.InvalidArgumentsorg.bluez.Error.NotSupportedorg.bluez.Error.FailedvoidRelease()
Release the previously held key invoked using Hold().
Possible Errors:
org.bluez.Error.NotSupportedorg.bluez.Error.FailedPropertiesstringEqualizer[readwrite]
Indicates Player Equalizer setting.
Possible values:
"off""on"stringRepeat[readwrite]
Indicates Player Repeat setting.
Possible values:
"off""singletrack""alltracks""group"stringShuffle[readwrite]
Indicates Player Suffle setting.
Possible values:
"off""alltracks""group"stringScan[readwrite]
Indicates Player Scan setting.
Possible values:
"off""alltracks""group"stringStatus[readonly]
Indicates Player Status setting.
Possible status:
"playing""stopped""paused""forward-seek""reverse-seek""error"uint32Position[readonly]
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.
dictTrack[readonly]
Track metadata.
Possible values:
stringTitle
Track title name
stringArtist
Track artist name
stringAlbum
Track album name
stringGenre
Track genre name
uint32NumberOfTracks
Number of tracks in total
uint32TrackNumber
Track number
uint32Duration
Track duration in milliseconds
stringImgHandle
[experimental]
Track image handle, available and valid only during the lifetime of an OBEX BIP connection to
the ObexPort.
objectDevice[readonly]
Device object path.
stringName[readonly]
Player name
stringType[readonly]
Player type
Possible values:
"Audio" "Video" "Audio Broadcasting" "Video Broadcasting"
stringSubtype[readonly]
Player subtype
Possible values:
"Audio Book" "Podcast"
booleanBrowsable[readonly]
If present indicates the player can be browsed using MediaFolder interface.
Possible values:
True Supported and active
False Supported but inactive
Note: If supported but inactive clients can enable it by using MediaFolder interface but it might
interfere in the playback of other players.
booleanSearchable[readonly]
If present indicates the player can be searched using MediaFolder interface.
Possible values:
True Supported and active
False Supported but inactive
Note: If supported but inactive clients can enable it by using MediaFolder interface but it might
interfere in the playback of other players.
objectPlaylist
Playlist object path.
uint16ObexPort[readonly,experimental]
If present indicates the player can get cover art using BIP over OBEX on this PSM port.
BlueZ September 2023 ORG.BLUEZ.MEDIAPLAYER(5)
Name
org.bluez.MediaPlayer - BlueZ D-Bus MediaPlayer API documentation
