Class: shaka.ads.MediaTailorAd

Constructor

new MediaTailorAd(mediaTailorAd, adPosition, totalAds, video)

Parameters:
Name Type Description
mediaTailorAd mediaTailor.Ad
adPosition number
totalAds number
video HTMLMediaElement
Implements:
Source:

Members

timeFormat_ :RegExp

Type:
  • RegExp
Source:
Example
00:00.000 or 00:00:00.000 or 0:00:00.000 or
00:00.00 or 00:00:00.00 or 0:00:00.00 or 00:00:00

ad_ :mediaTailor.Ad

Type:
  • mediaTailor.Ad
Source:

adPosition_ :number

Type:
  • number
Source:

isLinear_ :boolean

Type:
  • boolean
Source:

isSkipped_ :boolean

Type:
  • boolean
Source:

skipOffset_ :number

Type:
  • number
Source:

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

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

isSkipped() → {boolean}

Source:
Returns:
Type
boolean

parseTime_(timenullable) → {number}

Parses a time from string.
Parameters:
Name Type Attributes Description
time string <nullable>
Source:
Returns:
Type
number

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: