Class AtemCommandBatch

A simple command batcher for the ATEM. This class allows you to queue commands and send them all at once, in a single batch.

Hierarchy

__type<void, typeof AtemCommandBatchBase, this> & AtemCommandBatchBase<this>
- AtemCommandBatch

Index

Constructors

constructor

Properties

apiVersion

Methods

Constructors

constructor

new AtemCommandBatch(client): AtemCommandBatch
Parameters
- client: IBasicAtem
Returns AtemCommandBatch
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).constructor
- Defined in src/lib/batchCommands.ts:22

Properties

`Readonly` apiVersion

apiVersion: undefined | ProtocolVersion

Methods

autoDownstreamKey

autoDownstreamKey(key?, isTowardsOnAir?): void
Parameters
- key: number = 0
- Optional isTowardsOnAir: boolean
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).autoDownstreamKey
- Defined in src/lib/atemCommands.ts:97

autoTransition

autoTransition(me?): void
Parameters
- me: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).autoTransition
- Defined in src/lib/atemCommands.ts:82

captureMediaPoolStill

captureMediaPoolStill(): void
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).captureMediaPoolStill
- Defined in src/lib/atemCommands.ts:330

changePreviewInput

changePreviewInput(input, me?): void
Parameters
- input: number
- me: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).changePreviewInput
- Defined in src/lib/atemCommands.ts:72

changeProgramInput

changeProgramInput(input, me?): void
Parameters
- input: number
- me: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).changeProgramInput
- Defined in src/lib/atemCommands.ts:67

clearMediaPoolClip

clearMediaPoolClip(clipId): void
Parameters
- clipId: number
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).clearMediaPoolClip
- Defined in src/lib/atemCommands.ts:320

clearMediaPoolStill

clearMediaPoolStill(stillId): void
Parameters
- stillId: number
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).clearMediaPoolStill
- Defined in src/lib/atemCommands.ts:325

clearStartupState

clearStartupState(): void
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).clearStartupState
- Defined in src/lib/atemCommands.ts:773

cut

cut(me?): void
Parameters
- me: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).cut
- Defined in src/lib/atemCommands.ts:77

fadeToBlack

fadeToBlack(me?): void
Parameters
- me: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).fadeToBlack
- Defined in src/lib/atemCommands.ts:87

macroContinue

macroContinue(): void
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).macroContinue
- Defined in src/lib/atemCommands.ts:205

macroDelete

macroDelete(index?): void
Parameters
- index: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).macroDelete
- Defined in src/lib/atemCommands.ts:210

macroInsertTimedWait

macroInsertTimedWait(frames): void
Parameters
- frames: number
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).macroInsertTimedWait
- Defined in src/lib/atemCommands.ts:220

macroInsertUserWait

macroInsertUserWait(): void
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).macroInsertUserWait
- Defined in src/lib/atemCommands.ts:215

macroRun

macroRun(index?): void
Parameters
- index: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).macroRun
- Defined in src/lib/atemCommands.ts:225

macroSetLoop

macroSetLoop(loop): void
Parameters
- loop: boolean
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).macroSetLoop
- Defined in src/lib/atemCommands.ts:251

macroStartRecord

macroStartRecord(index, name, description): void
Parameters
- index: number
- name: string
- description: string
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).macroStartRecord
- Defined in src/lib/atemCommands.ts:235

macroStop

macroStop(): void
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).macroStop
- Defined in src/lib/atemCommands.ts:230

macroStopRecord

macroStopRecord(): void
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).macroStopRecord
- Defined in src/lib/atemCommands.ts:240

macroUpdateProperties

macroUpdateProperties(props, index?): void
Parameters
- props: Readonly<Partial<OmitReadonly<MacroPropertiesState>>>
- index: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).macroUpdateProperties
- Defined in src/lib/atemCommands.ts:245

previewTransition

previewTransition(on, me?): void
Parameters
- on: boolean
- me: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).previewTransition
- Defined in src/lib/atemCommands.ts:125

requestDisplayClockTime

requestDisplayClockTime(): void
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).requestDisplayClockTime
- Defined in src/lib/atemCommands.ts:783

requestRecordingDuration

requestRecordingDuration(): void
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).requestRecordingDuration
- Defined in src/lib/atemCommands.ts:748

requestStreamingDuration

requestStreamingDuration(): void
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).requestStreamingDuration
- Defined in src/lib/atemCommands.ts:722

requestTime

requestTime(): void
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).requestTime
- Defined in src/lib/atemCommands.ts:200

runUpstreamKeyerFlyKeyTo

runUpstreamKeyerFlyKeyTo(mixEffect, upstreamKeyerId, keyFrameId): void
Parameters
- mixEffect: number
- upstreamKeyerId: number
- keyFrameId: A | B | Full
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).runUpstreamKeyerFlyKeyTo
- Defined in src/lib/atemCommands.ts:470

runUpstreamKeyerFlyKeyToInfinite

runUpstreamKeyerFlyKeyToInfinite(mixEffect, upstreamKeyerId, direction): void
Parameters
- mixEffect: number
- upstreamKeyerId: number
- direction: FlyKeyDirection
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).runUpstreamKeyerFlyKeyToInfinite
- Defined in src/lib/atemCommands.ts:478

saveStartupState

saveStartupState(): void
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).saveStartupState
- Defined in src/lib/atemCommands.ts:769

sendCommand

sendCommand(command): void
Parameters
- command: ISerializableCommand
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).sendCommand
- Defined in src/lib/atemCommands.ts:49

sendCommands

sendCommands(commands): void
Parameters
- commands: ISerializableCommand[]
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).sendCommands
- Defined in src/lib/atemCommands.ts:50

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>
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).sendQueued
- Defined in src/lib/batchCommands.ts:30

setAuxSource

setAuxSource(source, bus?): void
Parameters
- source: number
- bus: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setAuxSource
- Defined in src/lib/atemCommands.ts:148

setClassicAudioMixerHeadphonesProps

setClassicAudioMixerHeadphonesProps(props): void
Parameters
- props: Partial<ClassicAudioHeadphoneOutputChannel>
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setClassicAudioMixerHeadphonesProps
- Defined in src/lib/atemCommands.ts:530

setClassicAudioMixerInputProps

setClassicAudioMixerInputProps(index, props): void
Parameters
- index: number
- props: Partial<OmitReadonly<ClassicAudioChannel>>
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setClassicAudioMixerInputProps
- Defined in src/lib/atemCommands.ts:512

setClassicAudioMixerMasterProps

setClassicAudioMixerMasterProps(props): void
Parameters
- props: Partial<ClassicAudioMasterChannel>
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setClassicAudioMixerMasterProps
- Defined in src/lib/atemCommands.ts:518

setClassicAudioMixerMonitorProps

setClassicAudioMixerMonitorProps(props): void
Parameters
- props: Partial<ClassicAudioMonitorChannel>
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setClassicAudioMixerMonitorProps
- Defined in src/lib/atemCommands.ts:524

setClassicAudioMixerProps

setClassicAudioMixerProps(props): void
Parameters
- props: Readonly<{
  audioFollowVideo: boolean;
  }>
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setClassicAudioMixerProps
- Defined in src/lib/atemCommands.ts:542

setClassicAudioResetPeaks

setClassicAudioResetPeaks(props): void
Parameters
- props: Partial<ClassicAudioResetPeaks>
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setClassicAudioResetPeaks
- Defined in src/lib/atemCommands.ts:536

setColorGeneratorColour

setColorGeneratorColour(newProps, index?): void
Parameters
- newProps: Partial<ColorGeneratorState>
- index: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setColorGeneratorColour
- Defined in src/lib/atemCommands.ts:297

setDVETransitionSettings

