Class CasparCGState0

constructor

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

  Parameters

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

  Returns CasparCGState0

bufferedCommands

minTimeSincePlay

isInitialised

• get isInitialised(): boolean

  Returns boolean

version

• get version(): string

  Returns string

clearState

• clearState(): void

  Resets / clears the current state

  Returns void

getDiff

• getDiff(newState: State, currentTime: number): DiffCommandGroups

  Parameters

  • newState: State
  • currentTime: number

  Returns DiffCommandGroups

getState

• getState(): InternalState

  Get the current state

  Returns InternalState

  The current state

initStateFromChannelInfo

• initStateFromChannelInfo(channels: ChannelInfo[], currentTime: number): void

  Initializes the state by using channel info

  Parameters

  • channels: ChannelInfo[]

    [description]

  • currentTime: number

  Returns void

setIsInitialised

• setIsInitialised(initialised: boolean, _currentTime: number): void

  Parameters

  • initialised: boolean
  • _currentTime: number

  Returns void

setState

• setState(state: InternalState): void

  Set the current statue to a provided state

  Parameters

  • state: InternalState

    The new state

  Returns void

softClearState

• softClearState(): void

  A soft clear, ie clears any content, but keeps channel settings

  Returns void

toString

• toString(): string

  Returns string

valueOf

• valueOf(): InternalState

  Returns InternalState

StaticdiffStates

• 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

StaticdiffStatesOrderedCommands

• 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[]