Add skeleton for org.bluez.Audio interface

1 files changed, 51 insertions, 0 deletions

diff --git a/doc/audio-api.txt b/doc/audio-api.txt
index 34379f5df..8c6117216 100644
--- a/doc/audio-api.txt
+++ b/doc/audio-api.txt
@@ -5,6 +5,57 @@ 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>
 
+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", "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
 
 Headset hierarchy
 =================