Introduction

Example connection that subscribes to the tracking/state topic:

const WebSocket = require('ws');

const connection = new WebSocket('ws://127.0.0.1:49152');

connection.on('open', () => {
  connection.send(JSON.stringify({
    op: 'subscribe',
    topic: '/api/v1/tracking/state'
  }));
});

connection.on('message', (data) => {
  const message = JSON.parse(data);
  const isTracking = message.msg.is_tracking;
  console.log(`The system is ${isTracking ? '' : 'not '}tracking`);
});

import asyncio
import websockets
import json


async def subscribe_to_tracking():
    uri = "ws://127.0.0.1:49152"
    async with websockets.connect(uri) as websocket:
        await websocket.send(json.dumps({
            "op": "subscribe",
            "topic": "/api/v1/tracking/state"
        }))
        while True:
            message = json.loads(await websocket.recv())
            is_tracking = message['msg']['is_tracking']
            print(f'The system is {"" if is_tracking else "not "}tracking')


asyncio.get_event_loop().run_until_complete(subscribe_to_tracking())

Welcome to the documentation of the Seervision Production API. This documentation gives an overview of the communication mechanism between the client and the Seervision Suite (server).

Communication between the client and the server is performed through websockets. The server accepts requests on port 49152.

If you are running multiple Seervision Suite instances on a single server, the associated port number is increased by one for the next instance i.e. 49153, 49154, etc.

The transport mechanism

Example message:

{
  "op": "Example"
}

A message sent through the websocket is, in the base case, a JSON object with a string field called "op".

The op field indicates the type of message that this is. Messages with different values for op may be handled differently.

Optionally, a message can also provide an arbitrary string ID.

Example message with an ID:

{
  "op": "Example",
  "id": "example_id"
}

If an ID is provided with a message to the server, then related response messages will typically contain that ID as well. Log messages caused by this operation will also contain the ID.

Semantically, the ID is not an identifier of the specific message that it is in, but instead is an identifier for an interaction which may consist of a number of operations in back-and-forth messages. Thus, the ID may be used by multiple messages referring to the same transaction.

Authentication

Authentication mechanism is not provided for now, but might be added in the future.

Communication protocol

There are two concepts that allow the client communicate with the server, get updates and request changes.

Services and service calls

Example service call:

{
  "op": "call_service",
  "id": "take_control",
  "service": "/api/v1/ptu_driver/take_control"
}

Example of a successful service response:

{
  "op": "service_response",
  "id": "take_control",
  "service": "/api/v1/ptu_driver/take_control",
  "result": true
  "values": {
    "success": true
  }
}

Example of a failed service response:

{
  "op": "service_response",
  "id": "take_control",
  "service": "/api/v1/ptu_driver/take_control",
  "result": false,
  "values": "Service does not exist"
}

A service provides a request/reply interface, which the client can utilize to request a one-time information or a simple "one-shot" action. To initiate the request, the client needs to send a message with a "call_service" op field. The server will then respond with a message containing a "service_response" op field, and additional information, specific to the service.

call_service fields are:

service_response fields are:

Topics and topic subscriptions

Example "subscribe" message:

{
  "op": "subscribe",
  "topic": "/api/v1/tracking/state"
}

Example "unsubscribe" message:

{
  "op": "unsubscribe",
  "topic": "/api/v1/tracking/state"
}

Example topic message:

{
  "op": "publish",
  "topic": "/api/v1/tracking/state",
  "msg": {
    "data": false
  }
}

A topic allows the client to subscribe to a stream of data from the server. This is especially useful when the client wants, for example, to get notified about the system status, e.g. tracking status. All messages in the topic are guaranteed to have the same format which you can find in the documents below.

The client can send a message with op equals to "subscribe" to subscribe to a specific topic and a message with op equal to "unsubscribe" to cancel the subscription. After subscription is initiated, the server will start sending messages of a type specific for this particular topic with "publish" in the op field.

subscribe and unsubscribe fields are:

publish fields are:

Versioning

API version is defined by the v<major_version>.<minor_version> string, where both major_version and minor_version are numbers. All topics and services are versioned, and have a /api/v<major_version>/ prefix.

It is guaranteed that:

1. The transport mechanism and communication protocols will not be changed in minor version updates.
2. The general structure of messages described above will not change in minor version updates.
3. The messages defined for every topic and every service will not have fields removed in minor version updates. Some fields may, however, be added.

Current version

The current version of the API is v1.8.

Changelog

Client libraries

If you would like to implement your own client application, here're a few links to get you started:

• NodeJS: ws.
• C++: boost.beast.
• Java: javax.websocket.
• Python: websockets.

Container groups

In the UI of the Seervision Suite Containers can be collected into groups for easier management when there are many containers in the interface. This API provides the means to query these groups.

Service: get container groups

Request message:

This service will return the list of container groups in the order they appear in the UI.

Request to get container groups:

{
  "op": "call_service",
  "service": "/api/v1/container_groups/get_all"
}

This service call doesn't expect any arguments.

Response message:

Response to the "get container groups" request:

{
  "op": "service_response",
  "service": "/api/v1/container_groups/get_all",
  "result": true,
  "values": {
    "container_groups": [{
      "group_id": "6f0c84",
      "group_name": "Group 1",
      "color": "flamingo",
      "container_ids": ["52ac65", "c6fd11"]
    }, {
      "group_id": "7c0849",
      "group_name": "Group 2",
      "color": "roquefort",
      "container_ids": []
    }, {
      "group_id": "",
      "group_name": "",
      "color": "",
      "container_ids": ["995d22"]
    }]
  }
}

The values returned will have the following fields:

Topic: get container groups

Message to initiate the subscription:

{
  "op": "subscribe",
  "topic": "/api/v1/container_groups/updates"
}

Message to cancel the subscription:

{
  "op": "unsubscribe",
  "topic": "/api/v1/container_groups/updates"
}

The /api/v1/container_groups/updates topic can be used to subscribe to the changes to the container groups. It will publish a new message whenever a container group is added or deleted, or when the order of containers in one of the groups is updated. Upon subscription, the client will receive one immediate message with the current container groups.

Example topic publication:

{
  "op": "publish",
  "topic": "/api/v1/container_groups/updates",
  "msg": {
    "container_groups": [{
      "group_id": "6f0c84",
      "group_name": "Group 1",
      "color": "flamingo",
      "container_ids": ["52ac65", "c6fd11"]
    }, {
      "group_id": "7c0849",
      "group_name": "Group 2",
      "color": "roquefort",
      "container_ids": []
    }, {
      "group_id": "",
      "group_name": "",
      "color": "",
      "container_ids": ["995d22"]
    }]
  }
}

The fields of the messages in this topic are:

Containers

The system is controllable through user defined containers. Each container consists of versatile components, that define the behavior of the container once it is recalled. Among other things, containers allow the user to request the camera move to a specific "pre-set" (pan/tilt/zoom/focus) position, as well as define and recall "pre-sets" of framing shots. This effectively makes containers a replacement for Presets and Shot presets.

This section defines services for creating, deleting, and recalling containers, as well as a topic publishing updates to the containers. Refer to the Seervision user manual for more details about containers and their configurations.

Service: create a container

Request message:

This service will create a container using the current system state as specified by the provided configuration type.

Request to create a Position container:

{
  "op": "call_service",
  "service": "/api/v1/containers/create",
  "args": {
    "name": "New container",
    "configuration_type": "position"
  }
}

Request to create a Shot container:

{
  "op": "call_service",
  "service": "/api/v1/containers/create",
  "args": {
    "name": "",
    "configuration_type": "shot"
  }
}

Request to create an Empty container:

{
  "op": "call_service",
  "service": "/api/v1/containers/create",
  "args": {
    "name": "",
    "configuration_type": "empty"
  }
}

The args field passed with the request must have the following fields:

Response message:

Response to the "create a container" request:

{
  "op": "service_response",
  "service": "/api/v1/containers/create",
  "result": true,
  "values": {
    "new_container": {
      "id": "6f0c84",
      "name": "Container 1"
    }
  }
}

The values returned will have the following fields:

Service: delete a container

This service will delete a container of the given ID. It will not throw if the container with the given ID is missing.

Request message:

Request to delete a container:

