Class VizMSEDevice

This class is used to interface with a vizRT Media Sequence Editor, through the v-connection library. It features playing both "internal" graphics element and vizPilot elements.

Hierarchy

DeviceWithState<VizMSEState, DeviceOptionsVizMSEInternal>
- VizMSEDevice

Index

Constructors

constructor

new VizMSEDevice(deviceId: string, deviceOptions: DeviceOptionsVizMSEInternal, getCurrentTime: (() => Promise<number>)): VizMSEDevice
Parameters
- deviceId: string
- deviceOptions: DeviceOptionsVizMSEInternal
- getCurrentTime: (() => Promise<number>)
  - - (): Promise<number>
    - Returns Promise<number>
Returns VizMSEDevice
Overrides DeviceWithState<VizMSEState, DeviceOptionsVizMSEInternal>.constructor
- Defined in packages/timeline-state-resolver/src/integrations/vizMSE/index.ts:88

Properties

`Private` _commandReceiver

_commandReceiver: CommandReceiver = ...

`Protected` _deviceOptions

_deviceOptions: DeviceOptionsVizMSEInternal

`Private` _doOnTime

_doOnTime: DoOnTime

`Private` _doOnTimeBurst

_doOnTimeBurst: DoOnTime

`Private` `Optional` _initOptions

_initOptions?: VizMSEOptions

`Protected` _isActive

_isActive: boolean = true

`Protected` _reportAllCommands

_reportAllCommands: boolean = false

`Private` `Optional` _vizMSE

_vizMSE?: MSE

`Private` _vizMSEConnected

_vizMSEConnected: boolean = false

`Private` `Optional` _vizmseManager

_vizmseManager?: VizMSEManager

useDirectTime

useDirectTime: boolean = false

Accessors

canConnect

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

connected

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

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/vizMSE/index.ts:306

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/vizMSE/index.ts:303

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/vizMSE/index.ts:310

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
Overrides DeviceWithState.supportsExpectedPlayoutItems
- Defined in packages/timeline-state-resolver/src/integrations/vizMSE/index.ts:314

Methods

`Private` _addToQueue

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

`Private` _contentToStateLayer

_contentToStateLayer(timelineObjId: string, content: TimelineContentVIZMSEElementInternal | TimelineContentVIZMSEElementPilot): undefined | VizMSEStateLayer
Parameters
- timelineObjId: string
- content: TimelineContentVIZMSEElementInternal | TimelineContentVIZMSEElementPilot
Returns undefined | VizMSEStateLayer
- Defined in packages/timeline-state-resolver/src/integrations/vizMSE/index.ts:458

`Private` _defaultCommandReceiver

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

`Private` _diffStates

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

`Private` _doCommand

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

activate

activate(payload: undefined | Record<string, any>): Promise<ActionExecutionResult<undefined>>
Parameters
- payload: undefined | Record<string, any>
Returns Promise<ActionExecutionResult<undefined>>
- Defined in packages/timeline-state-resolver/src/integrations/vizMSE/index.ts:215

addListener

addListener<T>(event: T, fn: ((...args: ArgumentMap<DeviceEvents>[Extract<T, keyof DeviceEvents>]) => void), context?: any): VizMSEDevice
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 VizMSEDevice
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

clearEngines

clearEngines(): Promise<void>
Returns Promise<void>
- Defined in packages/timeline-state-resolver/src/integrations/vizMSE/index.ts:261

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/vizMSE/index.ts:205

`Protected` clearStates

clearStates(): void
Removes all states

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

connectionChanged

connectionChanged(connected?: boolean): void
Parameters
- Optional connected: boolean
Returns void
- Defined in packages/timeline-state-resolver/src/integrations/vizMSE/index.ts:328

convertStateToVizMSE

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

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<A>(actionId: A, payload: VizMSEActionExecutionPayload<A>): Promise<VizMSEActionExecutionResult<A>>
Type Parameters
- A extends VizMSEActions
Parameters
- actionId: A
- payload: VizMSEActionExecutionPayload<A>
Returns Promise<VizMSEActionExecutionResult<A>>
Overrides DeviceWithState.executeAction
- Defined in packages/timeline-state-resolver/src/integrations/vizMSE/index.ts:280

executeStandDown

executeStandDown(): Promise<ActionExecutionResult<undefined>>
Returns Promise<ActionExecutionResult<undefined>>
- Defined in packages/timeline-state-resolver/src/integrations/vizMSE/index.ts:536

getCurrentState

getCurrentState(): undefined | VizMSEState
Returns undefined | VizMSEState
- Defined in packages/timeline-state-resolver/src/integrations/vizMSE/index.ts:325

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: VizMSEState;
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: VizMSEState;
time: number;
}
Inherited from DeviceWithState.getState
- Defined in packages/timeline-state-resolver/src/devices/device.ts:373

