THEOplayer Web SDK
    Preparing search index...

    Interface StartLinearAdBreakOptionsExperimental

    interface StartLinearAdBreakOptions {
        audio?: "content" | "ad";
        keepContentPlaying?: boolean;
        playback?: LinearAdPlayback;
        timeline?: "content" | "ad";
    }
    Index
    audio?: "content" | "ad"

    Whether the player's volume and muted controls apply to the ad or the content during the break.

    'content' requires keepContentPlaying to be true; the ad remains muted.

    'ad'

    keepContentPlaying?: boolean

    Whether the content keeps playing during the linear ad break, for example for a double-box layout where the ad is shown next to the content.

    When set, the player does not pause or hide the content. The content keeps its own volume and mute state. When omitted or false, the player pauses the content and hides ClientSideAdIntegrationController.contentElement with visibility: hidden, unless the playback sets LinearAdPlayback.usesContentVideoElement. By default, the player's volume and muted apply to the ad; set StartLinearAdBreakOptions.audio to 'content' to apply them to the content and keep the ad muted. With the default audio: 'ad', the viewer's volume and mute state is copied back to the content at break end. With audio: 'content', the viewer's controls already apply to the content. ChromelessPlayer.play and ChromelessPlayer.pause apply to both the ad and the content. The integration is responsible for positioning ClientSideAdIntegrationController.contentElement and the ad (in ClientSideAdIntegrationController.adContainer or the ClientSideAdIntegrationController.linearAdPlayer element) so that both are visible.

    false

    playback?: LinearAdPlayback

    Delegate for a linear ad player owned by the integration, such as the ad player of a third-party ad SDK rendering into ClientSideAdIntegrationController.adContainer.

    The delegate's readyState must use the same values as ChromelessPlayer.readyState. A delegate backed by an HTMLMediaElement can forward its readyState.

    If omitted, the integration must play its ads through the built-in player using linearAdPlayer.

    timeline?: "content" | "ad"

    Whether the player's time-related state follows the ad or the content during the break.

    'content' requires keepContentPlaying to be true; the player routes seeks to the content.

    'ad'