Class OmapIABClient

An OMAP client implentation for IAB specifaication.

const omapClient = new OmapIABClient(adTagUrl);

Implements

default

Constructors

constructor

new OmapIABClient(adTagUrl, httpClient?, prefetchableOffset?, prefetchThreshold?): OmapIABClient
Parameters
- adTagUrl: string
  AD Tag URI
- Optional httpClient: default
  You can specify your own HTTP client. If you don't specify, the default HTTP client will be used.
- prefetchableOffset: number = 5
  Offset time to let the IAB client prefetch ad data.
- prefetchThreshold: number = 2
  The threshold of giving up prefetching ad data.
Returns OmapIABClient
- Defined in iab-client/src/IABClient.ts:43

Properties

`Protected` httpClient

httpClient: default = ...

`Protected` prefetchThreshold

prefetchThreshold: number = 2

`Protected` prefetchableOffset

prefetchableOffset: number = 5

Methods

attachAdInsertionDecider

attachAdInsertionDecider(decider): void
Parameters
- decider: ((currentTime, adBreaks, countAdBreakConsumption) => undefined | default)
  - - (currentTime, adBreaks, countAdBreakConsumption): undefined | default
    - Parameters
      currentTime: number
      adBreaks: default[]
      countAdBreakConsumption: ((adBreak) => number)
      (adBreak): number
      Parameters
      adBreak: default
      Returns number
      Returns undefined | default
Returns void
Implementation of IOmapClient.attachAdInsertionDecider
- Defined in iab-client/src/IABClient.ts:61

destroy

destroy(): void
Returns void
Implementation of IOmapClient.destroy
- Defined in iab-client/src/IABClient.ts:53

`Protected` emit

emit(type): void
Parameters
- type: "contentCanPlay"
Returns void
- Defined in iab-client/src/IABClient.ts:261
emit(type): void
Parameters
- type: "contentPauseRequested"
Returns void
- Defined in iab-client/src/IABClient.ts:262
emit(type): void
Parameters
- type: "contentResumeRequested"
Returns void
- Defined in iab-client/src/IABClient.ts:263
emit(type): void
Parameters
- type: "allAdsCompleted"
Returns void
- Defined in iab-client/src/IABClient.ts:264
emit(type, adBreaks): void
Parameters
- type: "loaded"
- adBreaks: default[]
Returns void
- Defined in iab-client/src/IABClient.ts:265
emit(type): void
Parameters
- type: "load_error"
Returns void
- Defined in iab-client/src/IABClient.ts:266
emit(type): void
Parameters
- type: "started"
Returns void
- Defined in iab-client/src/IABClient.ts:267
emit(type): void
Parameters
- type: "complete"
Returns void
- Defined in iab-client/src/IABClient.ts:268
emit(type, adPodInsertionRequest): void
Parameters
- type: "adPodPreparationRequested"
- adPodInsertionRequest: default
Returns void
- Defined in iab-client/src/IABClient.ts:269
emit(type, adPodInsertionRequest): void
Parameters
- type: "adPodInsertionRequested"
- adPodInsertionRequest: default
Returns void
- Defined in iab-client/src/IABClient.ts:270
emit(type): void
Parameters
- type: "adPodInsertionRequestFailed"
Returns void
- Defined in iab-client/src/IABClient.ts:271

hasAdPodInsertionAt

hasAdPodInsertionAt(time): boolean
Parameters
- time: number
Returns boolean
Implementation of IOmapClient.hasAdPodInsertionAt
- Defined in iab-client/src/IABClient.ts:219

notifyAdCreativeEnded

notifyAdCreativeEnded(adCreative, adSequence): void
Parameters
- adCreative: default
- adSequence: number
Returns void
Implementation of IOmapClient.notifyAdCreativeEnded
- Defined in iab-client/src/IABClient.ts:194

notifyAdCreativePlaying

notifyAdCreativePlaying(adCreative, elapsedTime, adSequence): void
Parameters
- adCreative: default
- elapsedTime: number
- adSequence: number
Returns void
Implementation of IOmapClient.notifyAdCreativePlaying
- Defined in iab-client/src/IABClient.ts:170

notifyAdPlaybackError

notifyAdPlaybackError(ad): void
Parameters
- ad: default
Returns void
Implementation of IOmapClient.notifyAdPlaybackError
- Defined in iab-client/src/IABClient.ts:158

notifyAdPodEnded

