aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJohan Hedberg <johan.hedberg@nokia.com>2009-03-24 21:41:43 +0200
committerJohan Hedberg <johan.hedberg@nokia.com>2009-03-24 21:41:43 +0200
commit5427c56e495250cdf116ea77630ee85b37833291 (patch)
treea7577179baaf42aedf322b1b3fa3a4758943a123 /doc
parent763e9253e0f889202f199a4e61e19daa640a31c2 (diff)
downloadbluez-5427c56e495250cdf116ea77630ee85b37833291.tar.gz
Add State property to the AudioSink interface
This patch adds a new string State property to the AudioSink interface. It makes use of the recently added AVDTP connection state tracking support to create a "connecting" state.
Diffstat (limited to 'doc')
-rw-r--r--doc/audio-api.txt28
1 files changed, 27 insertions, 1 deletions
diff --git a/doc/audio-api.txt b/doc/audio-api.txt
index 64e13740..59c8e647 100644
--- a/doc/audio-api.txt
+++ b/doc/audio-api.txt
@@ -211,7 +211,33 @@ Signals void Connected() {deprecated}
This signal indicates a changed value of the given
property.
-properties boolean Connected [readonly]
+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
+
+
+ boolean Connected [readonly]
Indicates if a stream is setup to a A2DP sink on
the remote device.