This is a macOS application, providing an interface to control an ATEM video switcher via OSC.
The current version is built for Mac OS 10.13 (as of version 2.5). A compiled and runnable version of the atemOSC is included which has been built against Blackmagic SDK 7.4 (as of version 2.5.3).
- Go to the releases page
- For the latest version, use the first release. For a version that supports older versions of the Atem SDK, scroll down until you find the release for the version you want.
- Under
Assets, selectatemOSC.dmg - Double-click the downloaded DMG, drag the application to your Applications folder, then launch it from the Launchpad.
AtemOSC is a proxy, listening for commands following the OSC protocol and executing those commands on Blackmagic video switchers. You just have to tell atemOSC where the switcher is and what local port to listen on, and then send commands to the IP address of the computer running atemOSC on port you specified. If you set an outgoing IP address and port, atemOSC will send status updates and feedback OSC messages to the IP address and port you specified.
If you are sending atemOSC messages from a queueing software or translation software on the same computer that atemOSC is running on, make sure to send messages to 127.0.0.1 (localhost) on the port that atemOSC is listening on.
If you are sending atemOSC messages from another device, you will need to send it to the IP address of the computer running atemOSC on the port that atemOSC is listening on. You can find the IP address of a macOS computer by going to System Preferences > Network or by running ifconfig in a terminal window.
- A full overview of the actual OSC-addresses available for your switcher can be obtained from the help-menu inside the application.
- Unless otherwise specified, send the value 1 along with the OSC address below. Sending any other value may result in the command not being processed.
-
Black
/atem/program/0 -
Cam 1
/atem/program/1 -
Cam 2
/atem/program/2 -
Cam 3
/atem/program/3 -
Cam 4
/atem/program/4 -
Cam 5
/atem/program/5 -
Cam 6
/atem/program/6 -
and so on...
-
Color Bars
/atem/program/1000 -
Color 1
/atem/program/2001 -
Color 2
/atem/program/2002 -
Media 1
/atem/program/3010 -
Media 2
/atem/program/3020 -
Key 1 Mask
/atem/program/4010 -
DSK 1 Mask:
/atem/program/5010 -
DSK 2 Mask:
/atem/program/5020 -
Clean Feed 1
/atem/program/7001 -
Clean Feed 2
/atem/program/7002 -
Auxiliary 1
/atem/program/8001 -
and so on...
For preview selection /atem/preview/$i can be used.
Feedback: Enabled for all values
Note: The actual numbers vary greatly from device to device, be sure to check the in-app address menu
- T-bar
/atem/transition/bar <0-1> - Cut
/atem/transition/cut - auto
/atem/transition/auto - fade-to-black
/atem/transition/ftb
To set the transition type of the Auto transition:
- Mix
/atem/transition/set-type/mix - Dip
/atem/transition/set-type/dip - Wipe
/atem/transition/set-type/wipe - Stinger
/atem/transition/set-type/sting - DVE
/atem/transition/set-type/dve
Feedback: None
- Set Aux $i source to $x
/atem/aux/$i $x- Where
$xis an integer value that is a valid program source, and can be 1-6 depending on the capability of your ATEM switcher. Check the Help Menu for the correct values. - e.g.
/atem/aux/1 1to set Aux 1 output to source 1 (Camera 1)
- Where
Feedback: None
- Set Tie BKGD
/atem/usk/0/tie <0|1>- Send a value of 1 to enable tie, and 0 to disable
- Toggle Tie BKGD
/atem/usk/0/tie/toggle - Set On-Air Upstream Keyer $i
/atem/usk/$i/on-air <0|1>- Send a value of 1 to cut the USK on-air, and a value of 0 to cut it off-air
- Cut Toggle On-Air Upstream Keyer $i
/atem/usk/$i/on-air/toggle - Set Tie Upstream Keyer $i
/atem/usk/$i/tie <0|1>- Send a value of 1 to enable tie, and 0 to disable
- Toggle Tie Upstream Keyer $i
/atem/usk/$i/tie/toggle - Set Upstream Keyer $i for Next Scene
/atem/usk/$i/tie/set-next <0|1>- Send a value of 1 to show the USK after next transition, and 0 if you don’t want to show the USK after next transition
- e.g. If USK 1 is on air,
/atem/usk/1/tie/set-next 1will untie USK 1 so that it remains on, while/atem/usk/1/tie/set-next 0will tie USK 1 so that it will go off air after the next transition.
- Set Fill Source for Upstream Keyer $i
/atem/usk/$i/source/fill <int>- Int value should be the ID of the input to set as the source (from in-app help menu, under the Sources section)
- Set Key (cut) Source for Upstream Keyer $i
/atem/usk/$i/source/cut <int>- Int value should be the ID of the input to set as the source (from in-app help menu, under the Sources section)
- Set Clip Luma Parameter for Upstream Keyer $i
/atem/usk/$i/luma/clip <float>- Float value should be between 0.0 (for 0%) and 1.0 (for 100%)
- Set Gain Luma Parameter for Upstream Keyer $i
/atem/usk/$i/luma/gain <float>- Float value should be between 0.0 (for 0%) and 1.0 (for 100%)
- Set Pre-Multiplied Luma Parameter for Upstream Keyer $i
/atem/usk/$i/luma/pre-multiplied <bool> - Set Inverse Luma Parameter for Upstream Keyer $i
/atem/usk/$i/luma/inverse <bool>
Where $i can be 1, 2, 3, or 4 depending on the capability of your ATEM switcher
Feedback: Enabled for '/atem/usk/$i/on-air', '/atem/usk/$i/tie', '/atem/usk/$i/source/', and '/atem/usk/$i/luma/'
- Set On-Air Downstreamkeyer $i
/atem/dsk/$i/on-air <0|1>- Send a value of 1 to cut the DSK on-air, and a value of 0 to cut it off-air
- Auto Toggle On-Air Downstreamkeyer $i
/atem/dsk/$i/on-air/auto - Cut Toggle On-Air Downstreamkeyer $i
/atem/dsk/$i/on-air/toggle - Set Tie Downstreamkeyer $i
/atem/dsk/$i/tie <0|1>- Send a value of 1 to enable tie, and 0 to disable
- Toggle Tie Downstreamkeyer $i
/atem/dsk/$i/tie/toggle - Set Downstreamkeyer $i for Next Scene
/atem/dsk/$i/tie/set-next <0|1>- Send a value of 1 to show the DSK after next transition, and 0 if you don’t want to show the DSK after next transition
- e.g. If DSK1 is on air,
/atem/dsk/1/tie/set-next 1will untie DSK1 so that it remains on, while/atem/dsk/1/tie/set-next 0will tie DSK1 so that it will go off air after the next transition.
Where $i can be 1, 2, 3, or 4 depending on the capability of your ATEM switcher
Feedback: Enabled for '/atem/dsk/$i/on-air' and '/atem/dsk/$i/tie'
- Change Gain for Audio Input $i
/atem/audio/input/$i/gain $x- Where
$xis the gain in decibels (dB), ranging from-60to6 - e.g.
/atem/audio/input/2/gain -30.0
- Where
- Change Balance for Audio Input $i
/atem/audio/input/$i/balance $x- Where
$xis the balance,-1.0for full left up to1.0for full right - e.g.
/atem/audio/input/2/balance 0.4
- Where
- Change Gain for Audio Output (Mix)
/atem/audio/output/gain $x- Where
$xis the gain in decibels (dB), ranging from-60to6 - e.g.
/atem/audio/output/gain -30.0
- Where
- Change Balance for Audio Output
/atem/audio/output/balance $x- Where
$xis the balance,-1.0for full left up to1.0for full right - e.g.
/atem/audio/output/balance 0.4
- Where
Feedback: Enabled for all values
- Set Media Player $i source to Clip $x
/atem/mplayer/$i/clip/$x- Where
$ican be 1 or 2, and$xcan be 1 or 2 depending on the capability of your ATEM switcher - e.g.
/atem/mplayer/2/clip/1
- Where
- Set Media Player $i source to Still $x
/atem/mplayer/$i/still/$x- Where
$ican be 1 or 2, and$xcan be 1-20 depending on the capability of your ATEM switcher - e.g.
/atem/mplayer/1/still/5
- Where
Feedback: None
- Toggle SuperSource Box $i enabled
/atem/supersource/$i/enabled <0|1>- Send a value of 1 to enable, and 0 to disable
- Set SuperSource Box $i source to input $x
/atem/supersource/$i/source $x- Where
$xis a valid program source. Check the Help Menu for the correct values.
- Where
- Other options are available. Check the Help Menu in the app for the full list.
Feedback: None
- Macros should be recorded within the ATEM Control Panel software.
- Macros are stored within the ATEM in a 0-index array
- This means that to access the first recorded Macro, you should use an index
$iof0, to access the second recorded Macro, you should use an index of1etc.
- This means that to access the first recorded Macro, you should use an index
- Get the Maximum Number of Macros:
/atem/macros/max-number- Returns an
intof the maximum number of Macros supported by your ATEM - Access to these Macros should be used via an index of
n-1
- Returns an
- Stop the currently active Macro (if any):
/atem/macros/stop - Get the Name of a Macro:
/atem/macros/$i/name- Returns a
stringwith the name, or "" if the Macro is invalid
- Returns a
- Get the Description of a Macro:
/atem/macros/$i/description- Returns a
stringwith the description, or "" if the Macro is invalid
- Returns a
- Get whether the Macro at index $i is valid:
/atem/macros/$i/is-valid- Returns an
intof0|1to indicate whether the requested Macro is valid
- Returns an
- Run the Macro at index $i:
/atem/macros/$i/run- Returns an
intof0|1to indicate whether the requested Macro was executed. A0will be returned if the Macro is invalid, or does not exist
- Returns an
Feedback: Enabled for /atem/macros/max-number, /atem/macros/$i/name, /atem/macros/$i/description, and /atem/macros/$i/is-valid. Also available On-Request (you can send the command to get the value in a return message)
- Request all feedback available
/atem/send-status- This will query the switcher and send back the status for the program/preview, transition control, keyers, and macros
- e.g. This can be used when a new OSC client device is brought online, so that it gets the current status of the system
This software has been used successfuly with TouchOSC on the iPad. A TouchOSC-interface for the iPad can be found in the repository.
This software has been used successfuly with ControllerMate and X-keys via sendOSC and iTerm 2. An example ActionScript for use within ControllerMate can be found in the repository. It has also been used with OSCulator.
- The code is based on the SwitcherPanel-Democode (Version 3.5) provided by Blackmagic.
- VVOSC is used as OSC-framework.
- Program icon based heavily on the ATEM Software Control icon by Blackmagic Design.