notifyAdPodEnded(): void
Returns void
Implementation of IOmapClient.notifyAdPodEnded
- Defined in iab-client/src/IABClient.ts:131

notifyAdPodSkipped

notifyAdPodSkipped(): void
Returns void
Implementation of IOmapClient.notifyAdPodSkipped
- Defined in iab-client/src/IABClient.ts:142

notifyAdStarted

notifyAdStarted(ad): void
Parameters
- ad: default
Returns void
Implementation of IOmapClient.notifyAdStarted
- Defined in iab-client/src/IABClient.ts:146

notifyContentEnded

notifyContentEnded(): void
Returns void
- Defined in iab-client/src/IABClient.ts:205

notifyCurrentTime

notifyCurrentTime(currentTime): void
Parameters
- currentTime: number
Returns void
Implementation of IOmapClient.notifyCurrentTime
- Defined in iab-client/src/IABClient.ts:106

off

off(type, listener): void
Parameters
- type: "contentCanPlay"
- listener: (() => void)
  - - (): void
    - Returns void
Returns void
Implementation of IOmapClient.off
- Defined in iab-client/src/IABClient.ts:86
off(type, listener): void
Parameters
- type: "contentPauseRequested"
- listener: (() => void)
  - - (): void
    - Returns void
Returns void
Implementation of IOmapClient.off
- Defined in iab-client/src/IABClient.ts:87
off(type, listener): void
Parameters
- type: "contentResumeRequested"
- listener: (() => void)
  - - (): void
    - Returns void
Returns void
Implementation of IOmapClient.off
- Defined in iab-client/src/IABClient.ts:88
off(type, listener): void
Parameters
- type: "allAdsCompleted"
- listener: (() => void)
  - - (): void
    - Returns void
Returns void
Implementation of IOmapClient.off
- Defined in iab-client/src/IABClient.ts:89
off(type, listener): void
Parameters
- type: "loaded"
- listener: ((adBreaks) => void)
  - - (adBreaks): void
    - Parameters
      adBreaks: default[]
      Returns void
Returns void
Implementation of IOmapClient.off
- Defined in iab-client/src/IABClient.ts:90
off(type, listener): void
Parameters
- type: "load_error"
- listener: (() => void)
  - - (): void
    - Returns void
Returns void
Implementation of IOmapClient.off
- Defined in iab-client/src/IABClient.ts:91
off(type, listener): void
Parameters
- type: "started"
- listener: (() => void)
  - - (): void
    - Returns void
Returns void
Implementation of IOmapClient.off
- Defined in iab-client/src/IABClient.ts:92
off(type, listener): void
Parameters
- type: "complete"
- listener: (() => void)
  - - (): void
    - Returns void
Returns void
Implementation of IOmapClient.off
- Defined in iab-client/src/IABClient.ts:93
off(type, listener): void
Parameters
- type: "adPodInsertionRequested"
- listener: ((adPodInsertionRequest) => void)
  - - (adPodInsertionRequest): void
    - Parameters
      adPodInsertionRequest: default
      Returns void
Returns void
Implementation of IOmapClient.off
- Defined in iab-client/src/IABClient.ts:94
off(type, listener): void
Parameters
- type: "adPodInsertionRequestFailed"
- listener: (() => void)
  - - (): void
    - Returns void
Returns void
Implementation of IOmapClient.off
- Defined in iab-client/src/IABClient.ts:95
off(type, listener): void
Parameters
- type: "adPodPreparationRequested"
- listener: ((adPodInsertionRequest) => void)
  - - (adPodInsertionRequest): void
    - Parameters
      adPodInsertionRequest: default
      Returns void
Returns void
Implementation of IOmapClient.off
- Defined in iab-client/src/IABClient.ts:96

on

on(type, listener): void
Parameters
- type: "contentCanPlay"
- listener: (() => void)
  - - (): void
    - Returns void
Returns void
Implementation of IOmapClient.on
- Defined in iab-client/src/IABClient.ts:71
on(type, listener): void
Parameters
- type: "contentPauseRequested"
- listener: (() => void)
  - - (): void
    - Returns void
Returns void
Implementation of IOmapClient.on
- Defined in iab-client/src/IABClient.ts:72
on(type, listener): void
Parameters
- type: "contentResumeRequested"
- listener: (() => void)
  - - (): void
    - Returns void
Returns void
Implementation of IOmapClient.on
- Defined in iab-client/src/IABClient.ts:73
on(type, listener): void
Parameters
- type: "allAdsCompleted"
- listener: (() => void)
  - - (): void
    - Returns void
