doc/media-api: Add Press/Hold/Release methods for MediaPlayer1
authorArchie Pusaka <apusaka@chromium.org>
Thu, 3 Sep 2020 03:50:37 +0000 (11:50 +0800)
committerAyush Garg <ayush.garg@samsung.com>
Mon, 12 Apr 2021 09:00:50 +0000 (14:30 +0530)
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>
doc/media-api.txt

index dabc699..e985731 100755 (executable)
@@ -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"