Overview

The node sends an Immix Alarm using SMTP based on events generated by previous nodes, or a custom trigger condition. It can also send a link to live stream, attach a snapshot as well as any Clips saved Locally using Save Clip Node.

The event_source property controls how this node is triggered:

built_in (Events from previous nodes): Sends an Immix Alarm when other nodes in the pipeline (such as annotate_line_counter, event, etc.) generate events. The triggering event names are available to the immix_extra_text template via the events variable.
custom (Custom Event): Sends an Immix Alarm when the trigger condition evaluates to true.

Inputs & Outputs

Inputs : 1, Media Format : Raw Video
Outputs : 1, Media Format: Raw Video
Output Metadata : None

Properties

Property	Description	Type	Default	Required
`event_source`	Generate Immix Alarms from events generated by other nodes or a Custom defined event. Options: Events from previous nodes (`built_in`); Custom Event (`custom`).	`enum`	`custom`	Yes
`trigger`	Send an alarm when this condition evaluates to true. Conditional on `event_source` being `custom`.	trigger-condition	`null`	Yes
`include_snapshot`	Include snapshot from trigger time?	`bool`	`true`	No
`media_node`	Includes the most recent clip from the named Save Clip node with the alarm. The node must be configured to store clips locally. Accepted node type: `clip`.	`string`	`null`	No
`livestream_node`	Select Stream WebRTC Node to use. If specified, includes the live stream URL from this WebRTC Node with the Alarm. Accepted node type: `stream_webrtc_out`.	`string`	`null`	No
`enabled`	Enabled	`bool`	`true`	No
`immix_server`	IP Address of the Immix SMTP Server. Conditional on `enabled` being `true`.	`string`	`null`	Yes
`immix_port`	Port of the Immix SMTP Server. Conditional on `enabled` being `true`.	`number`	`null`	Yes
`immix_use_tls`	If enabled, a TLS socket will be used for the Immix SMTP session. Your Immix server must support the STARTTLS SMTP extension to use this. Conditional on `enabled` being `true`.	`bool`	`null`	No
`immix_to_email`	Email address associated with the System. Conditional on `enabled` being `true`.	`string`	`null`	Yes
`immix_alarm_number`	Immix alarm number for the	`number`	`null`	Yes
`immix_event_type`	Immix	`enum`	`ObjectDetected`	Yes
`immix_extra_text`	See node documentation for details on template variables.	`string`	`null`	No
`immix_location`	A description of location where the alarm occurred, e.g. latitude and longitude.	`string`	`null`	No
`interval`	Min. time between consecutive alarms. Unit: seconds.	`number`	`0`	No
`max_media_wait_time`	Max. time to wait until a media clip is available. Unit: seconds.	`number`	`10`	No
`enable_universal_bridge_override`	If enabled, overrides "To" email address with the email address received by the Universal Bridge. Set this to true in a pipeline used with the Universal Bridge.	`bool`	`true`	No

Template Syntax

The following Template variables are available to use in Email Subject and Body. The templates can be built using Jinja2 Template Syntax.

Variables available to the template:

Variable	Description
`events`	List of event names from previous nodes that triggered this alarm (when `event_source` is `built_in`).
`meta`	Frame metadata. Contains keys like `nodes`, `objects`, and other custom metadata inserted by Custom function node.
`application_id`	The application ID of the deployment that produced this metadata.
`application_name`	The application name of the deployment that produced this metadata.
`deployment_id`	The deployment ID of the deployment that produced this metadata.
`deployment_name`	The deployment name of the deployment that produced this metadata.
`source_name`	The name of the source that produced this metadata.
`livestream_url`	The URL of the livestream.

Example templates

Static text content:

Text content

Reference specific metadata:

Person detected on {{ source_name }}. View live stream at {{ livestream_url }}

Metadata reinserted as is:

{{ meta | tojson }}

Output Metadata

Node does not insert any output metadata; upstream metadata continues through the pipeline