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

Property	Description	Type	Default	Required
`event_type`	Event type to add to metadata. Can be used by downstream nodes to index clips, publish to Lumeo Dashboard etc.	string	``	Yes
`event_description`	Event description to add to metadata. Accepts templates. Optional.	text	``	No
`event_trigger`	Trigger the event when this condition evaluates to true.	trigger-condition	``	Yes
`trigger_mode`	Trigger 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.	enum	`exact`	Yes
`trigger_duration`	Minimum event duration in seconds. 0 implies 1 frame. Conditional on `trigger_mode` set to `fixed`.	float	`0`	Yes

Event Description Template

event_description uses Jinja2 Template Syntax for customizing the body of the Event description.

Variables available to the template:

Variable	Description
`nodes`	Node metadata.
`objects`	Object metadata.
`custom_property`	Custom properties inserted using a Custom function.

Examples

Static text content:

Fire was detected in the parking lot

Insert description from an existing node:

{{ nodes.annotate_line_counter1.lines.line1.dir1_objects_crossed_delta }} cars crossed the line

{{ nodes.claude1.rois.polygon1.label }}

Metadata

Example

{
    "nodes": {
        "[node_id]": {
            "event_delta": 1,
            "event_state": 1,
            "event": "illegal_right_turn",
            "event_id": "550e8400-e29b-41d4-a716-446655440000",
            "event_description": "The white SUV made a right turn at the intersection"
        }
    }
}

Format

Field	Description
`node_id`	This node's ID. Format: `eventX` ex. `event1`
`event_delta`	1 if the event_state changed from previous frame to this frame.
`event_state`	Current state of event : 0 (inactive) or 1 (active).
`event`	User-defined event type.
`event_id`	UUID for the event.
`event_description`	Event description. String or Null.