Class MixEffectKeyOnAirCommand

Base command type for a simple writable command, which has a few values which must all be sent

Hierarchy

BasicWritableCommand<{
onAir: boolean;
}>
- MixEffectKeyOnAirCommand

Index

Constructors

Properties

_properties mixEffect upstreamKeyerId minimumVersion? rawName

Accessors

Methods

Constructors

constructor

new MixEffectKeyOnAirCommand(mixEffect, upstreamKeyerId, onAir): MixEffectKeyOnAirCommand
Parameters
- mixEffect: number
- upstreamKeyerId: number
- onAir: boolean
Returns MixEffectKeyOnAirCommand
Overrides BasicWritableCommand.constructor
- Defined in src/commands/MixEffects/Key/MixEffectKeyOnAirCommand.ts:10

Properties

`Protected` _properties

_properties: {
onAir: boolean;
}

Type declaration

onAir: boolean

`Readonly` mixEffect

mixEffect: number

`Readonly` upstreamKeyerId

upstreamKeyerId: number

`Static` `Optional` `Readonly` minimumVersion

minimumVersion?: ProtocolVersion

`Static` `Readonly` rawName

rawName: "CKOn" = 'CKOn'

Accessors

properties

get properties(): Readonly<T>
Returns Readonly<T>
Inherited from BasicWritableCommand.properties
- Defined in src/commands/CommandBase.ts:35

Methods

serialize

serialize(): Buffer
Returns Buffer
Overrides BasicWritableCommand.serialize
- Defined in src/commands/MixEffects/Key/MixEffectKeyOnAirCommand.ts:17

Generated using TypeDoc