Class MultiViewerWindowSafeAreaCommand

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

Hierarchy

SymmetricalCommand<{
safeAreaEnabled: boolean;
}>
- MultiViewerWindowSafeAreaCommand

Index

Constructors

Properties

multiViewerId properties windowIndex minimumVersion rawName

Methods

applyToState serialize deserialize

Constructors

constructor

new MultiViewerWindowSafeAreaCommand(multiviewerId, windowIndex, safeAreaEnabled): MultiViewerWindowSafeAreaCommand
Parameters
- multiviewerId: number
- windowIndex: number
- safeAreaEnabled: boolean
Returns MultiViewerWindowSafeAreaCommand
Overrides SymmetricalCommand.constructor
- Defined in src/commands/Settings/MultiViewerWindowSafeAreaCommand.ts:12

Properties

`Readonly` multiViewerId

multiViewerId: number

`Readonly` properties

properties: Readonly<{
safeAreaEnabled: boolean;
}>

Type declaration

safeAreaEnabled: boolean

`Readonly` windowIndex

windowIndex: number

`Static` `Readonly` minimumVersion

minimumVersion: V8_0 = ProtocolVersion.V8_0

`Static` `Readonly` rawName

rawName: "SaMw" = 'SaMw'

Methods

applyToState

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

serialize

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

`Static` deserialize

deserialize(rawCommand): MultiViewerWindowSafeAreaCommand
Parameters
- rawCommand: Buffer
Returns MultiViewerWindowSafeAreaCommand
- Defined in src/commands/Settings/MultiViewerWindowSafeAreaCommand.ts:27

Generated using TypeDoc