setDVETransitionSettings(newProps, me?): void
Parameters
- newProps: Partial<DVETransitionSettings>
- me: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setDVETransitionSettings
- Defined in src/lib/atemCommands.ts:109

setDipTransitionSettings

setDipTransitionSettings(newProps, me?): void
Parameters
- newProps: Partial<DipTransitionSettings>
- me: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setDipTransitionSettings
- Defined in src/lib/atemCommands.ts:103

setDisplayClockProperties

setDisplayClockProperties(props): void
Parameters
- props: Partial<DisplayClockPropertiesExt>
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setDisplayClockProperties
- Defined in src/lib/atemCommands.ts:793

setDisplayClockState

setDisplayClockState(state): void
Parameters
- state: DisplayClockClockState
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setDisplayClockState
- Defined in src/lib/atemCommands.ts:788

setDownstreamKeyCutSource

setDownstreamKeyCutSource(input, key?): void
Parameters
- input: number
- key: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setDownstreamKeyCutSource
- Defined in src/lib/atemCommands.ts:163

setDownstreamKeyFillSource

setDownstreamKeyFillSource(input, key?): void
Parameters
- input: number
- key: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setDownstreamKeyFillSource
- Defined in src/lib/atemCommands.ts:168

setDownstreamKeyGeneralProperties

setDownstreamKeyGeneralProperties(props, key?): void
Parameters
- props: Partial<DownstreamKeyerGeneral>
- key: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setDownstreamKeyGeneralProperties
- Defined in src/lib/atemCommands.ts:173

setDownstreamKeyMaskSettings

setDownstreamKeyMaskSettings(props, key?): void
Parameters
- props: Partial<DownstreamKeyerMask>
- key: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setDownstreamKeyMaskSettings
- Defined in src/lib/atemCommands.ts:179

setDownstreamKeyOnAir

setDownstreamKeyOnAir(onAir, key?): void
Parameters
- onAir: boolean
- key: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setDownstreamKeyOnAir
- Defined in src/lib/atemCommands.ts:158

setDownstreamKeyRate

setDownstreamKeyRate(rate, key?): void
Parameters
- rate: number
- key: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setDownstreamKeyRate
- Defined in src/lib/atemCommands.ts:185

setDownstreamKeyTie

setDownstreamKeyTie(tie, key?): void
Parameters
- tie: boolean
- key: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setDownstreamKeyTie
- Defined in src/lib/atemCommands.ts:153

setEnableISORecording

setEnableISORecording(enabled): void
Parameters
- enabled: boolean
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setEnableISORecording
- Defined in src/lib/atemCommands.ts:764

setFadeToBlackRate

setFadeToBlackRate(rate, me?): void
Parameters
- rate: number
- me: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setFadeToBlackRate
- Defined in src/lib/atemCommands.ts:92

setFairlightAudioMixerInputProps

setFairlightAudioMixerInputProps(index, props): void
Parameters
- index: number
- props: Readonly<Partial<Omit<OmitReadonly<FairlightAudioInputProperties>, "activeInputLevel"> & {
  rcaToXlrEnabled: boolean;
  }>>
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setFairlightAudioMixerInputProps
- Defined in src/lib/atemCommands.ts:617

setFairlightAudioMixerMasterCompressorProps

setFairlightAudioMixerMasterCompressorProps(props): void
Parameters
- props: Partial<OmitReadonly<FairlightAudioCompressorState>>
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setFairlightAudioMixerMasterCompressorProps
- Defined in src/lib/atemCommands.ts:553

setFairlightAudioMixerMasterDynamicsReset

setFairlightAudioMixerMasterDynamicsReset(props): void
Parameters
- props: Partial<FairlightDynamicsResetProps>
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setFairlightAudioMixerMasterDynamicsReset
- Defined in src/lib/atemCommands.ts:584

setFairlightAudioMixerMasterEqualizerBandProps

setFairlightAudioMixerMasterEqualizerBandProps(band, props): void
Parameters
- band: number
- props: Partial<OmitReadonly<FairlightAudioEqualizerBandState>>
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setFairlightAudioMixerMasterEqualizerBandProps
- Defined in src/lib/atemCommands.ts:567

setFairlightAudioMixerMasterEqualizerReset

setFairlightAudioMixerMasterEqualizerReset(props): void
Parameters
- props: Partial<Readonly<Partial<{
  band: number;
  equalizer: boolean;
  }>>>
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setFairlightAudioMixerMasterEqualizerReset
- Defined in src/lib/atemCommands.ts:576

setFairlightAudioMixerMasterLimiterProps

setFairlightAudioMixerMasterLimiterProps(props): void
Parameters
- props: Partial<OmitReadonly<FairlightAudioLimiterState>>
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setFairlightAudioMixerMasterLimiterProps
- Defined in src/lib/atemCommands.ts:561

setFairlightAudioMixerMasterProps

setFairlightAudioMixerMasterProps(props): void
Parameters
- props: Partial<FairlightMixerMasterCommandProperties>
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setFairlightAudioMixerMasterProps
- Defined in src/lib/atemCommands.ts:547

setFairlightAudioMixerMonitorProps

setFairlightAudioMixerMonitorProps(props): void
Parameters
- props: Partial<OmitReadonly<FairlightAudioMonitorChannel>>
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setFairlightAudioMixerMonitorProps
- Defined in src/lib/atemCommands.ts:605

setFairlightAudioMixerMonitorSolo

setFairlightAudioMixerMonitorSolo(props): void
Parameters
- props: Partial<OmitReadonly<FairlightAudioMonitorSolo>>
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setFairlightAudioMixerMonitorSolo
- Defined in src/lib/atemCommands.ts:611

setFairlightAudioMixerResetPeaks

setFairlightAudioMixerResetPeaks(props): void
Parameters
- props: Readonly<{
  all: boolean;
  master: boolean;
  }>
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setFairlightAudioMixerResetPeaks
- Defined in src/lib/atemCommands.ts:590

setFairlightAudioMixerSourceCompressorProps

setFairlightAudioMixerSourceCompressorProps(index, source, props): void
Parameters
- index: number
- source: string
- props: Partial<OmitReadonly<FairlightAudioCompressorState>>
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setFairlightAudioMixerSourceCompressorProps
- Defined in src/lib/atemCommands.ts:642

setFairlightAudioMixerSourceDynamicsReset

setFairlightAudioMixerSourceDynamicsReset(index, source, props): void
Parameters
- index: number
- source: string
- props: Partial<FairlightDynamicsResetProps>
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setFairlightAudioMixerSourceDynamicsReset
- Defined in src/lib/atemCommands.ts:683

setFairlightAudioMixerSourceEqualizerBandProps

setFairlightAudioMixerSourceEqualizerBandProps(index, source, band, props): void
Parameters
- index: number
- source: string
- band: number
- props: Partial<OmitReadonly<FairlightAudioEqualizerBandState>>
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setFairlightAudioMixerSourceEqualizerBandProps
- Defined in src/lib/atemCommands.ts:672

setFairlightAudioMixerSourceEqualizerReset

setFairlightAudioMixerSourceEqualizerReset(index, source, props): void
Parameters
- index: number
- source: string
- props: Partial<Readonly<Partial<{
  band: number;
  equalizer: boolean;
  }>>>
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setFairlightAudioMixerSourceEqualizerReset
- Defined in src/lib/atemCommands.ts:693

setFairlightAudioMixerSourceExpanderProps

setFairlightAudioMixerSourceExpanderProps(index, source, props): void
Parameters
- index: number
- source: string
- props: Partial<OmitReadonly<FairlightAudioExpanderState>>
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setFairlightAudioMixerSourceExpanderProps
- Defined in src/lib/atemCommands.ts:662

