Class: shaka.ads.InterstitialAdManager

Constructor

new InterstitialAdManager(adContainer, player, onEvent)

Parameters:

Name	Type	Description
`adContainer`	HTMLElement
`player`	shaka.Player
`onEvent`	function

Implements:

shaka.util.IReleasable

Source:

lib/ads/interstitial_ad_manager.js, line 38

Members

adContainer_ :HTMLElement

Type:

HTMLElement

Source:

lib/ads/interstitial_ad_manager.js, line 49

adEventManager_ :shaka.util.EventManager

Type:

shaka.util.EventManager

Source:

lib/ads/interstitial_ad_manager.js, line 98

adVideo_ :HTMLMediaElement

Type:

HTMLMediaElement

Source:

lib/ads/interstitial_ad_manager.js, line 58

basePlayer_ :shaka.Player

Type:

shaka.Player

Source:

lib/ads/interstitial_ad_manager.js, line 52

baseVideo_ :HTMLMediaElement

Type:

HTMLMediaElement

Source:

lib/ads/interstitial_ad_manager.js, line 55

baseVideo_ :HTMLVideoElement

Type:

HTMLVideoElement

Source:

lib/ads/interstitial_ad_manager.js, line 287

baseVideo_ :HTMLVideoElement

Type:

HTMLVideoElement

Source:

lib/ads/interstitial_ad_manager.js, line 331

baseVideo_ :HTMLVideoElement

Type:

HTMLVideoElement

Source:

lib/ads/interstitial_ad_manager.js, line 354

config_ :shaka.extern.AdsConfiguration

Type:

shaka.extern.AdsConfiguration

Source:

lib/ads/interstitial_ad_manager.js, line 46

eventManager_ :shaka.util.EventManager

Type:

shaka.util.EventManager

Source:

lib/ads/interstitial_ad_manager.js, line 95

hlsMetadataIds_ :Set<string>

Type:

Set<string>

Source:

lib/ads/interstitial_ad_manager.js, line 70

interstitialIds_ :Set<string>

Type:

Set<string>

Source:

lib/ads/interstitial_ad_manager.js, line 73

interstitials_ :Set<shaka.extern.AdInterstitial>

Type:

Set<shaka.extern.AdInterstitial>

Source:

lib/ads/interstitial_ad_manager.js, line 76

lastOnSkip_ :?function()

Type:

?function()

Source:

lib/ads/interstitial_ad_manager.js, line 113

lastPlayedAd_ :shaka.extern.AdInterstitial

Type:

shaka.extern.AdInterstitial

Source:

lib/ads/interstitial_ad_manager.js, line 107

lastTime_ :number

Type:

number

Source:

lib/ads/interstitial_ad_manager.js, line 104

onEvent_ :function(!shaka.util.FakeEvent)

Type:

function(!shaka.util.FakeEvent)

Source:

lib/ads/interstitial_ad_manager.js, line 67

player_ :shaka.Player

Type:

shaka.Player

Source:

lib/ads/interstitial_ad_manager.js, line 90

playingAd_ :boolean

Type:

boolean

Source:

lib/ads/interstitial_ad_manager.js, line 101

playoutLimitTimer_ :shaka.util.Timer

Type:

shaka.util.Timer

Source:

lib/ads/interstitial_ad_manager.js, line 110

pollTimer_ :shaka.util.Timer

Type:

shaka.util.Timer

Source:

lib/ads/interstitial_ad_manager.js, line 197

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

Type:

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

Source:

lib/ads/interstitial_ad_manager.js, line 82

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

Type:

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

Source:

lib/ads/interstitial_ad_manager.js, line 87

timeUpdateTimer_ :shaka.util.Timer

Type:

shaka.util.Timer

Source:

lib/ads/interstitial_ad_manager.js, line 193

usingBaseVideo_ :boolean

Type:

boolean

Source:

lib/ads/interstitial_ad_manager.js, line 61

usingListeners_ :boolean

Type:

boolean

Source:

lib/ads/interstitial_ad_manager.js, line 116

video_ :HTMLMediaElement

