Canvas Timeline
Interface

UseTimelineClipsResult

Clip collection, lookup, edit capabilities, and presentation commands.

Signature

Type Definition
Interface UseTimelineClipsResult

Properties

NameSignatureDescription
canMoveClip(clipId: string): booleanWhether the clip and its track allow movement.
canSlideClip(clipId: string): booleanWhether the clip and its track allow sliding.
canSlipClip(clipId: string): booleanWhether the clip and its track allow source slipping.
canTrimClip(clipId: string): booleanWhether the clip and its track allow trimming.
clipsclips: { clip: object; clipIndex: number; track: object; trackIndex: number }[]Flattened clips in timeline track order.
getClip(clipId: string): TimelineClipEntry<string> | undefinedLooks up a clip and its containing track in current engine state.
updateClip(clipId: string, properties: TimelineClipUpdate): TimelineCommandResultUpdates clip presentation through the engine's validated command API.