API for LLHLS Dump

[getroot]

The LLHLS Dump feature (#902) can be controlled by API now.

Start Dump API

POST /v1/vhosts/<vhost_name>/apps/<app_name>/streams/<stream_name>:startHlsDump

{
	"outputStreamName": "stream",
	"id": "unique_dump_id",
	"outputPath": "/tmp/",
	"playlist" : ["llhls.m3u8", "abr.m3u8"],
	"infoFile": "/home/abc/xxx/unique_info_file_name.info",
	"userData": "access_key_id='AKIAXFOT7EWH3ZA4XXXX'"
}

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.

Stop Dump API

POST /v1/vhosts/<vhost_name>/apps/<app_name>/streams/<stream_name>:stopHlsDump

POST /v1/vhosts/<vhost_name>/apps/<app_name>/streams/<stream_name>:stopHlsDump
{
 "outputStreamName": "stream",
 "id": "dump_id"
}

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.

InfoFile

The info file is continuously updated after the dump file is written. It is in XML format and is as follows. <Items><Item> will continue to be added.

<HLSDumpInfo>
  <UserData>~~~</UserData>
  <Stream>/default/app/stream</Stream>
  <Status>Running | Completed | Error </Status>
  <Items>
    <Item>
      <Seq>0</Seq>
      <Time>~~~</Time>
      <File>~~~</File>
    </Item>
    ...
    <Item>
      <Seq>1</Seq>
      <Time>~~~</Time>
      <File>/tmp/abc/xxx/298182/chunklist_0_video_llhls.m3u8</File>
    </Item>
    ...
    <Item>
      <Seq>2</Seq>
      <Time>~~~</Time>
      <File>chunklist_0_video_llhls.m3u8</File>
    </Item>
  </Items>
</HLSDumpInfo>

[ArturLinnik]

I don't know why but it isn't working for me.

When I configure the LLHLS dumping it works right. The config is as follows:

            <LLHLS>
              <ChunkDuration>0.5</ChunkDuration>
              <SegmentDuration>6</SegmentDuration>
              <SegmentCount>10</SegmentCount>
              <CrossDomains>
                <Url>*</Url>
              </CrossDomains>

             <Dumps>
                <Dump>
                  <Enable>true</Enable>
                  <TargetStreamName>*</TargetStreamName>

                  <Playlists>
                    <Playlist>llhls.m3u8</Playlist>
                    <Playlist>abr.m3u8</Playlist>
                  </Playlists>
                  <OutputPath>/vods/${VHostName}_${AppName}_${StreamName}/${ISO8601}</OutputPath>
                </Dump>
              </Dumps>

            </LLHLS>

I have tried to keep these fields (although it dumps automatically my streamings) and also removing them but when I try to dump it with the API with the following body:

{
        "outputStreamName": output_stream_name,
        "id": stream_id,
        "outputPath": "/root/ome/vods/",
    }

It doesn't create anything.

I have already checked that OME has permissions for writing in that directory because the automatic dumping works and saves the files there.

The output of the API request is:

{
  "message": "OK",
  "statusCode": 200
}

which btw is strange because it should be as follows, according to the documentation:

{
	"statusCode": 200,
	"message": "OK",
	"response": [
		"stream",
		"stream2"
	]
}

And the response field doesn't appear although I am starting the dumping of the stream multiple times with different ids.

I am sure I'm doing something wrong but I don't know what and the OME's logs don't help me.

I would be very grateful if you could help me with this.

[getroot]

Please upload the full OME log file and provide the full text of your request json.

[ArturLinnik]

Thank you for your reply!

The body of my request json is:

data = {
        "outputStreamName": "SdEMoNy7n8TcGuHwUmBScZ-ptz",
        "id": 1111,
        "outputPath": "/root/ome/vods/",
    }

The OME logs when I make the request for dumping and stop it after 5 seconds:

[2023-06-05 07:18:56.999] I [SPAPISvr-t8081:31] LLHLS Publisher | llhls_stream.cpp:1124 | Start dump requested: stream_name = SdEMoNy7n8TcGuHwUmBScZ-ptz, dump_id = 1111, min_segment_number = 107
[2023-06-05 07:18:56.000] I [SPAPISvr-t8081:31] LLHLS Publisher | llhls_stream.cpp:1149 | Dump base segment : stream_name = SdEMoNy7n8TcGuHwUmBScZ-ptz, dump_id = 1111, track_id = 0, segment_number = 107, min_segment_number = 107, last_segment_number = 107
[2023-06-05 07:18:57.048] I [SPAPISvr-t8081:31] HttpServer | http_server.cpp:223  | Client(<ClientSocket: 0x7f7aec650010, #50, Disconnected, TCP, Nonblocking, 84.124.50.11:47228>) has disconnected from *:8081
[2023-06-05 07:19:00.616] I [SPAPISvr-t8081:31] HttpServer | http_server.cpp:149  | Client(<ClientSocket: 0x7f7aec650010, #50, Connected, TCP, Nonblocking, 172.20.0.5:59788>) is connected on *:8081
[2023-06-05 07:19:00.617] I [SPAPISvr-t8081:31] HttpServer | http_server.cpp:223  | Client(<ClientSocket: 0x7f7aec650010, #50, Disconnected, TCP, Nonblocking, 172.20.0.5:59788>) has disconnected from *:8081
[2023-06-05 07:19:00.617] I [SPAPISvr-t8081:31] HttpServer | http_server.cpp:149  | Client(<ClientSocket: 0x7f7af39ce010, #50, Connected, TCP, Nonblocking, 172.20.0.5:59804>) is connected on *:8081
[2023-06-05 07:19:00.618] I [SPAPISvr-t8081:31] HttpServer | http_server.cpp:223  | Client(<ClientSocket: 0x7f7af39ce010, #50, Disconnected, TCP, Nonblocking, 172.20.0.5:59804>) has disconnected from *:8081
[2023-06-05 07:19:00.618] I [SPAPISvr-t8081:31] HttpServer | http_server.cpp:149  | Client(<ClientSocket: 0x7f7aec616410, #50, Connected, TCP, Nonblocking, 172.20.0.5:59812>) is connected on *:8081
[2023-06-05 07:19:00.619] I [SPAPISvr-t8081:31] HttpServer | http_server.cpp:223  | Client(<ClientSocket: 0x7f7aec616410, #50, Disconnected, TCP, Nonblocking, 172.20.0.5:59812>) has disconnected from *:8081
[2023-06-05 07:19:01.995] I [SPAPISvr-t8081:31] HttpServer | http_server.cpp:149  | Client(<ClientSocket: 0x7f7aec616410, #50, Connected, TCP, Nonblocking, 84.124.50.11:47234>) is connected on *:8081
[2023-06-05 07:19:02.062] I [SPAPISvr-t8081:31] HttpServer | http_server.cpp:223  | Client(<ClientSocket: 0x7f7aec616410, #50, Disconnected, TCP, Nonblocking, 84.124.50.11:47234>) has disconnected from *:8081
[2023-06-05 07:19:05.614] I [SPAPISvr-t8081:31] HttpServer | http_server.cpp:149  | Client(<ClientSocket: 0x7f7aec616410, #50, Connected, TCP, Nonblocking, 172.20.0.5:59824>) is connected on *:8081
[2023-06-05 07:19:05.616] I [SPAPISvr-t8081:31] HttpServer | http_server.cpp:223  | Client(<ClientSocket: 0x7f7aec616410, #50, Disconnected, TCP, Nonblocking, 172.20.0.5:59824>) has disconnected from *:8081
[2023-06-05 07:19:05.619] I [SPAPISvr-t8081:31] HttpServer | http_server.cpp:149  | Client(<ClientSocket: 0x7f7aec64b010, #50, Connected, TCP, Nonblocking, 172.20.0.5:59840>) is connected on *:8081
[2023-06-05 07:19:05.620] I [SPAPISvr-t8081:31] HttpServer | http_server.cpp:223  | Client(<ClientSocket: 0x7f7aec64b010, #50, Disconnected, TCP, Nonblocking, 172.20.0.5:59840>) has disconnected from *:8081

[getroot]

Let's move to here : #1265

[ArturLinnik]

Hi again!

I'm using the version 0.15.10 of OME and it looks like the tag of the infoFile is not working as expected. It's always "Running".

This happens when I stop the dumping making stopHlsDump POST request and also when the stream finishes.

I have checked the releases and the only thing related I could find was the 0.15.11 release, but I understand those changes were to recordings not to hls dumping.

I hope you can help me.

Thank you!

ovenmediaengine.log