The atem member in ATEMMax is an ATEMProtocol object, containing constant value definitions for the ATEM protocol.

>>> print(switcher.atem.UDPPort.value)
9910
>>> print(switcher.atem.videoSources.mediaPlayer1.value)
3010
>>> print(switcher.atem.videoModeFormats.f1080p50.value)
12

Value enumerations

A lot of efforts have been put into making the library Intellisense friendly and helping the library user with the overwhelming amount of setting values you can find in the protocol.

Instead of using numbers extracted from the ATEM Potocol to identify cameras, videoSources, etc… you can use things like:

  • Video sources
    • switcher.atem.videoSources.input1
    • switcher.atem.videoSources.colorBars
    • switcher.atem.videoSources.mediaPlayer1
  • Audio sources
    • switcher.atem.audioSources.input1
    • switcher.atem.audioSources.xlr
    • switcher.atem.audioSources.mic1
  • Video mode formats
    • switcher.atem.videoModeFormats.f525i59_94_ntsc_16_9
    • switcher.atem.videoModeFormats.f720p50
    • switcher.atem.videoModeFormats.f1080p50
  • Down converter modes
    • switcher.atem.downConverterModes.centerCut
    • switcher.atem.downConverterModes.letterBox
    • switcher.atem.downConverterModes.anamorphic

As you start typing the collection name, your editor should show you a list of valid value names.

ATEMConstant

All these protocol values are stored as ATEMConstant objects.

  • An ATEMConstant object consists of a name and a value.
  • If you print an ATEMConstant you will get its name (string)
  • If you want to get the raw numeric value, use ATEMConstant.value

With these ATEMConstants you can choose how you want to provide parameters for methods:

  • Using the provided protocol constants
switcher.setProgramInputVideoSource(switcher.atem.mixEffects.mixEffect1, switcher.atem.videoSources.mediaPlayer1)
  • Using ATEM protocol integer values
switcher.setProgramInputVideoSource(0, 3010)
  • Using strings representing the values in the respective lists
switcher.setProgramInputVideoSource("mixEffect1", "mediaPlayer1")

It works the same way when getting data values:

  • Using the provided protocol constants
switcher.programInput[switcher.atem.mixEffects.mixEffect1].videoSource
  • Using ATEM protocol integer values
switcher.programInput[0].videoSource
  • Using strings representing the values in the respective lists
switcher.programInput["mixEffect1"].videoSource

Note about enumerated values

In the following value lists there are some enumerated values, like: switcher.atem.videoSources.input1 … switcher.atem.videoSources.input40

Please keep in mind that the associated numeric value does not need to be the same as the number in the value name.

As an example, you can see some values match:

  • switcher.atem.videoSources.input1 == 1
  • switcher.atem.cameras.camera1 == 1

While some others don’t:

  • switcher.atem.videoSources.color1 == 2001
  • switcher.atem.videoSources.mediaPlayer1 == 3010
  • switcher.atem.videoSources.key1Mask == 4010
  • switcher.atem.videoSources.dsk1Mask == 5010
  • switcher.atem.videoSources.cleanFeed1 == 7001
  • switcher.atem.videoSources.auxilary1 == 8001
  • switcher.atem.mixEffects.mixEffect1 == 0
  • switcher.atem.multiViewers.multiViewer1 == 0
  • switcher.atem.windows.window1 == 0
  • switcher.atem.keyers.keyer1 == 0
  • switcher.atem.dsks.dsk1 == 0
  • switcher.atem.colorGenerators.colorGenerator1 == 0
  • switcher.atem.auxChannels.auxChannel1 == 0
  • switcher.atem.mediaPlayers.mediaPlayer1 == 0
  • switcher.atem.clipBanks.clipBank1 == 0
  • switcher.atem.stillBanks.stillBank1 == 0
  • switcher.atem.macros.macro1 == 0
  • switcher.atem.boxes.box1 == 0

Value lists

switcher.atem.videoSources (ATEMVideoSources)

  • black
  • input1..40
  • colorBars
  • color1
  • color2
  • mediaPlayer1
  • mediaPlayer1..4Key
  • key1..16Mask
  • dsk1..4Mask
  • superSource
  • superSource2
  • cleanFeed1..4
  • auxilary1..24
  • mE1..4Prog
  • mE1..4Prev
  • input1Direct

switcher.atem.audioSources (ATEMAudioSources)

  • input1..20
  • xlr
  • aes_ebu
  • rca
  • mic1..2
  • mp1..4

switcher.atem.downConverterModes (ATEMDownConverterModes)

  • centerCut
  • letterBox
  • anamorphic

switcher.atem.videoModeFormats (ATEMVideoModeFormats)

  • f525i59_94_ntsc
  • f625i_50_pal
  • f525i59_94_ntsc_16_9
  • f625i_50_pal_16_9
  • f720p50
  • f720p59_94
  • f1080i50
  • f1080i59_94
  • f1080p23_98
  • f1080p24
  • f1080p25
  • f1080p29_97
  • f1080p50
  • f1080p59_94
  • f2160p23_98
  • f2160p24
  • f2160p25
  • f2160p29_97

