Class MixEffectKeyAdvancedChromaSampleCommand

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

Hierarchy

WritableCommand<UpstreamKeyerAdvancedChromaSample>
- MixEffectKeyAdvancedChromaSampleCommand

Index

Constructors

constructor

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

Properties

`Protected` _properties

_properties: Partial<UpstreamKeyerAdvancedChromaSample>

flag

flag: number

`Readonly` mixEffect

mixEffect: number

`Readonly` upstreamKeyerId

upstreamKeyerId: number

`Static` MaskFlags

MaskFlags: {
    cursorSize: number;
    cursorX: number;
    cursorY: number;
    enableCursor: number;
    preview: number;
    sampledCb: number;
    sampledCr: number;
    sampledY: number;
} = ...

Type declaration

cursorSize: number
cursorX: number
cursorY: number
enableCursor: number
preview: number
sampledCb: number
sampledCr: number
sampledY: number

`Static` `Optional` `Readonly` minimumVersion

minimumVersion?: ProtocolVersion

`Static` `Readonly` rawName

rawName: "CACC" = 'CACC'

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/MixEffectKeyAdvancedChromaSampleCommand.ts:28

updateProps

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

Class MixEffectKeyAdvancedChromaSampleCommand

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

mixEffect: number

upstreamKeyerId: number

Returns MixEffectKeyAdvancedChromaSampleCommand

Properties

Protected _properties

flag

Readonly mixEffect

Readonly upstreamKeyerId

Static MaskFlags

Type declaration

cursorSize: number

cursorX: number

cursorY: number

enableCursor: number

preview: number

sampledCb: number

sampledCr: number

sampledY: 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<UpstreamKeyerAdvancedChromaSample>

Returns boolean

Settings

Member Visibility

Theme

On This Page

`Protected` _properties

`Readonly` mixEffect

`Readonly` upstreamKeyerId

`Static` MaskFlags

`Static` `Optional` `Readonly` minimumVersion

`Static` `Readonly` rawName

`Protected` _updateProps

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