Type:

HTMLMediaElement

Source:

lib/ads/interstitial_ad_manager.js, line 64

videoCallbackId_ :number

Type:

number

Source:

lib/ads/interstitial_ad_manager.js, line 119

Methods

addAdUrlInterstitial(url) → {Promise}

Parameters:

Name	Type	Description
`url`	string

Source:

lib/ads/interstitial_ad_manager.js, line 753

Returns:

Type: Promise

addEventListeners_()

Source:

lib/ads/interstitial_ad_manager.js, line 274

addInterstitials(interstitialsnon-null)

Parameters:

Name	Type	Description
`interstitials`	Array<shaka.extern.AdInterstitial>

Source:

lib/ads/interstitial_ad_manager.js, line 799

addMetadata(hlsMetadata)

Parameters:

Name	Type	Description
`hlsMetadata`	shaka.extern.HLSMetadata

Source:

lib/ads/interstitial_ad_manager.js, line 463

addOverlayRegion(region)

Parameters:

Name	Type	Description
`region`	shaka.extern.TimelineRegionInfo

Source:

lib/ads/interstitial_ad_manager.js, line 584

addRegion(region)

Parameters:

Name	Type	Description
`region`	shaka.extern.TimelineRegionInfo

Source:

lib/ads/interstitial_ad_manager.js, line 491

checkForInterstitials_()

Source:

lib/ads/interstitial_ad_manager.js, line 142

checkPreloadOnDomElements_(interstitialnon-null)

Parameters:

Name	Type	Description
`interstitial`	shaka.extern.AdInterstitial

Source:

lib/ads/interstitial_ad_manager.js, line 2126

configure(config)

Called by the AdManager to provide an updated configuration any time it changes.

Parameters:

Name	Type	Description
`config`	shaka.extern.AdsConfiguration

Source:

lib/ads/interstitial_ad_manager.js, line 264

createMediaElement_() → {HTMLMediaElement}

Source:

lib/ads/interstitial_ad_manager.js, line 853

Returns:

Type: HTMLMediaElement

cuepointsChanged_()

Source:

lib/ads/interstitial_ad_manager.js, line 2017

determineIfUsingBaseVideo_()

Source:

lib/ads/interstitial_ad_manager.js, line 347

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

Parameters:

Name	Type	Attributes	Default	Description
`needPreRoll`	boolean	<optional>	false
`numberToSkip`	number	<optional> <nullable>	null

Source:

lib/ads/interstitial_ad_manager.js, line 874

Returns:

Type: shaka.extern.AdInterstitial

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

Only for testing

Source:

lib/ads/interstitial_ad_manager.js, line 2103

Returns:

Type: Array<shaka.extern.AdInterstitial>

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

Parameters:

Name	Type	Description
`hlsMetadata`	shaka.extern.HLSMetadata

Source:

lib/ads/interstitial_ad_manager.js, line 1601

Returns:

Type: Promise<!Array<shaka.extern.AdInterstitial>>

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

Parameters:

Name	Type	Description
`hlsMetadata`	shaka.extern.HLSMetadata

Source:

lib/ads/interstitial_ad_manager.js, line 1823

Returns:

Type: Array<shaka.extern.AdInterstitial>

getPlayer() → {shaka.Player}

Source:

lib/ads/interstitial_ad_manager.js, line 456

Returns:

Type: shaka.Player

isPreloadAllowed_(interstitialnon-null) → {boolean}

Parameters:

Name	Type	Description
`interstitial`	shaka.extern.AdInterstitial

Source:

lib/ads/interstitial_ad_manager.js, line 2088

Returns:

Type: boolean

isSmartTV_() → {boolean}

Source:

lib/ads/interstitial_ad_manager.js, line 2111

Returns:

Type: boolean

isWithinPreloadWindow_(interstitialnon-null) → {boolean}

Parameters:

Name	Type	Description
`interstitial`	shaka.extern.AdInterstitial

Source:

lib/ads/interstitial_ad_manager.js, line 2265

Returns:

Type: boolean

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

Parameters:

