Skip to main content

TimelineComponentProps

@fovea/annotation-tool


@fovea/annotation-tool / TimelineComponent / TimelineComponentProps

Interface: TimelineComponentProps

Defined in: src/components/annotation/TimelineComponent.tsx:27

TimelineComponentProps

Description

Props for TimelineComponent.

Properties

annotation

annotation: null | Annotation

Defined in: src/components/annotation/TimelineComponent.tsx:29

Annotation with boundingBoxSequence (optional - when null, controls are disabled)


currentFrame

currentFrame: number

Defined in: src/components/annotation/TimelineComponent.tsx:31

Current frame number


onAddKeyframe()

onAddKeyframe: () => void

Defined in: src/components/annotation/TimelineComponent.tsx:41

Callback to add keyframe at current frame

Returns

void


onClose()

onClose: () => void

Defined in: src/components/annotation/TimelineComponent.tsx:49

Callback to close/hide timeline

Returns

void


onCopyPreviousFrame()

onCopyPreviousFrame: () => void

Defined in: src/components/annotation/TimelineComponent.tsx:45

Callback to copy previous frame's box

Returns

void


onDeleteKeyframe()

onDeleteKeyframe: () => void

Defined in: src/components/annotation/TimelineComponent.tsx:43

Callback to delete keyframe at current frame

Returns

void


onSeek()

onSeek: (frameNumber) => void

Defined in: src/components/annotation/TimelineComponent.tsx:37

Callback when user seeks to a frame

Parameters

frameNumber

number

Returns

void


onUpdateInterpolationSegment()

onUpdateInterpolationSegment: (segmentIndex, type, controlPoints?) => void

Defined in: src/components/annotation/TimelineComponent.tsx:47

Callback when interpolation mode is changed

Parameters

segmentIndex

number

type

InterpolationType

controlPoints?

any

Returns

void


totalFrames

totalFrames: number

Defined in: src/components/annotation/TimelineComponent.tsx:33

Total frames in video


videoFps

videoFps: number

Defined in: src/components/annotation/TimelineComponent.tsx:35

Video frames per second


videoRef?

optional videoRef: RefObject<HTMLVideoElement>

Defined in: src/components/annotation/TimelineComponent.tsx:39

Optional video element ref for playback sync