Canvas Timeline
Interface

TimelinePlayheadControlOptions

Options for adapting the timeline playhead to a scalar control.

Signature

Type Definition
Interface TimelinePlayheadControlOptions

Properties

NameSignatureDescription
label?label?: stringAccessible label for the playhead control.
max?max?: numberMaximum timeline time in seconds. Defaults to timeline duration/content end.
min?min?: numberMinimum timeline time in seconds. Defaults to 0.
onValueCommitted?(value: number[], eventDetails?: unknown): voidCalled after the hook applies a committed control value to the engine. When the underlying scalar control provides commit details, Canvas Timeline forwards them unchanged as the second argument and does not read their fields.
step?step?: numberSlider step in seconds for consumers using slider primitives.