Class CasparCGDevice

This class is used to interface with CasparCG installations. It creates device states from timeline states and then diffs these states to generate commands. It depends on the DoOnTime class to execute the commands timely or, optionally, uses the CasparCG command scheduling features.

Hierarchy

DeviceWithState<State, DeviceOptionsCasparCGInternal>
- CasparCGDevice

Index

Constructors

constructor

new CasparCGDevice(deviceId: string, deviceOptions: DeviceOptionsCasparCGInternal, getCurrentTime: (() => Promise<number>)): CasparCGDevice
Parameters
- deviceId: string
- deviceOptions: DeviceOptionsCasparCGInternal
- getCurrentTime: (() => Promise<number>)
  - - (): Promise<number>
    - Returns Promise<number>
Returns CasparCGDevice
Overrides DeviceWithState<State, DeviceOptionsCasparCGInternal>.constructor
- Defined in packages/timeline-state-resolver/src/integrations/casparCG/index.ts:91

Properties

`Private` _ccg

_ccg: BasicCasparCGAPI

Setup in init

`Private` _commandReceiver

_commandReceiver: CommandReceiver = ...

`Private` _connected

_connected: boolean = false

`Private` _currentState

_currentState: InternalState = ...

`Protected` _deviceOptions

_deviceOptions: DeviceOptionsCasparCGInternal

`Private` _doOnTime

_doOnTime: DoOnTime

`Protected` _isActive

_isActive: boolean = true

`Private` _queueOverflow

_queueOverflow: boolean = false

`Protected` _reportAllCommands

_reportAllCommands: boolean = false

`Private` _retryTime

_retryTime: null | number = null

`Private` _retryTimeout

_retryTimeout: undefined | Timeout

`Private` _transitionHandler

_transitionHandler: InternalTransitionHandler = ...

`Private` `Optional` initOptions

initOptions?: CasparCGOptions

useDirectTime

useDirectTime: boolean = false

Accessors

canConnect

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

connected

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

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/casparCG/index.ts:298

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/casparCG/index.ts:295

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

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: AMCPCommandWithContext[], time: number): void
Use either AMCP Command Scheduling or the doOnTime to execute commands at {@code time}.
Parameters
- commandsToAchieveState: AMCPCommandWithContext[]
  
  Commands to be added to queue
- time: number
  
  Point in time to send commands at
Returns void
- Defined in packages/timeline-state-resolver/src/integrations/casparCG/index.ts:804

`Private` _assertIntendedState

_assertIntendedState(): void
This function takes the current timeline-state, and diffs it with the known CasparCG state. If any media has failed to load, it will create a diff with the intended (timeline) state and that command will be executed.

Returns void
- Defined in packages/timeline-state-resolver/src/integrations/casparCG/index.ts:966

`Private` _changeTrackedStateFromCommand

_changeTrackedStateFromCommand(command: AMCPCommand, response: Response<unknown>, time: number): void
Parameters
- command: AMCPCommand
- response: Response<unknown>
- time: number
Returns void
- Defined in packages/timeline-state-resolver/src/integrations/casparCG/index.ts:877

`Private` _connectionChanged

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

`Private` _defaultCommandReceiver

_defaultCommandReceiver(time: number, cmd: AMCPCommand, context: string, timelineObjId: string): Promise<any>
Sends a command over a casparcg-connection instance
Parameters
- time: number
  
  deprecated
- cmd: AMCPCommand
  
  Command to execute
- context: string
- timelineObjId: string
Returns Promise<any>
- Defined in packages/timeline-state-resolver/src/integrations/casparCG/index.ts:821

addListener

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

`Private` clearAllChannels

clearAllChannels(): Promise<ActionExecutionResult<undefined>>
Returns Promise<ActionExecutionResult<undefined>>
- Defined in packages/timeline-state-resolver/src/integrations/casparCG/index.ts:634

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/casparCG/index.ts:284

`Protected` clearStates

clearStates(): void
Removes all states

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

`Private` convertObjectToCasparState

convertObjectToCasparState(mappings: Mappings<unknown>, layer: Timeline.ResolvedTimelineObjectInstance<Timeline.Content>, mapping: MappingCasparCGLayer, isForeground: boolean): LayerBase
Parameters
- mappings: Mappings<unknown>
- layer: Timeline.ResolvedTimelineObjectInstance<Timeline.Content>
- mapping: MappingCasparCGLayer
- isForeground: boolean
Returns LayerBase
- Defined in packages/timeline-state-resolver/src/integrations/casparCG/index.ts:306

