Defining Content Replacement slots

Content Replacement can be implemented using different methods. The ESNI API that follows the SCTE-224 Standard, the REST API, or the built-in scheduler on broadpeak.io's web app, which lays on the REST API.

using ESNI (scte-224) API

When working with the ESNI API, the period of time on which the content is to be replaced is defined as a MediaPoint (specific point of interest in the media) and a duration.

MediaPoints should generally be created through the time slot management API (see API section).

Here are sample API calls that you can make through the ESNI SCTE 224 API to create:

a one-minute slot on August 18, 2021 at 4.00 p.m. UTC for all users (i.e. unconditional) with the default live source as replacement content:

<Media href="YourServiceName">
  <MediaPoint id="YourMediaPointName" matchTime="2021-08-18T16:00:00Z" expectedDuration="PT0H1M">
    <Apply>
      <Policy id="1">
        <ViewingPolicy id="1">
          <action:Content>urn:scte:224:action:blackout</action:Content>
        </ViewingPolicy>
      </Policy>
    </Apply>
  </MediaPoint>
</Media>

a one-minute slot on August 18, 2021 at 4.00 p.m. UTC for Audience "area 1" defined as list of zips 25267, 26311 and 20984, with ESPN_Alt_1 live source as replacement content:

<Media href="YourServiceName">
    <MediaPoint id="YourMediaPointName" matchTime="2021-08-18T16:00:00Z" expectedDuration="PT0H1M">
        <Apply>
            <Policy id="1">
                <ViewingPolicy id="1">
                   <Audience id="Nevada" match="ANY">
                        <audience:zip>25267</audience:zip>
                        <audience:zip>26311</audience:zip>
                        <audience:zip>20984</audience:zip>                     
                    </Audience>
                    <action:Content>ESPN_Alt_1</action:Content>
                </ViewingPolicy>
            </Policy>
        </Apply>
    </MediaPoint>
</Media>

Once provisioned, you can check the metadata for:

  • The slot associated with the Mediapoint by sending a GET request for this specific MediaPoint Id
  • All slots associated with a specific Content Replacement service by sending this GET request /!\

📘

Notes

  • The Policy Id can be provisioned but is not used. A GET call will return /policy/unknown
  • The Viewing Policy Id can be provisioned but is not used. A GET call will return /vp/unknown

using the REST API

Content replacement slots, their Audience, their duration as well as the substitute content Source can be specified directly using an API call to the REST endpoint. More information can be found on the API Reference document.

using the Web app Scheduler

The web app utilizes the REST API to enable you to create slots for your Content Replacement Services. On the Services page, you will notice a calendar icon in the row - left side - of each Service. Clicking on this icon grants you access to the Scheduler page specific to that Service.

Start by typing a name for your event, then choose a Source to use as substitute content. You can use another Live, or a VOD asset. Specify a time for the replacement to start, and a time for the end or a duration. If you intend to implement different behaviors based on the Audience, you can select a category to which this replacement should apply.

Categories can also be created through the web app via the left menu "Categories".