Welcome to the Open Switcher documentation

This is a new protocol documentation for the reverse-engineered UDP protocol of Blackmagic Design ATEM video switchers. The protocol has changed quite a bit in a few parts since the skaarhoj documentation has been last updated.

Contents:

• OpenSwitcher manual
  • Intro to ATEM switchers
• The low level UDP protocol
  • Anatomy of a packet
  • Starting a connection
  • The higher level protocol
• The USB protocol
  • The old USB protocol (until 8.5)
  • The 8.6+ protocol
• Media upload and download
  • Frame format
  • Compression
  • Frame storage locking
  • Downloading a frame
  • Uploading a frame
• Protocol fields
  • Switcher hardware info
  • Video switching fields
  • ATEM audio mixer
  • Fairlight audio mixer
  • File transfer fields
  • Video encoder fields
• Protocol commands
  • Switcher hardware control
  • Video switching commands
  • ATEM audio mixer
  • Fairlight audio mixer
  • File transfer commands
  • Video encoder commands
  • Camera control
• Using the Python module
  • Connecting
  • Receiving state changes
  • Sending commands
• The proxy server module
  • Configuration
• The OpenSwitcher TCP protocol
  • Packet format
  • Initial connection
• Converter setup protocol
  • The configuration protocol
  • Reading a setting
  • Writing a setting

Indices and tables

• Index

• Module Index

• Search Page