Class Device<TOptions>`Abstract`

Base class for all Devices to inherit from. Defines the API that the conductor class will use.

Type Parameters

TOptions extends DeviceOptionsBase<any>

Hierarchy

EventEmitter<DeviceEvents>
- Device

Implements

IDevice<TOptions>

Constructors

constructor

new Device<TOptions>(deviceId: string, deviceOptions: TOptions, getCurrentTime: (() => Promise<number>)): Device<TOptions>
Type Parameters
- TOptions extends DeviceOptionsBase<any, TOptions>
Parameters
- deviceId: string
- deviceOptions: TOptions
- getCurrentTime: (() => Promise<number>)
  - - (): Promise<number>
    - Returns Promise<number>
Returns Device<TOptions>
Overrides EventEmitter<DeviceEvents>.constructor
- Defined in packages/timeline-state-resolver/src/devices/device.ts:127

Properties

`Private` _currentTimeDiff

_currentTimeDiff: number = 0

`Private` _currentTimeUpdated

_currentTimeUpdated: number = 0

`Private` _deviceId

_deviceId: string

`Protected` _deviceOptions

_deviceOptions: TOptions

`Private` _getCurrentTime

_getCurrentTime: undefined | (() => number | Promise<number>)

`Private` _instanceId

_instanceId: number

`Protected` _isActive

_isActive: boolean = true

`Protected` _reportAllCommands

_reportAllCommands: boolean = false

`Private` _startTime

_startTime: number

`Private` debugLogging

debugLogging: boolean

`Private` debugState

debugState: boolean

useDirectTime

useDirectTime: boolean = false

Accessors

`Abstract` canConnect

get canConnect(): boolean
Returns boolean
Implementation of IDevice.canConnect
- Defined in packages/timeline-state-resolver/src/devices/device.ts:192

`Abstract` connected

get connected(): boolean
Returns boolean
Implementation of IDevice.connected
- Defined in packages/timeline-state-resolver/src/devices/device.ts:193

deviceId

get deviceId(): string
Returns string
Implementation of IDevice.deviceId
- Defined in packages/timeline-state-resolver/src/devices/device.ts:236

`Abstract` deviceName

get deviceName(): string
A human-readable name for this device

Returns string
Implementation of IDevice.deviceName
- Defined in packages/timeline-state-resolver/src/devices/device.ts:242

deviceOptions

get deviceOptions(): TOptions
Returns TOptions
Implementation of IDevice.deviceOptions
- Defined in packages/timeline-state-resolver/src/devices/device.ts:244

`Abstract` deviceType

get deviceType(): DeviceType
Returns DeviceType
Implementation of IDevice.deviceType
- Defined in packages/timeline-state-resolver/src/devices/device.ts:243

instanceId

get instanceId(): number
Returns number
Implementation of IDevice.instanceId
- Defined in packages/timeline-state-resolver/src/devices/device.ts:282

isActive

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

startTime

get startTime(): number
Returns number
Implementation of IDevice.startTime
- Defined in packages/timeline-state-resolver/src/devices/device.ts:285

supportsExpectedPlayoutItems

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

Methods

`Private` _updateCurrentTime

_updateCurrentTime(): void
Returns void
- Defined in packages/timeline-state-resolver/src/devices/device.ts:265

addListener

addListener<T>(event: T, fn: ((...args: ArgumentMap<DeviceEvents>[Extract<T, keyof DeviceEvents>]) => void), context?: any): Device<TOptions>
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 Device<TOptions>
Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

`Abstract` clearFuture

clearFuture(clearAfterTime: number): void
Clear any scheduled commands after this time
Parameters
- clearAfterTime: number
Returns void
Implementation of IDevice.clearFuture
- Defined in packages/timeline-state-resolver/src/devices/device.ts:191

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 EventEmitter.emit
- Defined in node_modules/eventemitter3/index.d.ts:32

`Protected` emitDebug

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

`Protected` emitDebugState

emitDebugState(state: object): void
Parameters
- state: object
Returns void
- 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 EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

executeAction

executeAction(_actionId: string, _payload?: Record<string, any>): Promise<ActionExecutionResult<any>>
Parameters
- _actionId: string
- Optional _payload: Record<string, any>
Returns Promise<ActionExecutionResult<any>>
- Defined in packages/timeline-state-resolver/src/devices/device.ts:258

getCurrentTime

getCurrentTime(): number
Returns number
Implementation of IDevice.getCurrentTime
- Defined in packages/timeline-state-resolver/src/devices/device.ts:166

`Abstract` getStatus

getStatus(): DeviceStatus
Returns DeviceStatus
Implementation of IDevice.getStatus
- Defined in packages/timeline-state-resolver/src/devices/device.ts:214

`Protected` handleDoOnTime

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

handleExpectedPlayoutItems

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

`Abstract` handleState

handleState(newState: Timeline.TimelineState<TSRTimelineContent>, mappings: Mappings<unknown>): void
Called from Conductor when a new state is to be handled
Parameters
- newState: Timeline.TimelineState<TSRTimelineContent>
- mappings: Mappings<unknown>
Returns void
Implementation of IDevice.handleState
- Defined in packages/timeline-state-resolver/src/devices/device.ts:181

