Class MediaPoolFrameDescriptionCommand

Base type for a receivable command

Hierarchy

DeserializedCommand<StillFrame>
- MediaPoolFrameDescriptionCommand

Index

Constructors

Properties

frameIndex mediaPool properties minimumVersion? rawName

Methods

applyToState deserialize

Constructors

constructor

new MediaPoolFrameDescriptionCommand(mediaPool, frameIndex, properties): MediaPoolFrameDescriptionCommand
Parameters
- mediaPool: number
- frameIndex: number
- properties: StillFrame
Returns MediaPoolFrameDescriptionCommand
Overrides DeserializedCommand.constructor
- Defined in src/commands/Media/MediaPoolFrameDescription.ts:12

Properties

`Readonly` frameIndex

frameIndex: number

`Readonly` mediaPool

mediaPool: number

`Readonly` properties

properties: Readonly<StillFrame>

`Static` `Optional` `Readonly` minimumVersion

minimumVersion?: ProtocolVersion

`Static` `Readonly` rawName

rawName: "MPfe" = 'MPfe'

Methods

applyToState

applyToState(state): string | string[]
Parameters
- state: AtemState
Returns string | string[]
Overrides DeserializedCommand.applyToState
- Defined in src/commands/Media/MediaPoolFrameDescription.ts:31

`Static` deserialize

deserialize(rawCommand): MediaPoolFrameDescriptionCommand
Parameters
- rawCommand: Buffer
Returns MediaPoolFrameDescriptionCommand
- Defined in src/commands/Media/MediaPoolFrameDescription.ts:19

Generated using TypeDoc