API for sending LLHLS ID3v2 Timed Metadata

[getroot]

An API has been released that 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 /v1/vhosts/{vhost name}/apps/{app name}/streams/{stream name}:sendEvent

POST /v1/vhosts/default/apps/app/streams/stream:sendEvent
{
  "eventFormat": "id3v2",
  "eventType": "video",
  "events":[
      {
        "frameType": "TXXX",
        "info": "AirenSoft",
        "data": "OvenMediaEngine"
      },
      {
        "frameType": "TIT2",
        "data": "OvenMediaEngine 123"
      }
  ]
}

eventFormat
 Currently only id3v2 is supported.

eventType (Optional, Default : event)
  Select one of event, video, and audio. 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.

How to listen for events in OvenPlayer

Most HLS players support ID3v2 Timed Metadata events. In the case of hls.js, events can be received with Hls.Events.FRAG_PARSING_METADATA. Example code is below.

// Initialize OvenPlayer
const player = OvenPlayer.create('player', {
    sources: [
        {
            type: 'hls',
            file: 'https://xxxx/xxxx/xxxx.m3u8'

        }
    ]
});

this.player.on('hlsPrepared', function (hls) {
                        hls.on(Hls.Events.FRAG_PARSING_METADATA, function (data, meta) {
                            console.log(data, meta);
                            if (meta && meta.samples) {
                                meta.samples.forEach(function (sample) {
                                    console.log(new TextDecoder("utf-8").decode(sample.data))
                                })
                            }

                        });
                    });

[stevespaw]

Is this a path to SCTE35 insertion? :-)

[Alazaren]

Could you please clarify, is there a limit on the number of events that can be sent per second?
From my observation, it seems like there could be a limit of about two events per second. Even though the content of each push is different, the data in the stream appears duplicated, with only two unique events being processed per second. But the amount of event is correct.

[getroot]

There is no limit to how much you can send per second. If you think this is a bug, please post a detailed description of how to reproduce it on the issue board.