Difference between revisions of "Extended Properties"
(Created page with "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 p...") |
|||
| Line 18: | Line 18: | ||
|| '''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:content:focus": "true"</code><br/> | ||
| + | <code>"button:restart:focus": "true"</code><br/> | ||
| + | <code>"button:prev:focus": "true"</code><br/> | ||
| + | <code>"button:rewind:focus": "true"</code><br/> | ||
| + | <code>"button:play_pause:focus": "true"</code><br/> | ||
| + | <code>"button:forward:focus": "true"</code><br/> | ||
| + | <code>"button:next:focus": "true"</code><br/> | ||
| + | <code>"button:speed:focus": "true"</code><br/> | ||
| + | <code>"button:eject:focus": "true"</code><br/> | ||
| + | || '''Yes''' || | ||
| + | Focuses a player button (if player is loaded). | ||
| + | |- | ||
| + | | <code>button:content:action</code> || <code>{ACTION}</code> || | ||
| + | <code>"button:content:action": "info:Custom content action executed."</code><br/> | ||
| + | || 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. | ||
| + | |||
| + | '''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>button:content:icon</code> || <code>{ICON}</code> || | ||
| + | <code>"button:content:icon": "info"</code><br/> | ||
| + | || No || | ||
| + | Sets up a custom content icon (replacement for the player button in the lower left corner). By default, the icon <code>pageview</code> is used. | ||
| + | |||
| + | '''Note: To use this property, the <code>button:content:action</code> property must also be set, otherwise this property is ignored.''' | ||
|} | |} | ||
Revision as of 16:04, 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 |
button:content:icon |
{ICON} |
|
No |
Sets up a custom content icon (replacement for the player button in the lower left corner). By default, the icon Note: To use this property, the |