Canvas Timeline
Interface

TimecodeFormatOptions

Options for formatting a seconds value into editable timecode text.

Signature

Type Definition
Interface TimecodeFormatOptions

Properties

NameSignatureDescription
dropFrame?dropFrame?: booleanFormats frame timecode with drop-frame numbering. Drop-frame is supported only for 29.97/59.94-style rates. Invalid developer options throw a `RangeError`.
format?format?: TimecodeFormatPreferred output shape. Defaults to `auto`. Use `frames` or `drop-frame` with `frameRate` for frame-based media production timecode.
frameRate?frameRate?: TimecodeFrameRateFrame rate used for frame-based formatting. When provided with `format: 'auto'`, output uses `HH:MM:SS:FF` unless `dropFrame` is true.