Channels

Get a state of all the Channels

GET http://recording_server:9000/api/channels

Returns a list of all the Channels using in Direct Take

Headers

Name	Type	Description
Authorization	string	API Token

200 Successfully returned

[
  {
    "Index": 0,
    "SourceName": "Not Specified",
    "Destinations": [
      "Destination #1"
    ],
    "IsRecording": false,
    "IsSomethingWrong": false,
    "IsRecordingPause": false,
    "IsInSync": false,
    "IsInSyncRec": false,
    "IsAudioPreview": false,
    "RecordingDuration": "00:00:00",
    "RecordingFPS": "0.00",
    "RecordingBreaks": "0",
    "RecordingDrops": "0",
    "RecordingBuffered": "0"
  },
  {
    "Index": 1,
    "SourceName": "Source 2",
    "Destinations": [],
    "IsRecording": false,
    "IsSomethingWrong": false,
    "IsRecordingPause": false,
    "IsInSync": false,
    "IsInSyncRec": false,
    "IsAudioPreview": false,
    "RecordingDuration": "00:00:00",
    "RecordingFPS": "0.00",
    "RecordingBreaks": "0",
    "RecordingDrops": "0",
    "RecordingBuffered": "0"
  },
  {
    "Index": 2,
    "SourceName": "Not Specified",
    "Destinations": [],
    "IsRecording": false,
    "IsSomethingWrong": false,
    "IsRecordingPause": false,
    "IsInSync": false,
    "IsInSyncRec": false,
    "IsAudioPreview": false,
    "RecordingDuration": "00:00:00",
    "RecordingFPS": "0.00",
    "RecordingBreaks": "0",
    "RecordingDrops": "0",
    "RecordingBuffered": "0"
  },
  {
    "Index": 3,
    "SourceName": "Not Specified",
    "Destinations": [],
    "IsRecording": false,
    "IsSomethingWrong": false,
    "IsRecordingPause": false,
    "IsInSync": false,
    "IsInSyncRec": false,
    "IsAudioPreview": false,
    "RecordingDuration": "00:00:00",
    "RecordingFPS": "0.00",
    "RecordingBreaks": "0",
    "RecordingDrops": "0",
    "RecordingBuffered": "0"
  }
]

Get a state of a Channel

GET http://recording_server:9000/api/channels/{index}

Returns parameters of a Channel by its index

Query Parameters

Name	Type	Description
{index}	integer	index of a Channel

Headers

Name	Type	Description
Authorization	string	API Token

200 Successfully returned

{
  "Index": 0,
  "SourceName": "Not Specified",
  "Destinations": [
    "Destination AAA"
  ],
  "IsRecording": false,
  "IsSomethingWrong": false,
  "IsRecordingPause": false,
  "IsInSync": false,
  "IsInSyncRec": false,
  "IsAudioPreview": false,
  "RecordingDuration": "00:00:00",
  "RecordingFPS": "0.00",
  "RecordingBreaks": "0",
  "RecordingDrops": "0",
  "RecordingBuffered": "0"
}

Set the grid size for the application

PUT http://recording_server:9000/api/channels/count/{grid_size}

Sets a grid size for the Channels

Query Parameters

Name	Type	Description
{grid_size}	integer	Sets the size of the channels grid. Possible values: 1, 4, 9, 16.

Headers

Name	Type	Description
Authorization	string	API Token

200 Successfully set

Get a preview image

GET http://recording_server:9000/api/channels/{index}/preview

Returns a Base64 string that represents a PNG image of a Channel's Source

Query Parameters

Name	Type	Description
{index}	integer	index of a Channel

Headers

Name	Type	Description
Authorization	string	API Token

200 Successfully returned Base64 string with bytes of PNG image

Set a source for a Channel

PUT http://recording_server:9000/api/channels/{index}/set-source/{source_name}

Configures a Channel (by its index) with a Source (by its name)

Query Parameters

Name	Type	Description
{source_name}	string	name of a Source
{index}	integer	index of a Channel

Headers

Name	Type	Description
Authorization	string	API Token

200 Successfully set

Remove a source for a Channel

PUT http://recording_server:9000/api/channels/{index}/unset-source

Removes a source from a Channel

Query Parameters

Name	Type	Description
{index}	integer	index of a Channel

Headers

Name	Type	Description
Authorization	string	API Token

200 Successfully removed

Add a destination for a Channel

PUT http://recording_server:9000/api/channels/{index}/add-dest/{destination_name}

Adds a Destination (by its name) to a configuration of a Channel (by its index). One channel might have multiple destinations.

Query Parameters

Name	Type	Description
{destination_name}	string	Name of a Destination
{index}	integer	index of a Channel

Headers

Name	Type	Description
Authorization	string	API Token

200 Successfully set

Delete a destination for a Channel

PUT http://recording_server:9000/api/channels/{index}/delete-dest/{destination_name}

Removes a Destination (by its name) from a configuration of a Channel (by its index)

Query Parameters

Name	Type	Description
{destination_name}	string	name of a Destination
{index}	integer	index of a Channel

Headers

Name	Type	Description
Authorization	string	API Token

200 Successfully removed

Enable InSync for a Channel

PUT http://recording_server:9000/api/channels/{index}/sync-on

Put a Channel in the InSync mode (ready for synchronous recording)

Query Parameters

Name	Type	Description
{index}	integer	index of a Channel

Headers

Name	Type	Description
Authorization	string	API Token

200 Successfully enabled

Disable InSync for a Channel

PUT http://recording_server:9000/api/channels/{index}/sync-off

Disables the InSync mode for a Channel (ready for regular recording)

Query Parameters

Name	Type	Description
{index}	integer	index of a Channel

Headers

Name	Type	Description
Authorization	string	API Token

200 Successfully disabled

Start (Resume) Recording of a Channel

PUT http://recording_server:9000/api/channels/{index}/rec-start

Starts Recording of a Channel. If the Channel is in the Paused state, resumes the recording.

Query Parameters

Name	Type	Description
{index}	integer	index of a Channel

Headers

Name	Type	Description
Authorization	string	API Token

200 Successfully started

Pause Recording of a Channel

PUT http://recording_server:9000/api/channels/{index}/rec-pause

Pauses Recording of a Channel

Query Parameters

Name	Type	Description
{index}	integer	index of a Channel

Headers

Name	Type	Description
Authorization	string	API Token

200 Successfully paused

Stop Recording of a Channel

PUT http://recording_server:9000/api/channels/{index}/rec-stop

Stops Recording of a Channel

Query Parameters

Name	Type	Description
{index}	integer	index of a Channel

Headers

Name	Type	Description
Authorization	string	API Token

200 Successfully stopped

Start (Resume) Synchronous Recording

PUT http://recording_server:9000/api/channels/sync-rec-start

Start (Resume) Synchronous Recording for channels in the InSync mode

Headers

Name	Type	Description
Authorization	string	API Token

200 Successfully started

Pause Synchronous Recording

PUT http://recording_server:9000/api/channels/sync-rec-pause

Pauses Synchronous Recording

Headers

Name	Type	Description
Authorization	string	API Token

200 Successfully paused

Stop Synchronous Recording

PUT http://recording_server:9000/api/channels/sync-rec-stop

Stop Synchronous Recording

Headers

Name	Type	Description
Authorization	string	API Token

200 Successfully stopped