Class MixEffectKeyLumaCommand

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

Hierarchy

WritableCommand<UpstreamKeyerLumaSettings>
- MixEffectKeyLumaCommand

Index

Constructors

Properties

_properties flag mixEffect upstreamKeyerId MaskFlags minimumVersion? rawName

Accessors

Methods

_updateProps serialize updateProps

Constructors

constructor

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

Properties

`Protected` _properties

_properties: Partial<UpstreamKeyerLumaSettings>

flag

flag: number

`Readonly` mixEffect

mixEffect: number

`Readonly` upstreamKeyerId

upstreamKeyerId: number

`Static` MaskFlags

MaskFlags: {
    clip: number;
    gain: number;
    invert: number;
    preMultiplied: number;
} = ...

Type declaration

clip: number
gain: number
invert: number
preMultiplied: number

`Static` `Optional` `Readonly` minimumVersion

minimumVersion?: ProtocolVersion

`Static` `Readonly` rawName

rawName: "CKLm" = 'CKLm'

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/MixEffectKeyLumaCommand.ts:24

updateProps

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

Generated using TypeDoc