Blackmagic Design Web Presenter 4K - Manual (Page 101)

Developer Information
Developer Information
Blackmagic Web Presenter Ethernet Protocol
v1.0
Overview
The Blackmagic Web Presenter Ethernet Protocol is a line-oriented, text-based protocol to
control a Web Presenter. The Blackmagic Web Presenter Ethernet Protocol is available for
Blackmagic Web Presenter HD. Lines from the Web Presenter server will be separated by an
ASCII LF sequence. Messages from the user may be separated by LF or CR LF.
Connection
The Web Presenter server is accessed by connecting to TCP port 9977 on a Web Presenter.
Connection Response
Upon connection, the Web Presenter server sends a dump of the device’s state. The Web
Presenter server sends information in blocks, with each having an identifying header followed
by a colon. A block spans multiple lines and is terminated by a blank line. Each line in the
protocol is terminated by a newline character.
Following the header, a block contains either a single multi-line string or a sequence of key/
value pairs arranged one per line. The first colon on a line is used to delimit the key and the
value. A value may be a comma separated list. In this case, values in the list must have the “,”
and “\” characters escaped with a “\” character.
To be resilient to future protocol changes, clients should ignore blocks they do not recognize,
up to the trailing blank line. Within recognized blocks, clients should ignore keys they do not
recognize.
The protocol preamble block is always the first block sent by the Web Presenter server:
PROTOCOL PREAMBLE: ↵
Legend
↵ End of line
... and so on
Orange Text Client Generated
Grey Text Server Generated
Version: 1.0
↵
↵
The version field indicates the protocol version. When the protocol is changed in a compatible
way, the minor version number will be updated. If incompatible changes are made, the major
version number will be updated.
The initial status dump is concluded by the end prelude block:
END PRELUDE: ↵
↵
101