Difference between revisions of "Extended Properties"
Line 9: | Line 9: | ||
| <code>button:{BUTTON_ID}:enable</code> || <code>{BOOLEAN_VALUE}</code> || | | <code>button:{BUTTON_ID}:enable</code> || <code>{BOOLEAN_VALUE}</code> || | ||
<code>"button:content:enable":"true"</code><br/> | <code>"button:content:enable":"true"</code><br/> | ||
− | <code>"button:restart:enable": "true"</code><br/> | + | <code>"button:restart:enable":"true"</code><br/> |
− | <code>"button:prev:enable": "true"</code><br/> | + | <code>"button:prev:enable":"true"</code><br/> |
− | <code>"button:rewind:enable": "true"</code><br/> | + | <code>"button:rewind:enable":"true"</code><br/> |
− | <code>"button:play_pause:enable": "true"</code><br/> | + | <code>"button:play_pause:enable":"true"</code><br/> |
− | <code>"button:forward:enable": "true"</code><br/> | + | <code>"button:forward:enable":"true"</code><br/> |
− | <code>"button:next:enable": | + | <code>"button:next:enable": true"</code><br/> |
− | <code>"button:speed:enable": "true"</code><br/> | + | <code>"button:speed:enable":"true"</code><br/> |
|| '''Yes''' || | || '''Yes''' || | ||
Enables/Disables a player button (all buttons except the eject button are supported). | Enables/Disables a player button (all buttons except the eject button are supported). | ||
|- | |- | ||
| <code>button:{BUTTON_ID}:focus</code> || <code>{BOOLEAN_VALUE}</code> || | | <code>button:{BUTTON_ID}:focus</code> || <code>{BOOLEAN_VALUE}</code> || | ||
− | <code>"button:content:focus": "true"</code><br/> | + | <code>"button:content:focus":"true"</code><br/> |
− | <code>"button:restart:focus": "true"</code><br/> | + | <code>"button:restart:focus":"true"</code><br/> |
− | <code>"button:prev:focus": "true"</code><br/> | + | <code>"button:prev:focus":"true"</code><br/> |
− | <code>"button:rewind:focus": "true"</code><br/> | + | <code>"button:rewind:focus":"true"</code><br/> |
− | <code>"button:play_pause:focus": "true"</code><br/> | + | <code>"button:play_pause:focus":"true"</code><br/> |
− | <code>"button:forward:focus": "true"</code><br/> | + | <code>"button:forward:focus":"true"</code><br/> |
<code>"button:next:focus": "true"</code><br/> | <code>"button:next:focus": "true"</code><br/> | ||
− | <code>"button:speed:focus": "true"</code><br/> | + | <code>"button:speed:focus":"true"</code><br/> |
− | <code>"button:eject:focus": "true"</code><br/> | + | <code>"button:eject:focus":"true"</code><br/> |
|| '''Yes''' || | || '''Yes''' || | ||
Focuses a player button (if player is loaded). | Focuses a player button (if player is loaded). | ||
|- | |- | ||
| <code>button:content:action</code> || <code>{ACTION}</code> || | | <code>button:content:action</code> || <code>{ACTION}</code> || | ||
− | <code>"button:content:action": "info:Custom content action executed."</code><br/> | + | <code>"button:content:action":"info:Custom content action executed."</code><br/> |
|| No || | || No || | ||
Sets up a custom content action (replacement for the player button in the lower left corner). By default, the action <code>player:content</code> is executed. | Sets up a custom content action (replacement for the player button in the lower left corner). By default, the action <code>player:content</code> is executed. | ||
Line 40: | Line 40: | ||
|- | |- | ||
| <code>control:load</code> || <code>{LOAD_MODE}</code> || | | <code>control:load</code> || <code>{LOAD_MODE}</code> || | ||
− | <code>"control:load": "default"</code><br/> | + | <code>"control:load":"default"</code><br/> |
− | <code>"control:load": "silent"</code><br/> | + | <code>"control:load":"silent"</code><br/> |
|| No || | || No || | ||
Sets up the player control load mode. If the mode is set to <code>"silent"</code>, the player is not shown if the video/audio file is loaded in auto mode (e.g. if the action <code>player:auto:next</code> is executed). | Sets up the player control load mode. If the mode is set to <code>"silent"</code>, the player is not shown if the video/audio file is loaded in auto mode (e.g. if the action <code>player:auto:next</code> is executed). | ||
|- | |- | ||
| <code>image:action</code> || <code>{ACTION}</code> || | | <code>image:action</code> || <code>{ACTION}</code> || | ||
− | <code>"image:action": "info:Custom image action executed."</code><br/> | + | <code>"image:action":"info:Custom image action executed."</code><br/> |
|| No || | || No || | ||
Sets up a custom slideshow image action (replacement for the default slideshow image action). By default, the action <code>slider:labels:play_pause</code> is executed. | Sets up a custom slideshow image action (replacement for the default slideshow image action). By default, the action <code>slider:labels:play_pause</code> is executed. | ||
Line 53: | Line 53: | ||
|- | |- | ||
| <code>image:extension</code> || <code>{LABEL}</code> || | | <code>image:extension</code> || <code>{LABEL}</code> || | ||
− | <code>"image:extension": "Custom image extension label"</code><br/> | + | <code>"image:extension":"Custom image extension label"</code><br/> |
|| No || | || No || | ||
Sets up an additional slideshow image extension label (displayed in the slideshow labels). | Sets up an additional slideshow image extension label (displayed in the slideshow labels). | ||
|- | |- | ||
| <code>image:trigger</code> || <code>{ACTION}</code> || | | <code>image:trigger</code> || <code>{ACTION}</code> || | ||
− | <code>"image:trigger": "info:Image is visible."</code><br/> | + | <code>"image:trigger":"info:Image is visible."</code><br/> |
|| No || | || No || | ||
Sets up a slideshow image trigger. | Sets up a slideshow image trigger. | ||
Line 65: | Line 65: | ||
|- | |- | ||
| <code>label:duration</code> || <code>{LABEL}</code> || | | <code>label:duration</code> || <code>{LABEL}</code> || | ||
− | <code>"label:duration": "Custom duration label"</code><br/> | + | <code>"label:duration":"Custom duration label"</code><br/> |
− | <code>"label:duration": "default"</code><br/> | + | <code>"label:duration":"default"</code><br/> |
|| '''Yes''' || | || '''Yes''' || | ||
Sets up the player duration label (overrides the default duration value of the video/audio player with a custom value). | 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</code> || <code>{LABEL}</code> || | ||
− | <code>"label:extension": "{ico:live-tv}"</code><br/> | + | <code>"label:extension":"{ico:live-tv}"</code><br/> |
− | <code>"label:extension": "default"</code><br/> | + | <code>"label:extension":"default"</code><br/> |
|| '''Yes''' || | || '''Yes''' || | ||
Sets up an additional player extension label. | Sets up an additional player extension label. | ||
|- | |- | ||
| <code>label:position</code> || <code>{LABEL}</code> || | | <code>label:position</code> || <code>{LABEL}</code> || | ||
− | <code>"label:position": "Custom position label"</code><br/> | + | <code>"label:position":"Custom position label"</code><br/> |
− | <code>"label:position": "default"</code><br/> | + | <code>"label:position":"default"</code><br/> |
|| '''Yes''' || | || '''Yes''' || | ||
Sets up the player position label (overrides the default position value of the video/audio player with a custom value). | 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</code> || <code>{COLOR}</code> || | ||
− | <code>"progress:color": "msx-red"</code><br/> | + | <code>"progress:color":"msx-red"</code><br/> |
− | <code>"progress:color": "default"</code><br/> | + | <code>"progress:color":"default"</code><br/> |
|| '''Yes''' || | || '''Yes''' || | ||
Sets up the player progress color. | Sets up the player progress color. | ||
|- | |- | ||
| <code>progress:marker:enable</code> || <code>{BOOLEAN_VALUE}</code> || | | <code>progress:marker:enable</code> || <code>{BOOLEAN_VALUE}</code> || | ||
− | <code>"progress:marker:enable": "true"</code><br/> | + | <code>"progress:marker:enable":"true"</code><br/> |
− | <code>"progress:marker:enable": "false"</code><br/> | + | <code>"progress:marker:enable":"false"</code><br/> |
|| '''Yes''' || | || '''Yes''' || | ||
Enables/Disables the player progress marker. | Enables/Disables the player progress marker. | ||
|- | |- | ||
| <code>progress:type</code> || <code>{PROGRESS_TYPE}</code> || | | <code>progress:type</code> || <code>{PROGRESS_TYPE}</code> || | ||
− | <code>"progress:type": "position"</code><br/> | + | <code>"progress:type":"position"</code><br/> |
− | <code>"progress:type": "position:{POSITION} {ico:image}"</code><br/> | + | <code>"progress:type":"position:{POSITION} {ico:image}"</code><br/> |
− | <code>"progress:type": "number"</code><br/> | + | <code>"progress:type":"number"</code><br/> |
− | <code>"progress:type": "number:{NUMBER} {ico:image}"</code><br/> | + | <code>"progress:type":"number:{NUMBER} {ico:image}"</code><br/> |
− | <code>"progress:type": "percentage"</code><br/> | + | <code>"progress:type":"percentage"</code><br/> |
− | <code>"progress:type": "time:{LIVE_DURATION_FORMAT}"</code><br/> | + | <code>"progress:type":"time:{LIVE_DURATION_FORMAT}"</code><br/> |
− | <code>"progress:type": "text:{LIVE_DURATION_TEXT}"</code><br/> | + | <code>"progress:type":"text:{LIVE_DURATION_TEXT}"</code><br/> |
− | <code>"progress:type": "reverse:position"</code><br/> | + | <code>"progress:type":"reverse:position"</code><br/> |
− | <code>"progress:type": "reverse:position:{POSITION} {ico:image}"</code><br/> | + | <code>"progress:type":"reverse:position:{POSITION} {ico:image}"</code><br/> |
− | <code>"progress:type": "reverse:number"</code><br/> | + | <code>"progress:type":"reverse:number"</code><br/> |
− | <code>"progress:type": "reverse:number:{NUMBER} {ico:image}"</code><br/> | + | <code>"progress:type":"reverse:number:{NUMBER} {ico:image}"</code><br/> |
− | <code>"progress:type": "reverse:percentage"</code><br/> | + | <code>"progress:type":"reverse:percentage"</code><br/> |
− | <code>"progress:type": "reverse:time:{LIVE_DURATION_FORMAT}"</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":"reverse:text:{LIVE_DURATION_TEXT}"</code><br/> |
− | <code>"progress:type": "difference:position"</code><br/> | + | <code>"progress:type":"difference:position"</code><br/> |
− | <code>"progress:type": "difference:position:{POSITION} {ico:image}"</code><br/> | + | <code>"progress:type":"difference:position:{POSITION} {ico:image}"</code><br/> |
− | <code>"progress:type": "difference:number"</code><br/> | + | <code>"progress:type":"difference:number"</code><br/> |
− | <code>"progress:type": "difference:number:{NUMBER} {ico:image}"</code><br/> | + | <code>"progress:type":"difference:number:{NUMBER} {ico:image}"</code><br/> |
− | <code>"progress:type": "difference:percentage"</code><br/> | + | <code>"progress:type":"difference:percentage"</code><br/> |
− | <code>"progress:type": "difference:time:{LIVE_DURATION_FORMAT}"</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":"difference:text:{LIVE_DURATION_TEXT}"</code><br/> |
− | <code>"progress:type": "fix:Fix progress label"</code><br/> | + | <code>"progress:type":"fix:Fix progress label"</code><br/> |
− | <code>"progress:type": "default"</code><br/> | + | <code>"progress:type":"default"</code><br/> |
|| '''Yes''' || | || '''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). | 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). | ||
|- | |- | ||
| <code>resume:key</code> || <code>{RESUME_KEY}</code> || | | <code>resume:key</code> || <code>{RESUME_KEY}</code> || | ||
− | <code>"resume:key": "id"</code><br/> | + | <code>"resume:key":"id"</code><br/> |
− | <code>"resume:key": "url"</code><br/> | + | <code>"resume:key":"url"</code><br/> |
− | <code>"resume:key": "custom_resume_key"</code><br/> | + | <code>"resume:key":"custom_resume_key"</code><br/> |
|| No || | || No || | ||
Sets up a resume key to store/restore the content position. If the key is set to <code>"id"</code>, the corresponding content item ID is used as key. If the key is set to <code>"url"</code>, the corresponding content video/audio URL is used as key. In all other cases, the key is used as is. | Sets up a resume key to store/restore the content position. If the key is set to <code>"id"</code>, the corresponding content item ID is used as key. If the key is set to <code>"url"</code>, the corresponding content video/audio URL is used as key. In all other cases, the key is used as is. | ||
Line 131: | Line 131: | ||
|- | |- | ||
| <code>resume:position</code> || <code>{RESUME_POSITION}</code> || | | <code>resume:position</code> || <code>{RESUME_POSITION}</code> || | ||
− | <code>"resume:position": "10"</code><br/> | + | <code>"resume:position":"10"</code><br/> |
− | <code>"resume:position": "10%"</code><br/> | + | <code>"resume:position":"10%"</code><br/> |
|| '''Yes''' || | || '''Yes''' || | ||
Sets up a fix resume position in seconds or percentage to start the content from there. | Sets up a fix resume position in seconds or percentage to start the content from there. | ||
|- | |- | ||
| <code>trigger:{TRIGGER_KEY}</code> || <code>{ACTION}</code> || | | <code>trigger:{TRIGGER_KEY}</code> || <code>{ACTION}</code> || | ||
− | <code>"trigger:load": "info:Video loaded."</code><br/> | + | <code>"trigger:load":"info:Video loaded."</code><br/> |
− | <code>"trigger:ready": "info:Video ready."</code><br/> | + | <code>"trigger:ready":"info:Video ready."</code><br/> |
− | <code>"trigger:start": "info:Video started."</code><br/> | + | <code>"trigger:start":"info:Video started."</code><br/> |
− | <code>"trigger:end": "info:Video ended."</code><br/> | + | <code>"trigger:end":"info:Video ended."</code><br/> |
− | <code>"trigger:complete": "info:Video completed."</code><br/> | + | <code>"trigger:complete":"info:Video completed."</code><br/> |
− | <code>"trigger:10": "info:10 seconds of video passed."</code><br/> | + | <code>"trigger:10":"info:10 seconds of video passed."</code><br/> |
− | <code>"trigger:10%": "info:10% of video passed."</code><br/> | + | <code>"trigger:10%":"info:10% of video passed."</code><br/> |
− | <code>"trigger:10t": "info:10 ticks of video passed."</code><br/> | + | <code>"trigger:10t":"info:10 ticks of video passed."</code><br/> |
− | <code>"trigger:20": "shot:info:20 seconds of video passed (shot)."</code><br/> | + | <code>"trigger:20":"shot:info:20 seconds of video passed (shot)."</code><br/> |
− | <code>"trigger:20%": "shot:info:20% of video passed (shot)."</code><br/> | + | <code>"trigger:20%":"shot:info:20% of video passed (shot)."</code><br/> |
− | <code>"trigger:20t": "shot:info:20 ticks of video passed (shot)."</code><br/> | + | <code>"trigger:20t":"shot:info:20 ticks of video passed (shot)."</code><br/> |
− | <code>"trigger:quartile1": "info:First quartile of video entered."</code><br/> | + | <code>"trigger:quartile1":"info:First quartile of video entered."</code><br/> |
− | <code>"trigger:quartile2": "info:Second quartile of video entered."</code><br/> | + | <code>"trigger:quartile2":"info:Second quartile of video entered."</code><br/> |
− | <code>"trigger:quartile3": "info:Third quartile of video entered."</code><br/> | + | <code>"trigger:quartile3":"info:Third quartile of video entered."</code><br/> |
− | <code>"trigger:quartile4": "info:Fourth quartile of video entered."</code><br/> | + | <code>"trigger:quartile4":"info:Fourth quartile of video entered."</code><br/> |
− | <code>"trigger:first_quartile": "info:First quartile of video reached."</code><br/> | + | <code>"trigger:first_quartile":"info:First quartile of video reached."</code><br/> |
− | <code>"trigger:midpoint": "info:Midpoint of video reached."</code><br/> | + | <code>"trigger:midpoint":"info:Midpoint of video reached."</code><br/> |
− | <code>"trigger:third_quartile": "info:Third quartile of video reached."</code><br/> | + | <code>"trigger:third_quartile":"info:Third quartile of video reached."</code><br/> |
− | <code>"trigger:play": "info:Video is playing."</code><br/> | + | <code>"trigger:play":"info:Video is playing."</code><br/> |
− | <code>"trigger:pause": "info:Video paused."</code><br/> | + | <code>"trigger:pause":"info:Video paused."</code><br/> |
− | <code>"trigger:stop": "info:Video stopped."</code><br/> | + | <code>"trigger:stop":"info:Video stopped."</code><br/> |
− | <code>"trigger:foreground": "info:Video moved to foreground."</code><br/> | + | <code>"trigger:foreground":"info:Video moved to foreground."</code><br/> |
− | <code>"trigger:background": "info:Video moved to background."</code><br/> | + | <code>"trigger:background":"info:Video moved to background."</code><br/> |
− | <code>"trigger:back": "info:Video back executed."</code><br/> | + | <code>"trigger:back":"info:Video back executed."</code><br/> |
|| '''Yes''' || | || '''Yes''' || | ||
Sets up a video/audio trigger. | Sets up a video/audio trigger. |
Revision as of 17:10, 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 ( |
resume:key |
{RESUME_KEY} |
|
No |
Sets up a resume key to store/restore the content position. If the key is set to Note: The key is stored as hash code on the local device. Stored keys can be cleared with the |
resume:position |
{RESUME_POSITION} |
|
Yes |
Sets up a fix resume position in seconds or percentage to start the content from there. |
trigger:{TRIGGER_KEY} |
{ACTION} |
|
Yes |
Sets up a video/audio trigger. Note: For trigger key |