Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
It allows you to insert events into streams. Right now events only support the ID3v2 format and only the LLHLS publisher handles it. Events delivered to LLHLS Publisher are inserted as emsg boxes within the m4s container.
POST
http[s]://{Host}/v1/vhosts/{vhost name}/apps/{app name}/streams/{stream name}:sendEvent
Body
eventFormat Currently only
id3v2
is supported.eventType (Optional, Default :
event
) Select one ofevent
,video
, andaudio
.event
inserts an event into every track.video
inserts events only on tracks of type video.audio
inserts events only on tracks of audio type.events It accepts only Json array format and can contain multiple events.
frameType Currently, only TXXX and T??? (Text Information Frames, e.g. TIT2) are supported. info This field is used only in TXXX and is entered in the Description field of TXXX. data If the frameType is TXXX, it is entered in the Value field, and if the frameType is "T???", it is entered in the Information field.
POST
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps
Creates Application
s in the VirtualHost
Request Example:
POST http://1.2.3.4:8081/v1/vhosts/default/apps
[ { "name": "app", "type": "live", "outputProfiles": { "outputProfile": [ { "name": "bypass_profile", "outputStreamName": "${OriginStreamName}", "encodes": { "videos": [ { "bypass": true } ], "audios": [ { "bypass": true } ] } } ] } ]
GET
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps
Lists all application names in the VirtualHost
Request Example:
GET http://1.2.3.4:8081/v1/vhosts/default/apps
GET
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}
Gets the configuration of the Application
Request Example:
GET http://1.2.3.4:8081/v1/vhosts/default/apps/app
PUT
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}
Changes the configuration of the Application
Request Example:
PUT http://1.2.3.4:8081/v1/vhosts/default/apps/app
{
"type": "live"
}
DELETE
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}
Deletes the Application
Request Example:
DELETE http://1.2.3.4:8081/v1/vhosts/default/apps/app
POST
http://<OME_HOST>:<API_PORT>/v1/vhosts
Creates VirtualHost
s
Request Example:
POST http://1.2.3.4:8081/v1/vhosts
[ { "name": "default" } ]
Return type: Response<VirtualHost>
GET
http://<OME_HOST>:<API_PORT>/v1/vhosts
Lists all virtual host names
Request Example:
GET http://1.2.3.4:8081/v1/vhosts
Return type: Response<List>
GET
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}
Gets the configuration of the VirtualHost
Request Example:
GET http://1.2.3.4:8081/v1/vhosts/default
POST
http[s]://{Host}/v1/vhosts/<vhost_name>/apps/<app_name>/streams/<stream_name>:startHlsDump
Body
outputStreamName (required)
The name of the output stream created with OutputProfile.
id (required)
ID for this API request.
outputPath (required)
Directory path to output. The directory must be writable by the OME process. OME will create the directory if it doesn't exist.
playlist (optional)
Dump the master playlist set in outputPath. It must be entered in Json array format, and multiple playlists can be specified.
infoFile (optional)
This is the name of the DB file in which the information of the dumped files is updated. If this value is not provided, no file is created. An error occurs if a file with the same name exists. (More details below)
userData (optional)
If infoFile is specified, this data is written to infoFile. Does not work if infoFile is not specified.
POST
http[s]://{Host}/v1/vhosts/<vhost_name>/apps/<app_name>/streams/<stream_name>:stopHlsDump
Body
outputStreamName (required)
The name of the output stream created with OutputProfile.
id (optional)
This is the id passed when calling the startHlsDump API. If id is not passed, all dump in progress at outputStreamName is aborted.
The info file is continuously updated after the dump file is written. It is in XML format and is as follows. will continue to be added.
GET
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}/streams
Lists all stream names in the Application
Request Example:
GET http://1.2.3.4:8081/v1/vhosts/default/apps/app/streams
GET
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}/streams/{stream_name}
Gets the configuration of the Stream
Request Example:
GET http://1.2.3.4:8081/v1/vhosts/default/apps/app/streams/stream
POST
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}/outputProfiles
Creates OutputProfile
s in the Application
Request Example:
POST http://1.2.3.4:8081/v1/vhosts/default/apps/app/outputProfiles
[
{
"name": "bypass_profile",
"outputStreamName": "${OriginStreamName}",
"encodes": {
"videos": [
{
"bypass": true
}
],
"audios": [
{
"bypass": true
}
]
}
}
]
GET
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}/outputProfiles
Lists all output profile names in the Application
Request Example:
GET http://1.2.3.4:8081/v1/vhosts/default/apps/app/outputProfiles
GET
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}/outputProfiles/{profile_name}
Gets the configuration of the OutputProfile
Request Example:
GET http://1.2.3.4:8081/v1/vhosts/default/apps/app/outputProfiles/bypass_profile
PUT
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}/outputProfiles/{profile_name}
Changes the configuration of the OutputProfile
Request Example:
PUT http://1.2.3.4:8081/v1/vhosts/default/apps/app/outputProfiles/bypass_profile
{
"outputStreamName": "${OriginStreamName}",
"encodes": {
"videos": [
{
"codec": "h264",
"bitrate": "3M",
"width": 1280,
"height": 720,
"framerate": 30
}
],
"audios": [
{
"bypass": true
}
]
}
}
DELETE
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}/outputProfiles/{profile_name}
Deletes the OutputProfile
Request Example:
DELETE http://1.2.3.4:8081/v1/vhosts/default/apps/app/outputProfiles/bypass_profile
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 |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
The can be controlled with this API.
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 |
---|
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 |
---|
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
authorization
string
A string for authentication in Basic Base64(AccessToken)
format.
For example, Basic b21lLWFjY2Vzcy10b2tlbg==
if access token is ome-access-token
.
(json body)
array
A list of Application
vhost_name
string
A name of VirtualHost
authorization
string
A string for authentication in Basic Base64(AccessToken)
format.
For example, Basic b21lLWFjY2Vzcy10b2tlbg==
if access token is ome-access-token
.
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
.
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
.
(json body)
object
Application
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
.
authorization
string
A string for authentication in Basic Base64(AccessToken)
format.
For example, Basic b21lLWFjY2Vzcy10b2tlbg==
if access token is ome-access-token
.
(json body)*
array
A list of VirtualHost
authorization
string
A string for authentication in Basic Base64(AccessToken)
format.
For example, Basic b21lLWFjY2Vzcy10b2tlbg==
if access token is ome-access-token
.
vhost_name
string
A name of VirtualHost
authorization
string
A string for authentication in Basic Base64(AccessToken)
format.
For example, Basic b21lLWFjY2Vzcy10b2tlbg==
if access token is ome-access-token
.
vhost_name | string | A name of |
app_name | string | A name of |
authorization | string | A string for authentication in |
vhost_name | string | A name of |
app_name | string | A name of |
stream_name | string | A name of |
authorization | string | A string for authentication in |
vhost_name | string | A name of |
app_name | string | A name of |
authorization | string | A string for authentication in |
(json body) | array | List< |
vhost_name | string | A name of |
app_name | string | A name of |
authorization | string | A string for authentication in |
vhost_name | string | A name of |
app_name | string | A name of |
profile_name | string | A name of |
authorization | string | A string for authentication in |
vhost_name | string | A name of |
app_name | string | A name of |
profile_name | string | A name of |
authorization | string | A string for authentication in |
(json body) | object |
|
vhost_name | string | A name of |
app_name | string | A name of |
profile_name | string | A name of |
authorization | string | A string for authentication in |
vhost_name* | string | A name of |
app_name* | string | A name of |
authorization* | string | A string for authentication in |
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 |
app_name* | string | A name of |
authorization* | string | A string for authentication in |
id* | string | An unique identifier for recording job. |
vhost_name* | string | A name of |
app_name* | string | A name of |
authorization* | string | A string for authentication in |
id | string | An unique identifier for recording job. If no value is specified, the entire recording job is requested. |
POST
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}:startPush
Example - RTMP push publishing by Output Stream Name
POST http[s]://{host}/v1/vhosts/default/apps/app:startPush
{
"id": "{unique_push_id}",
"stream": {
"name": "{output_stream_name}"
},
"protocol": "rtmp",
"url":"rtmp://{host}[:port]/{app_ame}",
"streamKey":"{stream_name}"
}
Example - MPEG TS push publishing by Output Stream Name
POST http[s]://{host}/v1/vhosts/default/apps/app:startPush
{
"id": "{unique_push_id}",
"stream": {
"name": "{output_stream_name}"
},
"protocol": "mpegts",
"url":"udp://{host}[:port]",
"streamKey":""
}
Example - Push publishing by Output Stream Name and Track Ids
POST http[s]://{host}/v1/vhosts/default/apps/app:startPush
{
"id": "{unique_push_id}",
"stream": {
"name": "{output_stream_name}",
"trackIds": [ 101, 102 ]
},
"protocol": "rtmp",
"url":"rtmp://{host}[:port]/{appName}",
"streamKey":"{stream_name}"
}
Example - Push publishing by Output Stream Name and Variant Names
POST http[s]://{host}/v1/vhosts/default/apps/app:startPush
{
"id": "{unique_push_id}",
"stream": {
"name": "{output_stream_name}",
"variantNames": [ "h264_fhd", "aac" ]
},
"protocol": "rtmp",
"url":"rtmp://{host}[:port]/{app_name}",
"streamKey":"{stream_name}"
}
* variantName means Application.OutputProfiles.OutputProfie.Encodes.[Video|Audio|Data].Name in the Server.xml configuration file.
POST
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}:stopPush
Example
POST http[s]://{host}/v1/vhosts/default/apps/app:stopRecord
{
"id": "{unique_push_id}"
}
POST
http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}/apps/{app_name}:pushes
Example
POST http[s]://{host}/v1/vhosts/default/apps/app:pushes
{
"id": "{unique_push_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 ofVirtualHost
app_name*
string
A name ofApplication
authorization*
string
A string for authentication in Basic Base64(AccessToken)
format.
For example, Basic b21lLWFjY2Vzcy10b2tlbg==
if access token is ome-access-token
id*
string
Unique identifier of push publishing
stream*
string
Output stream for push.
name*
string
Output stream name
trackIds
array
Used for push publishing specific track ids.
protocol*
string
Transport protocol [rtmp | mpegts]
url*
string
Destination URL.
streamKey*
object
Destination stream key.
variantNames
array
Used for push publishing specific variant names.
vhost_name*
string
A name ofVirtualHost
app_name*
string
A name ofApplication
authorization*
string
A string for authentication in Basic Base64(AccessToken)
format.
For example, Basic b21lLWFjY2Vzcy10b2tlbg==
if access token is ome-access-token
.
id*
string
Unique identifier of push publishing
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
Unique identifier of push publishing