Class DeviceContainer<TOptions>

A device container is a wrapper around a device in ThreadedClass class, it keeps a local property of some basic information about the device (like names and id's) to prevent a costly round trip over IPC.

Type Parameters

TOptions extends DeviceOptionsBase<any>

Hierarchy

BaseRemoteDeviceIntegration<TOptions>
- DeviceContainer

Index

Constructors

`Private` constructor

new DeviceContainer<TOptions>(device: Promisify<Device<TOptions>>, deviceOptions: TOptions, threadConfig: undefined | ThreadedClassConfig): DeviceContainer<TOptions>
Type Parameters
- TOptions extends DeviceOptionsBase<any, TOptions>
Parameters
- device: Promisify<Device<TOptions>>
- deviceOptions: TOptions
- threadConfig: undefined | ThreadedClassConfig
Returns DeviceContainer<TOptions>
Overrides BaseRemoteDeviceIntegration<TOptions>.constructor
- Defined in packages/timeline-state-resolver/src/devices/deviceContainer.ts:17

Properties

`Protected` _details

_details: DeviceDetails = ...

`Protected` `Readonly` _device

_device: Promisify<Device<TOptions>>

`Protected` _initialized

_initialized: boolean = false

`Protected` _onEventListeners

_onEventListeners: {
stop: (() => void);
}[] = []

onChildClose

onChildClose: undefined | (() => void)

Accessors

debugLogging

get debugLogging(): boolean
Returns boolean
Inherited from BaseRemoteDeviceIntegration.debugLogging
- Defined in packages/timeline-state-resolver/src/service/remoteDeviceInstance.ts:89

debugState

get debugState(): boolean
Returns boolean
Inherited from BaseRemoteDeviceIntegration.debugState
- Defined in packages/timeline-state-resolver/src/service/remoteDeviceInstance.ts:93

details

get details(): DeviceDetails
Returns DeviceDetails
Inherited from BaseRemoteDeviceIntegration.details
- Defined in packages/timeline-state-resolver/src/service/remoteDeviceInstance.ts:97

device

get device(): Promisify<DeviceInstanceWrapper> | Promisify<Device<TOptions>>
Returns Promisify<DeviceInstanceWrapper> | Promisify<Device<TOptions>>
Inherited from BaseRemoteDeviceIntegration.device
- Defined in packages/timeline-state-resolver/src/service/remoteDeviceInstance.ts:64

deviceId

get deviceId(): string
Returns string
Inherited from BaseRemoteDeviceIntegration.deviceId
- Defined in packages/timeline-state-resolver/src/service/remoteDeviceInstance.ts:67

deviceName

get deviceName(): string
Returns string
Inherited from BaseRemoteDeviceIntegration.deviceName
- Defined in packages/timeline-state-resolver/src/service/remoteDeviceInstance.ts:73

deviceOptions

get deviceOptions(): TOptions
Returns TOptions
Inherited from BaseRemoteDeviceIntegration.deviceOptions
- Defined in packages/timeline-state-resolver/src/service/remoteDeviceInstance.ts:76

deviceType

get deviceType(): DeviceType
Returns DeviceType
Inherited from BaseRemoteDeviceIntegration.deviceType
- Defined in packages/timeline-state-resolver/src/service/remoteDeviceInstance.ts:70

initialized

get initialized(): boolean
Returns boolean
Inherited from BaseRemoteDeviceIntegration.initialized
- Defined in packages/timeline-state-resolver/src/service/remoteDeviceInstance.ts:42

instanceId

get instanceId(): number
Returns number
Inherited from BaseRemoteDeviceIntegration.instanceId
- Defined in packages/timeline-state-resolver/src/service/remoteDeviceInstance.ts:82

startTime

get startTime(): number
Returns number
Inherited from BaseRemoteDeviceIntegration.startTime
- Defined in packages/timeline-state-resolver/src/service/remoteDeviceInstance.ts:85

threadConfig

get threadConfig(): undefined | ThreadedClassConfig
Returns undefined | ThreadedClassConfig
Inherited from BaseRemoteDeviceIntegration.threadConfig
- Defined in packages/timeline-state-resolver/src/service/remoteDeviceInstance.ts:79

Methods

addListener

addListener<T>(event: T, fn: ((...args: ArgumentMap<DeviceContainerEvents>[Extract<T, "error">]) => void), context?: any): DeviceContainer<TOptions>
Type Parameters
- T extends "error"
Parameters
- event: T
- fn: ((...args: ArgumentMap<DeviceContainerEvents>[Extract<T, "error">]) => void)
  - - (...args: ArgumentMap<DeviceContainerEvents>[Extract<T, "error">]): void
    - Parameters
      
      Rest ...args: ArgumentMap<DeviceContainerEvents>[Extract<T, "error">]
      
      Returns void
- Optional context: any
Returns DeviceContainer<TOptions>
Inherited from BaseRemoteDeviceIntegration.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

emit

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

eventNames

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

Returns "error"[]
Inherited from BaseRemoteDeviceIntegration.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

init

init(initOptions: TOptions["options"], activeRundownPlaylistId: undefined | string): Promise<boolean>
Parameters
- initOptions: TOptions["options"]
- activeRundownPlaylistId: undefined | string
Returns Promise<boolean>
Overrides BaseRemoteDeviceIntegration.init
- Defined in packages/timeline-state-resolver/src/devices/deviceContainer.ts:85

listenerCount

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

listeners

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

off

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

on

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

once

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

reloadProps

reloadProps(): Promise<void>
Returns Promise<void>
Overrides BaseRemoteDeviceIntegration.reloadProps
- Defined in packages/timeline-state-resolver/src/devices/deviceContainer.ts:74

removeAllListeners

removeAllListeners(event?: "error"): DeviceContainer<TOptions>
Remove all listeners, or those of the specified event.
Parameters
- Optional event: "error"
Returns DeviceContainer<TOptions>
Inherited from BaseRemoteDeviceIntegration.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

removeListener

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

setDebugLogging

setDebugLogging(debug: boolean): Promise<void>
Parameters
- debug: boolean
Returns Promise<void>
Inherited from BaseRemoteDeviceIntegration.setDebugLogging
- Defined in packages/timeline-state-resolver/src/service/remoteDeviceInstance.ts:54

setDebugState

setDebugState(debug: boolean): Promise<void>
Parameters
- debug: boolean
Returns Promise<void>
Inherited from BaseRemoteDeviceIntegration.setDebugState
- Defined in packages/timeline-state-resolver/src/service/remoteDeviceInstance.ts:59

terminate

terminate(): Promise<void>
Returns Promise<void>
Inherited from BaseRemoteDeviceIntegration.terminate
- Defined in packages/timeline-state-resolver/src/service/remoteDeviceInstance.ts:49

`Static` create

create<TOptions, TCtor>(orgModule: string, orgClassExport: string, deviceId: string, deviceOptions: TOptions, getCurrentTime: (() => number), threadConfig?: ThreadedClassConfig): Promise<DeviceContainer<TOptions>>
Type Parameters
- TOptions extends DeviceOptionsBase<unknown, TOptions>
- TCtor extends (new (...args: any[]) => Device<TOptions>)
Parameters
- orgModule: string
- orgClassExport: string
- deviceId: string
- deviceOptions: TOptions
- getCurrentTime: (() => number)
  - - (): number
    - Returns number
- Optional threadConfig: ThreadedClassConfig
Returns Promise<DeviceContainer<TOptions>>
- Defined in packages/timeline-state-resolver/src/devices/deviceContainer.ts:26

Class DeviceContainer<TOptions>

Type Parameters

TOptions extends DeviceOptionsBase<any>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Private constructor

Type Parameters

TOptions extends DeviceOptionsBase<any, TOptions>

Parameters

device: Promisify<Device<TOptions>>

deviceOptions: TOptions

threadConfig: undefined | ThreadedClassConfig

Returns DeviceContainer<TOptions>

Properties

Protected _details

Protected Readonly _device

Protected _initialized

Protected _onEventListeners

onChildClose

Accessors

debugLogging

Returns boolean

debugState

Returns boolean

details

Returns DeviceDetails

device

Returns Promisify<DeviceInstanceWrapper> | Promisify<Device<TOptions>>

deviceId

Returns string

deviceName

Returns string

deviceOptions

Returns TOptions

deviceType

Returns DeviceType

initialized

Returns boolean

instanceId

Returns number

startTime

Returns number

threadConfig

Returns undefined | ThreadedClassConfig

Methods

addListener

Type Parameters

T extends "error"

Parameters

event: T

fn: ((...args: ArgumentMap<DeviceContainerEvents>[Extract<T, "error">]) => void)

Parameters

Rest ...args: ArgumentMap<DeviceContainerEvents>[Extract<T, "error">]

Returns void

Optional context: any

Returns DeviceContainer<TOptions>

emit

Type Parameters

T extends "error"

Parameters

event: T

Rest ...args: ArgumentMap<DeviceContainerEvents>[Extract<T, "error">]

Returns boolean

eventNames

Returns "error"[]

init

Parameters

initOptions: TOptions["options"]

activeRundownPlaylistId: undefined | string

Returns Promise<boolean>

listenerCount

Parameters

event: "error"

Returns number

listeners

`Private` constructor

`Protected` _details

`Protected` `Readonly` _device

`Protected` _initialized

`Protected` _onEventListeners

`Rest` ...args: ArgumentMap<DeviceContainerEvents>[Extract<T, "error">]

`Optional` context: any

`Rest` ...args: ArgumentMap<DeviceContainerEvents>[Extract<T, "error">]

`Optional` fn: ((...args: ArgumentMap<DeviceContainerEvents>[Extract<T, "error">]) => void)

`Rest` ...args: ArgumentMap<DeviceContainerEvents>[Extract<T, "error">]

`Optional` context: any

`Optional` once: boolean

`Rest` ...args: ArgumentMap<DeviceContainerEvents>[Extract<T, "error">]

`Optional` context: any

`Rest` ...args: ArgumentMap<DeviceContainerEvents>[Extract<T, "error">]

`Optional` context: any

`Optional` event: "error"

`Optional` fn: ((...args: ArgumentMap<DeviceContainerEvents>[Extract<T, "error">]) => void)

`Rest` ...args: ArgumentMap<DeviceContainerEvents>[Extract<T, "error">]

`Optional` context: any

`Optional` once: boolean

`Static` create