Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions ads/callouts/_rebranding_notice.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
:::info OptiView Rebranding

OptiView Ads is the new name for THEOads as part of the OptiView product suite. During the transition, you may still see references to THEOads. OptiView Ads and THEOads refer to the same product.

:::
6 changes: 3 additions & 3 deletions ads/getting-started/android.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@ sidebar_custom_props: { 'icon': 'android' }

# Getting started with OptiView Ads on Android

This guide will get you started to integrate OptiView Ads in your THEOplayer Android SDK: configure the license, update dependencies and set the source description.
This guide will get you started to integrate OptiView Ads in your OptiView Player Android SDK: configure the license, update dependencies and set the source description.

## Prerequisites

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

1. You need to have a THEOplayer license which is compatible with OptiView Ads. This can be done through the [player portal](https://portal.theoplayer.com).
1. You need to have an OptiView Player license which is compatible with OptiView Ads. This can be done through the [player portal](https://portal.theoplayer.com).
2. You need a correctly deployed [OptiView Ads signaling service](signaling-service.mdx).
3. Add the THEOplayer Android SDK to your project by following our [Getting started](/theoplayer/getting-started/sdks/android/getting-started) guide. Make sure to [set up a OptiView Ads-compatible license](/theoplayer/getting-started/sdks/android/getting-started/#setting-up-the-license) in your app.
3. Add the OptiView Player Android SDK to your project by following our [Getting started](/theoplayer/getting-started/sdks/android/getting-started) guide. Make sure to [set up a OptiView Ads-compatible license](/theoplayer/getting-started/sdks/android/getting-started/#setting-up-the-license) in your app.
4. Add the OptiView Ads integration as a dependency in your module-level `build.gradle` file:
<Tabs queryString="lang">
<!-- prettier-ignore-start -->
Expand Down
8 changes: 4 additions & 4 deletions ads/getting-started/chromecast.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@ sidebar_custom_props: { 'icon': 'web' }

# Getting started with OptiView Ads on Chromecast CAF

This guide will get you started with OptiView Ads using the THEOplayer Chromecast CAF SDK.
This guide will get you started with OptiView Ads using the OptiView Player Chromecast CAF SDK.
! NOTE: Currently the Chromecast CAF SDK only supports image overlays from OptiView Ads.

## Prerequisites

1. You need to have a THEOplayer license which is compatible with OptiView Ads. This can be done through the [player portal](https://portal.theoplayer.com).
1. You need to have an OptiView Player license which is compatible with OptiView Ads. This can be done through the [player portal](https://portal.theoplayer.com).
2. You need a correctly deployed [OptiView Ads signaling service](signaling-service.mdx).
3. Your THEOplayer SDK needs to have the `theoads` feature enabled.

As of THEOplayer version 8.2.0, this feature is enabled by default in the main `theoplayer` package so we recommend to use at least this version, preferable the latest available version.
As of OptiView Player version 8.2.0, this feature is enabled by default in the main `theoplayer` package so we recommend to use at least this version, preferable the latest available version.
You can install this package with the following command:

```bash
Expand All @@ -29,7 +29,7 @@ This guide will get you started with OptiView Ads using the THEOplayer Chromecas
### Configuring the Chromecast receiver

OptiView Ads is supported using the default Chromecast Shaka player for HLS on Chromecast CAF. To enable this, before starting the Chromecast application, configure it to use Shaka.
Also, you need to load the THEOplayer Chromecast CAF SDK.
Also, you need to load the OptiView Player Chromecast CAF SDK.

Here is an example of a bare-bones CAF receiver app you can use as a starting point for basic playback without any custom UI:

Expand Down
6 changes: 5 additions & 1 deletion ads/getting-started/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@ sidebar_label: Getting Started

# Getting started with OptiView Ads

These guides provide the steps required to get started with OptiView Ads (SGAI). They cover the deployment and API integration of the Signaling Service into your existing workflow, as well as the integration of OptiView Ads into your application using various OptiView Player SDKs.
import RebrandingNotice from '../callouts/_rebranding_notice.md';

<RebrandingNotice />

These guides provide the steps required to get started with OptiView Ads. They cover the deployment and API integration of the Signaling Service into your existing workflow, as well as the integration of OptiView Ads into your application using various OptiView Player SDKs.

import DocCardList from '@theme/DocCardList';

Expand Down
6 changes: 3 additions & 3 deletions ads/getting-started/ios.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@ sidebar_custom_props: { 'icon': 'apple' }

# Getting started with OptiView Ads on iOS

This guide will get you started to integrate OptiView Ads in your THEOplayer iOS SDK: configure the license, update dependencies and set the source description.
This guide will get you started to integrate OptiView Ads in your OptiView Player iOS SDK: configure the license, update dependencies and set the source description.

## Prerequisites

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

1. You need to have a THEOplayer license which is compatible with OptiView Ads. This can be done through the [player portal](https://portal.theoplayer.com).
1. You need to have an OptiView Player license which is compatible with OptiView Ads. This can be done through the [player portal](https://portal.theoplayer.com).
2. You need a correctly deployed [OptiView Ads signaling service](signaling-service.mdx).
3. Add the THEOplayer iOS SDK to your project by following our [Getting started](/theoplayer/getting-started/sdks/ios/getting-started) guide. Make sure to [set up a OptiView Ads-compatible license](/theoplayer/getting-started/sdks/ios/getting-started/#theoplayer-license) in your app.
3. Add the OptiView Player iOS SDK to your project by following our [Getting started](/theoplayer/getting-started/sdks/ios/getting-started) guide. Make sure to [set up a OptiView Ads-compatible license](/theoplayer/getting-started/sdks/ios/getting-started/#theoplayer-license) in your app.
4. Add the OptiView Ads integration as a dependency to your project:
<Tabs queryString="lang">
<!-- prettier-ignore-start -->
Expand Down
6 changes: 3 additions & 3 deletions ads/getting-started/react-native.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ sidebar_custom_props: { 'icon': 'react' }

# Getting started with OptiView Ads on React Native

This guide will get you started with OptiView Ads in your THEOplayer React Native SDK: configure the license, update dependencies and set the source description.
This guide will get you started with OptiView Ads in your OptiView Player React Native SDK: configure the license, update dependencies and set the source description.

## Prerequisites

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

1. You need to have a THEOplayer license which is compatible with OptiView Ads. This can be done through the [player portal](https://portal.theoplayer.com).
1. You need to have an OptiView Player license which is compatible with OptiView Ads. This can be done through the [player portal](https://portal.theoplayer.com).
2. You need a correctly deployed [OptiView Ads signaling service](signaling-service.mdx).
3. Enable the OptiView Ads integration based on the target platform:
<Tabs queryString="platform">
Expand Down Expand Up @@ -46,7 +46,7 @@ import TabItem from '@theme/TabItem';

## Integration

This guide assumes you know how to set up React Native with THEOplayer.
This guide assumes you know how to set up React Native with OptiView Player.
For more information regarding this check out the [THEOplayer getting started](/theoplayer/getting-started/frameworks/react-native/getting-started/).

### Player configuration
Expand Down
8 changes: 4 additions & 4 deletions ads/getting-started/web.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ sidebar_custom_props: { 'icon': 'web' }

# Getting started with OptiView Ads on Web

This guide will get you started with OptiView Ads in your THEOplayer Web SDK: configure the license, update dependencies and set the source description.
This guide will get you started with OptiView Ads in your OptiView Player Web SDK: configure the license, update dependencies and set the source description.

## Prerequisites

1. You need to have a THEOplayer license which is compatible with OptiView Ads. This can be done through the [player portal](https://portal.theoplayer.com).
1. You need to have an OptiView Player license which is compatible with OptiView Ads. This can be done through the [player portal](https://portal.theoplayer.com).
2. You need a correctly deployed [OptiView Ads signaling service](signaling-service.mdx).
3. Your THEOplayer SDK needs to have the `theoads` feature enabled.

As of THEOplayer version 8.2.0, this feature is enabled by default in the main `theoplayer` package so we recommend to use at least this version, preferable the latest available version.
As of OptiView Player version 8.2.0, this feature is enabled by default in the main `theoplayer` package so we recommend to use at least this version, preferable the latest available version.
You can install this package with the following command:

```bash
Expand All @@ -23,7 +23,7 @@ This guide will get you started with OptiView Ads in your THEOplayer Web SDK: co

## Integration

This guide assumes you know how to set up THEOplayer. For more information regarding this, check out the [THEOplayer getting started](/theoplayer/getting-started/sdks/web/getting-started/).
This guide assumes you know how to set up OptiView Player. For more information regarding this, check out the [THEOplayer getting started](/theoplayer/getting-started/sdks/web/getting-started/).

### Google DAI library

Expand Down
4 changes: 2 additions & 2 deletions ads/how-to-guides/ad-impressions.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ The ad impression is beaconed simultaneously with the firing of the player's `ad

## Information tracked

The information passed only contains an identifier of the THEOplayer license build so the impressions are linked to the customer. It also includes the ad experience type.
The information passed only contains an identifier of the OptiView Player license build so the impressions are linked to the customer. It also includes the ad experience type.
No information about the viewers is passed along.

## View my impression usage

You can view your ad impressions on the portal dashboard underneath the THEOplayer license impressions.
You can view your ad impressions on the portal dashboard underneath the OptiView Player license impressions.

![Portal dashboard](../assets/img/impressions.png)
5 changes: 4 additions & 1 deletion ads/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,12 @@ sidebar_label: Introduction
# Dolby OptiView Ads Introduction

import SidebarDocCardList from '@site/src/components/SidebarDocCardList';
import RebrandingNotice from './callouts/_rebranding_notice.md';
import ThemedImage from '@theme/ThemedImage';
import useBaseUrl from '@docusaurus/useBaseUrl';

<RebrandingNotice />

OptiView Ads is an ad insertion service for LIVE content (VoD support coming soon), utilizing Server-Guided Ad Insertion (SGAI). On these pages, you'll learn how to get started with OptiView Ads, how to configure the player and integrate the signaling service APIs.

By logically redistributing responsibilities in the advertisement workflow, OptiView Ads:
Expand Down Expand Up @@ -39,7 +42,7 @@ To ensure high availability, we recommend maintaining the original origin stream

OptiView Ads is tightly integrated with [Google Ad Manager](https://developers.google.com/ad-manager/dynamic-ad-insertion 'Google DAI') for ad decisioning, transcoding, and serving, ensuring a streamlined process for ad delivery and management.

OptiView Ads enables innovative ad formats through THEOplayer, providing new ways to monetize content in a less intrusive manner. The out-of-the-box formats include, but are not limited to:
OptiView Ads enables innovative ad formats through OptiView Player, providing new ways to monetize content in a less intrusive manner. The out-of-the-box formats include, but are not limited to:

- **Default Full Screen Ad Insertion**: Replaces the content with an advertisement.
- **Double Box**: Allows content to continue playing side-by-side with an advertisement and its companion background.
Expand Down
23 changes: 3 additions & 20 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,7 @@ function removeDocIndexItems(items) {

const config: Config = {
title: 'Dolby OptiView Documentation',
tagline:
'Discover the latest developer documentation and samples for OptiView products including: Player, Streaming, Ads, Ad Engine, and Open Video UI',
tagline: 'Discover the latest developer documentation and samples for OptiView products',
favicon: 'img/favicon.ico',

// Set the production url of your site here
Expand Down Expand Up @@ -525,22 +524,6 @@ const config: Config = {
themeConfig: {
// TODO OpenGraph image for OptiView?
// image: 'img/opengraph.png',
announcementBar: process.env.DOCUSAURUS_PR_NUMBER
? {
id: 'pr_preview',
content: `This is a preview of the documentation website from <a target="_blank" rel="noopener noreferrer" href="${process.env.DOCUSAURUS_PR_URL}">pull request #${process.env.DOCUSAURUS_PR_NUMBER}</a>.`,
backgroundColor: '#9cb9c9',
textColor: '#344a5e',
isCloseable: false,
}
: {
id: 'dolby_optiview_new_name',
content:
'Dolby OptiView is the new home for everything Dolby.io and THEOplayer. <a target="_blank" rel="noopener" href="https://dolby.io/blog/introducing-dolby-optiview-redefining-immersive-streaming-experiences/">Learn more.</a>',
backgroundColor: '#4800c4',
textColor: '#fff',
isCloseable: true,
},
navbar: {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 PR preview announcement bar inadvertently removed along with rebranding announcement

The entire announcementBar config was removed from docusaurus.config.ts, but this contained two separate concerns bundled in a ternary expression: (1) a rebranding notice for production, and (2) a PR preview warning for PR preview deployments. The CI workflow at .github/workflows/pr-preview.yml:47-49 still sets DOCUSAURUS_PR_NUMBER and DOCUSAURUS_PR_URL environment variables expecting this announcement bar to render, but the code consuming these variables is now gone. As a result, PR preview deployments will no longer display the warning banner ("This is a preview of the documentation website from pull request #...") that alerts users the content may be inaccurate.

Prompt for agents
The announcementBar config in docusaurus.config.ts themeConfig was entirely removed. While removing the rebranding announcement ('dolby_optiview_new_name') was intentional, the PR preview announcement bar was also removed as collateral damage because both were in a single ternary expression.

The PR preview workflow (.github/workflows/pr-preview.yml lines 47-49) still sets DOCUSAURUS_PR_NUMBER and DOCUSAURUS_PR_URL environment variables and has a comment saying 'Add an announcement at the top to indicate that this is a preview'.

To fix this, re-add only the PR preview announcement bar to the themeConfig in docusaurus.config.ts. The property should be added right before the 'navbar' property. Something like:

announcementBar: process.env.DOCUSAURUS_PR_NUMBER
  ? {
      id: 'pr_preview',
      content: `This is a preview of the documentation website from <a target="_blank" rel="noopener noreferrer" href="${process.env.DOCUSAURUS_PR_URL}">pull request #${process.env.DOCUSAURUS_PR_NUMBER}</a>. It may contain inaccurate or incomplete information. Do not rely on it for official documentation.`,
      backgroundColor: '#9cb9c9',
      textColor: '#344a5e',
      isCloseable: false,
    }
  : undefined,

This preserves the PR preview warning while still removing the old rebranding announcement bar.
Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

title: null,
logo: {
Expand Down Expand Up @@ -600,14 +583,14 @@ const config: Config = {
type: 'docSidebar',
docsPluginId: 'theolive',
sidebarId: 'theolive',
label: 'Live (THEOlive)',
label: 'Live',
activeBasePath: '/theolive',
},
{
type: 'docSidebar',
docsPluginId: 'millicast',
sidebarId: 'millicast',
label: 'Real-time (Millicast)',
label: 'Real-time',
activeBasePath: '/millicast',
},
],
Expand Down
Loading
Loading