Interface UplynkAds

The Uplynk ads API.

interface UplynkAds {
    adBreaks: UplynkAdBreakList;
    currentAdBreak: undefined | UplynkAdBreak;
    currentAds: UplynkAdList;
    skip(): void;
}

Index

Properties

adBreaks currentAdBreak currentAds

Methods

Properties

`Readonly`adBreaks

adBreaks: UplynkAdBreakList

List of ad breaks.

`Readonly`currentAdBreak

currentAdBreak: undefined | UplynkAdBreak

The currently playing ad break.

`Readonly`currentAds

currentAds: UplynkAdList

The currently playing ads.

Remarks

- These will always be part of the current ad break.

Methods

skip

skip(): void
Seek to the end of the ad if it is skippable.

Returns void
Remarks

- The ad is skippable when it is currently playing and the ad break's offset is reached.