Difference between revisions of "Extended Properties"
Line 39: | Line 39: | ||
'''Note: To use this property, the <code>button:content:icon</code> property must also be set, otherwise this property is ignored. 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: To use this property, the <code>button:content:icon</code> property must also be set, otherwise this property is ignored. 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> | + | | <code>control:load</code> || <code>{LOAD_MODE}</code> || |
− | <code>" | + | <code>"control:load": "default"</code><br/> |
+ | <code>"control:load": "silent"</code><br/> | ||
|| No || | || No || | ||
− | Sets up a custom | + | 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": "info:Custom image action executed."</code><br/> | ||
+ | || 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. | ||
− | '''Note: | + | '''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.''' |
|} | |} |
Revision as of 16:52, 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 |