From: Archie Pusaka <apusaka@chromium.org>
Date: Thu, 3 Sep 2020 03:50:37 +0000 (+0800)
Subject: doc/media-api: Add Press/Hold/Release methods for MediaPlayer1
X-Git-Tag: submit/tizen/20210606.232858~8
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=cb382308cc0865d422b6c7eb097b4dfc031fd8be;p=platform%2Fupstream%2Fbluez.git

doc/media-api: Add Press/Hold/Release methods for MediaPlayer1

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>
Signed-off-by: Anuj Jain <anuj01.jain@samsung.com>
Signed-off-by: Ayush Garg <ayush.garg@samsung.com>
---

diff --git a/doc/media-api.txt b/doc/media-api.txt
index dabc6993..e9857315 100755
--- 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"