Class MixEffectKeyFlyPropertiesGetCommand

Base type for a receivable command

Hierarchy

DeserializedCommand<UpstreamKeyerFlySettings>
- MixEffectKeyFlyPropertiesGetCommand

Index

Constructors

Properties

mixEffect properties upstreamKeyerId minimumVersion? rawName

Methods

applyToState deserialize

Constructors

constructor

new MixEffectKeyFlyPropertiesGetCommand(mixEffect, upstreamKeyerId, properties): MixEffectKeyFlyPropertiesGetCommand
Parameters
- mixEffect: number
- upstreamKeyerId: number
- properties: UpstreamKeyerFlySettings
Returns MixEffectKeyFlyPropertiesGetCommand
Overrides DeserializedCommand.constructor
- Defined in src/commands/MixEffects/Key/MixEffectKeyFlyPropertiesGetCommand.ts:11

Properties

`Readonly` mixEffect

mixEffect: number

`Readonly` properties

properties: Readonly<UpstreamKeyerFlySettings>

`Readonly` upstreamKeyerId

upstreamKeyerId: number

`Static` `Optional` `Readonly` minimumVersion

minimumVersion?: ProtocolVersion

`Static` `Readonly` rawName

rawName: "KeFS" = 'KeFS'

Methods

applyToState

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

`Static` deserialize

deserialize(rawCommand): MixEffectKeyFlyPropertiesGetCommand
Parameters
- rawCommand: Buffer
Returns MixEffectKeyFlyPropertiesGetCommand
- Defined in src/commands/MixEffects/Key/MixEffectKeyFlyPropertiesGetCommand.ts:18

Generated using TypeDoc