Class MultiViewerWindowOverlaySafeAreaPatternCommand

Base command type for a command which gets sent in both directions

Hierarchy

SymmetricalCommand<{
safeTitlePattern: SafeTitlePattern[];
}>
- MultiViewerWindowOverlaySafeAreaPatternCommand

Index

Constructors

Properties

multiViewerId properties windowIndex minimumVersion? rawName

Methods

applyToState serialize deserialize

Constructors

constructor

new MultiViewerWindowOverlaySafeAreaPatternCommand(multiviewerId, windowIndex, safeTitlePattern): MultiViewerWindowOverlaySafeAreaPatternCommand
Parameters
- multiviewerId: number
- windowIndex: number
- safeTitlePattern: SafeTitlePattern[]
Returns MultiViewerWindowOverlaySafeAreaPatternCommand
Overrides SymmetricalCommand.constructor
- Defined in src/commands/Settings/MultiViewerWindowSafeAreaTypeCommand.ts:14

Properties

`Readonly` multiViewerId

multiViewerId: number

`Readonly` properties

properties: Readonly<{
safeTitlePattern: SafeTitlePattern[];
}>

Type declaration

safeTitlePattern: SafeTitlePattern[]

`Readonly` windowIndex

windowIndex: number

`Static` `Optional` `Readonly` minimumVersion

minimumVersion?: ProtocolVersion

`Static` `Readonly` rawName

rawName: "StMw" = 'StMw'

Methods

applyToState

applyToState(state): string
Parameters
- state: AtemState
Returns string
Overrides SymmetricalCommand.applyToState
- Defined in src/commands/Settings/MultiViewerWindowSafeAreaTypeCommand.ts:37

serialize

serialize(): Buffer
Returns Buffer
Overrides SymmetricalCommand.serialize
- Defined in src/commands/Settings/MultiViewerWindowSafeAreaTypeCommand.ts:21

`Static` deserialize

deserialize(rawCommand): MultiViewerWindowOverlaySafeAreaPatternCommand
Parameters
- rawCommand: Buffer
Returns MultiViewerWindowOverlaySafeAreaPatternCommand
- Defined in src/commands/Settings/MultiViewerWindowSafeAreaTypeCommand.ts:29

Generated using TypeDoc