Class OmapDashjsBinder

Dash.js binder for OMAP clients.

const player = dashjs.MediaPlayer().create();
const adDisplayContainer = document.getElementById('ad-display-container') as HTMLDivElement;
const adVideoElement = document.getElementById('ad-video') as HTMLVideoElement;
const adTagUrl = 'https://example.com/vmap.xml';
const omapClient = new OmapIABClient(adTagUrl);
const omapBinder = new OmapDashjsBinder(player, adDisplayContainer);
omapBinder.bind(omapClient);
omapBinder.play()
    .then(() => {
        player.initialize(videoElement, 'https://example.com/manifest.mpd', true);
    })
    .catch(() => {
        console.error('adBinder failed to get ready');
    });

Implements

default

Index

Constructors

constructor

new OmapDashjsBinder(player, adDisplayContainer, adVideoElement?): OmapDashjsBinder
Parameters
- player: MediaPlayerClass
  the dash.js player instance
- adDisplayContainer: HTMLElement
  the HTMLElement to contain ad video and UI
- Optional adVideoElement: HTMLVideoElement
  the HTMLVideoElement to playback ad video
Returns OmapDashjsBinder
- Defined in dashjs-binder/src/DashjsBinder.ts:49

Properties

`Protected` adBreaks

adBreaks: default[] = []

`Protected` adDisplayContainer

adDisplayContainer: HTMLElement

`Protected` `Optional` adVideoElement

adVideoElement?: HTMLVideoElement

`Protected` config

config: Partial<default> = {}

`Protected` dashjs

dashjs: MediaPlayerClass

`Protected` `Optional` omapClient

omapClient?: default

Accessors

state

get state(): TBinderState
Returns TBinderState
Implementation of IOmapBinder.state
- Defined in dashjs-binder/src/DashjsBinder.ts:85

Methods

`Protected` _onAllAdsCompleted

_onAllAdsCompleted(): void
Returns void
- Defined in dashjs-binder/src/DashjsBinder.ts:233

bind

bind(omapClient): void
Parameters
- omapClient: default
Returns void
Implementation of IOmapBinder.bind
- Defined in dashjs-binder/src/DashjsBinder.ts:95

destroy

destroy(): void
Returns void
Implementation of IOmapBinder.destroy
- Defined in dashjs-binder/src/DashjsBinder.ts:89

`Protected` emit

emit(type): void
Parameters
- type: "adPodStarted"
Returns void
- Defined in dashjs-binder/src/DashjsBinder.ts:208
emit(type): void
Parameters
- type: "adPodEnded"
Returns void
- Defined in dashjs-binder/src/DashjsBinder.ts:209
emit(type, ad): void
Parameters
- type: "adStarted"
- ad: default
Returns void
- Defined in dashjs-binder/src/DashjsBinder.ts:210
emit(type, ad): void
Parameters
- type: "adEnded"
- ad: default
Returns void
- Defined in dashjs-binder/src/DashjsBinder.ts:211
emit(type, sequence, numOfAds, remainingTime, duration): void
Parameters
- type: "adInfoUpdated"
- sequence: number
- numOfAds: number
- remainingTime: number
- duration: number
Returns void
- Defined in dashjs-binder/src/DashjsBinder.ts:212
emit(type): void
Parameters
- type: "adSkippableStateChanged"
Returns void
- Defined in dashjs-binder/src/DashjsBinder.ts:213

off

off(type, listener): void
Parameters
- type: "adPodStarted"
- listener: (() => void)
  - - (): void
    - Returns void
Returns void
Implementation of IOmapBinder.off
- Defined in dashjs-binder/src/DashjsBinder.ts:168
off(type, listener): void
Parameters
- type: "adPodEnded"
- listener: (() => void)
  - - (): void
    - Returns void
Returns void
Implementation of IOmapBinder.off
- Defined in dashjs-binder/src/DashjsBinder.ts:172
off(type, listener): void
Parameters
- type: "adStarted"
- listener: ((ad) => void)
  - - (ad): void
    - Parameters
      ad: default
      Returns void
Returns void
Implementation of IOmapBinder.off
- Defined in dashjs-binder/src/DashjsBinder.ts:176
off(type, listener): void
Parameters
- type: "adEnded"
- listener: ((ad) => void)
  - - (ad): void
    - Parameters
      ad: default
      Returns void
Returns void
Implementation of IOmapBinder.off
- Defined in dashjs-binder/src/DashjsBinder.ts:180
off(type, listener): void
Parameters
- type: "adInfoUpdated"
- listener: ((sequence, numOfAds, remainingTime, duration) => void)
  - - (sequence, numOfAds, remainingTime, duration): void
    - Parameters
      sequence: number
      numOfAds: number
      remainingTime: number
      duration: number
      Returns void
Returns void
Implementation of IOmapBinder.off
- Defined in dashjs-binder/src/DashjsBinder.ts:184
off(type, listener): void
Parameters
- type: "adSkippableStateChanged"
- listener: (() => void)
  - - (): void
    - Returns void
Returns void
Implementation of IOmapBinder.off
- Defined in dashjs-binder/src/DashjsBinder.ts:188

on

on(type, listener): void
Parameters
- type: "adPodStarted"
- listener: (() => void)
  - - (): void
    - Returns void
Returns void
Implementation of IOmapBinder.on
- Defined in dashjs-binder/src/DashjsBinder.ts:140
on(type, listener): void
Parameters
- type: "adPodEnded"
- listener: (() => void)
  - - (): void
    - Returns void
Returns void
Implementation of IOmapBinder.on
- Defined in dashjs-binder/src/DashjsBinder.ts:144
on(type, listener): void
Parameters
- type: "adStarted"
- listener: ((ad) => void)
  - - (ad): void
    - Parameters
      ad: default
      Returns void