Name	Type	Attributes	Description
`url`	string
`context`	shaka.extern.RequestContext	<optional>

Source:

lib/ads/interstitial_ad_manager.js, line 2072

Returns:

Type: Promise<BufferSource>

onSeeked_()

Source:

lib/ads/interstitial_ad_manager.js, line 178

onTimeUpdate_()

Source:

lib/ads/interstitial_ad_manager.js, line 157

processTrackingEvent_(type)

Parameters:

Name	Type	Description
`type`	string

Source:

lib/ads/interstitial_ad_manager.js, line 2187

release()

Request that this object release all internal references.

Implements:

shaka.util.IReleasable#release

Source:

lib/ads/interstitial_ad_manager.js, line 434

removeBaseStyles_(interstitialopt, nullable)

Parameters:

Name	Type	Attributes	Description
`interstitial`	shaka.extern.AdInterstitial	<optional> <nullable>

Source:

lib/ads/interstitial_ad_manager.js, line 1575

removeEventListeners_()

Source:

lib/ads/interstitial_ad_manager.js, line 318

removePreloadOnDomElements_(interstitialnon-null)

Parameters:

Name	Type	Description
`interstitial`	shaka.extern.AdInterstitial

Source:

lib/ads/interstitial_ad_manager.js, line 2160

sendEvent_(type, dictopt)

Parameters:

Name	Type	Attributes	Description
`type`	string
`dict`	Map<string, Object>	<optional>

Source:

lib/ads/interstitial_ad_manager.js, line 2177

sendTrackingEvent_(url)

Parameters:

Name	Type	Description
`url`	string

Source:

lib/ads/interstitial_ad_manager.js, line 2247

setBaseStyles_(interstitial)

Parameters:

Name	Type	Description
`interstitial`	shaka.extern.AdInterstitial

Source:

lib/ads/interstitial_ad_manager.js, line 1515

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:

lib/ads/interstitial_ad_manager.js, line 948

setupStaticAd_(interstitial, sequenceLength, adPosition, oncePlayed)

Parameters:

Name	Type	Description
`interstitial`	shaka.extern.AdInterstitial
`sequenceLength`	number
`adPosition`	number
`oncePlayed`	number

Source:

lib/ads/interstitial_ad_manager.js, line 1013

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:

lib/ads/interstitial_ad_manager.js, line 1158

stop()

Resets the Interstitial manager and removes any continuous polling.

Source:

lib/ads/interstitial_ad_manager.js, line 387

updatePlayerConfig_()

Source:

lib/ads/interstitial_ad_manager.js, line 2054

Type Definitions

Asset

Type:

{URI: string, DURATION: number, X-AD-CREATIVE-SIGNALING: ?shaka.extern.AdCreativeSignaling.CarriageEnvelope}

Properties:

Name	Type	Attributes	Description
`URI`	string
`DURATION`	number
`X-AD-CREATIVE-SIGNALING`	shaka.extern.AdCreativeSignaling.CarriageEnvelope	<nullable>

Source:

lib/ads/interstitial_ad_manager.js, line 2315

AssetsList

Type:

{ASSETS: !Array<shaka.ads.InterstitialAdManager.Asset>, SKIP-CONTROL: ?shaka.ads.InterstitialAdManager.SkipControl, X-AD-CREATIVE-SIGNALING: ?shaka.extern.AdCreativeSignaling.CarriageEnvelope}

Properties:

Name	Type	Attributes	Description
`ASSETS`	Array<shaka.ads.InterstitialAdManager.Asset>
`SKIP-CONTROL`	shaka.ads.InterstitialAdManager.SkipControl	<nullable>
`X-AD-CREATIVE-SIGNALING`	shaka.extern.AdCreativeSignaling.CarriageEnvelope	<nullable>

Source:

lib/ads/interstitial_ad_manager.js, line 2299

SkipControl

Type:

{OFFSET: number, DURATION: number}

Properties:

Name	Type	Description
`OFFSET`	number
`DURATION`	number

Source:

lib/ads/interstitial_ad_manager.js, line 2328