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

    Interface THEOplayerAdsBindingResult

    Player wiring and an ownership-neutral session factory.

    interface THEOplayerAdsBindingResult {
        configKey: string | null;
        createSession: () => OptiViewAdsSession | null;
        player: THEOplayer | null;
        playerConfig: PlayerConfiguration | undefined;
        playerHandlers: {
            onPlayerDestroy: (player: THEOplayer) => void;
            onPlayerReady: (player: THEOplayer) => void;
            onPlayerRestored: (player: THEOplayer) => void;
        };
        sessionKey: string
        | null;
    }
    Index
    configKey createSession player playerConfig playerHandlers sessionKey
    configKey: string | null

    Opaque in-process configuration identity for retained-session comparisons; do not log or persist.

    createSession: () => OptiViewAdsSession | null

    Creates a fresh session after player readiness; pass to useOptiViewAds or an external owner.

    player: THEOplayer | null

    The most recently ready or restored player, or null after destruction.

    playerConfig: PlayerConfiguration | undefined

    Pass to THEOplayerView's config prop.

    playerHandlers: {
        onPlayerDestroy: (player: THEOplayer) => void;
        onPlayerReady: (player: THEOplayer) => void;
        onPlayerRestored: (player: THEOplayer) => void;
    }

    Connect ready/destroy to the player view; invoke onPlayerRestored after an app-owned handoff.

    Type Declaration

    • onPlayerDestroy: (player: THEOplayer) => void

      Forwarded after clearing the bound player.

    • onPlayerReady: (player: THEOplayer) => void

      Forwarded after binding the ready player.

    • onPlayerRestored: (player: THEOplayer) => void

      Forwarded after rebinding a retained player; map the host's restore callback to this handler.

    sessionKey: string | null

    Opaque in-process session identity for retained-session comparisons; do not log or persist.

    Settings
    Member Visibility

    On This Page
    Properties