JSDoc: Class: shaka.ads.MediaTailorAdManager

Class: shaka.ads.MediaTailorAdManager

Constructor

new MediaTailorAdManager(adContainer, networkingEngine, video, onEvent)

Parameters:

Name	Type	Description
`adContainer`	HTMLElement
`networkingEngine`	shaka.net.NetworkingEngine
`video`	HTMLMediaElement
`onEvent`	function

Implements:

shaka.util.IReleasable

Source:

lib/ads/media_tailor_ad_manager.js, line 32

Members

BREAKEND_ :string

Type:

string

Source:

lib/ads/media_tailor_ad_manager.js, line 854

BREAKSTART_ :string

Type:

string

Source:

lib/ads/media_tailor_ad_manager.js, line 847

COMPLETE_ :string

Type:

string

Source:

lib/ads/media_tailor_ad_manager.js, line 840

FIRSTQUARTILE_ :string

Type:

string

Source:

lib/ads/media_tailor_ad_manager.js, line 819

IMPRESSION_ :string

Type:

string

Source:

lib/ads/media_tailor_ad_manager.js, line 777

MIDPOINT_ :string

Type:

string

Source:

lib/ads/media_tailor_ad_manager.js, line 826

MUTE_ :string

Type:

string

Source:

lib/ads/media_tailor_ad_manager.js, line 791

PAUSE_ :string

Type:

string

Source:

lib/ads/media_tailor_ad_manager.js, line 812

RESUME_ :string

Type:

string

Source:

lib/ads/media_tailor_ad_manager.js, line 805

START_ :string

Type:

string

Source:

lib/ads/media_tailor_ad_manager.js, line 784

THIRDQUARTILE_ :string

Type:

string

Source:

lib/ads/media_tailor_ad_manager.js, line 833

UNMUTE_ :string

Type:

string

Source:

lib/ads/media_tailor_ad_manager.js, line 798

ad_ :shaka.ads.MediaTailorAd

Type:

shaka.ads.MediaTailorAd

Source:

lib/ads/media_tailor_ad_manager.js, line 75

adBreaks_ :Array.<!mediaTailor.AdBreak>

Type:

Array.<!mediaTailor.AdBreak>

Source:

lib/ads/media_tailor_ad_manager.js, line 69

adContainer_ :HTMLElement

Type:

HTMLElement

Source:

lib/ads/media_tailor_ad_manager.js, line 41

adListeners_ :Array.<{target: EventTarget, type: string, listener: shaka.util.EventManager.ListenerType}>

Type:

Array.<{target: EventTarget, type: string, listener: shaka.util.EventManager.ListenerType}>

Source:

lib/ads/media_tailor_ad_manager.js, line 89

backupUrl_ :string

Type:

string

Source:

lib/ads/media_tailor_ad_manager.js, line 101

currentCuePoints_ :Array.<!shaka.extern.AdCuePoint>

Type:

Array.<!shaka.extern.AdCuePoint>

Source:

lib/ads/media_tailor_ad_manager.js, line 104

eventManager_ :shaka.util.EventManager

Type:

shaka.util.EventManager

Source:

lib/ads/media_tailor_ad_manager.js, line 107

eventsSent :Array.<string>

Type:

Array.<string>

Source:

lib/ads/media_tailor_ad_manager.js, line 92

firstTrackingRequest_ :boolean

Type:

boolean

Source:

lib/ads/media_tailor_ad_manager.js, line 98

isLive_ :boolean

Type:

boolean

Source:

lib/ads/media_tailor_ad_manager.js, line 59

mediaTailorAd_ :mediaTailor.Ad

Type:

mediaTailor.Ad

Source:

lib/ads/media_tailor_ad_manager.js, line 78

mediaTailorAdBreak_ :mediaTailor.AdBreak

Type:

mediaTailor.AdBreak

Source:

lib/ads/media_tailor_ad_manager.js, line 81

networkingEngine_ :shaka.net.NetworkingEngine

Type:

shaka.net.NetworkingEngine

Source:

lib/ads/media_tailor_ad_manager.js, line 44

onEvent_ :function(!shaka.util.FakeEvent)

Type:

function(!shaka.util.FakeEvent)

Source:

lib/ads/media_tailor_ad_manager.js, line 56

playedAds_ :Array.<string>

Type:

Array.<string>

Source:

lib/ads/media_tailor_ad_manager.js, line 72

snapForwardTime_ :number

Time to seek to after an ad if that ad was played as the result of snapback.

Type:

number

Source:

lib/ads/media_tailor_ad_manager.js, line 66

