Class QuantelDevice

This class is used to interface with a Quantel-gateway, https://github.com/nrkno/tv-automation-quantel-gateway

This device behaves a little bit different than the others, because a play-command is a two-step rocket. This is why the commands generated by the state-diff is not one-to-one related to the actual commands sent to the Quantel-gateway.

Hierarchy

DeviceWithState<QuantelState, DeviceOptionsQuantelInternal>
- QuantelDevice

Index

Constructors

constructor

new QuantelDevice(deviceId: string, deviceOptions: DeviceOptionsQuantelInternal, getCurrentTime: (() => Promise<number>)): QuantelDevice
Parameters
- deviceId: string
- deviceOptions: DeviceOptionsQuantelInternal
- getCurrentTime: (() => Promise<number>)
  - - (): Promise<number>
    - Returns Promise<number>
Returns QuantelDevice
Overrides DeviceWithState<QuantelState, DeviceOptionsQuantelInternal>.constructor
- Defined in packages/timeline-state-resolver/src/integrations/quantel/index.ts:69

Properties

`Private` _commandReceiver

_commandReceiver: CommandReceiver

`Protected` _deviceOptions

_deviceOptions: DeviceOptionsQuantelInternal

`Private` _disconnectedSince

_disconnectedSince: undefined | number = undefined

`Private` _doOnTime

_doOnTime: DoOnTime

`Private` _doOnTimeBurst

_doOnTimeBurst: DoOnTime

`Private` `Optional` _initOptions

_initOptions?: QuantelOptions

`Protected` _isActive

_isActive: boolean = true

`Private` _quantel

_quantel: QuantelGateway

`Private` _quantelManager

_quantelManager: QuantelManager

`Protected` _reportAllCommands

_reportAllCommands: boolean = false

useDirectTime

useDirectTime: boolean = false

Accessors

canConnect

get canConnect(): boolean
Returns boolean
Overrides DeviceWithState.canConnect
- Defined in packages/timeline-state-resolver/src/integrations/quantel/index.ts:231

connected

get connected(): boolean
Returns boolean
Overrides DeviceWithState.connected
- Defined in packages/timeline-state-resolver/src/integrations/quantel/index.ts:234

deviceId

get deviceId(): string
Returns string
Inherited from DeviceWithState.deviceId
- Defined in packages/timeline-state-resolver/src/devices/device.ts:236

deviceName

get deviceName(): string
Returns string
Overrides DeviceWithState.deviceName
- Defined in packages/timeline-state-resolver/src/integrations/quantel/index.ts:241

deviceOptions

get deviceOptions(): TOptions
Returns TOptions
Inherited from DeviceWithState.deviceOptions
- Defined in packages/timeline-state-resolver/src/devices/device.ts:244

deviceType

get deviceType(): DeviceType
Returns DeviceType
Overrides DeviceWithState.deviceType
- Defined in packages/timeline-state-resolver/src/integrations/quantel/index.ts:238

instanceId

get instanceId(): number
Returns number
Inherited from DeviceWithState.instanceId
- Defined in packages/timeline-state-resolver/src/devices/device.ts:282

isActive

get isActive(): boolean
Returns boolean
Inherited from DeviceWithState.isActive
- Defined in packages/timeline-state-resolver/src/devices/device.ts:254

queue

get queue(): {
    args: any[];
    id: string;
    queueId: string;
    time: number;
}[]
Returns {
    args: any[];
    id: string;
    queueId: string;
    time: number;
}[]
- Defined in packages/timeline-state-resolver/src/integrations/quantel/index.ts:249

startTime

get startTime(): number
Returns number
Inherited from DeviceWithState.startTime
- Defined in packages/timeline-state-resolver/src/devices/device.ts:285

supportsExpectedPlayoutItems

get supportsExpectedPlayoutItems(): boolean
Returns boolean
Inherited from DeviceWithState.supportsExpectedPlayoutItems
- Defined in packages/timeline-state-resolver/src/devices/device.ts:247

Methods

`Private` _addToQueue

