Class: shaka.ads.InterstitialAdManager

Constructor

new InterstitialAdManager(adContainer, basePlayer, baseVideo, onEvent)

Parameters:
Name Type Description
adContainer HTMLElement
basePlayer shaka.Player
baseVideo HTMLMediaElement
onEvent function
Implements:
Source:

Members

adContainer_ :HTMLElement

Type:
  • HTMLElement
Source:

adEventManager_ :shaka.util.EventManager

Type:
Source:

adVideo_ :HTMLMediaElement

Type:
Source:

basePlayer_ :shaka.Player

Type:
Source:

baseVideo_ :HTMLMediaElement

Type:
Source:

baseVideo_ :HTMLVideoElement

Type:
  • HTMLVideoElement
Source:

baseVideo_ :HTMLVideoElement

Type:
  • HTMLVideoElement
Source:

baseVideo_ :HTMLVideoElement

Type:
  • HTMLVideoElement
Source:

config_ :shaka.extern.AdsConfiguration

Type:
Source:

eventManager_ :shaka.util.EventManager

Type:
Source:

interstitialIds_ :Set.<string>

Type:
  • Set.<string>
Source:

interstitials_ :Set.<shaka.extern.AdInterstitial>

Type:
Source:

lastOnSkip_ :?function()

Type:
  • ?function()
Source:

lastPlayedAd_ :shaka.extern.AdInterstitial

Type:
Source:

lastTime_ :number

Type:
  • number
Source:

onEvent_ :function(!shaka.util.FakeEvent)

Type:
  • function(!shaka.util.FakeEvent)
Source:

player_ :shaka.Player

Type:
Source:

playingAd_ :boolean

Type:
  • boolean
Source:

playoutLimitTimer_ :shaka.util.Timer

Type:
Source:

pollTimer_ :shaka.util.Timer

Type:
Source:

preloadManagerInterstitials_ :Map.<shaka.extern.AdInterstitial, Promise.<?shaka.media.PreloadManager>>

Type:
Source:

preloadOnDomElements_ :Map.<shaka.extern.AdInterstitial, !Array.<!HTMLLinkElement>>

Type:
Source:

timeUpdateTimer_ :shaka.util.Timer

Type:
Source:

usingBaseVideo_ :boolean

Type:
  • boolean
Source:

usingListeners_ :boolean

Type:
  • boolean
Source:

video_ :HTMLMediaElement

Type:
Source:

videoCallbackId_ :number

Type:
  • number
Source:

Methods

addAdUrlInterstitial(url) → {Promise}

Parameters:
Name Type Description
url string
Source:
Returns:
Type
Promise

addEventListeners_()

Source:

addInterstitials(interstitialsnon-null)

Parameters:
Name Type Description
interstitials Array.<shaka.extern.AdInterstitial>
Source:

addMetadata(hlsInterstitial)

Parameters:
Name Type Description
hlsInterstitial shaka.extern.HLSInterstitial
Source:

addOverlayRegion(region)

Parameters:
Name Type Description
region shaka.extern.TimelineRegionInfo
Source:

addRegion(region)

Parameters:
Name Type Description
region shaka.extern.TimelineRegionInfo
Source:

checkForInterstitials_()

Source:

checkPreloadOnDomElements_(interstitialnon-null)

Parameters:
Name Type Description
interstitial shaka.extern.AdInterstitial
Source:

configure(config)

Called by the AdManager to provide an updated configuration any time it changes.
Parameters:
Name Type Description
config shaka.extern.AdsConfiguration
Source:

createMediaElement_() → {HTMLMediaElement}

Source:
Returns:
Type
HTMLMediaElement

cuepointsChanged_()

Source:

determineIfUsingBaseVideo_()

Source:

getCurrentInterstitial_(needPreRollopt, numberToSkipopt, nullable) → {shaka.extern.AdInterstitial}

Parameters:
Name Type Attributes Default Description
needPreRoll boolean <optional>
 false
numberToSkip number <optional>
<nullable>
 null
Source:
Returns:
Type
shaka.extern.AdInterstitial

getInterstitials() → {Array.<shaka.extern.AdInterstitial>}

Only for testing
Source:
Returns:
Type
Array.<shaka.extern.AdInterstitial>

getInterstitialsInfo_(hlsInterstitial) → {Promise.<!Array.<shaka.extern.AdInterstitial>>}

Parameters:
Name Type Description
hlsInterstitial shaka.extern.HLSInterstitial
Source:
Returns:
Type
Promise.<!Array.<shaka.extern.AdInterstitial>>

getPlayer() → {shaka.Player}

Source:
Returns:
Type
shaka.Player

isPreloadAllowed_(interstitialnon-null) → {boolean}

Parameters:
Name Type Description
interstitial shaka.extern.AdInterstitial
Source:
Returns:
Type
boolean

makeAdRequest_(url, contextopt) → {Promise.<BufferSource>}

Parameters:
Name Type Attributes Description
url string
context shaka.extern.RequestContext <optional>
Source:
Returns:
Type
Promise.<BufferSource>

onTimeUpdate_()

Source:

release()

Request that this object release all internal references.
Implements:
Source:

removeBaseStyles_(interstitialopt, nullable)

Parameters:
Name Type Attributes Description
interstitial shaka.extern.AdInterstitial <optional>
<nullable>
Source:

removeEventListeners_()

Source:

removePreloadOnDomElements_(interstitialnon-null)

Parameters:
Name Type Description
interstitial shaka.extern.AdInterstitial
Source:

setBaseStyles_(interstitial)

Parameters:
Name Type Description
interstitial shaka.extern.AdInterstitial
Source:

setupAd_(interstitial, sequenceLength, adPosition, initialTime, oncePlayedopt)

Parameters:
Name Type Attributes Default Description
interstitial shaka.extern.AdInterstitial
sequenceLength number
adPosition number
initialTime number the clock time the ad started at
oncePlayed number <optional>
 0
Source:

setupStaticAd_(interstitial, sequenceLength, adPosition, oncePlayed)

Parameters:
Name Type Description
interstitial shaka.extern.AdInterstitial
sequenceLength number
adPosition number
oncePlayed number
Source:

setupVideoAd_(interstitial, sequenceLength, adPosition, initialTime, oncePlayed)

Parameters:
Name Type Description
interstitial shaka.extern.AdInterstitial
sequenceLength number
adPosition number
initialTime number the clock time the ad started at
oncePlayed number
Source:

stop()

Resets the Interstitial manager and removes any continuous polling.
Source:

updatePlayerConfig_()

Source:

Type Definitions

Asset

Type:
  • {URI: string}
Properties:
Name Type Description
URI string
Source:

AssetsList

Type:
Properties:
Name Type Description
ASSETS Array.<shaka.ads.InterstitialAdManager.Asset>
SKIP-CONTROL shaka.ads.InterstitialAdManager.SkipControl
Source:

SkipControl

Type:
  • {ENABLE-SKIP-AFTER: number, ENABLE-SKIP-FOR: number}
Properties:
Name Type Description
ENABLE-SKIP-AFTER number
ENABLE-SKIP-FOR number
Source: