mirror of
https://github.com/hiloteam/Hilo.git
synced 2026-01-18 16:04:19 +00:00
474 lines
14 KiB
HTML
474 lines
14 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="generator" content="JsDoc Toolkit"/>
|
|
|
|
<title>WebSound - Hilo API Document</title>
|
|
<style>
|
|
iframe{
|
|
border:1px solid #333;
|
|
}
|
|
</style>
|
|
<link href="../../bootstrap3.0.3/css/bootstrap.min.css" rel="stylesheet">
|
|
<link href="../../bootstrap3.0.3/css/bootstrap-theme.min.css" rel="stylesheet">
|
|
<link href="../../css/prettify.min.css" rel="stylesheet">
|
|
<link href="../../css/api.min.css" rel="stylesheet">
|
|
</head>
|
|
|
|
<body>
|
|
<div class="navbar navbar-default navbar-fixed-top">
|
|
<div class="container">
|
|
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
<a class="navbar-brand" href="#">
|
|
<span>Hilo</span><span></span>
|
|
</a>
|
|
</div>
|
|
|
|
<div class="navbar-collapse collapse">
|
|
<ul class="nav navbar-nav">
|
|
<li><a href="//hiloteam.github.io/index.html">首页</a></li>
|
|
<li><a href="//github.com/hiloteam/Hilo" target="_blank">源码下载</a></li>
|
|
<li class="active"><a href="../index.html">API文档</a></li>
|
|
<li><a href="//hiloteam.github.io/tutorial/index.html">教程文档</a></li>
|
|
<li><a href="//hiloteam.github.io/examples/index.html">作品演示</a></li>
|
|
</u>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="container main">
|
|
<div class="col-md-3">
|
|
|
|
|
|
<div class="bs-sidebar well">
|
|
<!-- <div class="hilo-header">类列表</div> -->
|
|
<ul class="nav bs-sidenav">
|
|
|
|
|
|
<li class="nav-pkg">core<span></span></li>
|
|
<li class="nav-class"><a href="../symbols/Class.html">Class</a></li>
|
|
|
|
|
|
|
|
<li class="nav-class"><a href="../symbols/Hilo.html">Hilo</a></li>
|
|
|
|
|
|
<li class="nav-pkg">event<span></span></li>
|
|
<li class="nav-class"><a href="../symbols/EventMixin.html">EventMixin</a></li>
|
|
|
|
|
|
<li class="nav-pkg">game<span></span></li>
|
|
<li class="nav-class"><a href="../symbols/Camera.html">Camera</a></li>
|
|
|
|
|
|
|
|
<li class="nav-class"><a href="../symbols/Camera3d.html">Camera3d</a></li>
|
|
|
|
|
|
|
|
<li class="nav-class"><a href="../symbols/ParticleSystem.html">ParticleSystem</a></li>
|
|
|
|
|
|
<li class="nav-pkg">geom<span></span></li>
|
|
<li class="nav-class"><a href="../symbols/Matrix.html">Matrix</a></li>
|
|
|
|
|
|
<li class="nav-pkg">loader<span></span></li>
|
|
<li class="nav-class"><a href="../symbols/LoadQueue.html">LoadQueue</a></li>
|
|
|
|
|
|
<li class="nav-pkg">media<span></span></li>
|
|
<li class="nav-class"><a href="../symbols/HTMLAudio.html">HTMLAudio</a></li>
|
|
|
|
|
|
|
|
<li class="nav-class"><a href="../symbols/WebAudio.html">WebAudio</a></li>
|
|
|
|
|
|
|
|
<li class="nav-class"><a href="../symbols/WebSound.html">WebSound</a></li>
|
|
|
|
|
|
<li class="nav-pkg">renderer<span></span></li>
|
|
<li class="nav-class"><a href="../symbols/CanvasRenderer.html">CanvasRenderer</a></li>
|
|
|
|
|
|
|
|
<li class="nav-class"><a href="../symbols/DOMRenderer.html">DOMRenderer</a></li>
|
|
|
|
|
|
|
|
<li class="nav-class"><a href="../symbols/Renderer.html">Renderer</a></li>
|
|
|
|
|
|
|
|
<li class="nav-class"><a href="../symbols/WebGLRenderer.html">WebGLRenderer</a></li>
|
|
|
|
|
|
<li class="nav-pkg">tween<span></span></li>
|
|
<li class="nav-class"><a href="../symbols/Ease.html">Ease</a></li>
|
|
|
|
|
|
|
|
<li class="nav-class"><a href="../symbols/Tween.html">Tween</a></li>
|
|
|
|
|
|
<li class="nav-pkg">util<span></span></li>
|
|
<li class="nav-class"><a href="../symbols/TextureAtlas.html">TextureAtlas</a></li>
|
|
|
|
|
|
|
|
<li class="nav-class"><a href="../symbols/Ticker.html">Ticker</a></li>
|
|
|
|
|
|
|
|
<li class="nav-class"><a href="../symbols/browser.html">browser</a></li>
|
|
|
|
|
|
|
|
<li class="nav-class"><a href="../symbols/drag.html">drag</a></li>
|
|
|
|
|
|
|
|
<li class="nav-class"><a href="../symbols/util.html">util</a></li>
|
|
|
|
|
|
<li class="nav-pkg">view<span></span></li>
|
|
<li class="nav-class"><a href="../symbols/Bitmap.html">Bitmap</a></li>
|
|
|
|
|
|
|
|
<li class="nav-class"><a href="../symbols/BitmapText.html">BitmapText</a></li>
|
|
|
|
|
|
|
|
<li class="nav-class"><a href="../symbols/Button.html">Button</a></li>
|
|
|
|
|
|
|
|
<li class="nav-class"><a href="../symbols/CacheMixin.html">CacheMixin</a></li>
|
|
|
|
|
|
|
|
<li class="nav-class"><a href="../symbols/Container.html">Container</a></li>
|
|
|
|
|
|
|
|
<li class="nav-class"><a href="../symbols/DOMElement.html">DOMElement</a></li>
|
|
|
|
|
|
|
|
<li class="nav-class"><a href="../symbols/Drawable.html">Drawable</a></li>
|
|
|
|
|
|
|
|
<li class="nav-class"><a href="../symbols/Graphics.html">Graphics</a></li>
|
|
|
|
|
|
|
|
<li class="nav-class"><a href="../symbols/Sprite.html">Sprite</a></li>
|
|
|
|
|
|
|
|
<li class="nav-class"><a href="../symbols/Stage.html">Stage</a></li>
|
|
|
|
|
|
|
|
<li class="nav-class"><a href="../symbols/Text.html">Text</a></li>
|
|
|
|
|
|
|
|
<li class="nav-class"><a href="../symbols/View.html">View</a></li>
|
|
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="col-md-9">
|
|
<!-- ============================== class title ============================ -->
|
|
<h1 style="margin-top:0;">
|
|
|
|
WebSound
|
|
</h1><hr style="margin-top:10px;" />
|
|
|
|
<!-- ============================== class summary ========================== -->
|
|
<p class="description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span style="display:block;margin:0 0 2px 0;">
|
|
<b style="margin-right:10px;">Module</b> hilo/media/WebSound
|
|
</span>
|
|
|
|
|
|
|
|
<span style="display:block;margin:0 0 2px 0;">
|
|
<b style="margin-right:10px;">Requires</b>
|
|
<span><a href="../symbols/HTMLAudio.html">hilo/media/HTMLAudio</a></span>, <span><a href="../symbols/WebAudio.html">hilo/media/WebAudio</a></span>, <span><a href="../symbols/util.html">hilo/util/util</a></span>
|
|
</span>
|
|
|
|
|
|
<span style="display:block;margin:0 0 2px 0;">
|
|
<b style="margin-right:10px;">Source</b>
|
|
<a href="../symbols/src/docs_api-en_code_media_WebSound.js.html">WebSound.js</a>
|
|
</span>
|
|
|
|
<br>
|
|
Audio playing manager.
|
|
|
|
<br><br><iframe src='../../../examples/WebSound.html?noHeader' width = '320' height = '310' scrolling='no'></iframe>
|
|
<br/>
|
|
demo:
|
|
<pre>
|
|
var audio = WebSound.getAudio({
|
|
src: 'test.mp3',
|
|
loop: false,
|
|
volume: 1
|
|
}).on('load', function(e){
|
|
console.log('load');
|
|
}).on('end', function(e){
|
|
console.log('end');
|
|
}).play();
|
|
</pre>
|
|
|
|
|
|
</p>
|
|
|
|
<!-- ============================== properties summary ===================== -->
|
|
|
|
|
|
<!-- ============================== methods summary ======================== -->
|
|
|
|
|
|
|
|
<div style="margin:30px 0 5px; 0">
|
|
<h3 style="display:inline;margin-right:10px;">Methods</h3>
|
|
|
|
</div>
|
|
<table class="table table-striped table-bordered table-condensed table-symbol" cellspacing="0">
|
|
<thead>
|
|
<tr>
|
|
<th scope="col"></th>
|
|
<th scope="col">Method</th>
|
|
<th scope="col">Defined</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
|
|
|
|
|
|
<tr >
|
|
<td>
|
|
|
|
</td>
|
|
<td class="fixedFont">
|
|
<div><b><a href="../symbols/WebSound.html#.enableAudio">enableAudio</a></b>()
|
|
</div>
|
|
<div class="description">
|
|
<span class="label">static</span>
|
|
Activate audio function.
|
|
</div>
|
|
</td>
|
|
<td>
|
|
WebSound
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
<tr >
|
|
<td>
|
|
|
|
</td>
|
|
<td class="fixedFont">
|
|
<div><b><a href="../symbols/WebSound.html#.getAudio">getAudio</a></b>(source:String|Object, preferWebAudio:Boolean):WebAudio|HTMLAudio
|
|
</div>
|
|
<div class="description">
|
|
<span class="label">static</span>
|
|
Get audio element.
|
|
</div>
|
|
</td>
|
|
<td>
|
|
WebSound
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
<tr >
|
|
<td>
|
|
|
|
</td>
|
|
<td class="fixedFont">
|
|
<div><b><a href="../symbols/WebSound.html#.removeAudio">removeAudio</a></b>(source:String|Object)
|
|
</div>
|
|
<div class="description">
|
|
<span class="label">static</span>
|
|
Remove audio element.
|
|
</div>
|
|
</td>
|
|
<td>
|
|
WebSound
|
|
</td>
|
|
</tr>
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<script type="text/javascript">
|
|
function toggleMethods(){
|
|
var alink = $('#methodToggleIcon');
|
|
if(alink.hasClass('glyphicon-circle-arrow-right')){
|
|
alink.removeClass('glyphicon-circle-arrow-right');
|
|
alink.addClass('glyphicon-circle-arrow-down');
|
|
$('#methodToggleTip').html('Hide Inherited Methods');
|
|
$('.inheritMethod').show();
|
|
}else{
|
|
alink.removeClass('glyphicon-circle-arrow-down');
|
|
alink.addClass('glyphicon-circle-arrow-right');
|
|
$('#methodToggleTip').html('Show Inherited Methods');
|
|
$('.inheritMethod').hide();
|
|
}
|
|
}
|
|
</script>
|
|
|
|
|
|
<!-- ============================== field details ========================== -->
|
|
|
|
|
|
<!-- ============================== constructor details ==================== -->
|
|
|
|
|
|
<!-- ============================== method details ========================= -->
|
|
|
|
<br/>
|
|
<div class=""><h3 style="margin-bottom:15px;">Method Detail</h3></div>
|
|
|
|
<a class="anchor" name=".enableAudio"> </a>
|
|
<div class="member-box">
|
|
<div class="member-header">
|
|
[Static]
|
|
<b>enableAudio</b>()
|
|
</div>
|
|
<div class="description">Activate audio function. Note: Require user action events to activate. Currently support WebAudio.</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<a class="anchor" name=".getAudio"> </a>
|
|
<div class="member-box">
|
|
<div class="member-header">
|
|
[Static]
|
|
<b>getAudio</b>(source:String|Object, preferWebAudio:Boolean):<span class="light"><a href="../symbols/WebAudio.html">WebAudio</a>|<a href="../symbols/HTMLAudio.html">HTMLAudio</a></span>
|
|
</div>
|
|
<div class="description">Get audio element. Default use WebAudio if supported.</div>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading"><span class="label">parameters</span></dt>
|
|
|
|
<dt style="margin-left:20px;font-weight:normal;">
|
|
<b>source</b>:<span>String|Object</span>
|
|
— If String, it's the source of the audio; If Object, it should contains a src property.
|
|
</dt>
|
|
|
|
<dt style="margin-left:20px;font-weight:normal;">
|
|
<b>preferWebAudio</b>:<span>Boolean</span>
|
|
<i>Optional, Default: true</i> — Whether or not to use WebAudio first, default is true.
|
|
</dt>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading"><span class="label">return</span></dt>
|
|
|
|
<dd style="margin-left:20px;font-weight:normal;"><span><a href="../symbols/WebAudio.html">WebAudio</a>|<a href="../symbols/HTMLAudio.html">HTMLAudio</a></span> — Audio playing instance.</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<a class="anchor" name=".removeAudio"> </a>
|
|
<div class="member-box">
|
|
<div class="member-header">
|
|
[Static]
|
|
<b>removeAudio</b>(source:String|Object)
|
|
</div>
|
|
<div class="description">Remove audio element.</div>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading"><span class="label">parameters</span></dt>
|
|
|
|
<dt style="margin-left:20px;font-weight:normal;">
|
|
<b>source</b>:<span>String|Object</span>
|
|
— If String, it's the source of the audio; If Object, it should contains a src property.
|
|
</dt>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<footer class="col-md-12">
|
|
<hr>
|
|
<p>© Hilo 2016</p>
|
|
</footer>
|
|
|
|
<script src="../../js/jquery.min.js"></script>
|
|
<script src="../../bootstrap3.0.3/js/bootstrap.min.js"></script>
|
|
<script src="../../js/prettify.min.js"></script>
|
|
<script type="text/javascript">
|
|
//make code pretty
|
|
$('pre').addClass('prettyprint linenums fixedFont');
|
|
window.prettyPrint && prettyPrint();
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|