Canvas Timeline
Interface

UseTimelineEditCommandsResult

Result returned by `useTimelineEditCommands`.

Signature

Type Definition
Interface UseTimelineEditCommandsResult

Properties

NameSignatureDescription
cancelEdit(): voidClears the active command preview.
commitEdit(command: TimelineEditCommand): TimelineCommandResult<TimelineEditCommitResult>Commits a typed edit command as one history entry.
deleteRange(command: Omit<TimelineDeleteRangeEditCommand, "type">): TimelineCommandResult<TimelineEditCommitResult>Commits a range delete command.
insertClip(command: Omit<TimelineInsertEditCommand, "type">): TimelineCommandResult<TimelineEditCommitResult>Commits an insert command.
liftRange(command: { endTime: RationalTime; startTime: RationalTime; trackIds: typeOperator }): TimelineCommandResult<TimelineEditCommitResult>Commits a lift-range command.
moveClip(command: Omit<TimelineMoveEditCommand, "type">): TimelineCommandResult<TimelineEditCommitResult>Commits a move command.
overwriteClip(command: Omit<TimelineOverwriteEditCommand, "type">): TimelineCommandResult<TimelineEditCommitResult>Commits an overwrite command.
previewEdit(command: TimelineEditCommand): TimelineEditPreviewResolves and publishes a non-mutating command preview.
rippleTrimClip(command: Omit<TimelineRippleTrimEditCommand, "type">): TimelineCommandResult<TimelineEditCommitResult>Commits a ripple-trim command.
rollTrim(command: Omit<TimelineRollTrimEditCommand, "type">): TimelineCommandResult<TimelineEditCommitResult>Commits a roll-trim command.
slideClip(command: Omit<TimelineSlideEditCommand, "type">): TimelineCommandResult<TimelineEditCommitResult>Commits a slide command.
slipClip(clipId: string, deltaTime: RationalTime): TimelineCommandResult<TimelineEditCommitResult>Commits a slip command.
trimClip(command: Omit<TimelineTrimEditCommand, "type">): TimelineCommandResult<TimelineEditCommitResult>Commits a trim command.
validateEdit(command: TimelineEditCommand): TimelineEditValidationResultValidates a typed edit command without mutating timeline state.