diff mbox series

[Bluez,v3,1/2] doc/media-api: Add Press/Hold/Release methods for MediaPlayer1

Message ID 20200903115020.Bluez.v3.1.I6767a68b7e7b6cfb6d8046ee8b66c8e7d008d3e6@changeid
State New
Headers show
Series [Bluez,v3,1/2] doc/media-api: Add Press/Hold/Release methods for MediaPlayer1 | expand

Commit Message

Archie Pusaka Sept. 3, 2020, 3:50 a.m. UTC 
From: Archie Pusaka <apusaka@chromium.org>

This allows us to send any passthrough command. The button can also
be held for an extended amount of time.

Reviewed-by: Michael Sun <michaelfsun@chromium.org>
---

(no changes since v2)

Changes in v2:
* Add Hold and Release methods

 doc/media-api.txt | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
diff mbox series

Patch

diff --git a/doc/media-api.txt b/doc/media-api.txt
index dabc69936..e98573157 100644
--- a/doc/media-api.txt
+++ b/doc/media-api.txt
@@ -199,6 +199,35 @@  Methods		void Play()
 			Possible Errors: org.bluez.Error.NotSupported
 					 org.bluez.Error.Failed
 
+		void Press(byte avc_key)
+
+			Press a specific key to send as passthrough command.
+			The key will be released automatically. Use Hold()
+			instead if the intention is to hold down the key.
+
+			Possible Errors: org.bluez.Error.InvalidArguments
+					 org.bluez.Error.NotSupported
+					 org.bluez.Error.Failed
+
+		void Hold(byte avc_key)
+
+			Press and hold a specific key to send as passthrough
+			command. It is your responsibility to make sure that
+			Release() is called after calling this method. The held
+			key will also be released when any other method in this
+			interface is called.
+
+			Possible Errors: org.bluez.Error.InvalidArguments
+					 org.bluez.Error.NotSupported
+					 org.bluez.Error.Failed
+
+		void Release()
+
+			Release the previously held key invoked using Hold().
+
+			Possible Errors: org.bluez.Error.NotSupported
+					 org.bluez.Error.Failed
+
 Properties	string Equalizer [readwrite]
 
 			Possible values: "off" or "on"