Recording
/v1/vhosts/{vhost_name}/apps/{app_name}:startRecord
POST
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}:startRecord
This API performs a recording start request operation. for recording, the output stream name must be specified. file path, information path, recording interval and schedule parameters can be specified as options.
Request Example:
POST http://1.2.3.4:8081/v1/vhosts/default/apps/app:startRecord
{
"id": "custom_id",
"stream": {
"name": "stream_o",
"tracks": [ 100, 200 ]
},
"filePath" : "/path/to/save/recorded/file_${Sequence}.ts",
"infoPath" : "/path/to/save/information/file.xml",
"interval" : 60000, # Split it every 60 seconds
"schedule" : "0 0 */1" # Split it at second 0, minute 0, every hours.
"segmentationRule" : "continuity"
}
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 |
---|---|---|
segmentationRule | string | Define the policy for continuously or discontinuously generating timestamp in divided recorded files. - continuity - discontinuity (default) |
id | string | An unique identifier for recording job. |
stream | string | Output stream. |
name | string | Output stream name. |
tracks | array | Default is all tracks. It is possible to record only a specific track using the track Id. - default is all tracks |
schedule | string | Schedule based split recording. set only <second minute hour> using crontab method. It cannot be used simultaneously with interval. |
interval | number | Interval based split recording. It cannot be used simultaneously with schedule. |
filePath | string | Set the path of the file to be recorded. same as setting macro pattern in Config file. |
infoPath | string | Set the path to the information file to be recorded. same as setting macro pattern in Config file. |
/v1/vhosts/{vhost_name}/apps/{app_name}:stopRecord
POST
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}:stopRecord
This API performs a recording stop request.
Request Example:
POST http://1.2.3.4:8081/v1/vhosts/default/apps/app:stopRecord
{
"id": "custom_id"
}
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 job. |
/v1/vhosts/{vhost_name}/apps/{app_name}:records
POST
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}:records
This API performs a query of the job being recorded. Provides job inquiry function for all or custom Id.
Request Example:
POST http://1.2.3.4:8081/v1/vhosts/default/apps/app:records
{
"id" : "custom_id"
}
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 job. If no value is specified, the entire recording job is requested. |
Last updated