Recording
/v1/vhosts/{vhost_name}/apps/{app_name}:startRecord
POST
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}:startRecord
This is an action that requests recording of the output stream. The output file path can be set through API. If not set, the default output file path set in FILE Publisher in Server.xml is used. For information on settings, see the "Recording" document. You can also select the track to record by inquiring the Track ID through the stream inquiry API. If not selected, all tracks are recorded in one file.
Request Example:
POST http://1.2.3.4:8081/v1/vhosts/default/apps/app:startRecord
{
"id": "userDefinedUniqueId",
"stream": {
"name": "outputStreamName",
"tracks": [
101,
102
]
},
"filePath" : "{/path/to/save/recorded/file.ts}",
"infoPath" : "{/Path/to/save/information/file.xml}"
}
Path Parameters
Name | Type | Description |
---|---|---|
vhost_name | string | A name of |
app_name | string | A name of |
Headers
Name | Type | Description |
---|---|---|
authorization | string | A string for authentication in |
Request Body
Name | Type | Description |
---|---|---|
id | string | An unique identifier for recording management |
stream | string | Output stream for recording |
name | string | Output stream name |
tracks | array | Track id for want to recording. If there is no value, all tracks are recorded |
filePath | string | Path to save recorded file |
infoPath | string | Path to save information file |
/v1/vhosts/{vhost_name}/apps/{app_name}:stopRecord
POST
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}:stopRecord
The action requesting the recording to stop. Use the id parameters used when requested.
Request Example:
GET http://1.2.3.4:8081/v1/vhosts/default/apps/app:stopRecord
{
"id": "userDefinedUniqueId"
}
Path Parameters
Name | Type | Description |
---|---|---|
vhost_name | string | A name of |
app_name | string | A name of |
Headers
Name | Type | Description |
---|---|---|
authorization | string | A string for authentication in |
Request Body
Name | Type | Description |
---|---|---|
id | string | An unique identifier for recording c |
/v1/vhosts/{vhost_name}/apps/{app_name}:records
POST
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}:records
You can view all the recording lists that are being recorded in the application. Information such as recording status, file path, size, and recording time can be found in the inquired record item.
Request Example:
POST http://1.2.3.4:8081/v1/vhosts/default/apps/app:records
Path Parameters
Name | Type | Description |
---|---|---|
vhost_name | string | A name of |
app_name | string | A name of |
Headers
Name | Type | Description |
---|---|---|
authorization | string | A string for authentication in |
Last updated