1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
|
BlueZ D-Bus Audio API description
*********************************
Copyright (C) 2004-2010 Marcel Holtmann <marcel@holtmann.org>
Copyright (C) 2005-2007 Johan Hedberg <johan.hedberg@nokia.com>
Copyright (C) 2005-2006 Brad Midgley <bmidgley@xmission.com>
Audio hierarchy
===============
Service org.bluez
Interface org.bluez.Audio
Object path [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX
This is a generic audio interface that abstracts the different audio profiles.
Methods void Connect()
Connect all supported audio profiles on the device.
void Disconnect()
Disconnect all audio profiles on the device
dict GetProperties()
Returns all properties for the interface. See the
properties section for available properties.
Signals void PropertyChanged(string name, variant value)
This signal indicates a changed value of the given
property.
Properties string State
Possible values: "disconnected", "connecting",
"connected"
"disconnected" -> "connecting"
Either an incoming or outgoing connection
attempt ongoing.
"connecting" -> "disconnected"
Connection attempt failed
"connecting" -> "connected"
Successfully connected
"connected" -> "disconnected"
Disconnected from the remote device
Headset hierarchy
=================
Service org.bluez
Interface org.bluez.Headset
Object path [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX
Methods void Connect()
Connect to the HSP/HFP service on the remote device.
void Disconnect()
Disconnect from the HSP/HFP service on the remote
device.
boolean IsConnected() {deprecated}
Returns TRUE if there is a active connection to the
HSP/HFP connection on the remote device.
void IndicateCall()
Indicate an incoming call on the headset
connected to the stream. Will continue to
ring the headset about every 3 seconds.
void CancelCall()
Cancel the incoming call indication.
void Play()
Open the audio connection to the headset.
void Stop()
Close the audio connection.
boolean IsPlaying() {deprecated}
Returns true if an audio connection to the headset
is active.
uint16 GetSpeakerGain() {deprecated}
Returns the current speaker gain if available,
otherwise returns the error NotAvailable.
uint16 GetMicrophoneGain() {deprecated}
Returns the current microphone gain if available,
otherwise returns the error NotAvailable.
void SetSpeakerGain(uint16 gain) {deprecated}
Changes the current speaker gain if possible.
void SetMicrophoneGain(uint16 gain) {deprecated}
Changes the current speaker gain if possible.
dict GetProperties()
Returns all properties for the interface. See the
properties section for available properties.
Possible Errors: org.bluez.Error.InvalidArguments
void SetProperty(string name, variant value)
Changes the value of the specified property. Only
properties that are listed a read-write are changeable.
On success this will emit a PropertyChanged signal.
Possible Errors: org.bluez.Error.DoesNotExist
org.bluez.Error.InvalidArguments
Signals void AnswerRequested()
Sent when the answer button is pressed on the headset
void Connected() {deprecated}
Sent when the device has been connected to.
void Disconnected() {deprecated}
Sent when the device has been disconnected from.
void Stopped() {deprecated}
Sent when the audio connection is closed
void Playing() {deprecated}
Sent when the audio connection is opened
void SpeakerGainChanged(uint16 gain) {deprecated}
The speaker gain changed.
void MicrophoneGainChanged(uint16 gain) {deprecated}
The microphone gain changed.
PropertyChanged(string name, variant value)
This signal indicates a changed value of the given
property.
properties string State [readonly]
Possible values: "disconnected", "connecting",
"connected", "playing"
"disconnected" -> "connecting"
Either an incoming or outgoing connection
attempt ongoing.
"connecting" -> "disconnected"
Connection attempt failed
"connecting" -> "connected"
Successfully connected
"connected" -> "playing"
SCO audio connection successfully opened
"playing" -> "connected"
SCO audio connection closed
"connected" -> "disconnected"
"playing" -> "disconnected"
Disconnected from the remote device
boolean Connected [readonly]
Indicates if there is a active connection to the
HSP/HFP connection on the remote device.
boolean Playing [readonly]
Indicates if an audio connection to the headset
is active.
uint16 SpeakerGain [readwrite]
The speaker gain when available.
uint16 MicrophoneGain [readwrite]
The speaker gain when available.
AudioSink hierarchy
===================
Service org.bluez
Interface org.bluez.AudioSink
Object path [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX
Methods void Connect()
Connect and setup a stream to a A2DP sink on the
remote device.
void Disconnect()
Disconnect from the remote device.
boolean IsConnected() {deprecated}
Returns TRUE if a stream is setup to a A2DP sink on
the remote device.
dict GetProperties()
Returns all properties for the interface. See the
properties section for available properties.
Possible Errors: org.bluez.Error.InvalidArguments
Signals void Connected() {deprecated}
Sent when a successful connection has been made to the
remote A2DP Sink
void Disconnected() {deprecated}
Sent when the device has been disconnected from.
void Playing() {deprecated}
Sent when a stream with remote device is started.
void Stopped() {deprecated}
Sent when a stream with remote device is suspended.
PropertyChanged(string name, variant value)
This signal indicates a changed value of the given
property.
properties string State [readonly]
Possible values: "disconnected", "connecting",
"connected", "playing"
"disconnected" -> "connecting"
Either an incoming or outgoing connection
attempt ongoing.
"connecting" -> "disconnected"
Connection attempt failed
"connecting" -> "connected"
Successfully connected
"connected" -> "playing"
Audio stream active
"playing" -> "connected"
Audio stream suspended
"connected" -> "disconnected"
"playing" -> "disconnected"
Disconnected from the remote device
boolean Connected [readonly]
Indicates if a stream is setup to a A2DP sink on
the remote device.
boolean Playing [readonly]
Indicates if a stream is active to a A2DP sink on
the remote device.
AudioSource hierarchy
=====================
Service org.bluez
Interface org.bluez.AudioSource
Object path [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX
Methods void Connect()
Connect and setup a stream to a A2DP source on the
remote device.
void Disconnect()
Disconnect from the remote device.
dict GetProperties()
Returns all properties for the interface. See the
properties section for available properties.
Possible Errors: org.bluez.Error.InvalidArguments
Signals PropertyChanged(string name, variant value)
This signal indicates a changed value of the given
property.
properties string State [readonly]
Possible values: "disconnected", "connecting",
"connected", "playing"
"disconnected" -> "connecting"
Either an incoming or outgoing connection
attempt ongoing.
"connecting" -> "disconnected"
Connection attempt failed
"connecting" -> "connected"
Successfully connected
"connected" -> "playing"
Audio stream active
"playing" -> "connected"
Audio stream suspended
"connected" -> "disconnected"
"playing" -> "disconnected"
Disconnected from the remote device
HeadsetGateway hierarchy
========================
Service org.bluez
Interface org.bluez.HeadsetGateway
Object path [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX
This interface is available for remote devices which can function in the Audio
Gateway role of the HFP profiles.
Methods void Connect()
Connect to the AG service on the remote device.
void Disconnect()
Disconnect from the AG service on the remote device
void AnswerCall()
It has to called only after Ring signal received.
void TerminateCall()
Terminate call which is running or reject an incoming
call. This has nothing with any 3-way situation incl.
RaH. Just plain old PDH.
void Call(string number)
Dial a number 'number'. No number processing is done
thus if AG would reject to dial it don't blame me :)
string GetOperatorName()
Find out the name of the currently selected network
operator by AG.
void SendDTMF(string digits)
Will send each digit in the 'digits' sequentially. Would
send nothing if there is non-dtmf digit.
string GetSubscriberNumber()
Get the voicecall subscriber number of AG
dict GetProperties()
Returns all properties for the interface. See the
properties section for available properties.
Signals void Ring(string number)
Someone's calling from 'number'.
Caller number is provided as received from AG.
void CallTerminated()
Call failed to set up. It means that we tried to call
someone or someone tried to call us but call was not
accepted.
void CallStarted()
Call set up successfully.
void CallEnded()
Call was started and now ended. In contrast with
CallTerminated where call didn't started
PropertyChanged(string name, variant value)
This signal indicates a changed value of the given
property.
properties boolean Connected [readonly]
Indicates if there is an active connection to the
AG service on the remote device.
uint16 RegistrationStatus [readonly]
Service availability indicatior of AG, where:
0 implies no service. No Home/Roam network available.
1 implies presense of service. Home/Roam network
available.
uint16 SignalStrength [readonly]
Signal strength indicator of AG, the value ranges from
0 to 5.
uint16 RoamingStatus [readonly]
Roaming status indicator of AG, where:
0 means roaming is not active
1 means a roaming is active
uint16 BatteryCharge [readonly]
Battery Charge indicator of AG, the value ranges from
0 to 5.
uint16 SpeakerGain [readonly]
The speaker gain when available.
uint16 MicrophoneGain [readonly]
The speaker gain when available.
|
