Class: shaka.util.Stats

Constructor

new Stats()

Source:

Members

bandwidthEstimate_ :number

Type:
  • number
Source:

bytesDownloaded_ :number

Type:
  • number
Source:

completionPercent_ :number

Type:
  • number
Source:

currentStreamBandwidth_ :number

Type:
  • number
Source:

drmTimeSeconds_ :number

Type:
  • number
Source:

height_ :number

Type:
  • number
Source:

licenseTimeSeconds_ :number

Type:
  • number
Source:

liveLatencySeconds_ :number

Type:
  • number
Source:

loadLatencySeconds_ :number

Type:
  • number
Source:

manifestGapCount_ :number

Type:
  • number
Source:

manifestPeriodCount_ :number

Type:
  • number
Source:

manifestSizeBytes_ :number

Type:
  • number
Source:

manifestTimeSeconds_ :number

Type:
  • number
Source:

maxSegmentDurationSeconds_ :number

Type:
  • number
Source:

nonFatalErrorCount_ :number

Type:
  • number
Source:

stateHistory_ :shaka.util.StateHistory

Type:
Source:

switchHistory_ :shaka.util.SwitchHistory

Type:
Source:

totalCorruptedFrames_ :number

Type:
  • number
Source:

totalDecodedFrames_ :number

Type:
  • number
Source:

totalDroppedFrames_ :number

Type:
  • number
Source:

totalGapsJumped_ :number

Type:
  • number
Source:

totalStallsDetected_ :number

Type:
  • number
Source:

width_ :number

Type:
  • number
Source:

Methods

getEmptyBlob() → {shaka.extern.Stats}

Create an empty stats blob. This resembles the stats when we are not playing any content.
Source:
Returns:
Type
shaka.extern.Stats

addBytesDownloaded(bytesDownloaded)

Parameters:
Name Type Description
bytesDownloaded number
Source:

addNonFatalError()

Source:

getBlob() → {shaka.extern.Stats}

Create a stats blob that we can pass up to the app. This blob will not reference any internal data.
Source:
Returns:
Type
shaka.extern.Stats

getStateHistory() → {shaka.util.StateHistory}

Source:
Returns:
Type
shaka.util.StateHistory

getSwitchHistory() → {shaka.util.SwitchHistory}

Source:
Returns:
Type
shaka.util.SwitchHistory

setBandwidthEstimate(bandwidth)

Parameters:
Name Type Description
bandwidth number
Source:

setCompletionPercent(percent)

Record the current completion percent. This is the "high water mark", so it will store the highest provided completion percent.
Parameters:
Name Type Description
percent number
Source:

setCorruptedFrames(corrupted)

Update corrupted frames. This will replace the previous values.
Parameters:
Name Type Description
corrupted number
Source:

setCurrentStreamBandwidth(bandwidth)

Parameters:
Name Type Description
bandwidth number
Source:

setDrmTime(seconds)

Record the time it took to download the first drm key.
Parameters:
Name Type Description
seconds number
Source:

setDroppedFrames(dropped, decoded)

Update the ratio of dropped frames to total frames. This will replace the previous values.
Parameters:
Name Type Description
dropped number
decoded number
Source:

setGapsJumped(gapsJumped)

Update number of playback gaps jumped over. This will replace the previous value.
Parameters:
Name Type Description
gapsJumped number
Source:

setLicenseTime(seconds)

Record the cumulative time spent on license requests during this session.
Parameters:
Name Type Description
seconds number
Source:

setLiveLatency(seconds)

Record the latency in live streams.
Parameters:
Name Type Description
seconds number
Source:

setLoadLatency(seconds)

Record the time it took between the user signalling "I want to play this" to "I am now seeing this".
Parameters:
Name Type Description
seconds number
Source:

setManifestGapCount(count)

Parameters:
Name Type Description
count number
Source:

setManifestPeriodCount(count)

Parameters:
Name Type Description
count number
Source:

setManifestSize(size)

Parameters:
Name Type Description
size number
Source:

setManifestTime(seconds)

Record the time it took to download and parse the manifest.
Parameters:
Name Type Description
seconds number
Source:

setMaxSegmentDuration(seconds)

Record the presentation's max segment duration.
Parameters:
Name Type Description
seconds number
Source:

setResolution(width, height)

Set the width and height of the video we are currently playing.
Parameters:
Name Type Description
width number
height number
Source:

setStallsDetected(stallsDetected)

Update number of stalls detected. This will replace the previous value.
Parameters:
Name Type Description
stallsDetected number
Source: