Trigger an Event

Adds the specified event to the metadata stream for use by downstream nodes.

Overview

The Event node inserts a user defined event into the metadata, to be used by downstream nodes such as Publish to Lumeo Dashboard or Create Search Index.

Inputs & Outputs

  • Inputs: 1, Media Format: Raw Video
  • Outputs: 1, Media Format: Raw Video
  • Output Metadata: Event Metadata

Properties

PropertyDescriptionTypeDefaultRequired
event_typeEvent type to add to metadata. Can be used by downstream nodes to index clips, publish to Lumeo Dashboard etc.string``Yes
event_triggerTrigger the event when this condition evaluates to true.trigger-condition``Yes
trigger_modeTrigger mode. Options: exact, fixed. exact triggers for as long as trigger condition is true. fixed triggers for the defined minimum duration once the trigger condition is met.enumexactYes
trigger_durationMinimum event duration in seconds. 0 implies 1 frame. Conditional on trigger_mode set to fixed.float0Yes

Metadata

Example

{
    "nodes": {
        "[node_id]": {
            "event_delta": 1,
            "event_state": 1,
            "event": "illegal_right_turn"
        }
    }
}

Format

FieldDescription
node_idThis node's ID. Format: eventX ex. event1
event_delta1 if the event_state changed from previous frame to this frame.
event_stateCurrent state of event : 0 (inactive) or 1 (active).
event_typeUser-defined event type.