Returns void
Implementation of IOmapClient.on
- Defined in iab-client/src/IABClient.ts:74
on(type, listener): void
Parameters
- type: "loaded"
- listener: ((adBreaks) => void)
  - - (adBreaks): void
    - Parameters
      adBreaks: default[]
      Returns void
Returns void
Implementation of IOmapClient.on
- Defined in iab-client/src/IABClient.ts:75
on(type, listener): void
Parameters
- type: "load_error"
- listener: (() => void)
  - - (): void
    - Returns void
Returns void
Implementation of IOmapClient.on
- Defined in iab-client/src/IABClient.ts:76
on(type, listener): void
Parameters
- type: "started"
- listener: (() => void)
  - - (): void
    - Returns void
Returns void
Implementation of IOmapClient.on
- Defined in iab-client/src/IABClient.ts:77
on(type, listener): void
Parameters
- type: "complete"
- listener: (() => void)
  - - (): void
    - Returns void
Returns void
Implementation of IOmapClient.on
- Defined in iab-client/src/IABClient.ts:78
on(type, listener): void
Parameters
- type: "adPodInsertionRequested"
- listener: ((adPodInsertionRequest) => void)
  - - (adPodInsertionRequest): void
    - Parameters
      adPodInsertionRequest: default
      Returns void
Returns void
Implementation of IOmapClient.on
- Defined in iab-client/src/IABClient.ts:79
on(type, listener): void
Parameters
- type: "adPodInsertionRequestFailed"
- listener: (() => void)
  - - (): void
    - Returns void
Returns void
Implementation of IOmapClient.on
- Defined in iab-client/src/IABClient.ts:80
on(type, listener): void
Parameters
- type: "adPodPreparationRequested"
- listener: ((adPodInsertionRequest) => void)
  - - (adPodInsertionRequest): void
    - Parameters
      adPodInsertionRequest: default
      Returns void
Returns void
Implementation of IOmapClient.on
- Defined in iab-client/src/IABClient.ts:81

`Protected` onContentTimeUpdate

onContentTimeUpdate(currentTime, adBreaks, requestAdInsertion, countAdBreakConsumption): void
Parameters
- currentTime: number
- adBreaks: default[]
- requestAdInsertion: ((adBreak) => void)
  - - (adBreak): void
    - Parameters
      adBreak: default
      Returns void
- countAdBreakConsumption: ((adBreak) => number)
  - - (adBreak): number
    - Parameters
      adBreak: default
      Returns number
Returns void
- Defined in iab-client/src/IABClient.ts:229

play

play(): void
Returns void
Implementation of IOmapClient.play
- Defined in iab-client/src/IABClient.ts:57

Class OmapIABClient

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

adTagUrl: string

Optional httpClient: default

prefetchableOffset: number = 5

prefetchThreshold: number = 2

Returns OmapIABClient

Properties

Protected httpClient

Protected prefetchThreshold

Protected prefetchableOffset

Methods

attachAdInsertionDecider

Parameters

decider: ((currentTime, adBreaks, countAdBreakConsumption) => undefined | default)

Parameters

currentTime: number

adBreaks: default[]

countAdBreakConsumption: ((adBreak) => number)

Parameters

adBreak: default

Returns number

Returns undefined | default

Returns void

destroy

Returns void

Protected emit

Parameters

type: "contentCanPlay"

Returns void

Parameters

type: "contentPauseRequested"

Returns void

Parameters

type: "contentResumeRequested"

Returns void

Parameters

type: "allAdsCompleted"

Returns void

Parameters

type: "loaded"

adBreaks: default[]

Returns void

Parameters

type: "load_error"

Returns void

Parameters

type: "started"

Returns void

Parameters

type: "complete"

Returns void

Parameters

type: "adPodPreparationRequested"

adPodInsertionRequest: default

Returns void

Parameters

type: "adPodInsertionRequested"

adPodInsertionRequest: default

Returns void

Parameters

type: "adPodInsertionRequestFailed"

Returns void

hasAdPodInsertionAt

Parameters

time: number

Returns boolean

notifyAdCreativeEnded

Parameters

adCreative: default

adSequence: number

Returns void

notifyAdCreativePlaying

`Optional` httpClient: default

`Protected` httpClient

`Protected` prefetchThreshold

`Protected` prefetchableOffset

`Protected` emit