{
  "op": "call_service",
  "service": "/api/v1/containers/delete",
  "args": {
    "container_id": "6f0c84"
  }
}

The args passed with this call should have the following structure:

Response message:

Response to the "delete a container" request:

{
  "op": "service_response",
  "service": "/api/v1/containers/delete",
  "result": true,
  "values": {}
}

The server will return an empty message in response.

Service: get all containers

This service will return all saved containers.

Request message:

Request to get all containers:

{
  "op": "call_service",
  "service": "/api/v1/containers/get_all"
}

This service call doesn't expect any arguments.

Response message:

Response to the "get all containers" request:

{
  "op": "service_response",
  "service": "/api/v1/containers/get_all",
  "result": true,
  "values": {
    "containers": [{
      "id": "f0c846",
      "name": "Container 1"
    }, {
      "id": "a87c21",
      "name": "Main stage"
     }]
  }
}

The values returned will have the following fields:

Service: recall a container

This service sends a request to the SV-Suite to recall specific container using its name or ID.

Request message:

Request to recall a container:

{
  "op": "call_service",
  "service": "/api/v1/containers/recall",
  "args": {
    "container": "My container"
  }
}

The service expects the following args structure:

Response message:

Response to the "recall a container" request when container doesn't exist

{
  "op": "service_response",
  "service": "/api/v1/containers/recall",
  "result": false,
  "values": "Container with id \"756064\" does not exist"
}

Response to the successful "recall a container" request:

{
  "op": "service_response",
  "service": "/api/v1/containers/recall",
  "result": true,
  "values": {}
}

The server will return an error message if container does not exist, and an empty message otherwise.

Topic: get containers

Message to initiate the subscription:

{
  "op": "subscribe",
  "topic": "/api/v1/containers/updates"
}

Message to cancel the subscription:

{
  "op": "unsubscribe",
  "topic": "/api/v1/containers/updates"
}

The /api/v1/containers/updates topic can be used to subscribe to changes to the containers. It will publish a new message whenever a container is added, deleted, or updated. Upon subscription, the client will receive one immediate message with the current containers.

Example topic publication:

{
  "op": "publish",
  "topic": "/api/v1/containers/updates",
  "msg": {
    "containers": [{
      "id": "f0c846",
      "name": "Container 1"
    }, {
      "id": "a87c21",
      "name": "Main stage"
    }]
  }
}

The fields of the messages in this topic are:

Topic: get container status

Message to initiate the subscription:

{
  "op": "subscribe",
  "topic": "/api/v1/containers/status"
}

Message to cancel the subscription:

{
  "op": "unsubscribe",
  "topic": "/api/v1/containers/status"
}

The /api/v1/containers/status topic can be used to subscribe to notifications about the recall status of containers. Since only one container at a time can be recalled, the message sent through this topic contains information only about the last recalled container.

Example topic publication:

{
  "op": "publish",
  "topic": "/api/v1/containers/status",
  "msg": {
    "container_id": "f0c846",
    "status": "running"
  }
}

The fields of the messages in this topic are:

The system guarantees that every running status update is always followed by an abandoned, completed or interrupted status update for the same container.

Endpoints

This section describes the services that allow the user to check availability of other services and topics, provided by the API.

Service: is service available

Request message:

This service accepts service string in a request, and returns true if the service exists, and false otherwise.

Request to check service availability

{
  "op": "call_service",
  "service": "/api/v1/endpoints/is_service_available",
  "args": {
    "service": "/api/v1/tracking/start"
  }
}

The args field passed with the request must have the following fields:

Response message:

Response to the "check service availability" request if service exists:

{
  "op": "service_response",
  "service": "/api/v1/endpoints/is_service_available",
  "result": true,
  "values": {
    "is_available": true
  }
}

Response to the "check service availability" request if service does not exist:

{
  "op": "service_response",
  "service": "/api/v1/endpoints/is_service_available",
  "result": true,
  "values": {
    "is_available": false
  }
}

The values returned will have the following fields:

Service: is topic available

Request message:

This service accepts topic string in a request, and returns true if the topic exists, and false otherwise.

Request to check topic availability

{
  "op": "call_service",
  "service": "/api/v1/endpoints/is_topic_available",
  "args": {
    "topic": "/api/v1/tracking/state"
  }
}

