Server - Proctor

Communications between Server and Proctor are done with json via a websocket connection.

Message Format

All messages follow a consistent envelope structure:

Message Types

proctor.register

Used to register as a proctor viewing. This must be sent as the first message upon connecting. If the initial message is a different one, the connection will be aborted. If this message is sent in a registered connection it will just be ignored.

Direction: Proctor -> Server

Payload:

Empty payload.

Example:

{
  "type": "proctor.register",
  "timestamp": 1696969420,
  "payload": {}
}

proctor.set-pin

Used to set a PIN for filtering sentinels. The server will only send updates for sentinels that registered with this PIN. Setting a new PIN replaces the previous PIN filter.

Direction: Proctor -> Server

Payload:

Example:

{
  "type": "proctor.set-pin",
  "timestamp": 1696969420,
  "payload": {
    "pin": 2024
  }
}

server.registration.ack

This message will be sent from the server to acknowledge a registration of a proctor.

Direction: Server -> Proctor

Payload:

Example:

{
  "type": "server.registration.ack",
  "timestamp": 1696969420,
  "payload": {
    "proctorId": "e0a1e92b-7aae-4885-b5f7-7f7a89fce101"
  }
}

server.registration.reject

This message will be sent from the server to reject the registration of a proctor. If the proctor receives this message, it should close the connection.

Direction: Server -> Proctor

Payload:

Example:

{
  "type": "server.registration.reject",
  "timestamp": 1696969420,
  "payload": {
    "reason": "Server busy"
  }
}

server.update-sentinels

Sends a list of sentinels available for the proctor’s currently set PIN. Only sentinels that registered with this PIN are included. All sentinels not in this list are either dead or registered with a different PIN.

Direction: Server -> Proctor

Payload:

Each object in sentinels:

Example:

{
  "type": "server.update-sentinels",
  "timestamp": 1696969420,
  "payload": {
    "sentinels": [
      { "sentinelId": "0c0a4509-cd12-4118-81ae-d13b5b9e7274", "name": "Max Mustermann" },
      { "sentinelId": "df402174-1c26-426b-947f-b5360254d00c", "name": "Mix Mistermann" },
      { "sentinelId": "b255e355-e398-43d7-b772-101bbf4ca8f0", "name": "Mux Mastermann" }
    ]
  }
}

proctor.subscribe

Subscribe to a sentinel for which the proctor would like to receive frames. Multiple sentinels can be subscribed to at the same time.

Direction: Proctor -> Server

Payload:

Example:

{
  "type": "proctor.subscribe",
  "timestamp": 1696969420,
  "payload": {
    "sentinelId": "b255e355-e398-43d7-b772-101bbf4ca8f0"
  }
}

proctor.set-profile

Request a resolution profile for a specific sentinel. The server decides the actual resolution that will be used. The proctor only deals in profiles; the sentinel only receives a concrete maxSidePx value from the server.

Direction: Proctor -> Server

Payload:

Example:

{
  "type": "proctor.set-profile",
  "timestamp": 1696969420,
  "payload": {
    "sentinelId": "b255e355-e398-43d7-b772-101bbf4ca8f0",
    "profile": "MEDIUM"
  }
}

proctor.revoke-subscription

Revoke a subscription to a sentinel.

Direction: Proctor -> Server

Payload:

Example:

{
  "type": "proctor.revoke-subscription",
  "timestamp": 1696969420,
  "payload": {
    "sentinelId": "b255e355-e398-43d7-b772-101bbf4ca8f0"
  }
}

server.frame

The Server sends all Frames to the proctor that are new from the subscribed list.

Direction: Server -> Proctor

Payload:

Example:

{
  "type": "server.frame",
  "timestamp": 1696969420,
  "payload": {
    "frames": [
      {
        "sentinelId": "b255e355-e398-43d7-b772-101bbf4ca8f0",
        "frameId": "4799566e-ecdf-40e0-99c2-7bdc63a4038c",
        "index": 5,
        "data": "/9j/4AAQSkZ....Lj/1bP/F1v0A//9k="
      },
      {
        "sentinelId": "b784823d-805b-4129-b61d-12ca7da6d726",
        "frameId": "d7994246-35a6-4e2d-aae7-14bf9022f927",
        "index": 23,
        "data": "/9j/4AAQSkZJ....ejBknVXUhEj/9k="
      }
    ],
    "profile": "MEDIUM"
  }
}