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:
GET 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}"
}
POST
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}:stopPush
Stops recording for Application
Request Example:
GET http://1.2.3.4:8081/v1/vhosts/default/apps/app:stopRecord
{
"id": "{userDefinedUniqueId}"
}
POST
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}:pushes
Lists all Record
in the Application
Request Example:
POST http://1.2.3.4:8081/v1/vhosts/default/apps/app:pushes
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.
String
For example, Basic b21lLWFjY2Vzcy10b2tlbg==
if access token is ome-access-token
.
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
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.
String
For example, Basic b21lLWFjY2Vzcy10b2tlbg==
if access token is ome-access-token
.
id
string
Unique identifier for push management
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
.