Interface UplynkAdBreak

Represents an Uplynk ad break.

interface UplynkAdBreak {
    ads: UplynkAdList;
    duration: undefined | number;
    endTime: undefined | number;
    skipOffset: number;
    startTime: number;
    addEventListener<TType extends keyof UplynkAdBreakEventMap>(
        type: TType | readonly TType[],
        listener: EventListener<UplynkAdBreakEventMap[TType]>,
    ): void;
    removeEventListener<TType extends keyof UplynkAdBreakEventMap>(
        type: TType | readonly TType[],
        listener: EventListener<UplynkAdBreakEventMap[TType]>,
    ): void;
}

Hierarchy (View Summary)

Properties

ads duration endTime skipOffset startTime

Methods

addEventListener removeEventListener

Properties

Readonlyads

ads: UplynkAdList

List of ads in the ad break.

Readonlyduration

duration: undefined | number

The duration of the ad break, in seconds.

Remarks


- For channels it can return undefined when the duration has not yet been signaled.

ReadonlyendTime

endTime: undefined | number

The end time of the ad break, in seconds.

Remarks


- For channels it can return undefined when the end time has not yet been signaled.

skipOffset

skipOffset: number

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

Remarks

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. Skipping the ad in live streams is unsupported.

Example

To be able to skip the first ad after 10 seconds use: 10.

Default Value

The VerizonMediaConfiguration.defaultSkipOffset.

ReadonlystartTime

startTime: number

The start time of the ad break, in seconds.

Methods

addEventListener

removeEventListener

Settings

Member Visibility

On This Page

Properties
Methods