Returns void
Implementation of IOmapBinder.on
- Defined in dashjs-binder/src/DashjsBinder.ts:148
on(type, listener): void
Parameters
- type: "adEnded"
- listener: ((ad) => void)
  - - (ad): void
    - Parameters
      ad: default
      Returns void
Returns void
Implementation of IOmapBinder.on
- Defined in dashjs-binder/src/DashjsBinder.ts:152
on(type, listener): void
Parameters
- type: "adInfoUpdated"
- listener: ((sequence, numOfAds, remainingTime, duration) => void)
  - - (sequence, numOfAds, remainingTime, duration): void
    - Parameters
      sequence: number
      numOfAds: number
      remainingTime: number
      duration: number
      Returns void
Returns void
Implementation of IOmapBinder.on
- Defined in dashjs-binder/src/DashjsBinder.ts:156
on(type, listener): void
Parameters
- type: "adSkippableStateChanged"
- listener: ((skippable) => void)
  - - (skippable): void
    - Parameters
      skippable: boolean
      Returns void
Returns void
Implementation of IOmapBinder.on
- Defined in dashjs-binder/src/DashjsBinder.ts:160

`Protected` onAdEnded

onAdEnded(ad, adDisplayContainer): void
Parameters
- ad: default
- adDisplayContainer: HTMLElement
Returns void
- Defined in dashjs-binder/src/DashjsBinder.ts:263

`Protected` onAdPodEnded

onAdPodEnded(adPod, adDisplayContainer): void
Parameters
- adPod: default
- adDisplayContainer: HTMLElement
Returns void
- Defined in dashjs-binder/src/DashjsBinder.ts:254

`Protected` onAdPodStarted

onAdPodStarted(adPod, adDisplayContainer): void
Parameters
- adPod: default
- adDisplayContainer: HTMLElement
Returns void
- Defined in dashjs-binder/src/DashjsBinder.ts:250

`Protected` onAdProgress

onAdProgress(ad, adDisplayContainer, adCurrentTime, numOfAds): void
Parameters
- ad: default
- adDisplayContainer: HTMLElement
- adCurrentTime: number
- numOfAds: number
Returns void
- Defined in dashjs-binder/src/DashjsBinder.ts:268

`Protected` onAdSkippable

onAdSkippable(ad, adDisplayContainer, adCurrentTime, numOfAds): void
Parameters
- ad: default
- adDisplayContainer: HTMLElement
- adCurrentTime: number
- numOfAds: number
Returns void
- Defined in dashjs-binder/src/DashjsBinder.ts:285

`Protected` onAdStarted

onAdStarted(ad, adDisplayContainer): void
Parameters
- ad: default
- adDisplayContainer: HTMLElement
Returns void
- Defined in dashjs-binder/src/DashjsBinder.ts:258

`Protected` onContentCanPlay

onContentCanPlay(): void
Returns void
- Defined in dashjs-binder/src/DashjsBinder.ts:229

`Protected` onContentPauseRequested

onContentPauseRequested(): void
Returns void
- Defined in dashjs-binder/src/DashjsBinder.ts:237

`Protected` onContentResumeRequested

onContentResumeRequested(): void
Returns void
- Defined in dashjs-binder/src/DashjsBinder.ts:245

`Protected` onTimeUpdate

onTimeUpdate(e): void
Parameters
- e: PlaybackTimeUpdatedEvent
Returns void
- Defined in dashjs-binder/src/DashjsBinder.ts:221

play

play(startTime?): Promise<void>
Parameters
- startTime: number = 0
Returns Promise<void>
Implementation of IOmapBinder.play
- Defined in dashjs-binder/src/DashjsBinder.ts:118

skip

skip(): void
Returns void
Implementation of IOmapBinder.skip
- Defined in dashjs-binder/src/DashjsBinder.ts:130

updateConfig

updateConfig(config): void
Parameters
- config: Partial<default>
Returns void
Implementation of IOmapBinder.updateConfig
- Defined in dashjs-binder/src/DashjsBinder.ts:136

Class OmapDashjsBinder

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

player: MediaPlayerClass

adDisplayContainer: HTMLElement

Optional adVideoElement: HTMLVideoElement

Returns OmapDashjsBinder

Properties

Protected adBreaks

Protected adDisplayContainer

Protected Optional adVideoElement

Protected config

Protected dashjs

Protected Optional omapClient

Accessors

state

Returns TBinderState

Methods

Protected _onAllAdsCompleted

Returns void

bind

Parameters

omapClient: default

Returns void

destroy

Returns void

Protected emit

Parameters

type: "adPodStarted"

Returns void

Parameters

type: "adPodEnded"

Returns void

Parameters

type: "adStarted"

ad: default

Returns void

Parameters

type: "adEnded"

ad: default

Returns void

Parameters

type: "adInfoUpdated"

sequence: number

numOfAds: number

remainingTime: number

duration: number

Returns void

Parameters

type: "adSkippableStateChanged"

Returns void

off

Parameters

type: "adPodStarted"

listener: (() => void)

Returns void

Returns void

Parameters

type: "adPodEnded"

listener: (() => void)

Returns void

Returns void

Parameters

type: "adStarted"

listener: ((ad) => void)

Parameters

ad: default

Returns void

Returns void

Parameters

type: "adEnded"

listener: ((ad) => void)

Parameters

`Optional` adVideoElement: HTMLVideoElement

`Protected` adBreaks

`Protected` adDisplayContainer

`Protected` `Optional` adVideoElement

`Protected` config

`Protected` dashjs

`Protected` `Optional` omapClient

`Protected` _onAllAdsCompleted

`Protected` emit

`Protected` onAdEnded

`Protected` onAdPodEnded