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
`enabled`	Enabled	`bool`	`true`	No
`event_type`	Event type to add to metadata. Accepts templates. Event type to add to metadata. Can be used by downstream nodes to index clips, publish to Lumeo Dashboard etc.	`string`	`null`	Yes
`event_description`	Event description to add to metadata. Accepts templates. Optional. Event description to add to metadata. Can be used by downstream nodes to index clips, publish to Lumeo Dashboard etc.	`string`	`null`	No
`event_trigger`	Trigger the event when this condition evaluates to true.	trigger-condition	`null`	Yes
`trigger_mode`	Trigger mode. Options: Exact (`exact`): Trigger for as long as trigger condition is true; Fixed (`fixed`): Trigger for the defined maximum duration once the trigger condition is met.	`enum`	`exact`	Yes
`trigger_duration`	0 implies 1 frame. Conditional on `trigger_mode` being `fixed`. Unit: seconds.	`float`	`0`	Yes
`event_log_severity`	Record to Events log. Options: Do not record (`none`); Info (`info`); Warning (`warning`); Error (`error`).	`enum`	`none`	No
`event_log_message`	Optional message to publish to Events log	`string`	`null`	No
`stop_deployment_on_event`	Stop deployment with an Error when event occurs.	`bool`	`false`	No

Event Description Template

event_type and event_description accept Jinja2 Template Syntax for customizing the Event Type and body of the Event description.

Variables available to the template:

Variable	Description
`deployment_id`	Deployment ID.
`deployment_name`	Deployment Name.
`application_id`	Application ID.
`application_name`	Application Name.
`gateway_id`	Gateway ID.
`gateway_name`	Gateway Name.
`node_id`	Node ID.
`meta.nodes`	Node metadata.
`meta.objects`	Object metadata.
`meta.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 }}

Output Metadata

The fields below are declared by this node's metadata schema; the JSON values are representative examples.

Path	Type	Description
`nodes.<node_id>.event_delta`	`integer`	When the state of the event changes
`nodes.<node_id>.event_state`	`boolean`	While the event state is true or false
`nodes.<node_id>.event`	`string`	Current event name, or null when no event is active.
`nodes.<node_id>.event_id`	`string`	Unique identifier of the current event, or null when inactive.
`nodes.<node_id>.event_description`	`string`	Rendered description of the current event, if configured.
`nodes.<node_id>.type`	`string`	Identifies the node type that produced this metadata.

JSON example

{
  "nodes": {
    "event1": {
      "event": "value",
      "event_delta": 0,
      "event_description": "value",
      "event_id": "value",
      "event_state": false,
      "type": "event"
    }
  }
}