Interface: shaka.extern.IAdManager

Implementations:
Source:

Methods

addAdUrlInterstitial(url) → {Promise}

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

addCustomInterstitial(interstitial)

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

addMediaTailorTrackingUrl(url)

Parameters:
Name Type Description
url string
Source:

configure(config)

Called by the Player to provide an updated configuration any time it changes. Must be called at least once before init*().
Parameters:
Name Type Description
config shaka.extern.AdsConfiguration
Source:

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

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

getInterstitialPlayer() → {shaka.Player}

Source:
Returns:
Type
shaka.Player

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

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

getStats()

Get statistics for the current playback session. If the player is not playing content, this will return an empty stats object.
Source:

initClientSide(adContainernon-null, videonon-null, adsRenderingSettingsnullable)

Parameters:
Name Type Attributes Description
adContainer HTMLElement
video HTMLMediaElement
adsRenderingSettings google.ima.AdsRenderingSettings <nullable>
Source:

initInterstitial(adContainernullable, basePlayernon-null, baseVideonon-null)

Parameters:
Name Type Attributes Description
adContainer HTMLElement <nullable>
basePlayer shaka.Player
baseVideo HTMLMediaElement
Source:

initMediaTailor(adContainernon-null, networkingEnginenon-null, videonon-null)

Parameters:
Name Type Description
adContainer HTMLElement
networkingEngine shaka.net.NetworkingEngine
video HTMLMediaElement
Source:

initServerSide(adContainernon-null, videonon-null)

Parameters:
Name Type Description
adContainer HTMLElement
video HTMLMediaElement
Source:

onCueMetadataChange(value)

Parameters:
Name Type Description
value shaka.extern.MetadataFrame
Source:

onDASHInterstitialMetadata(basePlayernon-null, baseVideonon-null, region)

Parameters:
Name Type Description
basePlayer shaka.Player
baseVideo HTMLMediaElement
region shaka.extern.TimelineRegionInfo
Source:

onDashTimedMetadata(region)

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

onHLSInterstitialMetadata(basePlayernon-null, baseVideonon-null, interstitial)

Parameters:
Name Type Description
basePlayer shaka.Player
baseVideo HTMLMediaElement
interstitial shaka.extern.HLSInterstitial
Source:

onHlsTimedMetadata(metadata, timestampOffset)

Parameters:
Name Type Description
metadata shaka.extern.ID3Metadata
timestampOffset number
Source:

onManifestUpdated(isLive)

Fired when the manifest is updated.
Parameters:
Name Type Description
isLive boolean
Source:

replaceServerSideAdTagParameters(adTagParameters)

Parameters:
Name Type Description
adTagParameters Object
Source:

requestClientSideAds(imaRequestnon-null)

Parameters:
Name Type Description
imaRequest google.ima.AdsRequest
Source:

requestMediaTailorStream(url, adsParams, backupUrlopt) → {Promise<string>}

Parameters:
Name Type Attributes Description
url string
adsParams Object
backupUrl string <optional>
Source:
Returns:
Type
Promise<string>

requestServerSideStream(imaRequestnon-null, backupUrlopt) → {Promise<string>}

Parameters:
Name Type Attributes Description
imaRequest google.ima.dai.api.StreamRequest
backupUrl string <optional>
Source:
Returns:
Type
Promise<string>

setLocale(locale)

Parameters:
Name Type Description
locale string
Source:

updateClientSideAdsRenderingSettings(adsRenderingSettingsnon-null)

Parameters:
Name Type Description
adsRenderingSettings google.ima.AdsRenderingSettings
Source:

Type Definitions

Factory

A factory for creating the ad manager.
Type:
  • function(): !shaka.extern.IAdManager
Source: