dashjs

Version:

A reference client implementation for the playback of MPEG DASH via Javascript and compliant browsers.

3 lines • 122 kB

HTML

<!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="icon" href="https://dashif.org/img/favicon.ico"><link type="text/css" rel="stylesheet" href="jsdoc-custom.css"><title>Module: Settings</title><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="light"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">Home</a><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-modules"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-DashAdapter.html">DashAdapter</a></div><div class="sidebar-section-children"><a href="module-DashMetrics.html">DashMetrics</a></div><div class="sidebar-section-children"><a href="module-MediaPlayer.html">MediaPlayer</a></div><div class="sidebar-section-children"><a href="module-OfflineController.html">OfflineController</a></div><div class="sidebar-section-children"><a href="module-ProtectionController.html">ProtectionController</a></div><div class="sidebar-section-children"><a href="module-Settings.html">Settings</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="Errors.html">Errors</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html">MediaPlayerEvents</a></div><div class="sidebar-section-children"><a href="MediaPlayerModel.html">MediaPlayerModel</a></div><div class="sidebar-section-children"><a href="MetricsReportingEvents.html">MetricsReportingEvents</a></div><div class="sidebar-section-children"><a href="MssErrors.html">MssErrors</a></div><div class="sidebar-section-children"><a href="OfflineErrors.html">OfflineErrors</a></div><div class="sidebar-section-children"><a href="OfflineEvents.html">OfflineEvents</a></div><div class="sidebar-section-children"><a href="ProtectionErrors.html">ProtectionErrors</a></div><div class="sidebar-section-children"><a href="ProtectionEvents.html">ProtectionEvents</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-events"><div>Events</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:ADAPTATION_SET_REMOVED_NO_CAPABILITIES">ADAPTATION_SET_REMOVED_NO_CAPABILITIES</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:AST_IN_FUTURE">AST_IN_FUTURE</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:BASE_URLS_UPDATED">BASE_URLS_UPDATED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:BUFFER_EMPTY">BUFFER_EMPTY</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:BUFFER_LEVEL_STATE_CHANGED">BUFFER_LEVEL_STATE_CHANGED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:BUFFER_LEVEL_UPDATED">BUFFER_LEVEL_UPDATED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:BUFFER_LOADED">BUFFER_LOADED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:CAN_PLAY">CAN_PLAY</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:CAN_PLAY_THROUGH">CAN_PLAY_THROUGH</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:CAPTION_CONTAINER_RESIZE">CAPTION_CONTAINER_RESIZE</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:CAPTION_RENDERED">CAPTION_RENDERED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:CONFORMANCE_VIOLATION">CONFORMANCE_VIOLATION</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:CONTENT_STEERING_REQUEST_COMPLETED">CONTENT_STEERING_REQUEST_COMPLETED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:CUE_ENTER">CUE_ENTER</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:CUE_ENTER">CUE_ENTER</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:DVB_FONT_DOWNLOAD_ADDED">DVB_FONT_DOWNLOAD_ADDED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:DVB_FONT_DOWNLOAD_COMPLETE">DVB_FONT_DOWNLOAD_COMPLETE</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:DVB_FONT_DOWNLOAD_FAILED">DVB_FONT_DOWNLOAD_FAILED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:DYNAMIC_TO_STATIC">DYNAMIC_TO_STATIC</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:ERROR">ERROR</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:EVENT_MODE_ON_RECEIVE">EVENT_MODE_ON_RECEIVE</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:EVENT_MODE_ON_START">EVENT_MODE_ON_START</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:FRAGMENT_LOADING_ABANDONED">FRAGMENT_LOADING_ABANDONED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:FRAGMENT_LOADING_COMPLETED">FRAGMENT_LOADING_COMPLETED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:FRAGMENT_LOADING_PROGRESS">FRAGMENT_LOADING_PROGRESS</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:FRAGMENT_LOADING_STARTED">FRAGMENT_LOADING_STARTED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:INBAND_PRFT">INBAND_PRFT</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:LOG">LOG</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:MANIFEST_LOADED">MANIFEST_LOADED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:MANIFEST_LOADING_FINISHED">MANIFEST_LOADING_FINISHED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:MANIFEST_LOADING_STARTED">MANIFEST_LOADING_STARTED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:MANIFEST_VALIDITY_CHANGED">MANIFEST_VALIDITY_CHANGED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:METRIC_ADDED">METRIC_ADDED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:METRIC_CHANGED">METRIC_CHANGED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:METRIC_UPDATED">METRIC_UPDATED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:METRICS_CHANGED">METRICS_CHANGED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:PERIOD_SWITCH_COMPLETED">PERIOD_SWITCH_COMPLETED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:PERIOD_SWITCH_STARTED">PERIOD_SWITCH_STARTED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:PLAYBACK_ENDED">PLAYBACK_ENDED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:PLAYBACK_ERROR">PLAYBACK_ERROR</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:PLAYBACK_LOADED_DATA">PLAYBACK_LOADED_DATA</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:PLAYBACK_METADATA_LOADED">PLAYBACK_METADATA_LOADED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:PLAYBACK_NOT_ALLOWED">PLAYBACK_NOT_ALLOWED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:PLAYBACK_PAUSED">PLAYBACK_PAUSED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:PLAYBACK_PLAYING">PLAYBACK_PLAYING</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:PLAYBACK_PROGRESS">PLAYBACK_PROGRESS</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:PLAYBACK_RATE_CHANGED">PLAYBACK_RATE_CHANGED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:PLAYBACK_SEEKED">PLAYBACK_SEEKED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:PLAYBACK_SEEKING">PLAYBACK_SEEKING</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:PLAYBACK_STALLED">PLAYBACK_STALLED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:PLAYBACK_STARTED">PLAYBACK_STARTED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:PLAYBACK_TIME_UPDATED">PLAYBACK_TIME_UPDATED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:PLAYBACK_VOLUME_CHANGED">PLAYBACK_VOLUME_CHANGED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:PLAYBACK_WAITING">PLAYBACK_WAITING</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:QUALITY_CHANGE_RENDERED">QUALITY_CHANGE_RENDERED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:QUALITY_CHANGE_REQUESTED">QUALITY_CHANGE_REQUESTED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:REPRESENTATION_SWITCH">REPRESENTATION_SWITCH</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:STREAM_ACTIVATED">STREAM_ACTIVATED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:STREAM_DEACTIVATED">STREAM_DEACTIVATED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:STREAM_INITIALIZED">STREAM_INITIALIZED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:STREAM_INITIALIZING">STREAM_INITIALIZING</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:STREAM_TEARDOWN_COMPLETE">STREAM_TEARDOWN_COMPLETE</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:STREAM_UPDATED">STREAM_UPDATED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:TEXT_TRACK_ADDED">TEXT_TRACK_ADDED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:TEXT_TRACKS_ADDED">TEXT_TRACKS_ADDED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:THROUGHPUT_MEASUREMENT_STORED">THROUGHPUT_MEASUREMENT_STORED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:TRACK_CHANGE_RENDERED">TRACK_CHANGE_RENDERED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:TTML_PARSED">TTML_PARSED</a></div><div class="sidebar-section-children"><a href="MediaPlayerEvents.html#event:TTML_TO_PARSE">TTML_TO_PARSE</a></div><div class="sidebar-section-children"><a href="MetricsReportingEvents.html#event:CMCD_DATA_GENERATED">CMCD_DATA_GENERATED</a></div><div class="sidebar-section-children"><a href="OfflineEvents.html#event:OFFLINE_RECORD_FINISHED">OFFLINE_RECORD_FINISHED</a></div><div class="sidebar-section-children"><a href="OfflineEvents.html#event:OFFLINE_RECORD_LOADEDMETADATA">OFFLINE_RECORD_LOADEDMETADATA</a></div><div class="sidebar-section-children"><a href="OfflineEvents.html#event:OFFLINE_RECORD_STARTED">OFFLINE_RECORD_STARTED</a></div><div class="sidebar-section-children"><a href="OfflineEvents.html#event:OFFLINE_RECORD_STOPPED">OFFLINE_RECORD_STOPPED</a></div><div class="sidebar-section-children"><a href="ProtectionEvents.html#event:KEY_ADDED">KEY_ADDED</a></div><div class="sidebar-section-children"><a href="ProtectionEvents.html#event:KEY_ERROR">KEY_ERROR</a></div><div class="sidebar-section-children"><a href="ProtectionEvents.html#event:KEY_MESSAGE">KEY_MESSAGE</a></div><div class="sidebar-section-children"><a href="ProtectionEvents.html#event:KEY_SESSION_CLOSED">KEY_SESSION_CLOSED</a></div><div class="sidebar-section-children"><a href="ProtectionEvents.html#event:KEY_SESSION_CREATED">KEY_SESSION_CREATED</a></div><div class="sidebar-section-children"><a href="ProtectionEvents.html#event:KEY_SESSION_REMOVED">KEY_SESSION_REMOVED</a></div><div class="sidebar-section-children"><a href="ProtectionEvents.html#event:KEY_STATUSES_CHANGED">KEY_STATUSES_CHANGED</a></div><div class="sidebar-section-children"><a href="ProtectionEvents.html#event:KEY_SYSTEM_ACCESS_COMPLETE">KEY_SYSTEM_ACCESS_COMPLETE</a></div><div class="sidebar-section-children"><a href="ProtectionEvents.html#event:KEY_SYSTEM_SELECTED">KEY_SYSTEM_SELECTED</a></div><div class="sidebar-section-children"><a href="ProtectionEvents.html#event:LICENSE_REQUEST_COMPLETE">LICENSE_REQUEST_COMPLETE</a></div><div class="sidebar-section-children"><a href="ProtectionEvents.html#event:LICENSE_REQUEST_SENDING">LICENSE_REQUEST_SENDING</a></div><div class="sidebar-section-children"><a href="ProtectionEvents.html#event:PROTECTION_CREATED">PROTECTION_CREATED</a></div><div class="sidebar-section-children"><a href="ProtectionEvents.html#event:PROTECTION_DESTROYED">PROTECTION_DESTROYED</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#LICENSE_SERVER_MANIFEST_CONFIGURATIONS">LICENSE_SERVER_MANIFEST_CONFIGURATIONS</a></div><div class="sidebar-section-children"><a href="global.html#MediaType">MediaType</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#dark-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><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"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="core_Settings.js.html">core/Settings.js</a>, <a href="core_Settings.js.html#line39">line 39</a></li></ul></dd></div><div class="details-item-container"><dt class="tag-see bold">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></div></dl></div><h2 id="type-definitions" class="subsection-title has-anchor">Type Definitions</h2><h3 class="name has-anchor" id="~AbandonRequestRuleParameters">AbandonRequestRuleParameters</h3><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Object</span></li></ul></div><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>graceTimeThreshold</code></td><td class="type"><span class="param-type">number</span></td><td class="attributes"><optional><br></td><td class="default">500</td><td class="description last"><p>Minimum elapsed time in milliseconds that the segment download has to run before the rule considers abandoning the download.</p></td></tr><tr><td class="name"><code>abandonMultiplier</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 multiplied with the segment duration and compared to the estimated time of the download to decide the request should be abandoned.</p></td></tr><tr><td class="name"><code>minLengthToAverage</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>Minimum number of throughput samples required to consider abandoning the download of the segment.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="core_Settings.js.html">core/Settings.js</a>, <a href="core_Settings.js.html#line597">line 597</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="~AbrRulesParameters">AbrRulesParameters</h3><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Object</span></li></ul></div><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>abandonRequestRule</code></td><td class="type"><span class="param-type"><a href="module-Settings.html#~AbandonRequestRuleParameters">module:Settings~AbandonRequestRuleParameters</a></span></td><td class="description last"><p>Configuration parameters for the AbandonRequestRule</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="core_Settings.js.html">core/Settings.js</a>, <a href="core_Settings.js.html#line591">line 591</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="~AbrSettings">AbrSettings</h3><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Object</span></li></ul></div><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Name</th><th>Type</th><th>Attributes</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: true,switchHistoryRule: true,droppedFramesRule: true,abandonRequestsRule: true}</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>abrRulesParameters</code></td><td class="type"><span class="param-type"><a href="module-Settings.html#~AbrRulesParameters">module:Settings~AbrRulesParameters</a></span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Configuration options for the different ABR rules</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></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="core_Settings.js.html">core/Settings.js</a>, <a href="core_Settings.js.html#line607">line 607</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="~AudioVideoSettings">AudioVideoSettings</h3><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Object</span></li></ul></div><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Name</th><th>Type</th><th>Attributes</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> |<wbr> <span class="param-type">boolean</span> |<wbr> <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> |<wbr> <span class="param-type">boolean</span> |<wbr> <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></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="core_Settings.js.html">core/Settings.js</a>, <a href="core_Settings.js.html#line355">line 355</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="~Buffer">Buffer</h3><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Object</span></li></ul></div><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Name</th><th>Type</th><th>Attributes</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><tr><td class="name"><code>useChangeTypeForTrackSwitch</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 this flag is set to true then dash.js will use the MSE v.2 API call "changeType()" before switching to a different track.<br>Note that some platforms might not implement the changeType functio. dash.js is checking for the availability before trying to call it.</p></td></tr><tr><td class="name"><code>mediaSourceDurationInfinity</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 this flag is set to true then dash.js will allow <code>Infinity</code> to be set as the MediaSource duration otherwise the duration will be set to <code>Math.pow(2,32)</code> instead of <code>Infinity</code> to allow appending segments indefinitely.<br>Some platforms such as WebOS 4.x have issues with seeking when duration is set to <code>Infinity</code>, setting this flag to false resolve this.</p></td></tr><tr><td class="name"><code>resetSourceBuffersForTrackSwitch</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 switching to a track that is not compatible with the currently active MSE SourceBuffers, MSE will be reset. This happens when we switch codecs on a system<br>that does not properly implement "changeType()", such as webOS 4.0 and before.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="core_Settings.js.html">core/Settings.js</a>, <a href="core_Settings.js.html#line281">line 281</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="~CachingInfoSettings">CachingInfoSettings</h3><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Object</span></li></ul></div><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Name</th><th>Type</th><th>Attributes</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></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="core_Settings.js.html">core/Settings.js</a>, <a href="core_Settings.js.html#line404">line 404</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="~Capabilities">Capabilities</h3><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Object</span></li></ul></div><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Name</th><th>Type</th><th>Attributes</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></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="core_Settings.js.html">core/Settings.js</a>, <a href="core_Settings.js.html#line583">line 583</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="~CmcdSettings">CmcdSettings</h3><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Object</span></li></ul></div><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Name</th><th>Type</th><th>Attributes</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">5</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">"query"</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></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="core_Settings.js.html">core/Settings.js</a>, <a href="core_Settings.js.html#line686">line 686</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="~CmsdAbrSettings">CmsdAbrSettings</h3><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Object</span></li></ul></div><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>applyMb</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 to true if dash.js should apply CMSD maximum suggested bitrate in ABR logic.</p></td></tr><tr><td class="name"><code>etpWeightRatio</code></td><td class="type"><span class="param-type">number</span></td><td class="attributes"><optional><br></td><td class="default">0</td><td cla