Skip to main content
Skip table of contents

UC Create a Scheduled Recording [VCon IG]


Motivation

A scheduled recording is a single recording which occurs only once and thus the most basic recording that can be created.

Description

Even for a single recording all objects described here are needed. Everything can be created with a single POST call on BookingDefinitions that contains all objects in the request body as shown in the example. Please refer to the “Writeable” column in the parameter tables on the element’s detailed description pages (under Basic Data Model [VCon IG] ) to know which fields can be set and which are read only.

Reference

vidicontrol/schedulercore/swagger/index.html

Example

POST vidicontrol/schedulercore/SchedulerCore/BookingService/v1/BookingDefinitions

CODE
{
  "bookings": [
    {
      "chunkList": [
        {
          "commandList": [            
            {
              "capabilityId": "wl",
              "deviceId": "28J",
              "index": 0,
              "handling": "WaitForResult",
              "content": "{\"action\":\"Switch\",\"input\":{}}",
              "commandType": "CapabilityRouter"
            },
            {
                "capabilityId": "0B",
                "poolId": "0B",
                "executionTime": "2023-02-23T09:13:11.320175Z",
                "duration": 3600,
                "index": 1,
                "handling": "WaitForResult",
                "content": "{\"action\":\"Record\",\"input\":{}}",
                "commandType": "CapabilityRecorder"
              }
          ],
          "title": "ItemTitle1"
        }
      ]
    }
  ],
  "type": 2
}

Response:

JSON
{
  "id": "x8zp",
  "bookings": [
    {
      "id": "x8zp",
      "chunkList": [
        {
          "id": "68M4",
          "commandList": [
            {
              "id": "JzWP",
              "capabilityId": "wl",
              "poolId": null,
              "deviceId": "28J",
              "executionTime": "2023-02-23T09:11:09.320175Z",
              "duration": 2,
              "index": 0,
              "executionState": "Pending",
              "handling": "WaitForResult",
              "content": "{\"action\":\"Switch\",\"input\":{}}",
              "commandType": "CapabilityRouter",
              "inPortId": null,
              "outPortId": "GD"
            },
            {
              "id": "O0QP",
              "capabilityId": "0B",
              "poolId": "0B",
              "deviceId": "2n",
              "executionTime": "2023-02-23T09:13:11.320175Z",
              "duration": 3600,
              "index": 1,
              "executionState": "Pending",
              "handling": "WaitForResult",
              "content": "{\"action\":\"Record\",\"input\":{}}",
              "commandType": "CapabilityRecorder",
              "inPortId": null,
              "outPortId": null
            }
          ],
          "vcItemId": "",
          "metadata": null,
          "start": "2023-02-23T09:13:11.320175Z",
          "end": "2023-02-23T10:13:11.320175Z",
          "executionState": "Pending",
          "title": "ItemTitle1",
          "clipId": null
        }
      ],
      "start": "2023-02-23T09:13:11.320175Z",
      "end": "2023-02-23T10:13:11.320175Z",
      "vcItemSequenceId": "",
      "metadata": null,
      "bookingDefinitionId": null
    }
  ],
  "vcCollectionId": "",
  "metadata": null,
  "start": "2023-02-23T09:13:11.320175Z",
  "end": "2023-02-23T10:13:11.320175Z",
  "pattern": "",
  "type": 2
}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.