jsdk-offical

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>AudioPro | 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="../modules/js.html">JS</a> </li> <li> <a href="../modules/js.media.html">media</a> </li> <li> <a href="js.media.audiopro.html">AudioPro</a> </li> </ul> <h1>Class AudioPro</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Audio Processor.</p> </div> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">AudioPro</span> </li> </ul> </section> <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>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="js.media.audiopro.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class"><a href="js.media.audiopro.html#_dispose" class="tsd-kind-icon">_dispose</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="js.media.audiopro.html#_play" class="tsd-kind-icon">_play</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="js.media.audiopro.html#loop" class="tsd-kind-icon">loop</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="js.media.audiopro.html#play" class="tsd-kind-icon">play</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="js.media.audiopro.html#stop" class="tsd-kind-icon">stop</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="js.media.audiopro.html#volume" class="tsd-kind-icon">volume</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="js.media.audiopro.html#play-1" class="tsd-kind-icon">play</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">new <wbr>Audio<wbr>Pro<span class="tsd-signature-symbol">(</span>init<span class="tsd-signature-symbol">?: </span><a href="../interfaces/js.media.audioproinit.html" class="tsd-signature-type">AudioProInit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="js.media.audiopro.html" class="tsd-signature-type">AudioPro</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> init: <a href="../interfaces/js.media.audioproinit.html" class="tsd-signature-type">AudioProInit</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="js.media.audiopro.html" class="tsd-signature-type">AudioPro</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="_dispose" class="tsd-anchor"></a> <h3>_dispose</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">_dispose<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="_play" class="tsd-anchor"></a> <h3>_play</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">_play<span class="tsd-signature-symbol">(</span>a<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AudioBuffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>a: <span class="tsd-signature-type">AudioBuffer</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="loop" class="tsd-anchor"></a> <h3>loop</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">loop<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> <li class="tsd-signature tsd-kind-icon">loop<span class="tsd-signature-symbol">(</span>is<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>is: <span class="tsd-signature-type">boolean</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="play" class="tsd-anchor"></a> <h3>play</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">play<span class="tsd-signature-symbol">(</span>a<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li> <li class="tsd-signature tsd-kind-icon">play<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, cache<span class="tsd-signature-symbol">: </span><a href="js.media.audiocache.html" class="tsd-signature-type">AudioCache</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>a: <span class="tsd-signature-type">ArrayBuffer</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> </li> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>id: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>cache: <a href="js.media.audiocache.html" class="tsd-signature-type">AudioCache</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="stop" class="tsd-anchor"></a> <h3>stop</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">stop<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="volume" class="tsd-anchor"></a> <h3>volume</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">volume<span class="tsd-signature-symbol">(</span>n<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Sets volume of current sound.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>n: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>0~1</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="play-1" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> play</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">play<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, cache<span class="tsd-signature-symbol">: </span><a href="js.media.audiocache.html" class="tsd-signature-type">AudioCache</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>id: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>cache: <a href="js.media.audiocache.html" class="tsd-signature-type">AudioCache</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </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="../modules/js.html">JS</a> <ul> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.an.html">an</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.app.html">app</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.core.html">core</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.d2.html">d2</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.ds.html">ds</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.fx.html">fx</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.input.html">input</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.ioc.html">ioc</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.lang.html">lang</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.math.html">math</a> </li> <li class="current tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.media.html">media</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.model.html">model</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.net.html">net</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.store.html">store</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.sugar.html">sugar</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.ui.html">ui</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.unit.html">unit</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.util.html">util</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/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="js.media.audiocache.html" class="tsd-kind-icon">Audio<wbr>Cache</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-parent-kind-namespace"> <a href="js.media.audiopro.html" class="tsd-kind-icon">Audio<wbr>Pro</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="js.media.audiopro.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="js.media.audiopro.html#_dispose" class="tsd-kind-icon">_dispose</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="js.media.audiopro.html#_play" class="tsd-kind-icon">_play</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="js.media.audiopro.html#loop" class="tsd-kind-icon">loop</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="js.media.audiopro.html#play" class="tsd-kind-icon">play</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="js.media.audiopro.html#stop" class="tsd-kind-icon">stop</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="js.media.audiopro.html#volume" class="tsd-kind-icon">volume</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a href="js.media.audiopro.html#play-1" class="tsd-kind-icon">play</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-class tsd-parent-kind-namespace"> <a href="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="../modules/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="../modules/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="../modules/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="../modules/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="../modules/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="../modules/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> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static 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>