_addToQueue(commandsToAchieveState: QuantelCommand[]): void
Add commands to queue, to be executed at the right time
Parameters
- commandsToAchieveState: QuantelCommand[]
Returns void
- Defined in packages/timeline-state-resolver/src/integrations/quantel/index.ts:615

`Private` _connectionChanged

_connectionChanged(): void
Returns void
- Defined in packages/timeline-state-resolver/src/integrations/quantel/index.ts:687

`Private` _defaultCommandReceiver

_defaultCommandReceiver(_time: number, cmd: QuantelCommand, context: string, timelineObjId: string): Promise<any>
Sends commands to the Quantel ISA server
Parameters
- _time: number
- cmd: QuantelCommand
  
  Command to execute
- context: string
- timelineObjId: string
Returns Promise<any>
- Defined in packages/timeline-state-resolver/src/integrations/quantel/index.ts:647

`Private` _diffStates

_diffStates(oldState: QuantelState, newState: QuantelState, time: number): QuantelCommand[]
Compares the new timeline-state with the old one, and generates commands to account for the difference
Parameters
- oldState: QuantelState
- newState: QuantelState
- time: number
Returns QuantelCommand[]
- Defined in packages/timeline-state-resolver/src/integrations/quantel/index.ts:412

`Private` _doCommand

_doCommand(command: QuantelCommand, context: string, timlineObjId: string): Promise<void>
Parameters
- command: QuantelCommand
- context: string
- timlineObjId: string
Returns Promise<void>
- Defined in packages/timeline-state-resolver/src/integrations/quantel/index.ts:608

`Private` _getMappedPorts

_getMappedPorts(mappings: Mappings<unknown>): MappedPorts
Parameters
- mappings: Mappings<unknown>
Returns MappedPorts
- Defined in packages/timeline-state-resolver/src/integrations/quantel/index.ts:252

addListener

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

`Protected` cleanUpStates

cleanUpStates(removeBeforeTime: number, removeAfterTime: number): void
Sets a windows outside of which all states will be removed.
Parameters
- removeBeforeTime: number
- removeAfterTime: number
Returns void
Inherited from DeviceWithState.cleanUpStates
- Defined in packages/timeline-state-resolver/src/devices/device.ts:422

clearFuture

clearFuture(clearAfterTime: number): void
Clear any scheduled commands after this time
Parameters
- clearAfterTime: number
Returns void
Overrides DeviceWithState.clearFuture
- Defined in packages/timeline-state-resolver/src/integrations/quantel/index.ts:228

`Protected` clearStates

clearStates(): void
Removes all states

Returns void
Inherited from DeviceWithState.clearStates
- Defined in packages/timeline-state-resolver/src/devices/device.ts:437

convertStateToQuantel

convertStateToQuantel(timelineState: Timeline.TimelineState<TSRTimelineContent>, mappings: Mappings<unknown>): QuantelState
Takes a timeline state and returns a Quantel State that will work with the state lib.
Parameters
- timelineState: Timeline.TimelineState<TSRTimelineContent>
  
  The timeline state to generate from.
- mappings: Mappings<unknown>
Returns QuantelState
- Defined in packages/timeline-state-resolver/src/integrations/quantel/index.ts:284

emit

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

`Protected` emitDebug

emitDebug(...args: any[]): void
Parameters
- Rest ...args: any[]
Returns void
Inherited from DeviceWithState.emitDebug
- Defined in packages/timeline-state-resolver/src/devices/device.ts:220

`Protected` emitDebugState

emitDebugState(state: object): void
Parameters
- state: object
Returns void
Inherited from DeviceWithState.emitDebugState
- Defined in packages/timeline-state-resolver/src/devices/device.ts:230

eventNames

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

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

executeAction

executeAction(actionId: string, _payload?: Record<string, any>): Promise<ActionExecutionResult<undefined>>
Parameters
- actionId: string
- Optional _payload: Record<string, any>
Returns Promise<ActionExecutionResult<undefined>>
Overrides DeviceWithState.executeAction
- Defined in packages/timeline-state-resolver/src/integrations/quantel/index.ts:207