switcher.atem.externalPortTypes (ATEMExternalPortTypes)

  • internal
  • sdi
  • hdmi
  • composite
  • component
  • sVideo

switcher.atem.switcherPortTypes (ATEMSwitcherPortTypes)

  • external
  • black
  • colorBars
  • colorGenerator
  • mediaPlayerFill
  • mediaPlayerKey
  • superSource
  • externalDirect
  • mEOutput
  • auxiliary
  • mask
  • multiViewer

switcher.atem.multiViewerLayouts (ATEMMultiViewerLayouts)

  • top
  • bottom
  • left
  • right

switcher.atem.transitionStyles (ATEMTransitionStyles)

  • mix
  • dip
  • wipe
  • dVE
  • sting

switcher.atem.keyerTypes (ATEMKeyerTypes)

  • luma
  • chroma
  • pattern
  • dVE

switcher.atem.borderBevels (ATEMBorderBevels)

  • no
  • inOut
  • in_
  • out

switcher.atem.mediaPlayerSourceTypes (ATEMMediaPlayerSourceTypes)

  • still
  • clip

switcher.atem.audioMixerInputTypes (ATEMAudioMixerInputTypes)

  • externalVideo
  • mediaPlayer
  • externalAudio

switcher.atem.audioMixerInputPlugTypes (ATEMAudioMixerInputPlugTypes)

  • internal
  • sdi
  • hdmi
  • component
  • composite
  • sVideo
  • xlr
  • aes_ebu
  • rca

switcher.atem.audioMixerInputMixOptions (ATEMAudioMixerInputMixOptions)

  • off
  • on
  • afv

switcher.atem.dVETransitionStyles (ATEMDVETransitionStyles)

  • swooshTopLeft
  • swooshTop
  • swooshTopRight
  • swooshLeft
  • swooshRight
  • swooshBottomLeft
  • swooshBottom
  • swooshBottomRight
  • spinCCWTopRight
  • spinCWTopLeft
  • spinCCWBottomRight
  • spinCWBottomLeft
  • spinCWTopRight
  • spinCCWTopLeft
  • spinCWBottomRight
  • spinCCWBottomLeft
  • squeezeTopLeft
  • squeezeTop
  • squeezeTopRight
  • squeezeLeft
  • squeezeRight
  • squeezeBottomLeft
  • squeezeBottom
  • squeezeBottomRight
  • pushTopLeft
  • pushTop
  • pushTopRight
  • pushLeft
  • pushRight
  • pushBottomLeft
  • pushBottom
  • pushBottomRight
  • graphicCWSpin
  • graphicCCWSpin
  • graphicLogoWipe

switcher.atem.patternStyles (ATEMPatternStyles)

  • leftToRightBar
  • topToBottomBar
  • horizontalBarnDoor
  • verticalBarnDoor
  • cornersInFourBox
  • rectangleIris
  • diamondIris
  • circleIris
  • topLeftBox
  • topRightBox
  • bottomRightBox
  • bottomLeftBox
  • topCentreBox
  • rightCentreBox
  • bottomCentreBox
  • leftCentreBox
  • topLeftDiagonal
  • topRightDiagonal

switcher.atem.camerControlSharpeningLevels (ATEMCamerControlSharpeningLevels)

  • off
  • low
  • medium
  • high

switcher.atem.macroActions (ATEMMacroActions)

  • runMacro
  • stopMacro
  • stopRecording
  • insertWaitForUser
  • continueMacro
  • deleteMacro

switcher.atem.keyFrames (ATEMKeyFrames)

  • a
  • b
  • full
  • runToInfinite

switcher.atem.mixEffects (ATEMMixEffects)

  • mixEffect1..4

switcher.atem.multiViewers (ATEMMultiViewers)

  • multiViewer1..2

switcher.atem.windows (ATEMWindows)

  • window1..10

switcher.atem.keyers (ATEMKeyers)

  • keyer1..4

switcher.atem.dSKs (ATEMDSKs)

  • dsk1..2

switcher.atem.colorGenerators (ATEMColorGenerators)

  • colorGenerator1..2

switcher.atem.auxChannels (ATEMAuxChannels)

  • auxChannel1..6

switcher.atem.cameras (ATEMCameras)

  • camera1..20

switcher.atem.mediaPlayers (ATEMMediaPlayers)

  • mediaPlayer1..4

switcher.atem.clipBanks (ATEMClipBanks)

  • clipBank1..2

switcher.atem.stillBanks (ATEMStillBanks)

  • stillBank1..32

switcher.atem.macros (ATEMMacros)

  • stop
  • macro1..100

switcher.atem.boxes (ATEMBoxes)

  • box1..4