The args field passed with the request must have the following fields:

Response message:

Response to the "check topic availability" request if topic exists:

{
  "op": "service_response",
  "service": "/api/v1/endpoints/is_topic_available",
  "result": true,
  "values": {
    "is_available": true
  }
}

Response to the "check topic availability" request if topic does not exist:

{
  "op": "service_response",
  "service": "/api/v1/endpoints/is_topic_available",
  "result": true,
  "values": {
    "is_available": false
  }
}

The values returned will have the following fields:

Events

The Events API can be used by the consumers to tie specific events when the Seervision Suite detects a specific event. The events currently available through the Production API are tied to the Trigger Zones, but there are more to come in the future versions of the API.

Topic: get events fired by trigger zones

Message to initiate the subscription:

{
  "op": "subscribe",
  "topic": "/api/v1/events/trigger_zones"
}

Message to cancel the subscription:

{
  "op": "unsubscribe",
  "topic": "/api/v1/events/trigger_zones"
}

The /api/v1/events/trigger_zones can be used to get updates from the Seervision Suite when a specific event is fired by a trigger zone. As soon as a trigger zone detects an event, a message will be sent down this topic with event information.

When using the API, keep in mind that: * The events only get sent for enabled trigger zones. * The events get triggered with a delay specified in the zone through the UI. * If an event is superseded by event triggered by another trigger zone with a higher priority, it will not be fired.

Example topic publication:

{
  "op": "publish",
  "topic": "/api/v1/events/trigger_zones",
  "msg": {
    "type": "person_entered",
    "zone_id": "756064a6f0c84610b2e63fea54a87c21"
  }
}

The msg object will have the TriggerZoneEvent type.

Presets

Presets allow the user to request the camera move to a specific "pre-set" (pan/tilt/zoom/focus) position.

This section defines services for creating, deleting, and recalling presets, as well as a topic publishing updates to the presets.

Service: create a preset

Request message:

This service will create a preset at the current camera position of a specified type and transition type.

Request to create a preset:

{
  "op": "call_service",
  "service": "/api/v1/presets/create",
  "args": {
    "name": "New preset",
    "type": "static",
    "transition_type": {
      "type": "speed",
      "speed": 4
    }
  }
}

The args field passed with the request must have the following fields:

Response message:

Response to the "create a preset" request:

{
  "op": "service_response",
  "service": "/api/v1/presets/create",
  "result": true,
  "values": {
    "new_preset": {
      "id": "756064a6f0c84610b2e63fea54a87c21",
      "name": "New preset",
      "type": "static",
      "transitionType": {
        "type": "speed",
        "speed": 4,
        "time": 0
      }
    }
  }
}

The values returned will have the following fields:

Service: delete a preset

This service will delete a preset of the given ID. It will not throw if the preset with the given ID is missing.

Request message:

Request to delete a preset:

{
  "op": "call_service",
  "service": "/api/v1/presets/delete",
  "args": {
    "preset_id": "756064a6f0c84610b2e63fea54a87c21"
  }
}

The args passed with this call should have the following structure:

Response message:

Response to the "delete a preset" request:

{
  "op": "service_response",
  "service": "/api/v1/presets/delete",
  "result": true,
  "values": {}
}

The server will return an empty message in response.

Service: get all presets

This service will return all saved presets.

Request message:

Request to get all presets:

{
  "op": "call_service",
  "service": "/api/v1/presets/get_all"
}

This service call doesn't expect any arguments.

Response message:

Response to the "get all presets" request:

{
  "op": "service_response",
  "service": "/api/v1/presets/get_all",
  "result": true,
  "values": {
    "presets": [{
      "id": "756064a6f0c84610b2e63fea54a87c21",
      "name": "New preset",
      "type": "static",
      "transitionType": {
        "type": "speed",
        "speed": 4,
        "time": 0
      }
    }, {
      "id": "756064a6f0c84610b2e63fea54a87c21",
      "name": "Main stage",
      "type": "static",
       "transitionType": {
         "type": "time",
         "speed": 0,
         "time": 5
       }
     }]
  }
}

The values returned will have the following fields:

Service: recall a preset

This service sends a request to the SV-Suite to recall specific preset by its ID.

