1ORG.BLUEZ.MEDIAPLAYER(5)  Linux System Administration ORG.BLUEZ.MEDIAPLAYER(5)
2
3
4

NAME

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

INTERFACE

9       Service
10              org.bluez (Controller role)
11
12       Interface
13              org.bluez.MediaPlayer1
14
15       Object path
16              [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX/playerX
17
18   Methods
19   void Play()
20          Resume playback.
21
22          Possible Errors:
23
24          org.bluez.Error.NotSupported
25
26          org.bluez.Error.Failed
27
28   void Pause()
29          Pause playback.
30
31          Possible Errors:
32
33          org.bluez.Error.NotSupported
34
35          org.bluez.Error.Failed
36
37   void Stop()
38          Stop playback.
39
40          Possible Errors:
41
42          org.bluez.Error.NotSupported
43
44          org.bluez.Error.Failed
45
46   void Next()
47          Next item.
48
49          Possible Errors:
50
51          org.bluez.Error.NotSupported
52
53          org.bluez.Error.Failed
54
55   void Previous()
56          Previous item.
57
58          Possible Errors:
59
60          org.bluez.Error.NotSupported
61
62          org.bluez.Error.Failed
63
64   void FastForward()
65          Fast  forward  playback,  this  action  is only stopped when another
66          method in this interface is called.
67
68          Possible Errors:
69
70          org.bluez.Error.NotSupported
71
72          org.bluez.Error.Failed
73
74   void Rewind()
75          Rewind playback, this action is only stopped when another method  in
76          this interface is called.
77
78          Possible Errors:
79
80          org.bluez.Error.NotSupported
81
82          org.bluez.Error.Failed
83
84   void Press(byte avc_key)
85          Press a specific key to send as passthrough command. The key will be
86          released automatically. Use Hold() instead if the  intention  is  to
87          hold down the key.
88
89          Possible Errors:
90
91          org.bluez.Error.InvalidArguments
92
93          org.bluez.Error.NotSupported
94
95          org.bluez.Error.Failed
96
97   void Hold(byte avc_key)
98          Press  and hold a specific key to send as passthrough command. It is
99          your responsibility to make sure  that  Release()  is  called  after
100          calling  this  method.  The  held key will also be released when any
101          other method in this interface is called.
102
103          Possible Errors:
104
105          org.bluez.Error.InvalidArguments
106
107          org.bluez.Error.NotSupported
108
109          org.bluez.Error.Failed
110
111   void Release()
112          Release the previously held key invoked using Hold().
113
114          Possible Errors:
115
116          org.bluez.Error.NotSupported
117
118          org.bluez.Error.Failed
119
120   Properties
121   string Equalizer [readwrite]
122          Indicates Player Equalizer setting.
123
124          Possible values:
125
126          "off"
127
128          "on"
129
130   string Repeat [readwrite]
131          Indicates Player Repeat setting.
132
133          Possible values:
134
135          "off"
136
137          "singletrack"
138
139          "alltracks"
140
141          "group"
142
143   string Shuffle [readwrite]
144          Indicates Player Suffle setting.
145
146          Possible values:
147
148          "off"
149
150          "alltracks"
151
152          "group"
153
154   string Scan [readwrite]
155          Indicates Player Scan setting.
156
157          Possible values:
158
159          "off"
160
161          "alltracks"
162
163          "group"
164
165   string Status [readonly]
166          Indicates Player Status setting.
167
168          Possible status:
169
170          "playing"
171
172          "stopped"
173
174          "paused"
175
176          "forward-seek"
177
178          "reverse-seek"
179
180          "error"
181
182   uint32 Position [readonly]
183          Playback position in milliseconds. Changing the position may  gener‐
184          ate  additional  events that will be sent to the remote device. When
185          position is 0 it means the track is starting and when  it's  greater
186          than or equal to track's duration the track has ended.
187
188          Note  that even if duration is not available in metadata it's possi‐
189          ble to signal its end by setting  position  to  the  maximum  uint32
190          value.
191
192   dict Track [readonly]
193          Track metadata.
194
195          Possible values:
196
197          string Title
198                 Track title name
199
200          string Artist
201                 Track artist name
202
203          string Album
204                 Track album name
205
206          string Genre
207                 Track genre name
208
209          uint32 NumberOfTracks
210                 Number of tracks in total
211
212          uint32 TrackNumber
213                 Track number
214
215          uint32 Duration
216                 Track duration in milliseconds
217
218   object Device [readonly]
219          Device object path.
220
221   string Name [readonly]
222          Player name
223
224   string Type [readonly]
225          Player type
226
227          Possible values:
228              "Audio" "Video" "Audio Broadcasting" "Video Broadcasting"
229
230   string Subtype [readonly]
231          Player subtype
232
233          Possible values:
234              "Audio Book" "Podcast"
235
236   boolean Browsable [readonly]
237          If present indicates the player can be browsed using MediaFolder in‐
238          terface.
239
240          Possible values:
241
242          True   Supported and active
243
244          False  Supported but inactive
245
246          Note: If supported but inactive clients can enable it by using Medi‐
247          aFolder  interface  but  it might interfere in the playback of other
248          players.
249
250   boolean Searchable [readonly]
251          If present indicates the player can be  searched  using  MediaFolder
252          interface.
253
254          Possible values:
255
256          True   Supported and active
257
258          False  Supported but inactive
259
260          Note: If supported but inactive clients can enable it by using Medi‐
261          aFolder interface but it might interfere in the  playback  of  other
262          players.
263
264   object Playlist
265          Playlist object path.
266
267
268
269
270BlueZ                           September 2023        ORG.BLUEZ.MEDIAPLAYER(5)