diff options
| author | ChrisB-Elektrobit <chris.boguslawski@elektrobit.com> | 2017-08-04 15:28:38 -0400 |
|---|---|---|
| committer | ChrisB-Elektrobit <chris.boguslawski@elektrobit.com> | 2017-08-04 15:28:38 -0400 |
| commit | 166a09cc489c9e9155dac55183e18544e505e94d (patch) | |
| tree | dd63a163399c2def56f1068411aef896c3794914 | |
| parent | 1a2e930d060cba9d79cf78c361ebaef14f417478 (diff) | |
| download | sdl_core-166a09cc489c9e9155dac55183e18544e505e94d.tar.gz | |
- modified MOBILE_API.xml to support the changes needed for metadata
tagging
| -rw-r--r-- | src/components/interfaces/MOBILE_API.xml | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/src/components/interfaces/MOBILE_API.xml b/src/components/interfaces/MOBILE_API.xml index 81f673af1a..861ebc7a5d 100644 --- a/src/components/interfaces/MOBILE_API.xml +++ b/src/components/interfaces/MOBILE_API.xml @@ -701,6 +701,45 @@ </enum>
+ <enum name="TextFieldType">
+ <element name="mediaTitle">
+ <description>The data in this field contains the title of the currently playing audio track.</description>
+ </element>
+ <element name="mediaArtist">
+ <description>The data in this field contains the artist or creator of the currently playing audio track.</description>
+ </element>
+ <element name="mediaAlbum">
+ <description>The data in this field contains the album title of the currently playing audio track.</description>
+ </element>
+ <element name="mediaYear">
+ <description>The data in this field contains the creation year of the currently playing audio track.</description>
+ </element>
+ <element name="mediaGenre">
+ <description>The data in this field contains the genre of the currently playing audio track.</description>
+ </element>
+ <element name="mediaStation">
+ <description>The data in this field contains the name of the current source for the media.</description>
+ </element>
+ <element name="rating">
+ <description>The data in this field is a rating.</description>
+ </element>
+ <element name="currentTemperature">
+ <description>The data in this field is the current temperature.</description>
+ </element>
+ <element name="maximumTemperature">
+ <description>The data in this field is the maximum temperature for the day.</description>
+ </element>
+ <element name="minimumTemperature">
+ <description>The data in this field is the minimum temperature for the day.</description>
+ </element>
+ <element name="weatherTerm">
+ <description>The data in this field describes the current weather (ex. cloudy, clear, etc.).</description>
+ </element>
+ <element name="humidity">
+ <description>The data in this field describes the current humidity value.</description>
+ </element>
+ </enum>
+
<enum name="ImageFieldName">
<element name="softButtonImage">
<description>The image field for SoftButton</description>
@@ -841,6 +880,21 @@ </param>
</struct>
+ <struct name="MetadataStruct">
+ <param name="mainField1" type="TextFieldType" minsize="0" maxsize="5" array="true" mandatory="false">
+ <description>The type of data contained in the "mainField1" text field.</description>
+ </param>
+ <param name="mainField2" type="TextFieldType" minsize="0" maxsize="5" array="true" mandatory="false">
+ <description>The type of data contained in the "mainField2" text field.</description>
+ </param>
+ <param name="mainField3" type="TextFieldType" minsize="0" maxsize="5" array="true" mandatory="false">
+ <description>The type of data contained in the "mainField3" text field.</description>
+ </param>
+ <param name="mainField4" type="TextFieldType" minsize="0" maxsize="5" array="true" mandatory="false">
+ <description>The type of data contained in the "mainField4" text field.</description>
+ </param>
+ </struct>
+
<struct name="Choice">
<description>A choice is an option given to the user, which can be selected either by menu, or through voice recognition system.</description>
<param name="choiceID" type="Integer" minvalue="0" maxvalue="65535" mandatory="true"/>
@@ -3288,6 +3342,14 @@ </description>
</param>
+ <param name="textFieldMetadata" type="MetadataStruct" mandatory="false">
+ <description>
+ App defined metadata information. See MetadataStruct. Uses mainField1, mainField2, mainField3, mainField4.
+ If omitted on supported displays, the currently set metadata tags will not change.
+ If any text field contains no tags, the metadata tag for that textfield should be removed.
+ </description>
+ </param>
+
</function>
<function name="Show" functionID="ShowID" messagetype="response">
|