Class: shaka.ads.InterstitialAd

Constructor

new InterstitialAd(video, isSkippable, skipOffsetnullable, onSkip, sequenceLength, adPosition)

Parameters:
Name Type Attributes Description
video HTMLMediaElement
isSkippable boolean
skipOffset number <nullable>
onSkip function
sequenceLength number
adPosition number
Implements:
Source:

Members

adPosition_ :number

Type:
  • number
Source:

isSkippable_ :boolean

Type:
  • boolean
Source:

onSkip_ :function()

Type:
  • function()
Source:

sequenceLength_ :number

Type:
  • number
Source:

skipOffset_ :number

Type:
  • number
Source:

video_ :HTMLMediaElement

Type:
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

isClientRendering() → {boolean}

Implements:
Source:
Returns:
Type
boolean

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:

setMuted(muted)

Parameters:
Name Type Description
muted boolean
Implements:
Source:

setVolume(volume)

Parameters:
Name Type Description
volume number
Implements:
Source:

skip()

Source: