Interface MKPlayerAdvertisingAPI

MKPlayer Advertising API interface. It provides the APIs to schedule, manage, and track ad breaks. Only applicable in case of Client-Side Ad Insertion (CSAI) and available when advertising is provided in the PlayerConfig.

Hierarchy

  • MKPlayerAdvertisingAPI

Methods

discardAdBreak getActiveAd getActiveAdBreak getModuleInfo isLinearAdActive list schedule skip

Methods

discardAdBreak

  • Discards all scheduled ad breaks with the given ID. Also stops the current ad break if it has the same ID.

    Parameters

    • adBreakId: string

      The ID of the ad break which shall be removed from the scheduled ad breaks.

    Returns void

    Since

    v8.0

getActiveAd

  • Returns the currently active ad.

    Returns MKAd

    Since

    v8.1

getActiveAdBreak

  • Returns the currently active ad break.

    Returns MKAdBreak

    AdBreak

    Since

    v8.0

getModuleInfo

  • Returns the name and version of the currently used advertising module.

    Returns MKModuleInfo

    Since

    v8.1

isLinearAdActive

  • Returns true if a linear ad is currently active (playing or paused). Returns false otherwise.

    Returns boolean

    Since

    v8.0

list

  • Returns all scheduled ad breaks.

    Returns MKAdBreak[]

    Array containing all the scheduled ad breaks.

    Since

    v8.0

schedule

  • Schedules resulting ad break(s) of an ad config for playback.

    Parameters

    • adConfig: MKAdConfig

      The ad configuration used to schedule one or more ad breaks.

    Returns Promise<MKAdBreak[]>

    Promise that resolves with the ad breaks that were scheduled as a result of the given ad config.

    Since

    v8.0

skip

  • Skips the current ad. Has no effect if the ad is not skippable, if no ad is active or if the IMA module is used (disabled by IMA in version 3.607.0).

    Returns Promise<void>

    Promise that resolves when the ad has been skipped and the ad player is done with cleanup of events and states.

    Since

    v8.0

Settings

Member Visibility

Theme

On This Page