The LLHLS Dump feature can be controlled with this API.
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.
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.
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
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
.
vhost_name
string
A name of VirtualHost
app_name
string
A name of Application
stream_name
string
A name of Stream
authorization
string
A string for authentication in Basic Base64(AccessToken)
format.
For example, Basic b21lLWFjY2Vzcy10b2tlbg==
if access token is ome-access-token
.