Interface IOmapBinder

Interface for OMAP binder implementations

interface IOmapBinder {
    state: TOmapBinderState;
    trickyMediaPlayerHandler?: Object;
    bind(omapClient): void;
    destroy(): void;
    off(type, listener): void;
    off(type, listener): void;
    off(type, listener): void;
    off(type, listener): void;
    off(type, listener): void;
    off(type, listener): void;
    on(type, listener): void;
    on(type, listener): void;
    on(type, listener): void;
    on(type, listener): void;
    on(type, listener): void;
    on(type, listener): void;
    play(startTime?): Promise<void>;
    skip(): void;
    updateConfig(config): void;
}

Properties

state trickyMediaPlayerHandler?

Methods

bind destroy off on play skip updateConfig

Properties

Readonly state

state: TOmapBinderState

The binder's state

Optional Readonly trickyMediaPlayerHandler

trickyMediaPlayerHandler?: Object

The tricky media player handler can be provided where some interaction with the media player needs to be done in a tricky way. In that case, use the tricky media player handler's methods instead of those of the media player itself.

Methods

bind

  • bind(omapClient): void

  • Will bind an OMAP client to the media player that the binder uses.

    Parameters

    Returns void

destroy

off

  • off(type, listener): void

  • Use the on method to remove listeners for the AD_POD_STARTED event.

    Parameters

    • type: "adPodStarted"

      the type of event : BinderEvent.AD_POD_STARTED

    • listener: (() => void)

      the listener function

        • (): void

        • Returns void

    Returns void

  • off(type, listener): void

  • Use the on method to remove listeners for the AD_POD_ENDED event.

    Parameters

    • type: "adPodEnded"

      the type of event : BinderEvent.AD_POD_ENDED

    • listener: (() => void)

      the listener function

        • (): void

        • Returns void

    Returns void

  • off(type, listener): void

  • Use the on method to remove listeners for the AD_STARTED event.

    Parameters

    • type: "adStarted"

      the type of event : BinderEvent.AD_STARTED

    • listener: ((ad) => void)

      the listener function

        • (ad): void

        • Parameters

          Returns void

    Returns void

  • off(type, listener): void

  • Use the on method to remove listeners for the AD_ENDED event.

    Parameters

    • type: "adEnded"

      the type of event : BinderEvent.AD_ENDED

    • listener: ((ad) => void)

      the listener function

        • (ad): void

        • Parameters

          Returns void

    Returns void

  • off(type, listener): void

  • Use the on method to remove listeners for the AD_INFO_UPDATED event.

    Parameters

    • type: "adInfoUpdated"

      the type of event : BinderEvent.AD_INFO_UPDATED

    • listener: ((sequence, numOfAds, remainingTime, duration) => void)

      the listener function

        • (sequence, numOfAds, remainingTime, duration): void

        • Parameters

          • sequence: number
          • numOfAds: number
          • remainingTime: number
          • duration: number

          Returns void

    Returns void

  • off(type, listener): void

  • Use the on method to remove listeners for the AD_SKIPPABLE_STATE_CHANGED event.

    Parameters

    • type: "adSkippableStateChanged"

      the type of event : BinderEvent.AD_SKIPPABLE_STATE_CHANGED

    • listener: (() => void)

      the listener function

        • (): void

        • Returns void

    Returns void

on

  • on(type, listener): void

  • Use the on method to listen for the AD_POD_STARTED event.

    Parameters

    • type: "adPodStarted"

      the type of event : BinderEvent.AD_POD_STARTED

    • listener: (() => void)

      the listener function

        • (): void

        • Returns void

    Returns void

  • on(type, listener): void

  • Use the on method to listen for the AD_POD_ENDED event.

    Parameters

    • type: "adPodEnded"

      the type of event : BinderEvent.AD_POD_ENDED

    • listener: (() => void)

      the listener function

        • (): void

        • Returns void

    Returns void

  • on(type, listener): void

  • Use the on method to listen for the AD_STARTED event.

    Parameters

    • type: "adStarted"

      the type of event : BinderEvent.AD_STARTED

    • listener: ((ad) => void)

      the listener function

        • (ad): void

        • Parameters

          Returns void

    Returns void

  • on(type, listener): void

  • Use the on method to listen for the AD_ENDED event.

    Parameters

    • type: "adEnded"

      the type of event : BinderEvent.AD_ENDED

    • listener: ((ad) => void)

      the listener function

        • (ad): void

        • Parameters

          Returns void

    Returns void

  • on(type, listener): void

  • Use the on method to listen for the AD_INFO_UPDATED event.

    Parameters

    • type: "adInfoUpdated"

      the type of event : BinderEvent.AD_INFO_UPDATED

    • listener: ((sequence, numOfAds, remainingTime, duration) => void)

      the listener function

        • (sequence, numOfAds, remainingTime, duration): void

        • Parameters

          • sequence: number
          • numOfAds: number
          • remainingTime: number
          • duration: number

          Returns void

    Returns void

  • on(type, listener): void

  • Use the on method to listen for the AD_SKIPPABLE_STATE_CHANGED event.

    Parameters

    • type: "adSkippableStateChanged"

      the type of event : BinderEvent.AD_SKIPPABLE_STATE_CHANGED

    • listener: ((skippable) => void)

      the listener function

        • (skippable): void

        • Parameters

          • skippable: boolean

          Returns void

    Returns void

play

  • play(startTime?): Promise<void>

  • Will start playing the OMAP client.

    Parameters

    • Optional startTime: number

      the start time in seconds.

    Returns Promise<void>

skip

updateConfig

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc