2013-10-03 00:21:08 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > Phaser Class: Sound< / title >
<!-- [if lt IE 9]>
< script src = "//html5shiv.googlecode.com/svn/trunk/html5.js" > < / script >
<![endif]-->
2014-11-15 20:01:46 +00:00
< link type = "text/css" rel = "stylesheet" href = "styles/default.css" >
2013-10-03 00:21:08 +00:00
< link type = "text/css" rel = "stylesheet" href = "styles/sunlight.default.css" >
< link type = "text/css" rel = "stylesheet" href = "styles/site.cerulean.css" >
< / head >
< body >
2014-11-25 00:23:44 +00:00
2013-10-03 00:21:08 +00:00
< div class = "container-fluid" >
< div class = "navbar navbar-fixed-top navbar-inverse" >
2014-11-25 00:23:44 +00:00
< div style = "position: absolute; width: 143px; height: 31px; right: 10px; top: 10px; z-index: 1050" > < a href = "http://phaser.io" > < img src = "img/phaser.png" border = "0" / > < / a > < / div >
2013-10-03 00:21:08 +00:00
< div class = "navbar-inner" >
2014-11-25 00:23:44 +00:00
< a class = "brand" href = "index.html" > Phaser API< / a >
2013-10-03 00:21:08 +00:00
< ul class = "nav" >
2014-11-25 00:23:44 +00:00
2013-10-03 00:21:08 +00:00
< li class = "dropdown" >
2013-10-03 01:38:35 +00:00
< a href = "namespaces.list.html" class = "dropdown-toggle" data-toggle = "dropdown" > Namespaces< b
2013-10-03 00:21:08 +00:00
class="caret">< / b > < / a >
< ul class = "dropdown-menu " >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-0" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.html" > Phaser< / a >
2013-10-03 00:21:08 +00:00
< / li >
2014-11-15 20:01:46 +00:00
< li class = "class-depth-0" >
< a href = "PIXI.html" > PIXI< / a >
< / li >
2013-10-03 00:21:08 +00:00
< / ul >
< / li >
< li class = "dropdown" >
< a href = "classes.list.html" class = "dropdown-toggle" data-toggle = "dropdown" > Classes< b
class="caret">< / b > < / a >
< ul class = "dropdown-menu " >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.Animation.html" > Animation< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.AnimationManager.html" > AnimationManager< / a >
2013-10-03 00:21:08 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.AnimationParser.html" > AnimationParser< / a >
2013-10-03 00:21:08 +00:00
< / li >
2014-04-29 14:39:02 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.ArrayList.html" > ArrayList< / a >
< / li >
2014-11-25 00:23:44 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.ArraySet.html" > ArraySet< / a >
< / li >
2014-11-15 20:01:46 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.ArrayUtils.html" > ArrayUtils< / a >
< / li >
2014-10-09 15:12:53 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.AudioSprite.html" > AudioSprite< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.BitmapData.html" > BitmapData< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.BitmapText.html" > BitmapText< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Button.html" > Button< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Cache.html" > Cache< / a >
2013-10-03 00:21:08 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Camera.html" > Camera< / a >
2013-10-03 00:21:08 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Canvas.html" > Canvas< / a >
2013-10-03 00:21:08 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Circle.html" > Circle< / a >
2013-10-03 00:21:08 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Color.html" > Color< / a >
2013-10-03 00:21:08 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Device.html" > Device< / a >
2013-10-03 00:21:08 +00:00
< / li >
2014-11-15 20:01:46 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.DOM.html" > DOM< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.html" > Easing< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Back.html" > Back< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Bounce.html" > Bounce< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Circular.html" > Circular< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Cubic.html" > Cubic< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Elastic.html" > Elastic< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Exponential.html" > Exponential< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Linear.html" > Linear< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Quadratic.html" > Quadratic< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Quartic.html" > Quartic< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Quintic.html" > Quintic< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Sinusoidal.html" > Sinusoidal< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-18 03:01:51 +00:00
< a href = "Phaser.Ellipse.html" > Ellipse< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Events.html" > Events< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Filter.html" > Filter< / a >
< / li >
2014-09-09 14:36:56 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.FlexGrid.html" > FlexGrid< / a >
< / li >
< li class = "class-depth-1" >
< a href = "Phaser.FlexLayer.html" > FlexLayer< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Frame.html" > Frame< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.FrameData.html" > FrameData< / a >
2013-10-03 00:21:08 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.Game.html" > Game< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-21 15:37:26 +00:00
< a href = "Phaser.GameObjectCreator.html" > GameObjectCreator< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.GameObjectFactory.html" > GameObjectFactory< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-05 06:29:17 +00:00
< a href = "Phaser.Gamepad.html" > Gamepad< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-05 06:29:17 +00:00
< a href = "Phaser.GamepadButton.html" > GamepadButton< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Graphics.html" > Graphics< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.Group.html" > Group< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-08 07:24:22 +00:00
< a href = "Phaser.Image.html" > Image< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.Input.html" > Input< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.InputHandler.html" > InputHandler< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.Key.html" > Key< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.Keyboard.html" > Keyboard< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-05 06:29:17 +00:00
< a href = "Phaser.Line.html" > Line< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.LinkedList.html" > LinkedList< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.Loader.html" > Loader< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.LoaderParser.html" > LoaderParser< / a >
2013-10-03 00:21:08 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.Math.html" > Math< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.Mouse.html" > Mouse< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.MSPointer.html" > MSPointer< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.Net.html" > Net< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.Particle.html" > Particle< / a >
< / li >
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.Particles.html" > Particles< / a >
< / li >
2014-10-09 15:12:53 +00:00
< li class = "class-depth-2" >
< a href = "Phaser.Particles.Arcade.html" > Arcade< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.Particles.Arcade.Emitter.html" > Emitter< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Physics.html" > Physics< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Physics.Arcade.html" > Arcade< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Arcade.Body.html" > Body< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Ninja.html" > Ninja< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Ninja.AABB.html" > AABB< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Ninja.Body.html" > Body< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Ninja.Circle.html" > Circle< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Ninja.Tile.html" > Tile< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.html" > P2< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.Body.html" > Body< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.BodyDebug.html" > BodyDebug< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.CollisionGroup.html" > CollisionGroup< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.ContactMaterial.html" > ContactMaterial< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.DistanceConstraint.html" > DistanceConstraint< / a >
< / li >
2014-04-11 12:09:28 +00:00
< li class = "class-depth-3" >
< a href = "Phaser.Physics.P2.FixtureList.html" > FixtureList< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.GearConstraint.html" > GearConstraint< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.InversePointProxy.html" > InversePointProxy< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.LockConstraint.html" > LockConstraint< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.Material.html" > Material< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.PointProxy.html" > PointProxy< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.PrismaticConstraint.html" > PrismaticConstraint< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.RevoluteConstraint.html" > RevoluteConstraint< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-09-09 14:36:56 +00:00
< li class = "class-depth-3" >
< a href = "Phaser.Physics.P2.RotationalSpring.html" > RotationalSpring< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.Spring.html" > Spring< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.Plugin.html" > Plugin< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.PluginManager.html" > PluginManager< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.Point.html" > Point< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.Pointer.html" > Pointer< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-07 06:10:15 +00:00
< a href = "Phaser.Polygon.html" > Polygon< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.QuadTree.html" > QuadTree< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.RandomDataGenerator.html" > RandomDataGenerator< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.Rectangle.html" > Rectangle< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.RenderTexture.html" > RenderTexture< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.RequestAnimationFrame.html" > RequestAnimationFrame< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.RetroFont.html" > RetroFont< / a >
< / li >
2014-09-09 14:36:56 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.Rope.html" > Rope< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.ScaleManager.html" > ScaleManager< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.Signal.html" > Signal< / a >
< / li >
2014-04-11 12:09:28 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.SignalBinding.html" > SignalBinding< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-05 06:29:17 +00:00
< a href = "Phaser.SinglePad.html" > SinglePad< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.Sound.html" > Sound< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.SoundManager.html" > SoundManager< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Sprite.html" > Sprite< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-18 03:01:51 +00:00
< a href = "Phaser.SpriteBatch.html" > SpriteBatch< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.Stage.html" > Stage< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.State.html" > State< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.StateManager.html" > StateManager< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Text.html" > Text< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Tile.html" > Tile< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Tilemap.html" > Tilemap< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.TilemapLayer.html" > TilemapLayer< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.TilemapParser.html" > TilemapParser< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Tileset.html" > Tileset< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.TileSprite.html" > TileSprite< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Time.html" > Time< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Timer.html" > Timer< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-05 06:29:17 +00:00
< a href = "Phaser.TimerEvent.html" > TimerEvent< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.Touch.html" > Touch< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Tween.html" > Tween< / a >
< / li >
2014-11-25 00:23:44 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.TweenData.html" > TweenData< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.TweenManager.html" > TweenManager< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Utils.html" > Utils< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Utils.Debug.html" > Debug< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.World.html" > World< / a >
< / li >
2014-11-15 20:01:46 +00:00
< li class = "class-depth-1" >
< a href = "PIXI.AbstractFilter.html" > AbstractFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.AjaxRequest.html" > AjaxRequest< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.AlphaMaskFilter.html" > AlphaMaskFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.AsciiFilter.html" > AsciiFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.AssetLoader.html" > AssetLoader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.AtlasLoader.html" > AtlasLoader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.BaseTexture.html" > BaseTexture< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.BitmapFontLoader.html" > BitmapFontLoader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.BitmapText.html" > BitmapText< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.BlurFilter.html" > BlurFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.BlurXFilter.html" > BlurXFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.BlurYFilter.html" > BlurYFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.CanvasBuffer.html" > CanvasBuffer< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.CanvasGraphics.html" > CanvasGraphics< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.CanvasMaskManager.html" > CanvasMaskManager< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.CanvasRenderer.html" > CanvasRenderer< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.CanvasTinter.html" > CanvasTinter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Circle.html" > Circle< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.ColorMatrixFilter.html" > ColorMatrixFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.ColorStepFilter.html" > ColorStepFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.ComplexPrimitiveShader.html" > ComplexPrimitiveShader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.ConvolutionFilter.html" > ConvolutionFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.CrossHatchFilter.html" > CrossHatchFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.DisplacementFilter.html" > DisplacementFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.DisplayObject.html" > DisplayObject< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.DisplayObjectContainer.html" > DisplayObjectContainer< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.DotScreenFilter.html" > DotScreenFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Ellipse.html" > Ellipse< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Event.html" > Event< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.EventTarget.html" > EventTarget< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.FilterBlock.html" > FilterBlock< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.FilterTexture.html" > FilterTexture< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Graphics.html" > Graphics< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.GraphicsData.html" > GraphicsData< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.GrayFilter.html" > GrayFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.ImageLoader.html" > ImageLoader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.InteractionData.html" > InteractionData< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.InteractionManager.html" > InteractionManager< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.InvertFilter.html" > InvertFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.JsonLoader.html" > JsonLoader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Matrix.html" > Matrix< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.MovieClip.html" > MovieClip< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.NoiseFilter.html" > NoiseFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.NormalMapFilter.html" > NormalMapFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.PixelateFilter.html" > PixelateFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.PIXI.html" > PIXI< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.PixiFastShader.html" > PixiFastShader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.PixiShader.html" > PixiShader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Point.html" > Point< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Polygon.html" > Polygon< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.PolyK.html" > PolyK< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.PrimitiveShader.html" > PrimitiveShader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Rectangle.html" > Rectangle< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.RenderTexture.html" > RenderTexture< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.RGBSplitFilter.html" > RGBSplitFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Rope.html" > Rope< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.RoundedRectangle.html" > RoundedRectangle< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.SepiaFilter.html" > SepiaFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.SmartBlurFilter.html" > SmartBlurFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Spine.html" > Spine< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.SpineLoader.html" > SpineLoader< / a >
< / li >
2014-11-25 00:23:44 +00:00
< li class = "class-depth-1" >
< a href = "PIXI.SpineTextureLoader.html" > SpineTextureLoader< / a >
< / li >
2014-11-15 20:01:46 +00:00
< li class = "class-depth-1" >
< a href = "PIXI.Sprite.html" > Sprite< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.SpriteBatch.html" > SpriteBatch< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.SpriteSheetLoader.html" > SpriteSheetLoader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Stage.html" > Stage< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Strip.html" > Strip< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.StripShader.html" > StripShader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Text.html" > Text< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Texture.html" > Texture< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.TilingSprite.html" > TilingSprite< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.TiltShiftFilter.html" > TiltShiftFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.TiltShiftXFilter.html" > TiltShiftXFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.TiltShiftYFilter.html" > TiltShiftYFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.TwistFilter.html" > TwistFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.VideoTexture.html" > VideoTexture< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.WebGLBlendModeManager.html" > WebGLBlendModeManager< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.WebGLFastSpriteBatch.html" > WebGLFastSpriteBatch< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.WebGLFilterManager.html" > WebGLFilterManager< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.WebGLRenderer.html" > WebGLRenderer< / a >
< / li >
2013-10-03 00:21:08 +00:00
< / ul >
< / li >
2014-11-25 00:23:44 +00:00
2014-11-15 20:01:46 +00:00
< li class = "dropdown" >
2014-11-25 00:23:44 +00:00
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Core< b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu " >
< li class = "class-depth-1" > < a href = "Phaser.Group.html" > Group< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.World.html" > World< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Loader.html" > Loader< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Time.html" > Time< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Camera.html" > Camera< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.StateManager.html" > State Manager< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.TweenManager.html" > Tween Manager< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.SoundManager.html" > Sound Manager< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.InputManager.html" > Input Manager< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.ScaleManager.html" > Scale Manager< / a > < / li >
< / ul >
< / li >
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Game Objects< b class = "caret" > < / b > < / a >
2014-11-15 20:01:46 +00:00
< ul class = "dropdown-menu " >
2014-11-25 00:23:44 +00:00
< li class = "class-depth-1" > < a href = "Phaser.GameObjectFactory.html" > Factory (game.add)< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.GameObjectCreator.html" > Creator (game.make)< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Sprite.html" > Sprite< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Image.html" > Image< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Sound.html" > Sound< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Emitter.html" > Emitter< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Text.html" > Text< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Tween.html" > Tween< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.BitmapText.html" > BitmapText< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Tilemap.html" > Tilemap< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.BitmapData.html" > BitmapData< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.RetroFont.html" > RetroFont< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Button.html" > Button< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Animation.html" > Animation< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Graphics.html" > Graphics< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.RenderTexture.html" > RenderTexture< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.TileSprite.html" > TileSprite< / a > < / li >
< / ul >
< / li >
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Geometry< b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu " >
< li class = "class-depth-1" > < a href = "Phaser.Circle.html" > Circle< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Rectangle.html" > Rectangle< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Point.html" > Point< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Line.html" > Line< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Ellipse.html" > Ellipse< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Polygon.html" > Polygon< / a > < / li >
< / ul >
< / li >
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Physics< b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu " >
< li class = "class-depth-1" > < a href = "Phaser.Physics.Arcade.html" > Arcade Physics< / a > < / li >
< li class = "class-depth-2" > < a href = "Phaser.Physics.Arcade.Body.html" > Body< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Physics.P2.html" > P2 Physics< / a > < / li >
< li class = "class-depth-2" > < a href = "Phaser.Physics.P2.Body.html" > Body< / a > < / li >
< li class = "class-depth-2" > < a href = "Phaser.Physics.P2.Spring.html" > Spring< / a > < / li >
< li class = "class-depth-2" > < a href = "Phaser.Physics.P2.CollisionGroup.html" > CollisionGroup< / a > < / li >
< li class = "class-depth-2" > < a href = "Phaser.Physics.P2.ContactMaterial.html" > ContactMaterial< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Physics.Ninja.html" > Ninja Physics< / a > < / li >
< li class = "class-depth-2" > < a href = "Phaser.Physics.Body.html" > Body< / a > < / li >
2014-11-15 20:01:46 +00:00
< / ul >
< / li >
2014-11-25 00:23:44 +00:00
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Input< b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu " >
< li class = "class-depth-1" > < a href = "Phaser.InputHandler.html" > Input Handler< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Pointer.html" > Pointer< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Mouse.html" > Mouse< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Keyboard.html" > Keyboard< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Key.html" > Key< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Gamepad.html" > Gamepad< / a > < / li >
< / ul >
< / li >
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Community< b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu " >
< li class = "class-depth-1" > < a href = "https://github.com/photonstorm/phaser" > Phaser Github< / a > < / li >
< li class = "class-depth-1" > < a href = "http://examples.phaser.io" > Phaser Examples< / a > < / li >
< li class = "class-depth-1" > < a href = "https://github.com/photonstorm/phaser-plugins" > Phaser Plugins< / a > < / li >
< li class = "class-depth-1" > < a href = "http://www.html5gamedevs.com/forum/14-phaser/" > Forum< / a > < / li >
< li class = "class-depth-1" > < a href = "http://stackoverflow.com/questions/tagged/phaser-framework" > Stack Overflow< / a > < / li >
< li class = "class-depth-1" > < a href = "https://confirmsubscription.com/h/r/369DE48E3E86AF1E" > Newsletter< / a > < / li >
< li class = "class-depth-1" > < a href = "https://twitter.com/photonstorm" > Twitter< / a > < / li >
< li class = "class-depth-1" > < a href = "http://www.html5gamedevs.com/topic/4470-official-phaserio-irc-channel-phaserio-on-freenode/" > IRC< / a > < / li >
< li class = "class-depth-1" > < a href = "https://www.gittip.com/photonstorm/" > GitTip< / a > < / li >
< / ul >
< / li >
2014-11-15 20:01:46 +00:00
< / ul >
< / div >
< / div >
< div class = "row-fluid" >
2013-10-03 00:21:08 +00:00
< div class = "span8" >
< div id = "main" >
2014-11-25 00:23:44 +00:00
<!-- <h1 class="page - title">Class: Sound</h1> -->
2013-10-03 00:21:08 +00:00
< section >
< header >
< h2 >
2013-10-03 01:38:35 +00:00
< span class = "ancestors" > < a href = "Phaser.html" > Phaser< / a > .< / span >
2013-10-03 00:21:08 +00:00
Sound
< / h2 >
2014-10-09 15:12:53 +00:00
< div class = "class-description" > < p > Phaser.Sound< / p > < / div >
2013-10-03 00:21:08 +00:00
< / header >
< article >
< div class = "container-overview" >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="Sound">< span class = "type-signature" > < / span > new Sound< span class = "signature" > (game, key, < span class = "optional" > volume< / span > , < span class = "optional" > loop< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< div class = "description" >
< p > The Sound class constructor.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > game< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Game.html" > Phaser.Game< / a > < / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > Reference to the current game instance.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > key< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > Asset key for the sound.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > volume< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
1
< / td >
< td class = "description last" > < p > Default value for the volume, between 0 and 1.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > loop< / 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 > Whether or not the sound will loop.< / p > < / td >
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-17" > line 17< / a >
< / dt >
2013-10-03 00:21:08 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< / dd >
< / div >
< h3 class = "subsection-title" > Members< / h3 >
< dl >
2014-10-09 15:12:53 +00:00
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="allowMultiple">< span class = "type-signature" > < / span > allowMultiple< span class = "type-signature" > :boolean< / span > < / h4 >
2014-10-09 15:12:53 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-10-09 15:12:53 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > This will allow you to have multiple instances of this Sound playing at once. This is only useful when running under Web Audio, and we recommend you implement a local pooling system to not flood the sound channels.< / p >
< / div >
2014-10-09 15:12:53 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2014-10-09 15:12:53 +00:00
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > false< / li > < / ul > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-144" > line 144< / a >
< / dt >
2014-10-09 15:12:53 +00:00
< / dl >
< / dd >
2013-10-03 00:21:08 +00:00
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="autoplay">< span class = "type-signature" > < / span > autoplay< span class = "type-signature" > :boolean< / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Boolean indicating whether the sound should start automatically.< / p >
< / div >
2013-11-28 15:57:09 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-62" > line 62< / a >
< / dt >
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="context">< span class = "type-signature" > < / span > context< span class = "type-signature" > :AudioContext< / span > < / h4 >
< / dt >
< dd >
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Reference to the AudioContext instance.< / p >
< / div >
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-57" > line 57< / a >
< / dt >
2013-11-28 15:57:09 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="currentMarker">< span class = "type-signature" > < / span > currentMarker< span class = "type-signature" > :string< / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The string ID of the currently playing marker, if any.< / p >
< / div >
2013-10-03 00:21:08 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-126" > line 126< / a >
< / dt >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="currentTime">< span class = "type-signature" > < / span > currentTime< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The current time the sound is at.< / p >
< / div >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-78" > line 78< / a >
< / dt >
2013-10-03 00:21:08 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="duration">< span class = "type-signature" > < / span > duration< span class = "type-signature" > :number< / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The duration of the current sound marker in seconds.< / p >
< / div >
2013-10-03 00:21:08 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-83" > line 83< / a >
< / dt >
2013-10-03 00:21:08 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="durationMS">< span class = "type-signature" > < / span > durationMS< span class = "type-signature" > :number< / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
2014-10-09 15:12:53 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The duration of the current sound marker in ms.< / p >
< / div >
2014-10-09 15:12:53 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-88" > line 88< / a >
< / dt >
2013-10-03 00:21:08 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="externalNode">< span class = "type-signature" > < / span > externalNode< span class = "type-signature" > :object< / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > If defined this Sound won't connect to the SoundManager master gain node, but will instead connect to externalNode.< / p >
< / div >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-160" > line 160< / a >
< / dt >
2013-10-03 00:21:08 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="gainNode">< span class = "type-signature" > < / span > gainNode< span class = "type-signature" > :object< / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The gain node in a Web Audio system.< / p >
< / div >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-170" > line 170< / a >
< / dt >
2013-10-03 00:21:08 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="game">< span class = "type-signature" > < / span > game< span class = "type-signature" > :< a href = "Phaser.Game.html" > Phaser.Game< / a > < / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > A reference to the currently running Game.< / p >
< / div >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-27" > line 27< / a >
< / dt >
2013-10-03 00:21:08 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="isDecoded">< span class = "type-signature" > < readonly> < / span > isDecoded< span class = "type-signature" > :boolean< / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Returns true if the sound file has decoded.< / p >
< / div >
2013-10-03 00:21:08 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-927" > line 927< / a >
< / dt >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="isDecoding">< span class = "type-signature" > < readonly> < / span > isDecoding< span class = "type-signature" > :boolean< / span > < / h4 >
< / dt >
< dd >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Returns true if the sound file is still decoding.< / p >
< / div >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-914" > line 914< / a >
< / dt >
2013-10-03 00:21:08 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="isPlaying">< span class = "type-signature" > < / span > isPlaying< span class = "type-signature" > :boolean< / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > true if the sound is currently playing, otherwise false.< / p >
< / div >
2013-10-03 00:21:08 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > false< / li > < / ul > < / dd >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-120" > line 120< / a >
< / dt >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="key">< span class = "type-signature" > < / span > key< span class = "type-signature" > :string< / span > < / h4 >
< / dt >
< dd >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Asset key for the sound.< / p >
< / div >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-37" > line 37< / a >
< / dt >
2013-10-03 00:21:08 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="loop">< span class = "type-signature" > < / span > loop< span class = "type-signature" > :boolean< / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Whether or not the sound or current sound marker will loop.< / p >
< / div >
2013-10-03 00:21:08 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-42" > line 42< / a >
< / dt >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="markers">< span class = "type-signature" > < / span > markers< span class = "type-signature" > :object< / span > < / h4 >
< / dt >
< dd >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The sound markers.< / p >
< / div >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-52" > line 52< / a >
< / dt >
2013-10-03 00:21:08 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="masterGainNode">< span class = "type-signature" > < / span > masterGainNode< span class = "type-signature" > :object< / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The master gain node in a Web Audio system.< / p >
< / div >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-165" > line 165< / a >
< / dt >
2013-10-03 00:21:08 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="mute">< span class = "type-signature" > < / span > mute< span class = "type-signature" > :boolean< / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Gets or sets the muted state of this sound.< / p >
< / div >
2013-10-03 00:21:08 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-940" > line 940< / a >
< / dt >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="name">< span class = "type-signature" > < / span > name< span class = "type-signature" > :string< / span > < / h4 >
< / dt >
< dd >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Name of the sound.< / p >
< / div >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-32" > line 32< / a >
< / dt >
2013-10-03 00:21:08 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="onDecoded">< span class = "type-signature" > < / span > onDecoded< span class = "type-signature" > :< a href = "Phaser.Signal.html" > Phaser.Signal< / a > < / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The onDecoded event is dispatched when the sound has finished decoding (typically for mp3 files)< / p >
< / div >
2013-10-03 00:21:08 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-214" > line 214< / a >
< / dt >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="onFadeComplete">< span class = "type-signature" > < / span > onFadeComplete< span class = "type-signature" > :< a href = "Phaser.Signal.html" > Phaser.Signal< / a > < / span > < / h4 >
< / dt >
< dd >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The onFadeComplete event is dispatched when this sound finishes fading either in or out.< / p >
< / div >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-254" > line 254< / a >
< / dt >
2013-10-25 15:54:40 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="onLoop">< span class = "type-signature" > < / span > onLoop< span class = "type-signature" > :< a href = "Phaser.Signal.html" > Phaser.Signal< / a > < / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The onLoop event is dispatched when this sound loops during playback.< / p >
< / div >
2013-10-25 15:54:40 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-234" > line 234< / a >
< / dt >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="onMarkerComplete">< span class = "type-signature" > < / span > onMarkerComplete< span class = "type-signature" > :< a href = "Phaser.Signal.html" > Phaser.Signal< / a > < / span > < / h4 >
< / dt >
< dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The onMarkerComplete event is dispatched when a marker within this sound completes playback.< / p >
< / div >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-249" > line 249< / a >
< / dt >
2013-10-25 15:54:40 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="onMute">< span class = "type-signature" > < / span > onMute< span class = "type-signature" > :< a href = "Phaser.Signal.html" > Phaser.Signal< / a > < / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The onMouse event is dispatched when this sound is muted.< / p >
< / div >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-244" > line 244< / a >
< / dt >
2013-10-03 00:21:08 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="onPause">< span class = "type-signature" > < / span > onPause< span class = "type-signature" > :< a href = "Phaser.Signal.html" > Phaser.Signal< / a > < / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The onPause event is dispatched when this sound is paused.< / p >
< / div >
2013-10-03 00:21:08 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-224" > line 224< / a >
< / dt >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="onPlay">< span class = "type-signature" > < / span > onPlay< span class = "type-signature" > :< a href = "Phaser.Signal.html" > Phaser.Signal< / a > < / span > < / h4 >
< / dt >
< dd >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The onPlay event is dispatched each time this sound is played.< / p >
< / div >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-219" > line 219< / a >
< / dt >
2014-04-29 14:39:02 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="onResume">< span class = "type-signature" > < / span > onResume< span class = "type-signature" > :< a href = "Phaser.Signal.html" > Phaser.Signal< / a > < / span > < / h4 >
2014-04-29 14:39:02 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The onResume event is dispatched when this sound is resumed from a paused state.< / p >
< / div >
2014-04-29 14:39:02 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-229" > line 229< / a >
< / dt >
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="onStop">< span class = "type-signature" > < / span > onStop< span class = "type-signature" > :< a href = "Phaser.Signal.html" > Phaser.Signal< / a > < / span > < / h4 >
< / dt >
< dd >
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The onStop event is dispatched when this sound stops playback.< / p >
< / div >
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-239" > line 239< / a >
< / dt >
2013-10-03 00:21:08 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="override">< span class = "type-signature" > < / span > override< span class = "type-signature" > :boolean< / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > if true when you play this sound it will always start from the beginning.< / p >
< / div >
2013-10-03 00:21:08 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > false< / li > < / ul > < / dd >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-138" > line 138< / a >
< / dt >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="paused">< span class = "type-signature" > < / span > paused< span class = "type-signature" > :boolean< / span > < / h4 >
< / dt >
< dd >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > true if the sound is paused, otherwise false.< / p >
< / div >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-03 00:21:08 +00:00
< dt class = "tag-default" > Default Value:< / dt >
2014-11-15 20:01:46 +00:00
< dd class = "tag-default" > < ul class = "dummy" > < li > false< / li > < / ul > < / dd >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-104" > line 104< / a >
< / dt >
2013-10-03 00:21:08 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="pausedPosition">< span class = "type-signature" > < / span > pausedPosition< span class = "type-signature" > :number< / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The position the sound had reached when it was paused.< / p >
< / div >
2013-10-03 00:21:08 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-109" > line 109< / a >
< / dt >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="pausedTime">< span class = "type-signature" > < / span > pausedTime< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The game time at which the sound was paused.< / p >
< / div >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-114" > line 114< / a >
< / dt >
2013-10-03 00:21:08 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="pendingPlayback">< span class = "type-signature" > < readonly> < / span > pendingPlayback< span class = "type-signature" > :boolean< / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > true if the sound file is pending playback< / p >
< / div >
2013-10-03 00:21:08 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-132" > line 132< / a >
< / dt >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="position">< span class = "type-signature" > < / span > position< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The position of the current sound marker.< / p >
< / div >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-93" > line 93< / a >
< / dt >
2013-10-03 00:21:08 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="startTime">< span class = "type-signature" > < / span > startTime< span class = "type-signature" > :number< / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The time the Sound starts at (typically 0 unless starting from a marker)< / p >
< / div >
2013-10-03 00:21:08 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > 0< / li > < / ul > < / dd >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-73" > line 73< / a >
< / dt >
2013-10-03 00:21:08 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="stopTime">< span class = "type-signature" > < / span > stopTime< span class = "type-signature" > :number< / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The time the sound stopped.< / p >
< / div >
2013-10-03 00:21:08 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-98" > line 98< / a >
< / dt >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="totalDuration">< span class = "type-signature" > < / span > totalDuration< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The total duration of the sound in seconds.< / p >
< / div >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-67" > line 67< / a >
< / dt >
2013-10-03 00:21:08 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="usingAudioTag">< span class = "type-signature" > < / span > usingAudioTag< span class = "type-signature" > :boolean< / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > true if the sound is being played via the Audio tag.< / p >
< / div >
2013-10-03 00:21:08 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-155" > line 155< / a >
< / dt >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="usingWebAudio">< span class = "type-signature" > < readonly> < / span > usingWebAudio< span class = "type-signature" > :boolean< / span > < / h4 >
< / dt >
< dd >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > true if this sound is being played with Web Audio.< / p >
< / div >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-150" > line 150< / a >
< / dt >
2014-04-29 14:39:02 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="volume">< span class = "type-signature" > < readonly> < / span > volume< span class = "type-signature" > :number< / span > < / h4 >
2014-04-29 14:39:02 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Gets or sets the volume of this sound, a value between 0 and 1.< / p >
< / div >
2014-04-29 14:39:02 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-991" > line 991< / a >
< / dt >
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="volume">< span class = "type-signature" > < / span > volume< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The sound or sound marker volume. A value between 0 (silence) and 1 (full volume).< / p >
< / div >
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-47" > line 47< / a >
< / dt >
2013-10-03 00:21:08 +00:00
< / dl >
< / dd >
< / dl >
< h3 class = "subsection-title" > Methods< / h3 >
< dl >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="addMarker">< span class = "type-signature" > < / span > addMarker< span class = "signature" > (name, start, duration, < span class = "optional" > volume< / span > , < span class = "optional" > loop< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< div class = "description" >
2014-04-10 22:13:43 +00:00
< p > Adds a marker into the current Sound. A marker is represented by a unique key and a start time and duration.
This allows you to bundle multiple sounds together into a single audio file and use markers to jump between them for playback.< / p >
2013-10-03 00:21:08 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-04-10 22:13:43 +00:00
< th > Argument< / th >
2013-10-03 00:21:08 +00:00
2014-04-10 22:13:43 +00:00
< th > Default< / th >
2013-10-03 00:21:08 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2014-04-10 22:13:43 +00:00
< td class = "attributes" >
< / td >
2013-10-03 00:21:08 +00:00
2014-04-10 22:13:43 +00:00
< td class = "default" >
< / td >
2013-10-03 00:21:08 +00:00
2014-04-10 22:13:43 +00:00
< td class = "description last" > < p > A unique name for this marker, i.e. 'explosion', 'gunshot', etc.< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< tr >
< td class = "name" > < code > start< / code > < / td >
< td class = "type" >
2014-04-10 22:13:43 +00:00
< span class = "param-type" > number< / span >
2013-10-03 00:21:08 +00:00
< / td >
2014-04-10 22:13:43 +00:00
< td class = "attributes" >
< / td >
2013-10-03 00:21:08 +00:00
2014-04-10 22:13:43 +00:00
< td class = "default" >
< / td >
2013-10-03 00:21:08 +00:00
2014-04-10 22:13:43 +00:00
< td class = "description last" > < p > The start point of this marker in the audio file, given in seconds. 2.5 = 2500ms, 0.5 = 500ms, etc.< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< tr >
2014-04-10 22:13:43 +00:00
< td class = "name" > < code > duration< / code > < / td >
2013-10-03 00:21:08 +00:00
< td class = "type" >
2014-04-10 22:13:43 +00:00
< span class = "param-type" > number< / span >
2013-10-03 00:21:08 +00:00
< / td >
2014-04-10 22:13:43 +00:00
< td class = "attributes" >
< / td >
2013-10-03 00:21:08 +00:00
2014-04-10 22:13:43 +00:00
< td class = "default" >
< / td >
2013-10-03 00:21:08 +00:00
2014-04-10 22:13:43 +00:00
< td class = "description last" > < p > The duration of the marker in seconds. 2.5 = 2500ms, 0.5 = 500ms, etc.< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< tr >
< td class = "name" > < code > volume< / code > < / td >
< td class = "type" >
2014-04-10 22:13:43 +00:00
< span class = "param-type" > number< / span >
2013-10-03 00:21:08 +00:00
< / td >
2014-04-10 22:13:43 +00:00
< td class = "attributes" >
< optional>< br >
2013-10-03 00:21:08 +00:00
2014-04-10 22:13:43 +00:00
< / td >
2013-10-03 00:21:08 +00:00
2014-04-10 22:13:43 +00:00
< td class = "default" >
1
< / td >
< td class = "description last" > < p > The volume the sound will play back at, between 0 (silent) and 1 (full volume).< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< tr >
< td class = "name" > < code > loop< / code > < / td >
< td class = "type" >
2014-04-10 22:13:43 +00:00
< span class = "param-type" > boolean< / span >
2013-10-03 00:21:08 +00:00
< / td >
2014-04-10 22:13:43 +00:00
< td class = "attributes" >
< optional>< br >
2013-10-03 00:21:08 +00:00
2014-04-10 22:13:43 +00:00
2013-10-03 00:21:08 +00:00
2014-04-10 22:13:43 +00:00
< / td >
2013-10-03 00:21:08 +00:00
2014-04-10 22:13:43 +00:00
< td class = "default" >
false
< / td >
2013-10-03 00:21:08 +00:00
2014-04-10 22:13:43 +00:00
< td class = "description last" > < p > Sets if the sound will loop or not.< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-335" > line 335< / a >
< / dt >
2013-10-03 00:21:08 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="destroy">< span class = "type-signature" > < / span > destroy< span class = "signature" > (< span class = "optional" > remove< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< div class = "description" >
2014-04-10 22:13:43 +00:00
< p > Destroys this sound and all associated events and removes it from the SoundManager.< / p >
2013-10-03 00:21:08 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-04-10 22:13:43 +00:00
< td class = "name" > < code > remove< / code > < / td >
2013-10-03 00:21:08 +00:00
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
2014-04-10 22:13:43 +00:00
true
2013-10-03 00:21:08 +00:00
< / td >
2014-04-10 22:13:43 +00:00
< td class = "description last" > < p > If true this Sound is automatically removed from the SoundManager.< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-875" > line 875< / a >
< / dt >
2014-10-09 15:12:53 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-10-09 15:12:53 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="fadeIn">< span class = "type-signature" > < / span > fadeIn< span class = "signature" > (< span class = "optional" > duration< / span > , < span class = "optional" > loop< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2014-10-09 15:12:53 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-10-09 15:12:53 +00:00
< div class = "description" >
< p > Starts this sound playing (or restarts it if already doing so) and sets the volume to zero.
Then increases the volume from 0 to 1 over the duration specified.
2014-10-22 20:49:44 +00:00
At the end of the fade Sound.onFadeComplete is dispatched with this Sound object as the first parameter,
2014-10-09 15:12:53 +00:00
and the final volume (1) as the second parameter.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > duration< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
1000
< / td >
2014-10-22 20:49:44 +00:00
< td class = "description last" > < p > The time in milliseconds over which the Sound should fade in.< / p > < / td >
2014-10-09 15:12:53 +00:00
< / tr >
< tr >
< td class = "name" > < code > loop< / 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 > Should the Sound be set to loop? Note that this doesn't cause the fade to repeat.< / p > < / td >
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2014-10-09 15:12:53 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-789" > line 789< / a >
< / dt >
2014-10-09 15:12:53 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-10-09 15:12:53 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="fadeOut">< span class = "type-signature" > < / span > fadeOut< span class = "signature" > (< span class = "optional" > duration< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2014-10-09 15:12:53 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-10-09 15:12:53 +00:00
< div class = "description" >
< p > Decreases the volume of this Sound from its current value to 0 over the duration specified.
2014-10-22 20:49:44 +00:00
At the end of the fade Sound.onFadeComplete is dispatched with this Sound object as the first parameter,
2014-10-09 15:12:53 +00:00
and the final volume (0) as the second parameter.< / p >
< / div >
2014-10-22 20:49:44 +00:00
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > duration< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
1000
< / td >
< td class = "description last" > < p > The time in milliseconds over which the Sound should fade out.< / p > < / td >
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2014-10-22 20:49:44 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-814" > line 814< / a >
< / dt >
2014-10-22 20:49:44 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-10-22 20:49:44 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="fadeTo">< span class = "type-signature" > < / span > fadeTo< span class = "signature" > (< span class = "optional" > duration< / span > , < span class = "optional" > volume< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2014-10-22 20:49:44 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-10-22 20:49:44 +00:00
< div class = "description" >
< p > Fades the volume of this Sound from its current value to the given volume over the duration specified.
At the end of the fade Sound.onFadeComplete is dispatched with this Sound object as the first parameter,
and the final volume (volume) as the second parameter.< / p >
< / div >
2014-10-09 15:12:53 +00:00
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > duration< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
1000
< / td >
< td class = "description last" > < p > The time in milliseconds during which the Sound should fade out.< / p > < / td >
< / tr >
2014-10-22 20:49:44 +00:00
< tr >
< td class = "name" > < code > volume< / 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 volume which the Sound should fade to. This is a value between 0 and 1.< / p > < / td >
< / tr >
2014-10-09 15:12:53 +00:00
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2014-10-09 15:12:53 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-828" > line 828< / a >
< / dt >
2013-10-03 00:21:08 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="pause">< span class = "type-signature" > < / span > pause< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< div class = "description" >
2014-04-29 14:39:02 +00:00
< p > Pauses the sound.< / p >
2013-10-03 00:21:08 +00:00
< / div >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-668" > line 668< / a >
< / dt >
2013-10-03 00:21:08 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="play">< span class = "type-signature" > < / span > play< span class = "signature" > (< span class = "optional" > marker< / span > , < span class = "optional" > position< / span > , < span class = "optional" > volume< / span > , < span class = "optional" > loop< / span > , < span class = "optional" > forceRestart< / span > )< / span > < span class = "type-signature" > → {< a href = "Phaser.Sound.html" > Phaser.Sound< / a > }< / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< div class = "description" >
< p > Play this sound, or a marked section of it.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > marker< / 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 > If you want to play a marker then give the key here, otherwise leave blank to play the full sound.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > position< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
0
< / td >
< td class = "description last" > < p > The starting position to play the sound from - this is ignored if you provide a marker.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > volume< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
1
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > Volume of the sound you want to play. If none is given it will use the volume given to the Sound when it was created (which defaults to 1 if none was specified).< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< tr >
< td class = "name" > < code > loop< / 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 > Loop when it finished playing?< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > forceRestart< / 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 the sound is already playing you can set forceRestart to restart it from the beginning.< / p > < / td >
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > < a href = "Phaser.Sound.html" > Phaser.Sound< / a > < / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > This sound instance.< / p >
< / div >
< / div >
2013-10-03 00:21:08 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-438" > line 438< / a >
< / dt >
2013-10-03 00:21:08 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="removeMarker">< span class = "type-signature" > < / span > removeMarker< span class = "signature" > (name)< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< div class = "description" >
< p > Removes a marker from the sound.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < p > The key of the marker to remove.< / p > < / td >
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-363" > line 363< / a >
< / dt >
2013-10-03 00:21:08 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="restart">< span class = "type-signature" > < / span > restart< span class = "signature" > (< span class = "optional" > marker< / span > , < span class = "optional" > position< / span > , < span class = "optional" > volume< / span > , < span class = "optional" > loop< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< div class = "description" >
< p > Restart the sound, or a marked section of it.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > marker< / 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 > If you want to play a marker then give the key here, otherwise leave blank to play the full sound.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > position< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
0
< / td >
< td class = "description last" > < p > The starting position to play the sound from - this is ignored if you provide a marker.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > volume< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
1
< / td >
< td class = "description last" > < p > Volume of the sound you want to play.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > loop< / 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 > Loop when it finished playing?< / p > < / td >
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-648" > line 648< / a >
< / dt >
2013-10-03 00:21:08 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="resume">< span class = "type-signature" > < / span > resume< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< div class = "description" >
2014-04-29 14:39:02 +00:00
< p > Resumes the sound.< / p >
2013-10-03 00:21:08 +00:00
< / div >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-686" > line 686< / a >
< / dt >
2013-10-03 00:21:08 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="soundHasUnlocked">< span class = "type-signature" > < internal> < / span > soundHasUnlocked< span class = "signature" > (key)< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< div class = "description" >
< p > Called automatically when this sound is unlocked.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > key< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > The Phaser.Cache key of the sound file to check for decoding.< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "important tag-deprecated" > Internal:< / dt >
< dd class = "tag-deprecated" > < ul >
< li > This member is < em > internal (protected)< / em > and may be modified or removed in the future.< / li >
< / ul > < / dd >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-319" > line 319< / a >
< / dt >
2013-10-03 00:21:08 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="stop">< span class = "type-signature" > < / span > stop< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< div class = "description" >
< p > Stop playing this sound.< / p >
< / div >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-739" > line 739< / a >
< / dt >
2013-10-03 00:21:08 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="update">< span class = "type-signature" > < internal> < / span > update< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< div class = "description" >
< p > Called automatically by Phaser.SoundManager.< / p >
< / div >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "important tag-deprecated" > Internal:< / dt >
< dd class = "tag-deprecated" > < ul >
< li > This member is < em > internal (protected)< / em > and may be modified or removed in the future.< / li >
< / ul > < / dd >
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-374" > line 374< / a >
< / dt >
2013-10-03 00:21:08 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
< / dd >
< / dl >
< / article >
< / section >
< / div >
< div class = "clearfix" > < / div >
< footer >
< span class = "copyright" >
2014-02-05 06:29:17 +00:00
Phaser Copyright © 2012-2014 Photon Storm Ltd.
2013-10-03 00:21:08 +00:00
< / span >
< br / >
< span class = "jsdoc-message" >
2014-04-11 12:09:28 +00:00
Documentation generated by < a href = "https://github.com/jsdoc3/jsdoc" > JSDoc 3.3.0-dev< / a >
2014-11-25 00:23:44 +00:00
on Tue Nov 25 2014 00:17:55 GMT-0000 (GMT) using the < a href = "https://github.com/terryweiss/docstrap" > DocStrap template< / a > .
2013-10-03 00:21:08 +00:00
< / span >
< / footer >
< / div >
< div class = "span3" >
< div id = "toc" > < / div >
< / div >
< br clear = "both" >
< / div >
< / div >
< script src = "scripts/sunlight.js" > < / script >
< script src = "scripts/sunlight.javascript.js" > < / script >
< script src = "scripts/sunlight-plugin.doclinks.js" > < / script >
< script src = "scripts/sunlight-plugin.linenumbers.js" > < / script >
< script src = "scripts/sunlight-plugin.menu.js" > < / script >
< script src = "scripts/jquery.min.js" > < / script >
< script src = "scripts/jquery.scrollTo.js" > < / script >
< script src = "scripts/jquery.localScroll.js" > < / script >
< script src = "scripts/bootstrap-dropdown.js" > < / script >
< script src = "scripts/toc.js" > < / script >
< script > Sunlight . highlightAll ( { lineNumbers : true , showMenu : true , enableDoclinks : true } ) ; < / script >
< script >
$( function () {
$( "#toc" ).toc( {
2014-04-10 22:13:43 +00:00
anchorName : function(i, heading, prefix) {
2014-03-14 06:36:05 +00:00
return $(heading).attr("id") || ( prefix + i );
},
2013-10-03 00:21:08 +00:00
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
< / script >
< / body >
< / html >