Difference between revisions of "Extended Properties"
Line 51: | Line 51: | ||
'''Note: For property actions, it is not possible to provide an action-related <code>data</code> property. If you want to execute a property data action, please use the <code>execute:fetch:{URL}</code> action, alternatively.''' | '''Note: For property actions, it is not possible to provide an action-related <code>data</code> property. If you want to execute a property data action, please use the <code>execute:fetch:{URL}</code> action, alternatively.''' | ||
+ | |- | ||
+ | | <code>image:extension</code> || <code>{LABEL}</code> || | ||
+ | <code>"image:extension": "Custom image extension label"</code><br/> | ||
+ | || No || | ||
+ | Sets up an additional slideshow image extension label (displayed in the slideshow labels). | ||
+ | |- | ||
+ | | <code>image:trigger</code> || <code>{ACTION}</code> || | ||
+ | <code>"image:trigger": "info:Image is visible."</code><br/> | ||
+ | || No || | ||
+ | Sets up a slideshow image trigger. | ||
+ | |||
+ | '''Note: For property actions, it is not possible to provide an action-related <code>data</code> property. If you want to execute a property data action, please use the <code>execute:fetch:{URL}</code> action, alternatively.''' | ||
+ | |- | ||
+ | | <code>label:duration</code> || <code>{LABEL}</code> || | ||
+ | <code>"label:duration": "Custom duration label"</code><br/> | ||
+ | <code>"label:duration": "default"</code><br/> | ||
+ | || '''Yes''' || | ||
+ | Sets up the player duration label (overrides the default duration value of the video/audio player with a custom value). | ||
+ | |- | ||
+ | | <code>label:extension</code> || <code>{LABEL}</code> || | ||
+ | <code>"label:extension": "{ico:live-tv}"</code><br/> | ||
+ | <code>"label:extension": "default"</code><br/> | ||
+ | || '''Yes''' || | ||
+ | Sets up an additional player extension label. | ||
+ | |- | ||
+ | | <code>label:position</code> || <code>{LABEL}</code> || | ||
+ | <code>"label:position": "Custom position label"</code><br/> | ||
+ | <code>"label:position": "default"</code><br/> | ||
+ | || '''Yes''' || | ||
+ | Sets up the player position label (overrides the default position value of the video/audio player with a custom value). | ||
+ | |- | ||
+ | | <code>progress:color</code> || <code>{COLOR}</code> || | ||
+ | <code>"progress:color": "msx-red"</code><br/> | ||
+ | <code>"progress:color": "default"</code><br/> | ||
+ | || '''Yes''' || | ||
+ | Sets up the player progress color. | ||
+ | |- | ||
+ | | <code>progress:marker:enable</code> || <code>{BOOLEAN_VALUE}</code> || | ||
+ | <code>"progress:marker:enable": "true"</code><br/> | ||
+ | <code>"progress:marker:enable": "false"</code><br/> | ||
+ | || '''Yes''' || | ||
+ | Enables/Disables the player progress marker. | ||
+ | |- | ||
+ | | <code>progress:type</code> || <code>{PROGRESS_TYPE}</code> || | ||
+ | <code>"progress:type": "position"</code><br/> | ||
+ | <code>"progress:type": "position:{POSITION} {ico:image}"</code><br/> | ||
+ | <code>"progress:type": "number"</code><br/> | ||
+ | <code>"progress:type": "number:{NUMBER} {ico:image}"</code><br/> | ||
+ | <code>"progress:type": "percentage"</code><br/> | ||
+ | <code>"progress:type": "time:{LIVE_DURATION_FORMAT}"</code><br/> | ||
+ | <code>"progress:type": "text:{LIVE_DURATION_TEXT}"</code><br/> | ||
+ | <code>"progress:type": "reverse:position"</code><br/> | ||
+ | <code>"progress:type": "reverse:position:{POSITION} {ico:image}"</code><br/> | ||
+ | <code>"progress:type": "reverse:number"</code><br/> | ||
+ | <code>"progress:type": "reverse:number:{NUMBER} {ico:image}"</code><br/> | ||
+ | <code>"progress:type": "reverse:percentage"</code><br/> | ||
+ | <code>"progress:type": "reverse:time:{LIVE_DURATION_FORMAT}"</code><br/> | ||
+ | <code>"progress:type": "reverse:text:{LIVE_DURATION_TEXT}"</code><br/> | ||
+ | <code>"progress:type": "difference:position"</code><br/> | ||
+ | <code>"progress:type": "difference:position:{POSITION} {ico:image}"</code><br/> | ||
+ | <code>"progress:type": "difference:number"</code><br/> | ||
+ | <code>"progress:type": "difference:number:{NUMBER} {ico:image}"</code><br/> | ||
+ | <code>"progress:type": "difference:percentage"</code><br/> | ||
+ | <code>"progress:type": "difference:time:{LIVE_DURATION_FORMAT}"</code><br/> | ||
+ | <code>"progress:type": "difference:text:{LIVE_DURATION_TEXT}"</code><br/> | ||
+ | <code>"progress:type": "fix:Fix progress label"</code><br/> | ||
+ | <code>"progress:type": "default"</code><br/> | ||
+ | || '''Yes''' || | ||
+ | Sets up the player progress type (<code>default</code> is like <code>time:hh:mm:ss</code>). For the type that starts with (or contains) <code>position:</code>, the <code>{POSITION}</code> part is automatically replaced with the corresponding position value. For the type that starts with (or contains) <code>number:</code>, the <code>{NUMBER}</code> part is automatically replaced with the corresponding number value (which is the incremented position value). | ||
|} | |} |
Revision as of 17:01, 13 January 2021
These properties can be used for special use cases and are only valid for version 0.1.111+. Please ensure that you are using the correct version, because the syntax in previous versions can be different. Each property is a key-value pair of type string
and can be set in the properties
property of a Content Item Object. The dynamic properties can also be set via an action at runtime. For more information, please see Internal Actions.
Parameter Syntax[edit]
Property | Value | Example | Dynamic | Description |
---|---|---|---|---|
button:{BUTTON_ID}:enable |
{BOOLEAN_VALUE} |
|
Yes |
Enables/Disables a player button (all buttons except the eject button are supported). |
button:{BUTTON_ID}:focus |
{BOOLEAN_VALUE} |
|
Yes |
Focuses a player button (if player is loaded). |
button:content:action |
{ACTION} |
|
No |
Sets up a custom content action (replacement for the player button in the lower left corner). By default, the action Note: To use this property, the |
control:load |
{LOAD_MODE} |
|
No |
Sets up the player control load mode. If the mode is set to |
image:action |
{ACTION} |
|
No |
Sets up a custom slideshow image action (replacement for the default slideshow image action). By default, the action Note: For property actions, it is not possible to provide an action-related |
image:extension |
{LABEL} |
|
No |
Sets up an additional slideshow image extension label (displayed in the slideshow labels). |
image:trigger |
{ACTION} |
|
No |
Sets up a slideshow image trigger. Note: For property actions, it is not possible to provide an action-related |
label:duration |
{LABEL} |
|
Yes |
Sets up the player duration label (overrides the default duration value of the video/audio player with a custom value). |
label:extension |
{LABEL} |
|
Yes |
Sets up an additional player extension label. |
label:position |
{LABEL} |
|
Yes |
Sets up the player position label (overrides the default position value of the video/audio player with a custom value). |
progress:color |
{COLOR} |
|
Yes |
Sets up the player progress color. |
progress:marker:enable |
{BOOLEAN_VALUE} |
|
Yes |
Enables/Disables the player progress marker. |
progress:type |
{PROGRESS_TYPE} |
|
Yes |
Sets up the player progress type ( |