Save Snapshot

Save a snapshot and associated metadata when a specific condition is met


The node saves a snapshot in jpg format, along with the Pipeline metadata contained in that frame, as a files API object.

Files created by this node are also listed in the Console under the Deployment detail page.

Format of output

This node creates 2 files for every snapshot it saves:

  1. Media file (JPEG format), named <node_name>-YYYY-MM-DDThhmmss.usZ.jpg. Ex. snapshot1-2023-01-20T083909.952Z.jpg. The timestamp in the file name is the creation timestamp. This file contains the media for the snapshot in jpg format.

  2. Metadata file (JSON format) named <node_name>-YYYY-MM-DDThhmmss.usZ.jpg.json. Ex snapshot-2023-01-20T083909.952Z.jpg.json. This file contains the metadata for the frame contained in the media file in JSON format.

Inputs & Outputs

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


locationWhere to save snapshots & associated metadata. Options :

local : Save to local disk, in the folder specified under path property.

lumeo_cloud : Upload to Lumeo's cloud service. For this location, Lumeo will always create a files object for each snapshot.

s3 : Upload to a custom S3 bucket.
pathPath to save the snapshots, if location == local. If you change the defaults, ensure that the path is writable by lumeod user.

If location is set to lumeo_cloud snapshots are temporarily stored at /var/lib/lumeo/clip_upload (till they are uploaded).
max_edge_filesMaximum number of files to keep on local disk, when location == local, for this specific node. Ignored when location == lumeo_cloud.

If this property is not set, Lumeo will continue to save till the disk fills up. If it is set, Lumeo will save to local disk in a round robin manner (overwrite the 1st file once max_edge_files have been written).
triggerSave a snapshot when this condition is met, subject to Trigger mode property below.

The trigger expression must be a valid Dot-notation expression that operates on Pipeline Metadata and evaluates to True or False. See details here.

ex. nodes.annotate_line_counter1.lines.line1.total_objects_crossed_delta > 0
trigger_modeSingle : Take a snapshot once every time the trigger condition is met (goes from False to True).

Exact : Take a snapshot of every frame for as long as the condition is met.
s3_endpointAWS S3-compatible endpoint to upload to. Used when location == s3.

ex. or
s3_regionAWS S3-compatible endpoint Region. Used when location == s3.

ex. us or fra1
s3_bucketAWS S3-compatible bucket name. Used when location == s3.

ex. lumeo-data
s3_key_prefixFolder prefix within the AWS S3-compatible bucket that files will be created in. Used when location == s3.

ex. production/test
s3_access_key_idS3 API Key ID with write access to the specified bucket. Used when location == s3.

s3_secret_access_keyS3 API Key with write access to the specified bucket.


Metadata PropertyDescription