`Abstract` init

init(initOptions: TOptions["options"], activeRundownPlaylistId?: string): Promise<boolean>
Connect to the device, resolve the promise when ready.
Parameters
- initOptions: TOptions["options"]
  
  Device-specific options
- Optional activeRundownPlaylistId: string
  
  ID of active rundown playlist
Returns Promise<boolean>
Implementation of IDevice.init
- Defined in packages/timeline-state-resolver/src/devices/device.ts:163

listenerCount

listenerCount(event: keyof DeviceEvents): number
Return the number of listeners listening to a given event.
Parameters
- event: keyof DeviceEvents
Returns number
Inherited from EventEmitter.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 EventEmitter.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

makeReady

makeReady(_okToDestroyStuff?: boolean, _activeRundownId?: string): Promise<void>
The makeReady method could be triggered at a time before broadcast Whenever we know that the user want's to make sure things are ready for broadcast The exact implementation differ between different devices
Parameters
- Optional _okToDestroyStuff: boolean
- Optional _activeRundownId: string
Returns Promise<void>
Implementation of IDevice.makeReady
- Defined in packages/timeline-state-resolver/src/devices/device.ts:201

off

off<T>(event: T, fn?: ((...args: ArgumentMap<DeviceEvents>[Extract<T, keyof DeviceEvents>]) => void), context?: any, once?: boolean): Device<TOptions>
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 Device<TOptions>
Inherited from EventEmitter.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): Device<TOptions>
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 Device<TOptions>
Inherited from EventEmitter.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
- 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): Device<TOptions>
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 Device<TOptions>
Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54

`Abstract` prepareForHandleState

prepareForHandleState(newStateTime: number): void
Called from Conductor when a new state is about to be handled soon
Parameters
- newStateTime: number
Returns void
Implementation of IDevice.prepareForHandleState
- Defined in packages/timeline-state-resolver/src/devices/device.ts:179

removeAllListeners

removeAllListeners(event?: keyof DeviceEvents): Device<TOptions>
Remove all listeners, or those of the specified event.
Parameters
- Optional event: keyof DeviceEvents
Returns Device<TOptions>
Inherited from EventEmitter.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): Device<TOptions>
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 Device<TOptions>
Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

setDebugLogging

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

setDebugState

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

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>
Implementation of IDevice.standDown
- Defined in packages/timeline-state-resolver/src/devices/device.ts:210

`Abstract` terminate

terminate(): Promise<void>
Returns Promise<void>
- Defined in packages/timeline-state-resolver/src/devices/device.ts:164

`Private` updateIsActive

updateIsActive(mappings: Mappings<unknown>): void
Parameters
- mappings: Mappings<unknown>
Returns void
- Defined in packages/timeline-state-resolver/src/devices/device.ts:317

Class Device<TOptions>Abstract

Type Parameters

TOptions extends DeviceOptionsBase<any>

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

TOptions extends DeviceOptionsBase<any, TOptions>

Parameters

deviceId: string

deviceOptions: TOptions

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

Returns Promise<number>

Returns Device<TOptions>

Properties

Private _currentTimeDiff

Private _currentTimeUpdated

Private _deviceId

Protected _deviceOptions

Private _getCurrentTime

Private _instanceId

Protected _isActive

Protected _reportAllCommands

Private _startTime

Private debugLogging

Private debugState

useDirectTime

Accessors

Abstract canConnect

Returns boolean

Abstract connected

Returns boolean

deviceId

Returns string

Abstract deviceName

Returns string

deviceOptions

Returns TOptions

Abstract deviceType

Returns DeviceType

instanceId

Returns number

isActive

Returns boolean

startTime

Returns number

supportsExpectedPlayoutItems

Returns boolean

Methods

Private _updateCurrentTime

Returns void

addListener

Type Parameters

T extends keyof DeviceEvents

Parameters

event: T

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

Parameters

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

Returns void

Optional context: any

Returns Device<TOptions>

Abstract clearFuture

Parameters

clearAfterTime: number

Returns void

emit

Type Parameters

T extends keyof DeviceEvents

Parameters

event: T

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

Returns boolean

Protected emitDebug

Class Device<TOptions>`Abstract`

`Private` _currentTimeDiff

`Private` _currentTimeUpdated

`Private` _deviceId

`Protected` _deviceOptions

`Private` _getCurrentTime

`Private` _instanceId

`Protected` _isActive

`Protected` _reportAllCommands

`Private` _startTime

`Private` debugLogging

`Private` debugState

`Abstract` canConnect

`Abstract` connected

`Abstract` deviceName

`Abstract` deviceType

`Private` _updateCurrentTime

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

`Optional` context: any

`Abstract` clearFuture

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

`Protected` emitDebug

`Rest` ...args: any[]

`Protected` emitDebugState

`Optional` _payload: Record<string, any>

`Abstract` getStatus

`Protected` handleDoOnTime

`Abstract` handleState

`Abstract` init

`Optional` activeRundownPlaylistId: string

`Optional` _okToDestroyStuff: boolean

`Optional` _activeRundownId: string

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

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

`Optional` context: any

`Optional` once: boolean