Overview

Receive events from Genetec Security Center

Inputs & Outputs

Input media: Raw Video.
Output media: Raw Video.
Output metadata: nodes.<node_id>.events_delta, events_count, and genetec_events.

Pipeline usage

This node maintains a background subscription to the Genetec Security Center Web SDK and uses video frames only as the clock and metadata carrier. Configure a Genetec account with permission to read the selected event sources. The default endpoint is https://<hostname>:4590/WebSdk.

Select built-in event_types and optionally add comma-separated other_event_types. Narrow the subscription with event_source, source_ids, and event_filters; source IDs are Genetec logical IDs. Incoming events are buffered thread-safely and published on the next frame under:

nodes.<node_id>.events_delta — true when this frame publishes one or more new events.
nodes.<node_id>.events_count — number of events published on this frame.
nodes.<node_id>.genetec_events — event payloads; the buffer is cleared after publication.

Place trigger, notification, or storage nodes downstream and gate them on events_delta to avoid acting again on an empty subsequent frame.

Properties

Property	Description	Type	Default	Required
`enabled`	Enabled	`bool`	`true`	No
`hostname`	Server host name or IP address. Conditional on `enabled` being `true`.	`string`	`null`	Yes
`username`	User account that has privileges to send an alarm through Genetec VMS WebSDK. Conditional on `enabled` being `true`.	`string`	`null`	Yes
`password`	Password. Conditional on `enabled` being `true`.	`string`	`null`	Yes
`port`	Server Port. Conditional on `enabled` being `true`.	`number`	`4590`	Yes
`base_uri`	Web-based SDK Base URI. Conditional on `enabled` being `true`.	`string`	`WebSdk`	Yes
`https`	Use SSL Connection? Conditional on `enabled` being `true`.	`bool`	`true`	No
`event_types`	Genetec event types to receive from the server. Options: Door Open (`DoorOpen`); Door Close (`DoorClose`); Door Locked (`DoorLock`); Door Unlocked (`DoorUnlock`); Door Entry Detected (`DoorEntryDetected`); Access Granted (`AccessGranted`); Access Refused (`AccessRefused`); Alarm Triggered (`AlarmTriggered`). Format: array of selected option values.	`string[]`	`null`	Yes
`other_event_types`	Comma separated list of additional event types to receive from the server.	`string`	`null`	No
`event_source`	Source of Genetec events to receive from the server. Options: Area (`area`); Camera (`camera`); Door (`door`); Other (`other`).	`enum`	`null`	Yes
`other_event_source`	Other Genetec event source type to receive events from. Conditional on `event_source` being `other`.	`string`	`null`	Yes
`source_ids`	Comma separated list of logical IDs of the event source, obtained from Genetec Security Center.	`string`	`null`	No
`event_filters`	Filters to apply to the Genetec events received from the server.	`json`	`null`	No
`debug`	Log debugging information.	`bool`	`false`	No

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>.events_delta`	`integer`	When one or more Genetec events are received
`nodes.<node_id>.events_count`	`integer`	The number of Genetec events received
`nodes.<node_id>.genetec_events[].<event_field>`	`any JSON value`	JSON-compatible value supplied for this field by the Genetec event payload.
`nodes.<node_id>.genetec_events[].event_field.example`	`string`	Value of example.
`nodes.<node_id>.type`	`string`	Identifies the node type that produced this metadata.

JSON example

{
  "nodes": {
    "vms_genetec_events1": {
      "events_count": 0,
      "events_delta": 0,
      "genetec_events": [
        {
          "event_field": {
            "example": "value"
          }
        }
      ],
      "type": "vms_genetec_events"
    }
  }
}