Event Forwarding Exclusions

The Event Forwarding feature is an API that determines, at a specific Application in OvenMediaEngine, whether various events are forwarded to the next processing stage (internal or external). It allows you to control whether events generated by multiple Providers such as WebRTC, RTMP, OVT, and SRT are passed next stage, and it is mainly used for security hardening and operational policy control.

API Interface

Configuring Event Forwarding Exclusions

By default, Event Forwarding is enabled for all events. If you need to block specific event format(s) when forwarding events, you can specify them using the setEventForwardPolicy API.

This policy applies to all egress streams within the target Application.

Request

POST /v1/vhosts/{vhost}/apps/{app}:setEventForwardPolicy

Header

Authorization: Basic {credentials}

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

Body

{
    "dropEvent" : ["amf", "scte35"]
}

Response

200 Ok

The request has succeeded

Header

Content-Type: application/json

Body

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

Parameter	Input Type	Description
dropEvent	Array	A list of event format(s) to exclude from forwarding. amf, scte35, id3v2, webvtt, cue, oven_event

warning

Events generated directly by you via the REST API or the EventGeneration XML configuration are delivered regardless of this configuration.

Querying Event Forwarding

Request

GET /v1/vhosts/{vhost}/apps/{app}:EventForwardPolicy

Header

Authorization: Basic {credentials}

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

Response

200 Ok

The request has succeeded

Header

Content-Type: application/json

Body

{
    "message": "OK",
    "response": {
      "dropEvent" : ["amf", "scte35"]
    }
    "statusCode": 200
}