Clip API

Signature

Interface Clip

Properties

Name	Signature	Description
`color?`	`color?: string`	Custom styling color override (HEX color) for rendering the clip bar.
`disabled?`	`disabled?: boolean`	Whether the clip is disabled (suppressed from rendering and playback).
`editPreview?`	`editPreview?: ClipEditPreview`	Transient live-edit preview state for UI affordances.
`id`	`id: string`	Unique identifier for the clip.
`keyframes?`	`keyframes?: TimelineKeyframe[]`	Clip-scoped property keyframes positioned at absolute timeline times.
`label?`	`label?: string`	Optional customized text label rendered inside the clip.
`maxEnd?`	`maxEnd?: RationalTime`	Maximum allowable timelineEnd timestamp for locking clip positions.
`metadata?`	`metadata?: Record<string, unknown>`	Arbitrary custom application metadata attached to this clip.
`minStart?`	`minStart?: RationalTime`	Minimum allowable timelineStart timestamp for locking clip positions.
`movable?`	`movable?: boolean`	Whether this clip can be dragged left/right across the timeline track.
`opacity?`	`opacity?: number`	Visual transparency or volume level of this clip, from 0.0 to 1.0.
`resizable?`	`resizable?: boolean`	Whether the boundaries of this clip can be trimmed or extended.
`selected`	`selected: boolean`	Whether this clip is currently selected by the user.
`snap?`	`snap?: false \| ClipSnapOptions`	Whether this clip participates in snapping, or clip-specific snap settings.
`sourceId`	`sourceId: string`	Identifier linking this clip to its source asset (e.g., source video asset ID).
`sourceStart`	`sourceStart: RationalTime`	Offset into the source file from which playback begins.
`timelineEnd`	`timelineEnd: RationalTime`	End time of the clip on the global timeline.
`timelineStart`	`timelineStart: RationalTime`	Start time of the clip on the global timeline.