Class DownstreamKeyGeneralCommand

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

Hierarchy

WritableCommand<DownstreamKeyerGeneral>
- DownstreamKeyGeneralCommand

Index

Constructors

Properties

_properties downstreamKeyerId flag MaskFlags minimumVersion? rawName

Accessors

Methods

_updateProps serialize updateProps

Constructors

constructor

new DownstreamKeyGeneralCommand(downstreamKeyerId): DownstreamKeyGeneralCommand
Parameters
- downstreamKeyerId: number
Returns DownstreamKeyGeneralCommand
Overrides WritableCommand.constructor
- Defined in src/commands/DownstreamKey/DownstreamKeyGeneralCommand.ts:16

Properties

`Protected` _properties

_properties: Partial<DownstreamKeyerGeneral>

`Readonly` downstreamKeyerId

downstreamKeyerId: number

flag

flag: number

`Static` MaskFlags

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

Type declaration

clip: number
gain: number
invert: number
preMultiply: number

`Static` `Optional` `Readonly` minimumVersion

minimumVersion?: ProtocolVersion

`Static` `Readonly` rawName

rawName: "CDsG" = 'CDsG'

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/DownstreamKey/DownstreamKeyGeneralCommand.ts:22

updateProps

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

Generated using TypeDoc