Interface AdListener

interface AdListener {
    onAdBreakCompleted?(breakType: AdBreakType): void;
    onAdBreakStarted?(breakType: AdBreakType, totalAds: number): void;
    onAdClicked?(ad: AdInfo): void;
    onAdCompleted?(ad: AdInfo): void;
    onAdError?(error: OGAdError): void;
    onAdPaused?(ad: AdInfo): void;
    onAdProgress?(ad: AdInfo, positionMs: number, durationMs: number): void;
    onAdResumed?(ad: AdInfo): void;
    onAdSkippableStateChanged?(
        ad: AdInfo,
        isSkippable: boolean,
        skipOffsetMs: number,
    ): void;
    onAdSkipped?(ad: AdInfo): void;
    onAdStarted?(ad: AdInfo): void;
}

Index

Methods

onAdBreakCompleted? onAdBreakStarted? onAdClicked? onAdCompleted? onAdError? onAdPaused? onAdProgress? onAdResumed? onAdSkippableStateChanged? onAdSkipped? onAdStarted?

Methods

`Optional`onAdBreakCompleted

onAdBreakCompleted?(breakType: AdBreakType): void
Parameters
- breakType: AdBreakType
Returns void
- Defined in src/ads/types.ts:51

`Optional`onAdBreakStarted

onAdBreakStarted?(breakType: AdBreakType, totalAds: number): void
Parameters
- breakType: AdBreakType
- totalAds: number
Returns void
- Defined in src/ads/types.ts:47

`Optional`onAdClicked

onAdClicked?(ad: AdInfo): void
The viewer opened the ad's clickthrough; the SDK pauses the ad and resumes it when the page is visible again.
Parameters
- ad: AdInfo
Returns void
- Defined in src/ads/types.ts:55

`Optional`onAdCompleted

onAdCompleted?(ad: AdInfo): void
Parameters
- ad: AdInfo
Returns void
- Defined in src/ads/types.ts:50

`Optional`onAdError

onAdError?(error: OGAdError): void
Parameters
- error: OGAdError
Returns void
- Defined in src/ads/types.ts:58

`Optional`onAdPaused

onAdPaused?(ad: AdInfo): void
Parameters
- ad: AdInfo
Returns void
- Defined in src/ads/types.ts:52

`Optional`onAdProgress

onAdProgress?(ad: AdInfo, positionMs: number, durationMs: number): void
Parameters
- ad: AdInfo
- positionMs: number
- durationMs: number
Returns void
- Defined in src/ads/types.ts:56

`Optional`onAdResumed

onAdResumed?(ad: AdInfo): void
Parameters
- ad: AdInfo
Returns void
- Defined in src/ads/types.ts:53

`Optional`onAdSkippableStateChanged

onAdSkippableStateChanged?(
    ad: AdInfo,
    isSkippable: boolean,
    skipOffsetMs: number,
): void
Parameters
- ad: AdInfo
- isSkippable: boolean
- skipOffsetMs: number
Returns void
- Defined in src/ads/types.ts:57

`Optional`onAdSkipped

onAdSkipped?(ad: AdInfo): void
Parameters
- ad: AdInfo
Returns void
- Defined in src/ads/types.ts:49

`Optional`onAdStarted

onAdStarted?(ad: AdInfo): void
Parameters
- ad: AdInfo
Returns void
- Defined in src/ads/types.ts:48