setFairlightAudioMixerSourceLimiterProps

setFairlightAudioMixerSourceLimiterProps(index, source, props): void
Parameters
- index: number
- source: string
- props: Partial<OmitReadonly<FairlightAudioLimiterState>>
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setFairlightAudioMixerSourceLimiterProps
- Defined in src/lib/atemCommands.ts:652

setFairlightAudioMixerSourceProps

setFairlightAudioMixerSourceProps(index, source, props): void
Parameters
- index: number
- source: string
- props: Readonly<Partial<OmitReadonly<FairlightMixerSourceCommandProperties>>>
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setFairlightAudioMixerSourceProps
- Defined in src/lib/atemCommands.ts:632

setFairlightAudioMixerSourceResetPeaks

setFairlightAudioMixerSourceResetPeaks(index, source, props): void
Parameters
- index: number
- source: string
- props: Readonly<{
      dynamicsInput: boolean;
      dynamicsOutput: boolean;
      output: boolean;
  }>
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setFairlightAudioMixerSourceResetPeaks
- Defined in src/lib/atemCommands.ts:703

setFairlightAudioRoutingOutputProperties

setFairlightAudioRoutingOutputProperties(sourceId, props): void
Parameters
- sourceId: number
- props: Partial<OmitReadonly<FairlightAudioRoutingOutput>>
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setFairlightAudioRoutingOutputProperties
- Defined in src/lib/atemCommands.ts:808

setFairlightAudioRoutingSourceProperties

setFairlightAudioRoutingSourceProperties(sourceId, props): void
Parameters
- sourceId: number
- props: Partial<OmitReadonly<FairlightAudioRoutingSource>>
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setFairlightAudioRoutingSourceProperties
- Defined in src/lib/atemCommands.ts:799

setInputSettings

setInputSettings(newProps, input?): void
Parameters
- newProps: Partial<OmitReadonly<InputChannel>>
- input: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setInputSettings
- Defined in src/lib/atemCommands.ts:384

setMediaClip

setMediaClip(index, name, frames?): void
Parameters
- index: number
- name: string
- frames: number = 1
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setMediaClip
- Defined in src/lib/atemCommands.ts:315

setMediaPlayerSettings

setMediaPlayerSettings(newProps, player?): void
Parameters
- newProps: Partial<MediaPlayer>
- player: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setMediaPlayerSettings
- Defined in src/lib/atemCommands.ts:303

setMediaPlayerSource

setMediaPlayerSource(newProps, player?): void
Parameters
- newProps: Partial<MediaPlayerSource>
- player: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setMediaPlayerSource
- Defined in src/lib/atemCommands.ts:309

setMediaPoolSettings

setMediaPoolSettings(props): void
Parameters
- props: MediaPoolProps
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setMediaPoolSettings
- Defined in src/lib/atemCommands.ts:778

setMixTransitionSettings

setMixTransitionSettings(newProps, me?): void
Parameters
- newProps: Pick<MixTransitionSettings, "rate">
- me: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setMixTransitionSettings
- Defined in src/lib/atemCommands.ts:115

setMultiViewerBorderColor

setMultiViewerBorderColor(color, mv?): void
Parameters
- color: MultiViewerBorderColorState
- mv: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setMultiViewerBorderColor
- Defined in src/lib/atemCommands.ts:279

setMultiViewerProperties

setMultiViewerProperties(props, mv?): void
Parameters
- props: Partial<MultiViewerPropertiesState>
- mv: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setMultiViewerProperties
- Defined in src/lib/atemCommands.ts:274

setMultiViewerVuOpacity

setMultiViewerVuOpacity(opacity, mv?): void
Parameters
- opacity: number
- mv: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setMultiViewerVuOpacity
- Defined in src/lib/atemCommands.ts:270

setMultiViewerWindowOverlayProperties

setMultiViewerWindowOverlayProperties(props, mv?, window?): void
Parameters
- props: Partial<MultiViewerWindowOverlayPropertiesState>
- mv: number = 0
- window: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setMultiViewerWindowOverlayProperties
- Defined in src/lib/atemCommands.ts:283

setMultiViewerWindowSafeAreaEnabled

setMultiViewerWindowSafeAreaEnabled(safeAreaEnabled, mv?, window?): void
Parameters
- safeAreaEnabled: boolean
- mv: number = 0
- window: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setMultiViewerWindowSafeAreaEnabled
- Defined in src/lib/atemCommands.ts:261

setMultiViewerWindowSafeAreaPattern

setMultiViewerWindowSafeAreaPattern(safeTitlePattern, mv?, window?): void
Parameters
- safeTitlePattern: SafeTitlePattern[]
- mv: number = 0
- window: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setMultiViewerWindowSafeAreaPattern
- Defined in src/lib/atemCommands.ts:292

setMultiViewerWindowSource

setMultiViewerWindowSource(source, mv?, window?): void
Parameters
- source: number
- mv: number = 0
- window: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setMultiViewerWindowSource
- Defined in src/lib/atemCommands.ts:257

setMultiViewerWindowVuEnabled

setMultiViewerWindowVuEnabled(vuEnabled, mv?, window?): void
Parameters
- vuEnabled: boolean
- mv: number = 0
- window: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setMultiViewerWindowVuEnabled
- Defined in src/lib/atemCommands.ts:265

setRecordingSettings

setRecordingSettings(props): void
Parameters
- props: Partial<RecordingStateProperties>
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setRecordingSettings
- Defined in src/lib/atemCommands.ts:758

setStingerTransitionSettings

setStingerTransitionSettings(newProps, me?): void
Parameters
- newProps: Partial<StingerTransitionSettings>
- me: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setStingerTransitionSettings
- Defined in src/lib/atemCommands.ts:136

setStreamingAudioBitrates

setStreamingAudioBitrates(lowBitrate, highBitrate): void
Parameters
- lowBitrate: number
- highBitrate: number
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setStreamingAudioBitrates
- Defined in src/lib/atemCommands.ts:733

setStreamingService

setStreamingService(props): void
Parameters
- props: Partial<StreamingServiceProperties>
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setStreamingService
- Defined in src/lib/atemCommands.ts:727

setSuperSourceBorder

setSuperSourceBorder(newProps, ssrcId?): void
Parameters
- newProps: Partial<SuperSourceBorder>
- ssrcId: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setSuperSourceBorder
- Defined in src/lib/atemCommands.ts:353

setSuperSourceBoxBorder

setSuperSourceBoxBorder(newProps, box?, ssrcId?): void
Set the per-box SuperSource border (Constellation HD range and newer, firmware 9.6.0+). When box is omitted the same values are applied to all four boxes.
Parameters
- newProps: Partial<SuperSourceBoxBorder>
- Optional box: null | number
- ssrcId: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setSuperSourceBoxBorder
- Defined in src/lib/atemCommands.ts:370

setSuperSourceBoxSettings

setSuperSourceBoxSettings(newProps, box?, ssrcId?): void
Parameters
- newProps: Partial<SuperSourceBox>
- box: number = 0
- ssrcId: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setSuperSourceBoxSettings
- Defined in src/lib/atemCommands.ts:335

setSuperSourceProperties

setSuperSourceProperties(newProps, ssrcId?): void
Parameters
- newProps: Partial<SuperSourceProperties>
- ssrcId: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setSuperSourceProperties
- Defined in src/lib/atemCommands.ts:341

setTime

setTime(hour, minute, second, frame): void
Parameters
- hour: number
- minute: number
- second: number
- frame: number
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setTime
- Defined in src/lib/atemCommands.ts:190

setTimeMode

setTimeMode(mode): void
Parameters
- mode: TimeMode
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setTimeMode
- Defined in src/lib/atemCommands.ts:195

setTransitionPosition

setTransitionPosition(position, me?): void
Parameters
- position: number
- me: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setTransitionPosition
- Defined in src/lib/atemCommands.ts:120

setTransitionStyle

setTransitionStyle(newProps, me?): void
Parameters
- newProps: Partial<OmitReadonly<TransitionProperties>>
- me: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setTransitionStyle
- Defined in src/lib/atemCommands.ts:130

setUpstreamKeyerAdvancedChromaProperties

setUpstreamKeyerAdvancedChromaProperties(newProps, me?, keyer?): void
Parameters
- newProps: Partial<UpstreamKeyerAdvancedChromaProperties>
- me: number = 0
- keyer: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setUpstreamKeyerAdvancedChromaProperties
- Defined in src/lib/atemCommands.ts:400

setUpstreamKeyerAdvancedChromaSample

setUpstreamKeyerAdvancedChromaSample(newProps, me?, keyer?): void
Parameters
- newProps: Partial<UpstreamKeyerAdvancedChromaSample>
- me: number = 0
- keyer: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setUpstreamKeyerAdvancedChromaSample
- Defined in src/lib/atemCommands.ts:409

setUpstreamKeyerAdvancedChromaSampleReset

setUpstreamKeyerAdvancedChromaSampleReset(flags, me?, keyer?): void
Parameters
- flags: AdvancedChromaSampleResetProps
- me: number = 0
- keyer: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setUpstreamKeyerAdvancedChromaSampleReset
- Defined in src/lib/atemCommands.ts:418

setUpstreamKeyerChromaSettings

setUpstreamKeyerChromaSettings(newProps, me?, keyer?): void
Parameters
- newProps: Partial<UpstreamKeyerChromaSettings>
- me: number = 0
- keyer: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setUpstreamKeyerChromaSettings
- Defined in src/lib/atemCommands.ts:390

setUpstreamKeyerCutSource

setUpstreamKeyerCutSource(cutSource, me?, keyer?): void
Parameters
- cutSource: number
- me: number = 0
- keyer: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setUpstreamKeyerCutSource
- Defined in src/lib/atemCommands.ts:427

setUpstreamKeyerDVESettings

setUpstreamKeyerDVESettings(newProps, me?, keyer?): void
Parameters
- newProps: Partial<UpstreamKeyerDVESettings>
- me: number = 0
- keyer: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setUpstreamKeyerDVESettings
- Defined in src/lib/atemCommands.ts:437

setUpstreamKeyerFillSource

setUpstreamKeyerFillSource(fillSource, me?, keyer?): void
Parameters
- fillSource: number
- me: number = 0
- keyer: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setUpstreamKeyerFillSource
- Defined in src/lib/atemCommands.ts:432

setUpstreamKeyerFlyKeyKeyframe

setUpstreamKeyerFlyKeyKeyframe(mixEffect, upstreamKeyerId, keyframe, properties): void
Parameters
- mixEffect: number
- upstreamKeyerId: number
- keyframe: number
- properties: Partial<Omit<UpstreamKeyerFlyKeyframe, "keyFrameId">>
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setUpstreamKeyerFlyKeyKeyframe
- Defined in src/lib/atemCommands.ts:495

setUpstreamKeyerLumaSettings

setUpstreamKeyerLumaSettings(newProps, me?, keyer?): void
Parameters
- newProps: Partial<UpstreamKeyerLumaSettings>
- me: number = 0
- keyer: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setUpstreamKeyerLumaSettings
- Defined in src/lib/atemCommands.ts:443

setUpstreamKeyerMaskSettings

setUpstreamKeyerMaskSettings(newProps, me?, keyer?): void
Parameters
- newProps: Partial<UpstreamKeyerMaskSettings>
- me: number = 0
- keyer: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setUpstreamKeyerMaskSettings
- Defined in src/lib/atemCommands.ts:449

setUpstreamKeyerOnAir

setUpstreamKeyerOnAir(onAir, me?, keyer?): void
Parameters
- onAir: boolean
- me: number = 0
- keyer: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setUpstreamKeyerOnAir
- Defined in src/lib/atemCommands.ts:465

setUpstreamKeyerPatternSettings

setUpstreamKeyerPatternSettings(newProps, me?, keyer?): void
Parameters
- newProps: Partial<UpstreamKeyerPatternSettings>
- me: number = 0
- keyer: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setUpstreamKeyerPatternSettings
- Defined in src/lib/atemCommands.ts:455

setUpstreamKeyerType

setUpstreamKeyerType(newProps, me?, keyer?): void
Parameters
- newProps: Partial<UpstreamKeyerTypeSettings>
- me: number = 0
- keyer: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setUpstreamKeyerType
- Defined in src/lib/atemCommands.ts:506

setWipeTransitionSettings

setWipeTransitionSettings(newProps, me?): void
Parameters
- newProps: Partial<WipeTransitionSettings>
- me: number = 0
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).setWipeTransitionSettings
- Defined in src/lib/atemCommands.ts:142

startFairlightMixerSendLevels

startFairlightMixerSendLevels(): void
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).startFairlightMixerSendLevels
- Defined in src/lib/atemCommands.ts:595

startRecording

startRecording(): void
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).startRecording
- Defined in src/lib/atemCommands.ts:738

startStreaming

startStreaming(): void
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).startStreaming
- Defined in src/lib/atemCommands.ts:712

stopFairlightMixerSendLevels

stopFairlightMixerSendLevels(): void
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).stopFairlightMixerSendLevels
- Defined in src/lib/atemCommands.ts:600

stopRecording

stopRecording(): void
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).stopRecording
- Defined in src/lib/atemCommands.ts:743

stopStreaming

stopStreaming(): void
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).stopStreaming
- Defined in src/lib/atemCommands.ts:717

storeUpstreamKeyerFlyKeyKeyframe

storeUpstreamKeyerFlyKeyKeyframe(mixEffect, upstreamKeyerId, keyframe): void
Parameters
- mixEffect: number
- upstreamKeyerId: number
- keyframe: number
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).storeUpstreamKeyerFlyKeyKeyframe
- Defined in src/lib/atemCommands.ts:491

switchRecordingDisk

switchRecordingDisk(): void
Returns void
Inherited from AtemCommandSenderMixin<void, typeof AtemCommandBatchBase>(AtemCommandBatchBase).switchRecordingDisk
- Defined in src/lib/atemCommands.ts:753

Class AtemCommandBatch

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: IBasicAtem

Returns AtemCommandBatch

Properties

Readonly apiVersion

Methods

autoDownstreamKey

Parameters

key: number = 0

Optional isTowardsOnAir: boolean

Returns void

autoTransition

Parameters

me: number = 0

Returns void

captureMediaPoolStill

Returns void

changePreviewInput

Parameters

input: number

me: number = 0

Returns void

changeProgramInput

Parameters

input: number

me: number = 0

Returns void

clearMediaPoolClip

Parameters

clipId: number

Returns void

clearMediaPoolStill

Parameters

stillId: number

Returns void

clearStartupState

Returns void

cut

Parameters

me: number = 0

Returns void

fadeToBlack

Parameters

me: number = 0

Returns void

macroContinue

Returns void

macroDelete

Parameters

index: number = 0

Returns void

macroInsertTimedWait

Parameters

frames: number

Returns void

macroInsertUserWait

Returns void

macroRun

Parameters

index: number = 0

Returns void

macroSetLoop

Parameters

loop: boolean

Returns void

macroStartRecord

Parameters

index: number

name: string

description: string

Returns void

macroStop

`Readonly` apiVersion

`Optional` isTowardsOnAir: boolean

props: Readonly<{
audioFollowVideo: boolean;
}>