React Native THEOplayer SDK
    Preparing search index...

    Interface AdDescription

    Describes an ad break request.

    interface AdDescription {
        integration?: AdIntegrationKind | CustomAdIntegrationKind;
        replaceContent?: boolean;
        sources?: string | AdSource;
        timeOffset?: string | number;
    }

    Hierarchy (View Summary)

    Index
    integration? replaceContent? sources? timeOffset?
    integration?: AdIntegrationKind | CustomAdIntegrationKind

    The integration of the ad break.

    replaceContent?: boolean

    Whether the ad replaces playback of the content.


    - When the ad ends, the content will resume at the ad break's offset plus its duration.
    - Available for theoads since v11.2.0.


    - true for live content and theoads VOD content.
    - false for VOD content.

    sources?: string | AdSource

    A source which contains the location of ad resources to be scheduled.


    - Important: This should not be an array of sources.
    - VPAID support is limited to the 'google-ima' integration.
    - Not specifying this property should only happen when using a third party ad integration that uses an other system of specifying which ads to schedule

    timeOffset?: string | number

    Offset after which the ad break will start.

    Possible formats:
    - A number for the offset in seconds.
    - 'start' for a preroll.
    - 'end' for a postroll.
    - 'HH:MM:SS.mmm' for a timestamp in the playback window.
    - A percentage string (XX%) for a proportion of the content duration.


    - A timestamp which is not in the playback window will result in the ad break not being started.
    - VMAP resources will ignore this value as they contain an internal offset.

    'start'

    Settings
    Member Visibility

    On This Page
    Properties