Class MediaPoolClipDescriptionCommand

Base type for a receivable command

Hierarchy

DeserializedCommand<Omit<ClipBank, "frames">>
- MediaPoolClipDescriptionCommand

Index

Constructors

Properties

clipId properties minimumVersion? rawName

Methods

applyToState deserialize

Constructors

constructor

new MediaPoolClipDescriptionCommand(mediaPool, properties): MediaPoolClipDescriptionCommand
Parameters
- mediaPool: number
- properties: Omit<ClipBank, "frames">
Returns MediaPoolClipDescriptionCommand
Overrides DeserializedCommand.constructor
- Defined in src/commands/Media/MediaPoolClipDescription.ts:11

Properties

`Readonly` clipId

clipId: number

`Readonly` properties

properties: Readonly<Omit<ClipBank, "frames">>

`Static` `Optional` `Readonly` minimumVersion

minimumVersion?: ProtocolVersion

`Static` `Readonly` rawName

rawName: "MPCS" = 'MPCS'

Methods

applyToState

applyToState(state): string
Parameters
- state: AtemState
Returns string
Overrides DeserializedCommand.applyToState
- Defined in src/commands/Media/MediaPoolClipDescription.ts:28

`Static` deserialize

deserialize(rawCommand): MediaPoolClipDescriptionCommand
Parameters
- rawCommand: Buffer
Returns MediaPoolClipDescriptionCommand
- Defined in src/commands/Media/MediaPoolClipDescription.ts:17

Generated using TypeDoc