dashjs
Version:
A reference client implementation for the playback of MPEG DASH via Javascript and compliant browsers.
852 lines (719 loc) • 34.4 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>dash.js Source: dash/DashMetrics.js</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.spacelab.css">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top navbar-inverse">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand" href="index.html">dash.js</a>
<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
<div class="navbar-collapse collapse" id="topNavigation">
<ul class="nav navbar-nav">
<li class="dropdown">
<a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="module-DashAdapter.html">DashAdapter</a></li><li><a href="module-DashMetrics.html">DashMetrics</a></li><li><a href="module-MediaPlayer.html">MediaPlayer</a></li><li><a href="module-OfflineController.html">OfflineController</a></li><li><a href="module-ProtectionController.html">ProtectionController</a></li><li><a href="module-Settings.html">Settings</a></li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="Errors.html">Errors</a></li><li><a href="MediaPlayerEvents.html">MediaPlayerEvents</a></li><li><a href="MediaPlayerModel.html">MediaPlayerModel</a></li><li><a href="MetricsReportingEvents.html">MetricsReportingEvents</a></li><li><a href="MssErrors.html">MssErrors</a></li><li><a href="OfflineErrors.html">OfflineErrors</a></li><li><a href="OfflineEvents.html">OfflineEvents</a></li><li><a href="ProtectionErrors.html">ProtectionErrors</a></li><li><a href="ProtectionEvents.html">ProtectionEvents</a></li>
</ul>
</li>
<li class="dropdown">
<a href="events.list.html" class="dropdown-toggle" data-toggle="dropdown">Events<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="MediaPlayerEvents.html#event:ADAPTATION_SET_REMOVED_NO_CAPABILITIES">MediaPlayerEvents#event:ADAPTATION_SET_REMOVED_NO_CAPABILITIES</a></li><li><a href="MediaPlayerEvents.html#event:AST_IN_FUTURE">MediaPlayerEvents#event:AST_IN_FUTURE</a></li><li><a href="MediaPlayerEvents.html#event:BUFFER_EMPTY">MediaPlayerEvents#event:BUFFER_EMPTY</a></li><li><a href="MediaPlayerEvents.html#event:BUFFER_LEVEL_STATE_CHANGED">MediaPlayerEvents#event:BUFFER_LEVEL_STATE_CHANGED</a></li><li><a href="MediaPlayerEvents.html#event:BUFFER_LEVEL_UPDATED">MediaPlayerEvents#event:BUFFER_LEVEL_UPDATED</a></li><li><a href="MediaPlayerEvents.html#event:BUFFER_LOADED">MediaPlayerEvents#event:BUFFER_LOADED</a></li><li><a href="MediaPlayerEvents.html#event:CAN_PLAY">MediaPlayerEvents#event:CAN_PLAY</a></li><li><a href="MediaPlayerEvents.html#event:CAN_PLAY_THROUGH">MediaPlayerEvents#event:CAN_PLAY_THROUGH</a></li><li><a href="MediaPlayerEvents.html#event:CAPTION_CONTAINER_RESIZE">MediaPlayerEvents#event:CAPTION_CONTAINER_RESIZE</a></li><li><a href="MediaPlayerEvents.html#event:CAPTION_RENDERED">MediaPlayerEvents#event:CAPTION_RENDERED</a></li><li><a href="MediaPlayerEvents.html#event:CONFORMANCE_VIOLATION">MediaPlayerEvents#event:CONFORMANCE_VIOLATION</a></li><li><a href="MediaPlayerEvents.html#event:CONTENT_STEERING_REQUEST_COMPLETED">MediaPlayerEvents#event:CONTENT_STEERING_REQUEST_COMPLETED</a></li><li><a href="MediaPlayerEvents.html#event:DYNAMIC_TO_STATIC">MediaPlayerEvents#event:DYNAMIC_TO_STATIC</a></li><li><a href="MediaPlayerEvents.html#event:ERROR">MediaPlayerEvents#event:ERROR</a></li><li><a href="MediaPlayerEvents.html#event:EVENT_MODE_ON_RECEIVE">MediaPlayerEvents#event:EVENT_MODE_ON_RECEIVE</a></li><li><a href="MediaPlayerEvents.html#event:EVENT_MODE_ON_START">MediaPlayerEvents#event:EVENT_MODE_ON_START</a></li><li><a href="MediaPlayerEvents.html#event:FRAGMENT_LOADING_ABANDONED">MediaPlayerEvents#event:FRAGMENT_LOADING_ABANDONED</a></li><li><a href="MediaPlayerEvents.html#event:FRAGMENT_LOADING_COMPLETED">MediaPlayerEvents#event:FRAGMENT_LOADING_COMPLETED</a></li><li><a href="MediaPlayerEvents.html#event:FRAGMENT_LOADING_PROGRESS">MediaPlayerEvents#event:FRAGMENT_LOADING_PROGRESS</a></li><li><a href="MediaPlayerEvents.html#event:FRAGMENT_LOADING_STARTED">MediaPlayerEvents#event:FRAGMENT_LOADING_STARTED</a></li><li><a href="MediaPlayerEvents.html#event:LOG">MediaPlayerEvents#event:LOG</a></li><li><a href="MediaPlayerEvents.html#event:MANIFEST_LOADED">MediaPlayerEvents#event:MANIFEST_LOADED</a></li><li><a href="MediaPlayerEvents.html#event:MANIFEST_VALIDITY_CHANGED">MediaPlayerEvents#event:MANIFEST_VALIDITY_CHANGED</a></li><li><a href="MediaPlayerEvents.html#event:METRIC_ADDED">MediaPlayerEvents#event:METRIC_ADDED</a></li><li><a href="MediaPlayerEvents.html#event:METRIC_CHANGED">MediaPlayerEvents#event:METRIC_CHANGED</a></li><li><a href="MediaPlayerEvents.html#event:METRIC_UPDATED">MediaPlayerEvents#event:METRIC_UPDATED</a></li><li><a href="MediaPlayerEvents.html#event:METRICS_CHANGED">MediaPlayerEvents#event:METRICS_CHANGED</a></li><li><a href="MediaPlayerEvents.html#event:PERIOD_SWITCH_COMPLETED">MediaPlayerEvents#event:PERIOD_SWITCH_COMPLETED</a></li><li><a href="MediaPlayerEvents.html#event:PERIOD_SWITCH_STARTED">MediaPlayerEvents#event:PERIOD_SWITCH_STARTED</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_ENDED">MediaPlayerEvents#event:PLAYBACK_ENDED</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_ERROR">MediaPlayerEvents#event:PLAYBACK_ERROR</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_LOADED_DATA">MediaPlayerEvents#event:PLAYBACK_LOADED_DATA</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_METADATA_LOADED">MediaPlayerEvents#event:PLAYBACK_METADATA_LOADED</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_NOT_ALLOWED">MediaPlayerEvents#event:PLAYBACK_NOT_ALLOWED</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_PAUSED">MediaPlayerEvents#event:PLAYBACK_PAUSED</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_PLAYING">MediaPlayerEvents#event:PLAYBACK_PLAYING</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_PROGRESS">MediaPlayerEvents#event:PLAYBACK_PROGRESS</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_RATE_CHANGED">MediaPlayerEvents#event:PLAYBACK_RATE_CHANGED</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_SEEKED">MediaPlayerEvents#event:PLAYBACK_SEEKED</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_SEEKING">MediaPlayerEvents#event:PLAYBACK_SEEKING</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_STALLED">MediaPlayerEvents#event:PLAYBACK_STALLED</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_STARTED">MediaPlayerEvents#event:PLAYBACK_STARTED</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_TIME_UPDATED">MediaPlayerEvents#event:PLAYBACK_TIME_UPDATED</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_VOLUME_CHANGED">MediaPlayerEvents#event:PLAYBACK_VOLUME_CHANGED</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_WAITING">MediaPlayerEvents#event:PLAYBACK_WAITING</a></li><li><a href="MediaPlayerEvents.html#event:QUALITY_CHANGE_RENDERED">MediaPlayerEvents#event:QUALITY_CHANGE_RENDERED</a></li><li><a href="MediaPlayerEvents.html#event:QUALITY_CHANGE_REQUESTED">MediaPlayerEvents#event:QUALITY_CHANGE_REQUESTED</a></li><li><a href="MediaPlayerEvents.html#event:REPRESENTATION_SWITCH">MediaPlayerEvents#event:REPRESENTATION_SWITCH</a></li><li><a href="MediaPlayerEvents.html#event:STREAM_ACTIVATED">MediaPlayerEvents#event:STREAM_ACTIVATED</a></li><li><a href="MediaPlayerEvents.html#event:STREAM_DEACTIVATED">MediaPlayerEvents#event:STREAM_DEACTIVATED</a></li><li><a href="MediaPlayerEvents.html#event:STREAM_INITIALIZED">MediaPlayerEvents#event:STREAM_INITIALIZED</a></li><li><a href="MediaPlayerEvents.html#event:STREAM_INITIALIZING">MediaPlayerEvents#event:STREAM_INITIALIZING</a></li><li><a href="MediaPlayerEvents.html#event:STREAM_TEARDOWN_COMPLETE">MediaPlayerEvents#event:STREAM_TEARDOWN_COMPLETE</a></li><li><a href="MediaPlayerEvents.html#event:STREAM_UPDATED">MediaPlayerEvents#event:STREAM_UPDATED</a></li><li><a href="MediaPlayerEvents.html#event:TEXT_TRACK_ADDED">MediaPlayerEvents#event:TEXT_TRACK_ADDED</a></li><li><a href="MediaPlayerEvents.html#event:TEXT_TRACKS_ADDED">MediaPlayerEvents#event:TEXT_TRACKS_ADDED</a></li><li><a href="MediaPlayerEvents.html#event:TRACK_CHANGE_RENDERED">MediaPlayerEvents#event:TRACK_CHANGE_RENDERED</a></li><li><a href="MediaPlayerEvents.html#event:TTML_PARSED">MediaPlayerEvents#event:TTML_PARSED</a></li><li><a href="MediaPlayerEvents.html#event:TTML_TO_PARSE">MediaPlayerEvents#event:TTML_TO_PARSE</a></li><li><a href="MetricsReportingEvents.html#event:CMCD_DATA_GENERATED">MetricsReportingEvents#event:CMCD_DATA_GENERATED</a></li><li><a href="OfflineEvents.html#event:OFFLINE_RECORD_FINISHED">OfflineEvents#event:OFFLINE_RECORD_FINISHED</a></li><li><a href="OfflineEvents.html#event:OFFLINE_RECORD_LOADEDMETADATA">OfflineEvents#event:OFFLINE_RECORD_LOADEDMETADATA</a></li><li><a href="OfflineEvents.html#event:OFFLINE_RECORD_STARTED">OfflineEvents#event:OFFLINE_RECORD_STARTED</a></li><li><a href="OfflineEvents.html#event:OFFLINE_RECORD_STOPPED">OfflineEvents#event:OFFLINE_RECORD_STOPPED</a></li><li><a href="ProtectionEvents.html#event:KEY_ADDED">ProtectionEvents#event:KEY_ADDED</a></li><li><a href="ProtectionEvents.html#event:KEY_ERROR">ProtectionEvents#event:KEY_ERROR</a></li><li><a href="ProtectionEvents.html#event:KEY_MESSAGE">ProtectionEvents#event:KEY_MESSAGE</a></li><li><a href="ProtectionEvents.html#event:KEY_SESSION_CLOSED">ProtectionEvents#event:KEY_SESSION_CLOSED</a></li><li><a href="ProtectionEvents.html#event:KEY_SESSION_CREATED">ProtectionEvents#event:KEY_SESSION_CREATED</a></li><li><a href="ProtectionEvents.html#event:KEY_SESSION_REMOVED">ProtectionEvents#event:KEY_SESSION_REMOVED</a></li><li><a href="ProtectionEvents.html#event:KEY_STATUSES_CHANGED">ProtectionEvents#event:KEY_STATUSES_CHANGED</a></li><li><a href="ProtectionEvents.html#event:KEY_SYSTEM_SELECTED">ProtectionEvents#event:KEY_SYSTEM_SELECTED</a></li><li><a href="ProtectionEvents.html#event:LICENSE_REQUEST_COMPLETE">ProtectionEvents#event:LICENSE_REQUEST_COMPLETE</a></li><li><a href="ProtectionEvents.html#event:LICENSE_REQUEST_SENDING">ProtectionEvents#event:LICENSE_REQUEST_SENDING</a></li><li><a href="ProtectionEvents.html#event:PROTECTION_CREATED">ProtectionEvents#event:PROTECTION_CREATED</a></li><li><a href="ProtectionEvents.html#event:PROTECTION_DESTROYED">ProtectionEvents#event:PROTECTION_DESTROYED</a></li>
</ul>
</li>
<li class="dropdown">
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="global.html#LICENSE_SERVER_MANIFEST_CONFIGURATIONS">LICENSE_SERVER_MANIFEST_CONFIGURATIONS</a></li>
</ul>
</li>
</ul>
<div class="col-sm-3 col-md-3">
<form class="navbar-form" role="search">
<div class="input-group">
<input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
<div class="input-group-btn">
<button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
</div>
</div>
</form>
</div>
</div>
</div>
</div>
<div class="container" id="toc-content">
<div class="row">
<div class="col-md-12">
<div id="main">
<h1 class="page-title">Source: dash/DashMetrics.js</h1>
<section>
<article>
<pre
class="sunlight-highlight-javascript linenums">/**
* The copyright in this software is being made available under the BSD License,
* included below. This software may be subject to other third party and contributor
* rights, including patent rights, and no such rights are granted under this license.
*
* Copyright (c) 2013, Dash Industry Forum.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation and/or
* other materials provided with the distribution.
* * Neither the name of Dash Industry Forum nor the names of its
* contributors may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS AS IS AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
import Constants from '../streaming/constants/Constants';
import { HTTPRequest } from '../streaming/vo/metrics/HTTPRequest';
import FactoryMaker from '../core/FactoryMaker';
import MetricsConstants from '../streaming/constants/MetricsConstants';
import Round10 from './utils/Round10';
import MetricsModel from '../streaming/models/MetricsModel';
import Utils from '../core/Utils';
import {
PlayList,
PlayListTrace
} from '../streaming/vo/metrics/PlayList';
/**
* @module DashMetrics
* @description The DashMetrics module can be accessed using the MediaPlayer API getDashMetrics()
* @param {object} config
*/
function DashMetrics(config) {
config = config || {};
const context = this.context;
let instance,
playListTraceMetricsClosed,
playListTraceMetrics,
playListMetrics;
let metricsModel = config.metricsModel;
function setup() {
metricsModel = metricsModel || MetricsModel(context).getInstance({settings: config.settings});
resetInitialSettings();
}
function resetInitialSettings() {
playListTraceMetricsClosed = true;
playListTraceMetrics = null;
playListMetrics = null;
}
/**
* Returns the latest Representation switch for a given media type
* @param {MediaType} mediaType
* @returns {*}
* @memberof module:DashMetrics
* @instance
*/
function getCurrentRepresentationSwitch(mediaType) {
const metrics = metricsModel.getMetricsFor(mediaType, true);
return getCurrent(metrics, MetricsConstants.TRACK_SWITCH);
}
/**
* @param {MediaType} mediaType
* @param {Date} t time of the switch event
* @param {Date} mt media presentation time
* @param {string} to id of representation
* @param {string} lto if present, subrepresentation reference
* @memberof module:DashMetrics
* @instance
* @ignore
*/
function addRepresentationSwitch(mediaType, t, mt, to, lto) {
metricsModel.addRepresentationSwitch(mediaType, t, mt, to, lto);
}
/**
* Returns the current buffer state for a given media type
* @param {MediaType} mediaType
* @returns {number}
* @memberof module:DashMetrics
* @instance
*/
function getCurrentBufferState(mediaType) {
const metrics = metricsModel.getMetricsFor(mediaType, true);
return getCurrent(metrics, MetricsConstants.BUFFER_STATE);
}
/**
* Returns the current buffer level for a given media type
* @param {MediaType} mediaType
* @returns {number}
* @memberof module:DashMetrics
* @instance
*/
function getCurrentBufferLevel(mediaType) {
const metrics = metricsModel.getMetricsFor(mediaType, true);
const metric = getCurrent(metrics, MetricsConstants.BUFFER_LEVEL);
if (metric) {
return Round10.round10(metric.level / 1000, -3);
}
return 0;
}
/**
* @param {MediaType} mediaType
* @param {number} t
* @param {number} level
* @memberof module:DashMetrics
* @instance
* @ignore
*/
function addBufferLevel(mediaType, t, level) {
metricsModel.addBufferLevel(mediaType, t, level);
}
/**
* @param {MediaType} mediaType
* @param {string} state
* @param {number} target
* @memberof module:DashMetrics
* @instance
* @ignore
*/
function addBufferState(mediaType, state, target) {
metricsModel.addBufferState(mediaType, state, target);
}
/**
* @memberof module:DashMetrics
* @instance
* @ignore
*/
function clearAllCurrentMetrics () {
metricsModel.clearAllCurrentMetrics();
}
/**
* Returns the latest HTTP request for a given media type
* @param {MediaType} mediaType
* @returns {*}
* @memberof module:DashMetrics
* @instance
*/
function getCurrentHttpRequest(mediaType) {
const metrics = metricsModel.getMetricsFor(mediaType, true);
if (!metrics) {
return null;
}
const httpList = metrics.HttpList;
let currentHttpList = null;
let httpListLastIndex;
if (!httpList || httpList.length <= 0) {
return null;
}
httpListLastIndex = httpList.length - 1;
while (httpListLastIndex >= 0) {
if (httpList[httpListLastIndex].responsecode) {
currentHttpList = httpList[httpListLastIndex];
break;
}
httpListLastIndex--;
}
return currentHttpList;
}
/**
* Returns all HTTP requests for a given media type
* @param {MediaType} mediaType
* @returns {*}
* @memberof module:DashMetrics
* @instance
*/
function getHttpRequests(mediaType) {
const metrics = metricsModel.getMetricsFor(mediaType, true);
if (!metrics) {
return [];
}
return !!metrics.HttpList ? metrics.HttpList : [];
}
/**
* @param {MediaType} mediaType
* @param {Array} loadingRequests
* @param {Array} executedRequests
* @memberof module:DashMetrics
* @instance
* @ignore
*/
function addRequestsQueue(mediaType, loadingRequests, executedRequests) {
metricsModel.addRequestsQueue(mediaType, loadingRequests, executedRequests);
}
/**
* Returns the latest metrics for a given metric list and specific metric name
* @param {MetricsList} metrics
* @param {string} metricName
* @returns {*}
* @memberof module:DashMetrics
* @instance
*/
function getCurrent(metrics, metricName) {
if (!metrics) {
return null;
}
const list = metrics[metricName];
return (!list || list.length === 0) ? null : list[list.length - 1];
}
/**
* Returns the number of dropped frames
* @returns {*}
* @memberof module:DashMetrics
* @instance
*/
function getCurrentDroppedFrames() {
const metrics = metricsModel.getMetricsFor(Constants.VIDEO, true);
return getCurrent(metrics, MetricsConstants.DROPPED_FRAMES);
}
/**
* @param {number} quality
* @memberof module:DashMetrics
* @instance
* @ignore
*/
function addDroppedFrames(quality) {
metricsModel.addDroppedFrames(Constants.VIDEO, quality);
}
/**
* Returns the current scheduling info for a given media type
* @param {MediaType} mediaType
* @returns {*}
* @memberof module:DashMetrics
* @instance
*/
function getCurrentSchedulingInfo(mediaType) {
const metrics = metricsModel.getMetricsFor(mediaType, true);
return getCurrent(metrics, MetricsConstants.SCHEDULING_INFO);
}
/**
* @param {object} request
* @param {string} state
* @memberof module:DashMetrics
* @instance
* @ignore
*/
function addSchedulingInfo(request, state) {
metricsModel.addSchedulingInfo(
request.mediaType,
new Date(),
request.type,
request.startTime,
request.availabilityStartTime,
request.duration,
request.quality,
request.range,
state);
}
/**
* Returns the current manifest update information
* @returns {*}
* @memberof module:DashMetrics
* @instance
*/
function getCurrentManifestUpdate() {
const streamMetrics = metricsModel.getMetricsFor(Constants.STREAM);
return getCurrent(streamMetrics, MetricsConstants.MANIFEST_UPDATE);
}
/**
* @param {object} updatedFields fields to be updated
* @memberof module:DashMetrics
* @instance
* @ignore
*/
function updateManifestUpdateInfo(updatedFields) {
const manifestUpdate = this.getCurrentManifestUpdate();
metricsModel.updateManifestUpdateInfo(manifestUpdate, updatedFields);
}
/**
* @param {object} streamInfo
* @memberof module:DashMetrics
* @instance
* @ignore
*/
function addManifestUpdateStreamInfo(streamInfo) {
if (streamInfo) {
const manifestUpdate = this.getCurrentManifestUpdate();
metricsModel.addManifestUpdateStreamInfo(manifestUpdate, streamInfo.id, streamInfo.index, streamInfo.start, streamInfo.duration);
}
}
/**
* @param {object} request
* @memberof module:DashMetrics
* @instance
* @ignore
*/
function addManifestUpdate(request) {
metricsModel.addManifestUpdate(Constants.STREAM, request.type, request.requestStartDate, request.requestEndDate);
}
/**
* @param {object} request
* @param {string} responseURL
* @param {number} responseStatus
* @param {object} responseHeaders
* @param {object} traces
* @memberof module:DashMetrics
* @instance
* @ignore
*/
function addHttpRequest(request, responseURL, responseStatus, responseHeaders, traces) {
metricsModel.addHttpRequest(request.mediaType,
null,
request.type,
request.url,
request.quality,
responseURL,
request.serviceLocation || null,
request.range || null,
request.requestStartDate,
request.firstByteDate,
request.requestEndDate,
responseStatus,
request.duration,
responseHeaders,
traces,
request.fileLoaderType);
}
/**
* @param {object} representation
* @param {MediaType} mediaType
* @memberof module:DashMetrics
* @instance
* @ignore
*/
function addManifestUpdateRepresentationInfo(representation, mediaType) {
if (representation) {
const manifestUpdateInfo = this.getCurrentManifestUpdate();
metricsModel.addManifestUpdateRepresentationInfo(manifestUpdateInfo, representation.id, representation.index, representation.streamIndex, mediaType, representation.presentationTimeOffset, representation.startNumber, representation.fragmentInfoType);
}
}
/**
* Returns the current DVR window
* @param {MediaType} mediaType
* @returns {*}
* @memberof module:DashMetrics
* @instance
*/
function getCurrentDVRInfo(mediaType) {
const metrics = mediaType ? metricsModel.getMetricsFor(mediaType, true) :
metricsModel.getMetricsFor(Constants.VIDEO, true) || metricsModel.getMetricsFor(Constants.AUDIO, true);
return getCurrent(metrics, MetricsConstants.DVR_INFO);
}
/**
* @param {MediaType} mediaType
* @param {Date} currentTime time of the switch event
* @param {object} mpd mpd reference
* @param {object} range range of the dvr info
* @memberof module:DashMetrics
* @instance
* @ignore
*/
function addDVRInfo(mediaType, currentTime, mpd, range) {
metricsModel.addDVRInfo(mediaType, currentTime, mpd, range);
}
/**
* Returns the value for a specific request headers used in the latest MPD request
* @param {string} id
* @returns {*}
* @memberof module:DashMetrics
* @instance
*/
function getLatestMPDRequestHeaderValueByID(id) {
if (!id) {
return null;
}
let headers = {};
let httpRequestList,
httpRequest,
i;
httpRequestList = getHttpRequests(Constants.STREAM);
for (i = httpRequestList.length - 1; i >= 0; i--) {
httpRequest = httpRequestList[i];
if (httpRequest.type === HTTPRequest.MPD_TYPE) {
headers = Utils.parseHttpHeaders(httpRequest._responseHeaders);
break;
}
}
const value = headers[id.toLowerCase()];
return value === undefined ? null : value;
}
/**
* Returns the value for a specific request headers used in the latest fragment request
* @param {MediaType} mediaType
* @param {string} id
* @returns {*}
* @memberof module:DashMetrics
* @instance
*/
function getLatestFragmentRequestHeaderValueByID(mediaType, id) {
if (!id) {
return null;
}
let headers = {};
let httpRequest = getCurrentHttpRequest(mediaType);
if (httpRequest) {
headers = Utils.parseHttpHeaders(httpRequest._responseHeaders);
}
const value = headers[id.toLowerCase()];
return value === undefined ? null : value;
}
/**
* @memberof module:DashMetrics
* @instance
* @ignore
*/
function addPlayList() {
if (playListMetrics) {
metricsModel.addPlayList(playListMetrics);
playListMetrics = null;
}
}
/**
* Create a new playlist metric
* @param {number} mediaStartTime
* @param {string} startReason
* @ignore
*/
function createPlaylistMetrics(mediaStartTime, startReason) {
playListMetrics = new PlayList();
playListMetrics.start = new Date();
playListMetrics.mstart = mediaStartTime;
playListMetrics.starttype = startReason;
}
/**
* Create a playlist trace metric
* @param {number} representationId
* @param {number} mediaStartTime
* @param {number} speed
* @ignore
*/
function createPlaylistTraceMetrics(representationId, mediaStartTime, speed) {
if (playListTraceMetricsClosed === true ) {
playListTraceMetricsClosed = false;
playListTraceMetrics = new PlayListTrace();
playListTraceMetrics.representationid = representationId;
playListTraceMetrics.start = new Date();
playListTraceMetrics.mstart = mediaStartTime;
playListTraceMetrics.playbackspeed = speed !== null ? speed.toString() : null;
}
}
/**
* Update existing playlist trace metric
* @param {object} traceToUpdate
* @ignore
*/
function updatePlayListTraceMetrics(traceToUpdate) {
if (playListTraceMetrics) {
for (let field in playListTraceMetrics) {
playListTraceMetrics[field] = traceToUpdate[field];
}
}
}
/**
* Push a new playlist trace metric
* @param endTime
* @param reason
* @ignore
*/
function pushPlayListTraceMetrics(endTime, reason) {
if (playListTraceMetricsClosed === false && playListMetrics && playListTraceMetrics && playListTraceMetrics.start) {
const startTime = playListTraceMetrics.start;
const duration = endTime.getTime() - startTime.getTime();
playListTraceMetrics.duration = duration;
playListTraceMetrics.stopreason = reason;
playListMetrics.trace.push(playListTraceMetrics);
playListTraceMetricsClosed = true;
}
}
/**
* @param {object} errors
* @memberof module:DashMetrics
* @instance
* @ignore
*/
function addDVBErrors(errors) {
metricsModel.addDVBErrors(errors);
}
instance = {
getCurrentRepresentationSwitch,
getCurrentBufferState,
getCurrentBufferLevel,
getCurrentHttpRequest,
getHttpRequests,
getCurrentDroppedFrames,
getCurrentSchedulingInfo,
getCurrentDVRInfo,
getCurrentManifestUpdate,
getLatestFragmentRequestHeaderValueByID,
getLatestMPDRequestHeaderValueByID,
addRepresentationSwitch,
addDVRInfo,
updateManifestUpdateInfo,
addManifestUpdateStreamInfo,
addManifestUpdateRepresentationInfo,
addManifestUpdate,
addHttpRequest,
addSchedulingInfo,
addRequestsQueue,
addBufferLevel,
addBufferState,
addDroppedFrames,
addPlayList,
addDVBErrors,
createPlaylistMetrics,
createPlaylistTraceMetrics,
updatePlayListTraceMetrics,
pushPlayListTraceMetrics,
clearAllCurrentMetrics
};
setup();
return instance;
}
DashMetrics.__dashjs_factory_name = 'DashMetrics';
export default FactoryMaker.getSingletonFactory(DashMetrics);
</pre>
</article>
</section>
</div>
</div>
<div class="clearfix"></div>
</div>
</div>
<div class="modal fade" id="searchResults">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
<h4 class="modal-title">Search results</h4>
</div>
<div class="modal-body"></div>
<div class="modal-footer">
<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
</div>
</div><!-- /.modal-content -->
</div><!-- /.modal-dialog -->
</div>
<footer>
<span class="copyright">
<h3>DASH Industry Forum</h3>
</span>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a>
on Wed Sep 28th 2022
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
</footer>
<script src="scripts/docstrap.lib.js"></script>
<script src="scripts/toc.js"></script>
<script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
<script>
$( function () {
$( "[id*='$']" ).each( function () {
var $this = $( this );
$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
} );
$( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
var $this = $( this );
var example = $this.find( "code" );
exampleText = example.html();
var lang = /{@lang (.*?)}/.exec( exampleText );
if ( lang && lang[1] ) {
exampleText = exampleText.replace( lang[0], "" );
example.html( exampleText );
lang = lang[1];
} else {
var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
lang = langClassMatch ? langClassMatch[1] : "javascript";
}
if ( lang ) {
$this
.addClass( "sunlight-highlight-" + lang )
.addClass( "linenums" )
.html( example.html() );
}
} );
Sunlight.highlightAll( {
lineNumbers : true,
showMenu : true,
enableDoclinks : true
} );
$.catchAnchorLinks( {
navbarOffset: 10
} );
$( "#toc" ).toc( {
anchorName : function ( i, heading, prefix ) {
return $( heading ).attr( "id" ) || ( prefix + i );
},
selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
showAndHide : false,
smoothScrolling: true
} );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
$( '.dropdown-toggle' ).dropdown();
$( "table" ).each( function () {
var $this = $( this );
$this.addClass('table');
} );
} );
</script>
<!--Navigation and Symbol Display-->
<script>
$( function () {
$( '#main' ).localScroll( {
offset : { top : 60 } //offset by the height of your header (give or take a few px, see what works for you)
} );
$( "dt.name" ).each( function () {
var $this = $( this ).find("h4");
var icon = $( "<i/>" ).addClass( "icon-plus-sign" ).addClass( "pull-right" ).addClass( "icon-white" );
var dt = $(this);
var children = dt.next( "dd" );
dt.prepend( icon ).css( {cursor : "pointer"} );
dt.addClass( "member-collapsed" ).addClass( "member" );
children.hide();
dt.children().on( "click", function () {
children = dt.next( "dd" );
children.slideToggle( "fast", function () {
if ( children.is( ":visible" ) ) {
icon.addClass( "icon-minus-sign" ).removeClass( "icon-plus-sign" ).removeClass( "icon-white" );
dt.addClass( "member-open" ).animate( "member-collapsed" );
} else {
icon.addClass( "icon-plus-sign" ).removeClass( "icon-minus-sign" ).addClass( "icon-white" );
dt.addClass( "member-collapsed" ).removeClass( "member-open" );
}
} );
} );
} );
} );
</script>
<!--Google Analytics-->
<script type="text/javascript">
$(document).ready(function() {
SearcherDisplay.init();
});
</script>
</body>
</html>