POST
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}:startRecord
Description of the Start Recording API
Example - Recording by Output Stream Name
POST http[s]://{host}/v1/vhosts/default/apps/app:startRecord
{
"id": "{unique_record_id}",
"stream": {
"name": "{output_stream_name}",
}
}
Example - Recording by Output Stream Name with Track Ids
POST http[s]://{host}/v1/vhosts/default/apps/app:startRecord
{
"id": "{unique_record_id}",
"stream": {
"name": "{output_stream_name}",
"trackIds": [ 100, 200 ]
}
}
Example - Recording by Output Stream Name with Variant Names
POST http[s]://{host}/v1/vhosts/default/apps/app:startRecord
{
"id": "{unique_record_id}",
"stream": {
"name": "{output_stream_name}",
"variantNames": [ "h264_fhd", "aac" ]
}
}
* variantName means Application.OutputProfiles.OutputProfie.Encodes.[Video|Audio|Data].Name in the Server.xml configuration file.
Example - Split Recording by Interval
POST http[s]://{host}/v1/vhosts/default/apps/app:startRecord
{
"id": "{unique_record_id}",
"stream": {
"name": "{output_stream_name}"
},
"interval": 60000,
"segmentationRule": "discontinuity"
}
Example - Split Recording by Schedule
POST http[s]://{host}/v1/vhosts/default/apps/app:startRecord
{
"id": "{unique_record_id}",
"stream": {
"name": "{output_stream_name}"
},
"schedule" : "0 */1 *"
"segmentationRule": "continuity"
}
POST
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}:stopRecord
Description of the Stop Recording API
Request Example
POST http[s]://{host}/v1/vhosts/default/apps/app:stopRecord
{
"id": "{unique_record_id}"
}
POST
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}:records
Description of the Recording Status API
Request Example:
POST http[s]://{host}/v1/vhosts/default/apps/app:records
{
"id" : "{unique_record_id}"
}
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
vhost_name*
string
A name of VirtualHost
app_name*
string
A name of Application
authorization*
string
A string for authentication in Basic Base64(AccessToken)
format.
For example, Basic b21lLWFjY2Vzcy10b2tlbg==
if access token is ome-access-token
segmentationRule
string
Define the policy for continuously or discontinuously 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.
trackIds
array
Used for recording specific track IDs.
schedule
string
Schedule-based split recording settings. Same as crontab setting. Unable to use with interval. Format : <second minute hour>
interval
number
Interval based split recording settings. Unable to use with schedule. Format : Milliseconds
filePath
string
Set the path of the file to be recorded. Format: See Config Settings
infoPath
string
Set the path to the information file to be recorded. Format: See Config Settings
variantNames
array
Used for recording specific variant names.
vhost_name*
string
A name of VirtualHost
app_name*
string
A name of Application
authorization*
string
A string for authentication in Basic Base64(AccessToken)
format.
For example, Basic b21lLWFjY2Vzcy10b2tlbg==
if access token is ome-access-token
.
id*
string
An unique identifier for recording job.
vhost_name*
string
A name of VirtualHost
app_name*
string
A name of Application
authorization*
string
A string for authentication in Basic Base64(AccessToken)
format.
For example, Basic b21lLWFjY2Vzcy10b2tlbg==
if access token is ome-access-token
.
id
string
An unique identifier for recording job. If no value is specified, the entire recording job is requested.