React Native THEOplayer SDK
    Preparing search index...

    Interface LinearAd

    Represents a linear ad in the VAST specification.

    interface LinearAd {
        adBreak: AdBreak;
        adSystem: string | undefined;
        clickThrough: string | undefined;
        companions: CompanionAd[];
        creativeId: string | undefined;
        duration: number;
        height: number | undefined;
        id: string | undefined;
        integration?: AdIntegrationKind | CustomAdIntegrationKind;
        mediaFiles: MediaFile[];
        readyState?: AdReadyState;
        resourceURI?: string;
        skipOffset: number | undefined;
        type: string;
        universalAdIds: UniversalAdId[];
        width: number | undefined;
    }

    Hierarchy (View Summary)

    • Ad
      • LinearAd
    Index
    adBreak adSystem clickThrough companions creativeId duration height id integration? mediaFiles readyState? resourceURI? skipOffset type universalAdIds width
    adBreak: AdBreak

    The ad break which the ad is part of.


    - Available for VAST-ads.

    adSystem: string | undefined

    The source ad server information included in the ad response.


    - Available when the Ad.readyState is 'ready'.

    clickThrough: string | undefined

    The website of the advertisement.


    - Available when the Ad.readyState is 'ready'.

    companions: CompanionAd[]

    List of companions which can be displayed outside the player.


    - Available when the Ad.readyState is 'ready'.
    - Only supported for 'theo' and 'google-dai'.

    creativeId: string | undefined

    The identifier of the selected creative for the ad.


    - Available when the Ad.readyState is 'ready'.

    duration: number

    The duration of the ad, in seconds.


    - Available when the Ad.readyState is 'ready'.

    height: number | undefined

    The height of the ad.


    - Available when the Ad.readyState is 'ready'.

    id: string | undefined

    The identifier of the creative.


    - Available when the Ad.readyState is 'ready'.

    integration?: AdIntegrationKind | CustomAdIntegrationKind

    The integration of the ad, represented by a value from AdIntegrationKind or the identifier of a custom integration.

    'csai'

    mediaFiles: MediaFile[]

    List of media files which contain metadata about ad video files.

    readyState?: AdReadyState

    The ready state of the ad.

    resourceURI?: string

    The URI of the the ad content.


    - Available when the Ad.readyState is 'ready'.

    skipOffset: number | undefined

    Offset after which the ad break may be skipped, in seconds.


    - Available when the Ad.readyState is 'ready'.
    - If the offset is -1, the ad is unskippable.
    - If the offset is 0, the ad is immediately skippable.
    - Otherwise it must be a positive number indicating the offset.

    type: string

    The type of the ad, represented by a value from the following list:
    - 'linear'
    - 'nonlinear'

    universalAdIds: UniversalAdId[]

    The list of universal ad ID information of the selected creative for the ad.


    - Only supported for 'theo' and 'google-ima'.

    width: number | undefined

    The width of the ad, in pixels.


    - Available when the Ad.readyState is 'ready'.

    Settings
    Member Visibility

    On This Page
    Properties