Track API

Signature

Interface Track

Type parameters

Name	Constraint	Default	Description
`TrackKind`	None	`string`	The app-defined track kind, commonly "visual", "audio", or "subtitle".

Properties

Name	Signature	Description
`clips`	`clips: Clip[]`	Clips contained by this track in timeline order. Keep clips ordered by `timelineStart` for predictable rendering, hit testing, and snapping. Overlaps are allowed when your editor model supports them.
`collapsed?`	`collapsed?: boolean`	Collapses the track row into a compact layout when true. The default React track item renders collapsed rows at 24px high and expanded rows at `height` or its default.
`groupId?`	`groupId?: string`	Optional group identifier for visually grouping tracks.
`height?`	`height?: number`	Display height in pixels when expanded. Interaction components use this to size the row; when omitted, UI layers typically fall back to 48px.
`id`	`id: string`	Stable app-provided identifier used by engine operations. Track ids must be unique within a timeline state. Keep the value stable across renders, serialization, undo history, and drag operations.
`kind`	`kind: TrackKind`	App-defined lane category for routing behavior or display treatment.
`locked`	`locked: boolean`	Prevents clip edits on this track when true. Locked tracks are read-only for editing controls, but still provide snap reference targets unless `track.snap` disables them.
`muted`	`muted: boolean`	Marks this track as muted. Muted tracks affect playback/routing semantics and can be rendered with dimmed treatment by UI layers; muting does not disable snap references.
`name?`	`name?: string`	User-friendly name of the track.
`selected`	`selected: boolean`	Whether the track itself is selected in the UI.
`snap?`	`snap?: false \| TrackSnapOptions`	Whether this track's clips participate in snapping, or track-specific snap settings.
`targeted?`	`targeted?: boolean`	Whether the track is targeted for insert/overwrite/paste operations (e.g. V1, V2).
`visible`	`visible: boolean`	Marks this track as visible in output/active-layer lookup. Invisible tracks remain editable rows in timeline layouts, but their clips are excluded from playback, preview, and active media synchronization.