Class SuperSourceBoxBorderCommand

Sets the per-box SuperSource border on the ATEM Constellation HD range and newer (firmware 9.6.0+); SuperSourceBoxBorderUpdateCommand reports it back. Older models use SuperSourceBorderCommand instead - the two ranges each ignore the other's command.

Hierarchy

WritableCommand<SuperSourceBoxBorder>
- SuperSourceBoxBorderCommand

Index

Constructors

constructor

new SuperSourceBoxBorderCommand(ssrcId, boxId): SuperSourceBoxBorderCommand
Parameters
- ssrcId: number
- boxId: number
Returns SuperSourceBoxBorderCommand
Overrides WritableCommand.constructor
- Defined in src/commands/SuperSource/SuperSourceBoxBorderCommand.ts:86

Properties

`Protected` _properties

_properties: Partial<SuperSourceBoxBorder>

`Readonly` boxId

boxId: number

flag

flag: number

`Optional` runOrderGroup

runOrderGroup?: number = 0

Link

ISerializableCommand.runOrderGroup

`Readonly` ssrcId

ssrcId: number

`Static` MaskFlags

MaskFlags: {
    borderEnabled: number;
    borderHue: number;
    borderLuma: number;
    borderSaturation: number;
    borderWidthInBottom: number;
    borderWidthInLeft: number;
    borderWidthInRight: number;
    borderWidthInTop: number;
    borderWidthOutHorizontal: number;
    borderWidthOutVertical: number;
} = ...

Type declaration

borderEnabled: number
borderHue: number
borderLuma: number
borderSaturation: number
borderWidthInBottom: number
borderWidthInLeft: number
borderWidthInRight: number
borderWidthInTop: number
borderWidthOutHorizontal: number
borderWidthOutVertical: number

`Static` `Readonly` minimumVersion

minimumVersion: V9_6 = ProtocolVersion.V9_6

`Static` `Readonly` rawName

rawName: "CSSB" = 'CSSB'

Accessors

properties

get properties(): Readonly<T>
Returns Readonly<T>
Inherited from WritableCommand.properties
- Defined in src/commands/CommandBase.ts:47

Methods

`Protected` _updateProps

_updateProps(newProps): boolean
Parameters
- newProps: {
  [key: string]: any;
  }
  - [key: string]: any
Returns boolean
Inherited from WritableCommand._updateProps
- Defined in src/commands/CommandBase.ts:75

serialize

serialize(): Buffer
Returns Buffer
Overrides WritableCommand.serialize
- Defined in src/commands/SuperSource/SuperSourceBoxBorderCommand.ts:93

updateProps

updateProps(newProps): boolean
Update the values of some properties with this command
Parameters
- newProps: Partial<SuperSourceBoxBorder>
Returns boolean
Inherited from WritableCommand.updateProps
- Defined in src/commands/CommandBase.ts:71

Class SuperSourceBoxBorderCommand

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

ssrcId: number

boxId: number

Returns SuperSourceBoxBorderCommand

Properties

Protected _properties

Readonly boxId

flag

Optional runOrderGroup

Link

Readonly ssrcId

Static MaskFlags

Type declaration

borderEnabled: number

borderHue: number

borderLuma: number

borderSaturation: number

borderWidthInBottom: number

borderWidthInLeft: number

borderWidthInRight: number

borderWidthInTop: number

borderWidthOutHorizontal: number

borderWidthOutVertical: number

Static Readonly minimumVersion

Static Readonly rawName

Accessors

properties

Returns Readonly<T>

Methods

Protected _updateProps

Parameters

newProps: { [key: string]: any; }

[key: string]: any

Returns boolean

serialize

Returns Buffer

updateProps

Parameters

newProps: Partial<SuperSourceBoxBorder>

Returns boolean

Settings

Member Visibility

Theme

On This Page

`Protected` _properties

`Readonly` boxId

`Optional` runOrderGroup

`Readonly` ssrcId

`Static` MaskFlags

`Static` `Readonly` minimumVersion

`Static` `Readonly` rawName

`Protected` _updateProps

newProps: {
[key: string]: any;
}