Filter Stream
Filter frames based on condition or interval
Overview
Use the Filter Stream Node to conditionally allow one or more frames to pass through to the downstream Nodes. This is typically used to selectively take snapshots, or save clips, or send webhooks when specific conditions are met.
Inputs & Outputs
- Inputs : 1, Media Format : Raw Video
- Outputs : Raw Video
- Output Metadata : None
Properties
| Property | Value |
|---|---|
mode | Control operating mode. allow : Conditionally allow frames to pass through, drop: Drop all frames (but for the first one to allow pipelines to start up). |
condition | Allow frames when this condition evaluates to true. If Duration specified, allow only for duration every time condition goes from false to true. Else allow while condition is true. 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 |
interval | Allow frames at this interval (seconds). If duration is specified, allow for duration every interval, else allow once per interval. Ignored if condition is specified. |
duration | If specified, allow frames through for this duration depending on condition or at the specified interval. Set to -1 to allow only a single frame. |
Metadata
| Metadata Property | Description |
|---|---|
| None | None |
Updated 11 days ago