getCurrentTime

getCurrentTime(): number
Returns number
Inherited from DeviceWithState.getCurrentTime
- Defined in packages/timeline-state-resolver/src/devices/device.ts:166

`Protected` getState

getState(time?: number): null | {
state: QuantelState;
time: number;
}
Get the last known state at a point in time. Useful for creating device diffs.

Todo
is this literally the same as "getStateBefore(time + 1)"?
Parameters
- Optional time: number
Returns null | {
state: QuantelState;
time: number;
}
Inherited from DeviceWithState.getState
- Defined in packages/timeline-state-resolver/src/devices/device.ts:373

`Protected` getStateBefore

getStateBefore(time: number): null | {
state: QuantelState;
time: number;
}
Get the last known state before a point time. Useful for creating device diffs.
Parameters
- time: number
Returns null | {
state: QuantelState;
time: number;
}
Inherited from DeviceWithState.getStateBefore
- Defined in packages/timeline-state-resolver/src/devices/device.ts:347

getStatus

getStatus(): DeviceStatus
Returns DeviceStatus
Overrides DeviceWithState.getStatus
- Defined in packages/timeline-state-resolver/src/integrations/quantel/index.ts:383

`Protected` handleDoOnTime

handleDoOnTime(doOnTime: DoOnTime, deviceType: string): void
Parameters
- doOnTime: DoOnTime
- deviceType: string
Returns void
Inherited from DeviceWithState.handleDoOnTime
- Defined in packages/timeline-state-resolver/src/devices/device.ts:288

handleExpectedPlayoutItems

handleExpectedPlayoutItems(_expectedPlayoutItems: ExpectedPlayoutItem[]): void
Parameters
- _expectedPlayoutItems: ExpectedPlayoutItem[]
Returns void
Inherited from DeviceWithState.handleExpectedPlayoutItems
- Defined in packages/timeline-state-resolver/src/devices/device.ts:250

handleState

handleState(newState: Timeline.TimelineState<TSRTimelineContent>, newMappings: Mappings<unknown>): void
Generates an array of Quantel commands by comparing the newState against the oldState, or the current device state.
Parameters
- newState: Timeline.TimelineState<TSRTimelineContent>
- newMappings: Mappings<unknown>
Returns void
Overrides DeviceWithState.handleState
- Defined in packages/timeline-state-resolver/src/integrations/quantel/index.ts:163

init

init(initOptions: QuantelOptions): Promise<boolean>
Parameters
- initOptions: QuantelOptions
Returns Promise<boolean>
Overrides DeviceWithState.init
- Defined in packages/timeline-state-resolver/src/integrations/quantel/index.ts:109

listenerCount

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

listeners

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

makeReady

makeReady(okToDestroyStuff?: boolean): Promise<void>
Prepares the physical device for playout.
Parameters
- Optional okToDestroyStuff: boolean
  
  Whether it is OK to do things that affects playout visibly
Returns Promise<void>
Overrides DeviceWithState.makeReady
- Defined in packages/timeline-state-resolver/src/integrations/quantel/index.ts:373

off

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

on

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

`Protected` onHandleState

onHandleState(_newState: Timeline.TimelineState<TSRTimelineContent>, mappings: Mappings<unknown>): void
To be called by children first in .handleState
Parameters
- _newState: Timeline.TimelineState<TSRTimelineContent>
- mappings: Mappings<unknown>
Returns void
Inherited from DeviceWithState.onHandleState
- Defined in packages/timeline-state-resolver/src/devices/device.ts:184

once

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

prepareForHandleState

prepareForHandleState(newStateTime: number): void
Called by the Conductor a bit before a .handleState is called
Parameters
- newStateTime: number
Returns void
Overrides DeviceWithState.prepareForHandleState
- Defined in packages/timeline-state-resolver/src/integrations/quantel/index.ts:155

removeAllListeners

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

removeListener

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