Request message:

Request to recall a preset:

{
  "op": "call_service",
  "service": "/api/v1/presets/recall",
  "args": {
    "preset_id": "756064a6f0c84610b2e63fea54a87c21"
  }
}

The service expects the following args structure:

Response message:

Response to the "recall a preset" request when preset doesn't exist

{
  "op": "service_response",
  "service": "/api/v1/presets/recall",
  "result": false,
  "values": "Preset not found"
}

Response to the successful "recall a preset" request:

{
  "op": "service_response",
  "service": "/api/v1/presets/recall",
  "result": true,
  "values": {}
}

The server will return an error message if preset does not exist, and an empty message otherwise.

Topic: get presets

Message to initiate the subscription:

{
  "op": "subscribe",
  "topic": "/api/v1/presets/updates"
}

Message to cancel the subscription:

{
  "op": "unsubscribe",
  "topic": "/api/v1/presets/updates"
}

The /api/v1/presets/updates topic can be used to subscribe to changes to the presets. It will publish a new message whenever a preset is added, deleted, or renamed. Upon subscription, the client will receive one immediate message with the current presets.

Example topic publication:

{
  "op": "publish",
  "topic": "/api/v1/presets/updates",
  "msg": {
    "presets": [{
      "id": "756064a6f0c84610b2e63fea54a87c21",
      "name": "New preset",
      "type": "static",
      "transitionType": {
        "type": "speed",
        "speed": 4,
        "time": 0
      }
    }, {
      "id": "756064a6f0c84610b2e63fea54a87c21",
      "name": "Main stage",
      "type": "static",
       "transitionType": {
         "type": "time",
         "speed": 0,
         "time": 5
       }
     }]
  }
}

The fields of the messages in this topic are:

PTU control

Some PTUs/PTZs (e.g. Ross, Panasonic) have their own control system for the PTU (Pan Tilt Unit). The Seervision API provides a set of services that allow the client take control of the head, release control, as well as a topic that publishes messages which help the client determine whether Seervision Suite is currently in control.

Service: take control

Request message:

Request to take control:

{
  "op": "call_service",
  "service": "/api/v1/ptu_driver/take_control"
}

This service call doesn't expect any arguments.

Response message:

Response to the "take control" request:

{
  "op": "service_response",
  "service": "/api/v1/ptu_driver/take_control",
  "result": true,
  "values": {}
}

The server will return an empty message in response.

Service: release control

Request to release control

{
  "op": "call_service",
  "service": "/api/v1/ptu_driver/release_control"
}

This service call doesn't expect any arguments.

Response message:

Response to the "release control" request:

{
  "op": "service_response",
  "service": "/api/v1/ptu_driver/release_control",
  "result": true,
  "values": {}
}

The server will return an empty message in response.

Topic: PTU driver control status

Message to initiate the subscription:

{
  "op": "subscribe",
  "topic": "/api/v1/ptu_driver/in_control"
}

Message to cancel the subscription:

{
  "op": "unsubscribe",
  "topic": "/api/v1/ptu_driver/in_control"
}

A client can subscribe to changes to the control status from the /api/v1/ptu_driver/in_control topic. Upon subscription, the client will receive one immediate message with the current status.

Example topic publication:

{
  "op": "publish",
  "topic": "/api/v1/ptu_driver/in_control",
  "msg": {
    "in_control": false
  }
}

The messages sent through this topic will have the following fields:

Shot presets

It is possible to create presets of framing shots, which can later be recalled with a single service call. Refer to the Seervision user manual for more details.

This section defines services for creating, deleting, and recalling shot presets, as well as a topic publishing updates.

Service: create a shot preset

This service will create a shot preset using the current zoom level.

Request message:

Request to create a shot preset with shot position in the middle of the frame:

{
  "op": "call_service",
  "service": "/api/v1/shot_presets/create",
  "args": {
    "name": "New shot preset",
    "position": {
      "x": 0.5,
      "y": 0.5
    }
  }
}

args fields of the call are:

In case name is an empty string, it will be automatically generated instead. This name will be the lowest numeric value that is not used as a name of another shot preset.

Response message:

Response to the "create a shot preset" request:

