diff options
author | Archie Pusaka <apusaka@chromium.org> | 2020-09-03 11:50:37 +0800 |
---|---|---|
committer | Luiz Augusto von Dentz <luiz.von.dentz@intel.com> | 2020-09-04 15:34:37 -0700 |
commit | 4b3f85871321d9c84887db18243c4e4fdbc16e2c (patch) | |
tree | fe1bb71b3d6c5778e9922f65d307eb9bfa3c8416 /doc/media-api.txt | |
parent | 94f791dc873e48364b14ca4f9848b32ca6d7f03d (diff) | |
download | bluez-4b3f85871321d9c84887db18243c4e4fdbc16e2c.tar.gz |
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>
Diffstat (limited to 'doc/media-api.txt')
-rw-r--r-- | doc/media-api.txt | 29 |
1 files changed, 29 insertions, 0 deletions
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" |