OptiView Ads SDK for React Native
    Preparing search index...

    Interface OptiViewAdsReactNativeConfig

    The bridge-serializable OptiView Ads configuration for React Native.

    This is exactly the web OptiViewAdsConfig minus the non-serializable members (NonBridgeableConfigKey) — every remaining field is plain JSON data and is passed verbatim to the native OptiViewAds orchestrator, so the RN API stays in lockstep with the web API by construction.

    interface OptiViewAdsReactNativeConfig {
        adBreakCutSafetyMarginSec?: number;
        adInsertion?: AdInsertionMode;
        adPreload?: AdPreloadMode;
        autoplay?: boolean;
        breakWarnings?: BreakWarningsConfig;
        chaining?: ChainingConfig;
        continueContentDuringBreak?: boolean;
        debug?: boolean;
        diagnostics?: DiagnosticsConfig;
        doubleBoxAudio?: DoubleBoxAudio;
        gam?: GamConfig;
        maxBitrate?: number;
        mode?: OptiViewAdsMode;
        pdtGraceSeconds?: number;
        ptsSource?: PtsSource;
        ssai?: SsaiConfig;
        tuneIn?: TuneInConfig;
    }

    Hierarchy

    Index
    adBreakCutSafetyMarginSec?: number

    Seconds added to a break's effective duration to form the hard cut back to content, so an over-long or stalled ad cannot hold the break open. 0 cuts exactly at the boundary.

    2
    
    adInsertion?: AdInsertionMode

    Ad insertion strategy. auto switches iPhone/iPod to shared-element insertion, all other platforms overlay.

    'auto'
    

    AdInsertionMode

    adPreload?: AdPreloadMode

    Ad preload strategy.

    'auto'
    

    AdPreloadMode

    autoplay?: boolean

    Start playback automatically after loading the stitched master (SSAI only).

    false
    
    breakWarnings?: BreakWarningsConfig

    Pre-break warnings: adbreakstatus events N seconds before each non-pre-roll break.

    BreakWarningsConfig

    chaining?: ChainingConfig

    Consecutive-break chaining. Defaults to enabled with a 2s gap.

    ChainingConfig

    continueContentDuringBreak?: boolean

    Keep content playing, muted and hidden, through eligible replacement single-format breaks. Requires SGAI and an explicit adInsertionType: 'replacement'. The content player's optional setVideoQuality operation constrains background bandwidth when available.

    false
    
    debug?: boolean

    Enable debug logging.

    false
    
    diagnostics?: DiagnosticsConfig

    Ring buffer behind onDiagnostic() and exportDiagnostics().

    doubleBoxAudio?: DoubleBoxAudio

    Which side gets audio during a double-format break; the other side is muted for the break.

    'ad'
    

    DoubleBoxAudio

    gam?: GamConfig

    Google Ad Manager configuration. Its PRESENCE enables GAM. It carries no stream identity: in sgai that comes from the manifest's vendorConfiguration, in ssai from ssai + customAssetKey.

    maxBitrate?: number

    Maximum rendition bitrate (bits/sec) sent to the stitcher as max_bitrate; variants above it are dropped. SSAI only.

    Ad insertion architecture. With ssai, gam and ssai are both required and each session supplies stitcherUrl + customAssetKey.

    'sgai'
    

    OptiViewAdsMode

    pdtGraceSeconds?: number

    Seconds to wait for EXT-X-PROGRAM-DATE-TIME on a wallclock session before concluding the stream carries none. Until then no scheduling decision is made: the system clock runs ahead of the live playhead by the stream latency and would fire a break early.

    A backstop, not a fixed delay: content playing for ~1s with no PDT concludes immediately (DA-PDT-MISSING); the window only governs a player that never starts. Set 0 to use the system clock immediately. No effect on pts manifests.

    5
    
    ptsSource?: PtsSource

    How a timebase: "pts" break's start is resolved. mediaTime reads it directly as player media time. anvatoCue tracks Anvato in-stream cues — HLS ID3 GEOB frames (description Anvatos, MIME application/json) and DASH emsg (urn:anvato:es1:052016) with payload type=cue&pts=<seconds> — and schedules the break at the media time of the cue whose pts matches its start (±5 ms); until then it stays pending (DA-ANVATO-CUE-PENDING). SGAI only.

    'mediaTime'
    
    ssai?: SsaiConfig

    SSAI-only GAM identity (required with mode: 'ssai'): SSAI has no break manifest to read it from.

    tuneIn?: TuneInConfig

    Tune-in (join-in-progress) configuration. Defaults to enabled with a 5s minimum.

    TuneInConfig