`Protected` getStateBefore

getStateBefore(time: number): null | {
state: VizMSEState;
time: number;
}
Get the last known state before a point time. Useful for creating device diffs.
Parameters
- time: number
Returns null | {
state: VizMSEState;
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/vizMSE/index.ts:558

`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
Overrides DeviceWithState.handleExpectedPlayoutItems
- Defined in packages/timeline-state-resolver/src/integrations/vizMSE/index.ts:317

handleState

handleState(newState: Timeline.TimelineState<TSRTimelineContent>, newMappings: Mappings<unknown>): void
Generates an array of VizMSE 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/vizMSE/index.ts:170

ignoreWaitsInTests

ignoreWaitsInTests(): void
Returns void
- Defined in packages/timeline-state-resolver/src/integrations/vizMSE/index.ts:1007

init

init(initOptions: VizMSEOptions, activeRundownPlaylistId?: string): Promise<boolean>
Parameters
- initOptions: VizMSEOptions
- Optional activeRundownPlaylistId: string
Returns Promise<boolean>
Overrides DeviceWithState.init
- Defined in packages/timeline-state-resolver/src/integrations/vizMSE/index.ts:114

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, activeRundownPlaylistId?: string): Promise<void>
Prepares the physical device for playout.
Parameters
- Optional okToDestroyStuff: boolean
  
  Whether it is OK to do things that affects playout visibly
- Optional activeRundownPlaylistId: string
Returns Promise<void>
Overrides DeviceWithState.makeReady
- Defined in packages/timeline-state-resolver/src/integrations/vizMSE/index.ts:506

off

off<T>(event: T, fn?: ((...args: ArgumentMap<DeviceEvents>[Extract<T, keyof DeviceEvents>]) => void), context?: any, once?: boolean): VizMSEDevice
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 VizMSEDevice
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): VizMSEDevice
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 VizMSEDevice
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): VizMSEDevice
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 VizMSEDevice
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/vizMSE/index.ts:162

purgeRundown

purgeRundown(clearAll: boolean): Promise<void>
Parameters
- clearAll: boolean
Returns Promise<void>
- Defined in packages/timeline-state-resolver/src/integrations/vizMSE/index.ts:258

removeAllListeners

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

resetViz

resetViz(payload: VizResetPayload): Promise<void>
Parameters
- payload: VizResetPayload
Returns Promise<void>
- Defined in packages/timeline-state-resolver/src/integrations/vizMSE/index.ts:270

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: VizMSEState, 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: VizMSEState
- 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
Parameters
- Optional okToDestroyStuff: boolean
  
  If true, the device may do things that might affect the visible output
Returns Promise<void>
Overrides DeviceWithState.standDown
- Defined in packages/timeline-state-resolver/src/integrations/vizMSE/index.ts:553

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/vizMSE/index.ts:153

Class VizMSEDevice

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

deviceId: string

deviceOptions: DeviceOptionsVizMSEInternal

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

Returns Promise<number>

Returns VizMSEDevice

Properties

Private _commandReceiver

Protected _deviceOptions

Private _doOnTime

Private _doOnTimeBurst

Private Optional _initOptions

Protected _isActive

Protected _reportAllCommands

Private Optional _vizMSE

Private _vizMSEConnected

Private Optional _vizmseManager

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: VizMSECommand[]

Returns void

Private _contentToStateLayer

Parameters

timelineObjId: string

content: TimelineContentVIZMSEElementInternal | TimelineContentVIZMSEElementPilot

Returns undefined | VizMSEStateLayer

Private _defaultCommandReceiver

Parameters

_time: number

cmd: VizMSECommand

context: string

timelineObjId: string

Returns Promise<any>

Private _diffStates

Parameters

oldState: VizMSEState

newState: VizMSEState

time: number

Returns VizMSECommand[]

Private _doCommand

Parameters

command: VizMSECommand

context: string

timlineObjId: string

Returns Promise<void>

activate

`Private` _commandReceiver

`Protected` _deviceOptions

`Private` _doOnTime

`Private` _doOnTimeBurst

`Private` `Optional` _initOptions

`Protected` _isActive

`Protected` _reportAllCommands

`Private` `Optional` _vizMSE

`Private` _vizMSEConnected

`Private` `Optional` _vizmseManager

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

`Private` _addToQueue

`Private` _contentToStateLayer

`Private` _defaultCommandReceiver

`Private` _diffStates

`Private` _doCommand

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

`Optional` context: any

`Protected` cleanUpStates

`Protected` clearStates

`Optional` connected: boolean

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

`Protected` emitDebug

`Rest` ...args: any[]

`Protected` emitDebugState

`Protected` getState

`Optional` time: number