Difference between revisions of "Menu Root Object"
(Created page with "<syntaxhighlight lang="json"> { "name": "Content Name", "version": "1.0.0", "flag": "content_flag", "reuse": true, "cache": true, "restore": tru...") |
|||
| Line 21: | Line 21: | ||
! Property !! Type !! Default Value !! Mandatory !! Since Version !! class="unsortable" | Description | ! Property !! Type !! Default Value !! Mandatory !! Since Version !! class="unsortable" | Description | ||
|- | |- | ||
| − | | <code>name</code> || <code>string</code> || <code>null</code> || No || 0.1.0 || | + | | <code>name</code> || <code>string</code> || <code>null</code> || No || data-sort-value=0|0.1.0 || |
The name of the content. This property is only used if the menu data is loaded at startup and can be used to set the content name. This value is displayed in the about panel of the Media Station X application. | The name of the content. This property is only used if the menu data is loaded at startup and can be used to set the content name. This value is displayed in the about panel of the Media Station X application. | ||
|- | |- | ||
| − | | <code>version</code> || <code>string</code> || <code>null</code> || No || 0.1.0 || | + | | <code>version</code> || <code>string</code> || <code>null</code> || No || data-sort-value=0|0.1.0 || |
The version of the content. This property is only used if the menu data is loaded at startup and can be used to add a content version. This value is displayed in the about panel of the Media Station X application. | The version of the content. This property is only used if the menu data is loaded at startup and can be used to add a content version. This value is displayed in the about panel of the Media Station X application. | ||
|- | |- | ||
| − | | <code>flag</code> || <code>string</code> || <code>null</code> || No || '''0.1.120''' || | + | | <code>flag</code> || <code>string</code> || <code>null</code> || No || data-sort-value=120|'''0.1.120''' || |
A custom content flag that can be evaluated by plugins and/or servers. | A custom content flag that can be evaluated by plugins and/or servers. | ||
|- | |- | ||
| − | | <code>reuse</code> || <code>boolean</code> || <code>true</code> || No || 0.1.0 || | + | | <code>reuse</code> || <code>boolean</code> || <code>true</code> || No || data-sort-value=0|0.1.0 || |
Indicates if the menu data can be reused. If this property is set to <code>false</code>, the menu data is recreated each time it is displayed. | Indicates if the menu data can be reused. If this property is set to <code>false</code>, the menu data is recreated each time it is displayed. | ||
|- | |- | ||
| − | | <code>cache</code> || <code>boolean</code> || <code>true</code> || No || '''0.1.58''' || | + | | <code>cache</code> || <code>boolean</code> || <code>true</code> || No || data-sort-value=58|'''0.1.58''' || |
Indicates if the menu data is being cached. This property can be used to disable the cache feature. | Indicates if the menu data is being cached. This property can be used to disable the cache feature. | ||
|- | |- | ||
| − | | <code>restore</code> || <code>boolean</code> || <code>true</code> || No || '''0.1.120''' || | + | | <code>restore</code> || <code>boolean</code> || <code>true</code> || No || data-sort-value=120|'''0.1.120''' || |
Indicates if the menu data is restorable. If this property is set to <code>false</code>, the menu data (and the related content data) is not restored when the application returns from a link action. | Indicates if the menu data is restorable. If this property is set to <code>false</code>, the menu data (and the related content data) is not restored when the application returns from a link action. | ||
|- | |- | ||
| − | | <code>logo</code> || <code>string</code> || <code>null</code> || No || '''0.1.60''' || | + | | <code>logo</code> || <code>string</code> || <code>null</code> || No || data-sort-value=60|'''0.1.60''' || |
The logo image of the menu. This property can be used to display a logo instead of a headline. The area of the logo is 416x96 (WxH) pixels at layout resolution 720p. The logo is sized to fill the entire height (by keeping the ratio) and is positioned on the left side. | The logo image of the menu. This property can be used to display a logo instead of a headline. The area of the logo is 416x96 (WxH) pixels at layout resolution 720p. The logo is sized to fill the entire height (by keeping the ratio) and is positioned on the left side. | ||
|- | |- | ||
| − | | <code>headline</code> || <code>string</code> || <code>null</code> || No || 0.1.0 || | + | | <code>headline</code> || <code>string</code> || <code>null</code> || No || data-sort-value=0|0.1.0 || |
The headline of the menu. | The headline of the menu. | ||
| Line 49: | Line 49: | ||
This property supports inline expressions. For more information, please see [[Inline Expressions]]. | This property supports inline expressions. For more information, please see [[Inline Expressions]]. | ||
|- | |- | ||
| − | | <code>background</code> || <code>string</code> || <code>null</code> || No || 0.1.0 || | + | | <code>background</code> || <code>string</code> || <code>null</code> || No || data-sort-value=0|0.1.0 || |
The background image that is used if no other background is set at lower levels. If the menu data is loaded at startup, this background image is used as default. | The background image that is used if no other background is set at lower levels. If the menu data is loaded at startup, this background image is used as default. | ||
|- | |- | ||
| − | | <code>extension</code> || <code>string</code> || <code>null</code> || No || '''0.1.82''' || | + | | <code>extension</code> || <code>string</code> || <code>null</code> || No || data-sort-value=82|'''0.1.82''' || |
The extension of each corresponding content screen. This property can be used to display a small label in the upper right corner of each corresponding content screen (e.g. to show the logged in user, the current date/time, etc.). This property has no effect if the corresponding content contains its own extension. | The extension of each corresponding content screen. This property can be used to display a small label in the upper right corner of each corresponding content screen (e.g. to show the logged in user, the current date/time, etc.). This property has no effect if the corresponding content contains its own extension. | ||
This property supports inline expressions and live inline expressions. For more information about the inline expressions, please see [[Inline Expressions]]. For more information about the live inline expressions, please see [[Live Inline Expressions]]. | This property supports inline expressions and live inline expressions. For more information about the inline expressions, please see [[Inline Expressions]]. For more information about the live inline expressions, please see [[Live Inline Expressions]]. | ||
|- | |- | ||
| − | | <code>dictionary</code> || <code>string</code> || <code>null</code> || No || '''0.1.120''' || | + | | <code>dictionary</code> || <code>string</code> || <code>null</code> || No || data-sort-value=120|'''0.1.120''' || |
A link to a dictionary file. This property is only used if the menu data is loaded at startup and can be used to setup a dictionary. A dictionary can be used to translate the application user interface. For more information, please see [[Dictionary Structure]]. | A link to a dictionary file. This property is only used if the menu data is loaded at startup and can be used to setup a dictionary. A dictionary can be used to translate the application user interface. For more information, please see [[Dictionary Structure]]. | ||
|- | |- | ||
| − | | <code>menu</code> || <code>array</code> || <code>null</code> || '''Yes''' || 0.1.0 || | + | | <code>menu</code> || <code>array</code> || <code>null</code> || '''Yes''' || data-sort-value=0|0.1.0 || |
An array of menu items. Please see [[Menu Item Object]] for the data structure. This property is mandatory, because without it, no menu items can be displayed. | An array of menu items. Please see [[Menu Item Object]] for the data structure. This property is mandatory, because without it, no menu items can be displayed. | ||
|- | |- | ||
| − | | <code>options</code> || <code>object</code> || <code>null</code> || No || '''0.1.120''' || | + | | <code>options</code> || <code>object</code> || <code>null</code> || No || data-sort-value=120|'''0.1.120''' || |
A special content page object that is displayed in a content panel if a menu item is selected and the menu button is pressed. The availability of options for the current selected item is indicated in the lower right corner of the content screen. Please see [[Content Page Object]] for the data structure. | A special content page object that is displayed in a content panel if a menu item is selected and the menu button is pressed. The availability of options for the current selected item is indicated in the lower right corner of the content screen. Please see [[Content Page Object]] for the data structure. | ||
'''Note: If the selected menu item has its own options property, this property is ignored.''' | '''Note: If the selected menu item has its own options property, this property is ignored.''' | ||
|} | |} | ||
Revision as of 11:08, 8 January 2021
{
"name": "Content Name",
"version": "1.0.0",
"flag": "content_flag",
"reuse": true,
"cache": true,
"restore": true,
"logo": "http://link.to.image",
"headline": "Menu Headline",
"background": "http://link.to.image",
"extension": "Content Extension",
"dictionary": "http://link.to.dictionary",
"menu": [],
"options": null
}
| Property | Type | Default Value | Mandatory | Since Version | Description |
|---|---|---|---|---|---|
name |
string |
null |
No | 0.1.0 |
The name of the content. This property is only used if the menu data is loaded at startup and can be used to set the content name. This value is displayed in the about panel of the Media Station X application. |
version |
string |
null |
No | 0.1.0 |
The version of the content. This property is only used if the menu data is loaded at startup and can be used to add a content version. This value is displayed in the about panel of the Media Station X application. |
flag |
string |
null |
No | 0.1.120 |
A custom content flag that can be evaluated by plugins and/or servers. |
reuse |
boolean |
true |
No | 0.1.0 |
Indicates if the menu data can be reused. If this property is set to |
cache |
boolean |
true |
No | 0.1.58 |
Indicates if the menu data is being cached. This property can be used to disable the cache feature. |
restore |
boolean |
true |
No | 0.1.120 |
Indicates if the menu data is restorable. If this property is set to |
logo |
string |
null |
No | 0.1.60 |
The logo image of the menu. This property can be used to display a logo instead of a headline. The area of the logo is 416x96 (WxH) pixels at layout resolution 720p. The logo is sized to fill the entire height (by keeping the ratio) and is positioned on the left side. |
headline |
string |
null |
No | 0.1.0 |
The headline of the menu. Note: Since version 0.1.60, this property is ignored if a This property supports inline expressions. For more information, please see Inline Expressions. |
background |
string |
null |
No | 0.1.0 |
The background image that is used if no other background is set at lower levels. If the menu data is loaded at startup, this background image is used as default. |
extension |
string |
null |
No | 0.1.82 |
The extension of each corresponding content screen. This property can be used to display a small label in the upper right corner of each corresponding content screen (e.g. to show the logged in user, the current date/time, etc.). This property has no effect if the corresponding content contains its own extension. This property supports inline expressions and live inline expressions. For more information about the inline expressions, please see Inline Expressions. For more information about the live inline expressions, please see Live Inline Expressions. |
dictionary |
string |
null |
No | 0.1.120 |
A link to a dictionary file. This property is only used if the menu data is loaded at startup and can be used to setup a dictionary. A dictionary can be used to translate the application user interface. For more information, please see Dictionary Structure. |
menu |
array |
null |
Yes | 0.1.0 |
An array of menu items. Please see Menu Item Object for the data structure. This property is mandatory, because without it, no menu items can be displayed. |
options |
object |
null |
No | 0.1.120 |
A special content page object that is displayed in a content panel if a menu item is selected and the menu button is pressed. The availability of options for the current selected item is indicated in the lower right corner of the content screen. Please see Content Page Object for the data structure. Note: If the selected menu item has its own options property, this property is ignored. |