Class MultiViewerPropertiesCommand

Base command type for a full writable command, which uses flags to indicate the changed properties

Hierarchy

WritableCommand<MultiViewerPropertiesState>
- MultiViewerPropertiesCommand

Index

Constructors

Properties

_properties flag multiViewerId MaskFlags minimumVersion rawName

Accessors

Methods

_updateProps serialize updateProps

Constructors

constructor

new MultiViewerPropertiesCommand(multiviewerId): MultiViewerPropertiesCommand
Parameters
- multiviewerId: number
Returns MultiViewerPropertiesCommand
Overrides WritableCommand.constructor
- Defined in src/commands/Settings/MultiViewerPropertiesCommand.ts:17

Properties

`Protected` _properties

_properties: Partial<MultiViewerPropertiesState>

flag

flag: number

`Readonly` multiViewerId

multiViewerId: number

`Static` MaskFlags

MaskFlags: {
layout: number;
programPreviewSwapped: number;
} = ...

Type declaration

layout: number
programPreviewSwapped: number

`Static` `Readonly` minimumVersion

minimumVersion: V8_0 = ProtocolVersion.V8_0

`Static` `Readonly` rawName

rawName: "CMvP" = 'CMvP'

Accessors

properties

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

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:63

serialize

serialize(): Buffer
Returns Buffer
Overrides WritableCommand.serialize
- Defined in src/commands/Settings/MultiViewerPropertiesCommand.ts:23

updateProps

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

Generated using TypeDoc