Interface

Clip

Represents an individual media clip node positioned at a specific timeline interval.

Signature

Type Definition
Interface Clip

Properties

NameSignatureDescription
color?color?: stringCustom styling color override (HEX color) for rendering the clip bar.
disabled?disabled?: booleanWhether the clip is disabled (suppressed from rendering and playback).
editPreview?editPreview?: ClipEditPreviewTransient live-edit preview state for UI affordances.
idid: stringUnique identifier for the clip.
keyframes?keyframes?: TimelineKeyframe[]Clip-scoped property keyframes positioned at absolute timeline times.
label?label?: stringOptional customized text label rendered inside the clip.
maxEnd?maxEnd?: RationalTimeMaximum allowable timelineEnd timestamp for locking clip positions.
metadata?metadata?: TimelineMetadataArbitrary custom application metadata attached to this clip. Use plain objects, arrays, strings, finite numbers, booleans, null, or undefined. Store Maps, Sets, Dates, buffers, and other domain objects outside the engine. Metadata is copied on input and deeply frozen in public snapshots.
minStart?minStart?: RationalTimeMinimum allowable timelineStart timestamp for locking clip positions.
movable?movable?: booleanWhether this clip can be dragged left/right across the timeline track.
opacity?opacity?: numberVisual transparency or volume level of this clip, from 0.0 to 1.0.
resizable?resizable?: booleanWhether the boundaries of this clip can be trimmed or extended.
selectedselected: booleanWhether this clip is currently selected by the user.
snap?snap?: false | ClipSnapOptionsWhether this clip participates in snapping, or clip-specific snap settings.
sourceIdsourceId: stringIdentifier linking this clip to its source asset (e.g., source video asset ID).
sourceStartsourceStart: RationalTimeOffset into the source file from which playback begins.
timelineEndtimelineEnd: RationalTimeEnd time of the clip on the global timeline.
timelineStarttimelineStart: RationalTimeStart time of the clip on the global timeline.