Class MixEffectKeyAdvancedChromaPropertiesCommand

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

Hierarchy

WritableCommand<UpstreamKeyerAdvancedChromaProperties>
- MixEffectKeyAdvancedChromaPropertiesCommand

Index

Constructors

constructor

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

Properties

`Protected` _properties

_properties: Partial<UpstreamKeyerAdvancedChromaProperties>

flag

flag: number

`Readonly` mixEffect

mixEffect: number

`Optional` runOrderGroup

runOrderGroup?: number = 0

Link

ISerializableCommand.runOrderGroup

`Readonly` upstreamKeyerId

upstreamKeyerId: number

`Static` MaskFlags

MaskFlags: {
    backgroundLevel: number;
    blue: number;
    brightness: number;
    contrast: number;
    flareSuppression: number;
    foregroundLevel: number;
    green: number;
    keyEdge: number;
    red: number;
    saturation: number;
    spillSuppression: number;
} = ...

Type declaration

backgroundLevel: number
blue: number
brightness: number
contrast: number
flareSuppression: number
foregroundLevel: number
green: number
keyEdge: number
red: number
saturation: number
spillSuppression: number

`Static` `Optional` `Readonly` minimumVersion

minimumVersion?: ProtocolVersion

`Static` `Readonly` rawName

rawName: "CACK" = 'CACK'

Accessors

properties

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

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

serialize

serialize(): Buffer
Returns Buffer
Overrides WritableCommand.serialize
- Defined in src/commands/MixEffects/Key/MixEffectKeyAdvancedChromaPropertiesCommand.ts:33

updateProps

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

Class MixEffectKeyAdvancedChromaPropertiesCommand

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

mixEffect: number

upstreamKeyerId: number

Returns MixEffectKeyAdvancedChromaPropertiesCommand

Properties

Protected _properties

flag

Readonly mixEffect

Optional runOrderGroup

Link

Readonly upstreamKeyerId

Static MaskFlags

Type declaration

backgroundLevel: number

blue: number

brightness: number

contrast: number

flareSuppression: number

foregroundLevel: number

green: number

keyEdge: number

red: number

saturation: number

spillSuppression: number

Static Optional Readonly minimumVersion

Static Readonly rawName

Accessors

properties

Returns Readonly<T>

Methods

Protected _updateProps

Parameters

newProps: { [key: string]: any; }

[key: string]: any

Returns boolean

serialize

Returns Buffer

updateProps

Parameters

newProps: Partial<UpstreamKeyerAdvancedChromaProperties>

Returns boolean

Settings

Member Visibility

Theme

On This Page

`Protected` _properties

`Readonly` mixEffect

`Optional` runOrderGroup

`Readonly` upstreamKeyerId

`Static` MaskFlags

`Static` `Optional` `Readonly` minimumVersion

`Static` `Readonly` rawName

`Protected` _updateProps

newProps: {
[key: string]: any;
}