Class Atem

Hierarchy

BasicAtem
- Atem

Index

Methods

Constructors

constructor

new Atem(options?): Atem
Parameters
- Optional options: AtemOptions
Returns Atem
Overrides BasicAtem.constructor
- Defined in src/atem.ts:292

Properties

`Protected` `Readonly` dataTransferManager

dataTransferManager: DataTransferManager

Accessors

state

get state(): undefined | Readonly<AtemState>
Returns undefined | Readonly<AtemState>
Inherited from BasicAtem.state
- Defined in src/atem.ts:148

status

get status(): AtemConnectionStatus
Returns AtemConnectionStatus
Inherited from BasicAtem.status
- Defined in src/atem.ts:144

videoMode

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

Returns undefined | Readonly<VideoModeInfo>
Inherited from BasicAtem.videoMode
- Defined in src/atem.ts:155

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 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>
- Defined in src/atem.ts:358

autoTransition

autoTransition(me?): Promise<void>
Parameters
- me: number = 0
Returns Promise<void>
- Defined in src/atem.ts:343

captureMediaPoolStill

captureMediaPoolStill(): Promise<void>
Returns Promise<void>
- Defined in src/atem.ts:581

changePreviewInput

changePreviewInput(input, me?): Promise<void>
Parameters
- input: number
- me: number = 0
Returns Promise<void>
- Defined in src/atem.ts:333

changeProgramInput

changeProgramInput(input, me?): Promise<void>
Parameters
- input: number
- me: number = 0
Returns Promise<void>
- Defined in src/atem.ts:328

clearMediaPoolClip

clearMediaPoolClip(clipId): Promise<void>
Parameters
- clipId: number
Returns Promise<void>
- Defined in src/atem.ts:571

clearMediaPoolStill

clearMediaPoolStill(stillId): Promise<void>
Parameters
- stillId: number
Returns Promise<void>
- Defined in src/atem.ts:576

clearStartupState

clearStartupState(): Promise<void>
Returns Promise<void>
- Defined in src/atem.ts:1186

connect

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

cut

cut(me?): Promise<void>
Parameters
- me: number = 0
Returns Promise<void>
- Defined in src/atem.ts:338

destroy

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

disconnect

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

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:782

downloadMacro

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

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:818

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:1268

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 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 BasicAtem.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

fadeToBlack

fadeToBlack(me?): Promise<void>
Parameters
- me: number = 0
Returns Promise<void>
- Defined in src/atem.ts:348

hasInternalMultiviewerLabelGeneration

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

listVisibleInputs

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

listenerCount

listenerCount(event): number
Return the number of listeners listening to a given event.
Parameters
- event: keyof AtemEvents
Returns number
Inherited from 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 BasicAtem.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

macroContinue

macroContinue(): Promise<void>
Returns Promise<void>
- Defined in src/atem.ts:466

macroDelete

macroDelete(index?): Promise<void>
Parameters
- index: number = 0
Returns Promise<void>
- Defined in src/atem.ts:471

macroInsertTimedWait

macroInsertTimedWait(frames): Promise<void>
Parameters
- frames: number
Returns Promise<void>
- Defined in src/atem.ts:481

macroInsertUserWait

macroInsertUserWait(): Promise<void>
Returns Promise<void>
- Defined in src/atem.ts:476

macroRun

macroRun(index?): Promise<void>
Parameters
- index: number = 0
Returns Promise<void>
- Defined in src/atem.ts:486

macroSetLoop

macroSetLoop(loop): Promise<void>
Parameters
- loop: boolean
Returns Promise<void>
- Defined in src/atem.ts:512

macroStartRecord

macroStartRecord(index, name, description): Promise<void>
Parameters
- index: number
- name: string
- description: string
Returns Promise<void>
- Defined in src/atem.ts:496

macroStop

macroStop(): Promise<void>
Returns Promise<void>
- Defined in src/atem.ts:491

macroStopRecord

macroStopRecord(): Promise<void>
Returns Promise<void>
- Defined in src/atem.ts:501

macroUpdateProperties

