milestonexprotectrestpython.xpreventtype
Module: xpreventtype.py
Revision History
Date | Version | Description |
---|---|---|
2023/07/11 | 1.0.0.0 | Initial Version. |
Event Type information.
Threadsafety:
This class is fully thread-safe.
The BuiltIn status of the item - True if BuiltIn; otherwise False.
Returns:
The BuiltIn property value.
Globally unique identifier of the Counter event that relates to this event.
Returns:
The CounterEventID property value.
For example ... if this event type were a "Start Recording" event, then it's counter event would be the "Stop Recording" event.
Date and time (in UTC format) that the item was last modified.
Returns:
The DateModified property value.
User-friendly display name used in various user-interface displays.
Returns:
The DisplayName property value.
Globally unique identifier of the parent EventTypeGroup.
Returns:
The EventTypeGroupId property value.
Globally unique identifier of the originating group.
Returns:
The GeneratorGroupId property value.
Name of the originating group.
Returns:
The GeneratorGroupName property value.
Globally unique identifier of the originator.
Returns:
The GeneratorId property value.
True if the event type occurs globally; otherwise, False.
Returns:
The OccursGlobally property value.
Source item types.
Contains an array of possible sources of the event.
Can contain Camera, Hardware and other itemtype values.
For MIP plugin events the source itemtype is MIPItem and the filter contains the MIP Kind of source.
The actual source is selected in the rule and alarm definition configuration.
Returns:
The SourceArray property value.
Source filters.
Contains an array where the index is matching the sources.
Content is formatted as {value} or {type},{value}.
If source is "MIPItem" this value is the kind as defined in MIPKind (e.g. "3b559f2e-3693-5463-a6fb-005c1f0259dc").
Returns:
The SourceFilterArray property value.
State of the event type (e.g. "Warning", "Error", "Idle", etc).
Returns:
The State property value.
State group ID.
An event type can belong at most to one state group.
All event types with the same state group ID are used to determine the state of a source.
A source can be related to more than one state group. For example, a camera source is
related to at least two state groups: The motion state group and the recording state group.
Event types motion started and stopped in the motion state group determine whether something is moving inside the frame. Together, event types recording started and stopped in the recording state group determine whether the camera stream is being recorded.
Returns:
The StateGroupId property value.