Interface GoogleDAI

The Google DAI API.

Remarks


- Available since v3.7.0.

interface GoogleDAI {
    snapback: boolean;
    sourceTransformer: ((url) => string | Promise<string>);
    contentTimeForStreamTime(time): number;
    replaceAdTagParameters(adTagParameters?): void;
    streamTimeForContentTime(time): number;
}

Properties

snapback sourceTransformer

Methods

contentTimeForStreamTime replaceAdTagParameters streamTimeForContentTime

Properties

snapback

snapback: boolean

Whether snapback is enabled. When enabled and the user seeks over multiple ad breaks, the last ad break that was seeked past will be played.

sourceTransformer

sourceTransformer: ((url) => string | Promise<string>)

A source transformer which will receive the source as returned from Google DAI before loading it in the player. This capability can be useful if you need to add authentication tokens or signatures to the source URL as returned by Google.

Type declaration

    • (url): string | Promise<string>

    • A source transformer which will receive the source as returned from Google DAI before loading it in the player. This capability can be useful if you need to add authentication tokens or signatures to the source URL as returned by Google.

      Parameters

      • url: string

      Returns string | Promise<string>

Methods

contentTimeForStreamTime

  • contentTimeForStreamTime(time): number

  • Returns the content time without ads for a given stream time. Returns the given stream time for live streams.

    Parameters

    • time: number

      The stream time with inserted ads (in seconds).

    Returns number

replaceAdTagParameters

  • replaceAdTagParameters(adTagParameters?): void

  • Replaces all the ad tag parameters used for upcoming ad requests for a live stream.

    Parameters

    • Optional adTagParameters: Record<string, string>

      The new ad tag parameters.

    Returns void

streamTimeForContentTime

  • streamTimeForContentTime(time): number

  • Returns the stream time with ads for a given content time. Returns the given content time for live streams.

    Parameters

    • time: number

      The content time without any ads (in seconds).

    Returns number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc