Dash JS

Module: DashMetrics

The DashMetrics module can be accessed using the MediaPlayer API getDashMetrics()

Source:

Methods

getCurrent(metrics, metricName)

Returns the latest metrics for a given metric list and specific metric name

Parameters:
Name Type Description
metrics MetricsList
metricName string
Source:
Returns:
Type
*

getCurrentBufferLevel(mediaType)

Returns the current buffer level for a given media type

Parameters:
Name Type Description
mediaType MediaType
Source:
Returns:
Type
number

getCurrentBufferState(mediaType)

Returns the current buffer state for a given media type

Parameters:
Name Type Description
mediaType MediaType
Source:
Returns:
Type
number

getCurrentDroppedFrames()

Returns the number of dropped frames

Source:
Returns:
Type
*

getCurrentDVRInfo(mediaType)

Returns the current DVR window

Parameters:
Name Type Description
mediaType MediaType
Source:
Returns:
Type
*

getCurrentHttpRequest(mediaType)

Returns the latest HTTP request for a given media type

Parameters:
Name Type Description
mediaType MediaType
Source:
Returns:
Type
*

getCurrentManifestUpdate()

Returns the current manifest update information

Source:
Returns:
Type
*

getCurrentRepresentationSwitch(mediaType)

Returns the latest Representation switch for a given media type

Parameters:
Name Type Description
mediaType MediaType
Source:
Returns:
Type
*

getCurrentSchedulingInfo(mediaType)

Returns the current scheduling info for a given media type

Parameters:
Name Type Description
mediaType MediaType
Source:
Returns:
Type
*

getHttpRequests(mediaType)

Returns all HTTP requests for a given media type

Parameters:
Name Type Description
mediaType MediaType
Source:
Returns:
Type
*

getLatestFragmentRequestHeaderValueByID(mediaType, id)

Returns the value for a specific request headers used in the latest fragment request

Parameters:
Name Type Description
mediaType MediaType
id string
Source:
Returns:
Type
*

getLatestMPDRequestHeaderValueByID(id)

Returns the value for a specific request headers used in the latest MPD request

Parameters:
Name Type Description
id string
Source:
Returns:
Type
*