macroUpdateProperties(props, index?): Promise<void>
Parameters
- props: Readonly<Partial<OmitReadonly<MacroPropertiesState>>>
- index: number = 0
Returns Promise<void>
- Defined in src/atem.ts:506

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 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 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 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>
- Defined in src/atem.ts:386

removeAllListeners

removeAllListeners(event?): Atem
Remove all listeners, or those of the specified event.
Parameters
- Optional event: keyof AtemEvents
Returns Atem
Inherited from 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 BasicAtem.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

requestDisplayClockTime

requestDisplayClockTime(): Promise<void>
Returns Promise<void>
- Defined in src/atem.ts:1204

requestRecordingDuration

requestRecordingDuration(): Promise<void>
Returns Promise<void>
- Defined in src/atem.ts:1161

requestStreamingDuration

requestStreamingDuration(): Promise<void>
Returns Promise<void>
- Defined in src/atem.ts:1135

requestTime

requestTime(): Promise<void>
Returns Promise<void>
- Defined in src/atem.ts:461

runUpstreamKeyerFlyKeyTo

runUpstreamKeyerFlyKeyTo(mixEffect, upstreamKeyerId, keyFrameId): Promise<void>
Parameters
- mixEffect: number
- upstreamKeyerId: number
- keyFrameId: A | B | Full
Returns Promise<void>
- Defined in src/atem.ts:721

runUpstreamKeyerFlyKeyToInfinite

runUpstreamKeyerFlyKeyToInfinite(mixEffect, upstreamKeyerId, direction): Promise<void>
Parameters
- mixEffect: number
- upstreamKeyerId: number
- direction: FlyKeyDirection
Returns Promise<void>
- Defined in src/atem.ts:729

saveStartupState

saveStartupState(): Promise<void>
Returns Promise<void>
- Defined in src/atem.ts:1182

sendCommand

sendCommand(command): Promise<void>
Parameters
- command: ISerializableCommand
Returns Promise<void>
Inherited from BasicAtem.sendCommand
- Defined in src/atem.ts:193

sendCommands

sendCommands(commands): Promise<void>
Parameters
- commands: ISerializableCommand[]
Returns Promise<void>
Inherited from BasicAtem.sendCommands
- Defined in src/atem.ts:174

setAuxSource

setAuxSource(source, bus?): Promise<void>
Parameters
- source: number
- bus: number = 0
Returns Promise<void>
- Defined in src/atem.ts:409

setClassicAudioMixerHeadphonesProps

setClassicAudioMixerHeadphonesProps(props): Promise<void>
Parameters
- props: Partial<ClassicAudioHeadphoneOutputChannel>
Returns Promise<void>
- Defined in src/atem.ts:931

setClassicAudioMixerInputProps

setClassicAudioMixerInputProps(index, props): Promise<void>
Parameters
- index: number
- props: Partial<OmitReadonly<ClassicAudioChannel>>
Returns Promise<void>
- Defined in src/atem.ts:910

setClassicAudioMixerMasterProps

setClassicAudioMixerMasterProps(props): Promise<void>
Parameters
- props: Partial<ClassicAudioMasterChannel>
Returns Promise<void>
- Defined in src/atem.ts:919

setClassicAudioMixerMonitorProps

setClassicAudioMixerMonitorProps(props): Promise<void>
Parameters
- props: Partial<ClassicAudioMonitorChannel>
Returns Promise<void>
- Defined in src/atem.ts:925

setClassicAudioMixerProps

setClassicAudioMixerProps(props): Promise<void>
Parameters
- props: Readonly<{
  audioFollowVideo: boolean;
  }>
Returns Promise<void>
- Defined in src/atem.ts:945

setClassicAudioResetPeaks

setClassicAudioResetPeaks(props): Promise<void>
Parameters
- props: Partial<ClassicAudioResetPeaks>
Returns Promise<void>
- Defined in src/atem.ts:939

setColorGeneratorColour

setColorGeneratorColour(newProps, index?): Promise<void>
Parameters
- newProps: Partial<ColorGeneratorState>
- index: number = 0
Returns Promise<void>
- Defined in src/atem.ts:548

