mirror of
https://github.com/hiloteam/Hilo.git
synced 2026-01-18 16:04:19 +00:00
1159 lines
31 KiB
HTML
1159 lines
31 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>WebAudio - 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;">
|
||
|
||
WebAudio
|
||
</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/WebAudio
|
||
</span>
|
||
|
||
|
||
|
||
<span style="display:block;margin:0 0 2px 0;">
|
||
<b style="margin-right:10px;">Requires</b>
|
||
<span><a href="../symbols/Class.html">hilo/core/Class</a></span>, <span><a href="../symbols/util.html">hilo/util/util</a></span>, <span><a href="../symbols/EventMixin.html">hilo/event/EventMixin</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_WebAudio.js.html">WebAudio.js</a>
|
||
</span>
|
||
|
||
<br>
|
||
WebAudio audio playing module. It provides a better way to play and control audio, use on iOS6+ platform.
|
||
Compatibility：iOS6+、Chrome33+、Firefox28+ supported，but all Android browsers do not support.
|
||
|
||
|
||
</p>
|
||
|
||
<!-- ============================== properties summary ===================== -->
|
||
|
||
|
||
|
||
<div style="margin:30px 0 5px 0;">
|
||
<h3 style="display:inline;margin-right:10px;">Properties</h3>
|
||
|
||
</div>
|
||
<table class="table table-striped table-bordered table-condensed table-symbol" cellspacing="0">
|
||
<thead>
|
||
<tr>
|
||
<th scope="col"></th>
|
||
<th scope="col">Property </th>
|
||
<th scope="col">Defined</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
|
||
|
||
<tr >
|
||
<td>
|
||
|
||
</td>
|
||
<td class="fixedFont">
|
||
<div>
|
||
<!-- -->
|
||
<b><a href="../symbols/WebAudio.html#autoPlay">autoPlay</a></b>:Boolean
|
||
</div>
|
||
<div class="description">
|
||
|
||
Is the audio autoplay, default value is false.
|
||
</div>
|
||
</td>
|
||
<td>
|
||
WebAudio
|
||
</td>
|
||
</tr>
|
||
|
||
|
||
<tr >
|
||
<td>
|
||
|
||
</td>
|
||
<td class="fixedFont">
|
||
<div>
|
||
<!-- -->
|
||
<b><a href="../symbols/WebAudio.html#duration">duration</a></b>:Number
|
||
</div>
|
||
<div class="description">
|
||
|
||
The duration of the audio, readonly!
|
||
</div>
|
||
</td>
|
||
<td>
|
||
WebAudio
|
||
</td>
|
||
</tr>
|
||
|
||
|
||
<tr >
|
||
<td>
|
||
|
||
</td>
|
||
<td class="fixedFont">
|
||
<div>
|
||
<!-- -->
|
||
<b><a href="../symbols/WebAudio.html#loaded">loaded</a></b>:Boolean
|
||
</div>
|
||
<div class="description">
|
||
|
||
Is the audio resource loaded, readonly!
|
||
</div>
|
||
</td>
|
||
<td>
|
||
WebAudio
|
||
</td>
|
||
</tr>
|
||
|
||
|
||
<tr >
|
||
<td>
|
||
|
||
</td>
|
||
<td class="fixedFont">
|
||
<div>
|
||
<!-- -->
|
||
<b><a href="../symbols/WebAudio.html#loop">loop</a></b>:Boolean
|
||
</div>
|
||
<div class="description">
|
||
|
||
Is loop playback, default value is false.
|
||
</div>
|
||
</td>
|
||
<td>
|
||
WebAudio
|
||
</td>
|
||
</tr>
|
||
|
||
|
||
<tr >
|
||
<td>
|
||
|
||
</td>
|
||
<td class="fixedFont">
|
||
<div>
|
||
<!-- -->
|
||
<b><a href="../symbols/WebAudio.html#muted">muted</a></b>:Boolean
|
||
</div>
|
||
<div class="description">
|
||
|
||
Is the audio muted, default value is false.
|
||
</div>
|
||
</td>
|
||
<td>
|
||
WebAudio
|
||
</td>
|
||
</tr>
|
||
|
||
|
||
<tr >
|
||
<td>
|
||
|
||
</td>
|
||
<td class="fixedFont">
|
||
<div>
|
||
<!-- -->
|
||
<b><a href="../symbols/WebAudio.html#playing">playing</a></b>:Boolean
|
||
</div>
|
||
<div class="description">
|
||
|
||
Is the audio playing, readonly!
|
||
</div>
|
||
</td>
|
||
<td>
|
||
WebAudio
|
||
</td>
|
||
</tr>
|
||
|
||
|
||
<tr >
|
||
<td>
|
||
|
||
</td>
|
||
<td class="fixedFont">
|
||
<div>
|
||
<!-- -->
|
||
<b><a href="../symbols/WebAudio.html#src">src</a></b>:String
|
||
</div>
|
||
<div class="description">
|
||
|
||
The source of the playing audio.
|
||
</div>
|
||
</td>
|
||
<td>
|
||
WebAudio
|
||
</td>
|
||
</tr>
|
||
|
||
|
||
<tr >
|
||
<td>
|
||
|
||
</td>
|
||
<td class="fixedFont">
|
||
<div>
|
||
<!-- -->
|
||
<b><a href="../symbols/WebAudio.html#volume">volume</a></b>:Number
|
||
</div>
|
||
<div class="description">
|
||
|
||
The volume of the audio, value between 0 to 1.
|
||
</div>
|
||
</td>
|
||
<td>
|
||
WebAudio
|
||
</td>
|
||
</tr>
|
||
|
||
|
||
<tr >
|
||
<td>
|
||
|
||
</td>
|
||
<td class="fixedFont">
|
||
<div>
|
||
<!--
|
||
WebAudio.
|
||
-->
|
||
<b><a href="../symbols/WebAudio.html#.isSupported">isSupported</a></b>
|
||
</div>
|
||
<div class="description">
|
||
<span class="label">static</span>
|
||
Does the browser support WebAudio.
|
||
</div>
|
||
</td>
|
||
<td>
|
||
WebAudio
|
||
</td>
|
||
</tr>
|
||
|
||
|
||
<tr >
|
||
<td>
|
||
|
||
</td>
|
||
<td class="fixedFont">
|
||
<div>
|
||
<!--
|
||
WebAudio.
|
||
-->
|
||
<b><a href="../symbols/WebAudio.html#.enabled">enabled</a></b>
|
||
</div>
|
||
<div class="description">
|
||
<span class="label">static</span>
|
||
Does browser activate WebAudio already.
|
||
</div>
|
||
</td>
|
||
<td>
|
||
WebAudio
|
||
</td>
|
||
</tr>
|
||
|
||
</tbody>
|
||
</table>
|
||
|
||
|
||
<script type="text/javascript">
|
||
function toggleProperties(){
|
||
var alink = $('#propToggleIcon');
|
||
if(alink.hasClass('glyphicon-circle-arrow-right')){
|
||
alink.removeClass('glyphicon-circle-arrow-right');
|
||
alink.addClass('glyphicon-circle-arrow-down');
|
||
$('#propToggleTip').html('Hide Inherited Properties');
|
||
$('.inheritProp').show();
|
||
}else{
|
||
alink.removeClass('glyphicon-circle-arrow-down');
|
||
alink.addClass('glyphicon-circle-arrow-right');
|
||
$('#propToggleTip').html('Show Inherited Properties');
|
||
$('.inheritProp').hide();
|
||
}
|
||
}
|
||
</script>
|
||
|
||
|
||
<!-- ============================== 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>
|
||
<div class="fixedFont">
|
||
<b><a href="#constructor">WebAudio</a></b>(properties:Object)
|
||
</div>
|
||
<div class="description">Constructor</div>
|
||
</td>
|
||
<td>WebAudio</td>
|
||
</tr>
|
||
|
||
|
||
|
||
|
||
<tr >
|
||
<td>
|
||
|
||
</td>
|
||
<td class="fixedFont">
|
||
<div><b><a href="../symbols/WebAudio.html#load">load</a></b>()
|
||
</div>
|
||
<div class="description">
|
||
|
||
Load audio file.
|
||
</div>
|
||
</td>
|
||
<td>
|
||
WebAudio
|
||
</td>
|
||
</tr>
|
||
|
||
|
||
<tr >
|
||
<td>
|
||
|
||
</td>
|
||
<td class="fixedFont">
|
||
<div><b><a href="../symbols/WebAudio.html#pause">pause</a></b>()
|
||
</div>
|
||
<div class="description">
|
||
|
||
Pause (halt) playing the audio.
|
||
</div>
|
||
</td>
|
||
<td>
|
||
WebAudio
|
||
</td>
|
||
</tr>
|
||
|
||
|
||
<tr >
|
||
<td>
|
||
|
||
</td>
|
||
<td class="fixedFont">
|
||
<div><b><a href="../symbols/WebAudio.html#play">play</a></b>()
|
||
</div>
|
||
<div class="description">
|
||
|
||
Play the audio.
|
||
</div>
|
||
</td>
|
||
<td>
|
||
WebAudio
|
||
</td>
|
||
</tr>
|
||
|
||
|
||
<tr >
|
||
<td>
|
||
|
||
</td>
|
||
<td class="fixedFont">
|
||
<div><b><a href="../symbols/WebAudio.html#resume">resume</a></b>()
|
||
</div>
|
||
<div class="description">
|
||
|
||
Continue to play the audio.
|
||
</div>
|
||
</td>
|
||
<td>
|
||
WebAudio
|
||
</td>
|
||
</tr>
|
||
|
||
|
||
<tr >
|
||
<td>
|
||
|
||
</td>
|
||
<td class="fixedFont">
|
||
<div><b><a href="../symbols/WebAudio.html#setMute">setMute</a></b>(muted)
|
||
</div>
|
||
<div class="description">
|
||
|
||
Set mute mode.
|
||
</div>
|
||
</td>
|
||
<td>
|
||
WebAudio
|
||
</td>
|
||
</tr>
|
||
|
||
|
||
<tr >
|
||
<td>
|
||
|
||
</td>
|
||
<td class="fixedFont">
|
||
<div><b><a href="../symbols/WebAudio.html#setVolume">setVolume</a></b>(volume)
|
||
</div>
|
||
<div class="description">
|
||
|
||
Set the volume.
|
||
</div>
|
||
</td>
|
||
<td>
|
||
WebAudio
|
||
</td>
|
||
</tr>
|
||
|
||
|
||
<tr >
|
||
<td>
|
||
|
||
</td>
|
||
<td class="fixedFont">
|
||
<div><b><a href="../symbols/WebAudio.html#stop">stop</a></b>()
|
||
</div>
|
||
<div class="description">
|
||
|
||
Stop playing the audio.
|
||
</div>
|
||
</td>
|
||
<td>
|
||
WebAudio
|
||
</td>
|
||
</tr>
|
||
|
||
|
||
<tr >
|
||
<td>
|
||
|
||
</td>
|
||
<td class="fixedFont">
|
||
<div><b><a href="../symbols/WebAudio.html#.enable">enable</a></b>()
|
||
</div>
|
||
<div class="description">
|
||
<span class="label">static</span>
|
||
Activate WebAudio.
|
||
</div>
|
||
</td>
|
||
<td>
|
||
WebAudio
|
||
</td>
|
||
</tr>
|
||
|
||
|
||
<tr >
|
||
<td>
|
||
|
||
</td>
|
||
<td class="fixedFont">
|
||
<div><b><a href="../symbols/WebAudio.html#.clearBufferCache">clearBufferCache</a></b>(url:String)
|
||
</div>
|
||
<div class="description">
|
||
<span class="label">static</span>
|
||
Clear the audio buffer cache.
|
||
</div>
|
||
</td>
|
||
<td>
|
||
WebAudio
|
||
</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 ========================== -->
|
||
|
||
<br/>
|
||
<div class="">
|
||
<h3 style="margin-bottom:15px;">Property Detail</h3>
|
||
</div>
|
||
|
||
<a class="anchor" name="autoPlay"> </a>
|
||
<div class="member-box">
|
||
<div class="member-header">
|
||
<b>autoPlay</b><span class="light">:Boolean</span>
|
||
|
||
</div>
|
||
<div class="description">
|
||
Is the audio autoplay, default value is false.
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
<a class="anchor" name="duration"> </a>
|
||
<div class="member-box">
|
||
<div class="member-header">
|
||
<b>duration</b><span class="light">:Number</span>
|
||
|
||
</div>
|
||
<div class="description">
|
||
The duration of the audio, readonly!
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
<a class="anchor" name=".enabled"> </a>
|
||
<div class="member-box">
|
||
<div class="member-header">[Static]
|
||
<b>enabled</b>
|
||
|
||
</div>
|
||
<div class="description">
|
||
Does browser activate WebAudio already.
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
<a class="anchor" name=".isSupported"> </a>
|
||
<div class="member-box">
|
||
<div class="member-header">[Static]
|
||
<b>isSupported</b>
|
||
|
||
</div>
|
||
<div class="description">
|
||
Does the browser support WebAudio.
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
<a class="anchor" name="loaded"> </a>
|
||
<div class="member-box">
|
||
<div class="member-header">
|
||
<b>loaded</b><span class="light">:Boolean</span>
|
||
|
||
</div>
|
||
<div class="description">
|
||
Is the audio resource loaded, readonly!
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
<a class="anchor" name="loop"> </a>
|
||
<div class="member-box">
|
||
<div class="member-header">
|
||
<b>loop</b><span class="light">:Boolean</span>
|
||
|
||
</div>
|
||
<div class="description">
|
||
Is loop playback, default value is false.
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
<a class="anchor" name="muted"> </a>
|
||
<div class="member-box">
|
||
<div class="member-header">
|
||
<b>muted</b><span class="light">:Boolean</span>
|
||
|
||
</div>
|
||
<div class="description">
|
||
Is the audio muted, default value is false.
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
<a class="anchor" name="playing"> </a>
|
||
<div class="member-box">
|
||
<div class="member-header">
|
||
<b>playing</b><span class="light">:Boolean</span>
|
||
|
||
</div>
|
||
<div class="description">
|
||
Is the audio playing, readonly!
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
<a class="anchor" name="src"> </a>
|
||
<div class="member-box">
|
||
<div class="member-header">
|
||
<b>src</b><span class="light">:String</span>
|
||
|
||
</div>
|
||
<div class="description">
|
||
The source of the playing audio.
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
<a class="anchor" name="volume"> </a>
|
||
<div class="member-box">
|
||
<div class="member-header">
|
||
<b>volume</b><span class="light">:Number</span>
|
||
|
||
</div>
|
||
<div class="description">
|
||
The volume of the audio, value between 0 to 1.
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<!-- ============================== constructor details ==================== -->
|
||
|
||
<br/>
|
||
<div class="details">
|
||
<a class="anchor" name="constructor"> </a>
|
||
<div class="">
|
||
<h3 style="margin-bottom:15px;">Constructor</h3>
|
||
</div>
|
||
<div class="member-box">
|
||
<div class="member-header">
|
||
<b>WebAudio</b>(properties:Object)
|
||
</div>
|
||
|
||
|
||
<dl class="detailList">
|
||
<dt class="heading"><span class="label">parameters</span></dt>
|
||
|
||
<dt style="margin-left:20px;font-weight:normal;">
|
||
<b>properties</b>:<span>Object</span>
|
||
— create object properties, include all writable properties of this class.
|
||
</dt>
|
||
|
||
</dl>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<!-- ============================== method details ========================= -->
|
||
|
||
<br/>
|
||
<div class=""><h3 style="margin-bottom:15px;">Method Detail</h3></div>
|
||
|
||
<a class="anchor" name=".clearBufferCache"> </a>
|
||
<div class="member-box">
|
||
<div class="member-header">
|
||
[Static]
|
||
<b>clearBufferCache</b>(url:String)
|
||
</div>
|
||
<div class="description">Clear the audio buffer cache.</div>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList">
|
||
<dt class="heading"><span class="label">parameters</span></dt>
|
||
|
||
<dt style="margin-left:20px;font-weight:normal;">
|
||
<b>url</b>:<span>String</span>
|
||
— audio's url. if url is none, it will clear all buffer.
|
||
</dt>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
<a class="anchor" name=".enable"> </a>
|
||
<div class="member-box">
|
||
<div class="member-header">
|
||
[Static]
|
||
<b>enable</b>()
|
||
</div>
|
||
<div class="description">Activate WebAudio. Note: Require user action events to activate. Once activated, can play audio without user action events.</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
<a class="anchor" name="load"> </a>
|
||
<div class="member-box">
|
||
<div class="member-header">
|
||
|
||
<b>load</b>()
|
||
</div>
|
||
<div class="description">Load audio file. Note: use XMLHttpRequest to load the audio, should pay attention to cross-origin problem.</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
<a class="anchor" name="pause"> </a>
|
||
<div class="member-box">
|
||
<div class="member-header">
|
||
|
||
<b>pause</b>()
|
||
</div>
|
||
<div class="description">Pause (halt) playing the audio.</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
<a class="anchor" name="play"> </a>
|
||
<div class="member-box">
|
||
<div class="member-header">
|
||
|
||
<b>play</b>()
|
||
</div>
|
||
<div class="description">Play the audio. Restart playing the audio from the beginning if already playing.</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
<a class="anchor" name="resume"> </a>
|
||
<div class="member-box">
|
||
<div class="member-header">
|
||
|
||
<b>resume</b>()
|
||
</div>
|
||
<div class="description">Continue to play the audio.</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
<a class="anchor" name="setMute"> </a>
|
||
<div class="member-box">
|
||
<div class="member-header">
|
||
|
||
<b>setMute</b>(muted)
|
||
</div>
|
||
<div class="description">Set mute mode.</div>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList">
|
||
<dt class="heading"><span class="label">parameters</span></dt>
|
||
|
||
<dt style="margin-left:20px;font-weight:normal;">
|
||
<b>muted</b>
|
||
—
|
||
</dt>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
<a class="anchor" name="setVolume"> </a>
|
||
<div class="member-box">
|
||
<div class="member-header">
|
||
|
||
<b>setVolume</b>(volume)
|
||
</div>
|
||
<div class="description">Set the volume.</div>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList">
|
||
<dt class="heading"><span class="label">parameters</span></dt>
|
||
|
||
<dt style="margin-left:20px;font-weight:normal;">
|
||
<b>volume</b>
|
||
—
|
||
</dt>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
<a class="anchor" name="stop"> </a>
|
||
<div class="member-box">
|
||
<div class="member-header">
|
||
|
||
<b>stop</b>()
|
||
</div>
|
||
<div class="description">Stop playing the audio.</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</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>
|