Class MixEffectKeyPatternCommand

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

Hierarchy

WritableCommand<UpstreamKeyerPatternSettings>
- MixEffectKeyPatternCommand

Index

Constructors

constructor

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

Properties

`Protected` _properties

_properties: Partial<UpstreamKeyerPatternSettings>

flag

flag: number

`Readonly` mixEffect

mixEffect: number

`Readonly` upstreamKeyerId

upstreamKeyerId: number

`Static` MaskFlags

MaskFlags: {
    invert: number;
    positionX: number;
    positionY: number;
    size: number;
    softness: number;
    style: number;
    symmetry: number;
} = ...

Type declaration

invert: number
positionX: number
positionY: number
size: number
softness: number
style: number
symmetry: number

`Static` `Optional` `Readonly` minimumVersion

minimumVersion?: ProtocolVersion

`Static` `Readonly` rawName

rawName: "CKPt" = 'CKPt'

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

updateProps

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

Class MixEffectKeyPatternCommand

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

mixEffect: number

upstreamKeyerId: number

Returns MixEffectKeyPatternCommand

Properties

Protected _properties

flag

Readonly mixEffect

Readonly upstreamKeyerId

Static MaskFlags

Type declaration

invert: number

positionX: number

positionY: number

size: number

softness: number

style: number

symmetry: 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<UpstreamKeyerPatternSettings>

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;
}