Difference between revisions of "Extended Properties"

From MSX - Wiki
Jump to navigation Jump to search
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>button:content:icon</code> || <code>{ICON}</code> ||
+
| <code>control:load</code> || <code>{LOAD_MODE}</code> ||
<code>"button:content:icon": "info"</code><br/>
+
<code>"control:load": "default"</code><br/>
 +
<code>"control:load": "silent"</code><br/>
 
|| No ||
 
|| 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.
+
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: To use this property, the <code>button:content:action</code> property must also be set, otherwise this property is ignored.'''
+
'''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 syntax of extended properties
Property Value Example Dynamic Description
button:{BUTTON_ID}:enable {BOOLEAN_VALUE}

"button:content:enable": "true"
"button:restart:enable": "true"
"button:prev:enable": "true"
"button:rewind:enable": "true"
"button:play_pause:enable": "true"
"button:forward:enable": "true"
"button:next:enable": "true"
"button:speed:enable": "true"

Yes

Enables/Disables a player button (all buttons except the eject button are supported).

button:{BUTTON_ID}:focus {BOOLEAN_VALUE}

"button:content:focus": "true"
"button:restart:focus": "true"
"button:prev:focus": "true"
"button:rewind:focus": "true"
"button:play_pause:focus": "true"
"button:forward:focus": "true"
"button:next:focus": "true"
"button:speed:focus": "true"
"button:eject:focus": "true"

Yes

Focuses a player button (if player is loaded).

button:content:action {ACTION}

"button:content:action": "info:Custom content action executed."

No

Sets up a custom content action (replacement for the player button in the lower left corner). By default, the action player:content is executed.

Note: To use this property, the button:content:icon property must also be set, otherwise this property is ignored. For property actions, it is not possible to provide an action-related data property. If you want to execute a property data action, please use the execute:fetch:{URL} action, alternatively.

control:load {LOAD_MODE}

"control:load": "default"
"control:load": "silent"

No

Sets up the player control load mode. If the mode is set to "silent", the player is not shown if the video/audio file is loaded in auto mode (e.g. if the action player:auto:next is executed).

image:action {ACTION}

"image:action": "info:Custom image action executed."

No

Sets up a custom slideshow image action (replacement for the default slideshow image action). By default, the action slider:labels:play_pause is executed.

Note: For property actions, it is not possible to provide an action-related data property. If you want to execute a property data action, please use the execute:fetch:{URL} action, alternatively.