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 VirtualHost
app_name	string	A name of Application

Headers

Name	Type	Description
authorization	string	A string for authentication in Basic Base64(AccessToken) format. For example, Basic b21lLWFjY2Vzcy10b2tlbg== if access token is ome-access-token

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.

200

{
    "message": "OK",
    "response": [
        {
            "state": "ready",
            "id": "stream_o",
            "vhost": "default",
            "app": "app",
            "stream": {
                "name": "stream_o",
                "tracks": []
            },
            "filePath": "/path/to/save/recorded/file_${Sequence}.ts",
            "infoPath": "/path/to/save/information/file.xml",            
            "interval": 60000,  
            "schedule": "0 0 */1",       
            "segmentationRule": "continuity",
            "createdTime": "2021-08-31T23:44:44.789+0900"
        }
    ],
    "statusCode": 200
}

400

{
	"statusCode": 400,
	"message": "There is no required parameter [{id}, {stream.name}] (400)"
}
	
{
	"statusCode": 400,
	"message": "Duplicate ID already exists [{id}] (400)"
}

{
  "statusCode": 400,
  "message" : "[Interval] and [Schedule] cannot be used at the same time"
}

/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 VirtualHost
app_name	string	A name of Application

Headers

Name	Type	Description
authorization	string	A string for authentication in Basic Base64(AccessToken) format. For example, Basic b21lLWFjY2Vzcy10b2tlbg== if access token is ome-access-token.

Request Body

Name	Type	Description
id	string	An unique identifier for recording job.

200

{
    "message": "OK",
    "response": [
        {
            "state": "stopping",
            "id": "custom_id",            
            "vhost": "default",
            "app": "app",
            "stream": {
                "name": "stream_o",
                "tracks": []
            },
            "filePath": "app_stream_o_0.ts",
            "infoPath": "app_stream_o.xml",
            "segmentationRule": "discontinuity",
            "recordBytes": 1200503,
            "recordTime": 4272,
            "totalRecordBytes": 1204775,
            "totalRecordTime": 4272,
            "createdTime": "2021-08-31T23:44:44.789+0900",
            "startTime": "2021-08-31T23:44:44.849+0900"
        }
    ],
    "statusCode": 200
}

400

{
	"statusCode": 400,
	"message": "There is no required parameter [id] (400)"
}
	

404

{
	"statusCode": 404,
	"message": "There is no record information related to the ID [{id}] (404)"
}

/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 VirtualHost
app_name	string	A name of Application

Headers

Name	Type	Description
authorization	string	A string for authentication in Basic Base64(AccessToken) format. For example, Basic b21lLWFjY2Vzcy10b2tlbg== if access token is ome-access-token.

Request Body

Name	Type	Description
id	string	An unique identifier for recording job. If no value is specified, the entire recording job is requested.

200

{
    "message": "OK",
    "response": [
        {
            "state": "ready",
            "id": "custom_id_1",
            "vhost": "default",
            "app": "app",
            "stream": {
                "name": "stream_o",
                "tracks": []
            },
            "filePath": "app_stream_o_0.ts",
            "infoPath": "app_stream_o.xml",
            "segmentationRule": "discontinuity",
            "createdTime": "2021-08-31T21:05:01.171+0900",
        },
        {
            "state": "recording",
            "id": "custom_id_2",
            "vhost": "default",                    
            "app": "app",
            "stream": {
                "name": "stream_o",
                "tracks": []
            },
            "filePath": "app_stream_o_0.ts",
            "infoPath": "app_stream_o.xml",
            "segmentationRule": "discontinuity",
            "sequence": 0,
            "recordBytes": 1907351,
            "recordTime": 6968,
            "totalRecordBytes": 1907351,
            "totalRecordTime": 6968,
            "createdTime": "2021-08-31T21:05:01.171+0900",            
            "startTime": "2021-08-31T21:05:01.567+0900",            
        },
        {
            "state": "stopping",
            "id": "custom_id_3",
            "vhost": "default",
            "app": "app",
            "stream": {
                "name": "stream_o",
                "tracks": []
            },
            "filePath": "app_stream_o_0.ts",
            "infoPath": "app_stream_o.xml",
            "segmentationRule": "discontinuity",
            "sequence": 0,
            "recordBytes": 1907351,
            "recordTime": 6968,
            "totalRecordBytes": 1907351,
            "totalRecordTime": 6968,
            "createdTime": "2021-08-31T21:05:01.171+0900",
            "startTime": "2021-08-31T21:05:01.567+0900",
        },
        {
            "state": "stopped",
            "id": "custom_id_4",
            "vhost": "default",        
            "app": "app",
            "stream": {
                "name": "stream_o",
                "tracks": []
            },
            "filePath": "app_stream_o_0.ts",
            "infoPath": "app_stream_o.xml",
            "segmentationRule": "discontinuity",
            "sequence": 0,
            "recordBytes": 1907351,
            "recordTime": 6968,
            "totalRecordBytes": 1907351,
            "totalRecordTime": 6968,
            "startTime": "2021-08-31T21:05:01.567+0900",            
            "createdTime": "2021-08-31T21:05:01.171+0900",            
            "finishTime": "2021-08-31T21:15:01.567+0900"
        },
        {
            "state": "error",
            "id": "custom_id_5",
            "vhost": "default",        
            "app": "app",
            "stream": {
                "name": "stream_o",
                "tracks": []
            },
            "filePath": "app_stream_o_0.ts",
            "infoPath": "app_stream_o.xml",
            "segmentationRule": "discontinuity",
            "sequence": 0,
            "recordBytes": 1907351,
            "recordTime": 6968,
            "totalRecordBytes": 1907351,
            "totalRecordTime": 6968,
            "createdTime": "2021-08-31T21:05:01.171+0900",
            "startTime": "2021-08-31T21:05:01.567+0900",
            "finishTime": "2021-08-31T21:15:01.567+0900"
        }
    ],
    "statusCode": 200
}

204

{
	"statusCode": 204,
	"message": "There is no record information (204)"
}