@techsquidtv/canvas-timeline-utils

Options for parsing editable timecode text into `RationalTime`.

Stores a timeline time as integer ticks at a fixed rate.

Options for formatting a seconds value into editable timecode text.

Options for parsing editable timecode text into seconds.

Display shape used when formatting seconds for editable timecode text. `auto` keeps common decimal clock text unless a frame rate is provided. With a frame rate, `auto` formats frame timecode. `seconds`, `minutes`, and `hours` keep decimal centiseconds. `frames` formats `HH:MM:SS:FF`, and `drop-frame` formats `HH:MM:SS;FF`.

Frame rate accepted by frame-based timecode helpers. Pass a number for simple rates such as `24`, `25`, `30`, or `60`. Pass a rational object for exact fractional media rates such as `{ numerator: 30000, denominator: 1001 }`.

Rounding policy used when parsing editable timecode text. `none` preserves the decimal precision entered by the user, within normal JavaScript number limits. `centisecond` rounds the parsed seconds to two decimal places for legacy or display-like workflows.

Adds two rational timeline times.

Asserts that a value is a finite rational timeline time.

Restricts a number to an inclusive minimum and maximum range.

Compares two rational timeline times.

Formats a `RationalTime` as editable timecode text.

Formats a rational timeline time as decimal seconds.

Formats a rational timeline time as mm:ss.

Formats seconds for flexible editable timecode text. Decimal formats are rounded to centiseconds and clamped at zero. Non-finite values are treated as zero. Frame formats round to the nearest frame for the supplied frame rate.

Converts seconds to rational timeline time at the requested tick rate.

Converts a zero-based frame number to rational timeline time.

Returns the later of two rational timeline times.

Returns the earlier of two rational timeline times.

Parses flexible editable timecode text into seconds. Accepts plain seconds, decimal seconds, `m:ss`, `m:ss.cc`, `h:mm:ss`, `h:mm:ss.cc`, flexible single-digit colon segments such as `1:2`, and unit suffixes like `s` (seconds), `ms` (milliseconds), `m` (minutes), or `f` (frames, which requires a `frameRate` option). Invalid, negative, missing, or out-of-range user text returns `null`. Invalid developer options such as unsupported drop-frame rates throw `RangeError`.

Parses editable timecode text into `RationalTime`.

Checks whether two rational timeline times represent the same moment.

Resolves a frame-rate option to frames per second. This uses the same validation and normalization path as the timecode formatter/parser helpers, so invalid rates throw the same `RangeError`.

Rounds a number to the requested number of decimal places.

Subtracts one rational timeline time from another.

Converts a rational timeline time to seconds.

Converts a rational time to the nearest source frame number.