Cav frame player
Cav Frame Player operator properties for Script Engine. Picks a single frame from a CAV file loaded by a Cav file input and renders it on the layer. Useful for "show frame N" workflows — building a still image from a known position in a recording, frame-by-frame stepping driven from a script, or snapshotting a particular moment for use as a graphic. The frame number can be set from the UI or scripted, and the operator displays summary info about the source CAV (file path, total frame count, resolution).
| Property | Type | Access | Description |
|---|---|---|---|
ComponentLog |
ComponentLog |
get |
Live log of messages and warnings related to this operator (read-only). Records when a CAV input is detected, when the source has invalid dimensions, and any errors during frame rendering. |
SourceInfo |
Dictionary<string, object> |
get/set |
Summary info about the loaded CAV source — file path, frame count, and resolution (read-only). Populated when the operator is connected to a Cav file input. Useful for showing the user what the source looks like, or for scripts that need to know the source dimensions or length without reaching into the input directly. |
CurrentFrame |
DynamicIntSlider |
get |
Frame number to render from the connected CAV source. [default=0]. 0 is the first frame. The slider's upper bound is set automatically to the total frame count of the loaded CAV. Change this from a script to step through frames programmatically — the rendered output updates whenever the value changes. |
NumberOfVideoFrames |
int |
get |
Total number of video frames in the connected CAV source (read-only). Updated when a CAV input is detected. Useful from a script for clamping CurrentFrame to a valid range or for computing relative positions like "show the frame at 50% of the way through". |
ResetCmd |
Command |
get |
Reset operator state — clears the cached frame and forces a re-detect of the connected CAV input. |
Inherits from: AbstractOperator, AbstractAudioMetering.
See also: Cav frame player in Operators — user-facing introduction, screenshots, and section summaries.