Live Object - Revision history

Benzac at 07:09, 18 April 2024

2024-04-18T07:09:37Z

Benzac at 19:17, 17 April 2024

2024-04-17T19:17:43Z

Benzac at 19:14, 17 April 2024

2024-04-17T19:14:43Z

Benzac at 18:29, 11 April 2024

2024-04-11T18:29:31Z

Benzac at 07:19, 11 April 2024

2024-04-11T07:19:23Z

Benzac at 16:28, 6 July 2023

2023-07-06T16:28:21Z

Benzac at 06:49, 6 July 2023

2023-07-06T06:49:43Z

Benzac at 06:48, 6 July 2023

2023-07-06T06:48:35Z

Benzac at 06:47, 6 July 2023

2023-07-06T06:47:17Z

Benzac at 10:46, 5 July 2023

2023-07-05T10:46:17Z

@@ Line 9: / Line 9: @@
+{
      "type": "schedule",
      "from": 0,
      "to": 0,
@@ Line 19: / Line 18: @@
      "over": null,
      "execute": null,
      "color": "msx-glass",
      "title": "Item Title",
@@ Line 60: / Line 60: @@
 '''Note: The live object is only evaluated if the corresponding content item is visible. If the corresponding content item is visible, the live object is evaluated every second, regardless of the current state. Since version 0.1.74, live objects of type <code>"playback"</code> can also have the state <code>"coming"</code> if the corresponding content item contains the extension property <code>resume:key</code>. Please also note that live objects are evaluated on an overlay/underlay page, even if the overlay/underlay page is hidden.'''
 |-
 | <code>from</code> || <code>number</code> || <code>0</code> || No || data-sort-value=70|'''0.1.70''' ||
@@ Line 137: / Line 132: @@
 '''Note: To use this property, the <code>type</code> property must be set to <code>"schedule"</code>, <code>"lifetime"</code>, <code>"airtime"</code>, or <code>"setup"</code>, otherwise this property is ignored. If this property is set inside a state object (i.e. <code>coming</code>, <code>running</code>, or <code>over</code>), it is used (instead of this one) if the live object has the corresponding state.'''
 |-
 | <code>color</code> || <code>string</code> || <code>null</code> || No || data-sort-value=70|'''0.1.70''' ||

@@ Line 62: / Line 62: @@
 |-
 | <code>preload</code> || <code>boolean</code> || <code>true</code> || No || data-sort-value=156|'''0.1.156''' ||
-Indicates if the live object should be preloaded when reloading/replacing the entire content and the live object is visible.
+Indicates if the live object should be preloaded when reloading/replacing the content and the live object is visible.
 '''Note: To use this property, the <code>type</code> property must be set to <code>"schedule"</code> or <code>"playback"</code>, otherwise this property is ignored.'''

@@ Line 9: / Line 9: @@
+{
      "type": "schedule",
      "from": 0,
      "to": 0,
@@ Line 59: / Line 60: @@
 '''Note: The live object is only evaluated if the corresponding content item is visible. If the corresponding content item is visible, the live object is evaluated every second, regardless of the current state. Since version 0.1.74, live objects of type <code>"playback"</code> can also have the state <code>"coming"</code> if the corresponding content item contains the extension property <code>resume:key</code>. Please also note that live objects are evaluated on an overlay/underlay page, even if the overlay/underlay page is hidden.'''
 |-
 | <code>from</code> || <code>number</code> || <code>0</code> || No || data-sort-value=70|'''0.1.70''' ||

@@ Line 34: / Line 34: @@
      "progress": -1,
      "progressColor": "msx-blue",
      "wrapperColor": "msx-gray",
      "image": "http://link.to.image",
@@ Line 208: / Line 209: @@
 |-
 | <code>progressColor</code> || <code>string</code> || <code>null</code> || No || data-sort-value=70|'''0.1.70''' ||
 The live content property of the corresponding content item.
 |-

@@ Line 205: / Line 205: @@
 The live content property of the corresponding content item.
-'''Note: Only if the <code>progress</code> property has been set (to a non <code>null</code> value) in the origin data of the corresponding content item, it can be updated. By default, this property is automatically updated if the live object is in state <code>"running"</code>. If this property is set, it will not be updated automatically. Since version 0.1.74, this property is also automatically updated if the <code>type</code> property is set to <code>"playback"</code> and the corresponding content item contains the extension property <code>resume:key</code>.'''
+'''Note: Only if the <code>progress</code> property has been set (to a non <code>null</code> value) in the origin data of the corresponding content item, it can be updated. By default, this property is automatically updated if the live object is in state <code>"running"</code>. If this property is set, it will not be updated automatically. Since version 0.1.74, this property is also automatically updated if the <code>type</code> property is set to <code>"playback"</code> and the corresponding content item contains the extension property <code>resume:key</code>. Since version 0.1.156, this property can be set to <code>-2</code> to explicitly enable auto-update (any other value is used as is).'''
 |-
 | <code>progressColor</code> || <code>string</code> || <code>null</code> || No || data-sort-value=70|'''0.1.70''' ||

@@ Line 116: / Line 116: @@
 Since version '''0.1.153''', this object can also contain following sub-state objects to use separate live content properties for specific states.
-* <code>ready</code>: This sub-state object is used if the progress is exactly 0. If this object is not set, the <code>quartile1</code> object is used. It is typically used with live objects of type <code>"playback"</code>.
+* <code>ready</code>: This sub-state object is used if the progress is exactly 0.0. If this object is not set, the <code>quartile1</code> object is used. It is typically used with live objects of type <code>"playback"</code>.
-* <code>complete</code>: This sub-state object is used if the progress is exactly 1. If this object is not set, the <code>quartile4</code> object is used. It is typically used with live objects of type <code>"playback"</code>.
+* <code>complete</code>: This sub-state object is used if the progress is exactly 1.0. If this object is not set, the <code>quartile4</code> object is used. It is typically used with live objects of type <code>"playback"</code>.
 '''Note: To use this property, the <code>type</code> property must be set to <code>"schedule"</code>, <code>"lifetime"</code>, <code>"airtime"</code>, or <code>"playback"</code>, otherwise this property is ignored. The live action will only be executed once, if the live object enters the state <code>"running"</code>. The sub-state objects do not support live actions. Since version 0.1.74, live objects of type <code>"playback"</code> can also contain the sub-state objects inside the <code>coming</code> property.'''

@@ Line 114: / Line 114: @@
 * <code>quartile4</code>: This sub-state object is used if the progress is in range of 0.75 to 1.0.
-Since version '''0.1.153''', this object can also contain following sub-state objects to use separate live content properties for specific phases.
+Since version '''0.1.153''', this object can also contain following sub-state objects to use separate live content properties for specific states.
 * <code>ready</code>: This sub-state object is used if the progress is exactly 0. If this object is not set, the <code>quartile1</code> object is used. It is typically used with the <code>"playback"</code> type.

@@ Line 91: / Line 91: @@
 * <code>"id:{ID}"</code>: The indicated content item ID is used to check the live state.
-* <code>"url:{URL}"</code>: The indicated content action URL is used to check the live state.
+* <code>"url:{URL}"</code>: The indicated content action URL (i.e. <code>video:{URL}</code> or <code>audio:{URL}</code>) is used to check the live state.
 * <code>"key:{KEY}"</code>: The indicated content <code>resume:key</code> is used to check the live state.
-* <code>"resume:{KEY}"</code>: The live object will never be in the state <code>"running"</code>, but will be in the state <code>"coming"</code> if the indicated content <code>resume:key</code> is resumable.
+* <code>"resume:id:{ID}"</code>: The live object will never be in the state <code>"running"</code>, but will be in the state <code>"coming"</code> if the indicated content item ID is resumable.
 '''Note: To use this property, the <code>type</code> property must be set to <code>"playback"</code>, otherwise this property is ignored.'''