aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLuiz Augusto von Dentz <luiz.dentz@openbossa.org>2009-07-21 10:05:17 -0300
committerLuiz Augusto von Dentz <luiz.dentz@openbossa.org>2009-07-31 10:25:16 -0300
commita225cd153ad9dee469665bf944f14993dc452438 (patch)
tree3a84ff56dbf6dfbc1f512314d4882f9cf579de5c /doc
parenta30fbb241d5e79c46ecff148526d7c04f4409396 (diff)
downloadbluez-a225cd153ad9dee469665bf944f14993dc452438.tar.gz
Update audio-api.txt including AudioSource documentation.
Diffstat (limited to 'doc')
-rw-r--r--doc/audio-api.txt53
1 files changed, 53 insertions, 0 deletions
diff --git a/doc/audio-api.txt b/doc/audio-api.txt
index 95ebcf53..1f09cd51 100644
--- a/doc/audio-api.txt
+++ b/doc/audio-api.txt
@@ -290,6 +290,59 @@ properties string State [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
========================