diff --git a/ads/concepts/breaks.mdx b/ads/concepts/breaks.mdx index 807fd3b07d38..3ea343cf50d9 100644 --- a/ads/concepts/breaks.mdx +++ b/ads/concepts/breaks.mdx @@ -175,7 +175,7 @@ A `start` break is a **pre-roll**: it fires when content playback begins, once p #### Pause -A `pause` break is a **pause ad**: it fires every time the viewer pauses playback and is dismissed when the viewer resumes. Use it to monetize the pause screen, typically with an image overlay. With a `delay`, the break appears after the viewer has been paused for that many seconds. If the viewer resumes before the delay elapses, it cancels the pending break. When multiple `pause` breaks are defined, each pause shows the next one in order. +A `pause` break is a **pause ad**: it fires when the viewer pauses playback and is dismissed when the viewer resumes. Use it to monetize the pause screen, typically with an image overlay. With a `delay`, the break appears after the viewer has been paused for that many seconds. If the viewer resumes before the delay elapses, it cancels the pending break. When multiple `pause` breaks are defined, each pause shows the next one in order. After the last one has been shown, further pauses show no pause ad. #### End diff --git a/ads/player-integration/optiview-ads-sdk/index.mdx b/ads/player-integration/optiview-ads-sdk/index.mdx index 71a1501ca7d6..0c6b0e6923ca 100644 --- a/ads/player-integration/optiview-ads-sdk/index.mdx +++ b/ads/player-integration/optiview-ads-sdk/index.mdx @@ -54,10 +54,21 @@ The SDK also exposes optional presentation settings — such as ad preloading, b ### Session configuration -| Property | Description | -| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `manifestUrl` | The channel's Break Manifest URL. **Required.** See [Retrieving the required values](#retrieving-the-required-values). | -| `assetParameters` | Session-level ad targeting parameters: appended to static asset and VAST tag URLs, or sent to Google as `adTagParameters`. See [Ad targeting parameters](../../how-to-guides/ad-tag-parameters.mdx). | +| Property | Description | +| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `manifestUrl` | The channel's Break Manifest URL. **Required**, unless `manifestUrlDiscovery` is enabled in the SDK configuration and the content player discovers the manifest URL itself (THEOplayer with a THEOlive source). See [Retrieving the required values](#retrieving-the-required-values). | +| `assetParameters` | Session-level ad targeting parameters: appended to static asset and VAST tag URLs, or sent to Google as `adTagParameters`. See [Ad targeting parameters](../../how-to-guides/ad-tag-parameters.mdx). | + +## Scheduled ad breaks + +To draw ad markers on your scrubber, read the breaks scheduled for the current viewer with `getScheduledBreaks()` and listen for the `scheduledbreakschange` event, which fires whenever the list changes (for example after a manifest update, when a break has played, or with an empty list when the session ends). Each entry has an `id`, a `position`, a start (`startSec` in content seconds, or `startDate` for wallclock breaks), a `durationSec` and a `played` flag. + +```js +renderMarkers(sdk.getScheduledBreaks()); +sdk.addEventListener('scheduledbreakschange', ({ breaks }) => renderMarkers(breaks)); +``` + +The same API is available on Android, iOS and React Native. ## Retrieving the required values diff --git a/ads/player-integration/optiview-ads-sdk/ios.mdx b/ads/player-integration/optiview-ads-sdk/ios.mdx index 5ec916aff2d6..f595ad377a24 100644 --- a/ads/player-integration/optiview-ads-sdk/ios.mdx +++ b/ads/player-integration/optiview-ads-sdk/ios.mdx @@ -90,7 +90,8 @@ The `THEOplayerAdapter` wraps a `THEOplayer` instance. Ads are rendered in an ov **Limitations:** -- Requires the THEOplayer iOS SDK 11 or later and a valid THEOplayer license. +- Requires the THEOplayer iOS SDK 11.15.0 or later and a valid THEOplayer license. +- To let the SDK use the ads manifest URL that THEOplayer discovers for a THEOlive source, enable `manifestUrlDiscovery` and link the `THEOplayerTHEOliveIntegration` product. ### AVPlayer diff --git a/ads/player-integration/optiview-ads-sdk/roku.mdx b/ads/player-integration/optiview-ads-sdk/roku.mdx index a8b4ea8c3d68..7b1f6ff2d8df 100644 --- a/ads/player-integration/optiview-ads-sdk/roku.mdx +++ b/ads/player-integration/optiview-ads-sdk/roku.mdx @@ -114,9 +114,28 @@ m.player.source = { The player only starts the integration for sources with this `ssai` description, and the integration accepts the source only while the SDK session is active. Do not call the integration's functions yourself; the player invokes them. Destroying the player with `player.callFunc("destroy")` tears the integration down; destroy the `OptiViewAds` node afterwards. See the [Roku API reference](pathname:///ads/v2/api-reference/roku/#component-OptiViewAdsSDKIntegration) for details. +## Using the THEOlive discovery interceptor + +For THEOlive channels with server-side ad insertion, set `OptiViewAds:OptiViewAdsInterceptor` as the player's discovery response interceptor. It replaces the stream the player discovers with the stream the SDK obtained for the session. Bind `adsSdk` before calling `startSession`, and pass the THEOlive channel ID as `contentUrl`: + +```brightscript +m.interceptor = createObject("roSGNode", "OptiViewAds:OptiViewAdsInterceptor") +m.interceptor.adsSdk = m.ads +m.player.theoLive.discoveryResponseInterceptor = m.interceptor +m.ads.callFunc("startSession", { contentUrl: theoLiveChannelId, manifestUrl: breakManifestUrl }) +``` + +On the `ready` result, set the source with the integration kind: + +```brightscript +m.player.source = { sources: [{ src: theoLiveChannelId, type: "theolive", ssai: { integration: "optiview-ads-sdk" } }] } +``` + +Reset `discoveryResponseInterceptor` and `adsSdk` to `invalid` when you tear the player down. See the [Roku API reference](pathname:///ads/v2/api-reference/roku/#component-OptiViewAdsInterceptor) for details. + ## Events and configuration -Subscribe to ad and diagnostic events with the same `addEventListener` pattern. Each listener owner must expose its callback as an interface function. Remove a listener with `removeEventListener`, using the same event type, owner, and function name. +Subscribe to ad and diagnostic events with the same `addEventListener` pattern. While an ad plays, the SDK emits `adtimeupdate` every 0.25 seconds with the ad's `currentTime` and `duration`, for server-guided and server-side ad insertion. Ad and break events carry an `eventId` when a channel event applies. Each listener owner must expose its callback as an interface function. Remove a listener with `removeEventListener`, using the same event type, owner, and function name. The SDK also exposes session configuration, ad targeting updates, status snapshots, and capability information. See the [Roku API reference](pathname:///ads/v2/api-reference/roku/) for the full interface. diff --git a/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 b/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 index 1ff535e98cdb..32479fd66b30 100644 --- a/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 +++ b/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 @@ -
1.4.0 +
1.6.0