Interface SgaiProvider

interface SgaiProvider {
    clearDroppedOutAds(): void;
    getDueAds(time): SgaiAd[];
    getPostRollAds(): SgaiAd[];
    getPreRollAds(): SgaiAd[];
    getReplaceContentDuration(ad, nestedAds): number;
    getTotalPlannedDuration(ad, nestedAds): number;
    getTotalPlayoutLimit(ad): number;
    handleSkippedAds(fromTime, toTime): SgaiAd[];
    markAdAsPlayed(ad): void;
    reinsertAds(seekTarget): void;
    resolveAdCreativeSignaling(ad): SgaiAdTrackerData;
    resolveNestedAds(ad): Promise<SgaiLinearAd[]>;
    resolveRestrictions(ad): PlaybackRestrictions;
    startTracking(): void;
    stopTracking(): void;
}

Hierarchy

  • Disposable
    • SgaiProvider

Methods

clearDroppedOutAds getDueAds getPostRollAds getPreRollAds getReplaceContentDuration getTotalPlannedDuration getTotalPlayoutLimit handleSkippedAds markAdAsPlayed reinsertAds resolveAdCreativeSignaling resolveNestedAds resolveRestrictions startTracking stopTracking

Methods

clearDroppedOutAds

  • clearDroppedOutAds(): void

  • Returns void

getDueAds

  • getDueAds(time): SgaiAd[]

  • Parameters

    • time: number

    Returns SgaiAd[]

getPostRollAds

getPreRollAds

getReplaceContentDuration

  • getReplaceContentDuration(ad, nestedAds): number

  • Parameters

    Returns number

getTotalPlannedDuration

  • getTotalPlannedDuration(ad, nestedAds): number

  • Parameters

    Returns number

getTotalPlayoutLimit

  • getTotalPlayoutLimit(ad): number

  • Parameters

    Returns number

handleSkippedAds

  • handleSkippedAds(fromTime, toTime): SgaiAd[]

  • Parameters

    • fromTime: number
    • toTime: number

    Returns SgaiAd[]

markAdAsPlayed

  • markAdAsPlayed(ad): void

  • Parameters

    Returns void

reinsertAds

  • reinsertAds(seekTarget): void

  • Parameters

    • seekTarget: number

    Returns void

resolveAdCreativeSignaling

resolveNestedAds

resolveRestrictions

startTracking

  • startTracking(): void

  • Returns void

stopTracking

  • stopTracking(): void

  • Returns void

Settings

Member Visibility

Theme

On This Page

clearDroppedOutAdsgetDueAdsgetPostRollAdsgetPreRollAdsgetReplaceContentDurationgetTotalPlannedDurationgetTotalPlayoutLimithandleSkippedAdsmarkAdAsPlayedreinsertAdsresolveAdCreativeSignalingresolveNestedAdsresolveRestrictionsstartTrackingstopTracking