Bitmovin Player React Native SDK - v1.19.0
    Preparing search index...

    Interface AdvertisingConfig

    Contains configuration values regarding the ads which should be played back by the player.

    interface AdvertisingConfig {
        ima?: ImaAdvertisingConfig;
        schedule: AdItem[];
        shouldLoadAdItem?: (adItem: AdItem) => boolean;
        shouldPlayAdBreak?: (adBreak: AdBreak) => boolean;
    }
    Index

    Properties

    ima? schedule shouldLoadAdItem? shouldPlayAdBreak?

    Properties

    ima?: ImaAdvertisingConfig

    Configuration to customize Google IMA SDK integration.

    schedule: AdItem[]

    The ad items that are scheduled when a new playback session is started via Player.load().

    shouldLoadAdItem?: (adItem: AdItem) => boolean

    Called right before an ad item begins loading.

    Use this callback to conditionally allow or skip individual ad items based on runtime logic (e.g., user state, targeting rules, frequency caps).

    Type Declaration

      • (adItem: AdItem): boolean

      • Parameters

        • adItem: AdItem

          The ad item that is about to be loaded.

        Returns boolean

        • true → the ad item will proceed to load as scheduled.
        • false → the ad item will be skipped and removed from the playback schedule.
    shouldPlayAdBreak?: (adBreak: AdBreak) => boolean

    Called right before a scheduled ad break starts playback.

    Use this callback to conditionally allow or skip ad breaks at runtime (e.g., when starting playback from a time offset and discarding past breaks).

    Type Declaration

      • (adBreak: AdBreak): boolean

      • Parameters

        • adBreak: AdBreak

          The ad break that is about to start.

        Returns boolean

        • true → the ad break will start playback.
        • false → the ad break will be skipped.

    If the callback does not return within the platform's internal timeout, the ad break will play. The callback must be synchronous.

    Android

    Settings

    Member Visibility

    On This Page

    Properties