Class Atem

Hierarchy

__type<Promise<void>, typeof BasicAtem, this> & BasicAtem<this>
- Atem

Index

Methods

Constructors

constructor

new Atem(options?): Atem
Parameters
- Optional options: AtemOptions
Returns Atem
Overrides AtemCommandSenderMixin<Promise<void>, typeof BasicAtem>(BasicAtem).constructor
- Defined in src/atem.ts:369

Properties

`Readonly` apiVersion

apiVersion: undefined | ProtocolVersion

`Static` prefixed

prefixed: string | boolean

Accessors

`Protected` dataTransferManager

get dataTransferManager(): DataTransferManager
The data transfer manager, for uploading/downloading media. Exposed to subclasses (eg Atem) which build higher level helpers on top of it.

Returns DataTransferManager
Inherited from AtemCommandSenderMixin<Promise<void>, typeof BasicAtem>(BasicAtem).dataTransferManager
- Defined in src/atem.ts:307

state

get state(): undefined | Readonly<AtemState>
Returns undefined | Readonly<AtemState>
Inherited from AtemCommandSenderMixin<Promise<void>, typeof BasicAtem>(BasicAtem).state
- Defined in src/atem.ts:315

status

get status(): AtemConnectionStatus
Returns AtemConnectionStatus
Inherited from AtemCommandSenderMixin<Promise<void>, typeof BasicAtem>(BasicAtem).status
- Defined in src/atem.ts:311

videoMode

get videoMode(): undefined | Readonly<VideoModeInfo>
Get the current videomode of the ATEM, if known

Returns undefined | Readonly<VideoModeInfo>
Inherited from AtemCommandSenderMixin<Promise<void>, typeof BasicAtem>(BasicAtem).videoMode
- Defined in src/atem.ts:329

Methods

addListener

addListener<T>(event, fn, context?): Atem
Type Parameters
- T extends keyof AtemEvents
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: ArgumentMap<AtemEvents>[Extract<T, keyof AtemEvents>]
      
      Returns void
- Optional context: any
Returns Atem
Inherited from AtemCommandSenderMixin<Promise<void>, typeof BasicAtem>(BasicAtem).addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

autoDownstreamKey

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

autoTransition

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

captureMediaPoolStill

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

changePreviewInput

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

changeProgramInput

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

clearMediaPoolClip

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

clearMediaPoolStill

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

clearStartupState

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

connect

connect(address, port?): Promise<void>
Parameters
- address: string
- Optional port: number
Returns Promise<void>
Inherited from AtemCommandSenderMixin<Promise<void>, typeof BasicAtem>(BasicAtem).connect
- Defined in src/atem.ts:333

createCommandBatch

createCommandBatch(): AtemCommandBatch
Create a new command batch, to queue up multiple commands and send them together in a single batch.

Returns AtemCommandBatch
Inherited from AtemCommandSenderMixin<Promise<void>, typeof BasicAtem>(BasicAtem).createCommandBatch
- Defined in src/atem.ts:360

cut

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

destroy

destroy(): Promise<void>
Returns Promise<void>
Inherited from AtemCommandSenderMixin<Promise<void>, typeof BasicAtem>(BasicAtem).destroy
- Defined in src/atem.ts:341

disconnect

disconnect(): Promise<void>
Returns Promise<void>
Inherited from AtemCommandSenderMixin<Promise<void>, typeof BasicAtem>(BasicAtem).disconnect
- Defined in src/atem.ts:337

downloadClipFrame

downloadClipFrame(clipIndex, frameIndex, format?): Promise<Buffer>
Download a frame of a clip from the ATEM media pool

Note: This performs colour conversions in JS, which is not very CPU efficient. If performance is important, consider using @atem-connection/image-tools to pre-convert the images with more optimal algorithms
Parameters
- clipIndex: number
  
  Clip index to download
- frameIndex: number
  
  Frame index to download from the clip
- format: "raw" | "rgba" | "yuv" = 'rgba'
  
  The pixel format to return for the downloaded image. 'raw' passes through unchanged, and will be RLE encoded.
Returns Promise<Buffer>
Promise which returns the image once downloaded. If the still slot is not in use, this will throw
- Defined in src/atem.ts:423

downloadMacro

downloadMacro(index): Promise<Buffer>
Parameters
- index: number
Returns Promise<Buffer>
- Defined in src/atem.ts:405

downloadStill

downloadStill(index, format?): Promise<Buffer>
Download a still image from the ATEM media pool

Note: This performs colour conversions in JS, which is not very CPU efficient. If performance is important, consider using @atem-connection/image-tools to pre-convert the images with more optimal algorithms
Parameters
- index: number
  
  Still index to download
- format: "raw" | "rgba" | "yuv" = 'rgba'
  
  The pixel format to return for the downloaded image. 'raw' passes through unchanged, and will be RLE encoded.
Returns Promise<Buffer>
Promise which returns the image once downloaded. If the still slot is not in use, this will throw
- Defined in src/atem.ts:459

drawMultiviewerLabel

drawMultiviewerLabel(inputId, text): Promise<void>
Generate and upload a multiviewer label
Parameters
- inputId: number
  
  The input id
- text: string
  
  Label text
Returns Promise<void>
Promise that resolves once upload is complete
- Defined in src/atem.ts:589

emit

emit<T>(event, ...args): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends keyof AtemEvents
Parameters
- event: T
- Rest ...args: ArgumentMap<AtemEvents>[Extract<T, keyof AtemEvents>]
Returns boolean
Inherited from AtemCommandSenderMixin<Promise<void>, typeof BasicAtem>(BasicAtem).emit
- Defined in node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): (keyof AtemEvents)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (keyof AtemEvents)[]
Inherited from AtemCommandSenderMixin<Promise<void>, typeof BasicAtem>(BasicAtem).eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

fadeToBlack

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

hasInternalMultiviewerLabelGeneration

hasInternalMultiviewerLabelGeneration(): boolean
Returns boolean
- Defined in src/atem.ts:559

listVisibleInputs

listVisibleInputs(mode, me?): number[]
Parameters
- mode: "program" | "preview"
- me: number = 0
Returns number[]
- Defined in src/atem.ts:551

listenerCount

listenerCount(event): number
Return the number of listeners listening to a given event.
Parameters
- event: keyof AtemEvents
Returns number
Inherited from AtemCommandSenderMixin<Promise<void>, typeof BasicAtem>(BasicAtem).listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event): ((...args) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends keyof AtemEvents
Parameters
- event: T
Returns ((...args) => void)[]
Inherited from AtemCommandSenderMixin<Promise<void>, typeof BasicAtem>(BasicAtem).listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

macroContinue

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

macroDelete

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

macroInsertTimedWait

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

macroInsertUserWait

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

macroRun

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

macroSetLoop

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

macroStartRecord

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

macroStop

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

macroStopRecord

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

macroUpdateProperties

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

off

off<T>(event, fn?, context?, once?): Atem
Type Parameters
- T extends keyof AtemEvents
Parameters
- event: T
- Optional fn: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: ArgumentMap<AtemEvents>[Extract<T, keyof AtemEvents>]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns Atem
Inherited from AtemCommandSenderMixin<Promise<void>, typeof BasicAtem>(BasicAtem).off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T>(event, fn, context?): Atem
Add a listener for a given event.
Type Parameters
- T extends keyof AtemEvents
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: ArgumentMap<AtemEvents>[Extract<T, keyof AtemEvents>]
      
      Returns void
- Optional context: any
Returns Atem
Inherited from AtemCommandSenderMixin<Promise<void>, typeof BasicAtem>(BasicAtem).on
- Defined in node_modules/eventemitter3/index.d.ts:40

once

once<T>(event, fn, context?): Atem
Add a one-time listener for a given event.
Type Parameters
- T extends keyof AtemEvents
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: ArgumentMap<AtemEvents>[Extract<T, keyof AtemEvents>]
      
      Returns void
- Optional context: any
Returns Atem
Inherited from AtemCommandSenderMixin<Promise<void>, typeof BasicAtem>(BasicAtem).once
- Defined in node_modules/eventemitter3/index.d.ts:54

previewTransition

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

removeAllListeners

removeAllListeners(event?): Atem
Remove all listeners, or those of the specified event.
Parameters
- Optional event: keyof AtemEvents
Returns Atem
Inherited from AtemCommandSenderMixin<Promise<void>, typeof BasicAtem>(BasicAtem).removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event, fn?, context?, once?): Atem
Remove the listeners of a given event.
Type Parameters
- T extends keyof AtemEvents
Parameters
- event: T
- Optional fn: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: ArgumentMap<AtemEvents>[Extract<T, keyof AtemEvents>]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns Atem
Inherited from AtemCommandSenderMixin<Promise<void>, typeof BasicAtem>(BasicAtem).removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

requestDisplayClockTime

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

requestRecordingDuration

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

requestStreamingDuration

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

requestTime

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

runUpstreamKeyerFlyKeyTo

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

runUpstreamKeyerFlyKeyToInfinite

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

saveStartupState

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

sendCommand

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

sendCommands

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

sendUnprioritizedCommands

sendUnprioritizedCommands(commands): Promise<void>
Parameters
- commands: ISerializableCommand[]
Returns Promise<void>
Inherited from AtemCommandSenderMixin<Promise<void>, typeof BasicAtem>(BasicAtem).sendUnprioritizedCommands
- Defined in src/atem.ts:349

setAuxSource

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

setClassicAudioMixerHeadphonesProps

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

setClassicAudioMixerInputProps

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

setClassicAudioMixerMasterProps

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

setClassicAudioMixerMonitorProps

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

setClassicAudioMixerProps

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

setClassicAudioResetPeaks

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

setColorGeneratorColour

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

setDVETransitionSettings

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

setDipTransitionSettings

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

setDisplayClockProperties

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

setDisplayClockState

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

setDownstreamKeyCutSource

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

setDownstreamKeyFillSource

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

setDownstreamKeyGeneralProperties

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

setDownstreamKeyMaskSettings

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

setDownstreamKeyOnAir

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

setDownstreamKeyRate

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

setDownstreamKeyTie

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

setEnableISORecording

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

setFadeToBlackRate

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

setFairlightAudioMixerInputProps

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

setFairlightAudioMixerMasterCompressorProps

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

setFairlightAudioMixerMasterDynamicsReset

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

setFairlightAudioMixerMasterEqualizerBandProps

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

setFairlightAudioMixerMasterEqualizerReset

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

setFairlightAudioMixerMasterLimiterProps

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

setFairlightAudioMixerMasterProps

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

setFairlightAudioMixerMonitorProps

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

setFairlightAudioMixerMonitorSolo

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

setFairlightAudioMixerResetPeaks

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

setFairlightAudioMixerSourceCompressorProps

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

setFairlightAudioMixerSourceDynamicsReset

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

setFairlightAudioMixerSourceEqualizerBandProps

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

setFairlightAudioMixerSourceEqualizerReset

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

setFairlightAudioMixerSourceExpanderProps

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

setFairlightAudioMixerSourceLimiterProps

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

setFairlightAudioMixerSourceProps

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

setFairlightAudioMixerSourceResetPeaks

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

setFairlightAudioRoutingOutputProperties

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

setFairlightAudioRoutingSourceProperties

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

setInputSettings

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

setMediaClip

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

setMediaPlayerSettings

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

setMediaPlayerSource

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

setMediaPoolSettings

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

setMixTransitionSettings

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

setMultiViewerBorderColor

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

setMultiViewerProperties

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

setMultiViewerVuOpacity

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

setMultiViewerWindowOverlayProperties

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

setMultiViewerWindowSafeAreaEnabled

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

setMultiViewerWindowSafeAreaPattern

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

setMultiViewerWindowSource

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

setMultiViewerWindowVuEnabled

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

setMultiviewerFontFace

setMultiviewerFontFace(font): Promise<void>
Set the font to use for the multiviewer, or reset to default
Parameters
- font: null | string | FontFace
Returns Promise<void>
- Defined in src/atem.ts:379

setMultiviewerFontScale

setMultiviewerFontScale(scale): void
Set the scale factor for the multiviewer text. Default is 1
Parameters
- scale: null | number
Returns void
- Defined in src/atem.ts:396

setRecordingSettings

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

setStingerTransitionSettings

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

setStreamingAudioBitrates

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

setStreamingService

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

setSuperSourceBorder

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

setSuperSourceBoxBorder

setSuperSourceBoxBorder(newProps, box?, ssrcId?): Promise<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 Promise<void>
Inherited from AtemCommandSenderMixin<Promise<void>, typeof BasicAtem>(BasicAtem).setSuperSourceBoxBorder
- Defined in src/lib/atemCommands.ts:370

setSuperSourceBoxSettings

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

setSuperSourceProperties

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

setTime

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

setTimeMode

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

setTransitionPosition

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

setTransitionStyle

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

setUpstreamKeyerAdvancedChromaProperties

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

setUpstreamKeyerAdvancedChromaSample

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

setUpstreamKeyerAdvancedChromaSampleReset

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

setUpstreamKeyerChromaSettings

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

setUpstreamKeyerCutSource

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

setUpstreamKeyerDVESettings

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

setUpstreamKeyerFillSource

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

setUpstreamKeyerFlyKeyKeyframe

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

setUpstreamKeyerLumaSettings

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

setUpstreamKeyerMaskSettings

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

setUpstreamKeyerOnAir

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

setUpstreamKeyerPatternSettings

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

setUpstreamKeyerType

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

setWipeTransitionSettings

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

startFairlightMixerSendLevels

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

startRecording

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

startStreaming

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

stopFairlightMixerSendLevels

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

stopRecording

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

stopStreaming

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

storeUpstreamKeyerFlyKeyKeyframe

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

switchRecordingDisk

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

uploadAudio

uploadAudio(index, data, name): Promise<void>
Upload clip audio to the ATEM media pool
Parameters
- index: number
  
  Clip index to upload to
- data: Buffer
  
  stereo 48khz 24bit WAV audio data
- name: string
  
  Name to give the uploaded audio
Returns Promise<void>
Promise which resolves once the clip audio is uploaded
- Defined in src/atem.ts:547

uploadClip

uploadClip(index, frames, name, options?): Promise<void>
Upload a clip to the ATEM media pool

Note: This performs colour conversions in JS, which is not very CPU efficient. If performance is important, consider using @atem-connection/image-tools to pre-convert the images with more optimal algorithms
Parameters
- index: number
  
  Clip index to upload to
- frames: Iterable<UploadBufferInfo> | AsyncIterable<UploadBufferInfo> | Iterable<Buffer> | AsyncIterable<Buffer>
  
  Array or generator of frames. Each frame can be a RGBA pixel buffer, or an already YUVA encoded image
- name: string
  
  Name to give the uploaded clip
- Optional options: UploadStillEncodingOptions
  
  Upload options
Returns Promise<void>
Promise which resolves once the clip is uploaded
- Defined in src/atem.ts:522

uploadMacro

uploadMacro(index, name, data): Promise<void>
Parameters
- index: number
- name: string
- data: Buffer
Returns Promise<void>
- Defined in src/atem.ts:408

uploadStill

uploadStill(index, data, name, description, options?): Promise<void>
Upload a still image to the ATEM media pool

Note: This performs colour conversions in JS, which is not very CPU efficient. If performance is important, consider using @atem-connection/image-tools to pre-convert the images with more optimal algorithms
Parameters
- index: number
  
  Still index to upload to
- data: Buffer | UploadBufferInfo
  
  a RGBA pixel buffer, or an already YUVA encoded image
- name: string
  
  Name to give the uploaded image
- description: string
  
  Description for the uploaded image
- Optional options: UploadStillEncodingOptions
  
  Upload options
Returns Promise<void>
Promise which resolves once the image is uploaded
- Defined in src/atem.ts:494

writeMultiviewerLabel

writeMultiviewerLabel(inputId, buffer): Promise<void>
Write a custom multiviewer label buffer
Parameters
- inputId: number
  
  The input id
- buffer: Buffer
  
  Label buffer
Returns Promise<void>
Promise that resolves once upload is complete
- Defined in src/atem.ts:569

Class Atem

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: AtemOptions

Returns Atem

Properties

Readonly apiVersion

Static prefixed

Accessors

Protected dataTransferManager

Returns DataTransferManager

state

Returns undefined | Readonly<AtemState>

status

Returns AtemConnectionStatus

videoMode

Returns undefined | Readonly<VideoModeInfo>

Methods

addListener

Type Parameters

T extends keyof AtemEvents

Parameters

event: T

fn: ((...args) => void)

Parameters

Rest ...args: ArgumentMap<AtemEvents>[Extract<T, keyof AtemEvents>]

Returns void

Optional context: any

Returns Atem

autoDownstreamKey

Parameters

key: number = 0

Optional isTowardsOnAir: boolean

Returns Promise<void>

autoTransition

Parameters

me: number = 0

Returns Promise<void>

captureMediaPoolStill

Returns Promise<void>

changePreviewInput

Parameters

input: number

me: number = 0

Returns Promise<void>

changeProgramInput

Parameters

input: number

me: number = 0

Returns Promise<void>

clearMediaPoolClip

Parameters

clipId: number

Returns Promise<void>

clearMediaPoolStill

Parameters

stillId: number

Returns Promise<void>

clearStartupState

Returns Promise<void>

connect

Parameters

address: string

Optional port: number

Returns Promise<void>

createCommandBatch

Returns AtemCommandBatch

cut

Parameters

me: number = 0

Returns Promise<void>

destroy

Returns Promise<void>

`Optional` options: AtemOptions

`Readonly` apiVersion

`Static` prefixed

`Protected` dataTransferManager

`Rest` ...args: ArgumentMap<AtemEvents>[Extract<T, keyof AtemEvents>]

`Optional` context: any

`Optional` isTowardsOnAir: boolean

`Optional` port: number

`Rest` ...args: ArgumentMap<AtemEvents>[Extract<T, keyof AtemEvents>]