Class: TimelineController

Defined in: temporal/TimelineController.ts:21

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

• EventEmitter<TimelineEventMap>

Constructors

Constructor

new TimelineController(times, options?): TimelineController;

Defined in: temporal/TimelineController.ts:34

Parameters

times

number[]

options?

speed?

number

loop?

LoopMode

autoPlay?

boolean

Returns

TimelineController

Overrides

EventEmitter.constructor

Methods

on()

on<K>(event, listener): UnsubscribeFn;

Defined in: EventEmitter.ts:18

Type Parameters

K

K extends keyof TimelineEventMap

Parameters

event

K

listener

TypedEventListener<TimelineEventMap[K]>

Returns

UnsubscribeFn

Inherited from

EventEmitter.on

---

once()

once<K>(event, listener): UnsubscribeFn;

Defined in: EventEmitter.ts:30

Type Parameters

K

K extends keyof TimelineEventMap

Parameters

event

K

listener

TypedEventListener<TimelineEventMap[K]>

Returns

UnsubscribeFn

Inherited from

EventEmitter.once

---

emit()

emit<K>(event, ...args): void;

Defined in: EventEmitter.ts:41

Type Parameters

K

K extends keyof TimelineEventMap

Parameters

event

K

args

...EventPayloadArgs<TimelineEventMap[K]>

Returns

void

Inherited from

EventEmitter.emit

---

removeListener()

removeListener<K>(event, listenerToRemove): void;

Defined in: EventEmitter.ts:60

Type Parameters

K

K extends keyof TimelineEventMap

Parameters

event

K

listenerToRemove

TypedEventListener<TimelineEventMap[K]>

Returns

void

Inherited from

EventEmitter.removeListener

---

removeAllListeners()

removeAllListeners(event?): void;

Defined in: EventEmitter.ts:75

Parameters

event?

keyof TimelineEventMap

Returns

void

Inherited from

EventEmitter.removeAllListeners

---

off()

off<K>(event, listener): void;

Defined in: EventEmitter.ts:84

Type Parameters

K

K extends keyof TimelineEventMap

Parameters

event

K

listener

TypedEventListener<TimelineEventMap[K]>

Returns

void

Inherited from

EventEmitter.off

---

play()

play(): void;

Defined in: temporal/TimelineController.ts:70

Returns

void

---

pause()

pause(): void;

Defined in: temporal/TimelineController.ts:78

Returns

void

---

stop()

stop(): void;

Defined in: temporal/TimelineController.ts:88

Returns

void

---

toggle()

toggle(): void;

Defined in: temporal/TimelineController.ts:96

Returns

void

---

seek()

seek(time): void;

Defined in: temporal/TimelineController.ts:104

Parameters

time

number

Returns

void

---

setSpeed()

setSpeed(multiplier): void;

Defined in: temporal/TimelineController.ts:110

Parameters

multiplier

number

Returns

void

---

setLoop()

setLoop(mode): void;

Defined in: temporal/TimelineController.ts:120

Parameters

mode

LoopMode

Returns

void

---

getState()

getState(): TimelineState;

Defined in: temporal/TimelineController.ts:130

Returns

TimelineState

---

toStateJSON()

toStateJSON(): object;

Defined in: temporal/TimelineController.ts:269

Returns

object

currentTime

currentTime: number;

speed

speed: number;

loopMode

loopMode: string;

playing

playing: boolean;

---

fromStateJSON()

fromStateJSON(state): void;

Defined in: temporal/TimelineController.ts:278

Parameters

state

currentTime?

number

speed?

number

loopMode?

string

playing?

boolean

Returns

void

---

dispose()

dispose(): void;

Defined in: temporal/TimelineController.ts:295

Returns

void