Save Snapshot Node

Save a Snapshot to local disk or cloud when a trigger 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.

Inputs & Outputs

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





Where to save clips. Options :
local : Save snapshots to local disk, in the folder specified under path property.
lumeo_cloud : Upload snapshots to Lumeo's cloud service.

Irrespective of location, Lumeo will always create a files object for each snapshot. However, when location is local, the media will not be saved in this object.


Path 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).


Maximum 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).


Save 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


Single : 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.


Metadata Property




Did this page help you?