setDVETransitionSettings

setDVETransitionSettings(newProps, me?): Promise<void>
Parameters
- newProps: Partial<DVETransitionSettings>
- me: number = 0
Returns Promise<void>
- Defined in src/atem.ts:370

setDipTransitionSettings

setDipTransitionSettings(newProps, me?): Promise<void>
Parameters
- newProps: Partial<DipTransitionSettings>
- me: number = 0
Returns Promise<void>
- Defined in src/atem.ts:364

setDisplayClockProperties

setDisplayClockProperties(props): Promise<void>
Parameters
- props: Partial<DisplayClockPropertiesExt>
Returns Promise<void>
- Defined in src/atem.ts:1214

setDisplayClockState

setDisplayClockState(state): Promise<void>
Parameters
- state: DisplayClockClockState
Returns Promise<void>
- Defined in src/atem.ts:1209

setDownstreamKeyCutSource

setDownstreamKeyCutSource(input, key?): Promise<void>
Parameters
- input: number
- key: number = 0
Returns Promise<void>
- Defined in src/atem.ts:424

setDownstreamKeyFillSource

setDownstreamKeyFillSource(input, key?): Promise<void>
Parameters
- input: number
- key: number = 0
Returns Promise<void>
- Defined in src/atem.ts:429

setDownstreamKeyGeneralProperties

setDownstreamKeyGeneralProperties(props, key?): Promise<void>
Parameters
- props: Partial<DownstreamKeyerGeneral>
- key: number = 0
Returns Promise<void>
- Defined in src/atem.ts:434

setDownstreamKeyMaskSettings

setDownstreamKeyMaskSettings(props, key?): Promise<void>
Parameters
- props: Partial<DownstreamKeyerMask>
- key: number = 0
Returns Promise<void>
- Defined in src/atem.ts:440

setDownstreamKeyOnAir

setDownstreamKeyOnAir(onAir, key?): Promise<void>
Parameters
- onAir: boolean
- key: number = 0
Returns Promise<void>
- Defined in src/atem.ts:419

setDownstreamKeyRate

setDownstreamKeyRate(rate, key?): Promise<void>
Parameters
- rate: number
- key: number = 0
Returns Promise<void>
- Defined in src/atem.ts:446

setDownstreamKeyTie

setDownstreamKeyTie(tie, key?): Promise<void>
Parameters
- tie: boolean
- key: number = 0
Returns Promise<void>
- Defined in src/atem.ts:414

setEnableISORecording

setEnableISORecording(enabled): Promise<void>
Parameters
- enabled: boolean
Returns Promise<void>
- Defined in src/atem.ts:1177

setFadeToBlackRate

setFadeToBlackRate(rate, me?): Promise<void>
Parameters
- rate: number
- me: number = 0
Returns Promise<void>
- Defined in src/atem.ts:353

setFairlightAudioMixerInputProps

setFairlightAudioMixerInputProps(index, props): Promise<void>
Parameters
- index: number
- props: Readonly<Partial<Omit<OmitReadonly<FairlightAudioInputProperties>, "activeInputLevel"> & {
  rcaToXlrEnabled: boolean;
  }>>
Returns Promise<void>
- Defined in src/atem.ts:1030

setFairlightAudioMixerMasterCompressorProps

setFairlightAudioMixerMasterCompressorProps(props): Promise<void>
Parameters
- props: Partial<OmitReadonly<FairlightAudioCompressorState>>
Returns Promise<void>
- Defined in src/atem.ts:958

setFairlightAudioMixerMasterDynamicsReset

setFairlightAudioMixerMasterDynamicsReset(props): Promise<void>
Parameters
- props: Partial<FairlightDynamicsResetProps>
Returns Promise<void>
- Defined in src/atem.ts:991

setFairlightAudioMixerMasterEqualizerBandProps

setFairlightAudioMixerMasterEqualizerBandProps(band, props): Promise<void>
Parameters
- band: number
- props: Partial<OmitReadonly<FairlightAudioEqualizerBandState>>
Returns Promise<void>
- Defined in src/atem.ts:974

setFairlightAudioMixerMasterEqualizerReset

setFairlightAudioMixerMasterEqualizerReset(props): Promise<void>
Parameters
- props: Partial<Readonly<Partial<{
  band: number;
  equalizer: boolean;
  }>>>
Returns Promise<void>
- Defined in src/atem.ts:983

setFairlightAudioMixerMasterLimiterProps

setFairlightAudioMixerMasterLimiterProps(props): Promise<void>
Parameters
- props: Partial<OmitReadonly<FairlightAudioLimiterState>>
Returns Promise<void>
- Defined in src/atem.ts:966

setFairlightAudioMixerMasterProps

setFairlightAudioMixerMasterProps(props): Promise<void>
Parameters
- props: Partial<FairlightMixerMasterCommandProperties>
Returns Promise<void>
- Defined in src/atem.ts:950

setFairlightAudioMixerMonitorProps

setFairlightAudioMixerMonitorProps(props): Promise<void>
Parameters
- props: Partial<OmitReadonly<FairlightAudioMonitorChannel>>
Returns Promise<void>
- Defined in src/atem.ts:1014

setFairlightAudioMixerMonitorSolo

setFairlightAudioMixerMonitorSolo(props): Promise<void>
Parameters
- props: Partial<OmitReadonly<FairlightAudioMonitorSolo>>
Returns Promise<void>
- Defined in src/atem.ts:1022

setFairlightAudioMixerResetPeaks

setFairlightAudioMixerResetPeaks(props): Promise<void>
Parameters
- props: Readonly<{
  all: boolean;
  master: boolean;
  }>
Returns Promise<void>
- Defined in src/atem.ts:997

setFairlightAudioMixerSourceCompressorProps

setFairlightAudioMixerSourceCompressorProps(index, source, props): Promise<void>
Parameters
- index: number
- source: string
- props: Partial<OmitReadonly<FairlightAudioCompressorState>>
Returns Promise<void>
- Defined in src/atem.ts:1055

setFairlightAudioMixerSourceDynamicsReset

setFairlightAudioMixerSourceDynamicsReset(index, source, props): Promise<void>
Parameters
- index: number
- source: string
- props: Partial<FairlightDynamicsResetProps>
Returns Promise<void>
- Defined in src/atem.ts:1096

setFairlightAudioMixerSourceEqualizerBandProps

setFairlightAudioMixerSourceEqualizerBandProps(index, source, band, props): Promise<void>
Parameters
- index: number
- source: string
- band: number
- props: Partial<OmitReadonly<FairlightAudioEqualizerBandState>>
Returns Promise<void>
- Defined in src/atem.ts:1085

setFairlightAudioMixerSourceEqualizerReset

setFairlightAudioMixerSourceEqualizerReset(index, source, props): Promise<void>
Parameters
- index: number
- source: string
- props: Partial<Readonly<Partial<{
  band: number;
  equalizer: boolean;
  }>>>
Returns Promise<void>
- Defined in src/atem.ts:1106

setFairlightAudioMixerSourceExpanderProps

setFairlightAudioMixerSourceExpanderProps(index, source, props): Promise<void>
Parameters
- index: number
- source: string
- props: Partial<OmitReadonly<FairlightAudioExpanderState>>
Returns Promise<void>
- Defined in src/atem.ts:1075

setFairlightAudioMixerSourceLimiterProps

setFairlightAudioMixerSourceLimiterProps(index, source, props): Promise<void>
Parameters
- index: number
- source: string
- props: Partial<OmitReadonly<FairlightAudioLimiterState>>
Returns Promise<void>
- Defined in src/atem.ts:1065

setFairlightAudioMixerSourceProps

setFairlightAudioMixerSourceProps(index, source, props): Promise<void>
Parameters
- index: number
- source: string
- props: Readonly<Partial<OmitReadonly<FairlightMixerSourceCommandProperties>>>
Returns Promise<void>
- Defined in src/atem.ts:1045

setFairlightAudioMixerSourceResetPeaks

setFairlightAudioMixerSourceResetPeaks(index, source, props): Promise<void>
Parameters
- index: number
- source: string
- props: Readonly<{
      dynamicsInput: boolean;
      dynamicsOutput: boolean;
      output: boolean;
  }>
Returns Promise<void>
- Defined in src/atem.ts:1116

setFairlightAudioRoutingOutputProperties

setFairlightAudioRoutingOutputProperties(sourceId, props): Promise<void>
Parameters
- sourceId: number
- props: Partial<OmitReadonly<FairlightAudioRoutingOutput>>
Returns Promise<void>
- Defined in src/atem.ts:1229

setFairlightAudioRoutingSourceProperties

setFairlightAudioRoutingSourceProperties(sourceId, props): Promise<void>
Parameters
- sourceId: number
- props: Partial<OmitReadonly<FairlightAudioRoutingSource>>
Returns Promise<void>
- Defined in src/atem.ts:1220

setInputSettings

setInputSettings(newProps, input?): Promise<void>
Parameters
- newProps: Partial<OmitReadonly<InputChannel>>
- input: number = 0
Returns Promise<void>
- Defined in src/atem.ts:623

setMediaClip

setMediaClip(index, name, frames?): Promise<void>
Parameters
- index: number
- name: string
- frames: number = 1
Returns Promise<void>
- Defined in src/atem.ts:566

setMediaPlayerSettings

setMediaPlayerSettings(newProps, player?): Promise<void>
Parameters
- newProps: Partial<MediaPlayer>
- player: number = 0
Returns Promise<void>
- Defined in src/atem.ts:554

setMediaPlayerSource

setMediaPlayerSource(newProps, player?): Promise<void>
Parameters
- newProps: Partial<MediaPlayerSource>
- player: number = 0
Returns Promise<void>
- Defined in src/atem.ts:560

setMediaPoolSettings

setMediaPoolSettings(props): Promise<void>
Parameters
- props: MediaPoolProps
Returns Promise<void>
- Defined in src/atem.ts:1199

setMixTransitionSettings

setMixTransitionSettings(newProps, me?): Promise<void>
Parameters
- newProps: Pick<MixTransitionSettings, "rate">
- me: number = 0
Returns Promise<void>
- Defined in src/atem.ts:376

setMultiViewerProperties

setMultiViewerProperties(props, mv?): Promise<void>
Parameters
- props: Partial<MultiViewerPropertiesState>
- mv: number = 0
Returns Promise<void>
- Defined in src/atem.ts:542

setMultiViewerVuOpacity

setMultiViewerVuOpacity(opacity, mv?): Promise<void>
Parameters
- opacity: number
- mv: number = 0
Returns Promise<void>
- Defined in src/atem.ts:538

setMultiViewerWindowSafeAreaEnabled

setMultiViewerWindowSafeAreaEnabled(safeAreaEnabled, mv?, window?): Promise<void>
Parameters
- safeAreaEnabled: boolean
- mv: number = 0
- window: number = 0
Returns Promise<void>
- Defined in src/atem.ts:529

setMultiViewerWindowSource

setMultiViewerWindowSource(source, mv?, window?): Promise<void>
Parameters
- source: number
- mv: number = 0
- window: number = 0
Returns Promise<void>
- Defined in src/atem.ts:525

setMultiViewerWindowVuEnabled

setMultiViewerWindowVuEnabled(vuEnabled, mv?, window?): Promise<void>
Parameters
- vuEnabled: boolean
- mv: number = 0
- window: number = 0
Returns Promise<void>
- Defined in src/atem.ts:533

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:302

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:319

setRecordingSettings

setRecordingSettings(props): Promise<void>
Parameters
- props: Partial<RecordingStateProperties>
Returns Promise<void>
- Defined in src/atem.ts:1171

setStingerTransitionSettings

setStingerTransitionSettings(newProps, me?): Promise<void>
Parameters
- newProps: Partial<StingerTransitionSettings>
- me: number = 0
Returns Promise<void>
- Defined in src/atem.ts:397

setStreamingAudioBitrates

setStreamingAudioBitrates(lowBitrate, highBitrate): Promise<void>
Parameters
- lowBitrate: number
- highBitrate: number
Returns Promise<void>
- Defined in src/atem.ts:1146

setStreamingService

setStreamingService(props): Promise<void>
Parameters
- props: Partial<StreamingServiceProperties>
Returns Promise<void>
- Defined in src/atem.ts:1140

setSuperSourceBorder

setSuperSourceBorder(newProps, ssrcId?): Promise<void>
Parameters
- newProps: Partial<SuperSourceBorder>
- ssrcId: number = 0
Returns Promise<void>
- Defined in src/atem.ts:611

setSuperSourceBoxSettings

setSuperSourceBoxSettings(newProps, box?, ssrcId?): Promise<void>
Parameters
- newProps: Partial<SuperSourceBox>
- box: number = 0
- ssrcId: number = 0
Returns Promise<void>
- Defined in src/atem.ts:586

setSuperSourceProperties

setSuperSourceProperties(newProps, ssrcId?): Promise<void>
Parameters
- newProps: Partial<SuperSourceProperties>
- ssrcId: number = 0
Returns Promise<void>
- Defined in src/atem.ts:596

setTime

setTime(hour, minute, second, frame): Promise<void>
Parameters
- hour: number
- minute: number
- second: number
- frame: number
Returns Promise<void>
- Defined in src/atem.ts:451

setTimeMode

setTimeMode(mode): Promise<void>
Parameters
- mode: TimeMode
Returns Promise<void>
- Defined in src/atem.ts:456

setTransitionPosition

setTransitionPosition(position, me?): Promise<void>
Parameters
- position: number
- me: number = 0
Returns Promise<void>
- Defined in src/atem.ts:381

setTransitionStyle

setTransitionStyle(newProps, me?): Promise<void>
Parameters
- newProps: Partial<OmitReadonly<TransitionProperties>>
- me: number = 0
Returns Promise<void>
- Defined in src/atem.ts:391

setUpstreamKeyerAdvancedChromaProperties

setUpstreamKeyerAdvancedChromaProperties(newProps, me?, keyer?): Promise<void>
Parameters
- newProps: Partial<UpstreamKeyerAdvancedChromaProperties>
- me: number = 0
- keyer: number = 0
Returns Promise<void>
- Defined in src/atem.ts:639

setUpstreamKeyerAdvancedChromaSample

setUpstreamKeyerAdvancedChromaSample(newProps, me?, keyer?): Promise<void>
Parameters
- newProps: Partial<UpstreamKeyerAdvancedChromaSample>
- me: number = 0
- keyer: number = 0
Returns Promise<void>
- Defined in src/atem.ts:648

setUpstreamKeyerAdvancedChromaSampleReset

setUpstreamKeyerAdvancedChromaSampleReset(flags, me?, keyer?): Promise<void>
Parameters
- flags: AdvancedChromaSampleResetProps
- me: number = 0
- keyer: number = 0
Returns Promise<void>
- Defined in src/atem.ts:657

setUpstreamKeyerChromaSettings

setUpstreamKeyerChromaSettings(newProps, me?, keyer?): Promise<void>
Parameters
- newProps: Partial<UpstreamKeyerChromaSettings>
- me: number = 0
- keyer: number = 0
Returns Promise<void>
- Defined in src/atem.ts:629

setUpstreamKeyerCutSource

setUpstreamKeyerCutSource(cutSource, me?, keyer?): Promise<void>
Parameters
- cutSource: number
- me: number = 0
- keyer: number = 0
Returns Promise<void>
- Defined in src/atem.ts:666

setUpstreamKeyerDVESettings

setUpstreamKeyerDVESettings(newProps, me?, keyer?): Promise<void>
Parameters
- newProps: Partial<UpstreamKeyerDVESettings>
- me: number = 0
- keyer: number = 0
Returns Promise<void>
- Defined in src/atem.ts:676

setUpstreamKeyerFillSource

setUpstreamKeyerFillSource(fillSource, me?, keyer?): Promise<void>
Parameters
- fillSource: number
- me: number = 0
- keyer: number = 0
Returns Promise<void>
- Defined in src/atem.ts:671

setUpstreamKeyerFlyKeyKeyframe

setUpstreamKeyerFlyKeyKeyframe(mixEffect, upstreamKeyerId, keyframe, properties): Promise<void>
Parameters
- mixEffect: number
- upstreamKeyerId: number
- keyframe: number
- properties: Partial<Omit<UpstreamKeyerFlyKeyframe, "keyFrameId">>
Returns Promise<void>
- Defined in src/atem.ts:750

setUpstreamKeyerLumaSettings

setUpstreamKeyerLumaSettings(newProps, me?, keyer?): Promise<void>
Parameters
- newProps: Partial<UpstreamKeyerLumaSettings>
- me: number = 0
- keyer: number = 0
Returns Promise<void>
- Defined in src/atem.ts:686

setUpstreamKeyerMaskSettings

setUpstreamKeyerMaskSettings(newProps, me?, keyer?): Promise<void>
Parameters
- newProps: Partial<UpstreamKeyerMaskSettings>
- me: number = 0
- keyer: number = 0
Returns Promise<void>
- Defined in src/atem.ts:696

setUpstreamKeyerOnAir

setUpstreamKeyerOnAir(onAir, me?, keyer?): Promise<void>
Parameters
- onAir: boolean
- me: number = 0
- keyer: number = 0
Returns Promise<void>
- Defined in src/atem.ts:716

setUpstreamKeyerPatternSettings

setUpstreamKeyerPatternSettings(newProps, me?, keyer?): Promise<void>
Parameters
- newProps: Partial<UpstreamKeyerPatternSettings>
- me: number = 0
- keyer: number = 0
Returns Promise<void>
- Defined in src/atem.ts:706

setUpstreamKeyerType

setUpstreamKeyerType(newProps, me?, keyer?): Promise<void>
Parameters
- newProps: Partial<UpstreamKeyerTypeSettings>
- me: number = 0
- keyer: number = 0
Returns Promise<void>
- Defined in src/atem.ts:761

setWipeTransitionSettings

setWipeTransitionSettings(newProps, me?): Promise<void>
Parameters
- newProps: Partial<WipeTransitionSettings>
- me: number = 0
Returns Promise<void>
- Defined in src/atem.ts:403

startFairlightMixerSendLevels

startFairlightMixerSendLevels(): Promise<void>
Returns Promise<void>
- Defined in src/atem.ts:1004

startRecording

startRecording(): Promise<void>
Returns Promise<void>
- Defined in src/atem.ts:1151

startStreaming

startStreaming(): Promise<void>
Returns Promise<void>
- Defined in src/atem.ts:1125

stopFairlightMixerSendLevels

stopFairlightMixerSendLevels(): Promise<void>
Returns Promise<void>
- Defined in src/atem.ts:1009

stopRecording

stopRecording(): Promise<void>
Returns Promise<void>
- Defined in src/atem.ts:1156

stopStreaming

stopStreaming(): Promise<void>
Returns Promise<void>
- Defined in src/atem.ts:1130

storeUpstreamKeyerFlyKeyKeyframe

storeUpstreamKeyerFlyKeyKeyframe(mixEffect, upstreamKeyerId, keyframe): Promise<void>
Parameters
- mixEffect: number
- upstreamKeyerId: number
- keyframe: number
Returns Promise<void>
- Defined in src/atem.ts:742

switchRecordingDisk

switchRecordingDisk(): Promise<void>
Returns Promise<void>
- Defined in src/atem.ts:1166

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:906

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:881

uploadMacro

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

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:853

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:1248

Class Atem

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: AtemOptions

Returns Atem

Properties

Protected Readonly dataTransferManager

Accessors

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>

cut

Parameters

me: number = 0

Returns Promise<void>

destroy

Returns Promise<void>

disconnect

Returns Promise<void>

downloadClipFrame

Parameters

clipIndex: number

`Optional` options: AtemOptions

`Protected` `Readonly` 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>]