`Private` restartGateway

restartGateway(): Promise<void>
Attempts to restart the gateway

Returns Promise<void>
- Defined in packages/timeline-state-resolver/src/integrations/quantel/index.ts:200

setDebugLogging

setDebugLogging(debug: boolean): void
Parameters
- debug: boolean
Returns void
Inherited from DeviceWithState.setDebugLogging
- Defined in packages/timeline-state-resolver/src/devices/device.ts:216

setDebugState

setDebugState(debug: boolean): void
Parameters
- debug: boolean
Returns void
Inherited from DeviceWithState.setDebugState
- Defined in packages/timeline-state-resolver/src/devices/device.ts:226

`Protected` setState

setState(state: QuantelState, time: number): void
Saves a state on a certain time point. Overwrites any previous state saved at the same time. Removes any state after this time point.
Parameters
- state: QuantelState
- time: number
Returns void
Inherited from DeviceWithState.setState
- Defined in packages/timeline-state-resolver/src/devices/device.ts:400

standDown

standDown(_okToDestroyStuff?: boolean): Promise<void>
The standDown event could be triggered at a time after broadcast The exact implementation differ between different devices
Parameters
- Optional _okToDestroyStuff: boolean
Returns Promise<void>
Inherited from DeviceWithState.standDown
- Defined in packages/timeline-state-resolver/src/devices/device.ts:210

terminate

terminate(): Promise<void>
Terminates the device safely such that things can be garbage collected.

Returns Promise<void>
Overrides DeviceWithState.terminate
- Defined in packages/timeline-state-resolver/src/integrations/quantel/index.ts:150

Class QuantelDevice

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

deviceId: string

deviceOptions: DeviceOptionsQuantelInternal

getCurrentTime: (() => Promise<number>)

Returns Promise<number>

Returns QuantelDevice

Properties

Private _commandReceiver

Protected _deviceOptions

Private _disconnectedSince

Private _doOnTime

Private _doOnTimeBurst

Private Optional _initOptions

Protected _isActive

Private _quantel

Private _quantelManager

Protected _reportAllCommands

useDirectTime

Accessors

canConnect

Returns boolean

connected

Returns boolean

deviceId

Returns string

deviceName

Returns string

deviceOptions

Returns TOptions

deviceType

Returns DeviceType

instanceId

Returns number

isActive

Returns boolean

queue

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

startTime

Returns number

supportsExpectedPlayoutItems

Returns boolean

Methods

Private _addToQueue

Parameters

commandsToAchieveState: QuantelCommand[]

Returns void

Private _connectionChanged

Returns void

Private _defaultCommandReceiver

Parameters

_time: number

cmd: QuantelCommand

context: string

timelineObjId: string

Returns Promise<any>

Private _diffStates

Parameters

oldState: QuantelState

newState: QuantelState

time: number

Returns QuantelCommand[]

Private _doCommand

Parameters

command: QuantelCommand

context: string

timlineObjId: string

Returns Promise<void>

Private _getMappedPorts

Parameters

mappings: Mappings<unknown>

Returns MappedPorts

`Private` _commandReceiver

`Protected` _deviceOptions

`Private` _disconnectedSince

`Private` _doOnTime

`Private` _doOnTimeBurst

`Private` `Optional` _initOptions

`Protected` _isActive

`Private` _quantel

`Private` _quantelManager

`Protected` _reportAllCommands

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

`Private` _addToQueue

`Private` _connectionChanged

`Private` _defaultCommandReceiver

`Private` _diffStates

`Private` _doCommand

`Private` _getMappedPorts

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

`Optional` context: any

`Protected` cleanUpStates

`Protected` clearStates

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

`Protected` emitDebug

`Rest` ...args: any[]

`Protected` emitDebugState

`Optional` _payload: Record<string, any>

`Protected` getState

`Optional` time: number

Returns null | {
state: QuantelState;
time: number;
}

`Protected` getStateBefore

Returns null | {
state: QuantelState;
time: number;
}

`Protected` handleDoOnTime