THEOplayer Web SDK
    Preparing search index...

    Interface UplynkResponseVodAd

    The Uplynk response with ad information for VOD assets.

    interface UplynkResponseVodAd {
        apiFramework: null | string;
        companions: UplynkResponseVodAd[];
        creative: string;
        duration: number;
        events: Record<string, string[]>;
        extensions?: object[];
        fw_parameters?: Record<string, string>;
        height: number;
        mimeType: string;
        width: number;
    }
    Index

    Properties

    apiFramework companions creative duration events extensions? fw_parameters? height mimeType width

    Properties

    apiFramework: null | string

    The API framework, if any.


    - If the value is 'VPAID', then the ad is a VPAID ad.
    - Otherwise the ad is an Uplynk CMS asset.

    companions: UplynkResponseVodAd[]

    List of companion ads of the ad.

    creative: string

    The creative identifier.


    - Either a VPAID URL if the API framework is 'VPAID'.
    - Otherwise an asset ID from the Uplynk CMS.

    duration: number

    The duration of the ad, in seconds.

    events: Record<string, string[]>

    A record of all VAST 3.0 tracking events for the ad. Each entry contains an event name with associated tracking URLs.

    extensions?: object[]

    List of VAST extensions returned by the ad server.

    fw_parameters?: Record<string, string>

    Record of FreeWheel-defined creative parameters. Each entry contains the parameter name together with the associated value.

    height: number

    The height of the ad, in pixels.


    - Returns 0 when this is not a companion.

    mimeType: string

    The creative's mime type.


    - Either 'application/javascript' if the API framework is 'VPAID'.
    - Otherwise 'uplynk/m3u8'.

    width: number

    The width of the ad, in pixels.


    - Returns 0 when this is not a companion.

    Settings

    Member Visibility

    On This Page

    Properties