Class MixEffectKeyLumaUpdateCommand

Base type for a receivable command

Hierarchy

DeserializedCommand<UpstreamKeyerLumaSettings>
- MixEffectKeyLumaUpdateCommand

Index

Constructors

Properties

mixEffect properties upstreamKeyerId minimumVersion? rawName

Methods

applyToState deserialize

Constructors

constructor

new MixEffectKeyLumaUpdateCommand(mixEffect, upstreamKeyerId, properties): MixEffectKeyLumaUpdateCommand
Parameters
- mixEffect: number
- upstreamKeyerId: number
- properties: UpstreamKeyerLumaSettings
Returns MixEffectKeyLumaUpdateCommand
Overrides DeserializedCommand.constructor
- Defined in src/commands/MixEffects/Key/MixEffectKeyLumaCommand.ts:45

Properties

`Readonly` mixEffect

mixEffect: number

`Readonly` properties

properties: Readonly<UpstreamKeyerLumaSettings>

`Readonly` upstreamKeyerId

upstreamKeyerId: number

`Static` `Optional` `Readonly` minimumVersion

minimumVersion?: ProtocolVersion

`Static` `Readonly` rawName

rawName: "KeLm" = 'KeLm'

Methods

applyToState

applyToState(state): string
Parameters
- state: AtemState
Returns string
Overrides DeserializedCommand.applyToState
- Defined in src/commands/MixEffects/Key/MixEffectKeyLumaCommand.ts:65

`Static` deserialize

deserialize(rawCommand): MixEffectKeyLumaUpdateCommand
Parameters
- rawCommand: Buffer
Returns MixEffectKeyLumaUpdateCommand
- Defined in src/commands/MixEffects/Key/MixEffectKeyLumaCommand.ts:52

Generated using TypeDoc