Cav file input

CAV file input properties for Script Engine. Plays back a Vindral CAV file — Composer's own video and audio container, designed for frame-accurate playback with cue points. Supports play, pause, stop, rewind, frame-by-frame stepping, 10-frame skips, and jumping directly to a cue point by index or by name. Cue points can also drive automatic actions (loop, pause, end-of-file behaviour) when reached.

Property	Type	Access	Description
`ShowAdvancedOptions`	`bool`	`get/set`	Show or hide the input's advanced settings in the editor UI. [default=false].
`SourceUrl`	`Uri?`	`get/set`	Path or URL to the CAV file to play. Accepts a local file path or a remote URL pointing at a Vindral CAV file. Clearing this stops playback. While playback is running, this property is locked — stop the input before changing the source.
`MediaPlayerState`	`MediaPlayerState`	`get`	Current playback state of the input (read-only). Reflects whether the file is `NoMedia` (nothing loaded), `Playing`, `Paused`, `Stopped`, or in an error state. Driven indirectly by `PlayCommand`, `PauseCommand`, `StopCommand`, and `AutoPlay` at load time.
`CurrentFrame`	`int`	`get`	Current playhead position, as a frame number (read-only). Counts from 0 at the start of the file. Useful from a script for frame-accurate timing or to detect when a specific frame has been reached.
`FrameIsCuePoint`	`bool`	`get`	True if the current frame is marked as a cue point in the CAV file (read-only). Useful from a script to react each time the playhead lands on a cue point — for example to fire a parallel action without having to wait for `PassedCuePoint`.
`CurrentTime`	`TimeCode`	`get`	Current playhead position, as a time code in hours:minutes:seconds:frames (read-only). Updates continuously while the file is playing. Useful for displaying the playhead in a UI or for triggering events at specific points in the file.
`PlayCommand`	`Command`	`get`	Start playing the loaded CAV file.
`RewindCommand`	`Command`	`get`	Jump back to the start of the file.
`PauseCommand`	`Command`	`get`	Pause playback at the current frame.
`StopCommand`	`Command`	`get`	Stop playback and rewind to the beginning.
`PreviousCuePointCommand`	`Command`	`get`	Jump to the cue point before the most recently passed one. Note: this skips backwards past the cue point you just played through, not back to it.
`NextCuePointCommand`	`Command`	`get`	Jump to the next cue point in the file.
`PreviousFrameCommand`	`Command`	`get`	Step one frame backward. Playback must be paused.
`NextFrameCommand`	`Command`	`get`	Step one frame forward. Playback must be paused.
`Back10FramesCommand`	`Command`	`get`	Jump 10 frames backward.
`Skip10FramesCommand`	`Command`	`get`	Jump 10 frames forward.
`PlayBackEndCondition`	`PlayBackEndCondition`	`get/set`	What to do when playback reaches the end of the file. Choose between stopping, looping back to the start, holding on the last frame, or other supported end-of-file actions. Pick the option that matches how the clip should behave in the production — looping for backgrounds, stopping for cued playouts, etc.
`AutoPlay`	`bool`	`get/set`	Whether the file starts playing as soon as the project loads. [default=true]. When true, playback begins automatically once the source is ready. Disable to require an explicit `PlayCommand`, useful when playback should only start on operator action or via a script trigger.
`CuePointsTrackInfo`	`Dictionary<string, object>?`	`get`	Information about all cue points found in the loaded CAV file (read-only). A dictionary listing each cue point's name and frame position. Use this from a script to discover what's available in the file before jumping to a particular point.
`JumpToCuePointIndex`	`int`	`get/set`	Index of the cue point to jump to when `JumpToIndexedCuePointCommand` runs. [min=0]. Cue points are numbered from 0 in the order they appear in the file. See `CuePointsTrackInfo` to discover which indexes are available.
`JumpToCuePointName`	`string`	`get/set`	Name of the cue point to jump to when `JumpToNamedCuePointCommand` runs. Set to the exact name of a cue point as defined in the CAV file. The name-based jump command is only enabled when this matches a cue point that actually exists in the file.
`JumpToIndexedCuePointCommand`	`Command`	`get`	Jump to the cue point with the index in `JumpToCuePointIndex`.
`JumpToNamedCuePointCommand`	`Command`	`get`	Jump to the cue point with the name in `JumpToCuePointName`.
`CuePointJumpBehaviour`	`CuePointJumpBehaviour`	`get/set`	Whether the file plays or pauses after a jump to a cue point. Controls what happens immediately after `JumpToIndexedCuePointCommand`, `JumpToNamedCuePointCommand`, `NextCuePointCommand`, or `PreviousCuePointCommand` runs — for example "start playing from there" vs. "land on the cue point and stay paused".
`CuePointBehaviour`	`CuePointBehaviour`	`get/set`	What happens automatically when playback reaches a cue point. Choose between continuing through the cue point, pausing on it, or looping back to the previous cue point. Useful for building interactive playback flows where the file pauses at known anchor points and only resumes on operator action.
`PassedCuePoint`	`CavCuePoint?`	`get`	The cue point that playback most recently passed (read-only). Updated each time the playhead crosses a cue point. Read this from a script to know where in the file you are in cue-point terms — for example to drive UI labels or trigger follow-up actions.
`CompressionPercent`	`double`	`get`	Size of the most recently decoded frame compared to a fully uncompressed picture (read-only). Expressed as a percentage — lower is better-compressed. A handy at-a-glance indicator of how efficiently the file is encoded for the picture content currently on screen.
`Width`	`int`	`get`	Width of the video in the loaded CAV file, in pixels (read-only).
`Height`	`int`	`get`	Height of the video in the loaded CAV file, in pixels (read-only).
`VideoTrackInfo`	`Dictionary<string, object>?`	`get`	Metadata about the video track in the loaded CAV file (read-only). A dictionary with technical details about the video — resolution, frame rate, codec, duration, and so on. Available once the file has finished loading.
`AudioTrackInfo`	`Dictionary<string, object>?`	`get`	Metadata about the audio track in the loaded CAV file (read-only). A dictionary with technical details about the audio — codec, sample rate, channel count, bit rate, and so on. Available once the file has finished loading.
`MiniLog`	`FormattedMessage`	`get`	Most recent status, info, or error message from the input (read-only). The input writes here when the source loads, when playback starts/stops, when a cue point is reached, or when something goes wrong. Read this from a script to surface the latest event.

Inherits from: AbstractInput, AbstractAudioProcessing, AbstractAudioMetering.

See also: Cav file input in Inputs — user-facing introduction, screenshots, and section summaries.