Destinations
Add a new Destination
POST
http://recording_server:9000/api/destinations
Add a new output configuration for local file encoding or network streaming
Headers
Name | Type | Description |
---|---|---|
Authorization | string | API Token |
Request Body
Name | Type | Description |
---|---|---|
Name | string | Sets a name of a Destination |
Location | string | Sets a folder to store the recording files |
Type | string | Either "Local File Recording" or "Network Streaming" |
URL | string | Target URL for streaming |
StreamKey | string | Stream Key for streaming |
NamingTemplate | string | A template to name the resulting files |
OverwriteExistingFiles | boolean | Indicates whether the resulting files should be overwritten |
SplitIntervalString | string | Specifies a time for splitting the recorded files into equal chunks |
PresetName | string | A name of encoding preset |
PostCapturingAction | string | Sets an action for the recorded files. Possible values are "Do Nothing", "Move after recording to", and "Copy after recording to" |
PostCapturingActionTarget | string | Sets a folder to copy or move the recorded files if the PostCapturingAction is set. |
Update a Destination
PUT
http://recording_server:9000/api/destinations/{index}
Changes parameters of an existing Destination by its index
Query Parameters
Name | Type | Description |
---|---|---|
{index} | string | Specifies an index of a Destination to update |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | API Token |
Request Body
Name | Type | Description |
---|---|---|
Name | string | Sets a name of a Destination |
Location | string | Sets a folder to store the recording files |
Type | string | Either "Local File Recording" or "Network Streaming" |
URL | string | Target URL for streaming |
StreamKey | string | Stream Key for streaming |
NamingTemplate | string | A template to name the resulting files |
OverwriteExistingFiles | boolean | Indicates whether the resulting files should be overwritten |
SplitIntervalString | string | Specifies a time for splitting the recorded files into equal chunks |
PresetName | string | A name of encoding preset |
PostCapturingAction | string | Sets an action for the recorded files. Possible values are "Do Nothing", "Move after recording to", and "Copy after recording to" |
PostCapturingActionTarget | string | Sets a folder to copy or move the recorded files if the PostCapturingAction is set. |
Get a Destination
GET
http://recording_server:9000/api/destinations/{index}
Returns a Destination by its index
Query Parameters
Name | Type | Description |
---|---|---|
{index} | integer | Specifies an index of a Destination to return |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | API Token |
Get all the Destinations
GET
http://recording_server:9000/api/destinations
Returns all the available Destinations
Headers
Name | Type | Description |
---|---|---|
Authorization | string | API Token |
Remove a Destination
DELETE
http://recording_server:9000/api/destinations/{index}
Removes a Destination by its index
Query Parameters
Name | Type | Description |
---|---|---|
{index} | integer | Specifies an index of a Destination to remove |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | API Token |
Last updated