Update API description to match current implementation

1 files changed, 49 insertions, 25 deletions

diff --git a/audio/audio-api.txt b/audio/audio-api.txt
index e123689e..497c6cb6 100644
--- a/audio/audio-api.txt
+++ b/audio/audio-api.txt
@@ -23,6 +23,10 @@ Methods		array{string} ListHeadsets()
 			Returns the object path for the default
 			headset device.
 
+		void ChangeDefaultHeadset(string path)
+
+			Changes the default headset.
+
 		string CreateHeadset(string address)
 
 			Create a new headset device and returns
@@ -30,12 +34,21 @@ Methods		array{string} ListHeadsets()
 
 		void RemoveHeadset(string path)
 
+			Removes a headset object and all information
+			related to it.
+
 Signals		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.
+
 
 Audio Headset hierarchy
 =======================
@@ -44,28 +57,12 @@ Service		org.bluez.audio
 Interface	org.bluez.audio.Headset
 Object path	/org/bluez/audio/headset*
 
-Methods		string GetAddress()
-
-		string GetName()
-
-		void Connect()
+Methods		void Connect()
 
 		void Disconnect()
 
 		boolean IsConnected()
 
-		uint16 GetSpeakerGain()
-
-		uint16 GetMicrophoneGain()
-
-		void SetSpeakerGain(uint16 gain)
-
-			Gain is 0..15
-
-		void SetMicrophoneGain(uint16 gain)
-
-			Gain is 0..15
-
 		void IndicateCall()
 
 			Indicate an incoming call on the headset
@@ -76,18 +73,45 @@ Methods		string GetAddress()
 
 			Cancel the incoming call indication.
 
-Signals		void SpeakerGainChanged(uint16 gain)
+		void Play()
+	
+			Open the audio connection to the headset.
 
-			The speaker gain changed.
+		void Stop()
 
-		void MicrophoneGainChanged(uint16 gain)
+			Close the audio connection.
 
-			The microphone gain changed.
+		boolean IsPlaying()
+
+			Returns true if an audio connection to the headset
+			is active.
+
+
+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()
 
-		void CallIndicated()
+			Sent when the device has been disconnected from.
 
-			An incoming call was indicated.
+		void Stopped()
 
-		void CallCanceled()
+			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.
 
-			Incoming call was canceled.