Page Summary
-
Numeric gaps may exist in the release sequence numbers due to periodic skipped numbers.
-
Recent releases include support for companion ads, pod serving streams, and various bug fixes related to ad events and display.
-
Updates have been made to improve ad event reporting accuracy, particularly when users skip or seek through ad breaks.
-
Several new APIs have been added to support different stream types, ad request configurations, and access to ad information.
-
Support for skippable ads, Roku Watermark, and Google Cloud Video Stitcher API have been introduced in earlier versions.
- Adds
Companion.adSlotIdandCompanion.companionClickThroughproperties to support companion ads for Pod Serving streams. - Fixes an issue where the completed beacons failed to send for all ads except the last ad in an ad pod.
- Fixes a bug where the
COMPLETEad event was reported when the ad was skipped. Ad events are now more accurately reported when users seek through ad breaks. - Removes IMA behavior of focusing the UI container after IMA removes the ad UI.
- Fixes an issue where ad break started and ad started events fire at the incorrect time, such as when the content resumes.
- Fixes an issue where invalid ad duration values cause a runtime error,
'Dot' Operator attempted with invalid BrightScript Component or interface reference.
- Makes public the
player.streamInitialized()method which is called when a stream is initialized. - Updates IMA behavior to not fire the
COMPLETEDevent when users skip an ad. The SDK still fires theSKIPPEDevent when users skip ads. This change toCOMPLETEDevent behavior now matches the behavior of other IMA SDKs. - Improves message handling for pod serving streams.
- Fixes an issue where the ad UI stretched on Full HD streams.
- Fixes an issue where initial pre-roll ad events were delayed.
- Fixes the
Divide by Zeroedge case runtime error related to ad icons.
- Adds improvements to
currentAd.currentTimeto align thecurrentTimevalue to the time when the ad event is fired. - Fixes an issue where certain ad events intermittently did not fire.
- Adds the optional Ad Manager network code parameter for full-service DAI stream requests. Including the parameter lets IMA behavior change to match Ad Manager settings such as programmatic limited ads being disabled.
- Adds VOD stream support for
streamManager.loadThirdPartyStream(). - Updates
AdBreakInfo.podIndexfor live streams. This value now returns the break ID as the pod index for mid-rolls, or0for pre-rolls. There are no post-rolls in live streams. The value defaults to-2for live streams. - Adds support for
StreamManager.getStreamTime()andStreamManager.getContentTime()to Cloud stitching and pod serving streams. - Fixes an issue where the creative ad id and creative id values were
not included in the
AdInfo. - Fixes an issue where the Roku UI icon and skip button are incorrectly positioned.
- Adds a requirement for the
networkCodeparameter for all live and VOD stream requests. - Adds
creative_id,creative_ad_id, anddeal_idto theAdInfoclass. - Adds support for custom VAST tracking events such as skip shown, skip, and click-through.
- Fixes an issue with
StreamManager.getCuePoint()for Cloud Video Stitcher VOD streams. - Fixes a capitalization in
StreamManager.createVideoStitcherVodStreamRequestWithVodConfig().
- Adds
ima.StreamRequest.createVideoStitcherVodStreamRequestWithVodConfig(). - Adds
ima.AdEvent.ICON_FALLBACK_IMAGE_SHOWNandima.AdEvent.ICON_FALLBACK_IMAGE_CLOSEDfor when the fallback image dialog is shown and closed. - Adds
ima.AdInfo.skipOffsetfor the seconds it takes an ad to become skippable. - Adds
ima.StreamRequest.videoStitcherSessionOptions. - Fixes an issue where ad period events were not called for slate.
- Adds
createPodVodStreamRequestandStreamManager.loadThirdPartyStreamfunctions for DAI Pod Serving VOD.
- Adds an optional
settingsparameter to theima.initSdkfunction for enabling and disabling SDK features.
- Fixes a bug where the app could crash when encountering invalid
adBreakInfo.
- Adds the
StreamRequest.createVideoStitcherLiveStreamRequest()andStreamRequest.createVideoStitcherVodStreamRequest()APIs to support the Google Cloud Video Stitcher API. - Updates IMA behavior to respect the value set for the
description_url=parameter. Previously, IMA would always override thedescription_url=parameter with what it detected as the correct URL, and change theurl=parameter to what had previously been set as thedescription_url=. IMA will still set thedescription_url=if it is not set in the stream's ad tag URL.
- Adds support for traditional and TrueView skippable ads.
- Adds the following ad events:
- Service release, no new features.
- Service release, no new features.
- Service release, no new features.
- Adds the following APIs for requesting specific stream types:
-
CreateLiveStreamRequest()for creating livestream requests. -
CreatePodLiveStreamRequest()for creating live pod stream requests. -
CreateVodStreamRequest()for creating VOD stream requests.
StreamRequestfor information on the parameters for each API. -
- Adds
StreamRequest.customAssetKey()andStreamRequest.networkCode()to support pod serving.
- Implements proper ID3 event parsing for Live HLS CMAF streams. This fixes an issue where ad events were being fired at incorrect times for these streams.
- Deprecates
StreamManager.onTimedMetadata(). This method is no longer documented.
- Service release, no new features.
- Service release, no new features.
- Adds
StreamManager.onTimedMetadata().
- Adds support for skippable ads.
- Updates SDK behavior to now properly ping progress events.
- Adds
StreamRequest.adUiNodefor elements like Why This Ad and Skip buttons to be placed during ads. - Removes support for
StreamManager.enableInteractiveAds(). This is now a no op. Instead, pass data from the companion ad to RAF directly.
- Adds support for DASH live streams.
- Service release, no new features.
- Service release, no new features.
- Service release, no new features.
- Service release, no new features.
- Adds
AD_PERIOD_STARTEDandAD_PERIOD_ENDEDevents toima.AdEvent. - Adds ad
PROGRESSevents toima.AdEvent. - Adds
advertiserName,universalAdIDRegistry, anduniversalAdIDValueparameters toadInfo.
- Service release, no new features.

