jsdk-offical

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>media | JSDK 2.7.0 API</title> <meta name="description" content="Documentation for JSDK 2.7.0 API"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">JSDK 2.7.0 API</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../globals.html">Globals</a> </li> <li> <a href="js.html">JS</a> </li> <li> <a href="js.media.html">media</a> </li> </ul> <h1>Namespace media</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Classes</h3> <ul class="tsd-index-list"> <li class="tsd-kind-class tsd-parent-kind-namespace"><a href="../classes/js.media.audiocache.html" class="tsd-kind-icon">Audio<wbr>Cache</a></li> <li class="tsd-kind-class tsd-parent-kind-namespace"><a href="../classes/js.media.audiopro.html" class="tsd-kind-icon">Audio<wbr>Pro</a></li> <li class="tsd-kind-class tsd-parent-kind-namespace"><a href="../classes/js.media.videoplayer.html" class="tsd-kind-icon">Video<wbr>Player</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Interfaces</h3> <ul class="tsd-index-list"> <li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/js.media.audiocacheinit.html" class="tsd-kind-icon">Audio<wbr>Cache<wbr>Init</a></li> <li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/js.media.audioproinit.html" class="tsd-kind-icon">Audio<wbr>Pro<wbr>Init</a></li> <li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/js.media.remoteaudio.html" class="tsd-kind-icon">Remote<wbr>Audio</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Type aliases</h3> <ul class="tsd-index-list"> <li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="js.media.html#mediaevents" class="tsd-kind-icon">Media<wbr>Events</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="js.media.html#mediatypes" class="tsd-kind-icon">Media<wbr>Types</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="js.media.html#videoplayerinit" class="tsd-kind-icon">Video<wbr>Player<wbr>Init</a></li> </ul> </section> <section class="tsd-index-section tsd-is-not-exported"> <h3>Variables</h3> <ul class="tsd-index-list"> <li class="tsd-kind-variable tsd-parent-kind-namespace tsd-is-not-exported"><a href="js.media.html#a" class="tsd-kind-icon">A</a></li> <li class="tsd-kind-variable tsd-parent-kind-namespace tsd-is-not-exported"><a href="js.media.html#ac" class="tsd-kind-icon">AC</a></li> <li class="tsd-kind-variable tsd-parent-kind-namespace tsd-is-not-exported"><a href="js.media.html#w" class="tsd-kind-icon">W</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Type aliases</h2> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace"> <a name="mediaevents" class="tsd-anchor"></a> <h3>Media<wbr>Events</h3> <div class="tsd-signature tsd-kind-icon">Media<wbr>Events<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"abort"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"canplay"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"canplaythrough"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"durationchange"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"emptied"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ended"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"error"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"loadeddata"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"loadedmetadata"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"loadstart"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"pause"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"play"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"playing"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"progress"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ratechange"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"readystatechange"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"seeking"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"seeked"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"stalled"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"suspend"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"timeupdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"volumechange"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"waiting"</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace"> <a name="mediatypes" class="tsd-anchor"></a> <h3>Media<wbr>Types</h3> <div class="tsd-signature tsd-kind-icon">Media<wbr>Types<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"video/ogg"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"video/mp4"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"video/webm"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"audio/ogg"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"audio/mpeg"</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace"> <a name="videoplayerinit" class="tsd-anchor"></a> <h3>Video<wbr>Player<wbr>Init</h3> <div class="tsd-signature tsd-kind-icon">Video<wbr>Player<wbr>Init<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>appendTo<span class="tsd-signature-symbol">?: </span><a href="../interfaces/htmlelement.html" class="tsd-signature-type">HTMLElement</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>controls<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>height<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>loop<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>muted<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>on<span class="tsd-signature-symbol">?: </span><a href="js.lang.html#jsonobject" class="tsd-signature-type">JsonObject</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLMediaElement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>poster<span class="tsd-signature-symbol">?: </span><a href="js.net.html#urlstring" class="tsd-signature-type">URLString</a><span class="tsd-signature-symbol">; </span>preload<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"auto"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"meta"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"none"</span><span class="tsd-signature-symbol">; </span>src<span class="tsd-signature-symbol">?: </span><a href="js.net.html#urlstring" class="tsd-signature-type">URLString</a><span class="tsd-signature-symbol">; </span>width<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> append<wbr>To<span class="tsd-signature-symbol">?: </span><a href="../interfaces/htmlelement.html" class="tsd-signature-type">HTMLElement</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> controls<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> height<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> loop<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> muted<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> on<span class="tsd-signature-symbol">?: </span><a href="js.lang.html#jsonobject" class="tsd-signature-type">JsonObject</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLMediaElement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> poster<span class="tsd-signature-symbol">?: </span><a href="js.net.html#urlstring" class="tsd-signature-type">URLString</a></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> preload<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"auto"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"meta"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"none"</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> src<span class="tsd-signature-symbol">?: </span><a href="js.net.html#urlstring" class="tsd-signature-type">URLString</a></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> width<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5> </li> </ul> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-not-exported"> <h2>Variables</h2> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace tsd-is-not-exported"> <a name="a" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagLet">Let</span> A</h3> <div class="tsd-signature tsd-kind-icon">A<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = W.AudioContext || W['msAudioContext']</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace tsd-is-not-exported"> <a name="ac" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagLet">Let</span> AC</h3> <div class="tsd-signature tsd-kind-icon">AC<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AudioContext</span><span class="tsd-signature-symbol"> = new A()</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace tsd-is-not-exported"> <a name="w" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagLet">Let</span> W</h3> <div class="tsd-signature tsd-kind-icon">W<span class="tsd-signature-symbol">:</span> <a href="../interfaces/window.html" class="tsd-signature-type">Window</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">globalThis</span><span class="tsd-signature-symbol"> = window</span></div> <aside class="tsd-sources"> </aside> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> <li class="current tsd-kind-namespace"> <a href="js.html">JS</a> <ul> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="js.an.html">an</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="js.app.html">app</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="js.core.html">core</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="js.d2.html">d2</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="js.ds.html">ds</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="js.fx.html">fx</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="js.input.html">input</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="js.ioc.html">ioc</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="js.lang.html">lang</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="js.math.html">math</a> </li> <li class="current tsd-kind-namespace tsd-parent-kind-namespace"> <a href="js.media.html">media</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="js.model.html">model</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="js.net.html">net</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="js.store.html">store</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="js.sugar.html">sugar</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="js.ui.html">ui</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="js.unit.html">unit</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="js.util.html">util</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="js.view.html">view</a> </li> </ul> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-class tsd-parent-kind-namespace"> <a href="../classes/js.media.audiocache.html" class="tsd-kind-icon">Audio<wbr>Cache</a> </li> <li class=" tsd-kind-class tsd-parent-kind-namespace"> <a href="../classes/js.media.audiopro.html" class="tsd-kind-icon">Audio<wbr>Pro</a> </li> <li class=" tsd-kind-class tsd-parent-kind-namespace"> <a href="../classes/js.media.videoplayer.html" class="tsd-kind-icon">Video<wbr>Player</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-namespace"> <a href="../interfaces/js.media.audiocacheinit.html" class="tsd-kind-icon">Audio<wbr>Cache<wbr>Init</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-namespace"> <a href="../interfaces/js.media.audioproinit.html" class="tsd-kind-icon">Audio<wbr>Pro<wbr>Init</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-namespace"> <a href="../interfaces/js.media.remoteaudio.html" class="tsd-kind-icon">Remote<wbr>Audio</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-namespace"> <a href="js.media.html#mediaevents" class="tsd-kind-icon">Media<wbr>Events</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-namespace"> <a href="js.media.html#mediatypes" class="tsd-kind-icon">Media<wbr>Types</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-namespace"> <a href="js.media.html#videoplayerinit" class="tsd-kind-icon">Video<wbr>Player<wbr>Init</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-namespace tsd-is-not-exported"> <a href="js.media.html#a" class="tsd-kind-icon">A</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-namespace tsd-is-not-exported"> <a href="js.media.html#ac" class="tsd-kind-icon">AC</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-namespace tsd-is-not-exported"> <a href="js.media.html#w" class="tsd-kind-icon">W</a> </li> </ul> </nav> </div> </div> </div> <footer> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> </ul> </div> </div> </footer> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>