OptiView Ads SDK 1.2.0

ads/api/index.mdx

@@ -38,3 +38,4 @@ The [OptiView Ads SDK](../player-integration/optiview-ads-sdk/index.mdx) ships a
 - [Android API reference](pathname:///ads/v2/api-reference/android/) for the `com.dolby.optiview:ads-sdk` artifacts (Kotlin).
 - [iOS and tvOS API reference](pathname:///ads/v2/api-reference/ios/) for the `OptiViewAdsSDK` Swift packages (DocC, one module per package).
 - [React Native API reference](pathname:///ads/v2/api-reference/react-native/) for the `@dolby-optiview/ads-sdk-react-native` package.
+- [Roku API reference](pathname:///ads/v2/api-reference/roku/) for the `OptiViewAds` SceneGraph component in the `@dolby-optiview/ads-sdk-roku` package.

ads/player-integration/index.mdx

@@ -9,7 +9,7 @@ To play the ad breaks you schedule with OptiView Ads, your application needs a p
 
 ## OptiView Ads SDK (recommended)
 
-The [OptiView Ads SDK](./optiview-ads-sdk/index.mdx) lets you **bring your own player**. It handles the Break Manifest logic and ad tracking/analytics for you, while your application keeps full control over content playback. It is available for Web, Android, iOS, and React Native, with ready-made adapters for popular players.
+The [OptiView Ads SDK](./optiview-ads-sdk/index.mdx) lets you **bring your own player**. It handles the Break Manifest logic and ad tracking/analytics for you, while your application keeps full control over content playback. It is available for Web, Android, iOS, React Native, and Roku, with ready-made adapters for popular players.
 
 This is the recommended path for any new integration.
 

ads/player-integration/optiview-ads-sdk/index.mdx

@@ -11,7 +11,7 @@ The OptiView Ads SDK is the recommended way to integrate OptiView Ads into your
 - **Ad playback:** the SDK renders the scheduled ads, including the different [break layouts](../../concepts/breaks.mdx#layouts), on top of your content player.
 - **Ad tracking and analytics:** the SDK reports the ad impressions and tracking events for the ads it plays.
 
-The SDK is available for [Web](./web.mdx), [Android](./android.mdx), [iOS](./ios.mdx), and [React Native](./react-native.mdx).
+The SDK is available for [Web](./web.mdx), [Android](./android.mdx), [iOS](./ios.mdx), [React Native](./react-native.mdx), and [Roku](./roku.mdx).
 
 ## How the SDK works with your player
 

ads/player-integration/optiview-ads-sdk/roku.mdx

@@ -0,0 +1,103 @@
+---
+sidebar_position: 6
+sidebar_label: Roku
+---
+
+# OptiView Ads SDK on Roku
+
+On Roku, the OptiView Ads SDK is a SceneGraph component, `OptiViewAds`, for clear live HLS streams. Instead of a player adapter, it works with one `Video` node that your channel owns and never changes that node's source at an ad boundary:
+
+- **Client-side stitching (SGAI):** the component replaces content segments with the Google Ad Manager pod at the break times in the channel's [Break Manifest](../../concepts/break-manifest.mdx). The player plays one continuous stream.
+- **Server-side insertion (SSAI):** when the Break Manifest's delivery rule for TV devices selects SSAI, the component plays the channel's Google DAI live stream instead.
+
+## Prerequisites
+
+1. Retrieve the channel's Break Manifest URL. See [Retrieving the required values](./index.mdx#retrieving-the-required-values).
+2. For [Google Pod Serving](../../integrations/google/pod-serving.mdx), configure the Google Ad Manager `networkCode` and `customAssetKey` on the channel. The Roku SDK reads them from the Break Manifest.
+3. The content must be clear (not DRM-protected) live HLS with `EXT-X-PROGRAM-DATE-TIME` tags, in MPEG-TS or CMAF, with up to eight renditions.
+
+## Installation
+
+The SDK is published on npm as `@dolby-optiview/ads-sdk-roku`. Install it with [ropm](https://github.com/rokucommunity/ropm), the Roku package manager, and list it in `ropm.noprefix` so the component keeps the name `OptiViewAds`:
+
+```bash
+npm install ropm --save-dev
+npx ropm install @dolby-optiview/ads-sdk-roku
+```
+
+```json
+{
+  "dependencies": { "@dolby-optiview/ads-sdk-roku": "<version>" },
+  "ropm": { "noprefix": ["@dolby-optiview/ads-sdk-roku"] }
+}
+```
+
+Without `noprefix`, ropm prefixes every component and function of the package; create the node as `dolbyoptiview_adssdkroku_OptiViewAds` then. The package includes a Google IMA task component named `IMASDKTask`; if your channel already has a component with that name, install with the prefix.
+
+Without ropm, install the package with npm and copy its `channel/` folder into your channel root:
+
+```bash
+npm install @dolby-optiview/ads-sdk-roku
+cp -R node_modules/@dolby-optiview/ads-sdk-roku/channel/. <your-channel-root>/
+```
+
+The package is a component library, not a stand-alone channel. It adds `components/OptiViewAds/`, the Google IMA task under `components/Player/`, helpers under `source/` and the Break Manifest verification keys under `manifest-keys/`. Declare the Roku libraries it needs in your channel's `manifest`:
+
+```properties
+bs_libs_required=googleima3,roku_ads_lib
+```
+
+## Integration
+
+Create the component, bind your `Video` node and a node for the Google IMA ad UI, observe the result and event fields, then start a session with the channel's Break Manifest URL:
+
+```brightscript
+m.ads = CreateObject("roSGNode", "OptiViewAds")
+m.top.AppendChild(m.ads)
+m.ads.videoNode = m.top.FindNode("video")
+m.ads.adUiNode = m.top.FindNode("adUi")
+m.ads.ObserveField("operationResult", "OnAdsOperation")
+m.ads.ObserveField("sdkEvent", "OnAdsEvent")
+m.ads.ObserveField("diagnosticEvent", "OnAdsDiagnostic")
+m.ads.CallFunc("startSession", {
+    contentUrl: "https://cdn.example.com/live/master.m3u8"
+    manifestUrl: "https://us.markers.optiview.dolby.com/manifest/v1/ORG-ID/channels/CHANNEL-ID"
+})
+```
+
+`startSession` returns an operation ID. When `operationResult` reports `status: "ready"` for it, play **its `playbackUrl`** on your `Video` node; the SDK never sets the source itself:
+
+```brightscript
+sub OnAdsOperation(event as Object)
+    result = event.GetData()
+    if result.status = "ready"
+        content = CreateObject("roSGNode", "ContentNode")
+        content.url = result.playbackUrl
+        content.streamFormat = "hls"
+        m.video.content = content
+        m.video.control = "play"
+    end if
+end sub
+```
+
+From this point the SDK polls the [Break Manifest](../../concepts/break-manifest.mdx), inserts the breaks at their scheduled times, and reports the ad events and impressions from Google IMA. To verify the integration, schedule a break through the API or dashboard and confirm that it plays out.
+
+To stop, call `endSession`, stop and detach playback, then call `destroy`.
+
+All fields, functions, start configuration options, events, diagnostics and capabilities are documented in the [Roku API reference](pathname:///ads/v2/api-reference/roku/).
+
+## Supported players
+
+### Roku Video node
+
+The SDK binds the channel's own `Video` node, as shown above.
+
+**Limitations:**
+
+- Breaks need the stream's `EXT-X-PROGRAM-DATE-TIME`; a break that starts between segment boundaries starts at the nearest boundary.
+- DRM, VOD, low-latency HLS parts, pre-rolls, post-rolls, pause ads and VAST are not supported.
+- A break that fails after its ads were published ends playback; start a new session to continue.
+
+### OptiView Player (THEOplayer) for Roku
+
+THEOplayer owns its `Video` node. Bind that node (`player.callFunc("getVideoNode")`) to `videoNode`, then load the `playbackUrl` through THEOplayer's own source API instead of setting the `Video` content directly.

ads/static/ads/v2/api-reference/android/ads-sdk-adapter-test-kit/com.dolby.optiview.ads.testkit/-player-adapter-conformance-test/-player-adapter-conformance-test.html

@@ -38,7 +38,7 @@
             </a>        <button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle" type="button">Toggle table of contents
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
-        <div class="library-version" id="library-version">1.0.0
+        <div class="library-version" id="library-version">1.2.0
         </div>
         <div class="navigation-controls">
         <ul class="filter-section filter-section_loading" id="filter-section" aria-label="Target filter">

ads/static/ads/v2/api-reference/android/ads-sdk-adapter-test-kit/com.dolby.optiview.ads.testkit/-player-adapter-conformance-test/create-adapter.html

@@ -38,7 +38,7 @@
             </a>        <button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle" type="button">Toggle table of contents
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
-        <div class="library-version" id="library-version">1.0.0
+        <div class="library-version" id="library-version">1.2.0
         </div>
         <div class="navigation-controls">
         <ul class="filter-section filter-section_loading" id="filter-section" aria-label="Target filter">

ads/static/ads/v2/api-reference/android/ads-sdk-adapter-test-kit/com.dolby.optiview.ads.testkit/-player-adapter-conformance-test/delivers-volume-change-to-subscribers-and-stops-after-off.html

@@ -38,7 +38,7 @@
             </a>        <button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle" type="button">Toggle table of contents
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
-        <div class="library-version" id="library-version">1.0.0
+        <div class="library-version" id="library-version">1.2.0
         </div>
         <div class="navigation-controls">
         <ul class="filter-section filter-section_loading" id="filter-section" aria-label="Target filter">

ads/static/ads/v2/api-reference/android/ads-sdk-adapter-test-kit/com.dolby.optiview.ads.testkit/-player-adapter-conformance-test/destroy-is-idempotent.html

@@ -38,7 +38,7 @@
             </a>        <button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle" type="button">Toggle table of contents
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
-        <div class="library-version" id="library-version">1.0.0
+        <div class="library-version" id="library-version">1.2.0
         </div>
         <div class="navigation-controls">
         <ul class="filter-section filter-section_loading" id="filter-section" aria-label="Target filter">

ads/static/ads/v2/api-reference/android/ads-sdk-adapter-test-kit/com.dolby.optiview.ads.testkit/-player-adapter-conformance-test/index.html

@@ -38,7 +38,7 @@
             </a>        <button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle" type="button">Toggle table of contents
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
-        <div class="library-version" id="library-version">1.0.0
+        <div class="library-version" id="library-version">1.2.0
         </div>
         <div class="navigation-controls">
         <ul class="filter-section filter-section_loading" id="filter-section" aria-label="Target filter">

ads/static/ads/v2/api-reference/android/ads-sdk-adapter-test-kit/com.dolby.optiview.ads.testkit/-player-adapter-conformance-test/initial-state-is-live-like.html

@@ -38,7 +38,7 @@
             </a>        <button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle" type="button">Toggle table of contents
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
-        <div class="library-version" id="library-version">1.0.0
+        <div class="library-version" id="library-version">1.2.0
         </div>
         <div class="navigation-controls">
         <ul class="filter-section filter-section_loading" id="filter-section" aria-label="Target filter">

ads/static/ads/v2/api-reference/android/ads-sdk-adapter-test-kit/com.dolby.optiview.ads.testkit/-player-adapter-conformance-test/mute-is-settable-and-reflected.html

@@ -38,7 +38,7 @@
             </a>        <button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle" type="button">Toggle table of contents
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
-        <div class="library-version" id="library-version">1.0.0
+        <div class="library-version" id="library-version">1.2.0
         </div>
         <div class="navigation-controls">
         <ul class="filter-section filter-section_loading" id="filter-section" aria-label="Target filter">

ads/static/ads/v2/api-reference/android/ads-sdk-adapter-test-kit/com.dolby.optiview.ads.testkit/-player-adapter-conformance-test/preload-does-not-throw.html

@@ -38,7 +38,7 @@
             </a>        <button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle" type="button">Toggle table of contents
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
-        <div class="library-version" id="library-version">1.0.0
+        <div class="library-version" id="library-version">1.2.0
         </div>
         <div class="navigation-controls">
         <ul class="filter-section filter-section_loading" id="filter-section" aria-label="Target filter">

ads/static/ads/v2/api-reference/android/ads-sdk-adapter-test-kit/com.dolby.optiview.ads.testkit/-player-adapter-conformance-test/program-date-time-is-null-without-stream.html

@@ -38,7 +38,7 @@
             </a>        <button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle" type="button">Toggle table of contents
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
-        <div class="library-version" id="library-version">1.0.0
+        <div class="library-version" id="library-version">1.2.0
         </div>
         <div class="navigation-controls">
         <ul class="filter-section filter-section_loading" id="filter-section" aria-label="Target filter">

ads/static/ads/v2/api-reference/android/ads-sdk-adapter-test-kit/com.dolby.optiview.ads.testkit/-player-adapter-conformance-test/subscribe-and-unsubscribe-do-not-throw-for-every-event.html

@@ -38,7 +38,7 @@
             </a>        <button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle" type="button">Toggle table of contents
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
-        <div class="library-version" id="library-version">1.0.0
+        <div class="library-version" id="library-version">1.2.0
         </div>
         <div class="navigation-controls">
         <ul class="filter-section filter-section_loading" id="filter-section" aria-label="Target filter">

ads/static/ads/v2/api-reference/android/ads-sdk-adapter-test-kit/com.dolby.optiview.ads.testkit/-player-adapter-conformance-test/supports-parallel-buffering-is-boolean-or-null.html

@@ -38,7 +38,7 @@
             </a>        <button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle" type="button">Toggle table of contents
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
-        <div class="library-version" id="library-version">1.0.0
+        <div class="library-version" id="library-version">1.2.0
         </div>
         <div class="navigation-controls">
         <ul class="filter-section filter-section_loading" id="filter-section" aria-label="Target filter">

ads/static/ads/v2/api-reference/android/ads-sdk-adapter-test-kit/com.dolby.optiview.ads.testkit/-player-adapter-conformance-test/tear-down-conformance-adapter.html

@@ -38,7 +38,7 @@
             </a>        <button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle" type="button">Toggle table of contents
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
-        <div class="library-version" id="library-version">1.0.0
+        <div class="library-version" id="library-version">1.2.0
         </div>
         <div class="navigation-controls">
         <ul class="filter-section filter-section_loading" id="filter-section" aria-label="Target filter">

ads/static/ads/v2/api-reference/android/ads-sdk-adapter-test-kit/com.dolby.optiview.ads.testkit/-player-adapter-conformance-test/trigger-volume-change.html

@@ -38,7 +38,7 @@
             </a>        <button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle" type="button">Toggle table of contents
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
-        <div class="library-version" id="library-version">1.0.0
+        <div class="library-version" id="library-version">1.2.0
         </div>
         <div class="navigation-controls">
         <ul class="filter-section filter-section_loading" id="filter-section" aria-label="Target filter">

ads/static/ads/v2/api-reference/android/ads-sdk-adapter-test-kit/com.dolby.optiview.ads.testkit/-player-adapter-conformance-test/video-quality-selection-is-optional-and-safe.html

@@ -38,7 +38,7 @@
             </a>        <button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle" type="button">Toggle table of contents
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
-        <div class="library-version" id="library-version">1.0.0
+        <div class="library-version" id="library-version">1.2.0
         </div>
         <div class="navigation-controls">
         <ul class="filter-section filter-section_loading" id="filter-section" aria-label="Target filter">

ads/static/ads/v2/api-reference/android/ads-sdk-adapter-test-kit/com.dolby.optiview.ads.testkit/-player-adapter-conformance-test/volume-is-settable-and-clamped-to-unit-range.html

@@ -38,7 +38,7 @@
             </a>        <button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle" type="button">Toggle table of contents
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
-        <div class="library-version" id="library-version">1.0.0
+        <div class="library-version" id="library-version">1.2.0
         </div>
         <div class="navigation-controls">
         <ul class="filter-section filter-section_loading" id="filter-section" aria-label="Target filter">

ads/static/ads/v2/api-reference/android/ads-sdk-adapter-test-kit/com.dolby.optiview.ads.testkit/index.html

@@ -38,7 +38,7 @@
             </a>        <button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle" type="button">Toggle table of contents
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
-        <div class="library-version" id="library-version">1.0.0
+        <div class="library-version" id="library-version">1.2.0
         </div>
         <div class="navigation-controls">
         <ul class="filter-section filter-section_loading" id="filter-section" aria-label="Target filter">

ads/static/ads/v2/api-reference/android/ads-sdk-adapter-test-kit/index.html

@@ -38,7 +38,7 @@
             </a>        <button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle" type="button">Toggle table of contents
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
-        <div class="library-version" id="library-version">1.0.0
+        <div class="library-version" id="library-version">1.2.0
         </div>
         <div class="navigation-controls">
         <ul class="filter-section filter-section_loading" id="filter-section" aria-label="Target filter">