dashjs
Version:
A reference client implementation for the playback of MPEG DASH via Javascript and compliant browsers.
4,321 lines (1,049 loc) • 77.1 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>dash.js Classes</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-8">
<div id="main">
<h1 class="page-title">Classes</h1>
<section>
<header>
<h2>
</h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Classes</h3>
<dl>
<dt><a href="Errors.html">Errors</a></dt>
<dd></dd>
<dt><a href="MediaPlayerEvents.html">MediaPlayerEvents</a></dt>
<dd></dd>
<dt><a href="MediaPlayerModel.html">MediaPlayerModel</a></dt>
<dd></dd>
<dt><a href="MetricsReportingEvents.html">MetricsReportingEvents</a></dt>
<dd></dd>
<dt><a href="MssErrors.html">MssErrors</a></dt>
<dd></dd>
<dt><a href="OfflineErrors.html">OfflineErrors</a></dt>
<dd></dd>
<dt><a href="OfflineEvents.html">OfflineEvents</a></dt>
<dd></dd>
<dt><a href="ProtectionErrors.html">ProtectionErrors</a></dt>
<dd></dd>
<dt><a href="ProtectionEvents.html">ProtectionEvents</a></dt>
<dd></dd>
</dl>
<h3 class="subsection-title">Events</h3>
<dl>
<hr>
<dt>
<h4 class="name" id="event:ADAPTATION_SET_REMOVED_NO_CAPABILITIES">ADAPTATION_SET_REMOVED_NO_CAPABILITIES</h4>
</dt>
<dd>
<div class="description">
<p>Event that is dispatched whenever an adaptation set is removed due to all representations not being supported.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-400">line 400</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:AST_IN_FUTURE">AST_IN_FUTURE</h4>
</dt>
<dd>
<div class="description">
<p>Triggered when playback will not start yet<br>
as the MPD's availabilityStartTime is in the future.<br>
Check delay property in payload to determine time before playback will start.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-44">line 44</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:BUFFER_EMPTY">BUFFER_EMPTY</h4>
</dt>
<dd>
<div class="description">
<p>Triggered when the video element's buffer state changes to stalled.<br>
Check mediaType in payload to determine type (Video, Audio, FragmentedText).</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-52">line 52</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:BUFFER_LEVEL_STATE_CHANGED">BUFFER_LEVEL_STATE_CHANGED</h4>
</dt>
<dd>
<div class="description">
<p>Triggered when the video element's buffer state changes, either stalled or loaded. Check payload for state.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-66">line 66</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:BUFFER_LEVEL_UPDATED">BUFFER_LEVEL_UPDATED</h4>
</dt>
<dd>
<div class="description">
<p>Triggered when the buffer level of a media type has been updated</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-72">line 72</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:BUFFER_LOADED">BUFFER_LOADED</h4>
</dt>
<dd>
<div class="description">
<p>Triggered when the video element's buffer state changes to loaded.<br>
Check mediaType in payload to determine type (Video, Audio, FragmentedText).</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-59">line 59</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:CAN_PLAY">CAN_PLAY</h4>
</dt>
<dd>
<div class="description">
<p>Sent when enough data is available that the media can be played,<br>
at least for a couple of frames. This corresponds to the<br>
HAVE_ENOUGH_DATA readyState.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-250">line 250</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:CAN_PLAY_THROUGH">CAN_PLAY_THROUGH</h4>
</dt>
<dd>
<div class="description">
<p>This corresponds to the CAN_PLAY_THROUGH readyState.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-258">line 258</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:CAPTION_CONTAINER_RESIZE">CAPTION_CONTAINER_RESIZE</h4>
</dt>
<dd>
<div class="description">
<p>Triggered when the caption container is resized.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-244">line 244</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:CAPTION_RENDERED">CAPTION_RENDERED</h4>
</dt>
<dd>
<div class="description">
<p>Triggered when a caption is rendered.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-238">line 238</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:CONFORMANCE_VIOLATION">CONFORMANCE_VIOLATION</h4>
</dt>
<dd>
<div class="description">
<p>Event that is dispatched whenever the player encounters a potential conformance validation that might lead to unexpected/not optimal behavior</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-388">line 388</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:CONTENT_STEERING_REQUEST_COMPLETED">CONTENT_STEERING_REQUEST_COMPLETED</h4>
</dt>
<dd>
<div class="description">
<p>Triggered when a content steering request has completed.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-405">line 405</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:DYNAMIC_TO_STATIC">DYNAMIC_TO_STATIC</h4>
</dt>
<dd>
<div class="description">
<p>Triggered when a dynamic stream changed to static (transition phase between Live and On-Demand).</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-78">line 78</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:ERROR">ERROR</h4>
</dt>
<dd>
<div class="description">
<p>Triggered when there is an error from the element or MSE source buffer.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-84">line 84</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:EVENT_MODE_ON_RECEIVE">EVENT_MODE_ON_RECEIVE</h4>
</dt>
<dd>
<div class="description">
<p>Dash events are triggered as soon as they were parsed.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-382">line 382</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:EVENT_MODE_ON_START">EVENT_MODE_ON_START</h4>
</dt>
<dd>
<div class="description">
<p>Dash events are triggered at their respective start points on the timeline.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-376">line 376</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:FRAGMENT_LOADING_ABANDONED">FRAGMENT_LOADING_ABANDONED</h4>
</dt>
<dd>
<div class="description">
<p>Triggered when a fragment download is abandoned due to detection of slow download base on the ABR abandon rule..</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-106">line 106</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:FRAGMENT_LOADING_COMPLETED">FRAGMENT_LOADING_COMPLETED</h4>
</dt>
<dd>
<div class="description">
<p>Triggered when a fragment download has completed.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-89">line 89</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:FRAGMENT_LOADING_PROGRESS">FRAGMENT_LOADING_PROGRESS</h4>
</dt>
<dd>
<div class="description">
<p>Triggered when a partial fragment download has completed.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-95">line 95</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:FRAGMENT_LOADING_STARTED">FRAGMENT_LOADING_STARTED</h4>
</dt>
<dd>
<div class="description">
<p>Triggered when a fragment download has started.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-100">line 100</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:LOG">LOG</h4>
</dt>
<dd>
<div class="description">
<p>Triggered when <a href="module-Debug.html"><code>module:Debug</code></a> logger methods are called.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-112">line 112</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:MANIFEST_LOADED">MANIFEST_LOADED</h4>
</dt>
<dd>
<div class="description">
<p>Triggered when the manifest load is complete</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-118">line 118</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:MANIFEST_VALIDITY_CHANGED">MANIFEST_VALIDITY_CHANGED</h4>
</dt>
<dd>
<div class="description">
<p>Manifest validity changed - As a result of an MPD validity expiration event.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-370">line 370</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:METRIC_ADDED">METRIC_ADDED</h4>
</dt>
<dd>
<div class="description">
<p>Triggered every time a new metric is added.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-136">line 136</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:METRIC_CHANGED">METRIC_CHANGED</h4>
</dt>
<dd>
<div class="description">
<p>Triggered when an individual metric is added, updated or cleared.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-130">line 130</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:METRIC_UPDATED">METRIC_UPDATED</h4>
</dt>
<dd>
<div class="description">
<p>Triggered every time a metric is updated.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-142">line 142</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:METRICS_CHANGED">METRICS_CHANGED</h4>
</dt>
<dd>
<div class="description">
<p>Triggered anytime there is a change to the overall metrics.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-124">line 124</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:PERIOD_SWITCH_COMPLETED">PERIOD_SWITCH_COMPLETED</h4>
</dt>
<dd>
<div class="description">
<p>Triggered at the stream end of a period.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-154">line 154</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:PERIOD_SWITCH_STARTED">PERIOD_SWITCH_STARTED</h4>
</dt>
<dd>
<div class="description">
<p>Triggered when a new stream (period) starts.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-148">line 148</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:PLAYBACK_ENDED">PLAYBACK_ENDED</h4>
</dt>
<dd>
<div class="description">
<p>Sent when playback completes.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-264">line 264</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:PLAYBACK_ERROR">PLAYBACK_ERROR</h4>
</dt>
<dd>
<div class="description">
<p>Sent when an error occurs. The element's error<br>
attribute contains more information.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-270">line 270</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:PLAYBACK_LOADED_DATA">PLAYBACK_LOADED_DATA</h4>
</dt>
<dd>
<div class="description">
<p>The event is fired when the frame at the current playback position of the media has finished loading;<br>
often the first frame</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-290">line 290</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:PLAYBACK_METADATA_LOADED">PLAYBACK_METADATA_LOADED</h4>
</dt>
<dd>
<div class="description">
<p>The media's metadata has finished loading; all attributes now<br>
contain as much useful information as they're going to.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-283">line 283</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:PLAYBACK_NOT_ALLOWED">PLAYBACK_NOT_ALLOWED</h4>
</dt>
<dd>
<div class="description">
<p>Sent when playback is not allowed (for example if user gesture is needed).</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-277">line 277</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:PLAYBACK_PAUSED">PLAYBACK_PAUSED</h4>
</dt>
<dd>
<div class="description">
<p>Sent when playback is paused.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-297">line 297</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:PLAYBACK_PLAYING">PLAYBACK_PLAYING</h4>
</dt>
<dd>
<div class="description">
<p>Sent when the media begins to play (either for the first time, after having been paused,<br>
or after ending and then restarting).</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-303">line 303</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:PLAYBACK_PROGRESS">PLAYBACK_PROGRESS</h4>
</dt>
<dd>
<div class="description">
<p>Sent periodically to inform interested parties of progress downloading<br>
the media. Information about the current amount of the media that has<br>
been downloaded is available in the media element's buffered attribute.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-311">line 311</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:PLAYBACK_RATE_CHANGED">PLAYBACK_RATE_CHANGED</h4>
</dt>
<dd>
<div class="description">
<p>Sent when the playback speed changes.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-319">line 319</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:PLAYBACK_SEEKED">PLAYBACK_SEEKED</h4>
</dt>
<dd>
<div class="description">
<p>Sent when a seek operation completes.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-325">line 325</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:PLAYBACK_SEEKING">PLAYBACK_SEEKING</h4>
</dt>
<dd>
<div class="description">
<p>Sent when a seek operation begins.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-331">line 331</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:PLAYBACK_STALLED">PLAYBACK_STALLED</h4>
</dt>
<dd>
<div class="description">
<p>Sent when the video element reports stalled</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-337">line 337</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:PLAYBACK_STARTED">PLAYBACK_STARTED</h4>
</dt>
<dd>
<div class="description">
<p>Sent when playback of the media starts after having been paused;<br>
that is, when playback is resumed after a prior pause event.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-343">line 343</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:PLAYBACK_TIME_UPDATED">PLAYBACK_TIME_UPDATED</h4>
</dt>
<dd>
<div class="description">
<p>The time indicated by the element's currentTime attribute has changed.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-351">line 351</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:PLAYBACK_VOLUME_CHANGED">PLAYBACK_VOLUME_CHANGED</h4>
</dt>
<dd>
<div class="description">
<p>Sent when the video element reports that the volume has changed</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-357">line 357</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:PLAYBACK_WAITING">PLAYBACK_WAITING</h4>
</dt>
<dd>
<div class="description">
<p>Sent when the media playback has stopped because of a temporary lack of data.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-363">line 363</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:QUALITY_CHANGE_RENDERED">QUALITY_CHANGE_RENDERED</h4>
</dt>
<dd>
<div class="description">
<p>Triggered when the new ABR quality is being rendered on-screen.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-166">line 166</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:QUALITY_CHANGE_REQUESTED">QUALITY_CHANGE_REQUESTED</h4>
</dt>
<dd>
<div class="description">
<p>Triggered when an ABR up /down switch is initiated; either by user in manual mode or auto mode via ABR rules.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="streaming_MediaPlayerEvents.js.html">streaming/MediaPlayerEvents.js</a>,
<a href="streaming_MediaPlayerEvents.js.html#sunlight-1-line-160">line