About playback attributes
- Last UpdatedNov 06, 2024
- 3 minute read
Playback attributes are Read/Write and typically used as graphic element animation reference values. When the user interacts with a graphic element's animation or script, Playback attribute values are modified to enable some aspect of showing real time or historical data.
Tags and other static attribute values are generally not historized due to their unchanging nature. When these and any other non-historized static attributes are shown during playback, there are no values that can be pulled from the historical data. Prior to System Platform 2023, non-historized attribute values were displayed as empty or NaN (not a number) in place of the missing data. With System Platform 2023, a live data connection is opened to provide the these missing values. You can configure the appearance of the live data during Playback in the IDE.
If any other Quality and Status indicator is displayed (Communication Error, Security Error, Warning, etc.), live data is not shown for the non-historized values and the missing numerical values are shown as NaN. Other data types (string, date, Bool, etc.) may be shown as empty.
Important: Playback attributes are predefined and available only for AVEVA OMI ViewApps. Playback attributes cannot be included in an InTouch HMI application.
All Playback attributes operate in the MyViewApp.Playback namespace. The names of Playback attributes are specified with the MyViewApp.Playback prefix in the form MyViewApp.Playback.attribute_name. To access the Playback namespace, you can reference the SDK assembly ArchestrA.ClientRuntimeData.dll.
|
Attribute Name |
Data Type |
Attribute Type |
Initial Value |
Description |
|---|---|---|---|---|
|
CurrentTime |
DateTime |
Read/Write |
Current playback time |
CurrentTime is set to the current playback time when in playback mode. Setting this attribute adjusts the current playback time. The time assigned to CurrentTime can be only within the historical playback period. When the current time is being set and the speed is 0 (pause mode), the client will receive a data update based on the current time of the local system. |
|
Enabled |
Boolean |
Read/Write |
False |
When Enabled is set to True, other attributes are initialized to their default values and playback is enabled. When set to False, historical playback is disabled and play real time data. |
|
EndTime |
DateTime |
Read/Write |
Current time |
EndTime is initialized to the current time when the Enabled attribute is set to True. Setting this attribute adjusts the ending time of the historical playback range. EndTime can be set to a value regardless of the value set to the Enabled attribute. |
|
HistorianServer |
String |
Read/Write |
Empty string |
Node name of the computer hosting the Historian and its historical data. The value assigned to HistorianServer is retentive. If the initial value of HistorianServer is an empty string, the Historian is expected to be installed on the GR node. |
|
Playing |
Boolean |
Read/Write |
False |
When Playing is set to True, historical playback becomes active and playback speed is set to 1. The Enabled attribute must be set to True to set Playing to True. |
|
Speed |
Integer |
Read/Write |
0 |
Historical data playback speed as an integer value. 0 represents playback is stopped or paused. 1 represents normal playback speed. Speed values greater than 1 are functionally equivalent to the fast forward function of a media player that plays data faster than it was recorded. |
|
StartTime |
DateTime |
Read/Write |
8 hours prior to the current time |
StartTime is initialized to 8 hrs prior to the current time when the Enabled attribute is set to True. Setting this attribute adjusts the starting time of the historical playback range and the current playback time adjusts accordingly. StartTime can be set to a value regardless of the value set to the Enabled attribute. |