{
  "op": "service_response",
  "service": "/api/v1/shot_presets/create",
  "result": true,
  "values": {
    "new_preset": {
      "id": "756064a6f0c84610b2e63fea54a87c21",
      "name": "New shot preset",
      "position": {
        "x": 0.5,
        "y": 0.5
      },
      "zoom_level": 4.8
    }
  }
}

The values returned will have the following fields:

Service: delete a shot preset

This service will delete a shot preset of the given ID.

Request message:

Request to delete a shot preset:

{
  "op": "call_service",
  "service": "/api/v1/shot_presets/delete",
  "args": {
    "preset_id": "756064a6f0c84610b2e63fea54a87c21"
  }
}

args fields of the call are:

Response message:

Response to the "delete a shot preset" request:

{
  "op": "service_response",
  "service": "/api/v1/shot_presets/delete",
  "result": true,
  "values": {}
}

The server will return an empty message in response if the preset was successfully deleted, or if it wasn't there in the first place.

Service: get all shot presets

This service will return all saved shot presets.

Request message:

Request to get all shot presets:

{
  "op": "call_service",
  "service": "/api/v1/shot_presets/get_all"
}

This service call doesn't expect any arguments.

Response message:

Response to the "get all shot presets" request:

{
  "op": "service_response",
  "service": "/api/v1/shot_presets/get_all",
  "result": true,
  "values": {
    "presets": [{
      "id": "756064a6f0c84610b2e63fea54a87c21",
      "name": "New shot preset",
      "position": {
        "x": 0.5,
        "y": 0.5
      },
      "zoom_level": 4.8
    }, {
      "id": "756064a6f0c84610b2e63fea54a87c21",
      "name": "Full body shot",
      "position": {
        "x": 0.3,
        "y": 0.6
      },
      "zoom_level": 1.7
    }]
  }
}

The values returned will have the following fields:

Service: recall a shot preset

Request message:

Request to recall a shot preset:

{
  "op": "call_service",
  "service": "/api/v1/shot_presets/recall",
  "args": {
    "preset_id": "756064a6f0c84610b2e63fea54a87c21"
  }
}

args fields of the call are:

Response message:

Response to the "recall a preset" request when preset doesn't exist

{
  "op": "service_response",
  "service": "/api/v1/shot_presets/recall",
  "result": false,
  "values": "Preset not found"
}

Response to the "recall a preset" request when Seervision Suite is not in control:

{
  "op": "service_response",
  "service": "/api/v1/shot_presets/recall",
  "result": false,
  "values": "Not in control of the PTU"
}

Response to the successful "recall a preset" request:

{
  "op": "service_response",
  "service": "/api/v1/shot_presets/recall",
  "result": true,
  "values": {}
}

The server will return an error message if preset does not exist, and an empty message otherwise.

Topic: get shot presets updates

Message to initiate the subscription:

{
  "op": "subscribe",
  "topic": "/api/v1/shot_presets/updates"
}

Message to cancel the subscription:

{
  "op": "unsubscribe",
  "topic": "/api/v1/shot_presets/updates"
}

A client can subscribe to the changes in presets from the /api/v1/shot_presets/updates topic. Upon subscription, the client will receive one immediate message with the existing shot presets.

Example topic publication:

{
  "op": "publish",
  "topic": "/api/v1/shot_presets/updates",
  "msg": {
    "presets": [{
      "id": "756064a6f0c84610b2e63fea54a87c21",
      "name": "New shot preset",
      "position": {
        "x": 0.5,
        "y": 0.5
      },
      "zoom_level": 4.8
    }, {
      "id": "756064a6f0c84610b2e63fea54a87c21",
      "name": "Full body shot",
      "position": {
        "x": 0.3,
        "y": 0.6
      },
      "zoom_level": 1.7
    }]
  }
}

The messages sent through this topic will have the following format:

Tally state

This section defines services and topics related to the tally state of the system, i.e. whether the system is currently on program, in preview or none.

Service: get tally status

Request to get the tally state:

{
  "op": "call_service",
  "service": "/api/v1/tally_status/get"
}

Response message:

Response to the "get tally state" request:

{
  "op": "service_response",
  "service": "/api/v1/tally_status/get",
  "result": true,
  "values": {
    "status": "preview"
  }
}

