Overview

The Sync & Tile Frames node synchronizes metadata between nodes across one or more deployments on the same Gateway. It can also be used to create a grid or overlay multiple video streams in one.

Inputs & Outputs

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

Pipeline usage

Use the same sync_key on Sync nodes that should exchange data; participating deployments must run on the same gateway. Place Sync after the nodes whose metadata should be published. Remote state appears under synced_deployments, keyed by the publishing deployment and Sync node, so downstream conditions must read that namespace rather than nodes or objects directly. Enable sync_pixels on publishers only when a preview or composite view is needed, because it adds image encoding, shared-memory, and composition work. sync_nodes limits node metadata but does not select object records.

Properties

Property	Description	Type	Default	Required
`sync_key`	Key used to synchronize data between Sync nodes in one or more deployments. Must be unique per sync group.	`string`	`null`	Yes
`sync_meta`	Metadata to sync. Options: All metadata (`all`): Sync all metadata; Objects only (`objects`): Only sync object detection metadata; Nodes only (`nodes`): Only sync node metadata.	`enum`	`all`	Yes
`sync_nodes`	Comma-separated list of specific nodes to sync. Empty means sync all nodes.	`string`	`null`	No
`sync_pixels`	Whether to publish video frame pixels from this node to others	`bool`	`false`	No
`preview_mode`	Show preview for published pixels. Options: None (`null`): No preview; Right thumbnails (`thumbnail_right`): Show thumbnails on right side; Bottom thumbnails (`thumbnail_bottom`): Show thumbnails on bottom; Grid view (`grid`): Show all streams in grid layout.	`enum`	`null`	No
`preview_dims`	Dimensions for preview thumbnails in width x height format	`string`	`640x360`	No

Output Metadata

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

Path	Type	Description
`synced_deployments.<deploymentid_syncnodeid>.nodes.<node_id>.<node_property>`	`string`	Node property from a sync'd node

JSON example

{
  "synced_deployments": {
    "8121-2129-2912-2191_sync1": {
      "nodes": {
        "sync1": {
          "property": "value",
          "type": "sync"
        }
      }
    }
  }
}