Table of contents

1) Introduction 1.1) Establish connection 2) Command structure 2.1) Encoding 2.2) Basic examples 2.3) Header description 2.4) Error codes 2.5) Parameters 2.6) Header and Payload revisited 3) Authentication and permissions 4) Examples 4.1) Fixed header and payload examples 4.2) Dynamic header and payload examples 4.3) Authentication examples 5) Listings 6) Version info 7) Categories 8) Commands

1) Introduction

The WolfProt protocol is a byte-oriented protocol used to communicate with WolfVision® Visualizer, Cynap and Cynap Videobar systems. In this document, these systems are referred to as device. To interact with these devices, WolfProt commands are sent using WebSockets or using a TCP connection. Both methods provide a secure context for data transmission and should always be the preferred means of communication. Commands are processed serially by the device, with the exception of subscriptions. The replies will always be sent in the same order as commands are received by the device (FIFO). The best practice is to send a command, wait for the reply, and then proceed with the next command.

Please note that devices operate in various network environments and, in most cases, are only accessible through internal networks. Due to their non-public and dynamically assigned IP addresses, secure connections use self-signed certificates generated on the device, which must be accepted by the connecting client.

Older devices may only support communication using a TCP connection.

1.1) Establish connection

As mentioned before, the connection to send commands to a device can be established through a WebSocket or a TCP connection. Connection infos are described in the following. The [ip address] placeholder should be replaced with the device IP address.

1.1.1) WebSocket

TLS secured connection

wss://[ip address]/xxx

Insecure connection

ws://[ip address]/xxx

table
1)
WebSocket endpoints

1.1.2) TCP

TLS secured connection

[ip address]:50917

Insecure connection

[ip address]:50915

table
2)
TCP endpoints

2) Command structure

Commands exist in two basic types, GET and SET. GET commands are used to retrieve values from the device, while SET commands are used to set values on the device. Both GET and SET share the same command structure, but differ only in the header and payload configuration. Data is always sent and retrieved in binary. For better readability this binary data is encoded in hexadecimal format throughout this documentation. The process of sending a command always consists of a request and a reply, with their structure defined as shown below:

StructureLength

Header

1 or 2 byte

Command

1 or 2 byte

Payload length

1 up to 4 bytes

Payload
Parameters (0 to n)

0 up to n bytes

table
3)
Request and reply packet structure

In case the sent command results in an error (this can only occur on replies, no errors can be set on requests) the response structure changes slightly. The payload length is replaced by a 1 byte encoded error and no additional payload is provided:

StructureLength

Header

1 byte

Command

1 or 2 byte

Error code

1 byte

table
4)
Packet structure in case of an error

2.1) Encoding

The following table shows the encoding for the currently supported data types.

StructureLength

number (int8/int16/int32)

little endian

string

Non zero terminated ASCII

table
5)
Data type encoding

2.2) Basic examples

The following examples should provide an impression of how commands are sent. Header, payload length and payload (parameters) are explained in detail later.

2.2.1) Set example (Box name)

The following command sets the box name of a Cynap:

Request data:09 CB03 06 43796E617031

DescriptionValue

Header

09

Command

CB03

Payload length

06

Payload

43796E617031 Cynap1 (UTF-8)

The result, of the request, if proper permissions are given, should be as following:

Response data:09 CB03 00

DescriptionValue

Header

09

Command

CB03

Payload length

00

example
1)
Set box name

2.2.2) Get example (Box name)

The following command retrieves the box name of a Cynap:

Request data:08 CB03 00

DescriptionValue

Header

08

Command

CB03

Payload length

00

The result of the request may look like this:

Response data:08 CB03 06 43796E617031

DescriptionValue

Header

08

Command

CB03

Payload length

06

Payload

43796E617031 Cynap1 (UTF-8)

example
2)
Get box name

2.3) Header description

The command header configures various parameters when sending a command and consists of either 1 or 2 bytes. The later one is called the extended header and is used if the payload length needs 4 bytes to be encoded. The following table shows the regular header:

Bit index:

Error=1, No error=0

Reserved=0

Extended Command

Payload length: 2 byte

Extended header

GET=0, SET=1

Bit indexValue description

1 if it is a set command
0 otherwise

1 to enable extended header
0 otherwise

The extended header is only used if the payload has to be encoded with 4 bytes.

1 if the payload length has to be encoded with 2 bytes
0 if you use 1 or 4 bytes for the length

1 command itself uses 2 bytes
0 if the command uses 1 byte

4..6

Set to zero 0. Fields are reserved for future usage.

Only used in reply. Will be set to 1 if a command replies with an error.

table
6)
Header

The following table shows the extended header:

Bit index:

Reserved=0

Payload length: 4 byte

Bit indexValue description

1 if the payload length has to be encoded within 4 bytes
0 if the length is encoded with 1 or 2 bytes

1..7

Set to zero 0. Fields are reserved for future usage.

table
7)
Extended header

2.4) Error codes

The the error code byte (see Header) represents one of the following errors:

DescriptionValue

Timeout

0x01

Invalid command

0x02

Invalid parameter

0x03

Invalid length

0x04

Fifo full

0x05

Firmware update error

0x06

Access denied

0x07

Authentication required

0x08

Busy

0x09

Sip required

0x0A

Power off

0x0B

table
8)
Error codes

2.5) Parameters

Parameters are used in requests and replies. They can have a fixed or a dynamic length. The actual type of the value has to be interpreted from the command documentation.

LengthPatternExample

Fixed: 1 byte

[a-z][a-z]?

ac
a
i

Fixed: 1..n bytes

[a-z]0..[a-z]n

s0..s1 (2 bytes)
b0..b3 (4 bytes)
a0..a7 (8 bytes)

Dynamic
Dynamic inferred

[a-z]0..[a-z]n
[a-z]0..[a-z]ninf

s0..sn
s0..sninf

table
9)
Parameter types

2.5.1) Dynamic parameters

Dynamic length parameters are a special case. Their length is determined either by a preceeding fixed length parameter, or they are inferred by the payload length and are marked with the superscript^inf.

When inferring length for dynamic parameters from payload length, preceeding fixed length parameters have to be taken into account.

2.6) Header and Payload revisited

Commands exist in two different types regarding header and payload. Commands with fixed headers and payload, and commands with dynamic headers and payload. The fixed variant will always use the same header and payload as in the command documentation, except the reply responds with an error.

Header type (fixed or dynamic)ValueDescription

Fixed

i.e.: 08

should always be sent as 08

Dynamic

i.e.: [08]

is dynamic and changes depending on the payload length. The documentation should be interpreted as a prefilled bitmask which should be adjusted.

table
10)
Header types

Payload type (fixed or dynamic)ValueDescription

Fixed

ab

the payload length is encoded in 1 byte

Fixed

ab cd

the payload length is encoded in 2 bytes

Fixed

ab cd ef gh

the payload length is encoded in 4 bytes

Dynamic

[ab]

the payload length can be encoded in 1, 2, or 4 bytes
The header has to be adjusted accordingly

table
11)
Payload types

Please see the examples in the examples section for dynamic and fixed headers and payloads ( Fixed, Dynamic)

3) Authentication and permissions

All commands require a certain permission level, also referred to as user level. The user level specifies an authentication level required to use a command. The user level can be acquired by sending the login command, which differs between Cynap (including Cynap Videobar) and Visualizer devices. The following table shows the various types of user levels:

User level may also be referred as access level, or login level in the documentation

User levelDescription

None

No authentication needed, user level None is automatically granted.

Viewer

Can be acquired by sending viewer password or pin

On Cynap, viewer user level can be enabled through:

Settings → Login → Viewer

Annotation

Used for annotation purposes.

User

Moderator user level login. If the system has no moderator authentication, this user level is automatically granted.
Inherits rights from None

On Cynap, moderator user level authorization can be enforced by enabling moderator password or RMS authentication:

Settings → Login → Moderator password required
Settings → Login → Room Management System (RMS)

On Visualizer, moderator user level authorization can be enforced by enabling moderator password:

OSD → Advanced Settings → Security → Moderator password required

Admin

Highest user level, administrator login is required.
Inherits rights from User

App

Internal usage for vSolution App only.

table
12)
User levels

For examples please see the Authentication examples.

4) Examples

The following section contains various command examples.

4.1) Fixed header and payload examples

These commands always use the same header and payload length encoding as seen in the documentation.

4.1.1) Get Boxname (Cynap)

GET

Boxname

Userlevel: None

08 CB03 00

08 CB03 ab n₀..n_n

n₀..n_n^inf

Name of box

Max. 32 bytes

Below are examples of requests and their corresponding replies:Request

Documentation valuesExample 1)Example 2)

Header

08Header:08
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0

08Header:08
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0

08Header:08
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0

Command

CB03

CB03

CB03

Payload length

00 (Value is zero and has one byte)

00

00

Reply

Documentation valuesExample 1)Example 2)

Header

08Header:08
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0

08Header:08
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0

08Header:08
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0

Command

CB03

CB03

CB03

Payload length

ab (1 byte length)

0A

0A

Parameter

n0..nninf
Parameter length is determined by payload length

50616e646f726131 Pandora1 (UTF-8)
Length: 8 bytes

43796E617031 Cynap1 (UTF-8)
Length: 6 bytes

example
3)
Get Boxname (Cynap),  fixed header and payload length

4.1.2) Set Boxname (Cynap)

SET

Boxname

Userlevel: Admin

09 CB03 ab n₀..n_n

n₀..n_n^inf

Name of box

Max. 32 bytes

09 CB03 00

Below are examples of requests and their corresponding replies:Request

Documentation valuesExample 1)Example 2) - No Admin user level

Header

09Header:09
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0

09Header:09
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0

09Header:09
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0

Command

CB03

CB03

CB03

Payload length

ab (1 byte length)

0A

0A

Parameter

n0..nninf

50616e646f726131 Pandora1 (UTF-8)

50616e646f726131 Pandora1 (UTF-8)

Reply

Documentation valuesExample 1)Example 2) - No Admin user level

Header

09Header:09
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0

09Header:09
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0

89Header:89
 Bit index:
1 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0

Command

CB03

CB03

CB03

Payload length

00 (Value is zero has 1 byte length)

00

07
Payload length is now the error code: Access denied

example
4)
Set Boxname (Cynap),  fixed header and payload length

4.2) Dynamic header and payload examples

These commands vary in their header and payload length encoding depending on their payload length.

4.2.1) Get Picture (Visualizer)

The following command will retrieve the live preview picture of a Visualizer device provided as JPEG. The size of the image will vary drastically depending on the captured content. The 250 byte example may not occur in real life situations, but is provided for completeness.

GET

Get Picture

Userlevel: User

08 4117 00

[08] 4117 [ab] p s b₀..b_n

picture format

start indicator 0x00

b₀..b_n^inf

picture data.

Get live picture.
If web viewer mode is enabled (see WPC_WEBVIEWER_MODE),
this command will not require any authentication.
Size of the picture data is the command
length from header subtracted by 2.

Below are examples of requests and their corresponding replies:Request

Documentation valuesExample (250 Byte)Example (15 Ki)Example (4 Mi)

Header

08Header:08
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0

08Header:08
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0

08Header:08
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0

08Header:08
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0

Command

4117

4117

4117

4117

Payload length

00

00

00

00

Reply

Documentation valuesExample (250 Byte)Example (15 Ki)Example (4 Mi)

Header

[08]Header:08
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0

08Header:08
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0

0CHeader:0C
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
1 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0

0A01Header:0A
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
1 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0
Extended header:01
 Bit index:
0 Reserved=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Payload length: 4 byte
7
6
5
4
3
2
1
0

Command

4117

4117

4117

4117

Payload length

[ab] 1 - 4 bytes

FA

3C00

00400000

Parameter

p Picture format
s Start indicator
b0..bninf Picture data
Length is determined by Payload length

00 Picture format
00 Start indicator
ff0d8ffe0…n247 Picture data
Length:
250B - 2B → 247B

00 Picture format
00 Start indicator
ff0d8ffe0…n15358 Picture data
Length:
15360B - 2B → 15358B

00 Picture format
00 Start indicator
ff0d8ffe0…n4194302 Picture data
Length:
4194304B - 2B → 4194302B

example
5)
Get Picture (Visualizer),  dynamic header and payload length

4.3) Authentication examples

Authentication differs slightly between Visualizer and Cynap devices. The authentication should be done for each connection to the device. Please see the following examples:

4.3.1) Visualizer authentication

The following command can be used to request a user level for the current connection:

SET

Userlevel: None

[09] 400B [ab] l s₀..s_n

0x00

NONE

0x01

USER

0x02

ADMIN

s₀..s_n^inf

password

Set login level.

09 400B 00

Below are examples of requests and their corresponding replies:Request

Documentation valuesCorrect credentialsWrong credentials

Header

[09]Header:09
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0

09Header:09
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0

09Header:09
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0

Command

400B

400B

400B

Payload length

[ab] 1 - 4 bytes

09

08

Parameter

l User level
s0..sninf Password

02 Admin
50616e646f7261313232 Pandora1 (UTF-8)

02 Admin
5061646f7261313232 Padora1 (UTF-8)

Reply

Documentation valuesCorrect credentialsWrong credentials

Header

09Header:09
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0

09Header:09
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0

89Header:89
 Bit index:
1 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0

Command

400B

400B

400B

Payload length

00

00

07
Payload length is now the error code: Access denied

example
6)
Set Login Level (Visualizer),  dynamic header and payload length

The following command shows the active user level for the current connection:

GET

Userlevel: None

08 400B 00

08 400B 01 l

0x00

NONE

0x01

USER

0x02

ADMIN

0x03

ADJUSTMENT

Get current login level.

Below are examples of requests and their corresponding replies:Request

Documentation valuesAleady authenticatedNot authenticated

Header

08Header:08
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0

08Header:08
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0

08Header:08
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0

Command

400B

400B

400B

Payload length

00

00

00

Reply

Documentation valuesAleady authenticatedNot authenticated

Header

08Header:08
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0

08Header:08
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0

08Header:08
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0

Command

400B

400B

400B

Payload length

01

01

01

Parameter

lv User level

01 Admin

00 None

example
7)
Get Login Level (Visualizer),  fixed header and payload length

4.3.2) Cynap authentication

The following command can be used to request a user level for the current connection.

Please note: Login using PIN or Connection ID is not covered in this example. When using the PIN parameter the password length has to be set to 00 and the password parameter should not be set.

SET

Userlevel: None

09 CB42 ab al lp p₀..p_n ln n₀..n_n

Access level

0x01

User

0x02

Admin

0x03

Annotation

0x04

Viewer

Password length

Max. 63 bytes

p₀..p_n

Password

PIN length. This is an optional parameter and is only required if Admin Remote PIN is set to PIN required and Access level is set to Admin. Also used as connection ID pin for safe connections

Max. 63 bytes

n₀..n_n

PIN. This is an optional parameter and is only required if Admin Remote PIN is set to PIN required and Access level is set to Admin. Also used as connection ID pin for safe connections

09 CB42 00

Below are examples of requests and their corresponding replies:Request

Documentation valuesCorrect credentialsWrong credentials

Header

09Header:09
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0

09Header:09
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0

09Header:09
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0

Command

CB42

CB42

CB42

Payload length

ab 1 byte

0B

0A

Parameter

l Accesslevel (User level)
lp Password length
p0..pn Password
ln Pin length
n0..nn Pin

02 Admin
08 
50616e646f726131 Pandora1 (UTF-8)
00 No pin provided
-- Not used

02 Admin
07 
5061646f726131  Padora1 (UTF-8)
00 No pin provided
-- Not used

Reply

Documentation valuesCorrect credentialsWrong credentials

Header

09Header:09
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0

09Header:09
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0

89Header:89
 Bit index:
1 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0

Command

CB42

CB42

CB42

Payload length

00

00

07
Payload length is now the error code: Access denied

example
8)
Set Login (Cynap),  fixed header and payload length

The following command shows the active user level for the current connection.

GET

Userlevel: None

08 CB55 00

08 CB55 01 lv

Level

0x00

None

0x01

User

0x02

Admin

0x03

Annotation

0x04

Viewer

Below are examples of requests and their corresponding replies:Request

Documentation valuesAleady authenticatedNot authenticated

Header

08Header:08
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0

08Header:08
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0

08Header:08
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0

Command

CB55

CB55

CB55

Payload length

00

00

00

Reply

Documentation valuesAleady authenticatedNot authenticated

Header

08Header:08
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0

08Header:08
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0

08Header:08
 Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0

Command

CB55

CB55

CB55

Payload length

01

01

01

Parameter

lv User level

01 Admin

00 None

example
9)
Get Login Level (Cynap),  fixed header and payload length

5) Listings

Tables:

1) WebSocket endpoints 2) TCP endpoints 3) Request and reply packet structure 4) Packet structure in case of an error 5) Data type encoding 6) Header 7) Extended header 8) Error codes 9) Parameter types 10) Header types 11) Payload types 12) User levels

Examples:

1) Set box name 2) Get box name 3) Get Boxname (Cynap),
fixed header and payload length 4) Set Boxname (Cynap),
fixed header and payload length 5) Get Picture (Visualizer),
dynamic header and payload length 6) Set Login Level (Visualizer),
dynamic header and payload length 7) Get Login Level (Visualizer),
fixed header and payload length 8) Set Login (Cynap),
fixed header and payload length 9) Get Login Level (Cynap),
fixed header and payload length

6) Version info

Firmware Version:
1.76a

Firmware Type:
Cynap

8) Commands

Scroll to top

Access Point (18)

GET

AP Channel

Userlevel: Admin

08 CB0E 00

08 CB0E 01 ch

Channel

0x00

0x01

0x02

0x03

0x04

0x05

0x06

0x07

149

0x08

153

0x09

157

0x0A

161

SET

AP Channel

Userlevel: Admin

09 CB0E 01 ch

Channel

0x00

0x01

0x02

0x03

0x04

0x05

0x06

0x07

149

0x08

153

0x09

157

0x0A

161

09 CB0E 00

GET

AP SSID Auto

Userlevel: Admin

08 CB0F 00

08 CB0F 01 oo

0x00

Off

0x01

SET

AP SSID Auto

Userlevel: Admin

09 CB0F 01 oo

0x00

Off

0x01

09 CB0F 00

GET

AP Password

Userlevel: Admin

08 CB1B 00

08 CB1B ab p₀..p_n

p₀..p_n^inf

Password

Max. 63 bytes

SET

AP Password

Userlevel: Admin

09 CB1B ab p₀..p_n

p₀..p_n^inf

Password

Max. 63 bytes

09 CB1B 00

GET

AP SSID

Userlevel: Annotation

08 CBB4 00

08 CBB4 ab s₀..s_n

s₀..s_n^inf

SSID

Max. 128 bytes

SET

AP SSID

Userlevel: Admin

09 CBB4 ab s₀..s_n

s₀..s_n^inf

SSID

Max. 128 bytes

09 CBB4 00

GET

AP IP Address

Userlevel: Annotation

08 CBB5 00

08 CBB5 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

SET

AP IP Address

Userlevel: Admin

09 CBB5 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

09 CBB5 00

GET

AP Subnet Mask

Userlevel: Admin

08 CBB6 00

08 CBB6 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

SET

AP Subnet Mask

Userlevel: Admin

09 CBB6 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

09 CBB6 00

GET

AP Encryption

Userlevel: Admin

08 CBB7 00

08 CBB7 01 en

Encryption

0x00

Off

0x01

WPA/WPA2

SET

AP Encryption

Userlevel: Admin

09 CBB7 01 en

Encryption

0x00

Off

0x02

WPA/WPA2

09 CBB7 00

GET

AP TX Power

Userlevel: Admin

08 CBD3 00

08 CBD3 01 po

Power

0x00..0x1E

Power in dBm (0..30)

SET

AP TX Power

Userlevel: Admin

09 CBD3 01 po

Power

0x00..0x1E

Power in dBm (1..30)

09 CBD3 00

GET

AP Maximum Clients

Userlevel: Admin

08 CCF1 00

08 CCF1 01 cl

Clients

0x01..0x08

1..8 Clients

0x01..0x0F

1..15 Clients

SET

AP Maximum Clients

Userlevel: Admin

09 CCF1 01 cl

Clients

0x01..0x08

1..8 Clients

0x01..0x0F

1..15 Clients

09 CCF1 00

Annotation (10)

SET

Annotation Action

Userlevel: Annotation

09 CB96 02 ap ac

0xFF

Annotation plane

0xFE

Annotation Matrix Master plane

Action

0x03

Clean All

0x06

Snapshot

0x07

Connect with default nickname

0x08

Disconnect me

0x0E

Global undo

0x0F

Global redo

09 CB96 00

GET

Annotation Status

Userlevel: Annotation

08 CB97 00

08 CB97 01 st

Status

0x00

Disabled

0x01

Enabled

0x02

Paused

0x03

Enabled Matrix Collaboration

GET

Collaboration User

Userlevel: Admin

08 CBE6 00

08 CBE6 01 st

User connection state

0x00

Hide

0x01

Visible

SET

Collaboration User

Userlevel: Admin

09 CBE6 01 st

User connection state

0x00

Hide

0x01

Visible

09 CBE6 00

SET

Annotation Magic Pen

Userlevel: Annotation

09 CCE6 05 pa x₀..x₁ y₀..y₁

Painting

0x00

Finished

0x01

Continued

x₀..x₁

X position

y₀..y₁

Y position

09 CCE6 00

GET

Annotation Magic Pen Settings

Userlevel: Admin

08 CCE7 00

08 CCE7 04 vt ru fn sn

Visible time in sec

0x01..0x3C

1..60 seconds

Remote User

0x00

Denied

0x01

Allowed

Function

0x00

Disabled

0x01

Enabled

Snapshot

0x00

Off

0x01

On unfreeze

SET

Annotation Magic Pen Settings

Userlevel: Admin

09 CCE7 04 vt ru fn sn

Visible time in sec

0x01..0x3C

1..60 seconds

Remote User

0x00

Deny

0x01

Allow

Function

0x00

Disable

0x01

Enable

Snapshot

0x00

Off

0x01

On unfreeze

09 CCE7 00

SET

Annotation Magic Pen Properties

Userlevel: Annotation

09 CCE8 05 r g b a ps

Red

Green

Blue

Alpha

Pen size

09 CCE8 00

GET

Annotation Magic Pen Status

Userlevel: Annotation

08 CCEB 00

08 CCEB 01 st

0x00

Disabled

0x01

Enabled

SET

Annotation Magic Pen Timeout

Userlevel: Annotation

09 CCF0 01 ti

Timeout

0x00

Disable

0x01

Enable

09 CCF0 00

Block (1)

GET

Block

Userlevel: Annotation

deprecated

08 CB34 00

08 CB34 ab st re mu fr vo sys lw w₀..w_n ws si ns de₀..de₅

Streaming

0x00

Off

0x01

Recording

0x00

Started

0x01

Paused

0x02

Stopped

Mute

0x00

Off

0x01

Freeze

0x00

Off

0x01

0x00..0x64

Volume in percent (0..100)

sys

System state

0x00

Standby

0x01

WLAN name length

Max. 128 bytes

w₀..w_n

WLAN name

WLAN status

0x00

Disconnected

0x01

Connected

Signal strength

0x00..0x64

Signal strength in percent (0..100)

Number of sources

de₀..de₅

Deprecated

No longer used, all bytes always 0x00

Cloud (12)

SET

Cloud Connect

Userlevel: User

09 CB45 02 cs ac

0x00

Dropbox

0x03

Jianguoyun

0x04

OneDrive

0x05

WebDAV

Action

0x00

Disconnect

0x01

Connect

09 CB45 00

SET

Cloud Preload

Userlevel: User

0D CB46 ab cd ac f₀..f_n

Action

0x00

Abort

0x01

Download

0x02

Download and Open

f₀..f_n^inf

File path

Max. 512 bytes
Fully qualified name: e.g. USB:///folder/document.pdf

09 CB46 00

GET

Cloud Status

Userlevel: Annotation

08 CB4C 00

08 CB4C 06 dr ud ud ji od wd

Dropbox

Undefined/removed service

Jianguoyun

OneDrive

WebDAV

Status:

0x00: Disconnected
0x01: Authenticating
0x02: Connected
0x03: Failed
0x04: Synced
0x05: Disabled
0x06: Not responding

SET

Remove From Downloadlist

Userlevel: User

0D CB87 ab cd f₀..f_n

f₀..f_n^inf

File path

Max. 512 bytes
Fully qualified name: e.g. dropbox:///folder/image.jpg

09 CB87 00

GET

Cloud Mode

Userlevel: User

08 CB8F 00

08 CB8F 06 gd dr ud ji od wd

Undefined/removed service

0x00

Disabled

Dropbox

0x00

Disabled

0x01

Enabled

Undefined/removed service

0x00

Disabled

Jianguoyun

0x00

Disabled

0x01

Enabled

OneDrive

0x00

Disabled

0x01

Enabled

WebDAV

0x00

Disabled

0x01

Enabled

SET

Cloud Mode

Userlevel: Admin

09 CB8F 02 cs oo

0x00

Dropbox

0x03

Jianguoyun

0x04

OneDrive

0x05

WebDAV

0x00

Off

0x01

09 CB8F 00

SET

Cloud Upload

Userlevel: User

0D CBA1 ab cd cs ac f₀..f_n

0x00

Dropbox

0x03

Jianguoyun

0x04

OneDrive

0x05

WebDAV

Action

0x00

Abort

0x01

Start

f₀..f_n^inf

File path

Max. 512 bytes
Fully qualified name: e.g. Internal:///recordings/video.mp4

09 CBA1 00

SET

File Upload

Userlevel: None

0D CBBF ab cd ac sl₀..sl₁ s₀..s_n tl₀..tl₁ t₀..t_n

Action

0x00

Abort

0x01

Start

sl₀..sl₁

Source file path length

s₀..s_n

Source file path

Fully qualified name: e.g. Internal:///recordings/video.mp4

tl₀..tl₁

Target file path length

t₀..t_n

Target file path

Fully qualified name: e.g. netdrive0:///, FTP:///, dropbox:///, USB:///wolfvision/

09 CBBF 00

0D CBBF 05 ac i₀..i₃

Action

0x02

Abort

0x03

Restart

i₀..i₃

File index

09 CBBF 00

SET

Jianguoyun Cloud Data

Userlevel: User

deprecated

0D CBEF ab cd lu u₀..u_n lp p₀..p_n

Username length

Max. 63 bytes

u₀..u_n

Username

Password length

Max. 63 bytes

p₀..p_n

Password

09 CBEF 00

SET

WebDAV Credentials

Userlevel: User

0D CC73 ab cd wd lu u₀..u_n lp p₀..p_n

WebDAV service

0x00

Jianguoyun

0x02

WebDAV

Username length

Max. 63 bytes

u₀..u_n

Username

Password length

Max. 63 bytes

p₀..p_n

Password

09 CC73 00

GET

WebDAV Settings

Userlevel: Admin

08 CC74 00

0C CC74 ab cd lu u₀..u_n ln n₀..n_n

Url length

Max. 255 bytes

u₀..u_n

Url

Name length

Max. 63 bytes

n₀..n_n

Name

SET

WebDAV Settings

Userlevel: Admin

0D CC74 ab cd lu u₀..u_n ln n₀..n_n

Url length

Max. 255 bytes

u₀..u_n

Url

Name length

Max. 63 bytes

n₀..n_n

Name

09 CC74 00

Control Screen (8)

GET

Content Per Output

Userlevel: User

0C CD5D 03 o₀..o₁ ext

o₀..o₁

output (OR operation with the desired outputs)

0x0001

HDMI1

0x0002

HDMI2

0x0008

Edit Mode

0x0020

Screenshare

ext

extended information

0x00

0x01

Yes

0C CD5D ab cd ct cbl₀..cbl₁ cb₀..cb_n tbl₀..tbl₁ tb₀..tb_n

content type

0x00

windows

cbl₀..cbl₁

window common block length

cb₀..cb_n

window common block

ty: window type

0x00 = None
0x01 = Visualizer
0x02 = HDMI
0x03 = Browser
0x04 = Miracast
0x05 = Airplay/Chromecast
0x06 = Video
0x07 = vSolution Cast/App
0x08 = Image
0x09 = PDF
0x0A = Office PPT/PPTX
0x0B = Office DOC/DOCX/TXT
0x0C = Office XLS/XLSX
0x0D = Whiteboard
0x0E = Audio
0x0F = Webconference
0x10 = Webcam
0x11 = Stream Input
0x13 = Office 365 Outlook
0x14 = Office 365 Word
0x15 = Office 365 Excel
0x16 = Office 365 PowerPoint
0x17 = Office 365 OneNote
0x18 = vMatrix Pull Stream (from station)
0x19 = vMatrix Push Stream (to station)
0x1A = vMatrix Station Browser
0x1B = Office 365 Teams
0x1C = vMatrix Groupwork Stream
0x1E = Office 365 Whiteboard
0x1F = Office 365 Planner

id0..id7: app id

idx: window index/slot

op0..op1: output port

0x0001: HDMI1
0x0002: HDMI2
0x0008: Edit Mode
0x0020: Screenshare

rw0..rw1: reference width

rh0..rh1: reference height

x0..x1: x position (left upper corner)

y0..y1: y position (left upper corner)

w0..w1: width

h0..h1: height

mu: mute

0x00: not muted
0x01: muted

vo: volume (0x00..0x7d: volume in percent)

rec: display as transparent window for recording/streaming

0x00: no
0x01: yes

webrtc: shared over webrtc

0x00: no
0x01: yes

fs: full screen

0x00: normal
0x01: full screen

wr: window restricted

0x00: no
0x01: yes

aux: aux (not relevant in control screen mode)

0x00: not on second output
0x01: on second output

tbl₀..tbl₁

type specific block length

tb₀..tb_n

type specific block

Type Visualizer and HDMI (wt=0x01..0x02):
in0..in3: Index
ln0..ln1: Input name length
n0..nn: Input name

Type Browser, Webconference, Office365, vMatrix Station Browser (wt=0x03, 0x0F, 0x13..0x17, 0x1A, 0x1B):
lu0..lu1: URL length
u0..un: URL
lt0..lt1: Title length
t0..tn: Title
it: Input type (request keyboard)
pdf: PDF viewer active
pp0..pp3: Page of PDF
tpp0..tpp3: Total page count of PDF
bu: Busy
pft0..pft3: Password field top (0x00000000 if not available)
pfb0..pfb3: Password field bottom (0x00000000 if not available)
pfl0..pfl3: Password field left (0x00000000 if not available)
pfr0..pfr3: Password field right (0x00000000 if not available)
zlp0..zlp3: Zoom level in percent
Types Office365 & webconf additionally: scr: Screenshare status

Type Airplay, vMatrix Pull Stream (from station), vMatrix Groupwork Stream (wt=0x05, 0x18, 0x1C):
ln0..ln1: Name length
n0..nn: Name

Type vMatrix Push Stream (wt=0x19):
ln0..ln1: Name length
n0..nn: Name
pi: Push index

0x00..0x03: Input stream 1..4 as stream source
0xFC: Matrix master stream source (HDMI2)
0xFD: Station stream source (Coaching)
0xFE: Station stream source (Groupwork)
0xFF: Matrix master stream source (HDMI1)

Type Video and Audio (wt=0x06, 0x0E):
du0..du3: Duration in ms
p0..p3: Position in ms
sp: Speed

0x00: Pause
0x01: Normal
0x02..0x0A: Speed multiplier Forward
0xFF: Backward
0xFE..0xF6: Speed multiplier Backward

lo: Loop

0x00: Off
0x01: On

tl0..tl1: Title length
t0..tn: Title
ps: Playback Status

0x00: Stopped
0x01: Paused
0x02: Seek Backward
0x03: Seek Forward
0x04: Playing

Type Image (wt=0x08):
in0..in3: Image number
tn0..tn3: Total number of images
lf0..lf1: Filename length
f0..fn: Filename

Type PDF (wt=0x09):
p0..p3: Page
tp0..tp3: Total number of pages
zlp0..zlp3: Zoom level in percent

Type Office (wt=0x0A..0x0C):
p0..p3: Page
tp0..tp3: Total pages
ld0..ld1: Document name length
dn0..dnn: Document name
wp0..wp3: Worksheet pages
lw0..lw1: Worksheet name length
wn0..wnn: Worksheet name

Type Whiteboard (wt=0x0D):
nu: Number of users

Type Webcam (wt=0x10):
ct: Content type

0x00 = HDMI
0x01 = Visualizer
0x02 = Disc Player
0x03 = Computer
0x0A = Camera

ln0..ln1: Camera name length
n0..nn: Camera name

Type Stream Input (wt=0x11):
ct: Content type

0x00 = HDMI
0x01 = Visualizer
0x02 = Disc Player
0x03 = Computer
0x0A = Camera
0x0B = Stream Input
0x0D = Cynap

ln0..ln1: Stream name length
n0..nn: Stream name (URL encoded)

Type Miracast (wt=0x04):
ln0..ln1: Name length
n0..nn: Name
ll: Low latency state

0x00: Off
0x01: On

Type vSolution Cast/App (wt=0x07):
ln0..ln1: Name length
n0..nn: Name
cb: Camera Back Session Window

0x00: No
0x01: Yes

The parameters content type, window common block length, window common block, type specific block length and type specific block are combined in one block that is repeated n times.

0C CD5D 03 o₀..o₁ ext

o₀..o₁

output

0x0008

Edit Mode

ext

extended information

0x00

0x01

Yes

0C CD5D ab cd ct cbl₀..cbl₁ cb₀..cb_n

content type

0x01

output

cbl₀..cbl₁

output block length

cb₀..cb_n

otuput block

ty: output type

0x01 = HDMI OUT1
0x02 = HDMI OUT2

rw0..rw1: reference width

rh0..rh1: reference height

x0..x1: x position (left upper corner)

y0..y1: y position (left upper corner)

w0..w1: width

h0..h1: height

GET

Confidence Windows Information

Userlevel: User

08 CD5E 00

0C CD5E ab cd rw₀..rw₁ rh₀..rh₁ cbl₀..cbl₁ cb₀..cb_n

rw₀..rw₁

reference width

rh₀..rh₁

reference height

cbl₀..cbl₁

confidence window block length

cb₀..cb_n

confidence window block

x0..x1: x position (from left upper corner)
y0..y1: y position (from left upper corner)
w0..w1: width
h0..h1: height
op: output port

0x01: HDMI1
0x02: HDMI2

The parameters confidence window block length and confidence window block are combined in one block that is repeated two times.

GET

Control Screen Enable

Userlevel: Admin

08 CD5F 00

08 CD5F 01 oo

0x00

Off

0x01

SET

Control Screen Enable

Userlevel: Admin

09 CD5F 01 oo

0x00

Off

0x01

09 CD5F 00

SET

Start Application

Userlevel: User

09 CD60 0d o₀..o₁ ra₀..ra₇ pai re wt

o₀..o₁

0x0001

HDMI1

0x0002

HDMI2

0x0004

Control Screen (Prepare Area)

0x0008

Edit Mode

ra₀..ra₇

Replace application ID

0 if no replace is needed

pai

Prepare Area Index

0..0xFF

Position in the prepare area application list (0xFF to append). Ignored if none of the outputs is the prepare area

Restricted flag

0x00

Normal window

0x01

Restricted window: Full control of such a window is only allowed for the client starting the window and for the local frontend. Click/Touch/Key events as well as WolfProt window control commands are ignored from other clients

Window type

0x01

Visualizer

0x0D

Whiteboard

09 CD60 00

09 CD60 0e o₀..o₁ ra₀..ra₇ pai re wt idx

o₀..o₁

0x0001

HDMI1

0x0002

HDMI2

0x0004

Control Screen (Prepare Area)

0x0008

Edit Mode

ra₀..ra₇

Replace application ID

0 if no replace is needed

pai

Prepare Area Index

0..0xFF

Position in the prepare area application list (0xFF to append). Ignored if none of the outputs is the prepare area

Restricted flag

0x00

Normal window

0x01

Window type

0x02

HDMI

0x10

Webcam

0x11

Stream Input

idx

Input index

0x00 = HDMI IN1/ Webcam 1/ Stream 1

0x01 = HDMI IN2/ Webcam 2/ Stream 2

...

09 CD60 00

0D CD60 ab cd o₀..o₁ ra₀..ra₇ pai re wt ul₀..ul₁ u₀..u_n

o₀..o₁

0x0001

HDMI1

0x0002

HDMI2

0x0004

Control Screen (Prepare Area)

0x0008

Edit Mode

ra₀..ra₇

Replace application ID

0 if no replace is needed

pai

Prepare Area Index

0..0xFF

Position in the prepare area application list (0xFF to append). Ignored if none of the outputs is the prepare area

Restricted flag

0x00

Normal window

0x01

Window type

0x13

Office 365 Outlook

0x14

Office 365 Word

0x15

Office 365 Excel

0x16

Office 365 PowerPoint

0x17

Office 365 OneNote

0x1E

Office 365 Whiteboard

0x1F

Office 365 Planner

ul₀..ul₁

URL length

max 2048 bytes

u₀..u_n

URL

If no URL is provided, the default page is opened

09 CD60 00

0D CD60 ab cd o₀..o₁ ra₀..ra₇ pai re wt ul₀..ul₁ u₀..u_n idx

o₀..o₁

0x0001

HDMI1

0x0002

HDMI2

0x0004

Control Screen (Prepare Area)

0x0008

Edit Mode

ra₀..ra₇

Replace application ID

0 if no replace is needed

pai

Prepare Area Index

0..0xFF

Position in the prepare area application list (0xFF to append). Ignored if none of the outputs is the prepare area

Restricted flag

0x00

Normal window

0x01

Window type

0x03

Browser

ul₀..ul₁

URL length

max 2048 bytes

u₀..u_n

URL

If no URL or valid index is provided, the default page is opened

idx

Browser shortcut index

Browser shortcut index or 0xFF if not used

09 CD60 00

0D CD60 ab cd o₀..o₁ ra₀..ra₇ pai re wt ul₀..ul₁ u₀..u_n ns

o₀..o₁

0x0001

HDMI1

0x0008

Edit Mode

ra₀..ra₇

Replace application ID

0 if no replace is needed

pai

Prepare Area Index

0..0xFF

Position in the prepare area application list (0xFF to append). Ignored if none of the outputs is the prepare area

Restricted flag

0x00

Normal window

0x01

Window type

0x0F

Webconference

ul₀..ul₁

Join Meeting URL length

max 2048 bytes

u₀..u_n

Join Meeting URL

If no URL is provided, the first URL specified in the WebRTC settings is opened

Native Screenshare

0x00

09 CD60 00

0D CD60 ab cd o₀..o₁ ra₀..ra₇ pai re wt fl₀..fl₁ f₀..f_n

o₀..o₁

0x0001

HDMI1

0x0002

HDMI2

0x0004

Control Screen (Prepare Area)

0x0008

Edit Mode

ra₀..ra₇

Replace application ID

0 if no replace is needed

pai

Prepare Area Index

0..255

Position in the prepare area application list. Ignored if none of the outputs is the prepare area

Restricted flag

0x00

Normal window

0x01

Window type

0x09

Remote PDF

0x20

Local file

fl₀..fl₁

File path length

max 2048 bytes

f₀..f_n

Fully qualified path

E.g. Internal:///snapshots/image.jpg

09 CD60 00

0B01 CD60 ab cd ef gh o₀..o₁ ra₀..ra₇ pai re wt ac ul₀..ul₁ u₀..u_n lpr₀..lpr₁ pr₀..pr_n

o₀..o₁

0x0001

HDMI1

0x0002

HDMI2

0x0004

Control Screen (Prepare Area)

0x0008

Edit Mode

ra₀..ra₇

Replace application ID

0 if no replace is needed

pai

Prepare Area Index

0..0xFF

Position in the prepare area application list (0xFF to append). Ignored if none of the outputs is the prepare area

Restricted flag

0x00

Normal window

0x01

Window type

0x1B

Office 365 Teams

0x1D

Zoom

Action

0x00

Join Meeting

0x01

Start local meeting room

ul₀..ul₁

Join Meeing URL length

u₀..u_n

Join Meeting URL

lpr₀..lpr₁

Private data length

pr₀..pr_n

Private data

Cookies array as JSON string
Example:
{“cookies”: [{ "url": "https://teams.microsoft.com/", "name": "MUIDB", "value": "0A86A8C113F963AF2606B96E122062F1", "path": "/", "secure": true, "httpOnly": true, "expirationDate": 1687167192.6475179, "storeId": "0" }, …]}

09 CD60 00

SET

Control Application

Userlevel: None

09 CD61 09 ai₀..ai₇ ac

ai₀..ai₇

Action

0x00

0x01

Fullscreen

0x02

Normal

0x05

Toggle Fullscreen/Normal

0x06

Aux-Copy On

0x07

Aux-Copy Off

0x08

Aux-Copy Toggle

0x09

WebRTC Screen Sharing On

0x0A

WebRTC Screen Sharing Off

0x0B

WebRTC Screen Sharing Toggle

09 CD61 00

09 CD61 0a a₀..a₇ ac oo

a₀..a₇

Application ID

Action

0x03

Mute

0x00

Off

0x01

09 CD61 00

09 CD61 0a a₀..a₇ ac wv

a₀..a₇

Application ID

Action

0x04

Volume

0x00..0x7d

Volume in percent (0..125)

09 CD61 00

09 CD61 0e a₀..a₇ ac o₀..o₁ s₀..s₁ pai

a₀..a₇

Application ID

Action

0x0C

Show on. Invalid action during annotation (busy error reply will be sent back)

o₀..o₁

0x0001

HDMI1

0x0002

HDMI2

0x0004

Control Screen (Prepare Area)

0x0008

Edit Mode

s₀..s₁

Bit 0

HDMI1

Bit 1

HDMI2

Bit 2

Control Screen (Prepare Area)

Bit 3

Edit Mode

pai

Prepare Area Index

Ignored if none of the outputs is the Prepare Area

09 CD61 00

09 CD61 11 sa₀..sa₇ ac ra₀..ra₇

sa₀..sa₇

Source Application ID

Action

0x0D

Replace. Invalid action during annotation (busy error reply will be sent back)

ra₀..ra₇

Replace Application ID

09 CD61 00

GET

Prepare List

Userlevel: User

08 CD63 00

0C CD63 ab cd cbl₀..cbl₁ cb₀..cb_n

cbl₀..cbl₁

prepare list block length

cb₀..cb_n

prepare list block

id0..id7: app id

ty: window type

0x00 = None
0x01 = Visualizer
0x02 = HDMI
0x03 = Browser
0x04 = Miracast
0x05 = Airplay/Chromecast
0x06 = Video
0x07 = vSolution Cast/App
0x08 = Image
0x09 = PDF
0x0A = Office PPT/PPTX
0x0B = Office DOC/DOCX/TXT
0x0C = Office XLS/XLSX
0x0D = Whiteboard
0x0E = Audio
0x0F = Webconference
0x10 = Webcam
0x11 = Stream Input
0x13 = Office 365 Outlook
0x14 = Office 365 Word
0x15 = Office 365 Excel
0x16 = Office 365 PowerPoint
0x17 = Office 365 OneNote
0x18 = vMatrix Pull Stream (from station)
0x19 = vMatrix Push Stream (to station)
0x1A = vMatrix Station Browser
0x1B = Office 365 Teams
0x1C = vMatrix Groupwork Stream
0x1D = Zoom
0x1E = Office 365 Whiteboard
0x1F = Office 365 Planner

pr: preview available

ic: icon code

0x00 = HDMI
0x01 = Visualizer
0x02 = Discplayer
0x03 = Computer
0x04 = Camera
0x05 = Cynap
0x06 = Stream
0x10 = Image
0x11 = Video
0x12 = Numbers
0x13 = Presentation
0x14 = Audio
0x15 = Text
0x20 = txt-File
0x21 = ai-File
0x22 = css-File
0x23 = doc-File
0x24 = exe-File
0x25 = gif-File
0x26 = html-File
0x27 = jpg-File
0x28 = mov-File
0x29 = mp3-File
0x2A = mp4-File
0x2B = pdf-File
0x2C = png-File
0x2D = ppt-File
0x2E = psd-File
0x2F = rar-File
0x30 = svg-File
0x31 = xls-File
0x32 = zip-File
0x33 = avi-File
0x34 = bmp-File
0x35 = docx-File
0x36 = m4v-File
0x37 = mkv-File
0x38 = pptx-File
0x39 = wma-File
0x3A = wmv-File
0x3B = xlsx-File
0x3C = wav-File

til0..til1: title length

ti0..tin: title

The parameters prepare list block length & prepare list block are both repeated n times, where n is the number of apps within the prepare list.

SET

Output to Edit

Userlevel: None

09 CD77 01 ou

Output

0x00

None

0x01

HDMI1

0x02

HDMI2

Invalid command during annotation (busy error reply will be sent back)

09 CD77 00

Date/Time (13)

GET

Date/Time

Userlevel: None

08 CB1C 00

08 CB1C 05 yy mm dd hh mi

Year

0x00..0x63

Year (0..99)

Month

0x01..0x0C

Month (1..12)

Day

0x01..0x1F

Day (1..31)

Hour

0x00..0x17

Hour (0..23)

Minute

0x00..0x3B

Minute (0..59)

SET

Date/Time

Userlevel: Admin

09 CB1C 05 yy mm dd hh mi

Year

0x00..0x63

Year (0..99)

Month

0x01..0x0C

Month (1..12)

Day

0x01..0x1F

Day (1..31)

Hour

0x00..0x17

Hour (0..23)

Minute

0x00..0x3B

Minute (0..59)

09 CB1C 00

GET

Time Source

Userlevel: Admin

08 CB1D 00

08 CB1D 01 so

Source

0x00

Internal

0x01

External

SET

Time Source

Userlevel: Admin

09 CB1D 01 so

Source

0x00

Internal

0x01

External

09 CB1D 00

GET

Date Format

Userlevel: None

08 CB1E 00

08 CB1E 01 fo

Format

0x00

DDMMYYYY/24H

0x01

MMDDYYYY/12H

SET

Date Format

Userlevel: Admin

09 CB1E 01 fo

Format

0x00

DDMMYYYY/24H

0x01

MMDDYYYY/12H

09 CB1E 00

GET

Timezone

Userlevel: Admin

08 CB82 00

08 CB82 01 tz

Timezone

0x00

Pacific/Apia

0x01

Pacific/Honolulu

0x02

America/Anchorage

0x03

America/Los Angeles

0x04

America/Tijuana

0x05

America/Phoenix

0x06

America/Denver

0x07

America/Mazatlan

0x08

America/Chicago

0x09

America/Regina

0x0A

America/Mexico City

0x0B

America/Bogota

0x0C

America/New York

0x0D

America/Caracas

0x0E

America/Halifax

0x0F

America/Santiago

0x10

America/La Paz

0x11

America/St. Johns

0x12

America/Sao Paulo

0x13

America/Buenos Aires

0x14

America/Montevideo

0x15

Atlantic/South Georgia

0x16

Atlantic/Azores

0x17

Atlantic/Cape Verde

0x18

Africa/Casablanca

0x19

UTC

0x1A

Europe/London

0x1B

Europe/Berlin

0x1C

Africa/Kinshasa

0x1D

Europe/Istanbul

0x1E

Africa/Cairo

0x1F

Asia/Jerusalem

0x20

Africa/Johannesburg

0x21

Europe/Moscow

0x22

Africa/Nairobi

0x23

Asia/Baghdad

0x24

Asia/Tehran

0x25

Asia/Muscat

0x26

Asia/Baku

0x27

Asia/Kabul

0x28

Asia/Karachi

0x29

Asia/Kolkata

0x2A

Asia/Katmandu

0x2B

Asia/Almaty

0x2C

Asia/Dhaka

0x2D

Asia/Rangoon

0x2E

Asia/Bangkok

0x2F

Asia/Hong Kong

0x30

Asia/Singapore

0x31

Australia/Perth

0x32

Asia/Taipei

0x33

Asia/Tokyo

0x34

Asia/Seoul

0x35

Australia/Adelaide

0x36

Australia/Darwin

0x37

Australia/Sydney

0x38

Australia/Brisbane

0x39

Pacific/Noumea

0x3A

Pacific/Auckland

0x3B

Pacific/Kwajalein

0x3C

Europe/Helsinki

SET

Timezone

Userlevel: Admin

09 CB82 01 tz

Timezone

0x00

Pacific/Apia

0x01

Pacific/Honolulu

0x02

America/Anchorage

0x03

America/Los Angeles

0x04

America/Tijuana

0x05

America/Phoenix

0x06

America/Denver

0x07

America/Mazatlan

0x08

America/Chicago

0x09

America/Regina

0x0A

America/Mexico City

0x0B

America/Bogota

0x0C

America/New York

0x0D

America/Caracas

0x0E

America/Halifax

0x0F

America/Santiago

0x10

America/La Paz

0x11

America/St. Johns

0x12

America/Sao Paulo

0x13

America/Buenos Aires

0x14

America/Montevideo

0x15

Atlantic/South Georgia

0x16

Atlantic/Azores

0x17

Atlantic/Cape Verde

0x18

Africa/Casablanca

0x19

UTC

0x1A

Europe/London

0x1B

Europe/Berlin

0x1C

Africa/Kinshasa

0x1D

Europe/Istanbul

0x1E

Africa/Cairo

0x1F

Asia/Jerusalem

0x20

Africa/Johannesburg

0x21

Europe/Moscow

0x22

Africa/Nairobi

0x23

Asia/Baghdad

0x24

Asia/Tehran

0x25

Asia/Muscat

0x26

Asia/Baku

0x27

Asia/Kabul

0x28

Asia/Karachi

0x29

Asia/Kolkata

0x2A

Asia/Katmandu

0x2B

Asia/Almaty

0x2C

Asia/Dhaka

0x2D

Asia/Rangoon

0x2E

Asia/Bangkok

0x2F

Asia/Hong Kong

0x30

Asia/Singapore

0x31

Australia/Perth

0x32

Asia/Taipei

0x33

Asia/Tokyo

0x34

Asia/Seoul

0x35

Australia/Adelaide

0x36

Australia/Darwin

0x37

Australia/Sydney

0x38

Australia/Brisbane

0x39

Pacific/Noumea

0x3A

Pacific/Auckland

0x3B

Pacific/Kwajalein

0x3C

Europe/Helsinki

09 CB82 00

GET

Timeserver URL

Userlevel: Admin

08 CC42 00

08 CC42 ab u₀..u_n

u₀..u_n^inf

URL

Max. 255 bytes

SET

Timeserver URL

Userlevel: Admin

09 CC42 ab u₀..u_n

u₀..u_n^inf

URL

Max. 255 bytes

09 CC42 00

GET

Timezone UTC Offset

Userlevel: User

08 CC49 00

08 CC49 02 o₀..o₁

o₀..o₁

Offset

Offset in minutes to UTC. Positive values are timezones west of London (=UTC/GMT), negative values are east of London

SET

Timeserver Test

Userlevel: Admin

09 CC77 ab u₀..u_n

u₀..u_n^inf

URL

0x00

Max. 255 bytes

Initiates test

09 CC77 00

GET

Timeserver Test Status

Userlevel: Admin

08 CC78 00

08 CC78 01 st

Status

0x00

Testing

0x01

Failed

0x02

Success

Device (18)

GET

Model

Userlevel: None

08 CB00 00

08 CB00 ab n₀..n_n

n₀..n_n^inf

Model name

E.g. CB1

GET

Boxname

Userlevel: None

08 CB03 00

08 CB03 ab n₀..n_n

n₀..n_n^inf

Name of box

Max. 32 bytes

SET

Boxname

Userlevel: Admin

09 CB03 ab n₀..n_n

n₀..n_n^inf

Name of box

Max. 32 bytes

09 CB03 00

GET

Serial Number

Userlevel: None

08 CB60 00

08 CB60 04 s₀..s₃

s₀..s₃

Serial number

08 CB60 01 re

Request

0x00

Framegrabber

Only supported by Cynap Core Pro (CCP) devices

08 CB60 ab s₀..s₃ lf f₀..f_n

s₀..s₃

Serial number

Framegrabber serial number length

Max. 16 bytes

f₀..f_n

Framegrabber serial number

GET

Adjustment Date

Userlevel: Admin

08 CB76 00

08 CB76 04 y₀..y₁ mm dd

y₀..y₁

Year

0x0000..0xFFFF

Year

Month

0x01..0x0C

Month (1..12)

Day

0x01..0x1F

Day (1..31)

GET

Support Year

Userlevel: User

08 CB77 01 re

Request

0x00

Status

08 CB77 02 re st

Request

0x00

Status

0x00

Failed

0x01

08 CB77 01 re

Request

0x01

Key

08 CB77 ab re k₀..k_n

Request

0x01

Key

k₀..k_n^inf

Key

E.g. D83FB23E-45CA0401-99EC3A36-B6B019B5-400007E4

08 CB77 01 re

Request

0x02

Last calender year within support period

08 CB77 03 re y₀..y₁

Request

0x02

Last calender year within support period

y₀..y₁

Year

0x0000..0xFFFF

Year

GET

Support PIN

Userlevel: None

deprecated

08 CC79 00

08 CC79 04 p₀..p₃

p₀..p₃

0x00000000..0x000F423F

Max. 999999 (6 digits)

08 CC79 00

08 CC79 ab rs ln n₀..n_n

Reset Status

0x00

0x01

Failed

Nonce length

n₀..n_n

Nonce

GET

Admin Password Reset Status

Userlevel: None

08 CC7A 00

08 CC7A 01 st

Status

0x00

Processing

0x01

Failed

0x02

Success

SET

Generate Logfile

Userlevel: Admin

09 CC96 01 ac

Action

0x00

Save to USB

0x01

Generate download link

09 CC96 00

09 CC96 ab ac bc

Action

0x00

Save to USB

0x01

Generate download link

bc^inf

Boot Cycle

0x00

All

0x01

Current

0x02

Last

09 CC96 00

GET

Generate Logfile Status

Userlevel: Admin

08 CC97 00

08 CC97 01 st

Status

0x00

Not initialized

0x01

Busy

0x02

0x03

Failed

GET

Admin Message

Userlevel: User

08 CD2D 00

08 CD2D 01 st

Status

0x00

Stopped

0x01

Started

SET

Admin Message

Userlevel: Admin

0B01 CD2D ab cd ef gh ac ty l₀..l₃ p₀..p_n

Action

0x00

Stop

0x01

Start

Type

0x00

URL

0x01

Template

l₀..l₃

Payload length

p₀..p_n

Payload

09 CD2D 00

GET

Admin Message Settings

Userlevel: User

08 CD2E 00

08 CD2E 01 oo

0x00

Off

0x01

SET

Admin Message Settings

Userlevel: Admin

09 CD2E 01 oo

0x00

Off

0x01

09 CD2E 00

GET

HDMI Input Status

Userlevel: User

08 CD3B 01 i

Input

0x00

HDMI 1

0x01

HDMI 2

08 CD3B 07 b w₀..w₁ h₀..h₁ p h

Present

w₀..w₁

Width

h₀..h₁

Height

Progressive

HDCP

GET

Logfile Binary Start

Userlevel: Admin

08 CD4D 00

08 CD4D 04 fs₀..fs₃

fs₀..fs₃

Filesize in bytes

GET

Logfile Binary Read Chunk

Userlevel: Admin

08 CD4E 04 b₀..b₃

b₀..b₃

Buffer size in bytes

0A01 CD4E ab cd ef gh lb₀..lb₃ b₀..b_n

lb₀..lb₃

Binary file data length

b₀..b_n

Binary file data

GET

Logfile Binary Stop

Userlevel: Admin

08 CD4F 00

External Storage (3)

GET

USB Device List

Userlevel: Admin

08 CC20 00

0C CC20 ab cd j₀..j_n

j₀..j_n^inf

USB device list

USB device list as JSON string

Syntax:

device: e.g. /dev/sdb
mounted
- 0: Not mounted
- 1: Mounted as external drive
(Optional) manufacturer
(Optional) type: Filesystem, e.g. fat, vfat, fat32, etc.
(Optional) product
(Optional) uuid
(Optional) serial
(Optional) label
(Optional) sizeMb: Size of USB device in megabyte
(Optional) isChild

Example:
[{"serial": "AA011122161614300126", "device": "/dev/sdb", "mounted": 0, "manufacturer": "SanDisk", "sizeMb": 29952, "isChild": 0, "product": "Extreme"}, {"device": "/dev/sdb1", "type": "vfat", "mounted": 0, "uuid": "F81F-1EAE", "sizeMb": 29951, "manufacturer": "SanDisk", "isChild":1, "product": "Extreme", "serial": "AA011122161614300126"}]

SET

External Storage Action

Userlevel: Admin

09 CC21 ab ac d₀..d_n

Action

0x00

Format device

0x01

Bind device

d₀..d_n^inf

Device

Max. 254 bytes
E.g. /dev/sdb

09 CC21 00

09 CC21 01 ac

Action

0x02

Unbind

0x03

Unmount

0x04

Mount

09 CC21 00

GET

External Storage Status

Userlevel: Admin

08 CC23 00

08 CC23 01 st

Status

0x00

Disabled (unbound)

0x01

Not mounted (bound)

0x02

Busy

0x03

Mounted

0x04

Failed

File Listing (8)

SET

Open File

Userlevel: User

0D CB3C ab cd f₀..f_n

f₀..f_n^inf

File path

Fully qualified name: e.g. USB:///folder/document.pdf

09 CB3C 00

GET

Mounts List

Userlevel: Annotation

08 CB3D 00

0C CB3D ab cd j₀..j_n

j₀..j_n^inf

Mounts list

Mounts list as JSON string

Syntax:

name: e.g. Internal, USB, Dropbox, etc.
id
- Internal
- System
- USB
- dropbox
- jianguoyun
- onedrive
- webdav
- netdrive0..netdrive9
- cdrive
- FTP
- VMeeting
- Recent-Files
type
- local
- system
- usb
- cloud
- netdrive
- ftp
- vmeeting
- recent_files
status
- notMounted
- mountFailed
- mounted
- notResponding
- disabled
- auth
- busy
perms
- ro: Read only
- wo: Write only
- rw: Read Write

Example:
[{"perms": "ro", "name": "Internal", "id": "Internal", "type": "local", "status": "mounted"}, {"perms": "ro", "name": "System", "id": "System", "type": "system", "status": "mounted"}, {"perms": "rw", "name": "USB", "id": "USB", "type": "usb", "status": "mounted"}, {"name": "Dropbox", "id": "dropbox", "type": "cloud", "status": "notMounted"}, {"name": "OneDrive", "id": "onedrive", "type": "cloud", "status": "notMounted"}, {"name": "Jianguoyun", "id": "jianguoyun", "type": "cloud", "status": "notMounted"}, {"name": "MyData", "id": "netdrive0", "type": "netdrive", "status": "disabled"}, {"name": "Install", "id": "netdrive1", "type": "netdrive", "status": "disabled"}, {"name": "Private_Files", "id": "netdrive2", "type": "netdrive", "status": "disabled"}, {"name": "Testroom", "id": "netdrive3", "type": "netdrive", "status": "disabled"}, {"name": "QNAP_ReadWrite", "id": "netdrive4", "type": "netdrive", "status": "disabled"}, {"name": "Network Drive 5", "id": "netdrive5", "type": "netdrive", "status": "disabled"}, {"name": "Network Drive 6", "id": "netdrive6", "type": "netdrive", "status": "disabled"}, {"name": "Network Drive 7", "id": "netdrive7", "type": "netdrive", "status": "disabled"}, {"name": "Network Drive 8", "id": "netdrive8", "type": "netdrive", "status": "disabled"}, {"name": "Network Drive 9", "id": "netdrive9", "type": "netdrive", "status": "disabled"}, {"name": "cdrive", "id": "cdrive", "type": "cloud", "status": "disabled"}, {"perms": "wo", "name": "FTP", "id": "FTP", "type": "ftp", "status": "mounted"},{"name":"vSolution Meeting","id":"VMeeting","status":"mounted","type":"vmeeting","perms":"ro"},{"name":"Recent Files","id":"Recent-Files","type":"recent_files","status":"mounted","perms":"ro"}]

GET

File List

Userlevel: App

deprecated

0C CB3E ab cd p₀..p_n

p₀..p_n^inf

Path of requested file list: e.g. Internal:/// for Internal, USB:/// for USB, dropbox:///MyFolder for Dropbox (content of directory MyFolder), etc.

0A01 CB3E ab cd ef gh j₀..j_n

j₀..j_n^inf

File list

File list as JSON string

Syntax:

name: Filename
type
- dir: Directory
- text: Text files (TXT, ODT, etc.) or MS Word documents (DOC/DOCX)
- calc: MS Excel documents (XLS/XLSX, ODS)
- presentation: MS PowerPoint documents (PPT/PPTX, PPS, PPSX, ODP)
- pdf: PDF files (PDF)
- video: Video files (MP4, AVI, OGG, OGV, MOV, MPG, MPEG, TS, MKV, M2TS, WMV, M4V)
- audio: Audio files (MP3, WMA, OGA, MKA, WAV)
- image: Image files (BMP, JPG, PNG, GIF, TIFF, TIF)
- html: HTML files (HTML, HTM, etc.)
- unknown: Unknown file type (can't be opened)
(Optional) downloadStatus
- done
- running
- failed
(Optional) preload: Download progress in percent (0..100)
(Optional) [drive]UploadStatus
- aborted
- done
- failed
- running
- pending
(Optional) [drive]UploadProgress: Upload progress in percent (0..100)
(Optional) id: File ID (e.g. from cloud service)
(Optional) size: File size in bytes

[drive]:

USB
dropbox
jianguoyun
onedrive
webdav
netdrive0..netdrive9
FTP

Example:
[{"name": "Audio", "type": "dir"}, {"name": "test.txt", "type": "text"}, {"name": "TroubleChapter5.ogg", "type": "video"}, {"id": "0B9HuwUcpZFv5TnFQQnVtcG5pVXM", "name": "AdamSmith_WealthOfNations.pdf", "type": "pdf", "size": 3215627}, {"name": "WolfVisionHQ.xml", "type": "unknown"}, {"id": "0B9HuwUcpZFv5RnJSQTI2dzIzdjg", "name": "Foreman_H264.mp4", "downloadStatus": "running", "size": 35916682, "preload": 23, "type": "video"}]

GET

Download List

Userlevel: User

08 CB7B 00

0C CB7B ab cd j₀..j_n

j₀..j_n^inf

Download list

Download list for all cloud services as JSON string

Syntax:

status
- done
- failed
- aborted
filename
preload: Download progress in percent (0..100)

Example:
[{"status": "done", "filename": "dropbox:///MyTextFile.txt", "preload": 100}, {"status": "done", "filename": "dropbox:///ExcelSheet.xlsx", "preload&": 100}]

08 CB7B 01 cs

0x00

Dropbox

0x03

Jianguoyun

0x04

OneDrive

0x05

WebDAV

0C CB7B ab cd j₀..j_n

j₀..j_n^inf

Download list

Download list for specified cloud service as JSON string

Syntax:

status
- done
- failed
- aborted
filename
preload: Download progress in percent (0..100)

Example:
[{"status": "done", "filename": "dropbox:///MyTextFile.txt", "preload": 100}]

SET

Delete File

Userlevel: User

0D CB7C ab cd f₀..f_n

f₀..f_n^inf

File path

Fully qualified name: e.g. Internal:///snapshots/image.jpg

09 CB7C 00

GET

Upload List

Userlevel: Annotation

08 CBC1 01 re

Request

0x00

Uploads from current presentation

0C CBC1 ab cd j₀..j_n

j₀..j_n^inf

Upload list

Upload list of the current presentation as JSON string

Syntax:

file: Fully qualified name: e.g. Internal:///snapshots/image.jpg
status
- done
- fail
- aborted
- running
- pending
optional: progress: Progress in percent (0..100)
index: Index in uploads list
target: Upload destination, e.g. dropbox:///wolfvision/
sessionid: ID of session which started the upload. ID is incremented each time a login to a cloud service is executed
presentationid: ID of presentation which started the upload. ID is newly generated each time End Presentation is executed
uid: only for internal use
size: Filesize in bytes
option: Currently not used

Example:
[{"file": "Internal:///snapshots/cynap-00001234_20170518_085828.jpg", "target": "dropbox:///wolfvision/", "sessionid": 5, "index": 1, "status": "done", "presentationid": 387, "uid": "387_17659157756_IMMORTAL", "size": 115921, "progress": 100}, {"file": "Internal:///snapshots/cynap-00001234_20170518_085828.jpg", "status": "done", "presentationid": 387, "target": "dropbox:///wolfvision/", "sessionid": 6, "index": 2, "uid": "387_17713419333_IMMORTAL", "size": 115921, "progress": 100}]

SET

Delete Folder

Userlevel: User

0D CC2C ab cd lf f₀..f_n

Foldername length

Max. 255 bytes

f₀..f_n

Foldername

Fully qualified name: e.g. Internal:///rootfolder/foldername

09 CC2C 00

GET

File List 2

Userlevel: App

0C CD3F ab cd p₀..p_n

p₀..p_n^inf

Path of requested file list: e.g. Internal:/// for Internal, USB:/// for USB, dropbox:///MyFolder for Dropbox (content of directory MyFolder), etc.

0A01 CD3F ab cd ef gh j₀..j_n

j₀..j_n^inf

File list

File list as JSON object

Syntax:

syncState
- busy
- ready
fileList: array
- name: Filename
- type
  - dir: Directory
  - text: Text files (TXT, ODT, etc.) or MS Word documents (DOC/DOCX)
  - calc: MS Excel documents (XLS/XLSX, ODS)
  - presentation: MS PowerPoint documents (PPT/PPTX, PPS, PPSX, ODP)
  - pdf: PDF files (PDF)
  - video: Video files (MP4, AVI, OGG, OGV, MOV, MPG, MPEG, TS, MKV, M2TS, WMV, M4V)
  - audio: Audio files (MP3, WMA, OGA, MKA, WAV)
  - image: Image files (BMP, JPG, PNG, GIF, TIFF, TIF)
  - html: HTML files (HTML, HTM, etc.)
  - unknown: Unknown file type (can't be opened)
- (Optional) downloadStatus
  - done
  - running
  - failed
- (Optional) preload: Download progress in percent (0..100)
- (Optional) [drive]UploadStatus
  - aborted
  - done
  - failed
  - running
  - pending
- (Optional) [drive]UploadProgress: Upload progress in percent (0..100)
- (Optional) id: File ID (e.g. from cloud service)
- (Optional) size: File size in bytes

[drive]:

USB
dropbox
jianguoyun
onedrive
webdav
netdrive0..netdrive9
FTP

Example:
{"syncState": "ready", "fileList": [{"name": "Audio", "type": "dir"}, {"name": "test.txt", "type": "text"}, {"name": "TroubleChapter5.ogg", "type": "video"}, {"id": "0B9HuwUcpZFv5TnFQQnVtcG5pVXM", "name": "AdamSmith_WealthOfNations.pdf", "type": "pdf", "size": 3215627}, {"name": "WolfVisionHQ.xml", "type": "unknown"}, {"id": "0B9HuwUcpZFv5RnJSQTI2dzIzdjg", "name": "Foreman_H264.mp4", "downloadStatus": "running", "size": 35916682, "preload": 23, "type": "video"}]}

File Push (4)

GET

File Push Mode

Userlevel: None

08 CCD9 00

08 CCD9 01 oo

0x00

Off

0x01

SET

File Push Mode

Userlevel: User

09 CCD9 01 oo

0x00

Off

0x01

09 CCD9 00

GET

App Connection Counter

Userlevel: User

08 CCDA 00

08 CCDA 01 cc

Connection counter

GET

File Download

Userlevel: App

08 CCDB ab f₀..f_n

f₀..f_n^inf

Filename

0A01 CCDB ab cd ef gh b₀..b_n

b₀..b_n^inf

Binary file data

Firmware Update (9)

GET

FW Update Status

Userlevel: None

08 CB2E 00

08 CB2E 02 st pr

Status

0x00

Idle

0x01

Uploading

0x02

Updating

0x03

Finished

0x04

Failed

0x05

Verifying

Progress

0x00..0x64

Progress in percent (0..100)

SET

FW Update Start

Userlevel: Admin

09 CB2F 04 f₀..f₃

f₀..f₃

Filesize

In bytes

09 CB2F 00

09 CB2F 05 f₀..f₃ ft

f₀..f₃

In bytes

File Type

0x00

Legacy firmware file

0x01

RAUC firmware file

09 CB2F 00

SET

FW Update Data

Userlevel: Admin

0D CB30 ab cd d₀..d_n

d₀..d_n^inf

Firmware file data

Max. 65535 bytes

09 CB30 00

SET

FW Update Stop

Userlevel: Admin

09 CB31 00

GET

Web Update

Userlevel: User

08 CB7A 00

08 CB7A ab st pr v₀..v_n

Status

0x00

Idle

0x01

Failed

0x02

No connection

0x03

Checking

0x04

Up to date

0x05

Out of date

0x06

Downloading

0x07

Updating

Progress

0x00..0x64

Progress in percent (0..100)

v₀..v_n^inf

Firmware version

E.g. V1.14f

SET

Web Update

Userlevel: Admin

09 CB7A 01 ac

Action

0x00

Check for firmware update

0x01

Start firmware update

0x02

Cancel firmware update

09 CB7A 00

09 CB7A ab ac ul u₀..u_n

Action

0x03

Set XML file path

0x04

Start firmware update with given file

0x06

Start RAUC firmware update form url

0x07

Check RAUC firmware update form url

URL length

Max. 253 bytes

u₀..u_n

URL

09 CB7A 00

GET

USB Update Status

Userlevel: None

08 CC1A 00

08 CC1A 01 st

Status

0x00

No firmware update found (or invalid or same build number)

0x01

Firmware update found

SET

USB Update Skip

Userlevel: User

09 CC1B 00

Newer firmware found on USB stick -> Don't start installation

09 CC1B 00

SET

USB Update Start

Userlevel: Admin

09 CC1C 00

Newer firmware found on USB stick -> Start installation

09 CC1C 00

FTP (11)

GET

FTP Function

Userlevel: User

08 CB62 00

08 CB62 01 oo

0x00

Off

0x01

SET

FTP Function

Userlevel: Admin

09 CB62 01 oo

0x00

Off

0x01

09 CB62 00

GET

FTP Server URL

Userlevel: Admin

08 CB63 00

08 CB63 ab u₀..u_n

u₀..u_n^inf

URL

Max. 255 bytes

SET

FTP Server URL

Userlevel: Admin

09 CB63 ab u₀..u_n

u₀..u_n^inf

URL

Max. 255 bytes

09 CB63 00

GET

FTP Server Username

Userlevel: Admin

08 CB64 00

08 CB64 ab u₀..u_n

u₀..u_n^inf

Username

Max. 63 bytes

SET

FTP Username

Userlevel: Admin

09 CB64 ab u₀..u_n

u₀..u_n^inf

Username

Max. 63 bytes

09 CB64 00

GET

FTP Password

Userlevel: Admin

08 CB65 00

08 CB65 ab p₀..p_n

p₀..p_n^inf

Password

Max. 63 bytes

SET

FTP Password

Userlevel: Admin

09 CB65 ab p₀..p_n

p₀..p_n^inf

Password

Max. 63 bytes

09 CB65 00

SET

FTP Send File

Userlevel: User

deprecated

0D CB66 ab cd f₀..f_n

f₀..f_n^inf

File path

Max. 512 bytes
Fully qualified name: e.g. Internal:///snapshots/image.jpg

09 CB66 00

GET

FTP Test Status

Userlevel: Admin

08 CB67 00

08 CB67 01 st

Status

0x00

Testing

0x01

Failed

0x02

Success

SET

FTP Test

Userlevel: Admin

09 CB69 00

HDCP (8)

GET

Main Out

Userlevel: Admin

08 CB6F 00

08 CB6F 01 oo

0x00

Off

0x01

SET

Main Out

Userlevel: Admin

09 CB6F 01 oo

0x00

Off

0x01

09 CB6F 00

GET

Aux Out

Userlevel: Admin

08 CB70 00

08 CB70 01 oo

0x00

Off

0x01

SET

Aux Out

Userlevel: Admin

09 CB70 01 oo

0x00

Off

0x01

09 CB70 00

GET

In1

Userlevel: Admin

08 CB71 00

08 CB71 01 oo

0x00

Off

0x01

SET

In1

Userlevel: Admin

09 CB71 01 oo

0x00

Off

0x01

09 CB71 00

GET

In2

Userlevel: Admin

08 CB72 00

08 CB72 01 oo

0x00

Off

0x01

SET

In2

Userlevel: Admin

09 CB72 01 oo

0x00

Off

0x01

09 CB72 00

Infrastructure (44)

GET

Infra SSID

Userlevel: Annotation

08 CB10 00

08 CB10 ab s₀..s_n

s₀..s_n^inf

SSID

Max. 128 bytes

SET

Infra SSID

Userlevel: Admin

09 CB10 ab s₀..s_n

s₀..s_n^inf

SSID

Max. 128 bytes

09 CB10 00

GET

Infra DHCP

Userlevel: Admin

08 CB11 00

08 CB11 01 oo

0x00

Off

0x01

SET

Infra DHCP

Userlevel: Admin

0B01 CB11 01 oo

0x00

Off

0x01

0x02

Toggle

09 CB11 00

GET

Infra IP Address

Userlevel: None

08 CB12 00

08 CB12 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently used IP address

08 CB12 01 so

Source

0x00

Static IP

08 CB12 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently set Static IP address. If DHCP is set to Off, this is also the currently used IP address

08 CB12 01 so

Source

0x01

DHCP IP

08 CB12 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently set DHCP IP address. If DHCP is set to On, this is also the currently used IP address

SET

Infra IP Address

Userlevel: Admin

0B01 CB12 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

09 CB12 00

GET

Infra Subnet Mask

Userlevel: Admin

08 CB13 00

08 CB13 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently used subnet mask

08 CB13 01 so

Source

0x00

Static subnet mask

08 CB13 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently set Static subnet mask. If DHCP is set to Off, this is also the currently used subnet mask

08 CB13 01 so

Source

0x01

DHCP subnet mask

08 CB13 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently set DHCP subnet mask. If DHCP is set to On, this is also the currently used subnet mask

SET

Infra Subnet Mask

Userlevel: Admin

0B01 CB13 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

09 CB13 00

GET

Infra Gateway

Userlevel: Admin

08 CB14 00

08 CB14 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently used gateway

08 CB14 01 so

Source

0x00

Static gateway

08 CB14 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently set Static gateway. If DHCP is set to Off, this is also the currently used gateway

08 CB14 01 so

Source

0x01

DHCP gateway

08 CB14 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently set DHCP gateway. If DHCP is set to On, this is also the currently used gateway

SET

Infra Gateway

Userlevel: Admin

0B01 CB14 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

09 CB14 00

GET

Infra DNS1

Userlevel: Admin

08 CB15 00

08 CB15 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently used DNS1

08 CB15 01 so

Source

0x00

Static DNS1

08 CB15 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently set Static DNS1 address. If DHCP is set to Off, this is also the currently used DNS1

08 CB15 01 so

Source

0x01

DHCP DNS1

08 CB15 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently set DHCP DNS1. If DHCP is set to On, this is also the currently used DNS1

SET

Infra DNS1

Userlevel: Admin

0B01 CB15 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

09 CB15 00

GET

Infra DHCP State

Userlevel: Admin

08 CB18 00

08 CB18 01 st

State

0x00

Off

0x01

Failed

0x02

Trying

0x03

0x04

Unknown

GET

Infra Password

Userlevel: Admin

08 CB19 00

08 CB19 ab p₀..p_n

p₀..p_n^inf

Password

Max. 63 bytes

SET

Infra Password

Userlevel: Admin

09 CB19 ab p₀..p_n

p₀..p_n^inf

Password

Max. 63 bytes

09 CB19 00

GET

Infra Encryption

Userlevel: Admin

08 CB1A 00

08 CB1A 01 en

Encryption

0x00

Off

0x01

WEP

0x02

WPA/WPA2

0x03

WPA Enterprise

SET

Infra Encryption

Userlevel: Admin

09 CB1A 01 en

Encryption

0x00

Off

0x01

WEP

0x02

WPA/WPA2

0x03

WPA Enterprise

09 CB1A 00

GET

Infra AP List

Userlevel: Admin

08 CB44 00

0C CB44 ab cd j₀..j_n

j₀..j_n^inf

Access point list

Access point list as JSON string

Syntax:

name: Access point name
encryption
- none
- wep
- wpa
quality: In percent (0..100)
channel: Channel number
signallevel: In dBm
bssid: xx:xx:xx:xx:xx:xx
frequency: x.xxx

Example:
[{"name": "Multicast-Data", "encryption": "wpa", "quality": 100, "channel": 6, "signallevel": -18, "bssid": "A8:9D:21:83:5C:41", "frequency": "2.437"}, {"name": "DataLan", "encryption": "wep", "quality": 77, "channel": 6, "signallevel": -56, "bssid": "A8:9D:21:BE:6A:82", "frequency": "2.437"}, {"name": "....-----", "encryption": "none", "quality": 68, "channel": 36, "signallevel": -62, "bssid": "F8:32:E4:A4:D8:74", "frequency": "5.18"}]

SET

Infra AP List

Userlevel: Admin

09 CB44 01 ac

Action

0x00

Start scanning for access points

09 CB44 00

GET

Infra AP List Status

Userlevel: User

08 CB6D 00

08 CB6D 01 st

Status

0x00

Searching

0x01

Failed

0x02

Success

GET

Infra Username/Identity

Userlevel: Admin

08 CB6E 00

08 CB6E ab i₀..i_n

i₀..i_n^inf

Identity

Max. 63 bytes

SET

Infra Username/Identity

Userlevel: Admin

09 CB6E ab i₀..i_n

i₀..i_n^inf

Identity

Max. 63 bytes

09 CB6E 00

GET

Infra Certificate Mode

Userlevel: Admin

08 CB73 00

08 CB73 01 oo

0x00

Off

0x01

SET

Infra Certificate Mode

Userlevel: Admin

09 CB73 01 oo

0x00

Off

0x01

09 CB73 00

GET

Infra Certificate File

Userlevel: Admin

08 CB74 00

0C CB74 ab cd j₀..j_n

j₀..j_n^inf

Certificate file list

Certificate file list as JSON string

Syntax:

name: Certificate filename
active
- 0: No
- 1: Yes

Example:
[{"name": "certificate1.cer", "active": 0}, {"name": "certificate2.cer", "active": 1}]

SET

Infra Certificate File

Userlevel: Admin

0B01 CB74 ab cd ef gh ac lf f₀..f_n b₀..b_n

Action

0x00

Delete

0x01

Save

0x02

Verify

Filename length

f₀..f_n

Filename

b₀..b_n^inf

Binary file data

09 CB74 00

GET

Infra Certificate Name

Userlevel: Admin

08 CB75 00

08 CB75 ab n₀..n_n

n₀..n_n^inf

Name

Max. 255 bytes

SET

Infra Certificate Name

Userlevel: Admin

09 CB75 ab n₀..n_n

n₀..n_n^inf

Name

Max. 255 bytes

09 CB75 00

GET

Infra Certificate Method

Userlevel: Admin

08 CBC2 00

08 CBC2 01 me

Method

0x00

PEAP-MSCHAPV2

0x01

TTLS-PAP

SET

Infra Certificate Method

Userlevel: Admin

09 CBC2 01 me

Method

0x00

PEAP-MSCHAPV2

0x01

TTLS-PAP

09 CBC2 00

GET

Infra Anonymous Identity

Userlevel: Admin

08 CBC3 00

08 CBC3 ab i₀..i_n

i₀..i_n^inf

Identity

Max. 63 bytes

SET

Infra Anonymous Identity

Userlevel: Admin

09 CBC3 ab i₀..i_n

i₀..i_n^inf

Identity

Max. 63 bytes

09 CBC3 00

GET

Infra DNS2

Userlevel: Admin

08 CBD2 00

08 CBD2 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently used DNS2

08 CBD2 01 so

Source

0x00

Static DNS2

08 CBD2 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently set Static DNS2. If DHCP is set to Off, this is also the currently used DNS2

08 CBD2 01 so

Source

0x01

DHCP DNS2

08 CBD2 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently set DHCP DNS2. If DHCP is set to On, this is also the currently used DNS2

SET

Infra DNS2

Userlevel: Admin

0B01 CBD2 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

09 CBD2 00

GET

Infra WLAN Priority

Userlevel: Admin

08 CBED 00

08 CBED 01 pr

0x00

Priority 1

0x01

Priority 2

0x02

Priority 3

SET

Infra WLAN Priority

Userlevel: Admin

09 CBED 01 pr

0x00

Priority 1

0x01

Priority 2

0x02

Priority 3

09 CBED 00

GET

Infra WLAN SSID Type

Userlevel: Admin

08 CC44 00

08 CC44 01 ty

Type

0x00

ESSID

0x01

BSSID

SET

Infra WLAN SSID Type

Userlevel: Admin

09 CC44 01 ty

Type

0x00

ESSID

0x01

BSSID

09 CC44 00

GET

Infra WLAN BSSID

Userlevel: Admin

08 CC45 00

08 CC45 ab b₀..b_n

b₀..b_n^inf

BSSID

Max. 17 bytes

SET

Infra WLAN BSSID

Userlevel: Admin

09 CC45 ab b₀..b_n

b₀..b_n^inf

BSSID

Max. 17 bytes

09 CC45 00

GET

Infra WLAN Frequency Band

Userlevel: Admin

08 CC46 00

08 CC46 01 ba

Band

0x00

Both

0x01

2.4 GHz

0x02

5 GHz

SET

Infra WLAN Frequency Band

Userlevel: Admin

09 CC46 01 ba

Band

0x00

Both

0x01

2.4 GHz

0x02

5 GHz

09 CC46 00

GET

Infra Signal Level Limit

Userlevel: Admin

08 CC7B 00

08 CC7B 01 sll

sll

Signal Level Limit (dBm)

SET

Infra Signal Level Limit

Userlevel: Admin

09 CC7B 01 ssl

ssl

Signal Level Limit (dBm)

09 CC7B 00

LAN Interface (35)

GET

LAN DHCP

Userlevel: Admin

08 CB04 00

08 CB04 01 oo

0x00

Off

0x01

SET

LAN DHCP

Userlevel: Admin

09 CB04 01 oo

0x00

Off

0x01

09 CB04 00

GET

LAN IP Address

Userlevel: None

08 CB05 00

08 CB05 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently used IP address

08 CB05 01 so

Source

0x00

Static IP

08 CB05 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently set Static IP address. If DHCP is set to Off, this is also the currently used IP address

08 CB05 01 so

Source

0x01

DHCP IP

08 CB05 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently set DHCP IP address. If DHCP is set to On, this is also the currently used IP address

SET

LAN IP Address

Userlevel: Admin

09 CB05 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

09 CB05 00

GET

LAN Subnet Mask

Userlevel: Admin

08 CB06 00

08 CB06 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently used subnet mask

08 CB06 01 so

Source

0x00

Static subnet mask

08 CB06 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently set Static subnet mask. If DHCP is set to Off, this is also the currently used subnet mask

08 CB06 01 so

Source

0x01

DHCP subnet mask

08 CB06 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently set DHCP subnet mask. If DHCP is set to On, this is also the currently used subnet mask

SET

LAN Subnet Mask

Userlevel: Admin

09 CB06 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

09 CB06 00

GET

LAN Gateway

Userlevel: Admin

08 CB07 00

08 CB07 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently used gateway

08 CB07 01 so

Source

0x00

Static gateway

08 CB07 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently set Static gateway. If DHCP is set to Off, this is also the currently used gateway

08 CB07 01 so

Source

0x01

DHCP gateway

08 CB07 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently set DHCP gateway. If DHCP is set to On, this is also the currently used gateway

SET

LAN Gateway

Userlevel: Admin

09 CB07 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

09 CB07 00

GET

LAN DNS1

Userlevel: Admin

08 CB08 00

08 CB08 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently used DNS1

08 CB08 01 so

Source

0x00

Static DNS1

08 CB08 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently set Static DNS1 address. If DHCP is set to Off, this is also the currently used DNS1

08 CB08 01 so

Source

0x01

DHCP DNS1

08 CB08 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently set DHCP DNS1. If DHCP is set to On, this is also the currently used DNS1

SET

LAN DNS1

Userlevel: Admin

09 CB08 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

09 CB08 00

GET

LAN MAC

Userlevel: None

08 CB09 00

08 CB09 11 m₀..m₁₆

m₀..m₁₆

MAC address

MAC address as string: e.g. 00:0C:92:BC:61:2B

GET

LAN DHCP State

Userlevel: Admin

08 CB0A 00

08 CB0A 01 st

State

0x00

Off

0x01

Failed

0x02

Trying

0x03

0x04

Unknown

SET

LAN Settings

Userlevel: Admin

09 CB0B 0d dh ip₀..ip₃ sn₀..sn₃ gw₀..gw₃

DHCP

0x00

Off

0x01

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

sn₀..sn₃

Subnet mask

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

gw₀..gw₃

Gateway

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Configure all LAN settings with a single command

09 CB0B 00

SET

LAN Activate

Userlevel: Admin

09 CB35 01 ac

Action

0x00

Activate

09 CB35 00

GET

LAN Status

Userlevel: User

08 CB81 00

08 CB81 02 st sp

Status

0x00

Disconnected

0x01

Connected

0x02

Scanning

0x03

Authenticating

0x04

Failed

LinkSpeed

0x00

Unknown

0x01

10Mbit/s

0x02

100Mbit/s

0x03

1Gbit/s

0x04

2.5Gbit/s

GET

LAN Authentification Mode

Userlevel: Admin

08 CBC4 00

08 CBC4 01 oo

0x00

Off

0x01

SET

LAN Authentification Mode

Userlevel: Admin

09 CBC4 01 oo

0x00

Off

0x01

09 CBC4 00

GET

LAN Certificate Method

Userlevel: Admin

08 CBC5 00

08 CBC5 01 me

Method

0x00

PEAP-MSCHAPV2

0x01

TTLS-PAP

SET

LAN Certificate Method

Userlevel: Admin

09 CBC5 01 me

Method

0x00

PEAP-MSCHAPV2

0x01

TTLS-PAP

09 CBC5 00

GET

LAN Identity

Userlevel: Admin

08 CBC6 00

08 CBC6 ab i₀..i_n

i₀..i_n^inf

Identity

Max. 63 bytes

SET

LAN Identity

Userlevel: Admin

09 CBC6 ab i₀..i_n

i₀..i_n^inf

Identity

Max. 63 bytes

09 CBC6 00

GET

LAN Anonymous Identity

Userlevel: Admin

08 CBC7 00

08 CBC7 ab i₀..i_n

i₀..i_n^inf

Identity

Max. 63 bytes

SET

LAN Anonymous Identity

Userlevel: Admin

09 CBC7 ab i₀..i_n

i₀..i_n^inf

Identity

Max. 63 bytes

09 CBC7 00

GET

LAN Password

Userlevel: Admin

08 CBC8 00

08 CBC8 ab p₀..p_n

p₀..p_n^inf

Password

Max. 63 bytes

SET

LAN Password

Userlevel: Admin

09 CBC8 ab p₀..p_n

p₀..p_n^inf

Password

Max. 63 bytes

09 CBC8 00

GET

LAN Certficate Mode

Userlevel: Admin

08 CBC9 00

08 CBC9 01 oo

0x00

Off

0x01

SET

LAN Certficate Mode

Userlevel: Admin

09 CBC9 01 oo

0x00

Off

0x01

09 CBC9 00

GET

LAN Certificate Name

Userlevel: Admin

08 CBCA 00

08 CBCA ab n₀..n_n

n₀..n_n^inf

Name

Max. 255 bytes

SET

LAN Certificate Name

Userlevel: Admin

09 CBCA ab n₀..n_n

n₀..n_n^inf

Name

Max. 255 bytes

09 CBCA 00

GET

LAN Certificate File

Userlevel: Admin

08 CBCB 00

0C CBCB ab cd j₀..j_n

j₀..j_n^inf

Certificate file list

Certificate file list as JSON string

Syntax:

name: Certificate filename
active
- 0: No
- 1: Yes

Example:
[{"name": "certificate1.cer", "active": 0}, {"name": "certificate2.cer", "active": 1}]

SET

LAN Certificate File

Userlevel: Admin

0B01 CBCB ab cd ef gh ac lf f₀..f_n b₀..b_n

Action

0x00

Delete

0x01

Save

0x02

Verify

Filename length

f₀..f_n

Filename

b₀..b_n^inf

Binary file data

09 CBCB 00

GET

LAN DNS2

Userlevel: Admin

08 CBD1 00

08 CBD1 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently used DNS2

08 CBD1 01 so

Source

0x00

Static DNS2

08 CBD1 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently set Static DNS2. If DHCP is set to Off, this is also the currently used DNS2

08 CBD1 01 so

Source

0x01

DHCP DNS2

08 CBD1 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently set DHCP DNS2. If DHCP is set to On, this is also the currently used DNS2

SET

LAN DNS2

Userlevel: Admin

09 CBD1 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

09 CBD1 00

GET

LAN Priority

Userlevel: Admin

08 CBEC 00

08 CBEC 01 pr

0x00

Priority 1

0x01

Priority 2

0x02

Priority 3

SET

LAN Priority

Userlevel: Admin

09 CBEC 01 pr

0x00

Priority 1

0x01

Priority 2

0x02

Priority 3

09 CBEC 00

LAN Interface 2 (36)

GET

LAN2 Mode

Userlevel: Admin

08 CBF2 00

08 CBF2 01 mo

Mode

0x00

Visualizer

0x01

LAN

SET

LAN2 Mode

Userlevel: Admin

09 CBF2 01 mo

Mode

0x00

Visualizer

0x01

LAN

09 CBF2 00

GET

LAN2 DHCP

Userlevel: Admin

08 CBF3 00

08 CBF3 01 oo

0x00

Off

0x01

SET

LAN2 DHCP

Userlevel: Admin

09 CBF3 01 oo

0x00

Off

0x01

09 CBF3 00

GET

LAN2 IP Address

Userlevel: None

08 CBF4 00

08 CBF4 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently used IP address

08 CBF4 01 so

Source

0x00

Static IP

08 CBF4 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently set Static IP address. If DHCP is set to Off, this is also the currently used IP address

08 CBF4 01 so

Source

0x01

DHCP IP

08 CBF4 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently set DHCP IP address. If DHCP is set to On, this is also the currently used IP address

SET

LAN2 IP Address

Userlevel: Admin

09 CBF4 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

09 CBF4 00

GET

LAN2 Subnet Mask

Userlevel: Admin

08 CBF5 00

08 CBF5 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently used subnet mask

08 CBF5 01 so

Source

0x00

Static subnet mask

08 CBF5 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently set Static subnet mask. If DHCP is set to Off, this is also the currently used subnet mask

08 CBF5 01 so

Source

0x01

DHCP subnet mask

08 CBF5 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently set DHCP subnet mask. If DHCP is set to On, this is also the currently used subnet mask

SET

LAN2 Subnet Mask

Userlevel: Admin

09 CBF5 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

09 CBF5 00

GET

LAN2 Gateway

Userlevel: Admin

08 CBF6 00

08 CBF6 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently used gateway

08 CBF6 01 so

Source

0x00

Static gateway

08 CBF6 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently set Static gateway. If DHCP is set to Off, this is also the currently used gateway

08 CBF6 01 so

Source

0x01

DHCP gateway

08 CBF6 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently set DHCP gateway. If DHCP is set to On, this is also the currently used gateway

SET

LAN2 Gateway

Userlevel: Admin

09 CBF6 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

09 CBF6 00

GET

LAN2 DNS1

Userlevel: Admin

08 CBF7 00

08 CBF7 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently used DNS1

08 CBF7 01 so

Source

0x00

Static DNS1

08 CBF7 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently set Static DNS1 address. If DHCP is set to Off, this is also the currently used DNS1

08 CBF7 01 so

Source

0x01

DHCP DNS1

08 CBF7 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently set DHCP DNS1. If DHCP is set to On, this is also the currently used DNS1

SET

LAN2 DNS1

Userlevel: Admin

09 CBF7 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

09 CBF7 00

GET

LAN2 DNS2

Userlevel: Admin

08 CBF8 00

08 CBF8 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently used DNS2

08 CBF8 01 so

Source

0x00

Static DNS2

08 CBF8 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently set Static DNS2. If DHCP is set to Off, this is also the currently used DNS2

08 CBF8 01 so

Source

0x01

DHCP DNS2

08 CBF8 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Currently set DHCP DNS2. If DHCP is set to On, this is also the currently used DNS2

SET

LAN2 DNS2

Userlevel: Admin

09 CBF8 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

09 CBF8 00

GET

LAN2 MAC

Userlevel: None

08 CBF9 00

08 CBF9 11 m₀..m₁₆

m₀..m₁₆

MAC address

MAC address as string: e.g. 00:0C:92:BC:61:2B

GET

LAN2 DHCP State

Userlevel: Admin

08 CBFA 00

08 CBFA 01 st

State

0x00

Off

0x01

Failed

0x02

Trying

0x03

0x04

Unknown

GET

LAN2 Status

Userlevel: User

08 CBFB 00

08 CBFB 02 st sp

Status

0x00

Disconnected

0x01

Connected

0x02

Scanning

0x03

Authenticating

0x04

Failed

LinkSpeed

0x00

Unknown

0x01

10Mbit/s

0x02

100Mbit/s

0x03

1Gbit/s

0x04

2.5Gbit/s

GET

LAN2 Authentification Mode

Userlevel: Admin

08 CBFC 00

08 CBFC 01 oo

0x00

Off

0x01

SET

LAN2 Authentification Mode

Userlevel: Admin

09 CBFC 01 oo

0x00

Off

0x01

09 CBFC 00

GET

LAN2 Certificate Method

Userlevel: Admin

08 CBFD 00

08 CBFD 01 me

Method

0x00

PEAP-MSCHAPV2

0x01

TTLS-PAP

SET

LAN2 Certificate Method

Userlevel: Admin

09 CBFD 01 me

Method

0x00

PEAP-MSCHAPV2

0x01

TTLS-PAP

09 CBFD 00

GET

LAN2 Identity

Userlevel: Admin

08 CBFE 00

08 CBFE ab i₀..i_n

i₀..i_n^inf

Identity

Max. 63 bytes

SET

LAN2 Identity

Userlevel: Admin

09 CBFE ab i₀..i_n

i₀..i_n^inf

Identity

Max. 63 bytes

09 CBFE 00

GET

LAN2 Anonymous Identity

Userlevel: Admin

08 CBFF 00

08 CBFF ab i₀..i_n

i₀..i_n^inf

Identity

Max. 63 bytes

SET

LAN2 Anonymous Identity

Userlevel: Admin

09 CBFF ab i₀..i_n

i₀..i_n^inf

Identity

Max. 63 bytes

09 CBFF 00

GET

LAN2 Password

Userlevel: Admin

08 CC00 00

08 CC00 ab p₀..p_n

p₀..p_n^inf

Password

Max. 63 bytes

SET

LAN2 Password

Userlevel: Admin

09 CC00 ab p₀..p_n

p₀..p_n^inf

Password

Max. 63 bytes

09 CC00 00

GET

LAN2 Certficate Mode

Userlevel: Admin

08 CC01 00

08 CC01 01 oo

0x00

Off

0x01

SET

LAN2 Certificate Mode

Userlevel: Admin

09 CC01 01 oo

0x00

Off

0x01

09 CC01 00

GET

LAN2 Certificate Name

Userlevel: Admin

08 CC02 00

08 CC02 ab n₀..n_n

n₀..n_n^inf

Name

Max. 255 bytes

SET

LAN2 Certificate Name

Userlevel: Admin

09 CC02 ab n₀..n_n

n₀..n_n^inf

Name

Max. 255 bytes

09 CC02 00

GET

LAN2 Certificate File

Userlevel: Admin

08 CC03 00

0C CC03 ab cd j₀..j_n

j₀..j_n^inf

Certificate file list

Certificate file list as JSON string

Syntax:

name: Certificate filename
active
- 0: No
- 1: Yes

Example:
[{"name": "certificate1.cer", "active": 0}, {"name": "certificate2.cer", "active": 1}]

SET

LAN2 Certificate File

Userlevel: Admin

0B01 CC03 ab cd ef gh ac lf f₀..f_n b₀..b_n

Action

0x00

Delete

0x01

Save

0x02

Verify

Filename length

f₀..f_n

Filename

b₀..b_n^inf

Binary file data

09 CC03 00

GET

LAN2 Priority

Userlevel: Admin

08 CC04 00

08 CC04 01 pr

0x00

Priority 1

0x01

Priority 2

0x02

Priority 3

SET

LAN2 Priority

Userlevel: Admin

09 CC04 01 pr

0x00

Priority 1

0x01

Priority 2

0x02

Priority 3

09 CC04 00

SET

LAN2 Activate

Userlevel: Admin

09 CC05 01 ac

Action

0x00

Activate

09 CC05 00

Lecture Capture (18)

GET

Lecture Capture Settings

Userlevel: Annotation

08 CC9C 00

08 CC9C ab ty it ih im pa es lf f₀..f_n

Type

0x00

Disabled

0x01

Panopto

0x02

Opencast Adhoc

0x03

Opencast Auto

0x04

Panopto Adhoc Legacy

0x05

Panopto Adhoc OAuth2

Ingest time mode

0x00

Auto

0x01

Manual

Ingest time hour

0x00..0x17

Hour (0..23)

Ingest time minute

0x00..0x3B

Minute (0..59)

Path

0x00

Internal

Extern Source

0x00

Disabled

0x01

Enabled

Filename prefix length

Max. 64 bytes

f₀..f_n

Filename prefix

Custom prefix, prepended to name of recording

SET

Lecture Capture Settings

Userlevel: Admin

09 CC9C ab ty it ih im pa es lf f₀..f_n

Type

0x00

Disabled

0x01

Panopto Remote Recorder

0x02

Opencast Adhoc

0x03

Opencast Auto

0x04

Panopto Adhoc Legacy

0x05

Panopto Adhoc OAuth2

Ingest time mode

0x00

Auto

0x01

Manual

Ingest time hour

0x00..0x17

Hour (0..23)

Ingest time minute

0x00..0x3B

Minute (0..59)

Path

0x00

Internal

Extern Source

0x00

Disabled

0x01

Enabled

Filename prefix length

Max. 64 bytes

f₀..f_n

Filename prefix

Custom prefix, prepended to name of recording

09 CC9C 00

SET

Lecture Capture Start Recording

Userlevel: User

09 CC9D ab ty ic lu uf₀..uf_n lf f₀..f_n

Type

0x01

Panopto

IP camera mode

0x00

Disabled

0x01

Enabled: Capture IP camera input to second recording

Uploadfolder ID length

Max. 255 bytes

uf₀..uf_n

Uploadfolder ID

Filename prefix length

Max. 64 bytes

f₀..f_n

Filename prefix

Custom prefix, prepended to name of recording

09 CC9D 00

09 CC9D ab ty ic ls si₀..si_n lc c₀..c_n lt t₀..t_n

Type

0x02

Opencast Adhoc

IP camera mode

0x00

Disabled

0x01

Enabled: Capture IP camera input to second recording

Series ID length

Max. 255 bytes

si₀..si_n

Series ID

Creator Name length

Max. 255 bytes

c₀..c_n

Creator Name

Title length

Max. 255 bytes

t₀..t_n

Title

09 CC9D 00

GET

Panopto Subdirectories

Userlevel: User

08 CCA0 00

0C CCA0 ab cd dt₀..dt_n

dt₀..dt_n^inf

Directory tree

Directory tree as JSON string

Syntax:

Name: Name of directory
ID: Directory ID
Childs: Array of subdirectories
- Name: Name of subdirectory
- ID: Subdirectory ID
- childs: Array of subdirectories
- ParentID: ID of parent directory
- RW: Read/Write permission
  - 0: No
  - 1: Yes

Example:
{"Name": "/", "id": "1", "Childs": [{"Name": "SubDir01", "id": "2", "Childs": [{"Name": "SubSubDir01", "id": "3", "Childs": [], "ParentID": "2", "RW": "1"}], "ParentID": "1", "RW": "0"}]}

08 CCA0 ab lf f₀..f_n

Folder ID length

Max. 255 bytes

f₀..f_n

Folder ID

Root-Folder ID: 00000000-0000-0000-0000-000000000000

08 CCA0 ab cf₀..cf_n

cf₀..cf_n^inf

Child Folders

JSON string

Syntax:

status: Status of requested folders
- 0: Unknown
- 1: Incomplete
- 2: Complete
id: Folder ID
Childs: Array of child folders
- Name: Name of subdirectory
- ID: Subdirectory ID
- ParentID: ID of parent directory
- RW: Read/Write permission
  - 0: No
  - 1: Yes

Example:
{"status": "0", "id": "00000000-0000-0000-0000-000000000000", "Childs": [{"Name": "SubDir01", "ID": "36685465-a152-4baf-8579-a8f700f606ab", "ParentID": "8348fb82-48f6-4412-a026-a8f700f93633", "RW": "0"} {"Name": "SubDir01", "ID": "36685465-a152-4baf-8579-a8f700f606ab", "ParentID": "8348fb82-48f6-4412-a026-a8f700f93633", "RW": "0"} ]}

GET

Panopto Settings

Userlevel: User

08 CCA1 00

0C CCA1 ab cd lh h₀..h_n lu u₀..u_n lp p₀..p_n ce lk k₀..k_n li i₀..i_n ls s₀..s_n cu

Hostname URL length

Max. 255 bytes

h₀..h_n

Hostname URL

Username length

Max. 255 bytes

u₀..u_n

Username

Password length

Max. 255 bytes

p₀..p_n

Password

(valid data will be only returned for user level "admin")

Certificate

0x00

Certificate for Panopto disabled

0x01

Certificate for Panopto enabled

Remote Recorder Registration Key length

Max. 255 bytes

k₀..k_n

Remote Recorder Registration Key

(valid data will be only returned for user level "admin")

Client ID length

Max. 255 bytes

i₀..i_n

Client ID

(valid data will be only returned for user level "admin")

Client Secret length

Max. 255 bytes

s₀..s_n

Client Secret

(valid data will be only returned for user level "admin")

Custom User Mode

0x00

Disabled

0x01

Enabled

SET

Panopto Settings

Userlevel: Admin

0B01 CCA1 ab cd ef gh lh h₀..h_n lu u₀..u_n lp p₀..p_n cm lce₀..lce₁ ce₀..ce_n lk k₀..k_n li i₀..i_n ls s₀..s_n cu

Hostname URL length

Max. 255 bytes

h₀..h_n

Hostname URL

Username length

Max. 255 bytes

u₀..u_n

Username

Password length

Max. 255 bytes

p₀..p_n

Password

Certificate Mode

0x00

Certificate for Panopto disabled

0x01

Certificate for Panopto enabled

lce₀..lce₁

Certificate length

Max. 65535 bytes

ce₀..ce_n

Certificate blob

Remote Recorder Registration Key length

Max. 255 bytes

k₀..k_n

Remote Recorder Registration Key

Client ID length

Max. 255 bytes

i₀..i_n

Client ID

Client Secret length

Max. 255 bytes

s₀..s_n

Client Secret

Custom User Mode

0x00

Disabled

0x01

Enabled

09 CCA1 00

GET

Panopto Status

Userlevel: User

08 CCA3 00

08 CCA3 02 st sr

State

0x00

Not logged in

0x01

0x02

State Remote Recorder

0x00

Not logged in

0x01

0x02

08 CCA3 01 ve

Version

0x00

Version1

0C CCA3 ab cd st sr ul u₀..u_n

State

0x00

Not logged in

0x01

0x02

State Remote Recorder

0x00

Not logged in

0x01

0x02

Username length

Max. 255 bytes

u₀..u_n

Username

GET

Lecture Capture Upload Status

Userlevel: User

08 CCA4 00

08 CCA4 02 pu lu

Pending uploads

Last upload status

0x00

Unknown

0x01

0x02

Failed

GET

Opencast Series

Userlevel: User

08 CCBD 00

0A01 CCBD ab cd ef gh dt₀..dt_n

dt₀..dt_n^inf

Series List

Series as JSON string

Syntax:

id: Series ID
title: Series Title

Example:
[{"title": "Serie 1", "id": "32878111-dc9a-443b-8d37-d1cf6c611383"},{"title": "Serie 2", "id": "32878111-dc9a-443b-8d37-d1cf6c611383"}];

GET

Opencast Settings

Userlevel: Admin

08 CCBE 00

0A01 CCBE ab cd ef gh lh h₀..h_n lc c₀..c_n lu u₀..u_n lp p₀..p_n lw w₀..w_n cm

Hostname URL length

Max. 255 bytes

h₀..h_n

Hostname URL

Capture Agent Name length

Max. 255 bytes

c₀..c_n

Capture Agent Name

Username length

Max. 255 bytes

u₀..u_n

Username

Password length

Max. 255 bytes

p₀..p_n

Password

Workflow ID length

Max. 255 bytes

w₀..w_n

Workflow ID

Certificate Mode

0x00

Certificate for Opencast disabled

0x01

Certificate for Opencast enabled

SET

Opencast Settings

Userlevel: Admin

0B01 CCBE ab cd ef gh lh h₀..h_n lc c₀..c_n lu u₀..u_n lp p₀..p_n lw w₀..w_n cm lce₀..lce₁ ce₀..ce_n

Hostname URL length

Max. 255 bytes

h₀..h_n

Hostname URL

Capture Agent Name length

Max. 255 bytes

c₀..c_n

Capture Agent Name

Username length

Max. 255 bytes

u₀..u_n

Username

Password length

Max. 255 bytes

p₀..p_n

Password

Workflow ID length

Max. 255 bytes

w₀..w_n

Workflow ID

Certificate Mode

0x00

Certificate for Opencast disabled

0x01

Certificate for Opencast enabled

lce₀..lce₁

Certificate length

Max. 65535 bytes

ce₀..ce_n

Certificate blob

09 CCBE 00

GET

Opencast Events

Userlevel: User

08 CCBF 00

0A01 CCBF ab cd ef gh dt₀..dt_n

dt₀..dt_n^inf

Event List

Events as JSON string

Syntax:

start: Event start (Unix Epoch time)
stop: Event stop (Unix Epoch time)
title: Event title
series_title: Title of Series

Example:
[{"start": 1537858800, "stop": 1537862400, "title": "No Series"}, {"start": 1537923600, "stop": 1537927200, "series_title": "Hello World", "title": "Test123 09"}];

GET

Opencast Status

Userlevel: User

08 CCC0 00

08 CCC0 01 st

State

0x00

Not logged in

0x01

0x02

GET

Panopto Directory List Status

Userlevel: User

08 CD26 00

08 CD26 01 st

Status

0x00

Unknown

0x01

Updating

0x02

0x03

Failed

SET

Panopto Directory List

Userlevel: User

09 CD27 01 ac

Action

0x00

Reset Status

0x01

Update

09 CD27 00

SET

Panopto Custom User Credentials

Userlevel: User

0D CD33 ab cd lu u₀..u_n lp p₀..p_n

Username length

Max. 255 bytes

u₀..u_n

Username

Password length

Max. 255 bytes

p₀..p_n

Password

09 CD33 00

GET

Panopto Login Dialog

Userlevel: User

08 CD34 00

08 CD34 01 di

Dialog

0x00

None

0x01

Username and Password

0x02

Browser

SET

Panopto Browser

Userlevel: User

09 CD3E 01 ac

Action

0x00

Logout

0x01

09 CD3E 00

Matrix (48)

GET

Master Discovered Devices

Userlevel: Admin

08 CC7E 00

0C CC7E ab cd lb₀..lb₁ mf s₀..s₃ ip₀..ip₃ lv v₀..v_n ln₀..ln₁ n₀..n_n lm m₀..m_n bm

lb₀..lb₁

Block length

Combined length of Matrix flags, Serial number, IP address, Firmware version string length, Firmware version string, Name length, Name, Model length, Model and Bridge mode. Max. 65535 bytes

Matrix flags: Flag field for indication of matrix specific device properties

0x01

Matrix supported

0x02

Master mode enabled

0x04

Station mode enabled

s₀..s₃

Serial number

0x00000001..0x05F5E0FF

00000001..99999999

ip₀..ip₃

IP address

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Firmware version string length

Max. 255 bytes

v₀..v_n

Firmware version string

ln₀..ln₁

Name length

Max. 65535 bytes

n₀..n_n

Name

Model length

Max. 255 bytes

m₀..m_n

Model

Bridge mode

0x00

Receiver

0x01

Sender

0xFF

Not supported

The parameters Block length, Matrix flags, Serial number, IP address, Firmware version string length, Firmware version string, Name length, Name, Model length, Model and Bridge mode are combined in a block called Device infos. In this specification, only the Device infos block for device 0 is listed but this block is actually repeated for each discovered device. Note: Bridge mode only applies to model CBB

GET

Master Status

Userlevel: User

08 CC7F 00

0C CC7F ab cd lb₀..lb₁ sp s₀..s₃ ln₀..ln₁ n₀..n_n sl sh lm₀..lm₁ m₀..m_n pa pc pi ac ct

lb₀..lb₁

Block length

Combined length of station status block (Station presence, Serial number, Name length, ...) Max. 65535 bytes

Station presence

0x00

Not present

0x01

Present

s₀..s₃

Serial number of station

0x00000001..0x05F5E0FF

00000001..99999999

ln₀..ln₁

Name length

Max. 65535 bytes

n₀..n_n

Name

Station pull

0x00

Off

0x01

Station push

0x00

Off

0x01

lm₀..lm₁

Master name length

Max. 65535 bytes

m₀..m_n

Master name

Station push audio status

0x00

Disabled

0x01

Enabled

Matrix protocol compatibility

0x00

0x01

Legacy station

0x02

Outdated station

0x03

Outdated master

0x04

Legacy master

Push index

0x00..0x03

Input stream 1..4 as stream source

0xFF

Matrix master stream source (HDMI1)

0xFC

Matrix master stream source (HDMI2)

Access

0x00

Full

0x01

Limited

0x02

Locked

Control

0x00

Off

0x01

The return values are organised in repeating blocks for station0 .. n. Each block has a size of Block length with the same content (Station presence, Serial number, Name length, ...)

08 CC7F 00

0C CC7F ab cd lb₀..lb₁ sp s₀..s₃ ln₀..ln₁ n₀..n_n sl sh lm₀..lm₁ m₀..m_n pa pc pi ac ct po ps bm

lb₀..lb₁

Block length

Combined length of station status block (Station presence, Serial number, Name length, ...) Max. 65535 bytes

Station presence

0x00

Not present

0x01

Present

s₀..s₃

Serial number of station

0x00000001..0x05F5E0FF

00000001..99999999

ln₀..ln₁

Name length

Max. 65535 bytes

n₀..n_n

Name

Station pull

0x00

Off

0x01

Station push

0x00

Off

0x01

lm₀..lm₁

Master name length

Max. 65535 bytes

m₀..m_n

Master name

Station push audio status

0x00

Disabled

0x01

Enabled

Matrix protocol compatibility

0x00

0x01

Legacy station

0x02

Outdated station

0x03

Outdated master

0x04

Legacy master

Push index

0x00..0x03

Input stream 1..4 as stream source

0xFF

Matrix master stream source (HDMI1)

0xFC

Matrix master stream source (HDMI2)

Access

0x00

Full

0x01

Limited

0x02

Locked

Control

0x00

Off

0x01

Pull Output

0x00

No output

0x01

HDMI1

0x02

HDMI2

Push Side by Side

0x00

Off

0x01

Bridge mode

0x00

Receiver

0x01

Sender

0xFF

Not supported

The return values are organised in repeating blocks for station0 .. n. Each block has a size of Block length with the same content (Station presence, Serial number, Name length, ...). Note: Bridge mode only applies to station model CBB

GET

Master Setup Station

Userlevel: User

08 CC80 01 ti

Template index

0x00..0x04

0..4

0C CC80 ab cd lb₀..lb₁ s₀..s₃ pa ps

lb₀..lb₁

Block length

Combined length of Serial number, Push audio and Side by side enable. Max. 65535 bytes

s₀..s₃

Serial number of station

0x00000001..0x05F5E0FF

00000001..99999999

Push audio to station

0x00

Disabled

0x01

Enabled

Station push side by side

0x00

Disabled

0x01

Enabled

The return values are organised in repeating blocks for station0 .. n. Each block has a size of Block length with the same content (Serial number, Push audio to station, ...)

SET

Master Setup Station

Userlevel: Admin

0D CC80 ab cd ti lb₀..lb₁ s₀..s₃ pa ps

Template index

0x00..0x04

0..4

lb₀..lb₁

Block length

Length of following block, containing Serial number, Push audio and Side by side enable

s₀..s₃

Serial number of station

0x00000001..0x05F5E0FF

00000001..99999999

Push audio to station

0x00

Disable

0x01

Enable

Station push side by side

0x00

Disable

0x01

Enable

This command starts with the index of the matrix template it addresses. Further it contains an arbitrary number of blocks, each 8 bytes long. Every block represents the configuration for a station and starts with 2 bytes containing the block length which specifies the amount of bytes used by this entry.

09 CC80 00

SET

Master Pull

Userlevel: User

09 CC81 0f ac s₀..s₃ o₀..o₁ ra₀..ra₇

Action

0x01

Start

s₀..s₃

Serial number of station

0x00000001..0x05F5E0FF

00000001..99999999

o₀..o₁

Output Selection

0x0001 = HDMI1
0x0002 = HDMI2

ra₀..ra₇

Replace application ID

0 if no replace is needed

09 CC81 00

09 CC81 05 ac s₀..s₃

Action

0x00

Stop

0x01

Start

s₀..s₃

Serial number of station

0x00000001..0x05F5E0FF

00000001..99999999

09 CC81 00

SET

Master Push

Userlevel: User

09 CC82 05 ac s₀..s₃

Action

0x00

Stop

0x01

Start

s₀..s₃

Serial number of station

0x00000000

Push to all stations

0x00000001..0x05F5E0FF

00000001..99999999

09 CC82 00

09 CC82 06 ac s₀..s₃ pi

Action

0x00

Stop

0x01

Start

s₀..s₃

Serial number of station

0x00000000

Push to all stations

0x00000001..0x05F5E0FF

00000001..99999999

Push index

0x00..0x03

Input stream 1..4 as stream source

0xFF

Matrix master stream source (HDMI1)

0xFC

Matrix master stream source (HDMI2)

09 CC82 00

09 CC82 09 ac s₀..s₃ d₀..d₃

Action

0x00

Stop

0x01

Start

s₀..s₃

Serial number of source station

0x00000001..0x05F5E0FF

00000001..99999999

d₀..d₃

Serial number of destination station

0x00000001..0x05F5E0FF

00000001..99999999

Station to station push via master

09 CC82 00

GET

Master Preview Picture

Userlevel: User

08 CC83 09 s₀..s₃ w₀..w₁ h₀..h₁ fr

s₀..s₃

Serial number

0x00000001..0x05F5E0FF

00000001..99999999

w₀..w₁

Preferred preview picture width in pixels. The resolution of the returned image can vary temporarily as well as permanent.

0x0040..0x0780

64..1920

h₀..h₁

Preferred preview picture height in pixels. The resolution of the returned image can vary temporarily as well as permanent.

0x0040..0x0438

64..1080

Demanded framerate (fps) the preview picture is generated

0x01..0x1E

1..30

0A01 CC83 ab cd ef gh s₀..s₃ w₀..w₁ h₀..h₁ lp₀..lp₃ p₀..p_n

s₀..s₃

Serial number

0x00000001..0x05F5E0FF

00000001..99999999

w₀..w₁

Preview picture width in pixels

0x0040..0x0780

64..1920

h₀..h₁

Preview picture height in pixels

0x0040..0x0438

64..1080

lp₀..lp₃

Preview picture data length

p₀..p_n

Preview picture data

SET

Master File Share Add

Userlevel: User

0B01 CC87 ab cd ef gh s₀..s₃ fl₀..fl₁ fp₀..fp_n

s₀..s₃

Serial number of station

0x00000000

Add share to all stations

0x00000001..0x05F5E0FF

00000001..99999999

fl₀..fl₁

Filepath length

Max. 65535 bytes

fp₀..fp_n

File path

Fully qualified filename: e.g. Internal:///snapshots/file.jpg

09 CC87 00

SET

Matrix File Share Remove

Userlevel: User

0B01 CC88 ab cd ef gh s₀..s₃ lf₀..lf₁ f₀..f_n

s₀..s₃

Serial number of station

0x00000000

Remove share from all stations

0x00000001..0x05F5E0FF

00000001..99999999

lf₀..lf₁

Filename length

Max. 65535 bytes

f₀..f_n

Filename

Filename of shared file: e.g. file.jpg

09 CC88 00

GET

Matrix Master Mode

Userlevel: User

08 CC89 00

08 CC89 01 st

0x00

Disabled

0x01

Enabled

SET

Matrix Master Mode

Userlevel: Admin

09 CC89 01 st

0x00

Disable

0x01

Enable

09 CC89 00

GET

Auto Open File

Userlevel: User

08 CC8A 00

08 CC8A 01 oo

0x00

Off

0x01

SET

Auto Open File

Userlevel: Admin

09 CC8A 01 oo

0x00

Off

0x01

09 CC8A 00

GET

Master Active Template

Userlevel: User

08 CC8D 00

08 CC8D 01 ti

Template index

0x00..0x04

0..4

SET

Master Active Template

Userlevel: User

09 CC8D ab ti lt l₀..l_n

Template index

0x00..0x04

0..4

Template name length

Max. 255 bytes

l₀..l_n

Template name

09 CC8D 00

GET

Station Status

Userlevel: None

08 CC90 00

0C CC90 ab cd mo ps lm₀..lm₁ m₀..m_n pa pi lp₀..lp₁ p₀..p_n as sb

Station mode

0x00

Off

0x01

Push status

0x00

Off

0x01

lm₀..lm₁

Master name length

Max. 65535 bytes

m₀..m_n

Master Name

Push audio status

0x00

Disabled

0x01

Enabled

Push index

0x00..0x03

Input stream 1..4 as stream source

0xFF

Matrix master stream source

lp₀..lp₁

Push stream name length

Max. 65535 bytes

p₀..p_n

Push stream name

Access status

0x00

Full

0x01

Limited

0x02

Locked

Push side by side

0x00

Off

0x01

SET

Master Power Station

Userlevel: User

0B01 CCB2 07 lb₀..lb₁ ac s₀..s₃

lb₀..lb₁

Block length

Length of following block, containing action and serial

Action

0x00

Power off

0x01

Power on

s₀..s₃

Serial number of station to which this action belongs

This command contains an arbitrary number of blocks, each 7 bytes long. Every block starts with 2 bytes containing the block length which specifies the amount of bytes used by this entry.

09 CCB2 00

09 CCB2 01 ac

Action

0x00

Power off all stations in active template

0x01

Power on all stations in active template

09 CCB2 00

GET

Station Master Annotation Status

Userlevel: Annotation

08 CCB4 00

08 CCB4 01 st

Status

0x00

Disabled

0x01

Enabled

0x02

Paused

GET

Master Collaboration Mode

Userlevel: User

08 CCB5 00

08 CCB5 01 st

0x00

Disabled

0x01

Enabled

SET

Master Collaboration Mode

Userlevel: Admin

09 CCB5 01 st

0x00

Disable

0x01

Enable

09 CCB5 00

SET

Station Session Folder

Userlevel: User

0D CCC1 ab cd ty lu u₀..u_n lun un₀..un_n lp p₀..p_n ld d₀..d_n ls s₀..s_n

Type

0x00

None

0x01

CIFS

0x02

NFS

URL length

Max. 255 bytes

u₀..u_n

URL

lun

Username length

Max. 255 bytes

un₀..un_n

Username

Password length

Max. 255 bytes

p₀..p_n

Password

Domain length

Max. 255 bytes

d₀..d_n

Domain

Subdirectory length

Max. 255 bytes

s₀..s_n

Subdirectory

09 CCC1 00

GET

Master Session Folder

Userlevel: Admin

08 CCC2 00

0C CCC2 ab cd ty lu u₀..u_n lun un₀..un_n lp p₀..p_n ld d₀..d_n

Type

0x00

None

0x01

CIFS

0x02

NFS

URL length

Max. 255 bytes

u₀..u_n

URL

lun

Username length

Max. 255 bytes

un₀..un_n

Username

Password length

Max. 255 bytes

p₀..p_n

Password

Domain length

Max. 255 bytes

d₀..d_n

Domain

SET

Master Session Folder

Userlevel: Admin

0D CCC2 ab cd ty lu u₀..u_n lun un₀..un_n lp p₀..p_n ld d₀..d_n

Type

0x00

None

0x01

CIFS

0x02

NFS

URL length

Max. 255 bytes

u₀..u_n

URL

lun

Username length

Max. 255 bytes

un₀..un_n

Username

Password length

Max. 255 bytes

p₀..p_n

Password

Domain length

Max. 255 bytes

d₀..d_n

Domain

09 CCC2 00

GET

Session Folder Status

Userlevel: Admin

08 CCC3 00

08 CCC3 01 st

Status

0x00

Disabled

0x01

Not mounted

0x02

Authenticate

0x03

Busy

0x04

Not responding

0x05

Mounted read only

0x06

Mounted write only

0x07

Mounted read write

0x08

Failed

GET

Matrix Master Streaming Bitrate

Userlevel: Admin

08 CCDF 00

08 CCDF 03 mo br₀..br₁

Bitrate Mode

0x00

Constant

0x01

Variable

br₀..br₁

Bitrate

Average bitrate in kBit for 'Variable' mode

SET

Matrix Master Streaming Bitrate

Userlevel: Admin

09 CCDF 03 mo br₀..br₁

Bitrate Mode

0x00

Constant

0x01

Variable

br₀..br₁

Bitrate

Average bitrate in kBit for 'Variable' mode

09 CCDF 00

GET

Matrix Master Streaming Resolution

Userlevel: Admin

08 CCE0 00

08 CCE0 01 re

Resolution

0x00

Full HD (1080p, 1920x1080)

0x01

HD (720p, 1280x720)

0x02

qHD (540p, 960x540)

0x03

nHD (360p, 640x360)

SET

Matrix Master Streaming Resolution

Userlevel: Admin

09 CCE0 01 re

Resolution

0x00

Full HD (1080p, 1920x1080)

0x01

HD (720p, 1280x720)

0x02

qHD (540p, 960x540)

0x03

nHD (360p, 640x360)

09 CCE0 00

GET

Matrix Master Streaming Framerate

Userlevel: Admin

08 CCE1 00

08 CCE1 01 fr

Framerate

0x00

Low (10 FPS)

0x01

Medium (20 FPS)

0x02

High (30 FPS)

SET

Matrix Master Streaming Framerate

Userlevel: Admin

09 CCE1 01 fr

Framerate

0x00

Low (10 FPS)

0x01

Medium (20 FPS)

0x02

High (30 FPS)

09 CCE1 00

GET

Matrix Master Streaming Multicast IP

Userlevel: Admin

08 CCE2 00

08 CCE2 04 mi₀..mi₃

mi₀..mi₃

Multicast IP

0xF4000000..0xEFFFFFFF

224.0.0.0..239.255.255.255

SET

Matrix Master Streaming Multicast IP

Userlevel: Admin

09 CCE2 04 mi₀..mi₃

mi₀..mi₃

Multicast IP

0xF4000000..EFFFFFFF

224.0.0.0..239.255.255.255

09 CCE2 00

GET

Matrix Master Streaming Multicast Port

Userlevel: Admin

08 CCE3 00

08 CCE3 02 p₀..p₁

p₀..p₁

Multicast Port

0x157C..0x1770

Port (5500..6000)

SET

Matrix Master Streaming Multicast Port

Userlevel: Admin

09 CCE3 02 p₀..p₁

p₀..p₁

Multicast Port

0x157C..0x1770

Port (5500..6000)

09 CCE3 00

GET

Matrix Master Streaming Multicast TTL

Userlevel: Admin

08 CCE4 00

08 CCE4 01 tt

Multicast TTL

0x01..0xFF

TTL (1..255)

SET

Matrix Master Streaming Multicast TTL

Userlevel: Admin

09 CCE4 01 tt

Multicast TTL

0x01..0xFF

TTL (1..255)

09 CCE4 00

SET

Matrix Station Streaming Settings

Userlevel: User

0B01 CCE5 ab cd ef gh bm br₀..br₁ re fr mi₀..mi₃ p₀..p₁ tt

Bitrate Mode

0x00

Constant

0x01

Variable

br₀..br₁

Bitrate

Average bitrate in kBit for 'Variable' mode

re^inf

Resolution

0x00

Full HD (1080p, 1920x1080)

0x01

HD (720p, 1280x720)

0x02

qHD (540p, 960x540)

0x03

nHD (360p, 640x360)

Framerate

0x00

Low (10 FPS)

0x01

Medium (20 FPS)

0x02

High (30 FPS)

mi₀..mi₃

Multicast IP

0xF4000000..EFFFFFFF

224.0.0.0..239.255.255.255

p₀..p₁

Multicast Port

0x157C..0x1770

Port(5500..6000)

Multicast TTL

0x01..0xFF

TTL (1..255)

09 CCE5 00

GET

Master Groupwork Mode

Userlevel: User

08 CCF2 00

08 CCF2 01 st

0x00

Disabled

0x01

Enabled

SET

Master Groupwork Mode

Userlevel: Admin

09 CCF2 01 st

0x00

Disable

0x01

Enable

09 CCF2 00

GET

Station Groupwork Status

Userlevel: User

08 CCF6 00

08 CCF6 01 st

Status

0x00

Inactive

0x01

Active

GET

Station Groupwork Stations Status

Userlevel: User

08 CCF7 00

0C CCF7 ab cd lb₀..lb₁ sp gw s₀..s₃ ln₀..ln₁ n₀..n_n sp sh pc sr rr

lb₀..lb₁

Block length

Combined length of Station presence, Station in groupwork mode, Serial number, Length of name, Name, Station pull, Station push, Station compatibility, Sent request status and Received request status. Max. 65535 bytes

Station presence

0x00

Not present

0x01

Present

Groupwork mode on station

0x00

Inactive

0x01

Active

s₀..s₃

Serial number

0x00000001..0x05F5E0FF

00000001..99999999

ln₀..ln₁

Name length

Max. 65535 bytes

n₀..n_n

Name

Station pull

0x00

Disabled

0x01

Enabled

Station push

0x00

Disabled

0x01

Enabled

Matrix protocol compatibility

0x00

0x01

Legacy station

0x02

Outdated station

0x03

Outdated master

0x04

Legacy master

Station sent requested pull status

0x00

Rejected

0x01

Waiting

0x02

Timeout

0x03

Accepted

Station received requested pull status

0x00

Non waiting

0x01

Waiting

The parameters Block length, Station presence, Station in groupwork mode, Serial number, Length of name, Name, Station pull, Station push, Station compatibility, Sent request status and Received request status are combined in a block called Station info. In this specification, only the Station info block for station 0 is listed but this block is actually repeated for each station

SET

Station Groupwork Request Station Pull

Userlevel: User

09 CCF8 05 ac s₀..s₃

Action

0x00

Stop

0x01

Start

s₀..s₃

Serial number of station to which the request is directed

0x00000001..0x05F5E0FF

00000001..99999999

09 CCF8 00

SET

Station Groupwork Request Station Pull Answer

Userlevel: User

09 CCF9 05 an s₀..s₃

Answer

0x00

Reject

0x01

s₀..s₃

Serial number of station from which the request is coming

0x00000001..0x05F5E0FF

00000001..99999999

09 CCF9 00

SET

Station Groupwork Pull Stop

Userlevel: User

09 CCFA 04 s₀..s₃

s₀..s₃

Serial number of station which is pulling a stream

0x00000001..0x05F5E0FF

00000001..99999999

09 CCFA 00

SET

Station Groupwork Pull Stop Local

Userlevel: User

09 CCFE 04 s₀..s₃

s₀..s₃

Serial number of station which window to close

0x00000001..0x05F5E0FF

00000001..99999999

09 CCFE 00

GET

Matrix Master Groupwork Forced

Userlevel: User

08 CD3A 00

08 CD3A 01 st

0x00

Disabled

0x01

Enabled

SET

Matrix Master Groupwork Forced

Userlevel: User

09 CD3A 01 st

0x00

Disable

0x01

Enable

09 CD3A 00

SET

Master Multi File Share Add

Userlevel: User

0D CD86 ab cd s₀..s₃ nf fl fp₀..fp_n fl fp₀..fp_n

s₀..s₃

Serial number of station

0x00000000

Add share to all stations

0x00000001..0x05F5E0FF

00000001..99999999

Number files

Max. 8

Filepath length

Max. 255

fp₀..fp_n

File path

Fully qualified filename: e.g. Internal:///snapshots/file.jpg

Filepath length

fp₀..fp_n

File path

Repeat following block nf times:

fl
fp0..fpn

09 CD86 00

Network (74)

GET

Preview Picture

Userlevel: Viewer

08 CB02 06 w₀..w₁ h₀..h₁ ty so

w₀..w₁

Preferred picture width

h₀..h₁

Preferred picture height

Picture type

0x00

JPEG

Source

0x00

HDMI Out 1 (Main)

0x01

HDMI In 1

0x02

HDMI In 2

0x04

Visualizer

0x05

Rec-Streaming

0x06

WebRTC

0x07

Edit

0x08

HDMI Out 2

0A01 CB02 ab cd ef gh w₀..w₁ h₀..h₁ lp₀..lp₃ p₀..p_n

w₀..w₁

Picture width

h₀..h₁

Picture height

lp₀..lp₃

Picture data length

p₀..p_n

Picture data

08 CB02 0d w₀..w₁ h₀..h₁ ty ai₀..ai₇

w₀..w₁

Preferred picture width

h₀..h₁

Preferred picture height

Picture type

0x00

JPEG

ai₀..ai₇

0A01 CB02 ab cd ef gh w₀..w₁ h₀..h₁ lp₀..lp₃ p₀..p_n

w₀..w₁

Picture width

h₀..h₁

Picture height

lp₀..lp₃

Picture data length

p₀..p_n

Picture data

GET

Miracast User Input Back Channel

Userlevel: Admin

08 CB33 00

08 CB33 01 st

0x00

Disabled

0x01

Enabled

SET

Miracast User Input Back Channel

Userlevel: Admin

09 CB33 01 st

0x00

Disable

0x01

Enable

09 CB33 00

GET

Miracast

Userlevel: Admin

08 CB36 00

08 CB36 01 st

0x00

Disabled

0x01

Enabled

SET

Miracast

Userlevel: Admin

09 CB36 01 st

0x00

Disable

0x01

Enable

09 CB36 00

GET

Airplay

Userlevel: Admin

08 CB37 00

08 CB37 01 st

0x00

Disabled

0x01

Enabled

SET

Airplay

Userlevel: Admin

09 CB37 01 st

0x00

Disable

0x01

Enable

09 CB37 00

GET

Mirroring

Userlevel: None

08 CB3B 00

08 CB3B 03 st t₀..t₁

0x00

Disabled

0x01

Enabled

t₀..t₁

Time left

0x00..0x1E

In seconds (0..30)

SET

Mirroring

Userlevel: User

09 CB3B 01 st

0x00

Disable

0x01

Enable

09 CB3B 00

SET

vSolution Cast/App Start Stream

Userlevel: None

deprecated

09 CB43 ab c₀..c_n

c₀..c_n^inf

Client name

Max. 64 bytes

09 CB43 00

GET

vSolution Cast/App

Userlevel: None

08 CB86 00

08 CB86 01 st

0x00

Disabled

0x01

Enabled

SET

vSolution Cast/App

Userlevel: Admin

09 CB86 01 st

0x00

Disable

0x01

Enable

09 CB86 00

GET

Netdrive

Userlevel: User

08 CBAB 01 in

Index

0x00..0x09

Index (0..9)

0C CBAB ab cd in ty ln n₀..n_n lu u₀..u_n lun un₀..un_n lp p₀..p_n ld d₀..d_n am du

Index

0x00..0x09

Index (0..9)

Type

0x00

None

0x01

CIFS

0x02

NFS

Name length

Max. 255 bytes

n₀..n_n

Name

URL length

Max. 255 bytes

u₀..u_n

URL

lun

Username length

Max. 255 bytes

un₀..un_n

Username

Password length

Max. 255 bytes

p₀..p_n

Password

Domain length

Max. 255 bytes

d₀..d_n

Domain

Access mode

0x00

Read Only (RO)

0x01

Read Write (RW)

Default upload

0x00

0x01

Yes

SET

Netdrive

Userlevel: User

0D CBAB ab cd i ty ln n₀..n_n lu u₀..u_n lun un₀..un_n lp p₀..p_n ld d₀..d_n am du

Index

0x00..0x09

Index (0..9)

Type

0x00

None

0x01

CIFS

0x02

NFS

Name length

Max. 255 bytes

n₀..n_n

Name

URL length

Max. 255 bytes

u₀..u_n

URL

lun

Username length

Max. 255 bytes

un₀..un_n

Username

Password length

Max. 255 bytes

p₀..p_n

Password

Domain length

Max. 255 bytes

d₀..d_n

Domain

Access mode

0x00

Read Only (RO)

0x01

Read Write (RW)

Default upload

0x00

0x01

Yes

09 CBAB 00

GET

Airplay Parameters

Userlevel: None

08 CBAD 00

0C CBAD ab cd lh₀..lh₁ h₀..h_n ap₀..ap₁ vp₀..vp₁ ap₀..ap_n vp₀..vp_n

lh₀..lh₁

Hostname length

h₀..h_n

Hostname

ap₀..ap₁

Audio Port

vp₀..vp₁

Video Port

ap₀..ap_n^inf

Audio Parameter Block

vp₀..vp_n^inf

Video Parameter Block

Parameter block syntax:
lb0 lb1: Parameter block length
lkv0: Key/Value pair 0 length
kv00..kv0n: Key/Value pair 0
..
lkvn: Key/Value pair n length
kvn0..kvnn: Key/Value pair n

GET

Cast ID

Userlevel: None

08 CBAE 00

0C CBAE ab cd lcl₀..lcl₁ lc₀..lc_n wcl₀..wcl₁ wc₀..wc_n l2cl0..l2cl1 l2c0..l2cn

lcl₀..lcl₁

Cast ID for LAN interface length

lc₀..lc_n

Cast ID for LAN interface

wcl₀..wcl₁

Cast ID for WLAN interface length

wc₀..wc_n

Cast ID for WLAN interface

l2cl0..l2cl1

Cast ID for LAN2 interface length

l2c0..l2cn

Cast ID for LAN2 interface

GET

Chromecast

Userlevel: Admin

08 CBB2 00

08 CBB2 01 st

0x00

Disabled

0x01

Enabled

SET

Chromecast

Userlevel: Admin

09 CBB2 01 st

0x00

Disable

0x01

Enable

09 CBB2 00

GET

Webconference URL

Userlevel: Admin

deprecated

08 CBB8 00

08 CBB8 ab u₀..u_n

u₀..u_n^inf

URL

Max. 255 bytes

SET

Webconference URL

Userlevel: Admin

deprecated

09 CBB8 ab u₀..u_n

u₀..u_n^inf

URL

Max. 255 bytes

09 CBB8 00

GET

Webconference

Userlevel: None

08 CBB9 00

08 CBB9 01 st

0x00

Disabled

0x01

Enabled

SET

Webconference

Userlevel: Admin

09 CBB9 01 st

0x00

Disable

0x01

Enable

09 CBB9 00

GET

Webconference Camera Autostart

Userlevel: Admin

deprecated

08 CBBB 00

08 CBBB 01 oo

0x00

Off

0x01

SET

Webconference Camera Autostart

Userlevel: Admin

deprecated

09 CBBB 01 oo

0x00

Off

0x01

09 CBBB 00

GET

Airplay Password Mode

Userlevel: Admin

08 CBD6 00

08 CBD6 01 mo

Mode

0x00

None

0x01

SET

Airplay Password Mode

Userlevel: Admin

09 CBD6 01 mo

Mode

0x00

None

0x01

09 CBD6 00

GET

Miracast Password Mode

Userlevel: Admin

08 CC1F 00

08 CC1F 01 mo

Mode

0x00

None

0x01

SET

Miracast Password Mode

Userlevel: Admin

09 CC1F 01 mo

Mode

0x00

None

0x01

09 CC1F 00

GET

Airplay PIN Notification

Userlevel: User

08 CC33 00

08 CC33 01 oo

0x00

Off

0x01

SET

BYOD PIN Notification

Userlevel: Admin

09 CC33 01 oo

0x00

Off

0x01

09 CC33 00

GET

Webconference Enable Recording

Userlevel: Admin

08 CC34 00

08 CC34 01 oo

0x00

Off

0x01

SET

Webconference Enable Recording

Userlevel: Admin

09 CC34 01 oo

0x00

Off

0x01

09 CC34 00

SET

BYOD Custom PIN

Userlevel: User

09 CC35 02 p₀..p₁

p₀..p₁

0x0000..0x270F

Max. 9999 (4 digits)

09 CC35 00

GET

Airplay BLE Discovery

Userlevel: Admin

08 CC52 00

08 CC52 01 st

0x00

Disabled

0x01

Enabled

SET

Airplay BLE Discovery

Userlevel: Admin

09 CC52 01 st

0x00

Disable

0x01

Enable

09 CC52 00

GET

Airplay Interface

Userlevel: Admin

08 CC53 00

08 CC53 01 in

Interface

0x00

LAN

0x01

WLAN

0x02

LAN2

SET

Airplay Interface

Userlevel: Admin

09 CC53 01 in

Interface

0x00

LAN

0x01

WLAN

0x02

LAN2

09 CC53 00

GET

Mirroring LAN

Userlevel: Admin

08 CC6E 00

08 CC6E 01 oo

0x00

Off

0x01

SET

Mirroring LAN

Userlevel: Admin

09 CC6E 01 oo

0x00

Off

0x01

09 CC6E 00

GET

Mirroring LAN2

Userlevel: Admin

08 CC6F 00

08 CC6F 01 oo

0x00

Off

0x01

SET

Mirroring LAN2

Userlevel: Admin

09 CC6F 01 oo

0x00

Off

0x01

09 CC6F 00

GET

Mirroring WLAN

Userlevel: Admin

08 CC70 00

08 CC70 01 oo

0x00

Off

0x01

SET

Mirroring WLAN

Userlevel: Admin

09 CC70 01 oo

0x00

Off

0x01

09 CC70 00

GET

Mirroring Interface

Userlevel: User

08 CC71 00

08 CC71 01 st

0x00

Disabled

0x01

Enabled

GET

vSolution Cast/App Password Mode

Userlevel: None

08 CC98 00

08 CC98 01 mo

Mode

0x00

None

0x01

SET

vSolution Cast/App Password Mode

Userlevel: Admin

09 CC98 01 mo

Mode

0x00

None

0x01

09 CC98 00

SET

vSolution Cast/App Start

Userlevel: None

09 CC99 ab lp p₀..p_n lc c₀..c_n

PIN length

Max. 4 bytes

p₀..p_n

PIN as 4-digit string: e.g. 0245, 8934 or 1500

Clientname length

Max. 64 bytes

c₀..c_n

Clientname

09 CC99 00

GET

Webconference Entries

Userlevel: User

08 CCA6 00

0A01 CCA6 ab cd ef gh j₀..j_n

j₀..j_n^inf

JSON

JSON encoded webconference URLs and names: [{"Index": 0, "URL": "...", "Name": "...", "Native": "..."}, ..., {"Index": 9, "URL": "...", "Name": "..."}]

SET

Webconference Entries

Userlevel: Admin

0B01 CCA6 ab cd ef gh j₀..j_n

j₀..j_n^inf

JSON

JSON encoded webconference URLs and names: [{"Index": 0, "URL": "...", "Name": "...", {"Index": 9, "URL": "...", "Name": "..."}]

09 CCA6 00

GET

Interface MAC

Userlevel: None

08 CCB1 00

08 CCB1 07 m₀..m₅ if

m₀..m₅

MAC address

Binary MAC address: e.g. 000C92BC612B

Connected Interface

0x00

LAN

0x01

LAN2

0x02

WLAN

GET

Miracast Mice

Userlevel: Admin

08 CCC4 00

08 CCC4 02 st if

0x00

Disabled

0x01

Enabled

Interface

0x00

All

0x01

LAN

0x02

LAN2

0x03

WLAN

SET

Miracast Mice

Userlevel: Admin

09 CCC4 02 st if

0x00

Disable

0x01

Enable

Interface

0x00

All

0x01

LAN

0x02

LAN2

0x03

WLAN

09 CCC4 00

GET

Miracast P2P Mode

Userlevel: Admin

08 CCFD 00

08 CCFD 01 mo

Mode

0x00

Client

0x01

Master

SET

Miracast P2P Mode

Userlevel: Admin

09 CCFD 01 mo

Mode

0x00

Client

0x01

Master

09 CCFD 00

GET

Webconference Screenshare

Userlevel: None

08 CD0E 00

08 CD0E 01 oo

0x00

Off

0x01

GET

Dynamic Mirroring Pin

Userlevel: Admin

08 CD0F 00

08 CD0F 02 st rt

0x00

Disabled

0x01

Enabled

Reset time

0x0A..0x3C

In minutes (10..60)

SET

Dynamic Mirroring Pin

Userlevel: Admin

09 CD0F 02 st rt

0x00

Disable

0x01

Enable

Reset time

0x0A..0x3C

In minutes (10..60)

09 CD0F 00

GET

Screenshare Window

Userlevel: None

08 CD18 00

08 CD18 01 sw

Screenshare window

0x00

Don't show screenshare window

0x01

Show screenshare window

SET

Screenshare Window

Userlevel: User

deprecated

09 CD18 01 sw

Screenshare window

0x00

Don't show screenshare window

0x01

Show screenshare window

09 CD18 00

GET

Management Server Subscribe Settings

Userlevel: None

08 CD20 00

08 CD20 ab mo hl h₀..h_n

Management server subscribe mode

0x00

Off

0x01

Static

0x02

DHCP

Host for static mode length

h₀..h_n

Host for static mode

SET

Management Server Subscribe Settings

Userlevel: Admin

09 CD20 ab mo hl h₀..h_n

Management server subscribe mode

0x00

Off

0x01

Static

0x02

DHCP

Host for static mode length

h₀..h_n

Host for static mode

09 CD20 00

GET

BYOD Endless Mode

Userlevel: Admin

08 CD22 00

08 CD22 01 st

0x00

Disabled

0x01

Enabled

SET

BYOD Endless Mode

Userlevel: Admin

09 CD22 01 oo

0x00

Off

0x01

09 CD22 00

GET

Airplay 4k Mode

Userlevel: Admin

08 CD25 00

08 CD25 01 st

0x00

Disabled

0x01

Enabled

SET

Airplay 4k Mode

Userlevel: Admin

09 CD25 01 st

0x00

Disable

0x01

Enable

09 CD25 00

GET

Management Server Subscribe Status

Userlevel: None

08 CD29 00

08 CD29 ab st h₀..h₁ lh h₀..h_n

Status

0x00

Init

0x01

Generic error

0x02

Dhcp error

0x03

Post error

0x04

h₀..h₁

Html response code

Host length

h₀..h_n

Host

GET

Waitingroom

Userlevel: User

deprecated

08 CD2C 00

0A01 CD2C ab cd ef gh w₀..w_n

w₀..w_n^inf

Waitingroom as JSON string

If there are participants waiting:
{"waitingroom":"teams","participants":[{"name":"name of user","id":"ID of user"}]}

No participants waiting:
[]

SET

Waitingroom

Userlevel: User

deprecated

09 CD2C ab wn ac ul u₀..u_n

0x00..0x03

Window number (0..3)

Action

0x00

Admit user

0x01

Deny user

User ID length

Max. 252 bytes

u₀..u_n

User ID

09 CD2C 00

GET

Miracast 4K Mode

Userlevel: Admin

08 CD36 00

08 CD36 01 st

0x00

Disabled

0x01

Enabled

SET

Miracast 4K Mode

Userlevel: Admin

09 CD36 01 st

0x00

Disable

0x01

Enable

09 CD36 00

GET

Miracast Cursor Low Latency

Userlevel: Admin

08 CD4C 00

08 CD4C 01 st

0x00

Disabled

0x01

Enabled

SET

Miracast Cursor Low Latency

Userlevel: Admin

09 CD4C 01 st

0x00

Disable

0x01

Enable

09 CD4C 00

GET

Ping

Userlevel: Admin

08 CD66 00

0C CD66 ab cd st pl₀..pl₁ p₀..p_n

Status

0x00

Stopped

0x01

Started

0x02

Failed

0x03

Succeeded

pl₀..pl₁

Ping response length

p₀..p_n

Ping response

SET

Ping

Userlevel: Admin

09 CD66 ab ni dl d₀..d_n

Network interface

0x00

LAN1

0x01

LAN2

0x02

WLAN

Destination length

Max. 253 bytes

d₀..d_n

Destination

09 CD66 00

Office 365 (9)

GET

Office 365 Function

Userlevel: None

08 CC50 00

08 CC50 02 st tm

0x00

Disabled

0x01

Enabled

Teams Status

0x00

No teams meeting active

0x01

Teams meeting active, client denied

0x02

Teams meeting active, client allowed

SET

Office 365 Function

Userlevel: Admin

09 CC50 01 st

0x00

Disable

0x01

Enable

09 CC50 00

SET

Office 365 Window Control

Userlevel: User

0D CC51 ab cd wn ac u₀..u_n

0x00..0x03

Window number (0..3)

Action

0x00

URL

u₀..u_n^inf

URL

Max. 512 bytes

09 CC51 00

0D CC51 02 wn ac

0x00..0x03

Window number (0..3)

Action

0x01

Reload

0x02

Stop

0x03

Zoom In

0x04

Zoom Out

0x05

Cursor Down

0x06

Cursor Up

0x07

Cursor Right

0x08

Cursor Left

0x09

Back

0x0A

Forward

0x0B

Scroll Down

0x0C

Scroll Up

0x0D

Scroll Right

0x0E

Scroll Left

09 CC51 00

GET

Office 365 Credentials Used

Userlevel: User

08 CC8F 00

08 CC8F 01 cu

Credentials used

0x00

From local settings

0x01

From user

SET

Office 365 Credentials Used

Userlevel: User

09 CC8F 01 cu

Credentials used

0x00

From local settings

0x01

From user

09 CC8F 00

GET

Office365 Teams Settings

Userlevel: User

08 CD15 00

08 CD15 02 ts co

Teams as content source

0x00

Don't show Teams as content source

0x01

Show Teams as content source

Content

0x00

Disabled

0x01

Enabled

SET

Office365 Teams Settings

Userlevel: Admin

0D CD15 02 ts co

Teams as content source

0x00

Don't show Teams as content source

0x01

Show Teams as content source

Content

0x00

Disabled

0x01

Enabled

09 CD15 00

GET

Office 365 Local Account

Userlevel: None

08 CD21 00

0C CD21 ab cd la lu u₀..u_n lp p₀..p_n

Local Account

0x00

Disabled

0x01

Enabled

Username length

Max. 255 bytes, valid data will only be returned for user level "Admin"

u₀..u_n

Username

Valid data will only be returned for user level "Admin"

Password length

Max. 255 bytes, valid data will only be returned for user level "Admin"

p₀..p_n

Password

Valid data will only be returned for user level "Admin"

SET

Office 365 Local Account

Userlevel: Admin

0D CD21 ab cd la ul u₀..u_n pl p₀..p_n

Local Account

0x00

Disable

0x01

Enable

Username length

Max. 255 bytes

u₀..u_n

Username

Password length

Max. 255 bytes

p₀..p_n

Password

09 CD21 00

Output (43)

GET

Windows

Userlevel: User

deprecated

08 CB27 00

0C CB27 ab cd ww₀..ww₁ wh₂..wh₃ cb₀..cb₁₁ lb₀..lb₁ b₀..b_n

ww₀..ww₁

Window reference width

wh₂..wh₃

Window reference height

cb₀..cb₁₁

Common block

Syntax:
wt: Window type

0x00 = None
0x01 = Visualizer
0x02 = HDMI
0x03 = Browser
0x04 = Miracast
0x05 = Airplay/Chromecast
0x06 = Video
0x07 = vSolution Cast/App
0x08 = Image
0x09 = PDF
0x0A = Office PPT/PPTX
0x0B = Office DOC/DOCX/TXT
0x0C = Office XLS/XLSX
0x0D = Whiteboard
0x0E = Audio
0x0F = Webconference

fs: Full screen

0x00: Normal
0x01: Full screen

x0..x1: X position (left upper corner)
y0..y1: Y position (left upper corner)
w0..w1: Width
h0..h1: Height
mu: Mute

0x00: Not muted
0x01: Muted

vo: Volume (0x00..0x7d: Volume in percent)

lb₀..lb₁

Window type specific block length

b₀..b_n

Window type specific block

Type Visualizer and HDMI (wt=0x01..0x02):
in0..in3: Index
ln0..ln1: Input name length
n0..nn: Input name

Type Browser and Webconference (wt=0x03, 0x0F):
lu0..lu1: URL length
u0..un: URL
lt0..lt1: Title length
t0..tn: Title
it: Input type (request keyboard)
pdf: PDF viewer active
pp0..pp3: Page of PDF
tpp0..tpp3: Total page count of PDF
bu: Busy
pft0..pft3: Password field top (0x00000000 if not available)
pfb0..pfb3: Password field bottom (0x00000000 if not available)
pfl0..pfl3: Password field left (0x00000000 if not available)
pfr0..pfr3: Password field right (0x00000000 if not available)
zlp0..zlp3: Zoom level in percent
Type 0x1B additionally: scr: Screenshare status, am: Audio muted status, vm: Video muted status, tj: Teams joined status, hr: Hand raised status, as: Attendees shown status

Type Miracast, Airplay and vSolution Cast/App (wt=0x04, 0x05, 0x07):
ln0..ln1: Name length
n0..nn: Name

Type Video and Audio (wt=0x06, 0x0E):
du0..du3: Duration in ms
p0..p3: Position in ms
sp: Speed

0x00: Pause
0x01: Normal
0xFF: Backward
0x02..0x05: Speed multiplier)

Type Image (wt=0x08):
in0..in3: Image number
tn0..tn3: Total number of images
lf0..lf1: Filename length
f0..fn: Filename

Type PDF (wt=0x09):
p0..p3: Page
tp0..tp3: Total number of pages
zlp0..zlp3: Zoom level in percent

Type Whiteboard (wt=0x0D):
nu: Number of users

The parameters Common block, Window type specific block length and Window type specific block are combined in a block called Window infos. In this specification, only the Window infos block for window 0 is listed but this block is actually repeated four times (one Window infos block for each window, regardless if this window is currently displayed or not)

SET

Window Control

Userlevel: None

09 CB28 02 wn ac

0x00..0x03

Window number (0..3)

Action

0x00

0x01

Fullscreen

0x02

Normal

0x05

Toggle Fullscreen/Normal

0x06

Aux-Copy On

0x07

Aux-Copy Off

0x08

Aux-Copy Toggle

0x09

WebRTC Screen Sharing On

0x0A

WebRTC Screen Sharing Off

0x0B

WebRTC Screen Sharing Toggle

09 CB28 00

09 CB28 03 wn ac oo

0x00..0x03

Window number (0..3)

Action

0x03

Mute

0x00

Off

0x01

09 CB28 00

09 CB28 03 wn ac wv

0x00..0x03

Window number (0..3)

Action

0x04

Volume

0x00..0x7d

Volume in percent (0..125)

09 CB28 00

SET

Visualizer Control

Userlevel: None

09 CB29 04 wn ac s₀..s₁

0x00..0x03

Window number (0..3)

Action

0x00

Zoom Wide

0x01

Zoom Tele

0x02

Focus Far

0x03

Focus Near

s₀..s₁

Speed

0x0000

Stop

0x0001..0x000F

Speed (1..15)

09 CB29 00

09 CB29 02 wn ac

0x00..0x03

Window number (0..3)

Action

0x04

Auto Focus On

0x05

Auto Focus Off

0x06

Freeze On

0x07

Freeze Off

0x08

Preset Save

0x09

Preset Recall

0x0A

Auto Focus Toggle

0x0B

Freeze Toggle

0x0C

Power On

0x0D

Power Off

0x0E

Power Toggle

0x0F

Light On

0x10

Light Off

0x11

Light Toggle

0x12

Capture Area Shift On

0x13

Capture Area Shift Off

0x14

Capture Area Shift Toggle

09 CB29 00

09 CB29 04 wn ac f₀..f₁

0x00..0x03

Window number (0..3)

Action

0x15

One-Push Auto Focus

f₀..f₁

Field index

0x0001..0x0009

Field (1..9)

09 CB29 00

SET

Browser Control

Userlevel: User

0D CB2A ab cd wn ac u₀..u_n

0x00..0x03

Window number (0..3)

Action

0x00

URL

u₀..u_n^inf

URL

Max. 512 bytes

09 CB2A 00

0D CB2A 02 wn ac

0x00..0x03

Window number (0..3)

Action

0x01

Reload

0x02

Stop

0x03

Zoom In

0x04

Zoom Out

0x05

Cursor Down

0x06

Cursor Up

0x07

Cursor Right

0x08

Cursor Left

0x09

Back

0x0A

Forward

0x0B

(PDF Viewer) Next page

0x0C

(PDF Viewer) Previous page

0x0E

(PDF Viewer) Set zoom to full height

0x0F

(PDF Viewer) Set zoom to full width

0x10

(PDF Viewer) Set zoom to full page

0x11

Scroll Down

0x12

Scroll Up

0x13

Scroll Right

0x14

Scroll Left

0x15

Browser Home

09 CB2A 00

0D CB2A 04 wn ac p₀..p₁

0x00..0x03

Window number (0..3)

Action

0x0D

(PDF Viewer) Set page

p₀..p₁

Page number

09 CB2A 00

SET

Video Control

Userlevel: User

0D CB2B 02 wn ac

0x00..0x03

Window number (0..3)

Action

0x00

Play

0x01

Pause

0x02

Stop

0x03

Forward

0x04

Rewind

0x07

Loop Off

0x08

Loop On

0x09

Loop Toggle

09 CB2B 00

0D CB2B ab cd wn ac f₀..f_n

0x00..0x03

Window number (0..3)

Action

0x05

File path

f₀..f_n^inf

File path

Max. 512 bytes
Fully qualified name: e.g. USB:///folder/video.mp4

09 CB2B 00

0D CB2B 06 wn ac p₀..p₃

0x00..0x03

Window number (0..3)

Action

0x06

Seek

p₀..p₃

Position

In ms

09 CB2B 00

SET

Window Start

Userlevel: User

deprecated

0D CB2C ab cd wn wt lp₀..lp₁ p₀..p_n

0x00..0x03

Window number (0..3)

0xFF

Auto arrange

0x01

Visualizer

0x02

HDMI

0x03

Browser

0x06

Video

0x08

Image

0x09

PDF

0x0A

Office PPT/PPTX

0x0B

Office DOC/DOCX/TXT

0x0C

Office XLS/XLSX

0x0D

Whiteboard

0x0E

Audio

0x0F

Webconference

0x10

Webcam

0x11

Stream Input

0x13

Office 365 Outlook

0x14

Office 365 Word

0x15

Office 365 Excel

0x16

Office 365 PowerPoint

0x17

Office 365 OneNote

0x1B

Office 365 Teams

0x1D

Zoom

0x1E

Office 365 Whiteboard

0x1F

Office 365 Planner

lp₀..lp₁

Parameter length

Max. 65531 bytes

p₀..p_n

Parameter

Visualizer, Whiteboard, and Office 365 applications do not require any parameter. Set lp0..lp1 to 0x0000.

HDMI, Webcam, and Stream Input expect one index byte as parameter. The index encodes the HDMI input (0 = HDMI1, 1 = HDMI2), the webcam device index (0 = first device, 1 = second device, ...), or the stream index (0 = first stream, 1 = second stream, ...). For the latter two, see input settings. Set lp0..lp1 to 0x0001.

All other window types expect an (partially optional) ASCII string, which is not null-terminated. Therefore, make sure to store the length of the string in lp0..lp1.
The Browser window accepts an optional string with a URL. If no URL is provided, the default page is opened.

The types Video, Image, PDF, Office applications, and Audio expect an URI as parameter, which describes the file to be opened.

The Webconference window type accepts an optional string with the URL of the web conference. If no URL is provided, the first URL specified in the WebRTC settings is opened.

Similarly, the Office 365 Teams window type accepts an optional invitation link.

Deprecated: see 0xCD28

09 CB2C 00

SET

Event

Userlevel: User

09 CB2D 0d wn ac k₀..k₁ x₀..x₁ y₀..y₁ c₀..c₁ m0 m1 m2

0x00..0x03

Window number (0..3)

Event action for keyboard, pointer and touch events

0x00

Key Hit

0x01

Key Tip

0x02

Key Release

0x03

Pointer Relative

0x04

Pointer Absolute

0x05

Touch Down

0x06

Touch Motion

0x07

Touch Up

0x08

Touch Cancel

k₀..k₁

Reserved

Fill with 0.

x₀..x₁

X position

Coordinate origin is the upper left corner of the output. Fill with 0 if not needed.

y₀..y₁

Y position

Coordinate origin is the upper left corner of the output. Fill with 0 if not needed.

c₀..c₁

Key code

Linux Input Event Code. Fill with 0 if not needed.

Reserved

Fill with 0.

Reserved

Fill with 0.

Reserved

Fill with 0.

09 CB2D 00

SET

Image Control

Userlevel: User

0D CB39 ab cd wn ac f₀..f_n

0x00..0x03

Window number (0..3)

Action

0x00

File path

f₀..f_n^inf

File path

Max. 512 bytes
Fully qualified name: e.g. USB:///folder/image.jpg

09 CB39 00

0D CB39 02 wn ac

0x00..0x03

Window number (0..3)

Action

0x01

Previous Image

0x02

Next Image

0x03

First Image

0x04

Last Image

09 CB39 00

SET

PDF Control

Userlevel: User

0D CB4A ab cd wn ac f₀..f_n

0x00..0x03

Window number (0..3)

Action

0x00

File path

f₀..f_n^inf

File path

Max. 512 bytes
Fully qualified name: e.g. USB:///folder/document.pdf

09 CB4A 00

0D CB4A 02 wn ac

0x00..0x03

Window number (0..3)

Action

0x01

Zoom In

0x02

Zoom Out

0x03

Cursor Down

0x04

Cursor Up

0x05

Cursor Right

0x06

Cursor Left

0x07

0x08

0x0A

Set zoom to full height

0x0B

Set zoom to full width

0x0C

Set zoom to full page

0x0D

Scroll Down

0x0E

Scroll Up

0x0F

Scroll Right

0x10

Scroll Left

09 CB4A 00

0D CB4A 04 wn ac p₀..p₁

0x00..0x03

Window number (0..3)

Action

0x09

Set page

p₀..p₁

Page number

09 CB4A 00

SET

Office Control

Userlevel: User

0D CB4B ab cd wn ac f₀..f_n

0x00..0x03

Window number (0..3)

Action

0x00

File path

f₀..f_n^inf

File path

Max. 512 bytes
Fully qualified name: e.g. USB:///folder/spreadsheet.xlsx

09 CB4B 00

0D CB4B 02 wn ac

0x00..0x03

Window number (0..3)

Action

0x01

Zoom In

0x02

Zoom Out

0x03

Cursor Down

0x04

Cursor Up

0x05

Cursor Right

0x06

Cursor Left

0x07

0x08

0x09

Next Worksheet

0x0A

Previous Worksheet

0x0B

Set zoom to full page

0x0C

Set zoom to full width

0x0D

Scroll Down

0x0E

Scroll Up

0x0F

Scroll Right

0x10

Scroll Left

09 CB4B 00

GET

Main Resolution

Userlevel: Admin

08 CB4D 00

08 CB4D 01 re

Resolution

0x00

Auto

0x01

1080p60

0x02

2160p30

0x03

2160p60

0x04

1080p30

SET

Main Resolution

Userlevel: Admin

09 CB4D 01 re

Resolution

0x00

Auto

0x01

1080p60

0x02

2160p30

0x03

2160p60

0x04

1080p30

09 CB4D 00

GET

Aux Mode

Userlevel: None

08 CB5B 00

08 CB5B 01 mo

Mode

0x00

Mirror, 1:1

0x01

Mirror, 1080p60

0x02

Mirror, 720p60

0x03

Content, 1080p60

0x04

Content, 720p60

0x05

Moderator, 1080p60

SET

Aux Mode

Userlevel: Admin

09 CB5B 01 mo

Mode

0x00

Mirror, 1:1

0x01

Mirror, 1080p60

0x02

Mirror, 720p60

0x03

Content, 1080p60

0x04

Content, 720p60

0x05

Moderator, 1080p60

09 CB5B 00

GET

Window Free

Userlevel: None

08 CB8D 00

08 CB8D 01 ny

0x00

0x01

Yes

08 CB8D 01 ty

Type

0x00

BYOD Windows

08 CB8D 01 ny

0x00

0x01

Yes

SET

Audio Control

Userlevel: User

0D CBA2 02 wn ac

0x00..0x03

Window number (0..3)

Action

0x00

Play

0x01

Pause

0x02

Stop

0x03

Forward

0x04

Rewind

0x07

Loop Off

0x08

Loop On

0x09

Loop Toggle

09 CBA2 00

0D CBA2 ab cd wn ac f₀..f_n

0x00..0x03

Window number (0..3)

Action

0x05

File path

f₀..f_n^inf

File path

Max. 512 bytes
Fully qualified name: e.g. USB:///folder/audio.mp3

09 CBA2 00

0D CBA2 06 wn ac p₀..p₃

0x00..0x03

Window number (0..3)

Action

0x06

Seek

p₀..p₃

Position

In ms

09 CBA2 00

GET

Aux Content Priority

Userlevel: Admin

08 CBB3 00

08 CBB3 02 in wt

Index

0x00..0x02

Index (0..2)

0x01

Visualizer

0x02

HDMI

0x03

Browser

0x06

Video

0x08

Image

0x09

PDF

0x0A

Office PPT/PPTX

0x0B

Office DOC/DOCX/TXT

0x0C

Office XLS/XLSX

0x0D

Whiteboard

0x0E

Audio

0x0F

Webconference

0x10

Webcam

0x11

Stream Input

0x13

Office 365 Outlook

0x14

Office 365 Word

0x15

Office 365 Excel

0x16

Office 365 PowerPoint

0x17

Office 365 OneNote

0x1E

Office 365 Whiteboard

0x1F

Office 365 Planner

0x21

HDMI 1 Input

0x22

HDMI 2 Input

SET

Aux Content Priority

Userlevel: Admin

09 CBB3 02 in wt

Index

0x00..0x02

Index (0..2)

0x01

Visualizer

0x02

HDMI

0x03

Browser

0x06

Video

0x08

Image

0x09

PDF

0x0A

Office PPT/PPTX

0x0B

Office DOC/DOCX/TXT

0x0C

Office XLS/XLSX

0x0D

Whiteboard

0x0E

Audio

0x0F

Webconference

0x10

Webcam

0x11

Stream Input

0x13

Office 365 Outlook

0x14

Office 365 Word

0x15

Office 365 Excel

0x16

Office 365 PowerPoint

0x17

Office 365 OneNote

0x1E

Office 365 Whiteboard

0x1F

Office 365 Planner

0x21

HDMI 1 Input

0x22

HDMI 2 Input

09 CBB3 00

GET

Windows 2

Userlevel: User

deprecated

08 CBBA 00

0C CBBA ab cd ww₀..ww₁ wh₂..wh₃ lcb cb₀..cb_n lb₀..lb₁ b₀..b_n

ww₀..ww₁

Window reference width

wh₂..wh₃

Window reference height

lcb

Common block length

0x0F

15 bytes

cb₀..cb_n

Common block

Syntax:
wt: Window type

0x00 = None
0x01 = Visualizer
0x02 = HDMI
0x03 = Browser
0x04 = Miracast
0x05 = Airplay/Chromecast
0x06 = Video
0x07 = vSolution Cast/App
0x08 = Image
0x09 = PDF
0x0A = Office PPT/PPTX
0x0B = Office DOC/DOCX/TXT
0x0C = Office XLS/XLSX
0x0D = Whiteboard
0x0E = Audio
0x0F = Webconference
0x10 = Webcam
0x11 = Stream Input
0x13 = Office 365 Outlook
0x14 = Office 365 Word
0x15 = Office 365 Excel
0x16 = Office 365 PowerPoint
0x17 = Office 365 OneNote
0x18 = vMatrix Pull Stream (from station)
0x19 = vMatrix Push Stream (to station)
0x1A = vMatrix Station Browser
0x1B = Office 365 Teams
0x1C = vMatrix Groupwork Stream
0x1E = Office 365 Whiteboard
0x1F = Office 365 Planner
0xFF = Restricted Window: No touch/key events, only WolfProt window control 'Close', 'Fullscreen', 'Normal' and 'Toggle Fullscreen/Normal' allowed by client for this window

fs: Full screen

0x00: Normal
0x01: Full screen

x0..x1: X position (left upper corner)
y0..y1: Y position (left upper corner)
w0..w1: Width
h0..h1: Height
mu: Mute

0x00: Not muted
0x01: Muted

vo: Volume (0x00..0x7d: Volume in percent)
aux: Aux

0x00: Not on second output
0x01: On second output

rec: Display as transparent window for recording/streaming

0x00: No
0x01: Yes

WebRTC: Shared over WebRTC

0x00: No
0x01: Yes

lb₀..lb₁

Window type specific block length

b₀..b_n

Window type specific block

Type Visualizer and HDMI (wt=0x01..0x02):
in0..in3: Index
ln0..ln1: Input name length
n0..nn: Input name

Type Browser, Webconference, Office365, vMatrix Station Browser (wt=0x03, 0x0F, 0x13..0x17, 0x1A, 0x1B):
lu0..lu1: URL length
u0..un: URL
lt0..lt1: Title length
t0..tn: Title
it: Input type (request keyboard)
pdf: PDF viewer active
pp0..pp3: Page of PDF
tpp0..tpp3: Total page count of PDF
bu: Busy
pft0..pft3: Password field top (0x00000000 if not available)
pfb0..pfb3: Password field bottom (0x00000000 if not available)
pfl0..pfl3: Password field left (0x00000000 if not available)
pfr0..pfr3: Password field right (0x00000000 if not available)
zlp0..zlp3: Zoom level in percent
Type 0x1B additionally: scr: Screenshare status, am: Audio muted status, vm: Video muted status, tj: Teams joined status, hr: Hand raised status, as: Attendees shown status

Type Miracast, Airplay and vSolution Cast/App, vMatrix Pull Stream (from station), vMatrix Groupwork Stream (wt=0x04, 0x05, 0x07, 0x18, 0x1C):
ln0..ln1: Name length
n0..nn: Name

Type Video and Audio (wt=0x06, 0x0E):
du0..du3: Duration in ms
p0..p3: Position in ms
sp: Speed

0x00: Pause
0x01: Normal
0x02..0x0A: Speed multiplier Forward
0xFF: Backward
0xFE..0xF6: Speed multiplier Backward

lo: Loop

0x00: Off
0x01: On

Type Image (wt=0x08):
in0..in3: Image number
tn0..tn3: Total number of images
lf0..lf1: Filename length
f0..fn: Filename

Type PDF (wt=0x09):
p0..p3: Page
tp0..tp3: Total number of pages
zlp0..zlp3: Zoom level in percent

Type Whiteboard (wt=0x0D):
nu: Number of users

Type Webcam (wt=0x10):
ct: Content type

0x00 = HDMI
0x01 = Visualizer
0x02 = Disc Player
0x03 = Computer
0x0A = Camera

ln0..ln1: Camera name length
n0..nn: Camera name

Type Stream Input (wt=0x11):
ct: Content type

0x00 = HDMI
0x01 = Visualizer
0x02 = Disc Player
0x03 = Computer
0x0A = Camera
0x0B = Stream Input
0x0D = Cynap

ln0..ln1: Stream name length
n0..nn: Stream name (URL encoded)

The parameters Common block length, Common block, Window type specific block length and Window type specific block are combined in a block called Window infos. In this specification, only the Window infos block for window 0 is listed but this block is actually repeated four times (one Window infos block for each window, regardless if the window is currently displayed or not)

GET

Aux Allow Mirror Override

Userlevel: None

08 CBD7 00

08 CBD7 01 ny

0x00

0x01

Yes

SET

Aux Allow Mirror Override

Userlevel: Admin

09 CBD7 01 ny

0x00

0x01

Yes

09 CBD7 00

GET

Aux Mirror Override

Userlevel: User

08 CBD8 00

08 CBD8 01 oo

0x00

Off

0x01

SET

Aux Mirror Override

Userlevel: User

09 CBD8 01 oo

0x00

Off

0x01

09 CBD8 00

GET

Swap Main/Aux Outputs

Userlevel: Admin

08 CC3A 00

08 CC3A 01 oo

0x00

Off

0x01

SET

Swap Main/Aux Outputs

Userlevel: Admin

09 CC3A 01 oo

0x00

Off

0x01

09 CC3A 00

GET

Content Mode Recording Streaming Source

Userlevel: User

08 CC6D 00

08 CC6D 01 src

src

Source

0x00

Main

0x01

Aux

SET

Content Mode Recording Streaming Source

Userlevel: Admin

09 CC6D 01 src

src

Source

0x00

Main

0x01

Aux

09 CC6D 00

SET

Multiple Events

Userlevel: User

0D CCA5 ab cd bl wn ac k₀..k₁ x₀..x₁ y₀..y₁ c₀..c₁

Block length

0x00..0x03

Window number (0..3)

Event action for keyboard, pointer and touch events

0x01

Key Tip

0x02

Key Release

0x03

Pointer Relative

0x04

Pointer Absolute

0x05

Touch Down

0x06

Touch Motion

0x07

Touch Up

0x08

Touch Cancel

k₀..k₁

Reserved

Fill with 0.

x₀..x₁

X position

Coordinate origin is the upper left corner of the output. Fill with 0 if not needed.

y₀..y₁

Y position

Coordinate origin is the upper left corner of the output. Fill with 0 if not needed.

c₀..c₁

Key code

Linux Input Event Code. Fill with 0 if not needed.

This command can contain up to 16 subsequent event entries. Each event entry starts with the block length which specifies the amount of bytes used by this entry. If there are additional event entries, the next one will start directly after the first entry.

09 CCA5 00

SET

Window Start Private

Userlevel: User

0B01 CD28 ab cd ef gh wn wt lp₀..lp₁ p₀..p_n re lpr₀..lpr₁ pr₀..pr_n ui

0x00..0x03

Window number (0..3)

0xFF

Auto arrange

0x01

Visualizer

0x02

HDMI

0x03

Browser

0x06

Video

0x08

Image

0x09

PDF

0x0A

Office PPT/PPTX

0x0B

Office DOC/DOCX/TXT

0x0C

Office XLS/XLSX

0x0D

Whiteboard

0x0E

Audio

0x0F

Webconference

0x10

Webcam

0x11

Stream Input

0x13

Office 365 Outlook

0x14

Office 365 Word

0x15

Office 365 Excel

0x16

Office 365 PowerPoint

0x17

Office 365 OneNote

0x1B

Office 365 Teams

0x1D

Zoom

0x1E

Office 365 Whiteboard

0x1F

Office 365 Planner

lp₀..lp₁

Parameter length

p₀..p_n

Parameter

Restricted flag

0x00

Normal window

0x01

lpr₀..lpr₁

Private data length

pr₀..pr_n

Private data

User ID

09 CD28 00

GET

Windows 3

Userlevel: User

08 CD42 00

0C CD42 ab cd ww₀..ww₁ wh₂..wh₃ lcb cb₀..cb_n lb₀..lb₁ b₀..b_n

ww₀..ww₁

Window reference width

wh₂..wh₃

Window reference height

lcb

Common block length

0x10

16 bytes

cb₀..cb_n

Common block

Syntax:
wt: Window type

0x00 = None
0x01 = Visualizer
0x02 = HDMI
0x03 = Browser
0x04 = Miracast
0x05 = Airplay/Chromecast
0x06 = Video
0x07 = vSolution Cast/App
0x08 = Image
0x09 = PDF
0x0A = Office PPT/PPTX
0x0B = Office DOC/DOCX/TXT
0x0C = Office XLS/XLSX
0x0D = Whiteboard
0x0E = Audio
0x0F = Webconference
0x10 = Webcam
0x11 = Stream Input
0x13 = Office 365 Outlook
0x14 = Office 365 Word
0x15 = Office 365 Excel
0x16 = Office 365 PowerPoint
0x17 = Office 365 OneNote
0x18 = vMatrix Pull Stream (from station)
0x19 = vMatrix Push Stream (to station)
0x1A = vMatrix Station Browser
0x1B = Office 365 Teams
0x1C = vMatrix Groupwork Stream
0x1D = Zoom
0x1E = Office 365 Whiteboard
0x1F = Office 365 Planner

fs: Full screen

0x00: Normal
0x01: Full screen

x0..x1: X position (left upper corner)
y0..y1: Y position (left upper corner)
w0..w1: Width
h0..h1: Height
mu: Mute

0x00: Not muted
0x01: Muted

vo: Volume (0x00..0x7d: Volume in percent)
aux: Aux

0x00: Not on second output
0x01: On second output

rec: Display as transparent window for recording/streaming

0x00: No
0x01: Yes

WebRTC: Shared over WebRTC

0x00: No
0x01: Yes

Window restricted (no touch/key events, only WolfProt window control 'Close', 'Fullscreen', 'Normal' and 'Toggle Fullscreen/Normal' allowed by client for this window):

0x00: No
0x01: Yes

lb₀..lb₁

Window type specific block length

b₀..b_n

Window type specific block

Type Visualizer and HDMI (wt=0x01..0x02):
in0..in3: Index
ln0..ln1: Input name length
n0..nn: Input name

Type Browser, Webconference, Office365, vMatrix Station Browser, Zoom (wt=0x03, 0x0F, 0x13..0x17, 0x1A, 0x1B, 0x1D):
lu0..lu1: URL length
u0..un: URL
lt0..lt1: Title length
t0..tn: Title
it: Input type (request keyboard)
pdf: PDF viewer active
pp0..pp3: Page of PDF
tpp0..tpp3: Total page count of PDF
bu: Busy
pft0..pft3: Password field top (0x00000000 if not available)
pfb0..pfb3: Password field bottom (0x00000000 if not available)
pfl0..pfl3: Password field left (0x00000000 if not available)
pfr0..pfr3: Password field right (0x00000000 if not available)
zlp0..zlp3: Zoom level in percent
Types Office365 & webconf additionally: scr: Screenshare status

Type Airplay, vMatrix Pull Stream (from station), vMatrix Groupwork Stream (wt=0x05, 0x18, 0x1C):
ln0..ln1: Name length
n0..nn: Name

Type Video and Audio (wt=0x06, 0x0E):
du0..du3: Duration in ms
p0..p3: Position in ms
sp: Speed

0x00: Pause
0x01: Normal
0x02..0x0A: Speed multiplier Forward
0xFF: Backward
0xFE..0xF6: Speed multiplier Backward

lo: Loop

0x00: Off
0x01: On

Type Image (wt=0x08):
in0..in3: Image number
tn0..tn3: Total number of images
lf0..lf1: Filename length
f0..fn: Filename

Type PDF (wt=0x09):
p0..p3: Page
tp0..tp3: Total number of pages
zlp0..zlp3: Zoom level in percent

Type Whiteboard (wt=0x0D):
nu: Number of users

Type Webcam (wt=0x10):
ct: Content type

0x00 = HDMI
0x01 = Visualizer
0x02 = Disc Player
0x03 = Computer
0x0A = Camera

ln0..ln1: Camera name length
n0..nn: Camera name

Type Stream Input (wt=0x11):
ct: Content type

0x00 = HDMI
0x01 = Visualizer
0x02 = Disc Player
0x03 = Computer
0x0A = Camera
0x0B = Stream Input
0x0D = Cynap

ln0..ln1: Stream name length
n0..nn: Stream name (URL encoded)

Type Miracast (wt=0x04):
ln0..ln1: Name length
n0..nn: Name
ll: Low latency state

0x00: Off
0x01: On

Type vSolution Cast/App (wt=0x07):
ln0..ln1: Name length
n0..nn: Name
cb: Camera Back Session Window

0x00: No
0x01: Yes

SET

Open Webconference Local

Userlevel: User

09 CD45 02 wn wt

0x00..0x03

Window number (0..3)

0xFF

Auto arrange

Webconference type

0x1B

Teams

0x1D

Zoom

09 CD45 00

GET

Status

Userlevel: None

08 CD4B 00

08 CD4B 02 mwn wr

mwn

Webconferencing window number

0x00...0x03

Window number

0xFF

No active webconferencing

Window restricted

0x00

0x01

Yes

SET

Control Specific Type Application

Userlevel: User

09 CD62 0c wt ai₀..ai₇ ac s₀..s₁

Window type

0x01

Visualizer

ai₀..ai₇

Action

0x00

Zoom Wide

0x01

Zoom Tele

0x02

Focus Far

0x03

Focus Near

s₀..s₁

Speed

0x0000

Stop

0x0001..0x000F

Speed (1..15)

09 CD62 00

09 CD62 0a wt ai₀..ai₇ ac

Window type

0x01

Visualizer

ai₀..ai₇

Action

0x04

Auto Focus On

0x05

Auto Focus Off

0x06

Freeze On

0x07

Freeze Off

0x08

Preset Save

0x09

Preset Recall

0x0A

Auto Focus Toggle

0x0B

Freeze Toggle

0x0C

Power On

0x0D

Power Off

0x0E

Power Toggle

0x0F

Light On

0x10

Light Off

0x11

Light Toggle

0x12

Capture Area Shift On

0x13

Capture Area Shift Off

0x14

Capture Area Shift Toggle

09 CD62 00

09 CD62 0c wt ai₀..ai₇ ac f₀..f₁

Window type

0x01

Visualizer

ai₀..ai₇

Action

0x15

One-Push Auto Focus

f₀..f₁

Field index

0x0001..0x0009

Field (1..9)

09 CD62 00

0D CD62 ab cd wt ai₀..ai₇ ac u₀..u_n

Window type

0x03

Browser

ai₀..ai₇

Action

0x00

URL

u₀..u_n^inf

URL

Max. 512 bytes

09 CD62 00

0D CD62 0a wt ai₀..ai₇ ac

Window type

0x03

Browser

ai₀..ai₇

Action

0x01

Reload

0x02

Stop

0x03

Zoom In

0x04

Zoom Out

0x05

Cursor Down

0x06

Cursor Up

0x07

Cursor Right

0x08

Cursor Left

0x09

Back

0x0A

Forward

0x0B

(PDF Viewer) Next page

0x0C

(PDF Viewer) Previous page

0x0E

(PDF Viewer) Set zoom to full height

0x0F

(PDF Viewer) Set zoom to full width

0x10

(PDF Viewer) Set zoom to full page

0x11

Scroll Down

0x12

Scroll Up

0x13

Scroll Right

0x14

Scroll Left

0x15

Browser Home

09 CD62 00

0D CD62 0c wt ai₀..ai₇ ac p₀..p₁

Window type

0x03

Browser

ai₀..ai₇

Action

0x0D

Set page (PDF Viewer)

p₀..p₁

Page number

09 CD62 00

0D CD62 0a wt ai₀..ai₇ ac

Window type

0x06

Video

ai₀..ai₇

Action

0x00

Play

0x01

Pause

0x02

Stop

0x03

Forward

0x04

Rewind

0x07

Loop Off

0x08

Loop On

0x09

Loop Toggle

09 CD62 00

0D CD62 0c wt ai₀..ai₇ ac f₀..f₁

Window type

0x06

Video

ai₀..ai₇

Action

0x05

File path

f₀..f₁

Max. 512 bytes
Fully qualified name: e.g. USB:///folder/video.mp4

09 CD62 00

0D CD62 0e wt ai₀..ai₇ ac p₀..p₃

Window type

0x06

Video

ai₀..ai₇

Action

0x06

Seek

p₀..p₃

Position

In ms

09 CD62 00

0D CD62 0c wt ai₀..ai₇ ac f₀..f₁

Window type

0x08

Image

ai₀..ai₇

Action

0x00

File path

f₀..f₁

Max. 512 bytes
Fully qualified name: e.g. USB:///folder/image.jpg

09 CD62 00

0D CD62 0a wt ai₀..ai₇ ac

Window type

0x08

Image

ai₀..ai₇

Action

0x01

Previous Image

0x02

Next Image

0x03

First Image

0x04

Last Image

09 CD62 00

0D CD62 0c wt ai₀..ai₇ ac f₀..f₁

Window type

0x09

PDF

ai₀..ai₇

Action

0x00

File path

f₀..f₁

Fully qualified name: e.g. USB:///folder/document.pdf

09 CD62 00

0D CD62 0a wt ai₀..ai₇ ac

Window type

0x09

PDF

ai₀..ai₇

Action

0x01

Zoom In

0x02

Zoom Out

0x03

Cursor Down

0x04

Cursor Up

0x05

Cursor Right

0x06

Cursor Left

0x07

0x08

0x0A

Set zoom to full height

0x0B

Set zoom to full width

0x0C

Set zoom to full page

0x0D

Scroll Down

0x0E

Scroll Up

0x0F

Scroll Right

0x10

Scroll Left

09 CD62 00

0D CD62 0c wt ai₀..ai₇ ac p₀..p₁

Window type

0x09

PDF

ai₀..ai₇

Action

0x09

Set page

p₀..p₁

Page number

09 CD62 00

0D CD62 0a wt ai₀..ai₇ ac

Window type

0x0E

Audio

ai₀..ai₇

Action

0x00

Play

0x01

Pause

0x02

Stop

0x03

Forward

0x04

Rewind

0x07

Loop Off

0x08

Loop On

0x09

Loop Toggle

09 CD62 00

0D CD62 0c wt ai₀..ai₇ ac f₀..f₁

Window type

0x0E

Audio

ai₀..ai₇

Action

0x05

File path

f₀..f₁

Max. 512 bytes
Fully qualified name: e.g. USB:///folder/audio.mp3

09 CD62 00

0D CD62 0e wt ai₀..ai₇ ac p₀..p₃

Window type

0x0E

Audio

ai₀..ai₇

Action

0x06

Seek

p₀..p₃

Position

In ms

09 CD62 00

0D CD62 0c wt ai₀..ai₇ ac f₀..f₁

Window type

0x0A

Office Presentation

0x0B

Office Text

0x0C

Office Calc

ai₀..ai₇

Action

0x00

File path

f₀..f₁

Max. 512 bytes
Fully qualified name: e.g. USB:///folder/spreadsheet.xlsx

09 CD62 00

0D CD62 0a wt ai₀..ai₇ ac

Window type

0x0A

Office Presentation

0x0B

Office Text

0x0C

Office Calc

ai₀..ai₇

Action

0x01

Zoom In

0x02

Zoom Out

0x03

Cursor Down

0x04

Cursor Up

0x05

Cursor Right

0x06

Cursor Left

0x07

0x08

0x09

Next Worksheet

0x0A

Previous Worksheet

0x0B

Set zoom to full page

0x0C

Set zoom to full width

0x0D

Scroll Down

0x0E

Scroll Up

0x0F

Scroll Right

0x10

Scroll Left

09 CD62 00

0D CD62 0c wt ai₀..ai₇ ac u₀..u₁

Window type

0x13

Office365 Outlook

0x14

Office365 Word

0x15

Office365 Excel

0x16

Office365 PowerPoint

0x17

Office365 OneNote

0x1B

Office365 Teams

0x1E

Office365 Whiteboard

0x1F

Office365 Planner

ai₀..ai₇

Action

0x00

URL

u₀..u₁

Max. 512 bytes

09 CD62 00

0D CD62 0a wt ai₀..ai₇ ac

Window type

0x13

Office365 Outlook

0x14

Office365 Word

0x15

Office365 Excel

0x16

Office365 PowerPoint

0x17

Office365 OneNote

0x1B

Office365 Teams

0x1E

Office365 Whiteboard

0x1F

Office365 Planner

ai₀..ai₇

Action

0x01

Reload

0x02

Stop

0x03

Zoom In

0x04

Zoom Out

0x05

Cursor Down

0x06

Cursor Up

0x07

Cursor Right

0x08

Cursor Left

0x09

Back

0x0A

Forward

0x0B

Scroll Down

0x0C

Scroll Up

0x0D

Scroll Right

0x0E

Scroll Left

09 CD62 00

0D CD62 0a wt ai₀..ai₇ ac

Window type

0x04

Miracast

ai₀..ai₇

Application ID

Action

0x00

Low latency off

0x01

Low latency on

0x02

Low latency toggle

09 CD62 00

GET

Output Mirroring

Userlevel: User

08 CD6A 00

08 CD6A 01 oo

0x00

Off

0x01

SET

Output Mirroring

Userlevel: User

09 CD6A 01 oo

0x00

Off

0x01

09 CD6A 00

SET

Application Multiple Events

Userlevel: User

0D CD6B ab cd bl ai₀..ai₇ o₀..o₁ ac k₀..k₁ x₀..x₁ y₀..y₁ k₀..k₁

Block length

ai₀..ai₇

o₀..o₁

Output Selection

0x0001

HDMI1

0x0008

Edit Mode

0x0010

WebRTC

Event action for keyboard, pointer and touch events

0x01

Key Tip

0x02

Key Release

0x03

Pointer Relative

0x04

Pointer Absolute

0x05

Touch Down

0x06

Touch Motion

0x07

Touch Up

0x08

Touch Cancel

k₀..k₁

Reserved

Fill with 0.

x₀..x₁

X position

Coordinate origin is the upper left corner of the output. Fill with 0 if not needed.

y₀..y₁

Y position

Coordinate origin is the upper left corner of the output. Fill with 0 if not needed.

k₀..k₁

Key code

Linux Input Event Code. Fill with 0 if not needed.

09 CD6B 00

GET

Webconference Aux as Screenshare Display

Userlevel: User

08 CD6C 00

08 CD6C 01 oo

0x00

Off

0x01

SET

Webconference Aux as Screenshare Display

Userlevel: Admin

09 CD6C 01 oo

0x00

Off

0x01

09 CD6C 00

GET

Control Screen Resolution

Userlevel: Admin

08 CD6D 00

08 CD6D 01 re

Resolution

0x00

Auto

0x01

1080p60

0x02

2160p30

0x04

1080p30

SET

Control Screen Resolution

Userlevel: Admin

09 CD6D 01 re

Resolution

0x00

Auto

0x01

1080p60

0x02

2160p30

0x04

1080p30

09 CD6D 00

SET

Miracast Control

Userlevel: User

0D CD6E 02 wn ac

0x00..0x03

Window number (0..3)

Action

0x00

Low latency off

0x01

Low latency on

0x02

Low latency toggle

09 CD6E 00

GET

Webconference Application Status

Userlevel: None

08 CD80 00

0C CD80 ab cd sl₀..sl₁ sb₀..sb_n

sl₀..sl₁

Webconference application status block legnth

sb₀..sb_n^inf

Webconference application status block

wi0..wi7: Application ID

0: No active webconferencing

rw: Restricted window

0x00: No
0x01: Yes

op0..op1: output port

0x0001: HDMI1
0x0002: HDMI2
0x0008: Edit Mode
0x0020: Screenshare

GET

Simple Windows Basic

Userlevel: User

08 CD85 00

08 CD85 ab bl bd₀..bd_n

block length

bd₀..bd_n

block data

wt: Window type

0x00 = None
0x01 = Visualizer
0x02 = HDMI
0x03 = Browser
0x04 = Miracast
0x05 = Airplay/Chromecast
0x06 = Video
0x07 = vSolution Cast/App
0x08 = Image
0x09 = PDF
0x0A = Office PPT/PPTX
0x0B = Office DOC/DOCX/TXT
0x0C = Office XLS/XLSX
0x0D = Whiteboard
0x0E = Audio
0x0F = Webconference
0x10 = Webcam
0x11 = Stream Input
0x13 = Office 365 Outlook
0x14 = Office 365 Word
0x15 = Office 365 Excel
0x16 = Office 365 PowerPoint
0x17 = Office 365 OneNote
0x18 = vMatrix Pull Stream (from station)
0x19 = vMatrix Push Stream (to station)
0x1A = vMatrix Station Browser
0x1B = Office 365 Teams
0x1C = vMatrix Groupwork Stream
0x1E = Office 365 Whiteboard
0x1F = Office 365 Planner

fs: Full screen

0x00: Normal
0x01: Full screen

mu: Mute

0x00: Not muted
0x01: Muted

The parameters block length and block data are combined in one block that is repeated four times.

Recording (35)

GET

Video/Audio Recording

Userlevel: Annotation

08 CB25 00

08 CB25 05 st t₀..t₃

State

0x00

Recording

0x01

Paused

0x02

Stopped

t₀..t₃

Recording time

In ms

SET

Video/Audio Recording

Userlevel: User

09 CB25 01 ac

Action

0x00

Start

0x01

Pause/Resume

0x02

Stop

09 CB25 00

09 CB25 ab ac lf f₀..f_n

Action

0x00

Start

Filename length

Max. 64 bytes, URL encoded

f₀..f_n

Filename

09 CB25 00

09 CB25 ab ac lf f₀..f_n co

Action

0x00

Start

Filename length

Max. 64 bytes, URL encoded

f₀..f_n

Filename

Content

0x00

Video and Audio

0x01

Audio only

09 CB25 00

GET

Recording Resolution

Userlevel: Admin

08 CB26 00

08 CB26 01 re

Resolution

0x00

Full HD (1080p, 1920x1080)

0x01

HD (720p, 1280x720)

0x02

qHD (540p, 960x540)

0x03

nHD (360p, 640x360)

SET

Recording Resolution

Userlevel: Admin

09 CB26 01 re

Resolution

0x00

Full HD (1080p, 1920x1080)

0x01

HD (720p, 1280x720)

0x02

qHD (540p, 960x540)

0x03

nHD (360p, 640x360)

09 CB26 00

SET

Image Snapshot

Userlevel: User

09 CB32 01 ac

Action

0x00

Take snapshot

09 CB32 00

GET

Recording Function

Userlevel: None

08 CB92 00

08 CB92 01 st

0x00

Disabled

0x01

Enabled

SET

Recording Function

Userlevel: Admin

09 CB92 01 st

0x00

Disable

0x01

Enable

09 CB92 00

GET

Recording Framerate

Userlevel: Admin

08 CB94 00

08 CB94 01 fr

Framerate

0x00

Low (10 FPS)

0x01

Medium (20 FPS)

0x02

High (30 FPS)

SET

Recording Framerate

Userlevel: Admin

09 CB94 01 fr

Framerate

0x00

Low (10 FPS

0x01

Medium (20 FPS)

0x02

High (30 FPS)

09 CB94 00

GET

Recording Stream Input Setup

Userlevel: Admin

08 CC22 00

0C CC22 ab cd mo ra o₀..o₁ ls s₀..s_n

Mode

0x00

None

0x01

Generic

0x02

RTSP/RTP over TCP

Record audio track

0x00

Disabled

0x01

Enabled

o₀..o₁

Offset

In ms

Stream input URL length

Max. 255 bytes

s₀..s_n

Stream input URL

SET

Recording Stream Input Setup

Userlevel: Admin

0D CC22 ab cd mo ra o₀..o₁ ls s₀..s_n

Mode

0x00

None

0x01

Generic

0x02

RTSP/RTP over TCP

Record audio track

0x00

Disable

0x01

Enable

o₀..o₁

Offset

In ms

Stream input URL length

Max. 255 bytes

s₀..s_n

Stream input URL

09 CC22 00

SET

Test Recording Stream Input Setup

Userlevel: Admin

09 CC24 01 ac

Action

0x00

Start preview of recording stream input

09 CC24 00

GET

Recording Trigger

Userlevel: User

08 CC26 00

08 CC26 01 tr

Trigger

0x00

None

0x01

Manual

0x02

Opencast

0x03

Panopto

0x04

Panopto Auto

GET

Recording Safety Mode

Userlevel: User

08 CC27 00

08 CC27 01 oo

0x00

Off

0x01

SET

Recording Safety Mode

Userlevel: Admin

09 CC27 01 oo

0x00

Off

0x01

09 CC27 00

GET

Support audio only recording

Userlevel: None

08 CC28 00

08 CC28 01 oo

0x00

Off

0x01

SET

Support audio only recording

Userlevel: Admin

09 CC28 01 oo

0x00

Off

0x01

09 CC28 00

GET

Recording Stream Input Health Status

Userlevel: None

08 CC2D 00

08 CC2D 01 st

Status

0x00

None

0x01

0x02

Error

GET

Recording Location

Userlevel: User

08 CC2F 00

0C CC2F ab cd ll l₀..l_n lu u₀..u_n

Recording location length

Max. 255 bytes

l₀..l_n

Recording location

Recording location URI length

Max. 255 bytes

u₀..u_n

Recording location URI

GET

Recording Extern Source

Userlevel: Admin

08 CC30 00

08 CC30 02 es ei

Extern Source Type

0x00

None

0x01

Stream Input

0x02

HDMI In

0x03

USB Video Input

Extern Source Index

SET

Recording Extern Source

Userlevel: Admin

09 CC30 02 es ei

Extern Source Type

0x00

None

0x01

Stream Input

0x02

HDMI In

0x03

USB Video Input

Extern Source Index

09 CC30 00

GET

Recording Rename

Userlevel: None

08 CC9B 00

08 CC9B 01 oo

0x00

Off

0x01

SET

Recording Rename

Userlevel: Admin

09 CC9B 01 oo

0x00

Off

0x01

09 CC9B 00

GET

PIP Function

Userlevel: Admin

08 CD06 00

08 CD06 01 st

0x00

Disabled

0x01

Enabled

SET

PIP Function

Userlevel: Admin

09 CD06 01 st

0x00

Disable

0x01

Enable

09 CD06 00

GET

PIP Content

Userlevel: User

08 CD07 00

08 CD07 01 co

Content

0x00

IP Camera

0x01

Main Screen

SET

PIP Content

Userlevel: User

09 CD07 01 co

Content

0x00

IP Camera

0x01

Main Screen

09 CD07 00

GET

PIP Camera Latency

Userlevel: User

08 CD08 00

08 CD08 02 la₀..la₁

la₀..la₁

Latency

0x000..0x07D0

Latency in ms (0..2000)

SET

PIP Camera Latency

Userlevel: Admin

09 CD08 02 la₀..la₁

la₀..la₁

Latency

0x0000..0x07D0

Latency in ms (0..2000)

09 CD08 00

GET

PIP Size

Userlevel: User

08 CD0B 00

08 CD0B 01 si

Size

0x00

360p wide

SET

PIP Size

Userlevel: User

09 CD0B 01 si

Size

0x00

360p wide

09 CD0B 00

GET

PIP Position

Userlevel: User

08 CD0C 00

08 CD0C 01 po

Position

0x00

Top Left

0x01

Top Right

0x02

Bottom Left

0x03

Bottom Right

SET

PIP Position

Userlevel: User

09 CD0C 01 po

Position

0x00

Top Left

0x01

Top Right

0x02

Bottom Left

0x03

Bottom Right

09 CD0C 00

GET

PIP Stream Input

Userlevel: User

08 CD0D 00

08 CD0D 01 in

Index

0x00..0x03 = Index (0..3)

SET

PIP Stream Input

Userlevel: Admin

09 CD0D 01 in

Index

0x00..0x03 = Index (0..3)

09 CD0D 00

Remote (1)

SET

CB Remote

Userlevel: None

09 CB01 02 ky ac

Key

0x00

None

0x01

Left

0x02

Right

0x03

0x04

Down

0x05

0x06

0x07

Red

0x08

Green

0x09

Yellow

0x0A

Blue

0x0B

Toolbox

0x0C

USB File Listing

Action

0x00

None

0x01

Hit: Button was pressed and is currently hold (Begin of long press)

0x02

Release: Button was released after holding it (End of long press)

0x03

Tip: Button was pressed and is already released (Short press)

09 CB01 00

RMS Client (5)

GET

RMS Client

Userlevel: Admin

08 CC06 01 in

Index

0x00..0x13

Index (0..19)

0C CC06 ab cd in ev ln n₀..n_n ld d₀..d_n pt ip₀..ip₃ p₀..p₁ lc c₀..c_n en lpw pw₀..pw_n wc de

Index

0x00..0x13

Index (0..19)

Event

0x00

None

0x01

Power On

0x02

Power Off

0x03

Custom Button 1

0x04

Custom Button 2

0x05

Custom Button 3

0x06

Custom Button 4

0x07

Custom Button 5

0x08

Custom Button 6

0x09

Custom Button 7

0x0A

Custom Button 8

0x0B

Screen On

0x0C

Screen Off

Name length

Max. 255 bytes

n₀..n_n

Name

Description length

Max. 255 bytes

d₀..d_n

Description

Protocol type

0x00

TCP

0x01

UDP

0x02

PJLINK

0x03

WOLFPROT

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

p₀..p₁

Port

Command length

Max. 255 bytes

c₀..c_n

Command

Encoded as HEX string: e.g. 0F010A030405EFA0

Enabled

0x00

False

0x01

True

lpw

Password length

Max. 32 bytes

pw₀..pw_n

Password

Wolfprot Command

0x00

None

0x01

Mirroring Permission Allow

Delay

0x00..0x78

0..120 seconds

SET

RMS Client

Userlevel: Admin

0D CC06 ab cd in ev ln n₀..n_n ld d₀..d_n pt ip₀..ip₃ p₀..p₁ lc c₀..c_n en lpw pw₀..pw_n wc de

Index

0x00..0x13

Index (0..19)

Event

0x00

None

0x01

Power On

0x02

Power Off

0x03

Custom Button 1

0x04

Custom Button 2

0x05

Custom Button 3

0x06

Custom Button 4

0x07

Custom Button 5

0x08

Custom Button 6

0x09

Custom Button 7

0x0A

Custom Button 8

0x0B

Screen On

0x0C

Screen Off

Name length

Max. 255 bytes

n₀..n_n

Name

Description length

Max. 255 bytes

d₀..d_n

Description

Protocol type

0x00

TCP

0x01

UDP

0x02

PJLINK

0x03

WOLFPROT

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

p₀..p₁

Port

Command length

Max. 255 bytes

c₀..c_n

Command

Encoded as HEX string: e.g. 0F010A030405EFA0

Enabled

0x00

False

0x01

True

lpw

Password length

Max. 32 bytes

pw₀..pw_n

Password

Wolfprot Command

0x00

None

0x01

Mirroring Permission Allow

Delay

0x00..0x78

0..120 seconds

09 CC06 00

SET

RMS Client Test

Userlevel: Admin

09 CC07 01 in

Index

0x00..0x13

Index (0..19)

09 CC07 00

SET

RMS Client Event Trigger

Userlevel: User

09 CCDC 01 ev

Event

0x03

Custom Button 1

0x04

Custom Button 2

0x05

Custom Button 3

0x06

Custom Button 4

0x07

Custom Button 5

0x08

Custom Button 6

0x09

Custom Button 7

0x0A

Custom Button 8

09 CCDC 00

GET

RMS Client Event

Userlevel: User

08 CCDD 01 in

Index

0x00..0x13

Index (0..19)

08 CCDD 03 in ev en

Index

0x00..0x13

Index (0..19)

Event

0x00

None

0x01

Power On

0x02

Power Off

0x03

Custom Button 1

0x04

Custom Button 2

0x05

Custom Button 3

0x06

Custom Button 4

0x07

Custom Button 5

0x08

Custom Button 6

0x09

Custom Button 7

0x0A

Custom Button 8

0x0B

Screen On

0x0C

Screen Off

Enabled

0x00

False

0x01

True

Routing (4)

GET

Routing Mode

Userlevel: Admin

08 CCEA 00

08 CCEA 01 oo

0x00

Off

0x01

SET

Routing Mode

Userlevel: Admin

09 CCEA 01 oo

0x00

Off

0x01

09 CCEA 00

GET

Firewall

Userlevel: Admin

08 CD14 02 in se

Interface

0x00

LAN1

0x01

LAN2

0x02

WLAN

Service

0x00

HTTP/HTTPS

0x01

RTSP

08 CD14 03 in se ac

Interface

0x00

LAN1

0x01

LAN2

0x02

WLAN

Service

0x00

HTTP/HTTPS

0x01

RTSP

Action

0x00

Deny traffic

0x01

Accept traffic

SET

Firewall

Userlevel: Admin

09 CD14 03 in se ac

Interface

0x00

LAN1

0x01

LAN2

0x02

WLAN

Service

0x00

HTTP/HTTPS

0x01

RTSP

Action

0x00

Deny traffic

0x01

Accept traffic

09 CD14 00

Routing Table (2)

GET

Routing Table

Userlevel: Admin

08 CD0A 01 in

Index

0x00..0x09

Index (0..9)

0C CD0A 0d in en ip₀..ip₃ pr ge gw₀..gw₃ de

Index

0x00..0x09

Index (0..9)

Enable

0x00

Off

0x01

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Prefix

0x01..0x20

1..32

Gateway enable

0x00

Off

0x01

gw₀..gw₃

Gateway IP

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Device

0x00

LAN1

0x01

LAN2

0x02

WLAN

SET

Routing Table

Userlevel: Admin

0D CD0A 0d in en ip₀..ip₃ pr ge gw₀..gw₃ de

Index

0x00..0x09

Index (0..9)

Enable

0x00

Off

0x01

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Prefix

0x01..0x20

1..32

Gateway enable

0x00

Off

0x01

gw₀..gw₃

Gateway IP

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Device

0x00

LAN1

0x01

LAN2

0x02

WLAN

09 CD0A 00

Session Handling (18)

GET

iCalendar Events

Userlevel: User

08 CC36 00

0A01 CC36 ab cd ef gh lj₀..lj₃ j₀..j_n

lj₀..lj₃

iCal events list length

j₀..j_n

iCal events list

iCal events list as JSON string, based on iCalendar Standard RFC5545, RFC5546 and RFC7529

Syntax:

uid
index
summary
stop
location
start
id
start_trigger
password
stop_trigger
file_trigger

Example:
[{"uid": "466951C051", "index": 0, "summary": "My event", "stop": 1486454400, "location": "Austria", "start": 1486450800, "id": "1234", "start_trigger": "http://192.168.0.147/api/v1/wolfvision/cynap/1234/start", "password": "12345", "stop_trigger": "http://192.168.0.147/api/v1/wolfvision/cynap/1234/stop", "file_trigger": "http://192.168.0.147/api/v1/wolfvision/cynap/1234/file"}]

SET

iCalendar Events

Userlevel: User

0B01 CC36 ab cd ef gh n₀..n₁ le₀..le₃ e₀..e_n

n₀..n₁

Number of iCal events

le₀..le₃

iCal events length

e₀..e_n

iCal events

09 CC36 00

SET

Custom Cloud File List

Userlevel: User

0B01 CC37 ab cd ef gh lj₀..lj₃ j₀..j_n

lj₀..lj₃

File list length

j₀..j_n

File list

File list as JSON string

Syntax:

eventid
- name: Name of directory
- childs: Array of files in directory
  - name: Filename
  - thumbnail: Thumbnail URL
  - size: Filesize in bytes

Example:
[{"eventID1": {"name": "/", "childs": [{"name": "a%23au.jpg", "thumbnail": "http://url-to-thumbnail/foo3.jpeg", "size": 12695554}, {"name": "puitin.jpg", "thumbnail": "http://url-to-thumbnail/foo3.jpeg", "size": 126548}, {"name": "wolfvision", "childs": [{"name": "presenter.mp4", "thumbnail": "http://url-to-thumbnail/foo3.jpeg", "size": 182395502}, {"name": "IMG_20160801_164107.jpg", "thumbnail": "http://url-to-thumbnail/foo3.jpeg", "size": 12425962}]}]}}]

09 CC37 00

SET

Send Middleware Trigger

Userlevel: User

0D CC38 ab cd ac le₀..le₁ e₀..e_n lp₀..lp₁ p₀..p_n

Action

0x00

Stop

0x01

Start

le₀..le₁

Event ID length

Max. 255 bytes

e₀..e_n

Event ID

lp₀..lp₁

Event ID password length

Max. 255 bytes

p₀..p_n

Event ID password

09 CC38 00

GET

Active Session

Userlevel: None

08 CC39 00

0C CC39 ab cd le₀..le₁ e₀..e_n

le₀..le₁

Event ID length

Max. 255 bytes

e₀..e_n

Event ID

SET

Start/Stop Session

Userlevel: User

0D CC39 ab cd ac le₀..le₁ e₀..e_n

Action

0x00

Stop

0x01

Start

le₀..le₁

Event ID length

Max. 255 bytes

e₀..e_n

Event ID

09 CC39 00

SET

File Download Start

Userlevel: User

0D CC3B ab cd le e₀..e_n fs₀..fs₃ lf f₀..f_n

Event ID length

Max. 255 bytes

e₀..e_n

Event ID

fs₀..fs₃

Filesize

Filename length

Max. 255 bytes

f₀..f_n

Filename

09 CC3B 00

SET

File Download Data

Userlevel: User

0B01 CC3C ab cd ef gh b₀..b_n

b₀..b_n^inf

Binary file data

09 CC3C 00

SET

File Download Stop

Userlevel: User

09 CC3D 00

GET

Middleware Endpoint Access Credentials

Userlevel: Admin

08 CC3E 00

0C CC3E ab cd lt0 t₀..t_n sl0 s₀..s_n

lt0

Token length

t₀..t_n

Token

Max. 255 bytes

sl0

Secret length

s₀..s_n

Secret

Max. 255 bytes

Parameter block syntax:
lt0: Token length
t0..tn: Token
sl0: Secret length
s0..sn: Secret

SET

Middleware Endpoint Access Credentials

Userlevel: Admin

0D CC3E ab cd lt t₀..t_n ls s₀..s_n

Token length

Max. 255 bytes

t₀..t_n

Token

Secret length

Max. 255 bytes

s₀..s_n

Secret

09 CC3E 00

GET

File Upload Start

Userlevel: User

0C CC3F ab cd lf₀..lf₁ f₀..f_n

lf₀..lf₁

Filename length

Max. 255 bytes

f₀..f_n

Filename

Fully qualified name: e.g. Internal:///snapshots/cynap_foo.jpg

08 CC3F 04 fs₀..fs₃

fs₀..fs₃

Filesize

In bytes

GET

File Upload Data

Userlevel: User

08 CC40 04 b₀..b₃

b₀..b₃

Buffer size

In bytes

0A01 CC40 ab cd ef gh lb₀..lb₃ b₀..b_n

lb₀..lb₃

Binary file data length

b₀..b_n

Binary file data

GET

File Upload Stop

Userlevel: User

08 CC41 00

GET

Custom Cloud Name

Userlevel: User

08 CC47 00

08 CC47 ab n₀..n_n

n₀..n_n^inf

Name

Max. 255 bytes

SET

Custom Cloud Name

Userlevel: Admin

09 CC47 ab n₀..n_n

n₀..n_n^inf

Name

Max. 255 bytes

09 CC47 00

GET

Session Handling Support

Userlevel: None

08 CC48 00

08 CC48 01 st

0x00

Disabled

0x01

Enabled

SET

Session Handling Support

Userlevel: Admin

09 CC48 01 st

0x00

Disable

0x01

Enable

09 CC48 00

Streaming (28)

GET

Streaming Mode

Userlevel: None

08 CB20 00

08 CB20 01 oo

0x00

Off

0x01

SET

Streaming Mode

Userlevel: User

09 CB20 01 oo

0x00

Off

0x01

09 CB20 00

GET

RTP Streaming IP Address

Userlevel: Admin

08 CB21 00

08 CB21 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

08 CB21 00

08 CB21 08 s1a0..s1a3 s2a0..s2a3

s1a0..s1a3

Stream 1 IP Address

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

s2a0..s2a3

Stream 2 IP Address

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

SET

RTP Streaming IP Address

Userlevel: Admin

09 CB21 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

09 CB21 00

09 CB21 05 ip₀..ip₃ sn

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

0x01

RTP Stream 1 (HDMI1)

0x02

RTP Stream 2 (HDMI2)

09 CB21 00

GET

RTP Streaming Port

Userlevel: Admin

08 CB22 00

08 CB22 02 po..p1

po..p1

Port

0x2260..0x2328

Port (8800..9000)

08 CB22 00

08 CB22 04 s1po..s1p1 s2po..s2p1

s1po..s1p1

Stream 1 Port

0x2260..0x2328

Port (8800..9000)

s2po..s2p1

Stream 2 Port

0x2260..0x2328

Port (8800..9000)

SET

RTP Streaming Port

Userlevel: Admin

09 CB22 02 p₀..p₁

p₀..p₁

Port

0x2260..0x2328

Port (8800..9000)

09 CB22 00

09 CB22 03 p₀..p₁ sn

p₀..p₁

Port

0x2260..0x2328

Port (8800..9000)

0x01

RTP Stream 1 (HDMI1)

0x02

RTP Stream 2 (HDMI2)

09 CB22 00

GET

Streaming Resolution

Userlevel: Admin

08 CB23 00

08 CB23 01 re

Resolution

0x00

Full HD (1080p, 1920x1080)

0x01

HD (720p, 1280x720)

0x02

qHD (540p, 960x540)

0x03

nHD (360p, 640x360)

SET

Streaming Resolution

Userlevel: Admin

09 CB23 01 re

Resolution

0x00

Full HD (1080p, 1920x1080)

0x01

HD (720p, 1280x720)

0x02

qHD (540p, 960x540)

0x03

nHD (360p, 640x360)

09 CB23 00

GET

Streaming Framerate

Userlevel: Admin

08 CB24 00

08 CB24 01 fr

Framerate

0x00

Low (10 FPS)

0x01

Medium (20 FPS)

0x02

High (30 FPS)

SET

Streaming Framerate

Userlevel: Admin

09 CB24 01 fr

Framerate

0x00

Low (10 FPS)

0x01

Medium (20 FPS)

0x02

High (30 FPS)

09 CB24 00

GET

RTP Streaming Interface

Userlevel: Admin

08 CB5C 00

08 CB5C 01 in

Interface

0x00

LAN

0x01

WLAN

08 CB5C 00

08 CB5C 02 in1 in2

in1

Stream 1 Interface

0x00

LAN

0x01

WLAN

in2

Stream 2 Interface

0x00

LAN

0x01

WLAN

SET

RTP Streaming Interface

Userlevel: Admin

09 CB5C 01 in

Interface

0x00

LAN

0x01

WLAN

09 CB5C 00

09 CB5C 02 in sn

Interface

0x00

LAN

0x01

WLAN

0x01

RTP Stream 1 (HDMI1)

0x02

RTP Stream 2 (HDMI2)

09 CB5C 00

GET

Streaming Function

Userlevel: None

08 CB93 00

08 CB93 01 st

0x00

Disabled

0x01

Enabled

SET

Streaming Function

Userlevel: Admin

09 CB93 01 st

0x00

Disable

0x01

Enable

09 CB93 00

GET

RTP Streaming Mode

Userlevel: None

08 CBD4 00

08 CBD4 01 oo

0x00

Off

0x01

SET

RTP Streaming Mode

Userlevel: Admin

09 CBD4 01 oo

0x00

Off

0x01

09 CBD4 00

GET

RTSP Streaming Mode

Userlevel: None

08 CBD5 00

08 CBD5 01 oo

0x00

Off

0x01

SET

RTSP Streaming Mode

Userlevel: Admin

09 CBD5 01 oo

0x00

Off

0x01

09 CBD5 00

GET

RTP Unicast TTL

Userlevel: Admin

08 CBD9 00

08 CBD9 01 tt

TTL

0x01..0xFF

TTL (1..255)

08 CBD9 00

08 CBD9 02 tt1 tt2

tt1

Stream 1 TTL

0x01..0xFF

TTL (1..255)

tt2

Stream 2 TTL

0x01..0xFF

TTL (1..255)

SET

RTP Unicast TTL

Userlevel: Admin

09 CBD9 01 tt

TTL

0x01..0xFF

TTL (1..255)

09 CBD9 00

09 CBD9 02 tt sn

TTL

0x01..0xFF

TTL (1..255)

0x01

RTP Stream 1 (HDMI1)

0x02

RTP Stream 2 (HDMI2)

09 CBD9 00

GET

RTP Multicast TTL

Userlevel: Admin

08 CBDA 00

08 CBDA 01 tt

TTL

0x01..0xFF

TTL (1..255)

08 CBDA 00

08 CBDA 02 tt1 tt2

tt1

Stream 1 TTL

0x01..0xFF

TTL (1..255)

tt2

Stream 2 TTL

0x01..0xFF

TTL (1..255)

SET

RTP Multicast TTL

Userlevel: Admin

09 CBDA 01 tt

TTL

0x01..0xFF

TTL (1..255)

09 CBDA 00

09 CBDA 02 tt sn

TTL

0x01..0xFF

TTL (1..255)

0x01

RTP Stream 1 (HDMI1)

0x02

RTP Stream 2 (HDMI2)

09 CBDA 00

GET

RTSP URL Interface

Userlevel: Admin

08 CBE5 00

08 CBE5 01 in

Interface

0x00

LAN: Use IP address of LAN interface for streaming URL

0x01

WLAN: Use IP address of WLAN interface for streaming URL

SET

RTSP URL Interface

Userlevel: Admin

09 CBE5 01 in

Interface

0x00

LAN: Use IP address of LAN interface for streaming URL

0x01

WLAN: Use IP address of WLAN interface for streaming URL

09 CBE5 00

GET

Streaming URL Mode

Userlevel: Admin

08 CC69 00

08 CC69 01 mo

Mode

0x00

Static URL

0x01

Dynamic URL

SET

Streaming URL Mode

Userlevel: Admin

09 CC69 01 mo

Mode

0x00

Static URL

0x01

Dynamic URL

09 CC69 00

GET

Streaming Bitrate Mode

Userlevel: User

08 CC75 00

08 CC75 03 mo br₀..br₁

Bitrate Mode

0x00

Constant

0x01

Variable

br₀..br₁

Bitrate

Average bitrate in kBit for 'Variable' mode

SET

Streaming Bitrate Mode

Userlevel: Admin

09 CC75 03 mo br₀..br₁

Bitrate Mode

0x00

Constant

0x01

Variable

br₀..br₁

Bitrate

Average bitrate in kBit for 'Variable' mode

09 CC75 00

System (248)

GET

Power

Userlevel: None

08 CB0C 00

08 CB0C 01 oo

0x00

Off

0x01

SET

Power

Userlevel: User

09 CB0C 01 oo

0x00

Off

0x01

"Power On" is only applicable within 30 seconds after "Power Off" command was sent. If Cynap is already in Standby mode, Wake On LAN has to be used instead of "Power On" command

09 CB0C 00

GET

Presentation Mode

Userlevel: None

08 CB38 00

08 CB38 02 mo pe

Mode

0x00

Meeting

0x01

Lecture

Permission timeout

0x0A..0x78

10 sec - 120 sec

SET

Presentation Mode

Userlevel: Admin

09 CB38 01 mo

Mode

0x00

Meeting

0x01

Lecture

09 CB38 00

09 CB38 02 mo pe

Mode

0x00

Meeting

0x01

Lecture

Permission timeout

0x0A..0x78

10 sec - 120 sec

09 CB38 00

GET

Admin Password

Userlevel: Admin

08 CB3F 00

08 CB3F ab p₀..p_n

p₀..p_n^inf

Password

Max. 63 bytes

SET

Admin Password

Userlevel: Admin

09 CB3F ab p₀..p_n

p₀..p_n^inf

Password

Max. 63 bytes

09 CB3F 00

GET

User Password

Userlevel: Admin

08 CB40 00

08 CB40 ab p₀..p_n

p₀..p_n^inf

Password

Max. 63 bytes

SET

User Password

Userlevel: Admin

09 CB40 ab p₀..p_n

p₀..p_n^inf

Password

Max. 63 bytes

09 CB40 00

GET

Remote Password

Userlevel: None

08 CB41 00

08 CB41 01 st

Status

0x00

Password not required

0x01

Password required

SET

Meeting Mode Password

Userlevel: Admin

09 CB41 01 ny

0x00

0x01

Yes

09 CB41 00

SET

Userlevel: None

09 CB42 ab al lp p₀..p_n ln n₀..n_n

Access level

0x01

User

0x02

Admin

0x03

Annotation

0x04

Viewer

Password length

Max. 63 bytes

p₀..p_n

Password

Max. 63 bytes

n₀..n_n

09 CB42 00

SET

MIP Login

Userlevel: None

09 CB47 04 ip₀..ip₃

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

09 CB47 00

SET

USB User Settings Save

Userlevel: User

09 CB48 00

SET

End Presentation

Userlevel: User

09 CB49 04 dr ds mo dw

Delete recordings folder

0x00

0x01

Yes

Delete snapshots folder

0x00

0x01

Yes

Power off mode

0x00

New Presentation

0x01

Standby (formerly: Power off)

0x02

Screen Off

0x03

Screensaver

Delete whiteboards folder

0x00

0x01

Yes

09 CB49 00

GET

USB Mic Card Name

Userlevel: Admin

08 CB4E 00

08 CB4E ab c₀..c_n

c₀..c_n^inf

Card name

URL encoded

SET

USB Mic Card Name

Userlevel: Admin

09 CB4E ab c₀..c_n

c₀..c_n^inf

Card name

URL encoded

09 CB4E 00

GET

USB Mic Card List

Userlevel: Admin

08 CB4F 00

0C CB4F ab cd c₀..c_n

c₀..c_n^inf

Card names list (URL encoded)

List syntax:
lc0: Card name #0 length
c00..c0n: Card name #0
..
lcn: Card name #n length
cn0..cnn: Card name #n

GET

Firmware Version

Userlevel: None

08 CB50 00

0C CB50 ab cd j₀..j_n

j₀..j_n^inf

Firmware version

Firmware version as JSON string

Syntax:

cynap
- version: Vx.xxx
- buildnumber: Number with 14 digits
- stage
  - alpha
  - beta
  - release

Example:
{"cynap": {"version": "V1.15a", "buildnumber": "20170503010520", "stage": "alpha"}}

GET

Password Type

Userlevel: None

08 CB51 00

08 CB51 01 ty

Type

0x00

Local

0x01

SET

Password Type

Userlevel: Admin

09 CB51 01 ty

Type

0x00

Local

0x01

09 CB51 00

GET

PIN Destination

Userlevel: None

08 CB52 00

08 CB52 04 vz di ms rm

Show PIN on WolfVision Visualizer

0x00

0x01

Yes

Show PIN on Cynap display

0x00

0x01

Yes

Show PIN on main screen

0x00

0x01

Yes

Show PIN on room management system

0x00

0x01

Yes

SET

PIN Destination

Userlevel: Admin

09 CB52 04 vz di ms rm

Show PIN on WolfVision Visualizer

0x00

0x01

Yes

Show PIN on Cynap display

0x00

0x01

Yes

Show PIN on main screen

0x00

0x01

Yes

Show PIN on room management system

0x00

0x01

Yes

09 CB52 00

GET

PIN Status Local

Userlevel: None

08 CB53 00

08 CB53 01 st

Status

0x00

Hide PIN

08 CB53 00

08 CB53 05 st p₀..p₃

Status

0x01

Show PIN

p₀..p₃

PIN as 4-digit string: e.g. 0245, 8934 or 1500

GET

PIN Status RMS

Userlevel: None

08 CB54 00

08 CB54 01 st

Status

0x00

Hide PIN

08 CB54 00

08 CB54 05 st p₀..p₃

Status

0x01

Show PIN

p₀..p₃

PIN as 4-digit string: e.g. 0245, 8934 or 1500

GET

Userlevel: None

08 CB55 00

08 CB55 01 lv

Level

0x00

None

0x01

User

0x02

Admin

0x03

Annotation

0x04

Viewer

GET

Master Volume

Userlevel: Annotation

08 CB56 00

08 CB56 01 vo

0x00..0x64

Volume in percent (0..100)

SET

Master Volume

Userlevel: User

09 CB56 01 vo

0x00..0x64

Volume in percent (0..100)

09 CB56 00

GET

Master Mute

Userlevel: Annotation

08 CB58 00

08 CB58 01 oo

0x00

Off

0x01

SET

Master Mute

Userlevel: User

09 CB58 01 oo

0x00

Off

0x01

0x02

Toggle

09 CB58 00

GET

Mic Mute

Userlevel: Annotation

08 CB59 00

08 CB59 01 oo

0x00

Off

0x01

SET

Mic Mute

Userlevel: User

09 CB59 01 oo

0x00

Off

0x01

0x02

Toggle

09 CB59 00

GET

Main Freeze

Userlevel: Annotation

08 CB5A 00

08 CB5A 01 oo

0x00

Off

0x01

SET

Main Freeze

Userlevel: User

09 CB5A 01 oo

0x00

Off

0x01

0x02

Toggle

09 CB5A 00

GET

Status Bar

Userlevel: Annotation

08 CB5E 00

08 CB5E 01 ip

0x00

No IP

0x01

LAN

0x02

WLAN

0x03

Both

SET

Status Bar

Userlevel: Admin

09 CB5E 01 ip

0x00

No IP

0x01

LAN

0x02

WLAN

0x03

Both

09 CB5E 00

GET

Visualizer Status

Userlevel: User

08 CB68 00

08 CB68 11 st mo ft₀..ft₇ ip₀..ip₃ pw af fr

Status

0x00

No Visualizer connected

0x01

Visualizer connected with full integration support

Mode

0x00

No Visualizer connected

0x01

Visualizer connected with basic integration support

0x02

Visualizer connected with full integration support

0x03

Visualizer connected with basic integration support (FW Update)

0x04

Visualizer connected in security mode

ft₀..ft₇

Remote control features

ft0:

Bit7: Zoom
Bit6: Iris
Bit5: Mirror
Bit4: Focus
Bit3: AF
Bit2: Power
Bit1: Light
Bit0: ExtIn

ft1:

Bit7: Text
Bit6: WB
Bit5: Reset
Bit4: Image
Bit3: ImageTurn
Bit2: Freeze
Bit1: Arm
Bit0: Macro

ft2:

Bit7: Preset1
Bit6: Preset2
Bit5: Preset3
Bit4: Record
Bit3: Pause
Bit2: Stop
Bit1: Volume
Bit0: Mute

ft3:

Bit7: Capture Area Shift
Bit6: Memory1
Bit5: Memory2
Bit4: Memory3
Bit3: Memory4
Bit2: Memory5
Bit1: Memory6
Bit0: Memory7

ft4:

Bit7: Memory8
Bit6: Memory9
Bit5: ShowAll
Bit4: Menu
Bit3: OnePushAF
Bit2: Snapshot
Bit1: Pos/Neg
Bit0: Pos/Blue

ft5:

Bit7: Not Used (FWUpdate)
Bit6: Not Used (PT_dZoom)
Bit5: Not Used (PT_ImageTurn)
Bit4: StrToggle (PT_dem_dZoom)
Bit3: Help? (PT_dem_0deg)
Bit2: Not Used (PT_dem90deg,)
Bit1: Not Used (PT_dem180deg)
Bit0: Not Used (PT_dem270deg)

ft6:

Bit7: PiP
Bit6: VZ
Bit5: Mem
Bit4: USB
Bit3: Black/White
Bit2: Vergence
Bit1: Mirror Center
Bit0: 2D/3D

ft7:

Bit7: Mem/USB Navigation (Pos1, End, Left, Right, OK)
Bit6: Ext2
Bit5: Str
Bit4: Video Navigation (Pos1, End, FF, FB, OK)
Bit3: Not Used
Bit2: Not Used
Bit1: Not Used
Bit0: Not Used

ip₀..ip₃

0x00000000..0xFFFFFFFF

0.0.0.0..255.255.255.255

Power state

0x00

Off

0x01

Autofocus state

0x00

Off

0x01

Freeze State

0x00

Off

0x01

SET

USB Copy File

Userlevel: User

deprecated

0D CB6A ab cd f₀..f_n

f₀..f_n^inf

File path

Max. 512 bytes
Fully qualified name: e.g. Internal:///recordings/video.mp4

09 CB6A 00

GET

Settings File

Userlevel: Admin

08 CB6B 00

0C CB6B ab cd b₀..b_n

b₀..b_n^inf

Binary file data

Max. 65530 bytes

08 CB6B 00

0A01 CB6B ab cd ef gh b₀..b_n

b₀..b_n^inf

Binary file data

SET

Settings File

Userlevel: Admin

0D CB6B ab cd b₀..b_n

b₀..b_n^inf

Binary file data

Max. 65530 bytes

09 CB6B 00

0B01 CB6B ab cd ef gh b₀..b_n

b₀..b_n^inf

Binary file data

09 CB6B 00

GET

OSD Message

Userlevel: Annotation

08 CB78 00

0C CB78 ab cd id ic lp p₀..p_n

Message ID

Icon

0x00

None

0x01

Info

0x02

Warning

0x03

Error

Parameter length

Max. 255 bytes

p₀..p_n

Parameter

GET

HDMI Input Setup

Userlevel: Admin

08 CB79 01 in

Input

0x00

HDMI 1

0x01

HDMI 2

08 CB79 ab in ty n₀..n_n

Input

0x00

HDMI 1

0x01

HDMI 2

Type

0x00

Visualizer

0x01

HDMI

0x02

Computer

0x03

Disc Player

0x04

Camera

n₀..n_n^inf

Name

Max. 253 bytes

SET

HDMI Input Setup

Userlevel: Admin

09 CB79 ab in ty n₀..n_n

Input

0x00

HDMI 1

0x01

HDMI 2

Type

0x00

Visualizer

0x01

HDMI

0x02

Computer

0x03

Disc Player

0x04

Camera

n₀..n_n^inf

Name

Max. 253 bytes

09 CB79 00

GET

Available Storage Space

Userlevel: Annotation

08 CB7E 01 un

Unit used for available space value

0x00

MB (Megabyte)

08 CB7E 05 un as₀..as₃

Unit used for available space value

0x00

MB (Megabyte)

as₀..as₃

Available space left

SET

Background Image

Userlevel: Admin

09 CB80 00

Delete currently used image

09 CB80 00

0B01 CB80 ab cd ef gh b₀..b_n

b₀..b_n^inf

Binary file data

Add new image

09 CB80 00

GET

PIN Status VZ

Userlevel: None

08 CB83 00

08 CB83 01 st

Status

0x00

Hide PIN

08 CB83 00

08 CB83 05 st p₀..p₃

Status

0x01

Show PIN

p₀..p₃

PIN as 4-digit string: e.g. 0245, 8934 or 1500

GET

Local Touch Keyboard

Userlevel: User

08 CB84 00

08 CB84 01 oo

0x00

Off

0x01

SET

Local Touch Keyboard

Userlevel: Admin

09 CB84 01 oo

0x00

Off

0x01

09 CB84 00

GET

Caps Lock

Userlevel: User

08 CB85 00

08 CB85 01 oo

0x00

Off

0x01

GET

QR Code

Userlevel: Annotation

08 CB88 00

08 CB88 ab sn q₀..q_n

Stream not in use

0x00

0x01

Yes

q₀..q_n^inf

QR Code string

Max. 255 bytes

SET

QR Code

Userlevel: User

09 CB88 01 oo

0x00

Off

0x01

09 CB88 00

GET

Extra Settings File

Userlevel: Annotation

08 CB89 ab f₀..f_n

f₀..f_n^inf

Filename

0A01 CB89 ab cd ef gh b₀..b_n

b₀..b_n^inf

Binary file data

08 CB89 01 si

stream index

08 CB89 ab sn q₀..q_n

Stream not in use

0x00

0x01

Yes

q₀..q_n^inf

QR Code string

SET

Extra Settings File

Userlevel: User

0B01 CB89 ab cd ef gh lf f₀..f_n b₀..b_n

Filename length

Max. 255 bytes

f₀..f_n

Filename

b₀..b_n^inf

Binary file data

09 CB89 00

GET

Access Token

Userlevel: Annotation

08 CB8A 00

08 CB8A 09 al t₀..t₇

Access level

0x00

None

0x01

User

0x02

Admin

0x03

Annotation

t₀..t₇

Token

SET

Access Token

Userlevel: None

09 CB8A 08 t₀..t₇

t₀..t₇

Token

09 CB8A 00

GET

USB User Settings Status

Userlevel: Annotation

08 CB8B 00

08 CB8B 01 st

Status

0x00

No user settings

0x01

User settings found

0x02

User settings loaded

0x03

User settings not loaded

SET

USB User Settings Load

Userlevel: User

09 CB8B 01 ac

Action

0x00

Don't load

0x01

Load

09 CB8B 00

GET

Front Panel Login

Userlevel: Admin

08 CB8E 00

08 CB8E 01 st

0x00

Disabled

0x01

Enabled

SET

Front Panel Login

Userlevel: Admin

09 CB8E 01 st

0x00

Disable

0x01

Enable

09 CB8E 00

GET

Content Sources

Userlevel: Annotation

08 CB90 00

0C CB90 ab cd ns ls src ct ln n₀..n_n t₀..t_n

Number of sources

Source block length

Combined length of Source status, Content type, Source name length, Source name and Type specific source block

src

Source status

0x00

Not ready

0x01

Available and ready

Content type

0x00

HDMI

0x01

Visualizer

0x02

Disc Player

0x03

Computer

0x04

Browser

0x07

Mirroring

0x08

Annotation/Whiteboard

0x09

Webconference

0x0A

Webcam

0x0B

Stream Input

0x0C

Office365

0x0D

Cynap

0x0E

Zoom

0x0F

Office365 Teams Webconference

0x10

Stream Input List

0x11

Camera

0x12

Browser Shortcut

0xFF

Undefined

Source name length

n₀..n_n

Source name

t₀..t_n^inf

Type specific source block

This block is optional (depends on Content type)

Type HDMI (ct=0x00):

in: Index
- 0 = HDMI 1
- 1 = HDMI 2

Type Webcam (ct=0x0A):

in: Index (0..1)
ct: Content type
- 0x00 = HDMI
- 0x01 = Visualizer
- 0x02 = Disc Player
- 0x03 = Computer
- 0x0A = Camera

Type Stream Input (ct=0x0B):

in: Index (0..3)
ct: Content type
- 0x00 = HDMI
- 0x01 = Visualizer
- 0x02 = Disc Player
- 0x03 = Computer
- 0x0A = Camera
- 0x0B = Stream Input
- 0x0D = Cynap

Type Browser Shortcut (ct=0x12):

in: Index (1..3)

The parameters Source block length, Source status, Content type, Source name length, Source name and Type specific source block are combined in a block called Source infos. In this specification, only the Source infos block for source 0 is listed but this block is actually repeated as many times as Number of sources specifies

SET

PIN Status

Userlevel: None

09 CB91 01 st

Status

0x00

Hide PIN

0x01

Show PIN

09 CB91 00

GET

USB Stick Support

Userlevel: Admin

08 CBAC 00

08 CBAC 01 st

0x00

Disabled

0x01

Enabled

SET

USB Stick Support

Userlevel: Admin

09 CBAC 01 st

0x00

Disable

0x01

Enable

09 CBAC 00

GET

Line Out Volume

Userlevel: User

08 CBAF 00

08 CBAF 01 vo

0x00..0x64

Volume in percent (0..100)

SET

Line Out Volume

Userlevel: Admin

09 CBAF 01 vo

0x00..0x64

Volume in percent (0..100)

09 CBAF 00

GET

HDMI Out 1 Volume

Userlevel: User

08 CBB0 00

08 CBB0 01 vo

0x00..0x64

Volume in percent (0..100)

SET

HDMI Out 1 Volume

Userlevel: Admin

09 CBB0 01 vo

0x00..0x64

Volume in percent (0..100)

09 CBB0 00

GET

HDMI Out 2 Volume

Userlevel: User

08 CBB1 00

08 CBB1 01 vo

0x00..0x64

Volume in percent (0..100)

SET

HDMI Out 2 Volume

Userlevel: Admin

09 CBB1 01 vo

0x00..0x64

Volume in percent (0..100)

09 CBB1 00

GET

HDMI Input Autostart

Userlevel: Admin

08 CBBC 01 in

Input

0x00

HDMI 1

0x01

HDMI 2

08 CBBC 02 in oo

Input

0x00

HDMI 1

0x01

HDMI 2

0x00

Off

0x01

SET

HDMI Input Autostart

Userlevel: Admin

09 CBBC 02 in oo

Input

0x00

HDMI 1

0x01

HDMI 2

0x00

Off

0x01

09 CBBC 00

GET

File Upload Status

Userlevel: Annotation

08 CBBE 00

08 CBBE 01 st

Status

0x00

Idle

0x01

Upload of current presentation active

0x02

Upload of current presentation and/or background upload active

GET

File Upload Overall Progress

Userlevel: Annotation

08 CBC0 00

08 CBC0 01 pr

Progress over all active uploads

0x00..0x64

In percent (0..100)

SET

Annotation PIN Status

Userlevel: User

09 CBCD 01 st

Status

0x00

Hide PIN

0x01

Show PIN

09 CBCD 00

GET

Annotation PIN Status

Userlevel: None

08 CBCE 00

08 CBCE 01 st

Status

0x00

Hide PIN

08 CBCE 00

08 CBCE 05 st p₀..p₃

Status

0x01

Show PIN

p₀..p₃

PIN as 4-digit string: e.g. 0245, 8934 or 1500

GET

RMS Password

Userlevel: Admin

08 CBCF 00

08 CBCF ab p₀..p_n

p₀..p_n^inf

Password

Max. 63 bytes

SET

RMS Password

Userlevel: Admin

09 CBCF ab p₀..p_n

p₀..p_n^inf

Password

Max. 63 bytes

09 CBCF 00

GET

RMS Password Mode

Userlevel: Admin

08 CBD0 00

08 CBD0 01 st

0x00

Disabled

0x01

Enabled

SET

RMS Password Mode

Userlevel: Admin

09 CBD0 01 st

0x00

Disable

0x01

Enable

09 CBD0 00

GET

Force HTTPS

Userlevel: Admin

08 CBDB 00

08 CBDB 01 st

Status

0x00

HTTP and HTTPS allowed

0x01

Only HTTPS allowed

SET

Force HTTPS

Userlevel: Admin

09 CBDB 01 mo

Mode

0x00

HTTP and HTTPS allowed

0x01

Only HTTPS allowed

09 CBDB 00

SET

Create New Certificate

Userlevel: Admin

09 CBDC 00

Create new certificate for HTTPS

09 CBDC 00

GET

Line In Local Output

Userlevel: Admin

08 CBDD 00

08 CBDD 01 st

0x00

Disabled

0x01

Enabled

Mix Line In content on local outputs (Line Out, HDMI 1 and HDMI 2)

SET

Line In Local Output

Userlevel: Admin

09 CBDD 01 st

0x00

Disable

0x01

Enable

Mix Line In content on local outputs (Line Out, HDMI 1 and HDMI 2)

09 CBDD 00

GET

Line In Remote Output

Userlevel: Admin

08 CBDE 00

08 CBDE 01 st

0x00

Disabled

0x01

Enabled

Mix Line In content on remote outputs (Recording and Streaming)

SET

Line In Remote Output

Userlevel: Admin

09 CBDE 01 st

0x00

Disable

0x01

Enable

Mix Line In content on remote outputs (Recording and Streaming)

09 CBDE 00

GET

USB Mic

Userlevel: Admin

08 CBDF 00

08 CBDF 01 st

0x00

Disabled

0x01

Enabled

08 CBDF 00

08 CBDF 04 ue ul uw ur

USB Mic

0x00

Disabled

0x01

Enabled

USB Mic local out

0x00

Disabled

0x01

Enabled

USB Mic webconf

0x00

Disabled

0x01

Enabled

USB Mic recording/streaming

0x00

Disabled

0x01

Enabled

SET

USB Mic

Userlevel: Admin

09 CBDF 01 st

0x00

Disable

0x01

Enable

09 CBDF 00

09 CBDF 04 ue ul uw ur

USB Mic

0x00

Disable

0x01

Enable

USB Mic local out

0x00

Disable

0x01

Enable

USB Mic webconf

0x00

Disable

0x01

Enable

USB Mic recording/streaming

0x00

Disable

0x01

Enable

09 CBDF 00

GET

USB Mic Webconference Only

Userlevel: Admin

deprecated

08 CBE0 00

Deprecated: see 0xCBDF

08 CBE0 01 st

0x00

Disabled

0x01

Enabled

If enabled, USB mic will only be mixed to webconference audio input, otherwise USB mic will be mixed like window content

SET

USB Mic Webconference Only

Userlevel: Admin

deprecated

09 CBE0 01 st

0x00

Disable

0x01

Enable

Deprecated: see 0xCBDF

09 CBE0 00

SET

Audio Test

Userlevel: Admin

09 CBE3 01 ac

Action

0x01

Start

09 CBE3 00

GET

BYOD PIN Display

Userlevel: User

08 CBE4 00

08 CBE4 05 di p₀..p₃

Display

0x00

Hide PIN

0x01

Show PIN

0x02

Popup PIN

p₀..p₃

PIN as 4-digit string: e.g. 0245, 8934 or 1500

GET

PIN Status HDMI 2

Userlevel: None

08 CBE7 00

08 CBE7 01 st

Status

0x00

Hide PIN

08 CBE7 00

08 CBE7 05 st p₀..p₃

Status

0x01

Show PIN

p₀..p₃

PIN as 4-digit string: e.g. 0245, 8934 or 1500

GET

Line In Level

Userlevel: Admin

08 CBE8 00

08 CBE8 01 lv

Level

0x00..0x64

Level in percent (0..100)

SET

Line In Level

Userlevel: Admin

09 CBE8 01 lv

Level

0x00..0x64

Level in percent (0..100)

09 CBE8 00

GET

Mixer Meter

Userlevel: Admin

08 CBE9 00

08 CBE9 ab ls rs lm rm

Left channel speaker meter

0x00..0x64

in percent (0..100)

Right channel speaker meter

0x00..0x64

in percent (0..100)

lm^inf

Left channel mic meter

0x00..0x64

in percent (0..100)

rm^inf

Right channel mic meter

0x00..0x64

in percent (0..100)

GET

Mic Status

Userlevel: None

08 CBEA 00

08 CBEA 01 st

Status

0x00

Disabled

0x01

Working

0x02

Quiet

GET

User Settings Status

Userlevel: User

deprecated

08 CBEB 01 so

Source

0x00

USB

0x01

Internal

0C CBEB ab cd j₀..j_n

j₀..j_n^inf

User settings status list

User settings status list as JSON string

Syntax:

cloud_services

dropbox

status

0: Not available
1: Available

jianguoyun

status

0: Not available
1: Available

webdav

status

0: Not available
1: Available

onedrive

status

0: Not available
1: Available

office365

office365

status

0: Not available
1: Available

browser

bookmarks

status

0: Not available
1: Available

deprecated

08 CBEB 01 so

Source

0x02

USB

0x03

Internal

0C CBEB ab cd so lj₀..lj₁ j₀..j_n

Source

0x02

USB

0x03

Internal

lj₀..lj₁

Length of user settings status list

j₀..j_n

User settings status list

User settings status list as JSON string

Syntax:

cloud_services

dropbox

status

0: Not available
1: Available

jianguoyun

status

0: Not available
1: Available

webdav

status

0: Not available
1: Available

onedrive

status

0: Not available
1: Available

office365

office365

status

0: Not available
1: Available

browser

bookmarks

status

0: Not available
1: Available

08 CBEB 01 so

Source

0x04

USB

0x05

Internal

0C CBEB ab cd j₀..j_n

j₀..j_n^inf

User settings status list

User settings status list as JSON string

Syntax:

cloud_services

dropbox

status

0: Not available
1: Available

jianguoyun

status

0: Not available
1: Available

webdav

status

0: Not available
1: Available

onedrive

status

0: Not available
1: Available

office365

credentials

status

0: Not available
1: Available

name

credentials

localAccount

status

0: Not available
1: Available

name

localAccount

browser

bookmarks

status

0: Not available
1: Available

panopto

status

0: Not available
1: Available

name

panopto

Important:

Example:

08 CBEB 01 so

Source

0x06

USB

0x07

Internal

0C CBEB ab cd so lj₀..lj₁ j₀..j_n

Source

0x06

USB

0x07

Internal

lj₀..lj₁

Length of user settings status list

j₀..j_n

User settings status list

User settings status list as JSON string

Syntax:

cloud_services

dropbox

status

0: Not available
1: Available

jianguoyun

status

0: Not available
1: Available

webdav

status

0: Not available
1: Available

onedrive

status

0: Not available
1: Available

office365

credentials

status

0: Not available
1: Available

name

credentials

localAccount

status

0: Not available
1: Available

name

localAccount

browser

bookmarks

status

0: Not available
1: Available

panopto

status

0: Not available
1: Available

name

panopto

Important:
"webdav" is a placeholder for the WebDAV name set in the device settings

Example:
{"cloud_services": [{"dropbox": {"status": 1}}, {"jianguoyun": {"status": 1}}, {"onedrive": {"status": 1}}], "office365":[{"credentials":{"status":0,"name":"credentials"}},{"localAccount":{"status":0,"name":"localAccount"}}], "browser": [{"bookmarks": {"status": 1}}], "lcs": [{"panopto": {"status": 1,"name":"panopto"}}]}

SET

Admin Logout

Userlevel: Admin

09 CBEE 00

GET

SSH Mode

Userlevel: Admin

08 CBF0 00

0C CBF0 ab cd oo le e₀..e_n

0x00

Off

0x01

Expiration Date length

e₀..e_n

Expiration Date

e.g. 2026-01-23T00:00:00Z

Date in iso8601 format

SET

SSH Mode

Userlevel: Admin

09 CBF0 01 oo

0x00

Off

0x01

09 CBF0 00

GET

USB Mic Volume

Userlevel: Admin

08 CBF1 00

08 CBF1 01 vo

0x00..0x64

Volume in percent (0..100)

SET

USB Mic Volume

Userlevel: Admin

09 CBF1 01 vo

0x00..0x64

Volume in percent (0..100)

09 CBF1 00

GET

HDMI Input 1 no audio

Userlevel: Admin

08 CC14 00

08 CC14 01 st

0x00

Disabled

0x01

Enabled

SET

HDMI Input 1 no audio

Userlevel: Admin

09 CC14 01 st

0x00

Disable

0x01

Enable

09 CC14 00

GET

Save Coredumps

Userlevel: Admin

08 CC15 00

08 CC15 01 oo

0x00

Off

0x01

SET

Save Coredumps

Userlevel: Admin

09 CC15 01 oo

0x00

Off

0x01

09 CC15 00

SET

Simple File Upload

Userlevel: Admin

0B01 CC16 ab cd ef gh b₀..b_n

b₀..b_n^inf

Binary file data

09 CC16 00

GET

Stream Input Setup

Userlevel: None

08 CC19 01 in

Index

0x00..0x13

Index (0..19)

0C CC19 ab cd in mo ln n₀..n_n lu u₀..u_n ty ll am

Index

0x00..0x13

Index (0..19)

Mode

0x00

None

0x01

Generic

0x02

RTSP/RTP over TCP

Stream input name length

Max. 255 bytes

n₀..n_n

Stream input name

Stream input URL length

Max. 255 bytes

u₀..u_n

Stream input URL

Type

0x00

Stream

0x01

Camera

0x02

Computer

0x03

Visualizer

0x04

HDMI

0x05

Disc Player

0x06

Cynap

Low Latency

0x00

Off

0x01

Audio mute

0x00

Off

0x01

08 CC19 00

0A01 CC19 ab cd ef gh lb₀..lb₁ in mo ln n₀..n_n lu u₀..u_n ty ll am st

lb₀..lb₁

Block length

Combined length of Index, Mode, Stream input name length, Stream input name, Stream input URL length, Stream input URL, Type, Low Latency, Audio mute and Stream not in use. Max. 65535 bytes

Index

0x00..0x13

Index (0..19)

Mode

0x00

None

0x01

Generic

0x01

RTSP/RTP over TCP

Stream input name length

Max. 255 bytes

n₀..n_n

Stream input name

Stream input URL length

Max. 255 bytes

u₀..u_n

Stream input URL

Type

0x00

Stream

0x01

Camera

0x02

Computer

0x03

Visualizer

0x04

HDMI

0x05

Disc Player

0x06

Cynap

Low Latency

0x00

Off

0x01

Audio mute

0x00

Off

0x01

Stream not in use

0x00

0x01

Yes

The parameters Block length, Index, Mode, Stream input name length, Stream input name, Stream input URL length, Stream input URL, Type, Low Latency, Audio mute and Stream not in use are combined in a block. In this specification, only the block for index 0 is listed but this block is actually repeated for each input stream index

SET

Stream Input Setup

Userlevel: Admin

0D CC19 ab cd in mo ln n₀..n_n lu u₀..u_n ty ll am

Index

0x00..0x13

Index (0..19)

Mode

0x00

None

0x01

Generic

0x02

RTSP/RTP over TCP

Stream input name length

Max. 255 bytes

n₀..n_n

Stream input name

Stream input URL length

Max. 255 bytes

u₀..u_n

Stream input URL

Type

0x00

Stream

0x01

Camera

0x02

Computer

0x03

Visualizer

0x04

HDMI

0x05

Disc Player

0x06

Cynap

Low Latency

0x00

Off

0x01

Audio mute

0x00

Off

0x01

09 CC19 00

GET

USB Camera List

Userlevel: User

08 CC1D 00

0C CC1D ab cd c₀..c_n

c₀..c_n^inf

Camera list

List syntax:
lc0: Camera name #0 length
c00..c0n: Camera name #0
..
lcn: Camera name #n length
cn0..cnn: Camera name #n

GET

USB Camera Input Setup

Userlevel: Admin

deprecated

08 CC1E 00

08 CC1E ab in mo wc ln n₀..n_n d₀..d_n as

Index

0x00..0x01

Index (0..1)

Mode

0x00

None

0x01

Camera

0x02

Visualizer

0x03

HDMI

0x04

Computer

0x05

Disc Player

Use for Webconferencing

0x00

Off

0x01

Name length

Max. 255 bytes

n₀..n_n

Name

d₀..d_n^inf

Device

Available values can be retrieved with USB Camera List (CC 1D)

Audio support

0x00

Disabled

0x01

Enabled

SET

USB Camera Input Setup

Userlevel: Admin

deprecated

0D CC1E ab cd in mo wc ln n₀..n_n ld d₀..d_n as

Index

0x00..0x01

Index (0..1)

Mode

0x00

None

0x01

Camera

0x02

Visualizer

0x03

HDMI

0x04

Computer

0x05

Disc Player

Use for Webconferenceing

0x00

Off

0x01

Name length

Max. 255 bytes

n₀..n_n

Name

Device length

Max. 255 bytes

d₀..d_n

Device

Available values can be retrieved with USB Camera List (CC 1D)

Audio support

0x00

Disable

0x01

Enable

09 CC1E 00

GET

App Recording

Userlevel: None

08 CC25 00

08 CC25 01 oo

0x00

Off

0x01

SET

App Recording

Userlevel: User

09 CC25 01 oo

0x00

Off

0x01

09 CC25 00

GET

File Download Status

Userlevel: Annotation

08 CC2E 00

08 CC2E 01 st

Status

0x00

Idle

0x01

Download of current presentation active

GET

Recording Streaming Extern Source List

Userlevel: Admin

08 CC31 00

0C CC31 ab cd ls₀..ls₁ s₀..s_n

ls₀..ls₁

Source List length

s₀..s_n

JSON encoded Source List

Format:
[{ 'name': 'Foo Bar', 'device': 'special_device', 'idx': 0, 'source': 3 }]

GET

System Language

Userlevel: None

08 CC43 00

08 CC43 01 la

Language

0x00

English

0x01

German

0x02

Japanese

0x03

Chinese

0x04

French

0x05

Norwegian

0x06

Russian

SET

System Language

Userlevel: Admin

09 CC43 01 la

Language

0x00

English

0x01

German

0x02

Japanese

0x03

Chinese

0x04

French

0x05

Norwegian

0x06

Russian

09 CC43 00

GET

Proxy URL

Userlevel: Admin

08 CC5E 00

08 CC5E ab u₀..u_n

u₀..u_n^inf

URL

Max. 255 bytes

SET

Proxy URL

Userlevel: Admin

09 CC5E ab u0..0n

u0..0n^inf

URL

Max. 255 bytes

09 CC5E 00

GET

Browser Home URL

Userlevel: Admin

08 CC5F 00

08 CC5F ab u₀..u_n

u₀..u_n^inf

URL

Browser Home URL

SET

Browser Home URL

Userlevel: Admin

09 CC5F ab u₀..u_n

u₀..u_n^inf

URL

Browser Home URL, max. length 255

09 CC5F 00

GET

Proxy Authentication Mode

Userlevel: Admin

08 CC60 00

08 CC60 01 oo

0x00

Off

0x01

SET

Proxy Authentication Mode

Userlevel: Admin

09 CC60 01 oo

0x00

Off

0x01

09 CC60 00

GET

Proxy Username

Userlevel: Admin

08 CC61 00

08 CC61 ab u₀..u_n

u₀..u_n^inf

Username

Max. 255 bytes

SET

Proxy Username

Userlevel: Admin

09 CC61 ab u0..0n

u0..0n^inf

Username

Max. 255 bytes

09 CC61 00

GET

Proxy Password

Userlevel: Admin

08 CC62 00

08 CC62 ab p₀..p_n

p₀..p_n^inf

Password

Max. 255 bytes

SET

Proxy Password

Userlevel: Admin

09 CC62 ab p₀..p_n

p₀..p_n^inf

Password

Max. 255 bytes

09 CC62 00

SET

Proxy Activate

Userlevel: Admin

09 CC63 01 ac

Action

0x00

Activate

09 CC63 00

GET

Proxy Function

Userlevel: Admin

08 CC64 00

08 CC64 01 st

0x00

Disabled

0x01

Enabled

SET

Proxy Function

Userlevel: Admin

09 CC64 01 st

0x00

Disable

0x01

Enable

09 CC64 00

GET

Proxy Port

Userlevel: Admin

08 CC65 00

08 CC65 02 p₁..p₂

p₁..p₂

Port

0x0000..0xFFFF

Port (0..65535)

SET

Proxy Port

Userlevel: Admin

09 CC65 02 p₀..p₁

p₀..p₁

Port

0x0000..0xFFFF

Port (0..65535)

09 CC65 00

GET

Browser Bookmarks

Userlevel: User

08 CC66 00

0A01 CC66 ab cd ef gh j₀..j_n

j₀..j_n^inf

JSON

JSON encoded Bookmarks List, for example {"bookmarks": [{"URL": "orf.at", "NAME": "orf newssite"},{"URL": "gmail.com", "NAME": "mail provider"}]}

SET

Browser Bookmarks

Userlevel: User

0B01 CC66 ab cd ef gh j₀..j_n

j₀..j_n^inf

JSON

JSON encoded Bookmarks List, for example {"bookmarks": [{"URL": "orf.at", "NAME": "orf newssite"},{"URL": "gmail.com", "NAME": "mail provider"}]}

09 CC66 00

GET

Download Link List

Userlevel: User

08 CC67 00

08 CC67 ab j₀..j_n

j₀..j_n^inf

Download Link List

Download link list as JSON string

Syntax:

type
- 0: vCast Windows
source
- 0: Local
- 1: Remote
url

Example:
[{"type": 0, "source": 0, "url":"https://10.0.1.1/download/vSolutionCast.exe"}, {"type": 1, "source": 1,"url":"https://play.google.com/store/apps/details?id=com.wolfvision.vCast.Droid"}]

GET

URL Interface

Userlevel: Admin

08 CC68 00

08 CC68 01 in

Interface

0x00

LAN

0x01

WLAN

0x02

LAN2

SET

URL Interface

Userlevel: Admin

09 CC68 01 in

Interface

0x00

LAN

0x01

WLAN

0x02

LAN2

09 CC68 00

GET

Screensaver Settings

Userlevel: User

08 CC72 00

0A01 CC72 ab cd ef gh sb hd scr ds₀..ds₁ dh₀..dh₁ lu₀..lu₁ u₀..u_n as kf da₀..da₁ im

Standby

0x00

Disabled

0x01

Enabled

HDMI Off

0x00

Disabled

0x01

Enabled

scr

Screensaver

0x00

Disabled

0x01

Enabled

ds₀..ds₁

Standby Delay

Delay in minutes or seconds (bit 0x8000 is set) after which device is sent to Standby

dh₀..dh₁

HDMI Off Delay

Delay in minutes or seconds (bit 0x8000 is set) after which HDMI outputs are turned off

lu₀..lu₁

Screensaver URL length

u₀..u_n

Screensaver URL

Autostart

0x00

Disabled

0x01

Enabled

Keep files

0x00

Disabled

0x01

Enabled

da₀..da₁

Delay in minutes or seconds (bit 0x8000 is set) after which screensaver is started automatically

Interactive mode

0x00

Disabled

0x01

Enabled

SET

Screensaver Settings

Userlevel: Admin

0B01 CC72 ab cd ef gh sb hd scr ds₀..ds₁ dh₀..dh₁ lu₀..lu₁ u₀..u_n as kf da₀..da₁ im

Standby

0x00

Disable

0x01

Enable

HDMI Off

0x00

Disable

0x01

Enable

scr

Screensaver

0x00

Disable

0x01

Enable

ds₀..ds₁

Standby Delay

Delay in minutes or seconds (bit 0x8000 is set) after which device is sent to Standby

dh₀..dh₁

HDMI Off Delay

Delay in minutes or seconds (bit 0x8000 is set) after which HDMI outputs are turned off

lu₀..lu₁

Screensaver URL length

u₀..u_n

Screensaver URL

Autostart

0x00

Disable

0x01

Enable

Keep files

0x00

Disable

0x01

Enable

da₀..da₁

Autostart Delay

Delay in minutes or seconds (bit 0x8000 is set) after which screensaver is started automatically

Interactive mode

0x00

Disabled

0x01

Enabled

09 CC72 00

GET

Screensaver State

Userlevel: Viewer

08 CC76 00

08 CC76 01 st

State

0x00

Off

0x01

Standby active

0x02

Screen Off active

0x03

Screensaver active

GET

Remote Admin PIN

Userlevel: None

08 CC95 00

08 CC95 01 st

Status

0x00

PIN not required

0x01

PIN required

SET

Remote Admin PIN

Userlevel: Admin

09 CC95 01 st

Status

0x00

PIN not required

0x01

PIN required

09 CC95 00

SET

vSolution Cast/App PIN Display

Userlevel: None

09 CC9A 01 di

Display

0x01

Show PIN

0x02

Popup PIN

09 CC9A 00

SET

Disk Encryption Mode

Userlevel: Admin

09 CC9E 01 mo

Mode

0x00

Always on

09 CC9E 00

GET

Disk Encryption Status

Userlevel: Admin

08 CC9F 00

08 CC9F 01 st

Status

0x00

Failed

0x01

InProgress

0x02

Encrypted

0x03

Decrypted

GET

Firmware Signature Check

Userlevel: Admin

08 CCA2 00

08 CCA2 01 st

0x00

Disabled

0x01

Enabled

SET

Firmware Signature Check

Userlevel: Admin

09 CCA2 01 st

0x00

Disable

0x01

Enable

09 CCA2 00

GET

LDAP Auth Mode

Userlevel: None

08 CCA7 00

08 CCA7 01 oo

0x00

Off

0x01

SET

LDAP Auth Mode

Userlevel: Admin

09 CCA7 01 oo

0x00

Off

0x01

09 CCA7 00

GET

LDAP Server URL

Userlevel: Admin

08 CCA8 00

08 CCA8 ab u₀..u_n

u₀..u_n^inf

URL

Max. 255 bytes

SET

LDAP Server URL

Userlevel: Admin

09 CCA8 ab u₀..u_n

u₀..u_n^inf

URL

Max. 255 bytes

09 CCA8 00

GET

LDAP Server Domain

Userlevel: Admin

08 CCA9 00

08 CCA9 ab d₀..d_n

d₀..d_n^inf

Domain

Max. 255 bytes

SET

LDAP Server Domain

Userlevel: Admin

09 CCA9 ab d₀..d_n

d₀..d_n^inf

Domain

Max. 255 bytes

09 CCA9 00

GET

LDAP TLS Mode

Userlevel: Admin

08 CCAA 00

08 CCAA 01 oo

0x00

Off

0x01

SET

LDAP TLS Mode

Userlevel: Admin

09 CCAA 01 oo

0x00

Off

0x01

09 CCAA 00

SET

LDAP Login

Userlevel: None

09 CCAB ab lu u₀..u_n lp p₀..p_n

Length Username

u₀..u_n

Username

Length Password

p₀..p_n

Password

09 CCAB 00

GET

LDAP Status

Userlevel: None

08 CCAC 00

08 CCAC 01 st

Status

0x00

Not Authenticated

0x01

Authenticated

GET

Webbrowser Viewer Support

Userlevel: None

08 CCAD 00

08 CCAD 01 st

0x00

Disabled

0x01

Enabled

SET

Webbrowser Viewer Support

Userlevel: Admin

09 CCAD 01 st

0x00

Disable

0x01

Enable

09 CCAD 00

SET

LDAP Certificate File

Userlevel: Admin

0B01 CCAF ab cd ef gh ac lf f₀..f_n b₀..b_n

Action

0x00

Delete

0x01

Save

0x02

Verify

Filename length

f₀..f_n

Filename

b₀..b_n^inf

Binary file data

09 CCAF 00

GET

LDAP Certificate Name

Userlevel: Admin

08 CCB0 00

08 CCB0 ab n₀..n_n

n₀..n_n^inf

Name

Max. 255 bytes

SET

LDAP Certificate Name

Userlevel: Admin

09 CCB0 ab n₀..n_n

n₀..n_n^inf

Name

Max. 255 bytes

09 CCB0 00

GET

Window Settings

Userlevel: Admin

08 CCB3 00

08 CCB3 01 af

Auto fullscreen

x00

Off

0x01

0x02

Mixed

SET

Window Settings

Userlevel: Admin

09 CCB3 01 af

Auto fullscreen

0x00

Off

0x01

0x02

Mixed

09 CCB3 00

GET

USB Speaker

Userlevel: Admin

08 CCB6 00

08 CCB6 01 st

0x00

Disabled

0x01

Enabled

08 CCB6 00

08 CCB6 02 ue uw

USB speaker

0x00

Disabled

0x01

Enabled

USB speaker webconf split: webconf output via USB speaker only if enabled

0x00

Disabled

0x01

Enabled

SET

USB Speaker

Userlevel: Admin

09 CCB6 01 st

0x00

Disable

0x01

Enable

09 CCB6 00

09 CCB6 02 ue uw

USB Speaker

0x00

Disable

0x01

Enable

USB speaker webconf split: webconf output via USB speaker only if enabled

0x00

Disable

0x01

Enable

09 CCB6 00

GET

USB Speaker Card Name

Userlevel: Admin

08 CCB7 00

08 CCB7 ab c₀..c_n

c₀..c_n^inf

Card name

URL encoded

SET

USB Speaker Card Name

Userlevel: Admin

09 CCB7 ab c₀..c_n

c₀..c_n^inf

Card name

URL encoded

09 CCB7 00

GET

USB Speaker Card List

Userlevel: Admin

08 CCB8 00

0C CCB8 ab cd c₀..c_n

c₀..c_n^inf

Card names list (URL encoded)

List syntax:
lc0: Card name #0 length
c00..c0n: Card name #0
..
lcn: Card name #n length
cn0..cnn: Card name #n

GET

USB Speaker Volume

Userlevel: Admin

08 CCB9 00

08 CCB9 01 vo

0x00..0x64

Volume in percent (0..100)

SET

USB Speaker Volume

Userlevel: Admin

09 CCB9 01 vo

0x00..0x64

Volume in percent (0..100)

09 CCB9 00

GET

Presentation ID

Userlevel: User

08 CCBA 00

08 CCBA 04 pi

Presentation ID

0x00000000 .. 0xFFFFFFFF

GET

Keyboard Layout

Userlevel: None

08 CCC5 00

08 CCC5 01 la

Layout

0x00

0x01

0x03

0x05

0x07

0x08

0x09

ch_de

0x0A

ch_fr

0x0B

0x0C

ca_fr

SET

Keyboard Layout

Userlevel: Admin

09 CCC5 01 la

Layout

0x00

0x01

0x03

0x05

0x07

0x08

0x09

ch_de

0x0A

ch_fr

0x0B

0x0C

ca_fr

09 CCC5 00

GET

Power Down Mode

Userlevel: None

08 CCC7 00

08 CCC7 01 mo

Mode

0x00

Suspend

0x01

Shutdown

0x02

Power saving

SET

Power Down Mode

Userlevel: Admin

09 CCC7 01 mo

Mode

0x00

Suspend

0x01

Shutdown

0x02

Power saving

09 CCC7 00

GET

Debug Loglevel

Userlevel: Admin

08 CCE9 01 di

Daemon ID

0x00

Opencast

0x01

Webcast

0x02

Airplay

0x05

P2P

0x06

WPA Supplicant

0x07

Miracast

0x08

Miracast Mice

0x09

vSolution Meeting

0x0A

Matrix Master

0x0B

Matrix Groupwork

0x0C

Zoom

0x0D

Panopto

0x0E

Network Drive

0x0F

Audio

0x10

Storage

0x11

Framegrabber

0x12

Wolfprot

0x13

Chrome

0x14

Uof

08 CCE9 02 di ll

Daemon ID

0x00

Opencast

0x01

Webcast

0x02

Airplay

0x05

P2P

0x06

WPA Supplicant

0x07

Miracast

0x08

Miracast Mice

0x09

vSolution Meeting

0x0A

Matrix Master

0x0B

Matrix Groupwork

0x0C

Zoom

0x0D

Panopto

0x0E

Network Drive

0x0F

Audio

0x10

Storage

0x11

Framegrabber

0x12

Wolfprot

0x13

Chrome

0x14

Uof

Log Level

0x00

Emerge

0x01

Alert

0x02

Critical

0x03

Error

0x04

Warning

0x05

Notice

0x06

Info

0x07

Debug

SET

Debug Loglevel

Userlevel: Admin

09 CCE9 02 di ll

Daemon ID

0x00

Opencast

0x01

Webcast

0x02

Airplay

0x05

P2P

0x06

WPA Supplicant

0x07

Miracast

0x08

Miracast Mice

0x09

vSolution Meeting

0x0A

Matrix Master

0x0B

Matrix Groupwork

0x0C

Zoom

0x0D

Panopto

0x0E

Network Drive

0x0F

Audio

0x10

Storage

0x11

Framegrabber

0x12

Wolfprot

0x13

Chrome

0x14

Uof

Log Level

0x00

Emerge

0x01

Alert

0x02

Critical

0x03

Error

0x04

Warning

0x05

Notice

0x06

Info

0x07

Debug

09 CCE9 00

GET

Splash Screen Trigger Status

Userlevel: User

08 CCED 00

08 CCED 01 st

Status

0x00

Inactive

0x01

Active

SET

Splash Screen Trigger

Userlevel: User

09 CCEE 01 ac

Action

0x00

Trigger

09 CCEE 00

GET

Splash Screen Trigger Mode

Userlevel: User

08 CCEF 00

08 CCEF 01 oo

0x00

Off

0x01

SET

Splash Screen Trigger Mode

Userlevel: User

09 CCEF 01 oo

0x00

Off

0x01

09 CCEF 00

SET

System Reboot

Userlevel: Admin

09 CCF5 01 ac

Action

0x00

Reboot after 10s

0x01

Reboot immediately

09 CCF5 00

GET

Update on the fly

Userlevel: Admin

08 CCFC 00

08 CCFC 01 oo

0x00

Off

0x01

SET

Update On The Fly

Userlevel: Admin

09 CCFC 01 oo

0x00

Off

0x01

09 CCFC 00

SET

Screensaver Off

Userlevel: User

09 CD00 01 ac

Action

0x00

Off

09 CD00 00

GET

System Backup

Userlevel: Admin

08 CD01 01 ac

Action

0x00

Backup settings

0A01 CD01 ab cd ef gh ac b₀..b_n

Action

0x00

Backup settings

b₀..b_n^inf

Binary file data

GET

System Restore Status

Userlevel: None

08 CD02 00

08 CD02 01 st

Status

0x00

None

0x01

Pending

0x02

Success

0x03

Failed

SET

TLS 1.0 Support

Userlevel: Admin

09 CD13 01 st

0x00

Disable

0x01

Enable

09 CD13 00

GET

HDMI Input Max Resolution

Userlevel: Admin

08 CD16 01 in

Input

0x00

HDMI 1

0x01

HDMI 2

08 CD16 02 in rs

Input

0x00

HDMI 1

0x01

HDMI 2

Max. Resolution

0x00

2160p

0x01

1080p

SET

HDMI Input Max Resolution

Userlevel: Admin

09 CD16 02 in rs

Input

0x00

HDMI 1

0x01

HDMI 2

Max. Resolution

0x00

2160p

0x01

1080p

09 CD16 00

GET

Standby possible

Userlevel: User

08 CD17 00

08 CD17 01 ny

0x00

0x01

Yes

GET

Webbrowser Viewer Pin Support

Userlevel: None

08 CD19 00

08 CD19 01 st

0x00

Disabled

0x01

Enabled

SET

Webbrowser Viewer Pin Support

Userlevel: Admin

09 CD19 01 st

0x00

Disable

0x01

Enable

09 CD19 00

GET

Eddystone Discovery

Userlevel: Admin

08 CD1A 00

08 CD1A 01 oo

0x00

Off

0x01

SET

Eddystone Discovery

Userlevel: Admin

09 CD1A 01 oo

0x00

Off

0x01

09 CD1A 00

GET

Eddystone Interface

Userlevel: Admin

08 CD1B 00

08 CD1B 01 in

Interface

0x00

LAN1

0x01

LAN2

0x02

WLAN

SET

Eddystone Interface

Userlevel: Admin

09 CD1B 01 in

Interface

0x00

LAN1

0x01

LAN2

0x02

WLAN

09 CD1B 00

GET

Help Page Support

Userlevel: Admin

08 CD1C 00

08 CD1C 01 st

0x00

Disabled

0x01

Enabled

SET

Help Page Support

Userlevel: Admin

09 CD1C 01 st

0x00

Disable

0x01

Enable

09 CD1C 00

SET

Help Page

Userlevel: User

09 CD1D 01 ac

Action

0x00

Check

0x01

Open

09 CD1D 00

GET

Help Page Status

Userlevel: User

08 CD1E 00

08 CD1E ab st ul u₀..u_n

Status

0x00

Unavailable

0x01

Available

URL length

u₀..u_n

URL

e.g. https://wolfvision.com/wolf/cynap_pro_help_de

SET

Webbrowser Popup Viewer Pin

Userlevel: None

09 CD1F 00

GET

UVC Camera List 2

Userlevel: User

deprecated

08 CD23 00

0C CD23 ab cd c₀..c_n

c₀..c_n^inf

Camera list

List syntax:
lc0: Camera name #0 length
c00..c0n: Camera name #0
as0: Camera #0 autostart support
..
lcn: Camera name #n length
cn0..cnn: Camera name #n
asn: Camera #n autostart support

SET

USB Camera Input Setup 2

Userlevel: Admin

deprecated

0D CD24 ab cd in mo wc ln n₀..n_n ld d₀..d_n as au

Index

0x00..0x01

Index (0..1)

Mode

0x00

None

0x01

Camera

0x02

Visualizer

0x03

HDMI

0x04

Computer

0x05

Disc Player

Use for Webconferencing

0x00

Off

0x01

Name length

Max. 255 bytes

n₀..n_n

Name

Device length

Max. 255 bytes

d₀..d_n

Device

Available values can be retrieved with USB Camera List (CD 23)

Audio support

0x00

Disable

0x01

Enable

Autostart

0x00

None

0x01

Disable

0x02

Enable

09 CD24 00

GET

HDMI Input WebRTC

Userlevel: Admin

08 CD2A 01 in

Input

0x00

HDMI 1

0x01

HDMI 2

08 CD2A 02 in oo

Input

0x00

HDMI 1

0x01

HDMI 2

0x00

Off

0x01

SET

HDMI Input WebRTC

Userlevel: Admin

09 CD2A 02 in oo

Input

0x00

HDMI 1

0x01

HDMI 2

0x00

Off

0x01

09 CD2A 00

GET

Reverse Shell

Userlevel: User

08 CD2B 00

08 CD2B 06 po..p1 st wr dp md

po..p1

Port

0x0401..0xFFFF

Port (1025..65535)

Status

0x00

Stopped

0x01

Started

0x02

Failed

Webpage Redirect

0x00

Disabled

0x01

Enabled

Debug Port

0x00

Disabled

0x01

Enabled

Mode

0x00

Disabled

0x01

Enabled

SET

Reverse Shell

Userlevel: Admin

09 CD2B 05 st p₀..p₁ wr dp

0x00

Disable

0x01

Enable

p₀..p₁

Port

0x0401..0xFFFF = Port (1025..65535)

Webpage Redirect (Reverse Shell Prot + 1)

0x00

Disable

0x01

Enable

Debug Port (Reverse Shell Prot + 2)

0x00

Disable

0x01

Enable

09 CD2B 00

GET

Remote Admin PIN Only While Presenting

Userlevel: None

08 CD2F 00

08 CD2F 01 oo

0x00

Off

0x01

SET

Remote Admin PIN Only While Presenting

Userlevel: Admin

09 CD2F 01 oo

0x00

Off

0x01

09 CD2F 00

GET

Presentation Status

Userlevel: None

08 CD30 00

08 CD30 01 st

Status

0x00

Inactive

0x01

Active

GET

WVSolution MDNS Discovery

Userlevel: Admin

08 CD32 00

08 CD32 01 oo

0x00

Off

0x01

SET

WVSolution MDNS Discovery

Userlevel: Admin

09 CD32 01 oo

0x00

Off

0x01

09 CD32 00

GET

Mainboard Serial Number

Userlevel: Admin

08 CD39 00

08 CD39 ab m₀..m_n

m₀..m_n^inf

Mainboard Serial Number

Max. 127 bytes

SET

Userlevel: None

0D CD40 ab cd s₀..s_n

s₀..s_n^inf

Subscribed commands

List of commands, max. length 1024 bytes.
Supported commands:

0x08CCC700

Power Down Mode

0x08CD2D00

Admin Message

0x08CD3000

Presentation Status

0x08CB0C00

Power

0x08CC7600

Screensaver State

0x08CB6800

Visualizer Status

0x08CB2E00

FW Update Status

0x08CB7A00

Web Update

0x08CD6701[so]

RAUC Update Status

0x08CD7300

Simple Windows Basic

0x08CB5200

PIN Destination

0x08CB5400

PIN Status RMS

0x08CB3800

Presentation Mode

0x08CB3B00

Mirroring

0x08CB5A00

Main Freeze

0x08CB5800

Master Mute

0x08CB5900

Mic Mute

0x08CB5600

Master Volume

0x08CB2500

Video Recording

0x08CBE400

BYOD Pin Display

09 CD40 00

SET

Webconference Screenshare Start

Userlevel: User

09 CD44 01 ac

Action

0x00

Done

0x01

Cancel

09 CD44 00

GET

Connection ID Enable

Userlevel: User

08 CD47 00

08 CD47 01 oo

0x00

Off

0x01

SET

Connection ID Enable

Userlevel: Admin

09 CD47 01 oo

0x00

Off

0x01

09 CD47 00

GET

Connection ID Interface

Userlevel: Admin

08 CD48 00

08 CD48 01 in

Interface

0x00

LAN1

0x01

LAN2

0x02

WLAN

SET

Connection ID Interface

Userlevel: Admin

09 CD48 01 in

Interface

0x00

LAN1

0x01

WLAN

0x02

LAN2

09 CD48 00

GET

UVC Camera List 3

Userlevel: User

08 CD50 00

0A01 CD50 ab cd ef gh c₀..c_n

c₀..c_n^inf

Camera list

List syntax:
lc0: Camera name #0 length
c00..c0n: Camera name #0
as0: Camera #0 autostart support
..
lcn: Camera name #n length
cn0..cnn: Camera name #n
asn: Camera #n autostart support
lvm: Video modes length
vm0..vmn: JSON encoded list of video modes. Format: [{ 'type': 'video/x-h264', 'format': '', 'width': 1920, 'height': 1080, framerate: { 'num': 30, 'den': 1 } }]

GET

USB Camera Input Setup 3

Userlevel: Admin

08 CD51 01 in

Index

0x00..0x01

Index (0..1)

08 CD51 ab in mo wc ln n₀..n_n d₀..d_n as au lvm vm₀..vm_n

Index

0x00..0x01

Index (0..1)

Mode

0x00

None

0x01

Camera

0x02

Visualizer

0x03

HDMI

0x04

Computer

0x05

Disc Player

Use for Webconferencing

0x00

Off

0x01

Name length

Max. 255 bytes

n₀..n_n

Name

d₀..d_n^inf

Device

Available values can be retrieved with USB Camera List (CD 23)

Audio support

0x00

Disabled

0x01

Enabled

Autostart

0x00

None

0x01

Disabled

0x02

Enabled

lvm

Video mode length

Max. 255 bytes

vm₀..vm_n

Video mode

JSON in format: { 'type': 'video/x-h264', 'format': '', 'width': 1920, 'height': 1080, 'framerate': { 'num': 30, 'den': 1 } }

SET

USB Camera Input Setup 3

Userlevel: Admin

0D CD51 ab cd in mo wc ln n₀..n_n ld d₀..d_n as au lvm vm₀..vm_n

Index

0x00..0x01

Index (0..1)

Mode

0x00

None

0x01

Camera

0x02

Visualizer

0x03

HDMI

0x04

Computer

0x05

Disc Player

Use for Webconferencing

0x00

Off

0x01

Name length

Max. 255 bytes

n₀..n_n

Name

Device length

Max. 255 bytes

d₀..d_n

Device

Available values can be retrieved with USB Camera List (CD 23)

Audio support

0x00

Disable

0x01

Enable

Autostart

0x00

None

0x01

Disable

0x02

Enable

lvm

Video mode length

Max. 255 bytes

vm₀..vm_n

Video mode

JSON in format: { 'type': 'video/x-h264', 'format': '', 'width': 1920, 'height': 1080, 'framerate': { 'num': 30, 'den': 1 } }

09 CD51 00

GET

Browser Shortcuts Config

Userlevel: Admin

08 CD52 00

0C CD52 ab cd li₀..li_n

li₀..li_n^inf

JSON List

List of configured shortcuts. Format: [ { 'name': 'My Shortcut', 'url': 'https://www.google.at' } ]

SET

Browser Shortcuts Config

Userlevel: Admin

0D CD52 ab cd li₀..li_n

li₀..li_n^inf

JSON List

List of configured shortcuts. Format: [ { 'name': 'My Shortcut', 'url': 'https://www.google.at' } ]

09 CD52 00

SET

Browser Shortcut Open

Userlevel: User

09 CD53 01 idx

idx

Index of shortcut

09 CD53 00

GET

Download UI Start

Userlevel: Admin

08 CD59 00

08 CD59 04 fs₀..fs₃

fs₀..fs₃

Filesize in bytes

GET

Download UI Read Chunk

Userlevel: Admin

08 CD5A 04 b₀..b₃

b₀..b₃

Buffer size in bytes

0A01 CD5A ab cd ef gh l₀..l₃ d₀..d_n

l₀..l₃

Data length

d₀..d_n

File data

GET

Download UI Stop

Userlevel: Admin

08 CD5B 00

GET

Local Screensaver State

Userlevel: User

08 CD5C 00

08 CD5C ab cd ef st ls s₀..s_n

State

0x00

Not available

0x01

Available

Screensaver name length

s₀..s_n

Screensaver name

SET

Local Screensaver

Userlevel: Admin

0B01 CD5C ab cd ef gh ac ls s₀..s_n lb₀..lb₃ b₀..b_n

Action

0x00

Delete

0x01

Save

Screensaver name length

s₀..s_n

Screensaver name

lb₀..lb₃

Binary data length

b₀..b_n

Binary data

Archive in zip format

09 CD5C 00

GET

System Analyze

Userlevel: Admin

08 CD65 00

08 CD65 01 oo

0x00

Off

0x01

SET

System Analyze

Userlevel: Admin

09 CD65 01 oo

0x00

Off

0x01

09 CD65 00

GET

Screensaver HDMI off no content

Userlevel: Admin

08 CD6F 00

08 CD6F 01 ny

0x00

0x01

Yes

SET

Screensaver HDMI off no content

Userlevel: Admin

09 CD6F 01 ny

0x00

0x01

Yes

09 CD6F 00

SET

Camera Back Session

Userlevel: App

0D CD70 ab cd ac ls₀..ls₁ s₀..s_n

Action

0x00

Stop

0x01

Start

ls₀..ls₁

SDP-File Content length

Max. 65532 bytes

s₀..s_n

SDP File Content

09 CD70 08 S0..S7

S0..S7

Session ID

GET

Camera Back Function

Userlevel: None

08 CD71 00

08 CD71 01 oo

0x00

Off

0x01

SET

Camera Back Function

Userlevel: Admin

09 CD71 01 oo

0x00

Off

0x01

09 CD71 00

GET

Camera Back Session Active

Userlevel: None

08 CD72 00

08 CD72 01 ny

0x00

0x01

Yes

SET

Zero Config Video Test

Userlevel: Admin

09 CD74 ab

^inf

09 CD74 00

GET

Zero Config Active

Userlevel: Admin

08 CD75 00

0C CD75 ab cd ny ld₀..ld₁ d₀..d_n

0x00

0x01

Yes

ld₀..ld₁

Default Devices length

Max. 65532 bytes

d₀..d_n

Default Devices

Default Devices as JSON string

Syntax:

video: used USB video device

mic: used USB Mic

speaker: used USB Speaker

Example:
{"video": "foo video", "mic": "foo mic", "speaker": "foo speaker"}

GET

Camera Back Enable Recording

Userlevel: Admin

08 CD76 00

08 CD76 01 st

0x00

Disabled

0x01

Enabled

SET

Camera Back Enable Recording

Userlevel: Admin

09 CD76 01 st

0x00

Disable

0x01

Enable

09 CD76 00

SET

Audio Settings Activate

Userlevel: Admin

09 CD81 01 ac

Action

0x00

Activate

09 CD81 00

GET

Change Background when presenting

Userlevel: Admin

08 CD87 00

08 CD87 01 st

0x00

Disabled

0x01

Enabled

SET

Change Background while Presenting

Userlevel: Admin

09 CD87 01 oo

0x00

Off

0x01

09 CD87 00

vMeeting (32)

GET

vMeeting Cleanup Time

Userlevel: Admin

08 CCC8 00

08 CCC8 01 ct

Cleanup time in days

Max. 5 days

SET

vMeeting Cleanup Time

Userlevel: Admin

09 CCC8 01 ct

Cleanup time in days

Max. 5 days

09 CCC8 00

GET

vMeeting Session Data

Userlevel: None

08 CCC9 00

0A01 CCC9 ab cd ef gh j₀..j_n

j₀..j_n^inf

Censored metadata JSON object for all events

All events within next 24h as JSON array. If an event is private, subject and body will be censored.

Syntax:

organizer: Meeting organizer information
- email
- name
private
- true
- false
id: Session ID
body: Meeting description
subject: Meeting title
attendees: Array of meeting attendees
- email
- name
- required_attendee
  - true
  - false
end: End time as Unix timestamp
start: Start time as Unix timestamp
pin: PIN to start session, censored
state
- 0x00 = scheduled
- 0x01 = active
- 0x02 = ended
- 0x03 = ad-hoc
attachments: Array of file attachments
- id
- name
- content_type
- size
- last_modify
- dl_status
- progress

Example:
[{"organizer": {"email": "[email protected]", "name": "Exchange Developer 01"}, "private": false, "id": "eb3ec9367d2b35e0cd8a3fd3e4d852a657c2f451e61c2af947c2ff0eb64b2dd6", "body": "PGh0bWw+DQo8aGVhZD4NCjxtZXRhIGh0dHAtZXF1aXY9IkNvbnRlbnQtVHlwZSIgY29udGVudD0idGV4dC9odG1sOyBjaGFyc2V0PXV0Zi04Ij4NCjxzd", "state":0, "pin":0, "subject": "test meeting abend", "attendees": [{"email": "[email protected]", "name": "Exchange Developer 01", "required_attendee": true}, {"email": "[email protected]", "name": "Ressource03", "required_attendee": true}], "end": 1547128800, "start": 1547123400, "attachments": [{"id": "AAMkAGM3OTRhYTZiLWMxNGUtNDY3ZS04YWZjLWAAENAAAco9e57jmBQauBE/RGIsRjAAAk5eI7AAABEgAQAN6d8EoaQdNLkblBGURmDa8=", "name": "image.png", "content_type": "image/png", "size": 4079085, "last_modify": 1547463444, "dl_status": 0, "progress": 0}]}]

08 CCC9 ab li i₀..i_n lp p₀..p_n

Length of ID

i₀..i_n

ID of event to request metadata for

Length of PIN

p₀..p_n

PIN for requested ID

0A01 CCC9 ab cd ef gh j₀..j_n

j₀..j_n^inf

Uncensored metadata JSON object for requested ID

Meeting details for requested event as JSON object. Always contains the uncensored PIN, subject and body of the meeting. To request details for an ad hoc meeting, use ID = "Ad-Hoc-Meeting" with PIN = 0.

SET

vMeeting Resend Session PIN

Userlevel: User

09 CCCA ab ls s₀..s_n

Session ID length

s₀..s_n

Session ID

09 CCCA 00

GET

vMeeting Start Session

Userlevel: None

08 CCCB 00

08 CCCB ab i₀..i_n

i₀..i_n^inf

Session ID

Active Session ID

SET

vMeeting Start Session

Userlevel: User

09 CCCB ab lp p₀..p_n li i₀..i_n

Session PIN length

p₀..p_n

Session PIN

li^inf

Session ID length

i₀..i_n

Session ID

09 CCCB 00

09 CCCB 02 d₁..d₂

d₁..d₂

Duration in minutes

Max. 65535 minutes

Adhoc Meeting

09 CCCB 00

GET

vMeeting Unbooked Duration

Userlevel: None

08 CCCC 00

08 CCCC 02 d₀..d₁

d₀..d₁

Duration in minutes

Duration of next free block, starting from either now or end of actual meeting, if any.

GET

vMeeting Mode

Userlevel: None

08 CCCD 00

08 CCCD 01 md

Mode

0x02

Microsoft 365

0x03

Microsoft 365 Basic

0x04

Google Calendar

0x05

Google Calendar Basic

SET

vMeeting Mode

Userlevel: Admin

09 CCCD 01 md

Mode

0x02

Microsoft 365

0x03

Microsoft 365 Basic

0x04

Google Calendar

0x05

Google Calendar Basic

09 CCCD 00

GET

vMeeting Exchange Auth Mode

Userlevel: Admin

deprecated

08 CCCE 00

08 CCCE 01 mo

Mode

0x00

Basic

0x01

NTLM

0x02

OAuth2

SET

vMeeting Exchange Auth Mode

Userlevel: Admin

deprecated

09 CCCE 01 mo

Mode

0x00

Basic

0x01

NTLM

0x02

OAuth2

09 CCCE 00

GET

vMeeting Exchange URL

Userlevel: Admin

deprecated

08 CCCF 00

08 CCCF ab u₀..u_n

u₀..u_n^inf

URL

Max. 255 bytes

SET

vMeeting Exchange URL

Userlevel: Admin

deprecated

09 CCCF ab u₀..u_n

u₀..u_n^inf

URL

Max. 255 bytes

09 CCCF 00

GET

vMeeting OAuth Tenant ID

Userlevel: Admin

08 CCD0 00

08 CCD0 ab t₀..t_n

t₀..t_n^inf

OAuth2 Tenant ID

Max. 255 bytes

SET

vMeeting OAuth Tenant ID

Userlevel: Admin

09 CCD0 ab t₀..t_n

t₀..t_n^inf

OAuth2 Tenant ID

Max. 255 bytes

09 CCD0 00

GET

vMeeting OAuth Secret

Userlevel: Admin

08 CCD1 00

08 CCD1 ab s₀..s_n

s₀..s_n^inf

OAuth2 Secret

Max. 255 bytes

SET

vMeeting OAuth Secret

Userlevel: Admin

09 CCD1 ab s₀..s_n

s₀..s_n^inf

OAuth2 Secret

Max. 255 bytes

09 CCD1 00

GET

vMeeting Exchange Domain

Userlevel: Admin

deprecated

08 CCD2 00

08 CCD2 ab d₀..d_n

d₀..d_n^inf

Domain

Max. 255 bytes

SET

vMeeting Exchange Domain

Userlevel: Admin

deprecated

09 CCD2 ab d₀..d_n

d₀..d_n^inf

Domain

Max. 255 bytes

09 CCD2 00

GET

vMeeting Resource

Userlevel: Admin

08 CCD3 00

08 CCD3 ab r₀..r_n

r₀..r_n^inf

Resource

Max. 255 bytes

SET

vMeeting Resource

Userlevel: Admin

09 CCD3 ab r₀..r_n

r₀..r_n^inf

Resource

Max. 255 bytes

09 CCD3 00

GET

vMeeting Connection Status

Userlevel: None

08 CCD4 00

08 CCD4 01 st

Status

0x00

Disconnected

0x01

Unknown

0x02

Failure

0x03

Success

0x04

Connecting

SET

vMeeting Extend Session

Userlevel: User

09 CCD5 02 d₀..d₁

d₀..d₁

Duration in minutes

Max. 65535 minutes

09 CCD5 00

GET

vMeeting OAuth App ID

Userlevel: Admin

08 CCD6 00

08 CCD6 ab o₀..o_n

o₀..o_n^inf

OAuth2 App ID

Max. 255 bytes

SET

vMeeting OAuth App ID

Userlevel: Admin

09 CCD6 ab o₀..o_n

o₀..o_n^inf

OAuth2 App ID

Max. 255 bytes

09 CCD6 00

GET

vMeeting Function

Userlevel: None

08 CCD7 00

08 CCD7 01 oo

0x00

Off

0x01

SET

vMeeting Function

Userlevel: Admin

09 CCD7 01 oo

0x00

Off

0x01

09 CCD7 00

GET

vMeeting Time Left

Userlevel: User

08 CCD8 00

08 CCD8 01 st

Status of event

0x00

0x01

Warning

0x02

Critical

SET

vMeeting Time Left

Userlevel: User

09 CCD8 01 ac

Action

0x00

Enable OSD

0x01

Disable OSD

09 CCD8 00

SET

vMeeting OAuth

Userlevel: Admin

09 CD31 01 ac

Action

0x00

Logout

0x01

09 CD31 00

GET

vMeeting PIN

Userlevel: None

08 CD38 00

08 CD38 01 st

0x00

Disabled

0x01

Enabled

SET

vMeeting PIN

Userlevel: Admin

09 CD38 01 st

0x00

Disable

0x01

Enable

09 CD38 00

Webcasting (18)

GET

Webcast Mode

Userlevel: User

08 CC08 00

08 CC08 01 mo

Mode

0x00

Off

0x01

Custom

0x04

YouTube

0x05

Custom 2nd Stream

SET

Webcast Mode

Userlevel: Admin

09 CC08 01 mo

Mode

0x00

Off

0x01

Custom

0x04

YouTube

09 CC08 00

GET

Webcast Custom URL

Userlevel: Admin

deprecated

08 CC09 00

0C CC09 ab cd u₀..u_n

u₀..u_n^inf

URL

Max. 255 bytes

SET

Webcast Custom URL

Userlevel: Admin

deprecated

0D CC09 ab cd u₀..u_n

u₀..u_n^inf

URL

Max. 255 bytes

09 CC09 00

GET

Webcast Custom URL2

Userlevel: Admin

08 CC0A 00

0C CC0A ab cd lm₀..lm₁ m₀..m_n lh₀..lh₁ h₀..h_n lh₀..h₁ h₀..h_n

lm₀..lm₁

Main URL length

m₀..m_n

Main URL

Max. 1024 bytes

lh₀..lh₁

Extern URL length

h₀..h_n

Extern URL

Max. 1024 bytes

lh₀..h₁

HDMI Out 2 URL length

h₀..h_n

HDMI Out 2 URL

Max. 1024 bytes

SET

Webcast Custom URL2

Userlevel: Admin

0D CC0A ab cd lm₀..lm₁ m₀..m_n le₀..le₁ e₀..e_n et lh₀..lh₁ h₀..h_n

lm₀..lm₁

Main URL length

m₀..m_n

Main URL

Max. 1024 bytes

le₀..le₁

Extern URL length

e₀..e_n

Extern URL

Max. 1024 bytes

Extern Type

0x00

HDMI In2

lh₀..lh₁

HDMI Out 2 URL length

h₀..h_n

HDMI Out 2 URL

Max. 1024 bytes

09 CC0A 00

0D CC0A ab cd lm₀..lm₁ m₀..m_n le₀..le₁ e₀..e_n lh₀..lh₁ h₀..h_n

lm₀..lm₁

Main URL length

m₀..m_n

Main URL

Max. 1024 bytes

le₀..le₁

Extern URL length

e₀..e_n

Extern URL

Max. 1024 bytes

lh₀..lh₁

HDMI Out 2 URL length

h₀..h_n

HDMI Out 2 URL

Max. 1024 bytes

09 CC0A 00

GET

Webcast YouTube Public Name

Userlevel: Admin

08 CC13 00

08 CC13 ab n₀..n_n

n₀..n_n^inf

Name

Max. 255 bytes

GET

Webcast Extern Source

Userlevel: Admin

08 CC32 00

08 CC32 02 es ei

Extern Source Type

0x00

None

0x01

Stream Input

0x02

HDMI In

0x03

USB Video Input

Extern Source Index

SET

Webcast Extern Source

Userlevel: Admin

09 CC32 02 es ei

Extern Source Type

0x00

None

0x01

Stream Input

0x02

HDMI In

0x03

USB Video Input

Extern Source Index

09 CC32 00

GET

Webcast State

Userlevel: User

08 CC57 00

08 CC57 01 st

State

0x00

Disabled

0x01

Ready

0x02

Active

0x03

Error

08 CC57 01 ei

Extended Information

0x01

Extended Information

08 CC57 04 ms ie oe hs

Stream State Main

0x00

Disabled

0x01

Ready

0x02

Active

0x03

Error

Stream State Extern Input

0x00

Disabled

0x01

Ready

0x02

Active

0x03

Error

Stream State Extern Output

0x00

Disabled

0x01

Ready

0x02

Active

0x03

Error

Stream State HDMI 2

0x00

Disabled

0x01

Ready

0x02

Active

0x03

Error

GET

Webcast YouTube Login State

Userlevel: User

08 CC58 00

08 CC58 01 st

State

0x00

Disconnected

0x01

Authenticating

0x02

Authenticated

0x03

Token expired

0x04

Failed

GET

Webcast YouTube Stream State

Userlevel: User

08 CC59 ab

^inf

08 CC59 03 s1 s2 s3

State HDMI1

0x00

Idle

0x01

Ready

0x02

Test starting

0x03

Live starting

0x04

Live

0x05

Complete

0x06

Error

State HDMI2

0x00

Idle

0x01

Ready

0x02

Test starting

0x03

Live starting

0x04

Live

0x05

Complete

0x06

Error

State Extern

0x00

Idle

0x01

Ready

0x02

Test starting

0x03

Live starting

0x04

Live

0x05

Complete

0x06

Error

SET

Webcast YouTube Connect

Userlevel: Admin

09 CC5B 00

GET

Webcast Streaming State

Userlevel: User

08 CC5C 00

08 CC5C 01 st

State

0x00

Stopped

0x01

Started

SET

Webcast Streaming Mode

Userlevel: User

09 CC5C 01 ac

Action

0x00

Stop webcasting

0x01

Start webcasting

09 CC5C 00

SET

Webcast YouTube Logout

Userlevel: Admin

09 CC5D 00

GET

Webcast YouTube Parameters

Userlevel: Admin

08 CCAE 00

0C CCAE ab cd pr lt t₀..t_n

Privacy

0x00

Private

0x01

Public

0x02

Unlisted

Title length

Max. 255 bytes

t₀..t_n

Title

SET

Webcast YouTube Parameters

Userlevel: Admin

0D CCAE ab cd pr lt t₀..t_n

Privacy

0x00

Private

0x01

Public

0x02

Unlisted

Title length

Max. 255 bytes

t₀..t_n

Title

09 CCAE 00

WLAN (9)

GET

WLAN Mode

Userlevel: None

08 CB0D 00

08 CB0D 01 mo

Mode

0x00

Off

0x01

Infrastructure

0x02

Access Point

SET

WLAN Mode

Userlevel: Admin

09 CB0D 01 mo

Mode

0x00

Off

0x01

Infrastructure

0x02

Access Point

09 CB0D 00

SET

WLAN Activate

Userlevel: Admin

09 CB16 01 ac

Action

0x00

Activate

09 CB16 00

GET

WLAN MAC

Userlevel: None

08 CB17 00

08 CB17 11 m₀..m₁₆

m₀..m₁₆

MAC address

MAC address as string: e.g. 00:0C:92:BC:61:2B

GET

WLAN Region

Userlevel: Admin

08 CB5D 00

08 CB5D 01 re

Region

0x00

0x01

Others

SET

WLAN Region

Userlevel: Admin

09 CB5D 01 re

Region

0x00

0x01

Others

09 CB5D 00

GET

WLAN Status

Userlevel: Annotation

08 CB6C 00

08 CB6C 07 st qu sl rca rcs

Status

0x00

Disconnected/Not Running

0x01

Connected/Running

0x02

Scanning

0x03

Authenticating

0x04

Failed

Quality

0x00..0x64

Quality in percent (0..100)

Signal level

0x00..0xFF

Signal level in dBm (-35 - -85)

rca

Retry counter access point loss

0x0000..0xFFFF

Counter

rcs

Retry counter signal level

0x0000..0xFFFF

Counter

GET

Wifi Direct Channel Select

Userlevel: Admin

08 CCDE 00

08 CCDE 01 ch

Channel

0x00

Auto

0x01

Channel 1

0x02

Channel 6

0x03

Channel 11

SET

Wifi Direct Channel Select

Userlevel: Admin

09 CCDE 01 ch

Channel

0x00

Auto

0x01

Channel 1

0x02

Channel 6

0x03

Channel 11

09 CCDE 00

Zoom (5)

GET

Zoom Webconference Settings

Userlevel: None

08 CD49 00

0C CD49 05 ms ct va la jl

Master switch

0x00

Disabled

0x01

Enabled

Content streaming, recording

0x00

Disabled

0x01

Enabled

vApp

0x00

Disabled

0x01

Enabled

Local account

0x00

Disabled

0x01

Enabled

Join link

0x00

Disabled

0x01

Enabled

SET

Zoom Webconference Settings

Userlevel: Admin

09 CD49 05 ms ct va la jl

Master switch

0x00

Disable

0x01

Enable

Content streaming, recording

0x00

Disable

0x01

Enable

vApp

0x00

Disable

0x01

Enable

Local account

0x00

Disable

0x01

Enable

Join link

0x00

Disable

0x01

Enable

09 CD49 00

SET

Zoom Local Account Login

Userlevel: Admin

09 CD4A 01 ac

Action

0x00

Logout

0x01

09 CD4A 00

GET

Zoom Local Account Info

Userlevel: User

08 CD54 00

0C CD54 ab cd lf f₀..f_n le e₀..e_n lm₀..lm₁ m₀..m_n lp p₀..p_n

Full Name length

f₀..f_n

Full Name

Email length

e₀..e_n

lm₀..lm₁

Meeting URL length

m₀..m_n

Meeting URL

Personal ID length

p₀..p_n

Personal ID

GET

Zoom Local Account Status

Userlevel: User

08 CD55 00

08 CD55 01 st

Status

0x00

Undefined

0x02

Logged out

0x03

Connected

0x04

Disconnected

Firmware Version: 1.76a

Firmware Type: Cynap

Firmware Version:
1.76a

Firmware Type:
Cynap