Private
_actionPrivate
_callbackPrivate
_datastorePrivate
_devicePrivate
_doPrivate
_estimatePrivate
Optional
_getPrivate
_intervalPrivate
_isPrivate
_logPrivate
_mappingsPrivate
_multiPrivate
_nextPrivate
_optionsPrivate
_resolvePrivate
_resolvedTimestamp, when the timeline was resolved
Timestamp, when the timeline needs to be re-resolved
Private
_resolverPrivate
_sentPrivate
_statPrivate
_statPrivate
_statPrivate
_timelinePrivate
_timelinePrivate
_timelinePrivate
_triggerPrivate
_usePrivate
activationPrivate
devicesReturns the current timeline
Private
_diffPrivate
_mapPrivate
_queuePrivate
_resolvePrivate
_resolvePrivate
_sendPrivate
_setPrivate
_triggerPrivate
_triggerAdds a device that can be referenced by the timeline and mappings. NOTE: use this with caution! if a device fails to initialise (i.e. because the hardware is turned off) this may never resolve. It is preferred to use createDevice and initDevice separately for this reason.
A promise that resolves with the created device, or rejects with an error message.
Id used by the mappings to reference the device.
The options used to initalize the device
Optional
activeRundownPlaylistId: stringRest
...args: ArgumentMap<ConductorEvents>[Extract<T, keyof ConductorEvents>]Optional
context: anyCreates an uninitialised device that can be referenced by the timeline and mappings.
A promise that resolves with the created device, or rejects with an error message.
Id used by the mappings to reference the device.
The options used to initalize the device
Optional
options: { Additional options
Optional
signal?: AbortSignalPrivate
createCalls each of the listeners registered for a given event.
Rest
...args: ArgumentMap<ConductorEvents>[Extract<T, keyof ConductorEvents>]Private
emitOnly emits the event when there is an active rundownPlaylist. This is used to reduce unnesessary logging
Rest
...args: any[]Return an array listing the events for which the emitter has registered listeners.
Private
filterSplit the state into substates that are relevant for each device
Private
getInitialises an existing device that can be referenced by the timeline and mappings.
A promise that resolves with the initialised device, or rejects with an error message.
Id used by the mappings to reference the device.
The options used to initalize the device
Optional
activeRundownPlaylistId: stringId of the current rundown playlist
Optional
options: { Additional options
Optional
signal?: AbortSignalReturn the number of listeners listening to a given event.
Return the listeners registered for a given event.
Optional
fn: ((...args: ArgumentMap<ConductorEvents>[Extract<T, keyof ConductorEvents>]) => void)Rest
...args: ArgumentMap<ConductorEvents>[Extract<T, keyof ConductorEvents>]Optional
context: anyOptional
once: booleanAdd a listener for a given event.
Rest
...args: ArgumentMap<ConductorEvents>[Extract<T, keyof ConductorEvents>]Optional
context: anyAdd a one-time listener for a given event.
Rest
...args: ArgumentMap<ConductorEvents>[Extract<T, keyof ConductorEvents>]Optional
context: anyRemove all listeners, or those of the specified event.
Optional
event: keyof ConductorEventsRemove the listeners of a given event.
Optional
fn: ((...args: ArgumentMap<ConductorEvents>[Extract<T, keyof ConductorEvents>]) => void)Rest
...args: ArgumentMap<ConductorEvents>[Extract<T, keyof ConductorEvents>]Optional
context: anyOptional
once: booleanSets a new timeline and resets the resolver.
Optional
mappings: Mappings<unknown>Private
statPrivate
statPrivate
terminatePrivate
throwStatic
calculateGenerated using TypeDoc
The Conductor class serves as the main class for interacting. It contains methods for setting mappings, timelines and adding/removing devices. It keeps track of when to resolve the timeline and updates the devices with new states.