Index: audio-api.txt
===================================================================
RCS file: /cvsroot/bluez/utils/audio/audio-api.txt,v
retrieving revision 1.13
diff -u -3 -p -u -r1.13 audio-api.txt
--- audio-api.txt 18 May 2007 19:09:46 -0000 1.13
+++ audio-api.txt 21 May 2007 16:40:49 -0000
@@ -12,12 +12,12 @@ org.bluez.audio.Manager interface
Object path /org/bluez/audio
Methods
- string CreateDevice(string address)
+ string CreateDevice(string address, array{string} interfaces)
- Creates a new audio device object. If not yet done,
- this method will perform a SDP query on the remote
- device and return first when the query is complete,
- so be sure to call this method asynchronously.
+ Creates a new audio device object. This method will
+ perform a SDP query on the remote device based on
+ the given interfaces. This may fail if the remote
+ device doesn't implement one of the given interfaces.
The return parameter is the object path of the newly
created object.
@@ -25,39 +25,22 @@ Methods
void RemoveDevice(string path)
Removes a device from the device tree. If there are
- any connections open to the device they will be closed.
+ any connections open to the device they will be closed.
- array{string} ListDevices()
+ array{string} ListDevices(string interface)
Retuns an array of strings indicating the object paths
of available devices
- array{string} ListHeadsets()
+ string FindDevice(string pattern)
- Returns list of headset objects that
- are configured.
+ string DefaultDevice(string interface)
- string DefaultHeadset()
+ string ChangeDefaultDevice(string interface, string pattern)
- Returns the object path for the default
- headset device.
+ Changes the default device to the given interface.
- void ChangeDefaultHeadset(string path)
-
- Changes the default headset.
-
- string CreateHeadset(string address)
-
- Create a new headset device and returns
- its object path on return.
-
- void RemoveHeadset(string path)
-
- Removes a headset object and all information
- related to it.
-
-Signals
- void DeviceCreated(string path)
+Signals void DeviceCreated(string path)
Sent when a new device object has been created.
@@ -65,95 +48,74 @@ Signals
Sent when a device object has been removed.
- void HeadsetCreated(string path)
-
- Sent when a new headset object has been created.
-
- void HeadsetRemoved(string path)
-
- Sent when a headset object has been removed.
-
- void DefaultHeadsetChanged(string path)
-
- Sent when the default headset has changed.
+ void DefaultDeviceChanged(string interface, string path)
+ Sent when the default device has changed for the
+ interface.
org.bluez.audio.Device interface
================================
Object path(s) /org/bluez/audio/device*
-Methods string GetAddress()
-
- Returns the Bluetooth address of the remote device.
-
- array{string} GetConnectedInterfaces() [experimental]
-
- Returns a string list of interfaces that are in a
- connected state.
-
-
-org.bluez.audio.Headset interface
-=================================
-
-Object path(s) /org/bluez/audio/device*
-
Methods void Connect()
void Disconnect()
boolean IsConnected()
- void IndicateCall()
+ string GetAddress()
- Indicate an incoming call on the headset
- connected to the stream. Will continue to
- ring the headset about every 3 seconds.
+ Returns the Bluetooth address of the remote device.
- void CancelCall()
+ array{string} GetConnectedInterfaces() [experimental]
- Cancel the incoming call indication.
+ Returns a string list of interfaces that are in a
+ connected state.
- void Play()
+ void ChangeSpeakerGain(uint16 gain)
- Open the audio connection to the headset.
+ Change speaker gain.
- void Stop()
+ void ChangeMicrophoneGain(uint16 gain)
- Close the audio connection.
+ Change microphone gain.
- boolean IsPlaying()
+Signals void Connected()
- Returns true if an audio connection to the headset
- is active.
+ Sent when the device has been connected to.
-Signals void AnswerRequested()
+ void Disconnected()
- Sent when the answer button is pressed on the headset
+ Sent when the device has been disconnected from.
- void Connected()
+ void SpeakerGainChanged(uint16 gain)
- Sent when the device has been connected to.
+ The speaker gain changed.
- void Disconnected()
+ void MicrophoneGainChanged(uint16 gain)
- Sent when the device has been disconnected from.
+ The microphone gain changed.
- void Stopped()
+org.bluez.audio.Headset interface
+=================================
- Sent when the audio connection is closed
+Object path(s) /org/bluez/audio/device*
- void Playing()
+Methods void IndicateCall()
- Sent when the audio connection is opened
+ Indicate an incoming call on the headset
+ connected to the stream. Will continue to
+ ring the headset about every 3 seconds.
- void SpeakerGainChanged(uint16 gain)
+ void CancelCall()
- The speaker gain changed.
+ Cancel the incoming call indication.
- void MicrophoneGainChanged(uint16 gain)
- The microphone gain changed.
+Signals void AnswerRequested()
+
+ Sent when the answer button is pressed on the headset
org.bluez.audio.Source interface