Save Clip Node

Save a Clip to local disk or cloud when a trigger condition is met.


The node saves clips in mp4 format, along with the Pipeline metadata contained in those frames, 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 : Encoded Video
  • Outputs : 1, Media Format: Encoded Video
  • Output Metadata : None





Maximum duration for the clip, in seconds. Once this duration is reached, a new clip will be started.


Duration, in seconds, of video to record before the trigger condition is met.

Note: See section below on how Pre-buffer works depending on the trigger_mode property.


Maximum size of a clip in bytes. Once this size is reached, a new clip will be started.


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

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


Path to save the clips, if location == local. If you change the defaults, ensure that the path is writable by lumeod user.

If location is set to lumeo_cloud clips 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).


Start recording a clip once the trigger condition is met.

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


Exact : Record for as long as the trigger condition is met, but only up to the defined maximum duration.

Fixed Duration : Record for the defined maximum duration once the trigger condition is met.

Pre-buffer Interval

This diagram below explains how the pre-buffer interval changes how the video clip is recorded.



Metadata Property




Did this page help you?