Key concepts

For each Content Replacement service and time slot, the end-users receive the stream with either the original or replacement content. The decision is made based on the match between the zip code or “category” specified in the client request, and the policy defined in the metadata.

Metadata must be ingested prior to the events through a secured API. Base API endpoint is https://api.broadpeak.io/v1/esni and more information on how to use the API can be found here API reference)

The API is an Event Scheduling and Notification Interface (ESNI) which is based upon the SCTE 224 standard (link).
It allows you to define audiences (for instance with a list of zip codes, each zip code being a 5-digit number) and time slots.

Please note that time slots can also be created through a dedicated API (see the Content Replacement slot section).

❗️

Important

  • End user client requests must include a zip code or a category in the Query Parameter field (see pre-requisites)
  • All API calls must be authenticated with a valid key (see Generate your API key section)

Content mapping vs slot timing behavior

Before slot starts

Within slot

After slot ends

Original content

  • Content Replacement is unconditional when no audience is defined
  • For any end-user client request not matching the zip value, original content is selected
  • For end-user client requests matching the zip value, replacement content (slot level or default) is selected

Original content

Slot vs notification timing

"Past" and "future" time points are relative to timing when the API call is received and processed by the broadpeak.io platform.

Use case

Past event (obsolete notification)

In progress event (late notification)

Future event (notification)

Description

Slot ends in the past.

Slot starts in the past but ends in the future.

Slot starts in the future and ends in the future.

Scenario

Event is already finished. Slot cannot be created.

Event has started but has not finished yet. Slot will be created for the remaining period of time.

Event has not yet started. Slot will be created for the defined period.

API call

Call is refused.

Not supported yet (coming soon)

Supported

📘

Service variants

A future release will allow the ESNI Media Id to be mapped to a set of service variants. This scheme will be based upon an optional list of streaming formats, and will, for instance, enable support for any combination of formats/versions/DRMs you may have:

  • packaging format (DASH, HLS)
  • packaging format versions (HLS v3, HLS v5, etc.)
  • DRM versions (Fairplay, PlayReady, etc.)

Did this page help you?