Class: shaka.ads.Utils

Constructor

new Utils()

Source:

Members

AD_BREAK_READY :string

The event name for when the client side SDK signalled its readiness to play a VPAID ad or an ad rule.
Type:
  • string
Source:

AD_BUFFERING :string

The event name for when the ad is buffering.
Type:
  • string
Source:

AD_CLICKED :string

The event name for when the ad was clicked.
Type:
  • string
Source:

AD_CLOSED :string

The event name for when the ad was closed by the user.
Type:
  • string
Source:

AD_COMPLETE :string

The event name for when an ad has completed playing.
Type:
  • string
Source:

AD_CONTENT_ATTACH_REQUESTED :string

The name of the event for when an ad requires the video of the main content to be attached.
Type:
  • string
Source:

AD_CONTENT_PAUSE_REQUESTED :string

The name of the event for when an ad requires the main content to be paused. Fired when the platform does not support multiple media elements.
Type:
  • string
Source:

AD_CONTENT_RESUME_REQUESTED :string

The name of the event for when an ad requires the main content to be resumed. Fired when the platform does not support multiple media elements.
Type:
  • string
Source:

AD_DURATION_CHANGED :string

The event name for when the ad's duration changed.
Type:
  • string
Source:

AD_ERROR :string

The event name for when the ad manager dispatch errors.
Type:
  • string
Source:

AD_FIRST_QUARTILE :string

The event name for when an ad playhead crosses first quartile.
Type:
  • string
Source:

AD_IMPRESSION :string

The event name for when the ad's URL was hit.
Type:
  • string
Source:

AD_INTERACTION :string

The event name for when the interaction callback for the ad was triggered.
Type:
  • string
Source:

AD_LINEAR_CHANGED :string

The event name for when the ad changes from or to linear.
Type:
  • string
Source:

AD_LOADED :string

The event name for when the ad data becomes available.
Type:
  • string
Source:

AD_METADATA :string

The event name for when the ad's metadata becomes available.
Type:
  • string
Source:

AD_MIDPOINT :string

The event name for when an ad playhead crosses midpoint.
Type:
  • string
Source:

AD_MUTED :string

The event name for when the ad was muted.
Type:
  • string
Source:

AD_PAUSED :string

The event name for when the ad was paused.
Type:
  • string
Source:

AD_PROGRESS :string

The event name for when there is an update to the current ad's progress.
Type:
  • string
Source:

AD_RECOVERABLE_ERROR :string

The event name for when the ad display encountered a recoverable error.
Type:
  • string
Source:

AD_RESUMED :string

The event name for when the ad was resumed after a pause.
Type:
  • string
Source:

AD_SKIP_STATE_CHANGED :string

The event name for when the ad's skip status changes (usually it becomes skippable when it wasn't before).
Type:
  • string
Source:

AD_SKIPPED :string

The event name for when an ad is skipped by the user..
Type:
  • string
Source:

AD_STARTED :string

The event name for when an ad has started playing.
Type:
  • string
Source:

AD_STOPPED :string

The event name for when an ad has finished playing (played all the way through, was skipped, or was unable to proceed due to an error).
Type:
  • string
Source:

AD_THIRD_QUARTILE :string

The event name for when an ad playhead crosses third quartile.
Type:
  • string
Source:

AD_VOLUME_CHANGED :string

The event name for when the ad volume has changed.
Type:
  • string
Source:

ADS_LOADED :string

The event name for when a sequence of ads has been loaded.
Type:
  • string
Source:

ALL_ADS_COMPLETED :string

The event name for when all the ads were completed.
Type:
  • string
Source:

CUEPOINTS_CHANGED :string

The event name for when the ad's cue points (start/end markers) have changed.
Type:
  • string
Source:

IMA_AD_MANAGER_LOADED :string

The event name for when the native IMA ad manager object has loaded and become available.
Type:
  • string
Source:

IMA_STREAM_MANAGER_LOADED :string

The event name for when the native IMA stream manager object has loaded and become available.
Type:
  • string
Source:

Methods

parseVastToInterstitials(vastnon-null, currentTimenullable) → {Array<shaka.extern.AdInterstitial>}

Parameters:
Name Type Attributes Description
vast shaka.extern.xml.Node
currentTime number <nullable>
Source:
Returns:
Type
Array<shaka.extern.AdInterstitial>

parseVMAP(vmapnon-null) → {Array<{time: ?number, uri: string}>}

Parameters:
Name Type Description
vmap shaka.extern.xml.Node
Source:
Returns:
Type
Array<{time: ?number, uri: string}>

processLinearAd_(interstitialsnon-null, currentTimenullable, linearnon-null)

Parameters:
Name Type Attributes Description
interstitials Array<shaka.extern.AdInterstitial>
currentTime number <nullable>
linear shaka.extern.xml.Node
Source:

processNonLinearAd_(interstitialsnon-null, currentTimenullable, nonLinearnon-null)

Parameters:
Name Type Attributes Description
interstitials Array<shaka.extern.AdInterstitial>
currentTime number <nullable>
nonLinear shaka.extern.xml.Node
Source:

Events

AD_ERROR

Fired when a fatal error is encountered.
Properties:
Name Type Description
type string 'ad-error'
originalEvent Object The native SDK event, if available.
Source: