OptiView Ads SDK

The API reference for the OptiView Ads Web SDK version 1.0.0-beta.4.

The OptiView Ads SDK for web integrates ad playback with your video player. Use it to configure Server-Guided Ad Insertion (SGAI) or Server-Side Ad Insertion (SSAI), manage monetization sessions, respond to playback events, and troubleshoot your integration.

This API reference documents the SDK's classes, configuration options, events, and data types. Import them from @dolby-optiview/ads-sdk.

Getting started

1. Follow the Getting Started guide for installation and a complete integration example.
2. Connect your content player through a PlayerAdapter, then create an OptiViewAds instance with OptiViewAdsConfig. The web SDK includes a default ad player; you only need CreateAdAdapter for a custom ad player.
3. Subscribe with OptiViewAds.addEventListener before calling OptiViewAds.startSession. Use SessionConfig for a break-manifest session or SsaiSessionConfig for a stitched stream.
4. Use OptiViewAds.onDiagnostic to verify the integration and OptiViewAds.exportDiagnostics to capture a support report. Call OptiViewAds.endSession when switching content, or OptiViewAds.destroy when the SDK is no longer needed.

Browse by topic

• SDK & Sessions — start here for the SDK entry point and per-content session options.
• Configuration — choose insertion and preload modes, audio behavior, and ad-service settings.
• Events — find event names, typed payloads, and break status for your player UI.
• Player Integration — connect a supported player or implement a custom player adapter.
• Break Manifests & Ad Formats — understand break schedules, layouts, assets, and targeting.
• Manifest Customization — customize manifest requests and responses, and register asset-parameter macros.
• Diagnostics — configure diagnostic capture, handle records, and export reports for troubleshooting.