Class AtemCommandBatchBase

Holds the state for a command batch: the queue of commands, and the way to flush them. The command-building methods are added by AtemCommandSenderMixin.

Exported so that declaration emit can name it as the base of AtemCommandBatch (which extends it through the mixin). Not intended to be used directly.

Hierarchy

AtemCommandBatchBase

Index

Constructors

Accessors

Methods

sendCommand sendCommands sendQueued

Constructors

constructor

new AtemCommandBatchBase(client): AtemCommandBatchBase
Parameters
- client: IBasicAtem
Returns AtemCommandBatchBase
- Defined in src/lib/batchCommands.ts:22

Accessors

apiVersion

get apiVersion(): undefined | ProtocolVersion
Returns undefined | ProtocolVersion
- Defined in src/lib/batchCommands.ts:18

Methods

sendCommand

sendCommand(command): void
Parameters
- command: ISerializableCommand
Returns void
- Defined in src/lib/batchCommands.ts:37

sendCommands

sendCommands(commands): void
Parameters
- commands: ISerializableCommand[]
Returns void
- Defined in src/lib/batchCommands.ts:41

sendQueued

sendQueued(): Promise<void>
Send all of the queued commands to the ATEM. The queue is emptied before sending, so the batch can be reused afterwards.

Returns Promise<void>
- Defined in src/lib/batchCommands.ts:30

Generated using TypeDoc