Skip to content

Class: TimelineController

Defined in: src/temporal/TimelineController.ts:11

Playback state machine for temporal data.

Emits 'timechange' events with { time, frameA, frameB, alpha } on each animation frame. Knows nothing about layers or rendering — it is a pure time-source driven entirely by requestAnimationFrame.

Extends

Constructors

Constructor

ts
new TimelineController(times, options?): TimelineController;

Defined in: src/temporal/TimelineController.ts:21

Parameters

times

number[]

options?
speed?

number

loop?

LoopMode

autoPlay?

boolean

Returns

TimelineController

Overrides

EventEmitter.constructor

Methods

on()

ts
on(event, listener): UnsubscribeFn;

Defined in: src/EventEmitter.ts:12

Parameters

event

string

listener

EventListener

Returns

UnsubscribeFn

Inherited from

EventEmitter.on


once()

ts
once(event, listener): UnsubscribeFn;

Defined in: src/EventEmitter.ts:23

Parameters

event

string

listener

EventListener

Returns

UnsubscribeFn

Inherited from

EventEmitter.once


emit()

ts
emit(event, ...args): void;

Defined in: src/EventEmitter.ts:34

Parameters

event

string

args

...any[]

Returns

void

Inherited from

EventEmitter.emit


removeListener()

ts
removeListener(event, listenerToRemove): void;

Defined in: src/EventEmitter.ts:41

Parameters

event

string

listenerToRemove

EventListener

Returns

void

Inherited from

EventEmitter.removeListener


removeAllListeners()

ts
removeAllListeners(event?): void;

Defined in: src/EventEmitter.ts:52

Parameters

event?

string

Returns

void

Inherited from

EventEmitter.removeAllListeners


off()

ts
off(event, listener): void;

Defined in: src/EventEmitter.ts:61

Parameters

event

string

listener

EventListener

Returns

void

Inherited from

EventEmitter.off


play()

ts
play(): void;

Defined in: src/temporal/TimelineController.ts:45

Returns

void


pause()

ts
pause(): void;

Defined in: src/temporal/TimelineController.ts:53

Returns

void


stop()

ts
stop(): void;

Defined in: src/temporal/TimelineController.ts:63

Returns

void


toggle()

ts
toggle(): void;

Defined in: src/temporal/TimelineController.ts:71

Returns

void


seek()

ts
seek(time): void;

Defined in: src/temporal/TimelineController.ts:79

Parameters

time

number

Returns

void


setSpeed()

ts
setSpeed(multiplier): void;

Defined in: src/temporal/TimelineController.ts:86

Parameters

multiplier

number

Returns

void


setLoop()

ts
setLoop(mode): void;

Defined in: src/temporal/TimelineController.ts:90

Parameters

mode

LoopMode

Returns

void


getState()

ts
getState(): TimelineState;

Defined in: src/temporal/TimelineController.ts:97

Returns

TimelineState


toStateJSON()

ts
toStateJSON(): object;

Defined in: src/temporal/TimelineController.ts:225

Returns

object

currentTime
ts
currentTime: number;
speed
ts
speed: number;
loopMode
ts
loopMode: string;
playing
ts
playing: boolean;

fromStateJSON()

ts
fromStateJSON(state): void;

Defined in: src/temporal/TimelineController.ts:234

Parameters

state
currentTime?

number

speed?

number

loopMode?

string

playing?

boolean

Returns

void


dispose()

ts
dispose(): void;

Defined in: src/temporal/TimelineController.ts:242

Returns

void

Released under the MIT License.