Class CasparCGState0

Hierarchy

CasparCGState0
- CasparCGState

Index

Constructors

constructor

new CasparCGState0(config?: {
externalStorage?: ((action: string, data?: null | Record<string, any>) => InternalState);
getMediaDurationCallback?: ((clip: string, callback: ((duration: number) => void)) => void);
}): CasparCGState0
Parameters
- Optional config: {
  externalStorage?: ((action: string, data?: null | Record<string, any>) => InternalState);
  getMediaDurationCallback?: ((clip: string, callback: ((duration: number) => void)) => void);
  }
  - Optional externalStorage?: ((action: string, data?: null | Record<string, any>) => InternalState)
    - (action: string, data?: null | Record<string, any>): InternalState
      
      Parameters
      
      action: string
      
      Optional data: null | Record<string, any>
      
      Returns InternalState
  - Optional getMediaDurationCallback?: ((clip: string, callback: ((duration: number) => void)) => void)
    - (clip: string, callback: ((duration: number) => void)): void
      
      Parameters
      
      clip: string
      
      callback: ((duration: number) => void)
      
      (duration: number): void
      
      Parameters
      
      duration: number
      
      Returns void
      
      Returns void
Returns CasparCGState0
- Defined in src/lib/casparCGState.ts:67

Properties

`Protected` _currentStateStorage

_currentStateStorage: StateObjectStorage = ...

`Private` _isInitialised

_isInitialised: boolean = false

bufferedCommands

bufferedCommands: {
additionalLayerState?: LayerBase;
cmd: AMCPCommand;
}[] = []

minTimeSincePlay

minTimeSincePlay: number = MIN_TIME_SINCE_PLAY

Accessors

isInitialised

get isInitialised(): boolean
Returns boolean
- Defined in src/lib/casparCGState.ts:326

version

get version(): string
Returns string
- Defined in src/lib/casparCGState.ts:97

Methods

clearState

clearState(): void
Resets / clears the current state

Returns void
- Defined in src/lib/casparCGState.ts:161

getDiff

getDiff(newState: State, currentTime: number): DiffCommandGroups
Parameters
- newState: State
- currentTime: number
Returns DiffCommandGroups
- Defined in src/lib/casparCGState.ts:177

getState

getState(): InternalState
Get the gurrent state

Returns
The current state

Returns InternalState
- Defined in src/lib/casparCGState.ts:151

initStateFromChannelInfo

initStateFromChannelInfo(channels: ChannelInfo[], currentTime: number): void
Initializes the state by using channel info
Parameters
- channels: ChannelInfo[]
  
  [description]
- currentTime: number
Returns void
- Defined in src/lib/casparCGState.ts:105

setIsInitialised

setIsInitialised(initialised: boolean, _currentTime: number): void
Parameters
- initialised: boolean
- _currentTime: number
Returns void
- Defined in src/lib/casparCGState.ts:331

setState

setState(state: InternalState): void
Set the current statue to a provided state
Parameters
- state: InternalState
  
  The new state
Returns void
- Defined in src/lib/casparCGState.ts:143

softClearState

softClearState(): void
A soft clear, ie clears any content, but keeps channel settings

Returns void
- Defined in src/lib/casparCGState.ts:168

toString

toString(): string
Returns string
- Defined in src/lib/casparCGState.ts:321

valueOf

valueOf(): InternalState
Returns InternalState
- Defined in src/lib/casparCGState.ts:318

`Static` diffStates

diffStates(oldState: InternalState, newState: State, currentTime: number, minTimeSincePlay?: number): DiffCommandGroups
Parameters
- oldState: InternalState
- newState: State
- currentTime: number
- minTimeSincePlay: number = MIN_TIME_SINCE_PLAY
Returns DiffCommandGroups
- Defined in src/lib/casparCGState.ts:243

`Static` diffStatesOrderedCommands

diffStatesOrderedCommands(oldState: InternalState, newState: State, currentTime: number, minTimeSincePlay?: number): AMCPCommandWithContext[]
Temporary, intermediate function, to deal with ordering of commands. (This might be replaced with something more permanent later)
Parameters
- oldState: InternalState
- newState: State
- currentTime: number
- minTimeSincePlay: number = MIN_TIME_SINCE_PLAY
Returns AMCPCommandWithContext[]
- Defined in src/lib/casparCGState.ts:191

Class CasparCGState0

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional config: { externalStorage?: ((action: string, data?: null | Record<string, any>) => InternalState); getMediaDurationCallback?: ((clip: string, callback: ((duration: number) => void)) => void); }

Optional externalStorage?: ((action: string, data?: null | Record<string, any>) => InternalState)

Parameters

action: string

Optional data: null | Record<string, any>

Returns InternalState

Optional getMediaDurationCallback?: ((clip: string, callback: ((duration: number) => void)) => void)

Parameters

clip: string

callback: ((duration: number) => void)

Parameters

duration: number

Returns void

Returns void

Returns CasparCGState0

Properties

Protected _currentStateStorage

Private _isInitialised

bufferedCommands

minTimeSincePlay

Accessors

isInitialised

Returns boolean

version

Returns string

Methods

clearState

Returns void

getDiff

Parameters

newState: State

currentTime: number

Returns DiffCommandGroups

getState

Returns

Returns InternalState

initStateFromChannelInfo

Parameters

channels: ChannelInfo[]

currentTime: number

Returns void

setIsInitialised

Parameters

initialised: boolean

_currentTime: number

Returns void

setState

Parameters

state: InternalState

Returns void

softClearState

Returns void

toString

Returns string

valueOf

Returns InternalState

Static diffStates

Parameters

oldState: InternalState

newState: State

currentTime: number

minTimeSincePlay: number = MIN_TIME_SINCE_PLAY

Returns DiffCommandGroups

Static diffStatesOrderedCommands

Parameters

oldState: InternalState

newState: State

currentTime: number

minTimeSincePlay: number = MIN_TIME_SINCE_PLAY

Returns AMCPCommandWithContext[]

`Optional` config: {
externalStorage?: ((action: string, data?: null | Record<string, any>) => InternalState);
getMediaDurationCallback?: ((clip: string, callback: ((duration: number) => void)) => void);
}

`Optional` externalStorage?: ((action: string, data?: null | Record<string, any>) => InternalState)

`Optional` data: null | Record<string, any>

`Optional` getMediaDurationCallback?: ((clip: string, callback: ((duration: number) => void)) => void)

`Protected` _currentStateStorage

`Private` _isInitialised

`Static` diffStates

`Static` diffStatesOrderedCommands