Class SuperSourceBoxBorderUpdateCommand

Reports the per-box SuperSource border on the Constellation HD range and newer (firmware 9.6.0+). See SuperSourceBoxBorderCommand for the write side.

Hierarchy

DeserializedCommand<{
    border: SuperSourceBoxBorder;
    boxId: number;
    ssrcId: number;
}>
- SuperSourceBoxBorderUpdateCommand

Index

Constructors

Properties

properties minimumVersion rawName

Methods

applyToState deserialize

Constructors

constructor

new SuperSourceBoxBorderUpdateCommand(properties): SuperSourceBoxBorderUpdateCommand
Parameters
- properties: {
      border: SuperSourceBoxBorder;
      boxId: number;
      ssrcId: number;
  }
  - border: SuperSourceBoxBorder
  - boxId: number
  - ssrcId: number
Returns SuperSourceBoxBorderUpdateCommand
Inherited from DeserializedCommand.constructor
- Defined in src/commands/CommandBase.ts:17

Properties

`Readonly` properties

properties: Readonly<{
    border: SuperSourceBoxBorder;
    boxId: number;
    ssrcId: number;
}>

Type declaration

border: SuperSourceBoxBorder
boxId: number
ssrcId: number

`Static` `Readonly` minimumVersion

minimumVersion: V9_6 = ProtocolVersion.V9_6

`Static` `Readonly` rawName

rawName: "SSSB" = 'SSSB'

Methods

applyToState

applyToState(state): string
Parameters
- state: AtemState
Returns string
Overrides DeserializedCommand.applyToState
- Defined in src/commands/SuperSource/SuperSourceBoxBorderCommand.ts:47

`Static` deserialize

deserialize(rawCommand): SuperSourceBoxBorderUpdateCommand
Parameters
- rawCommand: Buffer
Returns SuperSourceBoxBorderUpdateCommand
- Defined in src/commands/SuperSource/SuperSourceBoxBorderCommand.ts:28

Generated using TypeDoc