dashjs
Version:
A reference client implementation for the playback of MPEG DASH via Javascript and compliant browsers.
7,375 lines • 144 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>dash.js Module: Settings</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">Module: Settings</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Define the configuration parameters of Dash.js MediaPlayer.</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="core_Settings.js.html">core/Settings.js</a>,
<a href="core_Settings.js.html#sunlight-1-line-39">line 39</a>
</li>
</ul>
</dd>
<dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="module-Settings.html#~PlayerSettings"><code>PlayerSettings</code></a> for further information about the supported configuration properties.</li>
</ul>
</dd>
</dl>
</div>
<h3 class="subsection-title">Type Definitions</h3>
<dl>
<hr>
<dt class="name" id="~AbrSettings">
<h4 id="~AbrSettings">AbrSettings</h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>movingAverageMethod</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
"slidingWindow"
</td>
<td class="description last"><p>Sets the moving average method used for smoothing throughput estimates.</p>
<p>Valid methods are "slidingWindow" and "ewma".</p>
<p>The call has no effect if an invalid method is passed.</p>
<p>The sliding window moving average method computes the average throughput using the last four segments downloaded.</p>
<p>If the stream is live (as opposed to VOD), then only the last three segments are used.</p>
<p>If wide variations in throughput are detected, the number of segments can be dynamically increased to avoid oscillations.</p>
<p>The exponentially weighted moving average (EWMA) method computes the average using exponential smoothing.</p>
<p>Two separate estimates are maintained, a fast one with a three-second half life and a slow one with an eight-second half life.</p>
<p>The throughput estimate at any time is the minimum of the fast and slow estimates.</p>
<p>This allows a fast reaction to a bandwidth drop and prevents oscillations on bandwidth spikes.</p></td>
</tr>
<tr>
<td class="name"><code>ABRStrategy</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
"abrDynamic"
</td>
<td class="description last"><p>Returns the current ABR strategy being used: "abrDynamic", "abrBola" or "abrThroughput".</p></td>
</tr>
<tr>
<td class="name"><code>trackSwitchMode</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
{video: "neverReplace", audio: "alwaysReplace"}
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>additionalAbrRules</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
{insufficientBufferRule: false,switchHistoryRule: true,droppedFramesRule: true,abandonRequestsRule: false}
</td>
<td class="description last"><p>Enable/Disable additional ABR rules in case ABRStrategy is set to "abrDynamic", "abrBola" or "abrThroughput".</p></td>
</tr>
<tr>
<td class="name"><code>bandwidthSafetyFactor</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
0.9
</td>
<td class="description last"><p>Standard ABR throughput rules multiply the throughput by this value.</p>
<p>It should be between 0 and 1, with lower values giving less rebuffering (but also lower quality).</p></td>
</tr>
<tr>
<td class="name"><code>useDefaultABRRules</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>Should the default ABR rules be used, or the custom ones added.</p></td>
</tr>
<tr>
<td class="name"><code>useDeadTimeLatency</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>If true, only the download portion will be considered part of the download bitrate and latency will be regarded as static.</p>
<p>If false, the reciprocal of the whole transfer time will be used.</p></td>
</tr>
<tr>
<td class="name"><code>limitBitrateByPortal</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>If true, the size of the video portal will limit the max chosen video resolution.</p></td>
</tr>
<tr>
<td class="name"><code>usePixelRatioInLimitBitrateByPortal</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>Sets whether to take into account the device's pixel ratio when defining the portal dimensions.</p>
<p>Useful on, for example, retina displays.</p></td>
</tr>
<tr>
<td class="name"><code>maxBitrate</code></td>
<td class="type">
<span class="param-type"><a href="module-Settings.html#~AudioVideoSettings">module:Settings~AudioVideoSettings</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
{audio: -1, video: -1}
</td>
<td class="description last"><p>The maximum bitrate that the ABR algorithms will choose. This value is specified in kbps.</p>
<p>Use -1 for no limit.</p></td>
</tr>
<tr>
<td class="name"><code>minBitrate</code></td>
<td class="type">
<span class="param-type"><a href="module-Settings.html#~AudioVideoSettings">module:Settings~AudioVideoSettings</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
{audio: -1, video: -1}
</td>
<td class="description last"><p>The minimum bitrate that the ABR algorithms will choose. This value is specified in kbps.</p>
<p>Use -1 for no limit.</p></td>
</tr>
<tr>
<td class="name"><code>maxRepresentationRatio</code></td>
<td class="type">
<span class="param-type"><a href="module-Settings.html#~AudioVideoSettings">module:Settings~AudioVideoSettings</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
{audio: 1, video: 1}
</td>
<td class="description last"><p>When switching multi-bitrate content (auto or manual mode) this property specifies the maximum representation allowed, as a proportion of the size of the representation set.</p>
<p>You can set or remove this cap at anytime before or during playback.</p>
<p>To clear this setting you set the value to 1.</p>
<p>If both this and maxAllowedBitrate are defined, maxAllowedBitrate is evaluated first, then maxAllowedRepresentation, i.e. the lowest value from executing these rules is used.</p>
<p>This feature is typically used to reserve higher representations for playback only when connected over a fast connection.</p></td>
</tr>
<tr>
<td class="name"><code>initialBitrate</code></td>
<td class="type">
<span class="param-type"><a href="module-Settings.html#~AudioVideoSettings">module:Settings~AudioVideoSettings</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
{audio: -1, video: -1}
</td>
<td class="description last"><p>Explicitly set the starting bitrate for audio or video. This value is specified in kbps.</p>
<p>Use -1 to let the player decide.</p></td>
</tr>
<tr>
<td class="name"><code>initialRepresentationRatio</code></td>
<td class="type">
<span class="param-type"><a href="module-Settings.html#~AudioVideoSettings">module:Settings~AudioVideoSettings</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
{audio: -1, video: -1}
</td>
<td class="description last"><p>Explicitly set the initial representation ratio.</p>
<p>If initalBitrate is specified, this is ignored.</p></td>
</tr>
<tr>
<td class="name"><code>autoSwitchBitrate</code></td>
<td class="type">
<span class="param-type"><a href="module-Settings.html#~AudioVideoSettings">module:Settings~AudioVideoSettings</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
{audio: true, video: true}
</td>
<td class="description last"><p>Indicates whether the player should enable ABR algorithms to switch the bitrate.</p></td>
</tr>
<tr>
<td class="name"><code>fetchThroughputCalculationMode</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
"abrFetchThroughputCalculationDownloadedData"
</td>
<td class="description last"><p>Algorithm to determine the throughput in case the Fetch API is used for low latency streaming.</p>
<p>For details please check the samples section and FetchLoader.js.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="core_Settings.js.html">core/Settings.js</a>,
<a href="core_Settings.js.html#sunlight-1-line-534">line 534</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id="~AudioVideoSettings">
<h4 id="~AudioVideoSettings">AudioVideoSettings</h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>audio</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">boolean</span>
|
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Configuration for audio media type of tracks.</p></td>
</tr>
<tr>
<td class="name"><code>video</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">boolean</span>
|
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Configuration for video media type of tracks.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="core_Settings.js.html">core/Settings.js</a>,
<a href="core_Settings.js.html#sunlight-1-line-314">line 314</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id="~Buffer">
<h4 id="~Buffer">Buffer</h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>enableSeekDecorrelationFix</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>Enables a workaround for playback start on some devices, e.g. WebOS 4.9.<br>
It is necessary because some browsers do not support setting currentTime on video element to a value that is outside of current buffer.</p>
<p>If you experience unexpected seeking triggered by BufferController, you can try setting this value to false.</p></td>
</tr>
<tr>
<td class="name"><code>fastSwitchEnabled</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>When enabled, after an ABR up-switch in quality, instead of requesting and appending the next fragment at the end of the current buffer range it is requested and appended closer to the current time.</p>
<p>When enabled, The maximum time to render a higher quality is current time + (1.5 * fragment duration).</p>
<p>Note, When ABR down-switch is detected, we appended the lower quality at the end of the buffer range to preserve the<br>
higher quality media for as long as possible.</p>
<p>If enabled, it should be noted there are a few cases when the client will not replace inside buffer range but rather just append at the end.</p>
<ol>
<li>When the buffer level is less than one fragment duration.</li>
<li>The client is in an Abandonment State due to recent fragment abandonment event.</li>
</ol>
<p>Known issues:</p>
<ol>
<li>In IE11 with auto switching off, if a user switches to a quality they can not download in time the fragment may be appended in the same range as the playhead or even in the past, in IE11 it may cause a stutter or stall in playback.</li>
</ol></td>
</tr>
<tr>
<td class="name"><code>flushBufferAtTrackSwitch</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>When enabled, after a track switch and in case buffer is being replaced, the video element is flushed (seek at current playback time) once a segment of the new track is appended in buffer in order to force video decoder to play new track.</p>
<p>This can be required on some devices like GoogleCast devices to make track switching functional.</p>
<p>Otherwise track switching will be effective only once after previous buffered track is fully consumed.</p></td>
</tr>
<tr>
<td class="name"><code>reuseExistingSourceBuffers</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>Enable reuse of existing MediaSource Sourcebuffers during period transition.</p></td>
</tr>
<tr>
<td class="name"><code>bufferPruningInterval</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
10
</td>
<td class="description last"><p>The interval of pruning buffer in seconds.</p></td>
</tr>
<tr>
<td class="name"><code>bufferToKeep</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
20
</td>
<td class="description last"><p>This value influences the buffer pruning logic.</p>
<p>Allows you to modify the buffer that is kept in source buffer in seconds.<br>
0|-----------bufferToPrune-----------|-----bufferToKeep-----|currentTime|</p></td>
</tr>
<tr>
<td class="name"><code>bufferTimeAtTopQuality</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
30
</td>
<td class="description last"><p>The time that the internal buffer target will be set to once playing the top quality.</p>
<p>If there are multiple bitrates in your adaptation, and the media is playing at the highest bitrate, then we try to build a larger buffer at the top quality to increase stability and to maintain media quality.</p></td>
</tr>
<tr>
<td class="name"><code>bufferTimeAtTopQualityLongForm</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
60
</td>
<td class="description last"><p>The time that the internal buffer target will be set to once playing the top quality for long form content.</p></td>
</tr>
<tr>
<td class="name"><code>longFormContentDurationThreshold</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
600
</td>
<td class="description last"><p>The threshold which defines if the media is considered long form content.</p>
<p>This will directly affect the buffer targets when playing back at the top quality.</p></td>
</tr>
<tr>
<td class="name"><code>initialBufferLevel</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
NaN
</td>
<td class="description last"><p>Initial buffer level before playback starts</p></td>
</tr>
<tr>
<td class="name"><code>stableBufferTime</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
12
</td>
<td class="description last"><p>The time that the internal buffer target will be set to post startup/seeks (NOT top quality).</p>
<p>When the time is set higher than the default you will have to wait longer to see automatic bitrate switches but will have a larger buffer which will increase stability.</p></td>
</tr>
<tr>
<td class="name"><code>stallThreshold</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
0.3
</td>
<td class="description last"><p>Stall threshold used in BufferController.js to determine whether a track should still be changed and which buffer range to prune.</p></td>
</tr>
<tr>
<td class="name"><code>useAppendWindow</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>Specifies if the appendWindow attributes of the MSE SourceBuffers should be set according to content duration from manifest.</p></td>
</tr>
<tr>
<td class="name"><code>setStallState</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>Specifies if we fire manual waiting events once the stall threshold is reached</p></td>
</tr>
<tr>
<td class="name"><code>avoidCurrentTimeRangePruning</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>Avoids pruning of the buffered range that contains the current playback time.</p>
<p>That buffered range is likely to have been enqueued for playback. Pruning it causes a flush and reenqueue in WPE and WebKitGTK based browsers. This stresses the video decoder and can cause stuttering on embedded platforms.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="core_Settings.js.html">core/Settings.js</a>,
<a href="core_Settings.js.html#sunlight-1-line-249">line 249</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id="~CachingInfoSettings">
<h4 id="~CachingInfoSettings">CachingInfoSettings</h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>enable</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Enable or disable the caching feature.</p></td>
</tr>
<tr>
<td class="name"><code>ttl</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Time to live.</p>
<p>A value defined in milliseconds representing how log to cache the settings for.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="core_Settings.js.html">core/Settings.js</a>,
<a href="core_Settings.js.html#sunlight-1-line-363">line 363</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id="~Capabilities">
<h4 id="~Capabilities">Capabilities</h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>filterUnsupportedEssentialProperties</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>Enable to filter all the AdaptationSets and Representations which contain an unsupported <EssentialProperty> element.</p></td>
</tr>
<tr>
<td class="name"><code>useMediaCapabilitiesApi</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>Enable to use the MediaCapabilities API to check whether codecs are supported. If disabled MSE.isTypeSupported will be used instead.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="core_Settings.js.html">core/Settings.js</a>,
<a href="core_Settings.js.html#sunlight-1-line-526">line 526</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id="~CmcdSettings">
<h4 id="~CmcdSettings">CmcdSettings</h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>enable</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>Enable or disable the CMCD reporting.</p></td>
</tr>
<tr>
<td class="name"><code>sid</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>GUID identifying the current playback session.</p>
<p>Should be in UUID format.</p>
<p>If not specified a UUID will be automatically generated.</p></td>
</tr>
<tr>
<td class="name"><code>cid</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>A unique string to identify the current content.</p>
<p>If not specified it will be a hash of the MPD url.</p></td>
</tr>
<tr>
<td class="name"><code>rtp</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>The requested maximum throughput that the client considers sufficient for delivery of the asset.</p>
<p>If not specified this value will be dynamically calculated in the CMCDModel based on the current buffer level.</p></td>
</tr>
<tr>
<td class="name"><code>rtpSafetyFactor</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>This value is used as a factor for the rtp value calculation: rtp = minBandwidth * rtpSafetyFactor</p>
<p>If not specified this value defaults to 5. Note that this value is only used when no static rtp value is defined.</p></td>
</tr>
<tr>
<td class="name"><code>mode</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>The method to use to attach cmcd metrics to the requests. 'query' to use query parameters, 'header' to use http headers.</p>
<p>If not specified this value defaults to 'query'.</p></td>
</tr>
<tr>
<td class="name"><code>enabledKeys</code></td>
<td class="type">
<span class="param-type">Array.<string></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>This value is used to specify the desired CMCD parameters. Parameters not included in this list are not reported.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="core_Settings.js.html">core/Settings.js</a>,
<a href="core_Settings.js.html#sunlight-1-line-612">line 612</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id="~DebugSettings">
<h4 id="~DebugSettings">DebugSettings</h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>logLevel</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
dashjs.Debug.LOG_LEVEL_WARNING
</td>
<td class="description last"><p>Sets up the log level. The levels are cumulative.</p>
<p>For example, if you set the log level to dashjs.Debug.LOG_LEVEL_WARNING all warnings, errors and fatals will be logged.</p>
<p>Possible values.</p>
<ul>
<li>
<p>dashjs.Debug.LOG_LEVEL_NONE<br>
No message is written in the browser console.</p>
</li>
<li>
<p>dashjs.Debug.LOG_LEVEL_FATAL<br>
Log fatal errors.<br>
An error is considered fatal when it causes playback to fail completely.</p>
</li>
<li>
<p>dashjs.Debug.LOG_LEVEL_ERROR<br>
Log error messages.</p>
</li>
<li>
<p>dashjs.Debug.LOG_LEVEL_WARNING<br>
Log warning messages.</p>
</li>
<li>
<p>dashjs.Debug.LOG_LEVEL_INFO<br>
Log info messages.</p>
</li>
<li>
<p>dashjs.Debug.LOG_LEVEL_DEBUG<br>
Log debug messages.</p>
</li>
</ul></td>
</tr>
<tr>
<td class="name"><code>dispatchEvent</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>Enable to trigger a Events.LOG event whenever log output is generated.</p>
<p>Note this will be dispatched regardless of log level.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="core_Settings.js.html">core/Settings.js</a>,
<a href="core_Settings.js.html#sunlight-1-line-322">line 322</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id="~ErrorSettings">
<h4 id="~ErrorSettings">ErrorSettings</h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>recoverAttempts</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
{mediaErrorDecode: 5}
</td>
<td class="description last"><p>Defines the maximum number of recover attempts for specific media errors.</p>
<p>For mediaErrorDecode the player will reset the MSE and skip the blacklisted segment that caused the decode error. The resulting gap will be handled by the GapController.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="core_Settings.js.html">core/Settings.js</a>,
<a href="core_Settings.js.html#sunlight-1-line-355">line 355</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id="~Gaps">
<h4 id="~Gaps">Gaps</h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>jumpGaps</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>Sets whether player should jump small gaps (discontinuities) in the buffer.</p></td>
</tr>
<tr>
<td class="name"><code>jumpLargeGaps</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>Sets whether player should jump large gaps (discontinuities) in the buffer.</p></td>
</tr>
<tr>
<td class="name"><code>smallGapLimit</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
1.5
</td>
<td class="description last"><p>Time in seconds for a gap to be considered small.</p></td>
</tr>
<tr>
<td class="name"><code>threshold</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
0.3
</td>
<td class="description last"><p>Threshold at which the gap handling is executed. If currentRangeEnd - currentTime < threshold the gap jump will be triggered.<br>
For live stream the jump might be delayed to keep a consistent live edge.<br>
Note that the amount of buffer at which platforms automatically stall might differ.</p></td>
</tr>
<tr>
<td class="name"><code>enableSeekFix</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>Enables the adjustment of the seek target once no valid segment request could be generated for a specific seek time. This can happen if the user seeks to a position for which there is a gap in the timeline.</p></td>
</tr>
<tr>
<td class="name"><code>enableStallFix</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>If playback stalled in a buffered range this fix will perform a seek by the value defined in stallSeek to trigger playback again.</p></td>
</tr>
<tr>
<td class="name"><code>stallSeek</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
0.1
</td>
<td class="description last"><p>Value to be used in case enableStallFix is set to true</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="core_Settings.js.html">core/Settings.js</a>,
<a href="core_Settings.js.html#sunlight-1-line-373">line 373</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id="~LiveCatchupSettings">
<h4 id="~LiveCatchupSettings">LiveCatchupSettings</h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>maxDrift</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
NaN
</td>
<td class="description last"><p>Use this method to set the maximum latency deviation allowed before dash.js to do a seeking to live position.</p>
<p>In low latency mode, when the difference between the measured latency and the target one, as an absolute number, is higher than the one sets with this method, then dash.js does a seek to live edge position minus the target live delay.</p>
<p>LowLatencyMaxDriftBeforeSeeking should be provided in seconds.</p>
<p>If 0, then seeking operations won't be used for fixing latency deviations.</p>
<p>Note: Catch-up mechanism is only applied when playing low latency live streams.</p></td>
</tr>
<tr>
<td class="name"><code>playbackRate</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
NaN
</td>
<td class="description last"><p>Use this parameter to set the maximum catch up rate, as a percentage, for low latency live streams.</p>
<p>In low latency mode, when measured latency is higher/lower than the target one, dash.js increases/decreases playback rate respectively up to (+/-) the percentage defined with this method until target is reached.</p>
<p>Valid values for catch up rate are in range 0-0.5 (0-50%).</p>
<p>Set it to NaN to turn off live catch up feature.</p>
<p>Note: Catch-up mechanism is only applied when playing low latency live streams.</p></td>
</tr>
<tr>
<td class="name"><code>playbackBufferMin</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
NaN
</td>
<td class="description last"><p>Use this parameter to specify the minimum buffer which is used for LoL+ based playback rate reduction.</p></td>
</tr>
<tr>
<td class="name"><code>enabled</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>Use this parameter to enable the catchup mode for non low-latency streams.</p></td>
</tr>
<tr>
<td class="name"><code>mode</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
"liveCatchupModeDefault"
</td>
<td class="description last"><p>Use this parameter to switch between different catchup modes.</p>
<p>Options: "liveCatchupModeDefault" or "liveCatchupModeLOLP".</p>
<p>Note: Catch-up mechanism is automatically applied when playing low latency live streams.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="core_Settings.js.html">core/Settings.js</a>,
<a href="core_Settings.js.html#sunlight-1-line-448">line 448</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id="~LiveDelay">
<h4 id="~LiveDelay">LiveDelay</h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>liveDelayFragmentCount</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
NaN
</td>
<td class="description last"><p>Changing this value will lower or increase live stream latency.</p>
<p>The detected segment duration will be multiplied by this value to define a time in seconds to delay a live stream from the live edge.</p>
<p>Lowering this value will lower latency but may decrease the player's ability to build a stable buffer.</p></td>
</tr>
<tr>
<td class="name"><code>liveDelay</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>Equivalent in seconds of setLiveDelayFragmentCount.</p>
<p>Lowering this value will lower latency but may decrease the player's ability to build a stable buffer.</p>
<p>This value should be less than the manifest duration by a couple of segment durations to avoid playback issues.</p>
<p>If set, this parameter will take precedence over setLiveDelayFragmentCount and manifest info.</p></td>
</tr>
<tr>
<td class="name"><code>useSuggestedPresentationDelay</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>Set to true if you would like to overwrite the default live delay and honor the SuggestedPresentationDelay attribute in by the manifest.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="core_Settings.js.html">core/Settings.js</a>,
<a href="core_Settings.js.html#sunlight-1-line-229">line 229</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id="~Metrics">
<h4 id="~Metrics">Metrics</h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>metricsMaxListDepth</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
100
</td>
<td class="description last"><p>Maximum number of metrics that are persisted per type.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="core_Settings.js.html">core/Settings.js</a>,
<a href="core_Settings.js.html#sunlight-1-line-642">line 642</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id="~PlayerSettings">
<h4 id="~PlayerSettings">PlayerSettings</h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>debug</code></td>
<td class="type">
<span class="param-type"><a href="module-Settings.html#~DebugSettings">module:Settings~DebugSettings</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Debug related settings.</p></td>
</tr>
<tr>
<td class="name"><code>errors</code></td>
<td class="type">
<span class="param-type"><a href="module-Settings.html#~ErrorSettings">module:Settings~ErrorSettings</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Error related settings</p></td>
</tr>
<tr>
<td class="name"><code>streaming</code></td>
<td class="type">
<span class="param-type"><a href="module-Settings.html#~StreamingSettings">module:Settings~StreamingSettings</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Streaming related settings.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="core_Settings.js.html">core/Settings.js</a>,
<a href="core_Settings.js.html#sunlight-1-line-45">line 45</a>
</li>
</ul>
</dd>
</dl>
<h5>Example</h5>
<pre class="sunlight-highlight-javascript">// Full settings object
settings = {
debug: {
logLevel: Debug.LOG_LEVEL_WARNING,
dispatchEvent: false
},
streaming: {
abandonLoadTimeout: 10000,
wallclockTimeUpdateInterval: 100,
manifestUpdateRetryInterval: 100,
cacheInitSegments: true,
applyServiceDescription: true,
applyProducerReferenceTime: true,
applyContentSteering: true,
eventControllerRefreshDelay: 100,
enableManifestDurationMismatchFix: true,
capabilities: {
filterUnsupportedEssentialProperties: true,
useMediaCapabilitiesApi: false
},
timeShiftBuffer: {
calcFromSegmentTimeline: false,
fallbackToSegmentTimeline: true
},
metrics: {
maxListDepth: 100
},
delay: {
liveDelayFragmentCount: NaN,
liveDelay: NaN,
useSuggestedPresentationDelay: true
},
protection: {
keepProtectionMediaKeys: false,
ignoreEmeEncryptedEvent: false,
detectPlayreadyMessageFormat: true,
},
buffer: {
enableSeekDecorrelationFix: true,
fastSwitchEnabled: true,
flushBufferAtTrackSwitch: false,
reuseExistingSourceBuffers: true,
bufferPruningInterval: 10,
bufferToKeep: 20,
bufferTimeAtTopQuality: 30,
bufferTimeAtTopQualityLongForm: 60,
initialBufferLevel: NaN,
stableBufferTime: 12,
longFormContentDurationThreshold: 600,
stallThreshold: 0.5,
useAppendWindow: true,
setStallState: true,
avoidCurrentTimeRangePruning: false
},
gaps: {
jumpGaps: true,
jumpLargeGaps: true,
smallGapLimit: 1.5,
threshold: 0.3,
enableSeekFix: true,
enableStallFix: false,
stallSeek: 0.1
},
utcSynchronization: {
enabled: true,
useManifestDateHeaderTimeSource: true,
backgroundAttempts: 2,
timeBetweenSyncAttempts: 30,
maximumTimeBetweenSyncAttempts: 600,
minimumTimeBetweenSyncAttempts: 2,
timeBetweenSyncAttemptsAdjustmentFactor: 2,
maximumAllowedDrift: 100,
enableBackgroundSyncAfterSegmentDownloadError: true,
defaultTimingSource: {
scheme: 'urn:mpeg:dash:utc:http-xsdate:2014',
value: 'http://time.akamai.com/?iso&ms'
}
},
scheduling: {
defaultTimeout: 300,
lowLatencyTimeout: 100,
scheduleWhilePaused: true
},
text: {
defaultEnabled: true
},
liveCatchup: {
maxDrift: NaN,
playbackRate: NaN,
playbackBufferMin: 0.5,
enabled: false,
mode: Constants.LIVE_CATCHUP_MODE_DEFAULT
},
lastBitrateCachingInfo: { enabled: true, ttl: 360000 },
lastMediaSettingsCachingInfo: { enabled: true, ttl: 360000 },
cacheLoadThresholds: { video: 50, audio: 5 },
trackSwitchMode: {
audio: Constants.TRACK_SWITCH_MODE_ALWAYS_REPLACE,
video: Constants.TRACK_SWITCH_MODE_NEVER_REPLACE
},
selectionModeForInitialTrack: Constants.TRACK_SELECTION_MODE_HIGHEST_SELECTION_PRIORITY,
fragmentRequestTimeout: 0,
retryIntervals: {
[HTTPRequest.MPD_TYPE]: 500,
[HTTPRequest.XLINK_EXPANSION_TYPE]: 500,
[HTTPRequest.MEDIA_SEGMENT_TYPE]: 1000,
[HTTPRequest.INIT_SEGMENT_TYPE]: 1000,
[HTTPRequest.BITSTREAM_SWITCHING_SEGMENT_TYPE]: 1000,
[HTTPRequest.INDEX_SEGMENT_TYPE]: 1000,
[HTTPRequest.MSS_FRAGMENT_INFO_SEGMENT_TYPE]: 1000,
[HTTPRequest.LICENSE]: 1000,
[HTTPRequest.OTHER_TYPE]: 1000,
lowLatencyReductionFactor: 10
},
retryAttempts: {
[HTTPRequest.MPD_TYPE]: 3,
[HTTPRequest.XLINK_EXPANSION_TYPE]: 1,
[HTTPRequest.MEDIA_SEGMENT_TYPE]: 3,
[HTTPRequest.INIT_SEGMENT_TYPE]: 3,
[HTTPRequest.BITSTREAM_SWITCHING_SEGMENT_TYPE]: 3,
[HTTPRequest.INDEX_SEGMENT_TYPE]: 3,
[HTTPRequest.MSS_FRAGMENT_INFO_SEGMENT_TYPE]: 3,
[HTTPRequest.LICENSE]: 3,
[HTTPRequest.OTHER_TYPE]: 3,
lowLatencyMultiplyFactor: 5
},
abr: {
movingAverageMethod: Constants.MOVING_AVERAGE_SLIDING_WINDOW,
ABRStrategy: Constants.ABR_STRATEGY_DYNAMIC,
additionalAbrRules: {
insufficientBufferRule: false,
switchHistoryRule: true,
droppedFramesRule: true,
abandonRequestsRule: false
},
bandwidthSafetyFactor: 0.9,
useDefaultABRRules: true,
useDeadTimeLatency: true,
limitBitrateByPortal: false,
usePixelRatioInLimitBitrateByPortal: false,
maxBitrate: { audio: -1, video: -1 },
minBitrate: { audio: -1, video: -1 },
maxRepresentationRatio: { audio: 1, video: 1 },
initialBitrate: { audio: -1, video: -1 },
initialRepresentationRatio: { audio: -1, video: -1 },
autoSwitchBitrate: { audio: true, video: true },
fetchThroughputCalculationMode: Constants.ABR_FETCH_THROUGHPUT_CALCULATION_DOWNLOADED_DATA
},
cmcd: {
enabled: false,
sid: null,
cid: null,
rtp: null,
rtpSafetyFactor: 5,
mode: Constants.CMCD_MODE_QUERY,
enabledKeys: ['br', 'd', 'ot', 'tb' , 'bl', 'dl', 'mtp', 'nor', 'nrr', 'su' , 'bs', 'rtp' , 'cid', 'pr', 'sf', 'sid', 'st', 'v']
}
},
errors: {
recoverAttempts: {
mediaErrorDecode: 5
}
}
}</pre>
</dd>
<hr>
<dt class="name" id="~Protection">
<h4 id="~Protection">Protection</h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>keepProtectionMediaKeys</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>Set the value for the ProtectionController and MediaKeys life cycle.</p>
<p>If true, the ProtectionController and then created MediaKeys and MediaKeySessions will be preserved during the MediaPlayer lifetime.</p></td>
</tr>
<tr>
<td class="name"><code>ignoreEmeEncryptedEvent</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>If set to true the player will ignore "encrypted" and "needkey" events thrown by the EME.</p></td>
</tr>
<tr>
<td class="name"><code>detectPlayreadyMessageFormat</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>If set to true the player will use the raw unwrapped message from the Playready CDM</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="core_Settings.js.html">core/Settings.js</a>,
<a href="core_Settings.js.html#sunlight-1-line-513">line 513</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id="~RequestTypeSettings">
<h4 id="~RequestTypeSettings">RequestTypeSettings</h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>MPD</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Manifest type of requests.</p></td>
</tr>
<tr>
<td class="name"><code>XLinkExpansion</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>XLink expansion type of requests.</p></td>
</tr>
<tr>
<td class="name"><code>InitializationSegment</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Request to retrieve an initialization segment.</p></td>
</tr>
<tr>
<td class="name"><code>IndexSegment</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Request to retrieve an index segment (SegmentBase).</p></td>
</tr>
<tr>
<td class="name"><code>MediaSegment</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Request to retrieve a media segment (video/audio/image/text chunk).</p></td>
</tr>
<tr>
<td class="name"><code>BitstreamSwitchingSegment</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Bitrate stream switching type of request.</p></td>
</tr>
<tr>
<td class="name"><code>FragmentInfoSegment</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Request to retrieve a FragmentInfo segment (specific to Smooth Streaming live streams).</p></td>
</tr>
<tr>
<td class="name"><code>other</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Other type of request.</p></td>
</tr>
<tr>
<td class="name"><code>lowLatencyReductionFactor</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>For low latency mode, values of type of request are divided by lowLatencyReductionFactor.</p>
<p>Note: It's not type of request.</p></td>
</tr>
<tr>
<td class="name"><code>lowLatencyMultiplyFactor</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>For low latency mode, values of type of request are multiplied by lowLatencyMultiplyFactor.</p>
<p>Note: It's not type of request.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="core_Settings.js.html">core/Settings.js</a>,
<a href="core_Settings.js.html#sunlight-1-line-485">line 485</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id="~Scheduling">
<h4 id="~Scheduling">Scheduling</h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>defaultTimeout</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
300
</td>
<td class="description last"><p>Default timeout between two consecutive segment scheduling attempts</p></td>
</tr>
<tr>
<td class="name"><code>lowLatencyTimeout</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>Default timeout between two consecutive low-latency segment scheduling attempts</p></td>
</tr>
<tr>
<td class="name"><code>scheduleWhilePaused</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>Set to true if you would like dash.js to keep downloading fragments in the background when the video element is paused.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="core_Settings.js.html">core/Settings.js</a>,
<a href="core_Settings.js.html#sunlight-1-line-432">line 432</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id="~StreamingSettings">
<h4 id="~StreamingSettings">StreamingSettings</h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>abandonLoadTimeout</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
10000
</td>
<td class="description last"><p>A timeout value in seconds, which during the ABRController will block switch-up events.</p>
<p>This will only take effect after an abandoned fragment event occurs.</p></td>
</tr>
<tr>
<td class="name"><code>wallclockTimeUpdateInterval</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
50
</td>
<td class="description last"><p>How frequently the wallclockTimeUpdated internal event is triggered (in milliseconds).</p></td>
</tr>
<tr>
<td class="name"><code>manifestUpdateRetryInterval</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
100
</td>
<td class="description last"><p>For live streams, set the interval-frequency in milliseconds at which dash.js will check if the current manifest is still processed before downloading the next manifest once the minimumUpdatePeriod time has.</p></td>
</tr>
<tr>
<td class="name"><code>cacheInitSegments</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>Enables the caching of init segments to avoid requesting the init segments before each representation switch.</p></td>
</tr>
<tr>
<td class="name"><code>applyServiceDescription</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>Set to true if dash.js should use the parameters defined in ServiceDescription elements</p></td>
</tr>
<tr>
<td class="name"><code>applyProducerReferenceTime</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>Set to true if dash.js should use the parameters defined in ProducerReferenceTime elements in combination with ServiceDescription elements.</p></td>
</tr>
<tr>
<td class="name"><code>applyContentSteering</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>Set to true if dash.js should apply content steering during playback.</p></td>
</tr>
<tr>
<td class="name"><code>eventControllerRefreshDelay</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
100
</td>
<td class="description last"><p>For multi-period streams, overwrite the manifest mediaPresentationDuration attribute with the sum of period durations if the manifest mediaPresentationDuration is greater than the sum of period durations</p></td>
</tr>
<tr>
<td class="name"><code>enableManifestDurationMismatchFix</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>Defines the delay in milliseconds between two consecutive checks for events to be fired.</p></td>
</tr>
<tr>
<td class="name"><code>metrics</code></td>
<td class="type">
<span class="param-type"><a href="module-Settings.html#~Metrics">module:Settings~Metrics</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Metric settings</p></td>
</tr>
<tr>
<td class="name"><code>delay</code></td>
<td class="type">
<span class="param-type"><a href="module-Settings.html#~LiveDelay">module:Settings~LiveDelay</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Live Delay settings</p></td>
</tr>
<tr>
<td class="name"><code>timeShiftBuffer</code></td>
<td class="type">
<span class="param-type"><a href="module-Settings.html#~TimeShiftBuffer">module:Settings~TimeShiftBuffer</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>TimeShiftBuffer settings</p></td>
</tr>
<tr>
<td class="name"><code>protection</code></td>
<td class="type">
<span class="param-type"><a href="module-Settings.html#~Protection">module:Settings~Protection</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>DRM related settings</p></td>
</tr>
<tr>
<td class="name"><code>capabilities</code></td>
<td class="type">
<span class="param-type"><a href="module-Settings.html#~Capabilities">module:Settings~Capabilities</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Capability related settings</p></td>
</tr>
<tr>
<td class="name"><code>buffer</code></td>
<td class="type">
<span class="param-type"><a href="module-Settings.html#~Buffer">module:Settings~Buffer</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Buffer related settings</p></td>
</tr>
<tr>
<td class="name"><code>gaps</code></td>
<td class="type">
<span class="param-type"><a href="module-Settings.html#~Gaps">module:Settings~Gaps</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Gap related settings</p></td>
</tr>
<tr>
<td class="name"><code>utcSynchronization</code></td>
<td class="type">
<span class="param-type"><a href="module-Settings.html#~UtcSynchronizationSettings">module:Settings~UtcSynchronizationSettings</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Settings related to UTC clock synchronization</p></td>
</tr>
<tr>
<td class="name"><code>scheduling</code></td>
<td class="type">
<span class="param-type"><a href="module-Settings.html#~Scheduling">module:Settings~Scheduling</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Settings related to segment scheduling</p></td>
</tr>
<tr>
<td class="name"><code>text</code></td>
<td class="type">
<span class="param-type"><a href="module-Settings.html#~Text">module:Settings~Text</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Settings related to Subtitles and captions</p></td>
</tr>
<tr>
<td class="name"><code>liveCatchup</code></td>
<td class="type">
<span class="param-type"><a href="module-Settings.html#~LiveCatchupSettings">module:Settings~LiveCatchupSettings</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Settings related to live catchup.</p></td>
</tr>
<tr>
<td class="name"><code>lastBitrateCachingInfo</code></td>
<td class="type">
<span class="param-type"><a href="module-Settings.html#~CachingInfoSettings">module:Settings~CachingInfoSettings</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
{enabled: true, ttl: 360000}
</td>
<td class="description last"><p>Set to false if you would like to disable the last known bit rate from being stored during playback and used to set the initial bit rate for subsequent playback within the expiration window.</p>
<p>The default expiration is one hour, defined in milliseconds.</p>
<p>If expired, the default initial bit rate (closest to 1000 kbps) will be used for that session and a new bit rate will be stored during that session.</p></td>
</tr>
<tr>
<td class="name"><code>cacheLoadThresholds</code></td>
<td class="type">
<span class="param-type"><a href="module-Settings.html#~AudioVideoSettings">module:Settings~AudioVideoSettings</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
{video: 50, audio: 5}
</td>
<td class="description last"><p>For a given media type, the threshold which defines if the response to a fragment request is coming from browser cache or not.</p></td>
</tr>
<tr>
<td class="name"><code>trackSwitchMode</code></td>
<td class="type">
<span class="param-type"><a href="module-Settings.html#~AudioVideoSettings">module:Settings~AudioVideoSettings</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
{video: "neverReplace", audio: "alwaysReplace"}
</td>
<td class="description last"><p>For a given media type defines if existing segments in the buffer should be overwritten once the track is switched. For instance if the user switches the audio language the existing segments in the audio buffer will be replaced when setting this value to "alwaysReplace".</p>
<p>Possible values</p>
<ul>
<li>
<p>Constants.TRACK_SWITCH_MODE_ALWAYS_REPLACE<br>
Replace existing segments in the buffer</p>
</li>
<li>
<p>Constants.TRACK_SWITCH_MODE_NEVER_REPLACE<br>
Do not replace existing segments in the buffer</p>
</li>
</ul></td>
</tr>
<tr>
<td class="name"><code>selectionModeForInitialTrack</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
"highestBitrate"
</td>
<td class="description last"><p>Sets the selection mode for the initial track. This mode defines how the initial track will be selected if no initial media settings are set. If initial media settings are set this parameter will be ignored. Available options are:</p>
<p>Possible values</p>
<ul>
<li>
<p>Constants.TRACK_SELECTION_MODE_HIGHEST_SELECTION_PRIORITY<br>
This mode makes the player select the track with the highest selectionPriority as defined in the manifest. If not selectionPriority is given we fallback to TRACK_SELECTION_MODE_HIGHEST_BITRATE. This mode is a default mode.</p>
</li>
<li>
<p>Constants.TRACK_SELECTION_MODE_HIGHEST_BITRATE<br>
This mode makes the player select the track with a highest bitrate.</p>
</li>
<li>
<p>Constants.TRACK_SELECTION_MODE_FIRST_TRACK<br>
This mode makes the player select the first track found in the manifest.</p>
</li>
<li>
<p>Constants.TRACK_SELECTION_MODE_HIGHEST_EFFICIENCY<br>
This mode makes the player select the track with the lowest bitrate per pixel average.</p>
</li>
<li>
<p>Constants.TRACK_SELECTION_MODE_WIDEST_RANGE<br>
This mode makes the player select the track with a widest range of bitrates.</p>
</li>
</ul></td>
</tr>
<tr>
<td class="name"><code>fragmentRequestTimeout</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>Time in milliseconds before timing out on loading a media fragment.</p>
<p>Fragments that timeout are retried as if they failed.</p></td>
</tr>
<tr>
<td class="name"><code>retryIntervals</code></td>
<td class="type">
<span class="param-type"><a href="module-Settings.html#~RequestTypeSettings">module:Settings~RequestTypeSettings</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>Time in milliseconds of which to reload a failed file load attempt.</p>
<p>For low latency mode these values are divided by lowLatencyReductionFactor.</p></td>
</tr>
<tr>
<td class="name"><code>retryAttempts</code></td>
<td class="type">
<span class="param-type"><a href="module-Settings.html#~RequestTypeSettings">module:Settings~RequestTypeSettings</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>Total number of retry attempts that will occur on a file load before it fails.</p>
<p>For low latency mode these values are multiplied by lowLatencyMultiplyFactor.</p></td>
</tr>
<tr>
<td class="name"><code>abr</code></td>
<td class="type">
<span class="param-type"><a href="module-Settings.html#~AbrSettings">module:Settings~AbrSettings</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Adaptive Bitrate algorithm related settings.</p></td>
</tr>
<tr>
<td class="name"><code>cmcd</code></td>
<td class="type">
<span class="param-type"><a href="module-Settings.html#~CmcdSettings">module:Settings~CmcdSettings</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Settings related to Common Media Client Data reporting.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="core_Settings.js.html">core/Settings.js</a>,
<a href="core_Settings.js.html#sunlight-1-line-648">line 648</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id="~Text">
<h4 id="~Text">Text</h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>defaultEnabled</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>Enable/disable subtitle rendering by default.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="core_Settings.js.html">core/Settings.js</a>,
<a href="core_Settings.js.html#sunlight-1-line-442">line 442</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id="~TimeShiftBuffer">
<h4 id="~TimeShiftBuffer">TimeShiftBuffer</h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>calcFromSegmentTimeline</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>Enable calculation of the DVR window for SegmentTimeline manifests based on the entries in <SegmentTimeline>.</p>
<ul>
<li>@property {boolean} [fallbackToSegmentTimeline=true]<br>
In case the MPD uses <SegmentTimeline\ and no segment is found within the DVR window the DVR window is calculated based on the entries in <SegmentTimeline>.</li>
</ul></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="core_Settings.js.html">core/Settings.js</a>,
<a href="core_Settings.js.html#sunlight-1-line-221">line 221</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id="~UtcSynchronizationSettings">
<h4 id="~UtcSynchronizationSettings">UtcSynchronizationSettings</h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>enabled</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>Enables or disables the UTC clock synchronization</p></td>
</tr>
<tr>
<td class="name"><code>useManifestDateHeaderTimeSource</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>Allows you to enable the use of the Date Header, if exposed with CORS, as a timing source for live edge detection.</p>
<p>The use of the date header will happen only after the other timing source that take precedence fail or are omitted as described.</p></td>
</tr>
<tr>
<td class="name"><code>backgroundAttempts</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
2
</td>
<td class="description last"><p>Number of synchronization attempts to perform in the background after an initial synchronization request has been done. This is used to verify that the derived client-server offset is correct.</p>
<p>The background requests are async and done in parallel to the start of the playback.</p>
<p>This value is also used to perform a resync after 404 errors on segments.</p></td>
</tr>
<tr>
<td class="name"><code>timeBetweenSyncAttempts</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
30
</td>
<td class="description last"><p>The time in seconds between two consecutive sync attempts.</p>
<p>Note: This value is used as an initial starting value. The internal value of the TimeSyncController is adjusted during playback based on the drift between two consecutive synchronization attempts.</p>
<p>Note: A sync is only performed after an MPD update. In case the @minimumUpdatePeriod is larger than this value the sync will be delayed until the next MPD update.</p></td>
</tr>
<tr>
<td class="name"><code>maximumTimeBetweenSyncAttempts</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
600
</td>
<td class="description last"><p>The maximum time in seconds between two consecutive sync attempts.</p></td>
</tr>
<tr>
<td class="name"><code>minimumTimeBetweenSyncAttempts</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
2
</td>
<td class="description last"><p>The minimum time in seconds between two consecutive sync attempts.</p></td>
</tr>
<tr>
<td class="name"><code>timeBetweenSyncAttemptsAdjustmentFactor</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
2
</td>
<td class="description last"><p>The factor used to multiply or divide the timeBetweenSyncAttempts parameter after a sync. The maximumAllowedDrift defines whether this value is used as a factor or a dividend.</p></td>
</tr>
<tr>
<td class="name"><code>maximumAllowedDrift</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
100
</td>
<td class="description last"><p>The maximum allowed drift specified in milliseconds between two consecutive synchronization attempts.</p></td>
</tr>
<tr>
<td class="name"><code>enableBackgroundSyncAfterSegmentDownloadError</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>Enables or disables the background sync after the player ran into a segment download error.</p></td>
</tr>
<tr>
<td class="name"><code>defaultTimingSource</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
{scheme:'urn:mpeg:dash:utc:http-xsdate:2014',value: 'http://time.akamai.com/?iso&ms'}
</td>
<td class="description last"><p>The default timing source to be used. The timing sources in the MPD take precedence over this one.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="core_Settings.js.html">core/Settings.js</a>,
<a href="core_Settings.js.html#sunlight-1-line-393">line 393</a>
</li>
</ul>
</dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
</div>
<div class="clearfix"></div>
<div class="col-md-3">
<div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
</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>