THEOplayer Web SDK
    Preparing search index...

    Interface CsaiAdDescription

    Describes an ad break request.

    interface CsaiAdDescription {
        integration?: "csai" | "theo";
        replaceContent?: boolean;
        skipOffset?: string | number;
        sources: string | AdSource;
        timeOffset?: string | number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    integration? replaceContent? skipOffset? sources timeOffset?

    Properties

    integration?: "csai" | "theo"

    The integration of the ad break.

    'csai'


    - The 'theo' integration naming is deprecated and has been replaced with 'csai'.

    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.


    - true for live content,
    - false for VOD content.

    skipOffset?: string | number

    Offset after which the ad break can be skipped.


    - 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.

    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.

    'start'

    sources: string | AdSource

    The source of the ad


    - Only supports VAST and VMAP.

    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.
    - Do NOT set for VMAP ads. VMAP resources will ignore this value as they contain an internal offset. https://www.theoplayer.com/docs/theoplayer/how-to-guides/ads/how-to-set-up-vast-and-vmap/#vmap
    - Since 2.18, numbers are supported for the Google IMA integration, since 2.21 other formats as well.

    'start'

    Settings

    Member Visibility

    On This Page

    Properties