Client-Side Pre-roll Ads with Live SSAI

Overview

When delivering live streams with server-side ad insertion (SSAI) using Brightcove Player, you can insert a client-side pre-roll ad. For client-side ads, this feature supports IMA ads.

Caveats

• Customers using this feature must be using Dynamic Delivery.
• Only IMA and SSAI plugins are supported (no FreeWheel).
• Currently, this feature only supports a single player on the page.

Getting started

To play a client-side IMA pre-roll ad with a live SSAI stream, follow these steps:

1. Create an SSAI-enabled live stream
2. Create a Brightcove player
3. Implement client-side pre-roll using Studio

Create an SSAI-enabled live stream

The Live module supports Server-Side Ad Insertion (SSAI) enabling server-side ads can be requested and displayed during a live stream. To create your live stream, see the following:

• Implementing Server-Side Ads in the Live Module

Create a Brightcove player

Create a new Brightcove player using the Players module. For details, see the Quick Start: Creating and Styling a Player document.

Implementing client-side pre-roll using Studio

The easiest way to configure your player for auto-failover ads is by using Studio. Once you have created an ad configuration and player, then you are ready to configure the player for auto-failover as follows:

1. Open the Players module and locate the player to which you want to add advertising functionality.
2. Click the link for the player to open the player properties.
3. In the left navigation menu, click Advertising.
4. Check the Enable Client-Side (IMA) checkbox.
5. Include the URL for your IMA Ad Tag. For this example, we will use the sample Ad Tag URL.

   

   For details about the player advertising properties, see the Configuring Player Advertising using the Players Module document.

6. Check the Enable Server-Side (SSAI) checkbox.

7. From the Select Configuration dropdown menu, select the ad configuration that you would like to associate with this player.
8. If you want overlays to display over your ads, check the Enable ad information overlays checkbox. This includes "Learn More" and ad count down overlays.

   

9. Click the Save button.
10. In the left navigation menu, click JSON Editor.

11. In the JSON editor, scroll down until you see the ad_failover: true property.

    

12. Replace the ad_failover: true property with the following:

    "ima_preroll_with_ssai": true
    

13. Your JSON editor should look similar to this:

    

14. Click Save.
15. To publish the player, click Publish & Embed... > Publish Changes.
16. Now, you are ready to publish your live event. For details, see the Implementing Server-Side Ads in the Live Module document.

Listening to player events

When using this feature, player event listeners that are bound before or during the IMA pre-roll ad will need to be re-bound before SSAI playback begins.

The ima_preroll_with_ssai feature is designed to dispose of the player after displaying the IMA3 ad. Then, another player with the same id is re-initialized. This is why events won't be triggered with the initial player.

A reasonable workaround to ensure that player event listeners are triggered is to wrap them in a player dispose event listener and a videojs setup hook which is called after a player is created.

Here is a code example:

const playerId = 'samplePlayer';
    let player = videojs.getPlayer(playerId);

    // Add ad listeners here for events during IMA3 playback
    player.on("ads-ad-started", function (evt) {
      player.log("IMA3: ads-ad-started! ", evt);
    });

     player.on("ads-ad-ended", function (evt) {
      player.log("IMA3: ads-ad-ended! ", evt);
    });

    player.on('dispose', () => {
      videojs.hook('setup', (newPlayer) => {

        // Make sure the new player is the one being created by the ima_preroll_with_ssai feature
        if (newPlayer.id() !== playerId) {
          return;
        }

        player = newPlayer;

        // Add ad listeners here for events during SSAI playback
        player.on("ads-ad-started", function (evt) {
          player.log("SSAI:ads-ad-started! ", evt);
        });

        player.on("ads-ad-ended", function (evt) {
          player.log("SSAI: ads-ad-ended! ", evt);
        });

        player.on("bcov-ssai-click-through", function (evt) {
          player.log("SSAI: bcov-ssai-click-through! ", evt);
        });
      });
    });