Sources

Add a new Source

POST http://recording_server:9000/api/sources

Adds a new source

Headers

Name	Type	Description
Authorization	string	API Token

Request Body

Name	Type	Description
AudioGain	string	Specifies the audio gain
AudioDevice	object	Specifies the audio device of the source (use a list of available audio devices to set)
LTCTimecode	object	Specifies the audio device that is used as an LTC timecode source (use a list of available audio devices to set)
VideoFormat	string	Sets the input video format
VideoLine	string	Specifies the input line of signal (e.g. HDMI)
StreamBuffer	integer	Sets the input stream buffer. Possible values are from 0 to 9 with "0" means "zero latency", and "9" for "5 seconds buffering"
StreamURL	string	For Network Streams, sets the input stream URL
Name	string	Specifies the name of the Source
VideoDevice	object	Specifies a video device (use a list of available video devices to set - you should use the whole definition of a source to set, i.e. the device type, its index, and its name)

200 Successfully added

Update a Source

PUT http://recording_server:9000/api/sources/{index}

Edit an existing source

Query Parameters

Name	Type	Description
{index}	string	indicates an index of a source to update

Headers

Name	Type	Description
Authorization	string	API Token

Request Body

Name	Type	Description
AudioGain	string	Specifies the audio gain
AudioDevice	object	Specifies the audio device of the source (use a list of available audio devices to set)
LTCTimecode	object	Specifies the audio device that is used as an LTC timecode source (use a list of available audio devices to set)
VideoFormat	string	Sets the input video format
VideoLine	string	Specifies the input line of signal (e.g., HDMI)
StreamBuffer	integer	Sets the input stream buffer. Possible values are from 0 to 9 with "0" means "zero latency", and "9" for "5 seconds buffering"
StreamURL	string	For Network Streams, sets the input stream URL
Name	string	Specifies the name of the Source
VideoDevice	object	Specifies a video device (use a list of available video devices to set - you should use the whole definition of a source to set, i.e. the device type, its index, and its name)

200 Successfully updated

Get a Source

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

Returns a configuration of the specified source

Query Parameters

Name	Type	Description
{index}	number	indicates an index of a source to return

Headers

Name	Type	Description
Authorization	string	API Token

200 Successfully returned

{
  "VideoDevice": {
    "Type": 0,
    "Name": "Logitech BRIO"
  },
  "Name": "Source 1",
  "AudioMeters": [
    0.0,
    0.0
  ],
  "VideoLines": [],
  "VideoLine": null,
  "VideoFormats": [
    "YUY2 [email protected] 4:3",
    "YUY2 [email protected] 4:3",
    "YUY2 [email protected] 16:9",
    "HD1080-30p YUY2 [email protected] 16:9"
  ],
  "VideoFormat": null,
  "AudioDevice": null,
  "AudioFormats": [],
  "AudioFormat": null,
  "StreamBuffer": 5,
  "StreamURL": null,
  "LTCTimecode": null,
  "AudioGain": 0.0
}

Get all the Sources

GET http://recording_server:9000/api/sources

Returns a list of all the sources

Headers

Name	Type	Description
Authorization	string	API Token

200 Successfully returned

[
  {
    "Index": 0,
    "Name": "Source 1",
    "Device": "Logitech BRIO"
  },
  {
    "Index": 1,
    "Name": "Source 2",
    "Device": "Network Stream"
  }
]

Remove a Source

DELETE http://recording_server:9000/api/sources/{index}

Removes a source by its index

Query Parameters

Name	Type	Description
{index}	string	Indicates an index of a source to remove

Headers

Name	Type	Description
Authorization	string	API Token

200 Successfully removed