Class: shaka.ads.ClientSideAd

Constructor

new ClientSideAd(imaAdnon-null, imaAdManagernon-null, video)

Parameters:
Name Type Description
imaAd google.ima.Ad
imaAdManager google.ima.AdsManager
video HTMLMediaElement
Implements:
Source:

Members

ad_ :google.ima.Ad

Type:
  • google.ima.Ad
Source:

eventManager_ :shaka.util.EventManager

Type:
Source:

isPaused_ :boolean

Type:
  • boolean
Source:

manager_ :google.ima.AdsManager

Type:
  • google.ima.AdsManager
Source:

video_ :HTMLMediaElement

Type:
Source:

video_ :HTMLVideoElement

Type:
  • HTMLVideoElement
Source:

volume_ :number

Type:
  • number
Source:

Methods

canSkipNow() → {boolean}

Implements:
Source:
Returns:
Type
boolean

getAdId() → {string}

Implements:
Source:
Returns:
Type
string

getAdvertiserName() → {string}

Implements:
Source:
Returns:
Type
string

getCreativeAdId() → {string}

Implements:
Source:
Returns:
Type
string

getDescription() → {string}

Implements:
Source:
Returns:
Type
string

getDuration() → {number}

Implements:
Source:
Returns:
Type
number

getMediaUrl() → {string}

Implements:
Source:
Returns:
Type
string

getMinSuggestedDuration() → {number}

Gets the minimum suggested duration. Defaults to being equivalent to getDuration() for server-side ads.
Implements:
Source:
See:
Returns:
Type
number

getPodIndex() → {number}

Implements:
Source:
Returns:
Type
number

getPositionInSequence() → {number}

Implements:
Source:
Returns:
Type
number

getRemainingTime() → {number}

Implements:
Source:
Returns:
Type
number

getSequenceLength() → {number}

Implements:
Source:
Returns:
Type
number

getTimeOffset() → {number}

Implements:
Source:
Returns:
Type
number

getTimeUntilSkippable() → {number}

Implements:
Source:
Returns:
Type
number

getTitle() → {string}

Implements:
Source:
Returns:
Type
string

getVastMediaBitrate() → {number}

Implements:
Source:
Returns:
Type
number

getVastMediaHeight() → {number}

Implements:
Source:
Returns:
Type
number

getVastMediaWidth() → {number}

Implements:
Source:
Returns:
Type
number

getVolume() → {number}

Implements:
Source:
Returns:
Type
number

isLinear() → {boolean}

Implements:
Source:
Returns:
Type
boolean

isMuted() → {boolean}

Implements:
Source:
Returns:
Type
boolean

isPaused() → {boolean}

Implements:
Source:
Returns:
Type
boolean

isSkippable() → {boolean}

Implements:
Source:
Returns:
Type
boolean

needsSkipUI() → {boolean}

Implements:
Source:
Returns:
Type
boolean

pause()

Source:

play()

Source:

release()

Request that this object release all internal references.
Inherited From:
Implements:
Source:

resize(width, height)

Parameters:
Name Type Description
width number
height number
Implements:
Source:

setInitialMuted(videoVolume)

It's required for a muted ad to start when autoplaying.
Parameters:
Name Type Description
videoVolume number
Source:

setMuted(muted)

Parameters:
Name Type Description
muted boolean
Implements:
Source:

setPaused(paused)

Parameters:
Name Type Description
paused boolean
Source:

setVolume(volume)

Parameters:
Name Type Description
volume number
Implements:
Source:

skip()

Source: