Interface

UseTimelineKeyframesResult

Result returned by `useTimelineKeyframes`.

Signature

Type Definition
Interface UseTimelineKeyframesResult

Type parameters

NameConstraintDefaultDescription
TrackKindNonestringNo type parameter summary yet.

Properties

NameSignatureDescription
clearKeyframeSelection(): TimelineCommandResultClears keyframe selection.
getPropertyValueAtTime(clipId: string, property: "opacity", time?: RationalTime): number | undefinedEvaluates a keyframed property at a timeline time.
keyframeRectskeyframeRects: TimelineKeyframeRect<TrackKind>[]Viewport-space keyframe geometry in track order.
keyframeskeyframes: TimelineKeyframe[]Clip-scoped keyframes for `clipId`, or all keyframes from visible rects when no clip is scoped.
removeKeyframe(clipId: string, keyframeId: string, options?: TimelineKeyframeMutationOptions): TimelineCommandResult<TimelineKeyframe>Removes one keyframe from a clip.
selectKeyframe(clipId: string | null, keyframeId: string | null): TimelineCommandResultSelects one keyframe, or clears keyframe selection when ids are null.
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.
visibleKeyframesvisibleKeyframes: VisibleTimelineKeyframe<TrackKind>[]Viewport-intersecting keyframe geometry in track order.