Push
/v1/vhosts/{vhost_name}/apps/{app_name}:startPush
POST
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}:startPush
This is an action to request a push of a selected stream. Please refer to the "Push" document for detail setting.
Request Example:
POST http://1.2.3.4:8081/v1/vhosts/default/apps/app:startPush
{
"id": "{UserDefinedUniqueId}",
"stream": {
"name": "output_stream_name",
"tracks": [
101,
102 ]
},
"protocol": "rtmp",
"url":"rtmp://{host}[:port]/{appName}",
"streamKey":"{streamName}"
}
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 For example, |
Request Body
Name | Type | Description |
---|---|---|
id* | string | Unique identifier for push management. if there is no value, automatically created and returned |
stream* | string | Output stream for push |
name* | string | Output stream name |
tracks | string | Track id for want to push, if there is no value, all tracks are push |
protocol* | string | Transport protocol [rtmp | mpegts] |
url* | string | Destination URL |
streamKey* | object | Destination stream key |
/v1/vhosts/{vhost_name}/apps/{app_name}:stopPush
POST
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}:stopPush
Request to stop pushing
Request Example:
POST 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 For example, |
Request Body
Name | Type | Description |
---|---|---|
id* | string | Unique identifier for push management |
/v1/vhosts/{vhost_name}/apps/{app_name}:pushes
POST
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}:pushes
Get all push lists for a specific application
Request Example:
POST http://1.2.3.4:8081/v1/vhosts/default/apps/app:pushes
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