LiveTracker(player, optionsopt)

A class for checking live current time and determining when the player is at or behind the live edge.

new LiveTracker(player, optionsopt)
live-tracker.js, line 18

Creates an instance of this class.

Parameters:
Name Type Attributes Description
player default

The Player that this class should be attached to.
options Object <optional>

The key/value store of player options.

Properties
Name Type Attributes Default Description
trackingThreshold number <optional>
 20

Number of seconds of live window (seekableEnd - seekableStart) that media needs to have before the liveui will be shown.
liveTolerance number <optional>
 15

Number of seconds behind live that we have to be before we will be considered non-live. Note that this will only be used when playing at the live edge. This allows large seekable end changes to not effect whether we are live or not.

Methods

atLiveEdge() → {boolean}
live-tracker.js, line 305

Determines if currentTime is at the live edge and won't fall behind on each seekableendchange

Returns:
boolean -

Whether playback is at the live edge

behindLiveEdge() → {boolean}
live-tracker.js, line 343

If we are currently behind the live edge, aka currentTime will be behind on a seekableendchange

Returns:
boolean -

If we are behind the live edge

dispose()
live-tracker.js, line 370

Dispose of liveTracker

handleDurationchange()
live-tracker.js, line 106

handle a durationchange event on the player and start/stop tracking accordingly.

handleFirstTimeupdate()
live-tracker.js, line 157

handle the first timeupdate on the player if it wasn't already playing when live tracker started tracking.

handlePlay()
live-tracker.js, line 178

handle the first play on the player, and make sure that we seek right to the live edge.

handleSeeked()
live-tracker.js, line 166

Keep track of what time a seek starts, and listen for seeked to find where a seek ends.

isLive() → {boolean}
live-tracker.js, line 294

Determines if the player is live, only checks if this component is tracking live playback or not

Returns:
boolean -

Whether liveTracker is tracking

isTracking()
live-tracker.js, line 350

Whether live tracker is currently tracking or not.

liveCurrentTime() → {number}
live-tracker.js, line 315

get what we expect the live current time to be

Returns:
number -

The expected live current time

liveWindow() → {number}
live-tracker.js, line 276

Get the live time window aka the amount of time between seekable start and live current time.

Returns:
number -

The amount of seconds that are seekable in the live video.

nextSeekedFromUser()
live-tracker.js, line 210

The next seeked event is from the user. Meaning that any seek

2s behind live will be considered behind live for real and liveTolerance will be ignored.

pastSeekEnd() → {number}
live-tracker.js, line 326

The number of seconds that have occurred after seekable end changed. This will be reset to 0 once seekable end changes.

Returns:
number -

Seconds past the current seekable end

reset_()
live-tracker.js, line 186

Stop tracking, and set all internal variables to their initial value.

seekableEnd() → {number}
live-tracker.js, line 232

A helper to get the player seekable end so that we don't have to null check everywhere

Returns:
number -

The furthest seekable end or Infinity.

seekableStart() → {number}
live-tracker.js, line 253

A helper to get the player seekable start so that we don't have to null check everywhere

Returns:
number -

The earliest seekable start or 0.

seekToLiveEdge()
live-tracker.js, line 357

Seek to the live edge if we are behind the live edge

startTracking()
live-tracker.js, line 128

start tracking live playback

stopTracking()
live-tracker.js, line 217

stop tracking live playback

toggleTracking()
live-tracker.js, line 113

start/stop tracking

trackLive_()
live-tracker.js, line 63

all the functionality for tracking when seek end changes and for tracking how far past seek end we should be