Class DoOnTime

Hierarchy

EventEmitter<DoOnTimeEvents>
- DoOnTime

Constructors

constructor

new DoOnTime(getCurrentTime: (() => number), sendMode?: SendMode, options?: SlowReportOptions): DoOnTime
Parameters
- getCurrentTime: (() => number)
  - - (): number
    - Returns number
- sendMode: SendMode = SendMode.BURST
- Optional options: SlowReportOptions
Returns DoOnTime
Overrides EventEmitter<DoOnTimeEvents>.constructor
- Defined in packages/timeline-state-resolver/src/devices/doOnTime.ts:76

Properties

`Private` _checkQueueTimeout

_checkQueueTimeout: any = 0

`Private` _commandsToSendNow

_commandsToSendNow: {
[queueId: string]: (() => Promise<any>)[];
} = {}

Type declaration

[queueId: string]: (() => Promise<any>)[]

`Private` _i

_i: number = 0

`Private` _options

_options: SlowReportOptions

`Private` _queues

_queues: {
    [queueId: string]: {
        [id: string]: DoOrder;
    };
} = {}

Type declaration

[queueId: string]: {
[id: string]: DoOrder;
}
- [id: string]: DoOrder

`Private` _sendMode

_sendMode: SendMode

`Private` _sendingCommands

_sendingCommands: {
[queueId: string]: boolean;
} = {}

Type declaration

[queueId: string]: boolean

getCurrentTime

getCurrentTime: (() => number)

Type declaration

- (): number
- Returns number

Methods

`Private` _checkQueue

_checkQueue(): void
Returns void
- Defined in packages/timeline-state-resolver/src/devices/doOnTime.ts:156

`Private` _remove

_remove(queueId: string, id: string): void
Parameters
- queueId: string
- id: string
Returns void
- Defined in packages/timeline-state-resolver/src/devices/doOnTime.ts:153

`Private` _sendCommandReport

_sendCommandReport(o: DoOrder, send: number, queueId: string): void
Parameters
- o: DoOrder
- send: number
- queueId: string
Returns void
- Defined in packages/timeline-state-resolver/src/devices/doOnTime.ts:316

`Private` _sendNextCommand

_sendNextCommand(queueId: string): void
Parameters
- queueId: string
Returns void
- Defined in packages/timeline-state-resolver/src/devices/doOnTime.ts:201

`Private` _verifyFulfillCommand

_verifyFulfillCommand(o: DoOrder, send: number, queueId: string): void
Parameters
- o: DoOrder
- send: number
- queueId: string
Returns void
- Defined in packages/timeline-state-resolver/src/devices/doOnTime.ts:292

`Private` _verifySendCommand

_verifySendCommand(o: DoOrder, send: number, queueId: string): boolean
Parameters
- o: DoOrder
- send: number
- queueId: string
Returns boolean
- Defined in packages/timeline-state-resolver/src/devices/doOnTime.ts:256

addListener

addListener<T>(event: T, fn: ((...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]) => void), context?: any): DoOnTime
Type Parameters
- T extends keyof DoOnTimeEvents
Parameters
- event: T
- fn: ((...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]) => void)
  - - (...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]
      
      Returns void
- Optional context: any
Returns DoOnTime
Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

clearQueueAfter

clearQueueAfter(time: number): void
Parameters
- time: number
Returns void
- Defined in packages/timeline-state-resolver/src/devices/doOnTime.ts:128

clearQueueNowAndAfter

clearQueueNowAndAfter(time: number): number
Parameters
- time: number
Returns number
- Defined in packages/timeline-state-resolver/src/devices/doOnTime.ts:137

dispose

dispose(): void
Returns void
- Defined in packages/timeline-state-resolver/src/devices/doOnTime.ts:149

emit

emit<T>(event: T, ...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends keyof DoOnTimeEvents
Parameters
- event: T
- Rest ...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): (keyof DoOnTimeEvents)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (keyof DoOnTimeEvents)[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

getQueue

getQueue(): {
    args: any[];
    id: string;
    queueId: string;
    time: number;
}[]
Returns {
    args: any[];
    id: string;
    queueId: string;
    time: number;
}[]
- Defined in packages/timeline-state-resolver/src/devices/doOnTime.ts:112

listenerCount

listenerCount(event: keyof DoOnTimeEvents): number
Return the number of listeners listening to a given event.
Parameters
- event: keyof DoOnTimeEvents
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event: T): ((...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends keyof DoOnTimeEvents
Parameters
- event: T
Returns ((...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]) => void)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

off

off<T>(event: T, fn?: ((...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]) => void), context?: any, once?: boolean): DoOnTime
Type Parameters
- T extends keyof DoOnTimeEvents
Parameters
- event: T
- Optional fn: ((...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]) => void)
  - - (...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns DoOnTime
Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T>(event: T, fn: ((...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]) => void), context?: any): DoOnTime
Add a listener for a given event.
Type Parameters
- T extends keyof DoOnTimeEvents
Parameters
- event: T
- fn: ((...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]) => void)
  - - (...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]
      
      Returns void
- Optional context: any
Returns DoOnTime
Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:40

once

once<T>(event: T, fn: ((...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]) => void), context?: any): DoOnTime
Add a one-time listener for a given event.
Type Parameters
- T extends keyof DoOnTimeEvents
Parameters
- event: T
- fn: ((...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]) => void)
  - - (...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]
      
      Returns void
- Optional context: any
Returns DoOnTime
Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54

queue

queue(time: number, queueId: undefined | string, fcn: DoOrderFunctionNothing): string
Parameters
- time: number
- queueId: undefined | string
- fcn: DoOrderFunctionNothing
Returns string
- Defined in packages/timeline-state-resolver/src/devices/doOnTime.ts:82
queue<A>(time: number, queueId: undefined | string, fcn: DoOrderFunction0<A>, arg0: A): string
Type Parameters
- A
Parameters
- time: number
- queueId: undefined | string
- fcn: DoOrderFunction0<A>
- arg0: A
Returns string
- Defined in packages/timeline-state-resolver/src/devices/doOnTime.ts:83
queue<A, B>(time: number, queueId: undefined | string, fcn: DoOrderFunction1<A, B>, arg0: A, arg1: B): string
Type Parameters
- A
- B
Parameters
- time: number
- queueId: undefined | string
- fcn: DoOrderFunction1<A, B>
- arg0: A
- arg1: B
Returns string
- Defined in packages/timeline-state-resolver/src/devices/doOnTime.ts:84
queue<A, B, C>(time: number, queueId: undefined | string, fcn: DoOrderFunction2<A, B, C>, arg0: A, arg1: B, arg2: C): string
Type Parameters
- A
- B
- C
Parameters
- time: number
- queueId: undefined | string
- fcn: DoOrderFunction2<A, B, C>
- arg0: A
- arg1: B
- arg2: C
Returns string
- Defined in packages/timeline-state-resolver/src/devices/doOnTime.ts:85

removeAllListeners

removeAllListeners(event?: keyof DoOnTimeEvents): DoOnTime
Remove all listeners, or those of the specified event.
Parameters
- Optional event: keyof DoOnTimeEvents
Returns DoOnTime
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event: T, fn?: ((...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]) => void), context?: any, once?: boolean): DoOnTime
Remove the listeners of a given event.
Type Parameters
- T extends keyof DoOnTimeEvents
Parameters
- event: T
- Optional fn: ((...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]) => void)
  - - (...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns DoOnTime
Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

`Private` representArguments

representArguments(o: DoOrder): any
Parameters
- o: DoOrder
Returns any
- Defined in packages/timeline-state-resolver/src/devices/doOnTime.ts:249

Class DoOnTime

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

getCurrentTime: (() => number)

Returns number

sendMode: SendMode = SendMode.BURST

Optional options: SlowReportOptions

Returns DoOnTime

Properties

Private _checkQueueTimeout

Private _commandsToSendNow

Type declaration

[queueId: string]: (() => Promise<any>)[]

Private _i

Private _options

Private _queues

Type declaration

[queueId: string]: { [id: string]: DoOrder; }

[id: string]: DoOrder

Private _sendMode

Private _sendingCommands

Type declaration

[queueId: string]: boolean

getCurrentTime

Type declaration

Returns number

Methods

Private _checkQueue

Returns void

Private _remove

Parameters

queueId: string

id: string

Returns void

Private _sendCommandReport

Parameters

o: DoOrder

send: number

queueId: string

Returns void

Private _sendNextCommand

Parameters

queueId: string

Returns void

Private _verifyFulfillCommand

Parameters

o: DoOrder

send: number

queueId: string

Returns void

Private _verifySendCommand

Parameters

o: DoOrder

send: number

queueId: string

Returns boolean

addListener

Type Parameters

T extends keyof DoOnTimeEvents

Parameters

event: T

fn: ((...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]) => void)

Parameters

Rest ...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]

Returns void

Optional context: any

Returns DoOnTime

clearQueueAfter

Parameters

time: number

Returns void

clearQueueNowAndAfter

Parameters

time: number

`Optional` options: SlowReportOptions

`Private` _checkQueueTimeout

`Private` _commandsToSendNow

`Private` _i

`Private` _options

`Private` _queues

[queueId: string]: {
[id: string]: DoOrder;
}

`Private` _sendMode

`Private` _sendingCommands

`Private` _checkQueue

`Private` _remove

`Private` _sendCommandReport

`Private` _sendNextCommand

`Private` _verifyFulfillCommand

`Private` _verifySendCommand

`Rest` ...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]

`Optional` context: any

`Rest` ...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]

Returns {
args: any[];
id: string;
queueId: string;
time: number;
}[]

`Optional` fn: ((...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]) => void)

`Rest` ...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]

`Optional` context: any

`Optional` once: boolean

`Rest` ...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]

`Optional` context: any

`Rest` ...args: ArgumentMap<DoOnTimeEvents>[Extract<T, keyof DoOnTimeEvents>]

`Optional` context: any