Class MixEffectKeyMaskSetCommand

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

Hierarchy

WritableCommand<UpstreamKeyerMaskSettings>
- MixEffectKeyMaskSetCommand

Index

Constructors

Properties

_properties flag mixEffect upstreamKeyerId MaskFlags minimumVersion? rawName

Accessors

Methods

_updateProps serialize updateProps

Constructors

constructor

new MixEffectKeyMaskSetCommand(mixEffect, upstreamKeyerId): MixEffectKeyMaskSetCommand
Parameters
- mixEffect: number
- upstreamKeyerId: number
Returns MixEffectKeyMaskSetCommand
Overrides WritableCommand.constructor
- Defined in src/commands/MixEffects/Key/MixEffectKeyMaskSetCommand.ts:18

Properties

`Protected` _properties

_properties: Partial<UpstreamKeyerMaskSettings>

flag

flag: number

`Readonly` mixEffect

mixEffect: number

`Readonly` upstreamKeyerId

upstreamKeyerId: number

`Static` MaskFlags

MaskFlags: {
    maskBottom: number;
    maskEnabled: number;
    maskLeft: number;
    maskRight: number;
    maskTop: number;
} = ...

Type declaration

maskBottom: number
maskEnabled: number
maskLeft: number
maskRight: number
maskTop: number

`Static` `Optional` `Readonly` minimumVersion

minimumVersion?: ProtocolVersion

`Static` `Readonly` rawName

rawName: "CKMs" = 'CKMs'

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/MixEffects/Key/MixEffectKeyMaskSetCommand.ts:25

updateProps

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

Generated using TypeDoc