Integrating IMA Client Side with Brightcove Web & Smart TV SDK

Overview

IMA Client-Side allows for the easy integration of video advertising into your media players built with the Brightcove Web & Smart TV SDK. The IMA3 integration facilitates pre-roll, mid-roll, and post-roll ad placements, as well as sophisticated ad management capabilities.

Prerequisites

• A Brightcove account with access to Video Cloud.

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

• Access to the Google IMA SDK resources and an Ad Manager account.

Usage Example

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

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

2. Import the IMA Client-Side integration class from the Brightcove SDK.

   import { ImaClientSideIntegrationFactory } from '@brightcove/web-sdk/integrations/imaClientSide';
               

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

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

4. Setup ima-client-side integration.

   IntegrationsManager.registerImaClientSideIntegrationFactory(ImaClientSideIntegrationFactory);
               

5. Create and Configure the Player.

   const player = new Player({accountId:'<account-id>'});
   
    player.updateConfiguration({
      integrations: {
        imaClientSide: {
          serverUrl: '<ad-tag-url>',
          requestMode: 'onload',
          hardTiemouts: 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 IMA Client Side Integration API via the IntegrationsManager:

   const { imaClientSideIntegration } = player.getIntegrationsManager();
               

8. Call CSAI-specific methods

   imaClientSideIntegration.isVpaid();
               

Configuration Summary

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

Public Methods Summary

Event Summary

Error Summary