Skip to main content

Send Event

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.

Request​

POST v1/vhosts/{vhost}/apps/{app}/streams/{stream}:sendEvent
Authorization: Basic {credentials}

# Authorization
    Credentials for HTTP Basic Authentication created with <AccessToken>

Body​

{
  "eventFormat": "id3v2",
  "eventType": "video",
  "startOffset": 0,
  "events":[
      {
        "frameType": "TXXX",
        "info": "OvenMediaLabs",
        "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 video type. 
  audio inserts events only on tracks of audio type.
# startOffset (Optional, Default : 0)
  How long (in ms) from the current stream position to delay the event. 
  Negative values are not allowed, and the maximum is 300000. 
  Events are placed in the order they are sent, so an event that would land 
  at or before the previous one is refused.
# 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.

Responses​

200 Ok

The request has succeeded

Header​

Content-Type: application/json

Body​

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

# statusCode
	Same as HTTP Status Code
# message
	A human-readable description of the response code
# response
	Json array containing a list of stream names
400 Bad Request

Invalid request. Body is not a Json Object or does not have a required value

401 Unauthorized

Authentication required

Header​

WWW-Authenticate: Basic realm=”OvenMediaEngine”

Body​

{
    "message": "[HTTP] Authorization header is required to call API (401)",
    "statusCode": 401
}
404 Not Found

The given vhost name or app name could not be found.

Body​

{
    "statusCode": 404,
    "message": "Could not find the application: [default/non-exists] (404)"
}
409 Conflict

The stream has not started sending media yet, so there is no position to place the event at, or the event would land at or before one already sent.

Body​

{
    "statusCode": 409,
    "message": "Media has not started yet: [default/app/stream] (409)"
}
{
    "statusCode": 409,
    "message": "An event is already placed at or after this position, so events must be sent in order: [default/app/stream] (409)"
}