Display linear VPAID ads in an ad break

Last update: 2023-10-02

TVSDK supports displaying linear Video Player-Ad Interface Definition (VPAID) ads in an ad break. VPAID version 1.0 requires Flash, while version 2.0 also works with Browser TVSDK and JavaScript.

To display VPAID ads correctly, you must provide an ad container ( AdContainerView) within the MediaPlayerContext instance.

Limitations for VPAID ads:

  • VPAID ads do not necessarily have a predefined duration, given that the ad can be interactive. Therefore, the ad duration (defined by the ad server response) may not always exactly correspond to the true duration of the ad.
  • For VPAID 1.0 ads, TVSDK requires Flash player or greater installed on the device. For earlier versions of the Flash player, this feature is disabled and VPAID 1.0 ads are skipped.

To set up an ad container for displaying VPAID ads (version 1.0 or 2.0) within an ad break:

  1. Use the following sample code to set up an ad container that can show VPAID ads.

    var context:MediaPlayerContext =
      new MediaPlayerContext(_authorizedFeatureHelper.authorizedFeatures);
    adContainer = new AdContainerView();
    adContainer.x = adContainer.y = 0;
    adContainer.setSize(videoContainer.width, videoContainer.height);
    context.adContainer = adContainer;
    _player = new DefaultMediaPlayer(context);
  2. When the view resizes, reset the size on the ad container.

    adContainer.setSize(stage.stageWidth, stage.stageHeight);

    When you get a full-screen-change event and you set the new size on the ad container, pass the stage display state as follows to ensure that the player resizes correctly:

    private function onFullScreenChange(event:FullScreenEvent):void {
    if (_adContainer)
    { _adContainer.setSize(stage.stageWidth, stage.stageHeight, stage.displayState); }

On this page