summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJackLivio <jack@livio.io>2018-08-24 14:35:12 -0400
committerJackLivio <jack@livio.io>2018-08-24 14:35:12 -0400
commitfaab06e696895db3222ad2314ad2640a1ade231c (patch)
treeab4eb66237d636486c9585aa6c8a14badd2b66b3
parent76908e6f7a387d294d0cc85d131f801b46035a7e (diff)
downloadsdl_core-faab06e696895db3222ad2314ad2640a1ade231c.tar.gz
Update mobile api to include description
-rw-r--r--src/components/interfaces/MOBILE_API.xml11
1 files changed, 10 insertions, 1 deletions
diff --git a/src/components/interfaces/MOBILE_API.xml b/src/components/interfaces/MOBILE_API.xml
index de9580e67f..0d04b290b2 100644
--- a/src/components/interfaces/MOBILE_API.xml
+++ b/src/components/interfaces/MOBILE_API.xml
@@ -562,7 +562,16 @@
<enum name="ButtonName" since="1.0">
<description>Defines the hard (physical) and soft (touchscreen) buttons available from the module</description>
<element name="OK" />
- <element name="PLAY_PAUSE" since="5.0"/>
+ <element name="PLAY_PAUSE" since="5.0">
+ <description>
+ The button name for the physical Play/Pause
+ toggle that can be used by media apps.
+ </description>
+ <warning>
+ Please use the physical OK button in order to
+ use a Play/Pause toggle for versions &lt; 4.5.0.
+ </warning>
+ </element>
<element name="SEEKLEFT" />
<element name="SEEKRIGHT" />
<element name="TUNEUP" />