summaryrefslogtreecommitdiffstats
path: root/doc/audio-api.txt
diff options
context:
space:
mode:
authorMarcel Holtmann <marcel@holtmann.org>2008-05-29 21:21:11 +0000
committerMarcel Holtmann <marcel@holtmann.org>2008-05-29 21:21:11 +0000
commitbc23c086b3e41836fb8c680c2c7108cadd395f91 (patch)
treeabeedc0a48ab45e28664497ae4c01223e75c5bd3 /doc/audio-api.txt
parenta93a6fa2f4091679556db6ddd65b3291592fe9c9 (diff)
Add initial version of new audio API
Diffstat (limited to 'doc/audio-api.txt')
-rw-r--r--doc/audio-api.txt154
1 files changed, 154 insertions, 0 deletions
diff --git a/doc/audio-api.txt b/doc/audio-api.txt
new file mode 100644
index 00000000..941f7ef7
--- /dev/null
+++ b/doc/audio-api.txt
@@ -0,0 +1,154 @@
+BlueZ D-Bus Audio API description
+*********************************
+
+Copyright (C) 2004-2008 Marcel Holtmann <marcel@holtmann.org>
+Copyright (C) 2005-2007 Johan Hedberg <johan.hedberg@nokia.com>
+Copyright (C) 2005-2006 Brad Midgley <bmidgley@xmission.com>
+
+
+Headset hierarchy
+=================
+
+Service org.bluez
+Interface org.bluez.Headset
+Object path /{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()
+
+ 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()
+
+ Returns true if an audio connection to the headset
+ is active.
+
+ uint16 GetSpeakerGain()
+
+ Returns the current speaker gain if available,
+ otherwise returns the error NotAvailable.
+
+ uint16 GetMicrophoneGain()
+
+ Returns the current microphone gain if available,
+ otherwise returns the error NotAvailable.
+
+ void SetSpeakerGain(uint16 gain)
+
+ Changes the current speaker gain if possible.
+
+ void SetMicrophoneGain(uint16 gain)
+
+ Changes the current speaker gain if possible.
+
+ void SetupCall(string value) [experimental]
+
+ Sets up an call with the connected HFP. The value can
+ be "incoming", "outgoing" or "remote" to indicate
+ incoming call, outgoing call and remote party alerted
+ respectively.
+
+ void IdentifyCall(string phone_number, int32 type) [experimental]
+
+ Enables a called subscriber to get the calling
+ line identity (CLI) of the calling party when
+ receiving a call. The value of type shud be
+ the same as provided by the GSM stack.
+
+Signals void AnswerRequested()
+
+ Sent when the answer button is pressed on the headset
+
+ void Connected()
+
+ Sent when the device has been connected to.
+
+ void Disconnected()
+
+ Sent when the device has been disconnected from.
+
+ void Stopped()
+
+ Sent when the audio connection is closed
+
+ void Playing()
+
+ Sent when the audio connection is opened
+
+ void SpeakerGainChanged(uint16 gain)
+
+ The speaker gain changed.
+
+ void MicrophoneGainChanged(uint16 gain)
+
+ The microphone gain changed.
+
+ void CallTerminated()
+
+ Sent when an ongoing call is terminated.
+
+
+Headset hierarchy
+=================
+
+Service org.bluez
+Interface org.bluez.Sink
+Object path /{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()
+
+ Returns TRUE if a stream is setup to a A2DP sink on
+ the remote device.
+
+Signals void Connected()
+
+ Sent when a successful connection has been made to the
+ remote A2DP Sink
+
+ void Disconnected()
+
+ Sent when the device has been disconnected from.
+
+ void Playing()
+
+ Sent when a stream with remote device is started.
+
+ void Stopped()
+
+ Sent when a stream with remote device is suspended.