convertStateToCaspar

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

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: CasparCGActionExecutionPayload<A>): Promise<CasparCGActionExecutionResult<A>>
Type Parameters
- A extends CasparCGActions
Parameters
- actionId: A
- payload: CasparCGActionExecutionPayload<A>
Returns Promise<CasparCGActionExecutionResult<A>>
Overrides DeviceWithState.executeAction
- Defined in packages/timeline-state-resolver/src/integrations/casparCG/index.ts:684

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

`Protected` getStateBefore

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

`Private` getVideMode

getVideMode(info: InfoEntry): string
Parameters
- info: InfoEntry
Returns string
- Defined in packages/timeline-state-resolver/src/integrations/casparCG/index.ts:1004

`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 CasparCG 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/casparCG/index.ts:251

init

init(initOptions: CasparCGOptions): Promise<boolean>
Initiates the connection with CasparCG through the ccg-connection lib and initializes CasparCG State library.
Parameters
- initOptions: CasparCGOptions
Returns Promise<boolean>
Overrides DeviceWithState.init
- Defined in packages/timeline-state-resolver/src/integrations/casparCG/index.ts:112

`Private` listMedia

listMedia(query?: ClsParameters): Promise<ActionExecutionResult<ListMediaResult>>
Parameters
- query: ClsParameters = {}
Returns Promise<ActionExecutionResult<ListMediaResult>>
- Defined in packages/timeline-state-resolver/src/integrations/casparCG/index.ts:749

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. If amcp scheduling is used this tries to sync the timecode. If {@code okToDestroyStuff === true} this clears all channels and resets our states.
Parameters
- Optional okToDestroyStuff: boolean
  
  Whether it is OK to restart the device
Returns Promise<void>
Overrides DeviceWithState.makeReady
- Defined in packages/timeline-state-resolver/src/integrations/casparCG/index.ts:627

off

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

removeAllListeners

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

`Private` restartCasparCG

restartCasparCG(): Promise<ActionExecutionResult<undefined>>
Attemps to restart casparcg over the HTTP API provided by CasparCG launcher.

Returns Promise<ActionExecutionResult<undefined>>
- Defined in packages/timeline-state-resolver/src/integrations/casparCG/index.ts:703

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: State, 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: State
- 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/casparCG/index.ts:222

Class CasparCGDevice

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

deviceId: string

deviceOptions: DeviceOptionsCasparCGInternal

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

Returns Promise<number>

Returns CasparCGDevice

Properties

Private _ccg

Private _commandReceiver

Private _connected

Private _currentState

Protected _deviceOptions

Private _doOnTime

Protected _isActive

Private _queueOverflow

Protected _reportAllCommands

Private _retryTime

Private _retryTimeout

Private _transitionHandler

Private Optional initOptions

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

startTime

Returns number

supportsExpectedPlayoutItems

Returns boolean

Methods

Private _addToQueue

Parameters

commandsToAchieveState: AMCPCommandWithContext[]

time: number

Returns void

Private _assertIntendedState

Returns void

Private _changeTrackedStateFromCommand

Parameters

command: AMCPCommand

response: Response<unknown>

time: number

Returns void

Private _connectionChanged

Returns void

Private _defaultCommandReceiver

Parameters

time: number

cmd: AMCPCommand

context: string

timelineObjId: string

Returns Promise<any>

addListener

Type Parameters

T extends keyof DeviceEvents

Parameters

event: T

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

`Private` _ccg

`Private` _commandReceiver

`Private` _connected

`Private` _currentState

`Protected` _deviceOptions

`Private` _doOnTime

`Protected` _isActive

`Private` _queueOverflow

`Protected` _reportAllCommands

`Private` _retryTime

`Private` _retryTimeout

`Private` _transitionHandler

`Private` `Optional` initOptions

`Private` _addToQueue

`Private` _assertIntendedState

`Private` _changeTrackedStateFromCommand

`Private` _connectionChanged

`Private` _defaultCommandReceiver

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

`Optional` context: any

`Protected` cleanUpStates

`Private` clearAllChannels

`Protected` clearStates

`Private` convertObjectToCasparState

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

`Protected` emitDebug

`Rest` ...args: any[]

`Protected` emitDebugState

`Protected` getState

`Optional` time: number

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

`Protected` getStateBefore

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

`Private` getVideMode