Class FadeToBlackStateCommand

Base type for a receivable command

Hierarchy

DeserializedCommand<FadeToBlackProps>
- FadeToBlackStateCommand

Index

Constructors

Properties

mixEffect properties minimumVersion? rawName

Methods

applyToState deserialize

Constructors

constructor

new FadeToBlackStateCommand(mixEffect, properties): FadeToBlackStateCommand
Parameters
- mixEffect: number
- properties: FadeToBlackProps
Returns FadeToBlackStateCommand
Overrides DeserializedCommand.constructor
- Defined in src/commands/MixEffects/FadeToBlack/FadeToBlackStateCommand.ts:15

Properties

`Readonly` mixEffect

mixEffect: number

`Readonly` properties

properties: Readonly<FadeToBlackProps>

`Static` `Optional` `Readonly` minimumVersion

minimumVersion?: ProtocolVersion

`Static` `Readonly` rawName

rawName: "FtbS" = 'FtbS'

Methods

applyToState

applyToState(state): string
Parameters
- state: AtemState
Returns string
Overrides DeserializedCommand.applyToState
- Defined in src/commands/MixEffects/FadeToBlack/FadeToBlackStateCommand.ts:32

`Static` deserialize

deserialize(rawCommand): FadeToBlackStateCommand
Parameters
- rawCommand: Buffer
Returns FadeToBlackStateCommand
- Defined in src/commands/MixEffects/FadeToBlack/FadeToBlackStateCommand.ts:21

Generated using TypeDoc