The server will return the current status in the response, either "none", "preview" or "program".

Service: set tally status

Request message:

Request to set the tally state:

{
  "op": "call_service",
  "service": "/api/v1/tally_status/set",
  "args": {
    "status": "preview"
  }
}

Response message:

Response to the "set tally state" request:

{
  "op": "service_response",
  "service": "/api/v1/tally_status/set",
  "result": true,
  "values": {}
}

The server will return an empty message in response.

Topic: tally status

Message to initiate the subscription:

{
  "op": "subscribe",
  "topic": "/api/v1/tally_status"
}

Message to cancel the subscription:

{
  "op": "unsubscribe",
  "topic": "/api/v1/tally_status"
}

A client can subscribe to changes to the tally status from the /api/v1/tally_status topic. Upon subscription, the client will receive one immediate message with the current status.

Messages on the topic:

{
  "op": "publish",
  "topic": "/api/v1/tally_status",
  "msg": {
    "status": "preview"
  }
}

The server will publish the current status in the messages, either "none", "preview" or "program".

Tracking state

This section defines services and topics related to the tracking state of the system, i.e. whether the system is currently tracking someone or not.

Service: start tracking

Request message:

Request to start tracking:

{
  "op": "call_service",
  "service": "/api/v1/tracking/start",
  "args": {
    "target": "left"
  }
}

Response message:

Response to the "start tracking" request:

{
  "op": "service_response",
  "service": "/api/v1/tracking/start",
  "result": true,
  "values": {}
}

The server will return an empty message in response.

Service: stop tracking

Request to stop tracking

{
  "op": "call_service",
  "service": "/api/v1/tracking/stop"
}

Response message:

Response to the "stop tracking" request:

{
  "op": "service_response",
  "service": "/api/v1/tracking/stop",
  "result": true,
  "values": {}
}

The server will return an empty message in response.

Topic: get tracking state

Message to initiate the subscription:

{
  "op": "subscribe",
  "topic": "/api/v1/tracking/state"
}

Message to cancel the subscription:

{
  "op": "unsubscribe",
  "topic": "/api/v1/tracking/state"
}

A client can subscribe to changes to the tracking state from the /api/v1/tracking/state topic. Upon subscription, the client will receive one immediate message with the current state.

Example topic publication:

{
  "op": "publish",
  "topic": "/api/v1/tracking/state",
  "msg": {
    "is_tracking": false
  }
}

The messages sent through this topic have the following structure:

Trigger zones

Trigger zones can be defined through the User Interface to trigger specific actions from the system on events fired by the zone. This section describes a service and a method that can be used to retrieve information about the trigger zones defined in the system.

Service: set trigger zone state

Request message:

This service changes the "enabled" state of a single trigger zone.

Request to change status of a single trigger zone:

{
  "op": "call_service",
  "service": "/api/v1/trigger_zones/set_status_of_single_zone",
  "args": {
    "zone_id": "756064a6f0c84610b2e63fea54a87c21",
    "is_enabled": true
  }
}

The args field passed with the request must have the following fields:

Response message:

Response to the "update trigger zone 'enabled' status" request:

{
  "op": "service_response",
  "service": "/api/v1/trigger_zones/set_status_of_single_zone",
  "result": true,
  "values": {}
}

The server will return an empty message in response if the zone was successfully updated.

Service: set state of all trigger zones

Request message:

This service changes the "enabled" state of a single trigger zone.

Request to change status of all trigger zones:

{
  "op": "call_service",
  "service": "/api/v1/trigger_zones/set_status_of_all_zones",
  "args": {
    "is_enabled": true
  }
}

The args field passed with the request must have the following fields:

Response message:

Response to the "update trigger zones 'enabled' status" request:

{
  "op": "service_response",
  "service": "/api/v1/trigger_zones/set_status_of_all_zones",
  "result": true,
  "values": {}
}

The server will return an empty message in response if all zones got successfully updated.

Service: get trigger zones

Request message:

This service returns the list of trigger zones in the system.

Request to list trigger zones:

{
  "op": "call_service",
  "service": "/api/v1/trigger_zones/get_all"
}

This service call doesn't expect any arguments.

