Usage notes
The result combines settled keyframe lists, selection, and mutation commands. Use it for keyframe inspectors, property editors, and toolbar actions. For pointer-driven dragging, combine it with useTimelineKeyframeDrag; for Bezier easing handles, combine it with useTimelineKeyframeTangentDrag.
Signature
Interface UseTimelineKeyframesResultProperties
| Name | Signature | Description |
|---|---|---|
clearKeyframeSelection | (): TimelineCommandResult | Clears keyframe selection. |
copyKeyframes | (): TimelineKeyframeClipboard | Copies the current selection independently of clip copy/paste. |
createPasteCommand | (clipboard: TimelineKeyframeClipboard, time: RationalTime, clipId?: string): TimelineKeyframeEditCommand | Creates a paste command with preserved relative timing. |
getPropertyValueAtTime | (clipId: string, property: string, time?: RationalTime): number | undefined | Evaluates a keyframed property at a timeline time. |
keyframes | keyframes: TimelineKeyframe[] | Settled keyframes matching the clip, property, and selection filters. |
removeKeyframe | (clipId: string, keyframeId: string, options?: TimelineKeyframeMutationOptions): TimelineCommandResult<TimelineKeyframe> | Removes one keyframe from a clip. |
selectedKeyframes | selectedKeyframes: TimelineKeyframeReference[] | Selected keys across all clips. |
selectKeyframes | (references: typeOperator, mode?: "toggle" | "replace" | "add"): TimelineCommandResult | Selects keys without subscribing to live geometry. |
setKeyframe | (input: TimelineSetClipKeyframeOptions, options?: TimelineKeyframeMutationOptions): TimelineCommandResult<TimelineKeyframe> | Adds or updates one keyframe by clip, property, and exact timeline time. |
updateKeyframe | (input: TimelineUpdateClipKeyframeOptions, options?: TimelineKeyframeMutationOptions): TimelineCommandResult<TimelineKeyframe> | Updates one existing keyframe. |