staticResources_ :Map.<string, !Array.<mediaTailorExternalResource.App>>

Type:

Map.<string, !Array.<mediaTailorExternalResource.App>>

Source:

lib/ads/media_tailor_ad_manager.js, line 84

streamPromise_ :shaka.util.PublicPromise.<string>

Type:

shaka.util.PublicPromise.<string>

Source:

lib/ads/media_tailor_ad_manager.js, line 50

streamRequestStartTime_ :number

Type:

number

Source:

lib/ads/media_tailor_ad_manager.js, line 53

trackingUrl_ :string

Type:

string

Source:

lib/ads/media_tailor_ad_manager.js, line 95

video_ :HTMLMediaElement

Type:

HTMLMediaElement

Source:

lib/ads/media_tailor_ad_manager.js, line 47

Methods

addTrackingUrl(url)

Parameters:

Name	Type	Description
`url`	string

Source:

lib/ads/media_tailor_ad_manager.js, line 136

checkForSnapback_()

If a seek jumped over the ad break, return to the start of the ad break, then complete the seek after the ad played through.

Source:

lib/ads/media_tailor_ad_manager.js, line 383

checkLinearAds_(currentTime)

Parameters:

Name	Type	Description
`currentTime`	number

Source:

lib/ads/media_tailor_ad_manager.js, line 502

checkNonLinearAds_(currentTime)

Parameters:

Name	Type	Description
`currentTime`	number

Source:

lib/ads/media_tailor_ad_manager.js, line 543

displayNonLinearAd_(appsnon-null)

Parameters:

Name	Type	Description
`apps`	Array.<mediaTailorExternalResource.App>

Source:

lib/ads/media_tailor_ad_manager.js, line 583

getCacheKeyForNonLinear_(nonLinearAd) → {string}

Parameters:

Name	Type	Description
`nonLinearAd`	mediaTailor.NonLinearAd

Source:

lib/ads/media_tailor_ad_manager.js, line 341

Returns:

Type: string

getCuePoints() → {Array.<!shaka.extern.AdCuePoint>}

Source:

lib/ads/media_tailor_ad_manager.js, line 187

Returns:

Type: Array.<!shaka.extern.AdCuePoint>

onAdBreakEnded_()

Source:

lib/ads/media_tailor_ad_manager.js, line 424

onEnded_()

Source:

lib/ads/media_tailor_ad_manager.js, line 604

onManifestUpdated(isLive)

Fired when the manifest is updated

Parameters:

Name	Type	Description
`isLive`	boolean

Source:

lib/ads/media_tailor_ad_manager.js, line 175

onTimeupdate_()

Source:

lib/ads/media_tailor_ad_manager.js, line 438

release()

Request that this object release all internal references.

Implements:

shaka.util.IReleasable#release

Source:

lib/ads/media_tailor_ad_manager.js, line 163

removeCurrentAdListeners_()

Source:

lib/ads/media_tailor_ad_manager.js, line 684

requestSessionInfo_(url, adsParams)

Parameters:

Name	Type	Description
`url`	string
`adsParams`	Object

Source:

lib/ads/media_tailor_ad_manager.js, line 207

requestStaticResource_(nonLinearAd)

Parameters:

Name	Type	Description
`nonLinearAd`	mediaTailor.NonLinearAd

Source:

lib/ads/media_tailor_ad_manager.js, line 307

requestTrackingInfo_(trackingUrl, firstRequest)

Parameters:

Name	Type	Description
`trackingUrl`	string
`firstRequest`	boolean

Source:

lib/ads/media_tailor_ad_manager.js, line 259

sendInProgressEvents_(currentTime, ad)

Parameters:

Name	Type	Description
`currentTime`	number
`ad`	mediaTailor.Ad

Source:

lib/ads/media_tailor_ad_manager.js, line 475

sendTrackingEvent_(eventType)

Parameters:

Name	Type	Description
`eventType`	string

Source:

lib/ads/media_tailor_ad_manager.js, line 698

setupAdBreakListeners_()

Setup Ad Break listeners

Source:

lib/ads/media_tailor_ad_manager.js, line 361

setupCurrentAdListeners_()

Source:

lib/ads/media_tailor_ad_manager.js, line 628

stop()

Resets the MediaTailor manager and removes any continuous polling.

Source:

lib/ads/media_tailor_ad_manager.js, line 145

streamRequest(url, adsParams, backupUrl) → {Promise.<string>}

Parameters:

Name	Type	Description
`url`	string
`adsParams`	Object
`backupUrl`	string

Source:

lib/ads/media_tailor_ad_manager.js, line 116

Returns:

Type: Promise.<string>