Fixes

• Address issue where ads can prevent content autoplay
• Adjust ad audio playback tracking behavior for analytics with new versions of the IMA SDK
• Fix missing ad pod index analytics data before an ad starts

Fixes

• This release fixes an issue where the continuous play mode in playlists did not behave as expected when using IMA ad requests with the "onplay" setting.

• Improve event interrogation before passing data to ad insights
• Address an issue when serverUrl returns an falsey value, preventing content to autoplay

• Revert fix in 5.4.4 due to regression involving malformed URL

• Fix an issue where the plugin attempted to load the IMA SDK over the incorrect protocol

Package updates

• Update videojs-contrib-ads to v7.5.2.

• Address autoplay and viewability setting incompatibilities for playerMode features

• Fix an issue where ad data was not sent in ad_error beacons

Features

• Add support for a new playerMode option that can be used with videojs-contrib-ads

Package Updates

• Update videojs-contrib-ads to 7.5.0

Features

• Passes IMA3 Errors to the player using the video.js contrib-ads error interface.

Fixes

• Provides detailed ad info with the adserror event.

• Fix a misalignment in the ad loading spinner animation

• More robust handling of document.referrer and window.location when processing ad macros.

Fixes

• Configuration for omidAccessModeRules has been brought into line with the latest IMA3 SDK requirements.
• Addresses an issue whereby content change during an ad break would sometimes cause a short flash of content playback before the next preroll.
• If content is changed during an ad break, the changed-to content (and any preroll) will now only play if autoplay is enabled.

• When transitioning from preroll to content playback, content on iOS skips back to the start after about 1 second of playback.

Fixes

• Address an issue introduced in IMA3 v5.2.2 where playback could not be paused/resumed by clicking on the player.

Fixes

• Address an issue introduced in IMA3 v5.2.2 where the control bar was not hidden on tap on iOS and Android

Fixes

• Address an issue on iOS and Android where the 'Skip Ad' button had to be double-clicked to skip an ad

Fixes

• Address an issue where an unexpected value is provided for ads_ad_play_duration parameter, which was causing a console error.
• Address an issue where an unexpected value is provided for ads_pod_time_offset parameter, which was causing a console error and the ad UI to display an incorrect value for the duration of postroll ads.

• Adds support for the accountId macro. Including {accountId} in the call to the ad server will expand to include the accountId of the player. For example: https://www.ad.server.com/?accountId={accountId} would expand to https://www.ad.server.com/?accountId=123456879

• Populates Brightcove analytics ad_ beacons with parameters facilitating ad insights reporting

Fixes

Fixes an issue that caused ads not to show when player appears in a cross-origin iframe.

Fixes

Fixes an issue with rebuffering at the end of content in cases where postroll ads are not available.

Fixes

Fixes an issue with rebuffering at the end of content in cases where postroll ads are not available.

Features

When used alongside a version of the player that supports ad insights beacons, an ad_begin beacon will be fired whenever an ad starts, and ad_complete will be fired whenever an ad completes playback or is skipped.

Bug Fixes

• Fixes an issue where CSS from other packages would not load, resolving problems with styling.

The minimum compatible player version for this version of the IMA plugin is v7.0.0.

Backward Incompatible Changes

• From this version, the build output of this plugin targets modern browsers and drops support for older ones, such as IE 11.

Features

• Add support for a SpringServe {{US_PRIVACY}} macro for CCPA compliance.

Bug Fixes

• Fixes an issue with rebuffering at the end of content in cases where postroll ads are not available.

Package Updates

• Update video.js to 8.3.0.
• Update videojs-contrib-ads to 7.3.1.

Features

• Add support for new SpringServe macros

Bug Fixes

• Revert deprecation warning changes from 4.2.8 to fix player version 6 compatibility.
• Ensure SDK URL includes protocol for IMA's validation.

Chores

• Update plugin to remove deprecated functionality from older versions of video.js.

Bug Fixes

• Fix an issue where the player fails to continue playing on ad timeouts.

Bug Fixes

• Fix an issue where the content's playback speed change carries into ad playback in Safari

Bug Fixes

• An instance of the IMA AdsRenderingSettings class will now be passed to the AdsManager's updateAdsRenderingSettings method, instead of a plain object.

Bug Fixes

• Fix errors when making subsequent 'ondemand' ad requests during ad playback

Bug Fixes

• Prevent on-demand ad requests when player ad lifecycle has entered 'AdsDone' state at the end of a video.

Bug Fixes

• Fix an issue where the IMA3 plugin unexpectedly pauses playback in between media content in a playlist where continuous play mode (or autoadvance) has been configured.

Bug Fixes

• Fix an issue where ad VMAP data generated from media que points would be incorrectly inherited across multiple videos in a playlist.

Features

• Add an ads-before-request event that is dispatched before an ad request is made

Fixes

• Fix control bar issues when using the IMA3 plugin and SSAI plugin ad failover
• Fix VPA value for videos in a playlist
• Prevent player.ads.isAdPlaying is not a function error from middleware when ads are not initialised

Bug Fixes

• Fix an issue where preroll and content would play simultaneously in a playlist

Features

OM Access Modes

Adds mechanism to set different OM access modes for different verification scripts. The access rules can be set via the omidAccessModeRules plugin option as follows:

{
    omidAccessModeRules: {
        "FULL": ["exampleRegexPattern1"],
        "DOMAIN": ["exampleRegexPattern2", "exampleRegexPattern3"],
        "LIMITED": []
    }
}

Note: To enable OMID, the enableOmidBeta feature flag must be set to true and it can be set via the the ima3SdkSettings plugin option:

{
    "featureFlags": {
        "enableOmidBeta": true
    }
}

This release focuses on simplifying the autoplay behavior of the IMA3 plugin and supporting the full range of possible values offered by Video.js. And its resolves some issues with interactions between the IMA3 plugin and playlists.

For heavily customized integrations, we've included a short migration guide below, which will also be available in the Brightcove support documentation soon. For basic integrations, the upgrade should be seamless.

A full list of backward incompatible changes and a migration guide follows:

Backward Incompatible Changes

• Removes an internal dependency on the can-autoplay library and changes autoplay behavior to add support for Video.js "any", "play", and "muted" values. This includes the removal of the following properties:
  • player.ima3.canAutoPlayVideo
  • player.ima3.canAutoPlayMutedVideo
  • player.ima3.canAutoPlayMutedInlineVideo
• Removes the player.ima3.adPlayer and player.ima3.adControlBar components and replaces them with a middleware-based UI for ad playback.
• Removes the player.ima3.adTech property.
• Removes the usePlayerAutoplayHandling option.
• Removes the adTechOrder option as Flash is no longer supported.
• Removes the debugContribAds option
• Removes an older naming scheme for videojs-ima3 distributed files (videojs.ima3.x).

Migration Guide

The minimum compatible player version for this version of the IMA plugin is v6.59.1.

Previous versions of the IMA3 plugin would treat autoplay: true as autoplay: "any" - falling back to muted autoplay if unmuted didn’t work. This is no longer the case. Instead, full control is granted to publishers who are able to select their preferred autoplay behavior. All possible Video.js autoplay values are supported.

In order to emulate the fallback behavior of the IMA3 plugin 3.x, use autoplay: "any".

Additional Steps to Migrate

• Remove references to player.ima3.adPlayer and player.ima3.adControlBar from custom integration code.
  • Any previously existing adPlayer method calls (ex. adPlayer.currentTime(), adPlayer.duration()) should be replaced with method calls on the player (ex. player.currentTime(), player.duration()), which will now pass through Video.js middleware.
  • For example, during content playback, player.currentTime() will return the current playhead position within the content. During ad playback, the same method will return the current playhead position within the ad.
• Remove references to the player.ima3.adTech property, which no longer has a use and has been removed.
• Use the debug option instead of debugContribAds.
• Remove the usePlayerAutoplayHandling and adTechOrder options as they now do nothing.

Features

TCF Macros

Adds support for consent string and other TCF metadata generated by a consent management platform for GDPR.

This will add a macro for any property of the tcData object. Most notable are {tcf.gdprApplies} and {tcf.tcString} which return whether GDPR applies to the session (broadly, is the browser in Europe) and the current consent string.

Additionally {tcf.gdprAppliesInt} returns {tcf.gdprApplies} as an integer, as this seems more commonly expected by ad servers.

See videojs-contrib-ads documentation for more details.

Fixes

• Resolves an issue where the plugin could get stuck in a preroll state on certain ad error events.
• Fix adtimeouts when IMA SDK fails to load due to ad blocker or network issues.

Debug Mode

Adds a debug option as well as integrating with the player-level debug mode. Also, adds many helpful logging statements.

Autoplay Updates

By default, the plugin will now use its own autoplay handling.

In 3.4.3, we silently introduced a change to use the player's built-in autoplay handling instead of that build. This was invisible to most users, but it seems to have caused some edge cases issues with certain advanced customer integrations.

As such, in 3.7.0, this is no longer the default behavior. However, the previous (3.4.3 through 3.6.2) behavior can be restored by passing usePlayerAutoplayHandling: true in options for the IMA3 plugin.

Bug Fixes

• Revert autoplay fix from 3.6.1 to fix click-to-play behavior

Bug Fixes

• Fix mute toggle button not working in iOS Ad player with autoplay and preroll
• Fix autoplay with play promise sending the correct values for vpa and vpmute with vpaidMode:'Enable'

Features

• Upgrade to videojs-contrib-ads 6.7.0, which implements support for some new macros.