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 29

Members

BREAK_END_ :string

Type:

string

Source:

lib/ads/media_tailor_ad_manager.js, line 895

BREAK_START_ :string

Type:

string

Source:

lib/ads/media_tailor_ad_manager.js, line 888

COMPLETE_ :string

Type:

string

Source:

lib/ads/media_tailor_ad_manager.js, line 874

FIRSTQUARTILE_ :string

Type:

string

Source:

lib/ads/media_tailor_ad_manager.js, line 853

IMPRESSION_ :string

Type:

string

Source:

lib/ads/media_tailor_ad_manager.js, line 811

MIDPOINT_ :string

Type:

string

Source:

lib/ads/media_tailor_ad_manager.js, line 860

MUTE_ :string

Type:

string

Source:

lib/ads/media_tailor_ad_manager.js, line 825

PAUSE_ :string

Type:

string

Source:

lib/ads/media_tailor_ad_manager.js, line 846

RESUME_ :string

Type:

string

Source:

lib/ads/media_tailor_ad_manager.js, line 839

SKIP_STATE_CHANGED_ :string

Type:

string

Source:

lib/ads/media_tailor_ad_manager.js, line 902

SKIPPED_ :string

Type:

string

Source:

lib/ads/media_tailor_ad_manager.js, line 881

START_ :string

Type:

string

Source:

lib/ads/media_tailor_ad_manager.js, line 818

THIRDQUARTILE_ :string

Type:

string

Source:

lib/ads/media_tailor_ad_manager.js, line 867

UNMUTE_ :string

Type:

string

Source:

lib/ads/media_tailor_ad_manager.js, line 832

ad_ :shaka.ads.MediaTailorAd

Type:

shaka.ads.MediaTailorAd

Source:

lib/ads/media_tailor_ad_manager.js, line 72

adBreaks_ :Array<!mediaTailor.AdBreak>

Type:

Array<!mediaTailor.AdBreak>

Source:

lib/ads/media_tailor_ad_manager.js, line 66

adContainer_ :HTMLElement

Type:

HTMLElement

Source:

lib/ads/media_tailor_ad_manager.js, line 38

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 87

backupUrl_ :string

Type:

string

Source:

lib/ads/media_tailor_ad_manager.js, line 99

currentCuePoints_ :Array<!shaka.extern.AdCuePoint>

Type:

Array<!shaka.extern.AdCuePoint>

Source:

lib/ads/media_tailor_ad_manager.js, line 102

eventManager_ :shaka.util.EventManager

Type:

shaka.util.EventManager

Source:

lib/ads/media_tailor_ad_manager.js, line 105

eventsSent :Array<string>

Type:

Array<string>

Source:

lib/ads/media_tailor_ad_manager.js, line 90

firstTrackingRequest_ :boolean

Type:

boolean

Source:

lib/ads/media_tailor_ad_manager.js, line 96

isLive_ :boolean

Type:

boolean

Source:

lib/ads/media_tailor_ad_manager.js, line 56

mediaTailorAd_ :mediaTailor.Ad

Type:

mediaTailor.Ad

Source:

lib/ads/media_tailor_ad_manager.js, line 75

mediaTailorAdBreak_ :mediaTailor.AdBreak

Type:

mediaTailor.AdBreak

Source:

lib/ads/media_tailor_ad_manager.js, line 78

networkingEngine_ :shaka.net.NetworkingEngine

Type:

shaka.net.NetworkingEngine

Source:

lib/ads/media_tailor_ad_manager.js, line 41

onEvent_ :function(!shaka.util.FakeEvent)

Type:

function(!shaka.util.FakeEvent)

Source:

lib/ads/media_tailor_ad_manager.js, line 53

playedAds_ :Array<string>

Type:

Array<string>

Source:

lib/ads/media_tailor_ad_manager.js, line 69

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 63

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

Type:

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

Source:

lib/ads/media_tailor_ad_manager.js, line 81

streamPromise_ :shaka.util.PublicPromise<string>

Type:

shaka.util.PublicPromise<string>

Source:

lib/ads/media_tailor_ad_manager.js, line 47

streamRequestStartTime_ :number

Type:

number

Source:

lib/ads/media_tailor_ad_manager.js, line 50

trackingUrl_ :string

Type:

string

Source:

lib/ads/media_tailor_ad_manager.js, line 93

video_ :HTMLMediaElement

Type:

HTMLMediaElement

Source:

lib/ads/media_tailor_ad_manager.js, line 44

Methods

addTrackingUrl(url)

Parameters:

Name	Type	Description
`url`	string

Source:

lib/ads/media_tailor_ad_manager.js, line 134

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 393

checkLinearAds_(currentTime)

Parameters:

Name	Type	Description
`currentTime`	number

Source:

lib/ads/media_tailor_ad_manager.js, line 516

checkNonLinearAds_(currentTime)

Parameters:

Name	Type	Description
`currentTime`	number

Source:

lib/ads/media_tailor_ad_manager.js, line 557

displayNonLinearAd_(appsnon-null)

Parameters:

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

Source:

lib/ads/media_tailor_ad_manager.js, line 597

getCacheKeyForNonLinear_(nonLinearAd) → {string}

Parameters:

Name	Type	Description
`nonLinearAd`	mediaTailor.NonLinearAd

Source:

lib/ads/media_tailor_ad_manager.js, line 351

Returns:

Type: string

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

Source:

lib/ads/media_tailor_ad_manager.js, line 185

Returns:

Type: Array<!shaka.extern.AdCuePoint>

onAdBreakEnded_()

Source:

lib/ads/media_tailor_ad_manager.js, line 434

onEnded_()

Source:

lib/ads/media_tailor_ad_manager.js, line 618

onManifestUpdated(isLive)

Fired when the manifest is updated

Parameters:

Name	Type	Description
`isLive`	boolean

Source:

lib/ads/media_tailor_ad_manager.js, line 173

onTimeupdate_()

Source:

lib/ads/media_tailor_ad_manager.js, line 448

release()

Request that this object release all internal references.

Implements:

shaka.util.IReleasable#release

Source:

lib/ads/media_tailor_ad_manager.js, line 161

removeCurrentAdListeners_(skippedopt)

Parameters:

Name	Type	Attributes	Default	Description
`skipped`	boolean	<optional>	false

Source:

lib/ads/media_tailor_ad_manager.js, line 699

requestSessionInfo_(url, adsParams)

Parameters:

Name	Type	Description
`url`	string
`adsParams`	Object

Source:

lib/ads/media_tailor_ad_manager.js, line 205

requestStaticResource_(nonLinearAd)

Parameters:

Name	Type	Description
`nonLinearAd`	mediaTailor.NonLinearAd

Source:

lib/ads/media_tailor_ad_manager.js, line 313

requestTrackingInfo_(trackingUrl, firstRequest)

Parameters:

Name	Type	Description
`trackingUrl`	string
`firstRequest`	boolean

Source:

lib/ads/media_tailor_ad_manager.js, line 261

sendInProgressEvents_(currentTime, ad)

Parameters:

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

Source:

lib/ads/media_tailor_ad_manager.js, line 489

sendTrackingEvent_(eventType)

Parameters:

Name	Type	Description
`eventType`	string

Source:

lib/ads/media_tailor_ad_manager.js, line 717

setupAdBreakListeners_()

Setup Ad Break listeners

Source:

lib/ads/media_tailor_ad_manager.js, line 371

setupCurrentAdListeners_()

Source:

lib/ads/media_tailor_ad_manager.js, line 642

stop()

Resets the MediaTailor manager and removes any continuous polling.

Source:

lib/ads/media_tailor_ad_manager.js, line 143

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 114

Returns:

Type: Promise<string>