Response message:

Response to the "get all trigger zones" request:

{
  "op": "service_response",
  "service": "/api/v1/trigger_zones/get_all",
  "result": true,
  "values": {
    "trigger_zones": [{
      "id": "756064a6f0c84610b2e63fea54a87c21",
      "name": "Trigger Zone 1",
      "is_enabled": false
    }, {
      "id": "856064a6f0c84610b2e63fea54a87c21",
      "name": "Trigger Zone 2",
      "is_enabled": true
     }]
  }
}

The values returned will have the following fields:

Topic: get trigger zones

Message to initiate the subscription:

{
  "op": "subscribe",
  "topic": "/api/v1/trigger_zones/updates"
}

Message to cancel the subscription:

{
  "op": "unsubscribe",
  "topic": "/api/v1/trigger_zones/updates"
}

The /api/v1/trigger_zones/updates topic can be used to subscribe to changes to the trigger zones. It will publish a new message whenever a trigger zone is added, deleted, or renamed. Upon subscription, the client will receive one immediate message with the current trigger zones.

Example topic publication:

{
  "op": "publish",
  "topic": "/api/v1/trigger_zones/updates",
  "msg": {
    "trigger_zones": [
      {
        "id": "756064a6f0c84610b2e63fea54a87c21",
        "name": "Trigger Zone 1",
        "is_enabled": false
      },
      {
        "id": "856064a6f0c84610b2e63fea54a87c21",
        "name": "Trigger Zone 2",
        "is_enabled": true
      }
    ]
  }
}

The fields of the messages in this topic are:

Common object definitions

This section contains definitions of messages used in topic publications and service responses. Every message is an object with one or more strongly typed fields.

Container

Example of a Container message:

{
  "id": "4a6f0c",
  "name": "Container 1"
}

This object contains information about a container.

ContainerGroup

Example of a ContainerGroup message for a user-defined group:

{
  "group_id": "7c0849",
  "group_name": "Group 2",
  "color": "roquefort",
  "container_ids": ["995d22"]
}

Example of a ContainerGroup message for a default group:

{
  "group_id": "",
  "group_name": "",
  "color": "",
  "container_ids": ["52ac65"]
}

This object contains information about a container group. The message content differs based on whether it is a user-defined group, or a default group. All containers that appear in the UI as ungrouped belong to the default group.

Point2d

Example of a Point2d message:

{
  "x": 0.5,
  "y": 0.5
}

This message is usually used to describe point position in the 2-dimensional coordinates.

Preset

This object contains full information about a preset.

Static preset of the "speed" movement type:

{
  "id": "756064a6f0c84610b2e63fea54a87c21",
  "name": "Main stage",
  "type": "static",
  "transition_type": {
    "type": "speed",
    "speed": 4,
    "time": 0
  }
}

Static preset of the "time" movement type:

{
  "id": "756064a6f0c84610b2e63fea54a87c21",
  "name": "Main stage",
  "type": "static",
  "transition_type": {
    "type": "time",
    "speed": 0,
    "time": 5
  }
}

PresetTransitionType

"Speed" transition type example:

{
  "type": "speed",
  "speed": 5,
  "time": 0
}

"Time" transition type example:

{
  "type": "time",
  "speed": 0,
  "time": 5
}

This object defines the type of transition to be used to transition towards the selected preset.

On the server side, speed and time values will be validated, and might be adjusted to match the limits of the currently selected hardware.

ShotPreset

Example of a ShotPreset message:

{
  "id": "756064a6f0c84610b2e63fea54a87c21",
  "name": "New shot preset",
  "position": {
    "x": 0.5,
    "y": 0.5
  },
  "zoom_level": 4.8
}

This message is used to describe a shot preset.

TriggerZone

Example of a TriggerZone message:

{
  "id": "756064a6f0c84610b2e63fea54a87c21",
  "name": "Trigger Zone 1",
  "is_enabled": false
}

This message is used to describe a trigger zone.

TriggerZoneEvent

Example of a TriggerZoneEvent message with "person_entered" type:

{
  "zone_id": "756064a6f0c84610b2e63fea54a87c21",
  "type": "person_entered"
}

This message is used to describe an event triggered by a trigger zone.