Interface UplynkAd

Represents an Uplynk ad.

interface UplynkAd {
    apiFramework: undefined | string;
    companions: readonly UplynkAd[];
    creative: string;
    duration: number;
    endTime: number;
    events: Record<string, string[]>;
    extensions: readonly object[];
    freeWheelParameters: Record<string, string>;
    height: number;
    mimeType: string;
    startTime: number;
    width: number;
    addEventListener<TType extends keyof UplynkAdEventMap>(
        type: TType | readonly TType[],
        listener: EventListener<UplynkAdEventMap[TType]>,
    ): void;
    removeEventListener<TType extends keyof UplynkAdEventMap>(
        type: TType | readonly TType[],
        listener: EventListener<UplynkAdEventMap[TType]>,
    ): void;
}

Hierarchy (View Summary)

Properties

apiFramework companions creative duration endTime events extensions freeWheelParameters height mimeType startTime width

Methods

addEventListener removeEventListener

Properties

ReadonlyapiFramework

apiFramework: undefined | string

The API framework, if any.

Remarks


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

Readonlycompanions

companions: readonly UplynkAd[]

List of companion ads of the ad.

Readonlycreative

creative: string

The identifier of the creative.

Remarks


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

Readonlyduration

duration: number

The duration of the ad, in seconds.

ReadonlyendTime

endTime: number

The end time of the ad, in seconds.

Readonlyevents

events: Record<string, string[]>

A record of all VAST 3.0 tracking events for this ad. Each entry contains all related tracking URLs.

Readonlyextensions

extensions: readonly object[]

List of VAST extensions returned by the ad server.

ReadonlyfreeWheelParameters

freeWheelParameters: Record<string, string>

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

Readonlyheight

height: number

The height of the ad, in pixels.

Remarks


- Returns 0 when this is not a companion.

ReadonlymimeType

mimeType: string

The creative's mime type.

Remarks


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

ReadonlystartTime

startTime: number

The start time of the ad, in seconds.

Readonlywidth

width: number

The width of the ad, in pixels.

Remarks


- Returns 0 when this is not a companion.

Methods

addEventListener

removeEventListener

Settings

Member Visibility

On This Page

Properties
Methods