Integrating SSAI with Brightcove Web & Smart TV SDK

Overview

Server-Side Ad Insertion (SSAI) allows you to insert ads into your video streams on the server side, providing a seamless ad experience for viewers. This guide will walk you through the process of implementing SSAI using it's API.

Prerequisites

• A Brightcove account with access to Video Cloud.

• The Brightcove Web & Smart TV SDK installed in your project.

• Have created an Ad Configuration.

Usage Example

1. Import the Player (with UI) class from the Brightcove SDK.

   import { Player, IntegrationsManager } from '@brightcove/web-sdk/ui';
               

2. Import the SSAI integration class from the Brightcove SDK.

   import { SsaiIntegrationFactory } from '@brightcove/web-sdk/integrations/ssai';
               

3. Import the SSAI integration CSS from the Brightcove SDK.

   import '@brightcove/web-sdk/integrations/ssai/styles';
               

4. Setup SSAI integration.

   IntegrationsManager.registerSsaiIntegrationFactory(SsaiIntegrationFactory);
               

5. Create and Configure the Player.

   const player = new Player({accountId:'<account-id>'});
   
    player.updateConfiguration({
      brightcove: {
        // Passing an Ad Config ID will enable the fetching of an SSAI stream from the Playback API
        adConfigId: '<valid-ad-config-id>',
      },
      ssai: {
        timeout: 30_000,
        hideOverlays: false,
        // etc
      }
    });

6. Attach the player to a mount root (DOM element in the page):

   const root = document.querySelector('#player-mount-root');
    player.attach(root);
               

7. Access the SSAI Integration API via the IntegrationsManager

   const { ssaiIntegration } = player.getIntegrationsManager();
               

8. Call SSAI-specific methods

   ssaiIntegration.seekInRelativeTime(50);
               

Configuration Summary

This section provides detailed information about the various configuration options available for Server-Side Ad Insertion (SSAI) when using the Web & Smart TV SDK.

Public Methods Summary

Event Summary

Error Summary