Difference between revisions of "Extended Properties"
Line 120: | Line 120: | ||
|| '''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": "id"</code><br/> | ||
+ | <code>"resume:key": "url"</code><br/> | ||
+ | <code>"resume:key": "custom_resume_key"</code><br/> | ||
+ | || 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. | ||
+ | |||
+ | '''Note: The key is stored as hash code on the local device. Stored keys can be cleared with the <code>resume:clear</code> actions.''' | ||
+ | |- | ||
+ | | <code>resume:position</code> || <code>{RESUME_POSITION}</code> || | ||
+ | <code>"resume:position": "10"</code><br/> | ||
+ | <code>"resume:position": "10%"</code><br/> | ||
+ | || '''Yes''' || | ||
+ | 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:load": "info:Video loaded."</code><br/> | ||
+ | <code>"trigger:ready": "info:Video ready."</code><br/> | ||
+ | <code>"trigger:start": "info:Video started."</code><br/> | ||
+ | <code>"trigger:end": "info:Video ended."</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% 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% 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:quartile2": "info:Second 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:first_quartile": "info:First quartile 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:play": "info:Video is playing."</code><br/> | ||
+ | <code>"trigger:pause": "info:Video paused."</code><br/> | ||
+ | <code>"trigger:stop": "info:Video stopped."</code><br/> | ||
+ | <code>"trigger:foreground": "info:Video moved to foreground."</code><br/> | ||
+ | <code>"trigger:background": "info:Video moved to background."</code><br/> | ||
+ | <code>"trigger:back": "info:Video back executed."</code><br/> | ||
+ | || '''Yes''' || | ||
+ | Sets up a video/audio trigger. | ||
+ | |||
+ | '''Note: For trigger key <code>complete</code>, the action <code>player:auto:next</code> is automatically set (please use trigger key <code>end</code> if you want to keep the default complete action). 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.''' | ||
|} | |} |
Revision as of 17:06, 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 |