Downloads: Roku: SceneGraph

It is important that your video player project contains only a single instance of the Conviva library to avoid unexpected conflicts and run-time errors. If you're planning a player upgrade or a new release, consider upgrading the Conviva Roku library as well.

Conviva_Roku_3.5.14 (10/JUL/2026)

• Added Ad Session Heartbeat optimization (ad_shb) support — optimizes ad session heartbeat delivery on high-traffic live events when enabled by Conviva for an account; requires WSG protocol 2.8; no API changes.

• Fixed missing monitored fields (e.g. bitrate) when using monitorVideoNode() without associateVideoNode().

• Fixed exceptions when DPI is disabled (enableEco = false).

• Improved monitoring performance by reducing repeated video node field reads.

Conviva_Roku_3.5.13 (18/MAR/2026)

• Replace usage of appendString, which is deprecated in Roku OS 15.1.

• Optimized node observing to include only necessary fields on the video node.

• When settings.disableErrorReporting = true is passed to ConvivaClient(settings), no errors will be automatically reported by the Conviva sensor for neither content nor ad session. When disableErrorReporting is set to true, errors should be reported via conviva.reportContentError() and conviva.reportAdError().

• Fix for peak bitrate not being auto-collected when the video node was attached late.

Conviva_Roku_3.5.12 (10/DEC/2025)

Fixes the race condition issue in Video monitoring to switch off during endMonitoring. The endMonitoring API call now removes ConvivaPlayerMonitor task nodes from videoNode, only if DPI is disabled.

Conviva_Roku_3.5.11 (25/MAR/2025)

• Fixes an issue where the player state was incorrectly reported as NOT_MONITORED at the start of a session.

• Fixes an exception caused in the older version (3.5.9) that prevented the first video session from being created.

Conviva_Roku_3.5.9 (25/FEB/2025)

Fixes an issue where EBVS was over-reported due to mishandling of the time between video monitoring and DPI event reporting, causing inconsistencies in tracking the first video session.

Conviva_Roku_3.5.8 (18/DEC/2024)

Fixes a crash when Conviva library ran out of rourlTransfer objects due to unreachable gatewayUrl while sending data.

Conviva_Roku_3.5.6 (13/SEP/2024)

• Supports Conviva DPI Version: 0.2.12.

• Introduces the following in Conviva DPI Sensor for Roku:

• **enableEco** and **appId** fields in the settings to initialize Conviva Client.

  • setUserId() API to set the viewerId for DPI data.

  • setChannelInfo() API to set the report channel/app load time.

  • trackScreenView() API to report the screen view and changes with load times.

  • trackCustomEvent() API to report custom events.

  • trackClick() API to report button clicks.

  • trackAppError() API to report runtime errors/exceptions.

  • trackNetworkRequest() API to report network request/response data.

  • setCustomTags() API to report custom tags for building custom dimensions.

• Fixed an issue where reportAdError API always sends severity as FATAL instead of accepting the input severity.

Conviva_Roku_3.5.4 (14/MAR/2024)

• Added auto collection for the Average FrameRate.

• Fixed crash issue in processing gateway response due to invalid response.

Conviva_Roku_3.5.3 (25/OCT/2023)

• Supports IMA 3.62.0

Conviva_Roku_3.5.2 (22/AUG/2023)

• Supports Roku OS 12

• Fixes the issue of reporting Ad duration in the main content session.

Conviva_Roku_3.5.1 (19/MAY/2023)

• Fixes the application crash issue that occurred with the endMonitoring() API call.

• Code refactoring

Conviva_Roku_3.5.0 (10/APR/2023)

• Supports auto detection of audio, subtitle, and closed captions language.

• Introduces the reportPlayerSubtitleLang() API to report subtitle language for the content.

• Introduces the reportPlayerCCLang() API to report closed caption language for the content.

• Introduces the reportPlayerAudioLang() API to report audio language for the content.

Conviva_Roku_3.4.8 (26/DEC/2022)

• Fixes an issue where buffering was not reported during content underrun.

Conviva_Roku_3.4.7 (08/DEC/2022)

• The endMonitoring API call now removes any stopped ConvivaPlayerMonitor task nodes from videoNode.

Conviva_Roku_3.4.6 (07/NOV/2022)

• Supports Google DAI 3.60.0

Conviva_Roku_3.4.5 (22/SEP/2022)

• Supports Roku OS 11.5

• Supports YoSpace 3.4.2

• Supports Roku ID for Advertising (RIDA) collection.

• Fixes an issue with the YoSpace module not auto collecting the bitrate.

• Fixes an issue with server-side ad sessions not copying metrics from content sessions.

• Fixes an issue with the collection of c3.app.version when custom tags aren't set.

Conviva_Roku_3.4.1 (24/MAY/2022)

• Enhances auto detection of ad asset name, ad id, ad system and ad creativeid from the native ad Object of RAFX SSAI Adapter and adstitcher from the RAFX_SSAI constructor “name” attribute.

• Fixes the issue of setting default asset name to “No assetname detected”, if asset name is not available during Conviva Session creation.

• Fixes the issue of reportAdError() failing to report errors.

Conviva_Roku_3.3.0 (24/JAN/2022)

• Supports YoSpace 3.2.2.

Conviva_Roku_3.2.2 (04/JAN/2022)

• Supports YoSpace 1.8-13.

• Automatically collects "c3.ad.firstAdSystem", "c3.ad.firstAdId" and "c3.ad.firstCreativeId" tags.

Conviva_Roku_3.2.1 (25/NOV/2021)

• Supports Roku 10.5.0.

• Supports Google DAI 3.39.0.

• Automatically collects "c3.app.version" tag from manifest.

• Introduces a setting to disable error collection by Conviva library and allows error reporting using the reportContentError API manually.

• Introduces the reportPlayerAverageBitrate API to report average bitrate for the content as available from manifest.

Conviva_Roku_3.0.15 (10/JUN/2021)

• Supports Roku OS 10.0.

• Added log messages for indicating the missing mandatory metadata during session creation.

Conviva_Roku_3.0.13 (15/APR/2021)

• Fixed crashes specific to YoSpace integration when ad metadata is not available.

• Fixed an issue with "Unknown" connection type that occurred at start of monitoring sessions.

• Fixed an issue with errors/warnings raised by Roku static analysis tool version 7.8.7 by updating the necessary APIs available prior to Roku OS 9.2 release that were causing the issue.

Conviva_Roku_3.0.10 (23/DEC/2020)

• Supports Roku OS 9.4.

Conviva_Roku_3.0.9 (05/AUG/2020)

• Supports Roku OS 9.3.

• Support to report the tags c3.ad.firstAdId, c3.ad.firstCreativeId, and c3.ad.firstAdSystem tags for ad integrations.

• Fixes an issue with associateVideoNode API not detecting player state changes.

• Fixes the implementation of the APIs reportSeekStarted, reportSeekEnded, setOrUpdateContentInfo, and reportAdPlayerBitrate.

• notificationInterval can be set to any value between 0.1 and 1.0. Conviva library accepts notificationInterval set on video node's content metadata object. If not set, or if set to more than 1.0, notificationInterval defaults to 0.5.

• Fixes crash issue when an "empty" or "invalid" sequence is received from YoSpace SDK.

• Replaces debug logs showing adStart / addend when ads are not integrated with pauseJoin / resumeJoin.

Conviva_Roku_3.0.6 (01/APR/2020)

• Supports Roku OS 9.2 and above.

• Supports Conviva auto detection of Akamai CDN Edge Server IP address.

• Introduces setCDNServerIp() API in ConvivaClient to support manual setting of the CDN Edge Server's IP address.

• Uses latest Roku OS 9.2 APIs and Properties to improve bitrate collection. Average Bitrate metric values are not impacted by this change.

• Fixes an issue of video node not being monitored when it is an inherited component.

• Fixes an endMonitoring API issue that did not stop the monitoring of applications using scenes to monitor video nodes rather than tasks.

• Fixes an issue that caused some cases of starting mid-roll ads to trigger the end of monitoring sessions.

Conviva_Roku_3.0.5 (13/MAR/2020)

• Fixes an issue that caused sessions to not be created for subsequent assets after one asset playback finished.

Conviva_Roku_3.0.1 (14/FEB/2020)

• Introduces a major upgrade to the SDK architecture that simplifies and accelerates Conviva integration.

• Introduces ConvivaClient to simplify the integration of the SDK.

Conviva_Roku_2.151.0.36994 (22/AUG/2019)

• Introduces setCDNServerIP() API to support setting of CDN Edge Server's IP address.

Conviva_Roku_2.151.0.36990 (21/MAY/2019)

• Supports Roku OS 9.1

Conviva_Roku_2.151.0.36978 (14/MAR/2019)

• Introduces new API setPlayerState to set player states, exclusively for Ad Insights. Details are available in "Report Ad States" at Roku Scenegraph: Integrating Ad Insights page.

Conviva_Roku_2.151.0.36960 (12/DEC/2018)

• Supports Roku OS 9.0 Beta.

• Modifies sample app for multithreaded approach, which resolves issue of Conviva heartbeat not been sent during ad playback.

• Adds ability to update Resource using updateContentMetadata() API. Please review Update Content Metadata restrictions.

• Adds enhancement of sending cwsStateChange event in first heartbeat of the ConvivaContentInfo, which is set during Create Session.

• Fixes an issue where bitrate is not accurately reported when ads are enabled.

• Fixes a Roku library crash issue which occured when updating tags from non-string to string values.

• Deprecates Roku BrightScript library.

Conviva_Roku_2.146.0.36444 (21/AUG/2018)

• Supports videonode object update after session creation – adds updateVideoNode() API.

• Supports prebuffer feature.

• Supports roInt object for setting integer metadata in Conviva ContentInfo object.

• Introduces single Conviva download file for Scenegraph and Brightscript libraries.

• Fixes Roku application crash issue when the Conviva library used video.content to detect steamFormat; it now uses Roku streamInfo event.

Conviva_Roku_SgClient_2.141.0.35946 and Conviva_Roku_BrsClient_2.141.0.35946 (18/MAY/2018)

• Supports Roku OS 8.1.

• Enables updateContentMetadata() API to be used during the session lifetime.

• Fixes crash incidents due to invalid settings during Conviva library initialization.

• Improves tag handling when updateContentMetadata() API is invoked.

• Removes detection and collection of Device Identifier.

• Fixes a Smooth Streaming issue where bitrate reporting was delayed.

Conviva_Roku_SgClient_2.137.0.35367 and Conviva_Roku_BrsClient_2.137.0.35367 (14/MAR/2018)

• Supports customer specific gatewayUrl using customer's CUSTOMER_KEY.

• Introduces new APIs setPlayerSeekStart() and setPlayerSeekEnd() to accurately measure VRT and Connection Induced Buffering.

• Deprecates defaultReportingCdnName field.

• Removed detection and reporting of SSID.

• Fixes inaccurate reporting of playing state when live content is unreachable for certain live contents.

• Fixes Conviva Roku library crash incidents when the streamformat is not set during Conviva session creation.

Conviva_Roku_SgClient_2.134.0.34932 and Conviva_Roku_BrsClient_2.134.0.34932 (21/DEC/2017)

• Supports Roku OS 8.0.

• Fixes bitrate inflating issue in situations where audio and video segments contain dissimilar index sequences.

• Fixes issue where pod metrics are not reflected in Pulse (Conviva VSI).

• Fixes issue where VSF is under-reported when live content is unreachable.

• Introduces new Player Insight API, sendEvent(), to report events that are not associated with a specific monitoring session.

Conviva_Roku_SgClient_2.127.0.33941 and Conviva_Roku_BrsClient_2.127.0.33941 (11/AUG/2017)

• Support for Roku OS 7.7.

• Changed the implementation of the bitrate calculation logic for DASH and SS content.

• Integration change for moving the observeField() API from the Conviva Roku library to the application.

• Fixed an issue with parsing non JSON-formatted strings using the parseJSON() API.

• Fixed an issue with Video Restart Time (VRT) reporting during the start of playback.

• Fixed an issue of failure to report the playing state when playback continues after mid-stream failure, in cases in which there are enough chunks in the cache.

• Roku BrightScript Thread only: Integration change for moving the observeField() API from the Conviva Roku library to the application.

Conviva_Roku_SgClient_2.125.0.33575 (12/JUN/2017)

• Support for Roku OS 7.7 Beta.

• Support for DASH protocol.

Conviva_Roku_SgClient_2.124.0.33361 (18/MAY/2017)

• Support Conviva Mutable Metadata feature – added updateContentMetadata() API.

• Provided information on deprecating setCurrentStreamMetadata( API in future as new API updateContentMetadata() is added for similar functionality.

• Supports auto detection of Play Head Time, Network Connection Type and WiFi SSID friendly name.

• Removed conflict of Conviva variable convention with Roku Conviva Library.

• Updated reportError() API to be able to send FATAL/WARNING error types.

Conviva_Roku_SgClient_2.123.0.33023 (19/APR/2017)

New Features/Bug Fixes:

• Support for Roku OS 7.6.

• Fixed issue of incorrect reporting of Bitrate for HLS contents.

• Changed behavior for ContentLength to be set by the application instead of using values automatically detected by the Conviva library.

• Changed behavior of streamUrl to prioritise contentInfo values set by the application instead of values automatically detected by the Conviva library.

Conviva_Roku_SgClient_2.117.0.31695 (18/NOV/2016)

New Features/Bug Fixes:

• Conviva library support for Roku OS 7.5

• Fixed Roku Syntax Error Issue.

• Removed logging from Conviva library.

• Changed the NotificationPeriod argument of CreateSession() to a float value.

Conviva_Roku_SgClient_2.115.0.31160 (12/OCT/2016)

New Features/Bug Fixes:

• This Conviva version runs in Scene Graph Components with Roku OS 7.2.
• Introduced the Seek Induced Buffering metric in order to differentiate between Network Induced Buffering and Seek Induced Buffering.