Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-15 09:27:37 +00:00
Code Issues Projects Releases Packages Wiki Activity
phaser/docs/Phaser.Sound.html
photonstorm 9f28d0659d Phaser 2.4.8 release.
2016-05-19 12:36:51 +01:00

6245 lines
No EOL
98 KiB
HTML
Raw Blame History

<!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]-->
<link type="text/css" rel="stylesheet" href="styles/default.css">
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
<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>
<div class="navbar-inner">
<a class="brand" href="index.html">Phaser API</a>
<ul class="nav">
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-0">
<a href="Phaser.html">Phaser</a>
</li>
<li class="class-depth-0">
<a href="Phaser.KeyCode.html">KeyCode</a>
</li>
<li class="class-depth-0">
<a href="PIXI.html">PIXI</a>
</li>
</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 ">
<li class="class-depth-1">
<a href="Phaser.Animation.html">Animation</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AnimationManager.html">AnimationManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AnimationParser.html">AnimationParser</a>
</li>
<li class="class-depth-1">
<a href="Phaser.ArraySet.html">ArraySet</a>
</li>
<li class="class-depth-1">
<a href="Phaser.ArrayUtils.html">ArrayUtils</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Button.html">Button</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Cache.html">Cache</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Camera.html">Camera</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Canvas.html">Canvas</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Circle.html">Circle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Color.html">Color</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Angle.html">Angle</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Animation.html">Animation</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.AutoCull.html">AutoCull</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Bounds.html">Bounds</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.BringToTop.html">BringToTop</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Core.html">Core</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Crop.html">Crop</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Delta.html">Delta</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Destroy.html">Destroy</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.FixedToCamera.html">FixedToCamera</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Health.html">Health</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.InCamera.html">InCamera</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.InputEnabled.html">InputEnabled</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.InWorld.html">InWorld</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.LifeSpan.html">LifeSpan</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.LoadTexture.html">LoadTexture</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Overlap.html">Overlap</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.PhysicsBody.html">PhysicsBody</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Reset.html">Reset</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.ScaleMinMax.html">ScaleMinMax</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Smoothed.html">Smoothed</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Create.html">Create</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Creature.html">Creature</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Device.html">Device</a>
</li>
<li class="class-depth-1">
<a href="Phaser.DeviceButton.html">DeviceButton</a>
</li>
<li class="class-depth-1">
<a href="Phaser.DOM.html">DOM</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Easing.html">Easing</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Back.html">Back</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Bounce.html">Bounce</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Circular.html">Circular</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Cubic.html">Cubic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Elastic.html">Elastic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Exponential.html">Exponential</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Linear.html">Linear</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quadratic.html">Quadratic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quartic.html">Quartic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quintic.html">Quintic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Ellipse.html">Ellipse</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Events.html">Events</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Filter.html">Filter</a>
</li>
<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>
<li class="class-depth-1">
<a href="Phaser.Frame.html">Frame</a>
</li>
<li class="class-depth-1">
<a href="Phaser.FrameData.html">FrameData</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Game.html">Game</a>
</li>
<li class="class-depth-1">
<a href="Phaser.GameObjectCreator.html">GameObjectCreator</a>
</li>
<li class="class-depth-1">
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Gamepad.html">Gamepad</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Graphics.html">Graphics</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Group.html">Group</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Image.html">Image</a>
</li>
<li class="class-depth-1">
<a href="Phaser.ImageCollection.html">ImageCollection</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Input.html">Input</a>
</li>
<li class="class-depth-1">
<a href="Phaser.InputHandler.html">InputHandler</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Key.html">Key</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Keyboard.html">Keyboard</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Line.html">Line</a>
</li>
<li class="class-depth-1">
<a href="Phaser.LinkedList.html">LinkedList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Loader.html">Loader</a>
</li>
<li class="class-depth-1">
<a href="Phaser.LoaderParser.html">LoaderParser</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Math.html">Math</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Matrix.html">Matrix</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Mouse.html">Mouse</a>
</li>
<li class="class-depth-1">
<a href="Phaser.MSPointer.html">MSPointer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Net.html">Net</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Particle.html">Particle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Physics.html">Physics</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Physics.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Arcade.Body.html">Body</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Arcade.TilemapCollision.html">TilemapCollision</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Physics.Ninja.html">Ninja</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.AABB.html">AABB</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Body.html">Body</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Circle.html">Circle</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Tile.html">Tile</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Physics.P2.html">P2</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Body.html">Body</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.BodyDebug.html">BodyDebug</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.DistanceConstraint.html">DistanceConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.FixtureList.html">FixtureList</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.GearConstraint.html">GearConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.InversePointProxy.html">InversePointProxy</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.LockConstraint.html">LockConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Material.html">Material</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PointProxy.html">PointProxy</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PrismaticConstraint.html">PrismaticConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RevoluteConstraint.html">RevoluteConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RotationalSpring.html">RotationalSpring</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Spring.html">Spring</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Plugin.html">Plugin</a>
</li>
<li class="class-depth-1">
<a href="Phaser.PluginManager.html">PluginManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Point.html">Point</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Pointer.html">Pointer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.PointerMode.html">PointerMode</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Polygon.html">Polygon</a>
</li>
<li class="class-depth-1">
<a href="Phaser.QuadTree.html">QuadTree</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Rectangle.html">Rectangle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RenderTexture.html">RenderTexture</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RetroFont.html">RetroFont</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Rope.html">Rope</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RoundedRectangle.html">RoundedRectangle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.ScaleManager.html">ScaleManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Signal.html">Signal</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SignalBinding.html">SignalBinding</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SinglePad.html">SinglePad</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Sound.html">Sound</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SoundManager.html">SoundManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Sprite.html">Sprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SpriteBatch.html">SpriteBatch</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Stage.html">Stage</a>
</li>
<li class="class-depth-1">
<a href="Phaser.State.html">State</a>
</li>
<li class="class-depth-1">
<a href="Phaser.StateManager.html">StateManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Text.html">Text</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tile.html">Tile</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tilemap.html">Tilemap</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TilemapParser.html">TilemapParser</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tileset.html">Tileset</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Time.html">Time</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Timer.html">Timer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TimerEvent.html">TimerEvent</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Touch.html">Touch</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tween.html">Tween</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TweenData.html">TweenData</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TweenManager.html">TweenManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Utils.html">Utils</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Utils.Debug.html">Debug</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Video.html">Video</a>
</li>
<li class="class-depth-1">
<a href="Phaser.World.html">World</a>
</li>
<li class="class-depth-1">
<a href="PIXI.AbstractFilter.html">AbstractFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BaseTexture.html">BaseTexture</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.CanvasPool.html">CanvasPool</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.ComplexPrimitiveShader.html">ComplexPrimitiveShader</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.EarCut.html">EarCut</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.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.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.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.RenderTexture.html">RenderTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Rope.html">Rope</a>
</li>
<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.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.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.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>
</ul>
</li>
<li class="dropdown">
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-0">
<a href="global.html#AUTO">AUTO</a>
</li>
<li class="class-depth-0">
<a href="global.html#BITMAPDATA">BITMAPDATA</a>
</li>
<li class="class-depth-0">
<a href="global.html#BITMAPTEXT">BITMAPTEXT</a>
</li>
<li class="class-depth-0">
<a href="global.html#blendModes">blendModes</a>
</li>
<li class="class-depth-0">
<a href="global.html#BUTTON">BUTTON</a>
</li>
<li class="class-depth-0">
<a href="global.html#CANVAS">CANVAS</a>
</li>
<li class="class-depth-0">
<a href="global.html#CANVAS_FILTER">CANVAS_FILTER</a>
</li>
<li class="class-depth-0">
<a href="global.html#CIRCLE">CIRCLE</a>
</li>
<li class="class-depth-0">
<a href="global.html#CREATURE">CREATURE</a>
</li>
<li class="class-depth-0">
<a href="global.html#DOWN">DOWN</a>
</li>
<li class="class-depth-0">
<a href="global.html#ELLIPSE">ELLIPSE</a>
</li>
<li class="class-depth-0">
<a href="global.html#EMITTER">EMITTER</a>
</li>
<li class="class-depth-0">
<a href="global.html#GAMES">GAMES</a>
</li>
<li class="class-depth-0">
<a href="global.html#GRAPHICS">GRAPHICS</a>
</li>
<li class="class-depth-0">
<a href="global.html#GROUP">GROUP</a>
</li>
<li class="class-depth-0">
<a href="global.html#HEADLESS">HEADLESS</a>
</li>
<li class="class-depth-0">
<a href="global.html#IMAGE">IMAGE</a>
</li>
<li class="class-depth-0">
<a href="global.html#LEFT">LEFT</a>
</li>
<li class="class-depth-0">
<a href="global.html#LINE">LINE</a>
</li>
<li class="class-depth-0">
<a href="global.html#MATRIX">MATRIX</a>
</li>
<li class="class-depth-0">
<a href="global.html#NONE">NONE</a>
</li>
<li class="class-depth-0">
<a href="global.html#PENDING_ATLAS">PENDING_ATLAS</a>
</li>
<li class="class-depth-0">
<a href="global.html#POINT">POINT</a>
</li>
<li class="class-depth-0">
<a href="global.html#POINTER">POINTER</a>
</li>
<li class="class-depth-0">
<a href="global.html#POLYGON">POLYGON</a>
</li>
<li class="class-depth-0">
<a href="global.html#RECTANGLE">RECTANGLE</a>
</li>
<li class="class-depth-0">
<a href="global.html#RENDERTEXTURE">RENDERTEXTURE</a>
</li>
<li class="class-depth-0">
<a href="global.html#RETROFONT">RETROFONT</a>
</li>
<li class="class-depth-0">
<a href="global.html#RIGHT">RIGHT</a>
</li>
<li class="class-depth-0">
<a href="global.html#ROPE">ROPE</a>
</li>
<li class="class-depth-0">
<a href="global.html#ROUNDEDRECTANGLE">ROUNDEDRECTANGLE</a>
</li>
<li class="class-depth-0">
<a href="global.html#scaleModes">scaleModes</a>
</li>
<li class="class-depth-0">
<a href="global.html#SPRITE">SPRITE</a>
</li>
<li class="class-depth-0">
<a href="global.html#SPRITEBATCH">SPRITEBATCH</a>
</li>
<li class="class-depth-0">
<a href="global.html#TEXT">TEXT</a>
</li>
<li class="class-depth-0">
<a href="global.html#TILEMAP">TILEMAP</a>
</li>
<li class="class-depth-0">
<a href="global.html#TILEMAPLAYER">TILEMAPLAYER</a>
</li>
<li class="class-depth-0">
<a href="global.html#TILESPRITE">TILESPRITE</a>
</li>
<li class="class-depth-0">
<a href="global.html#UP">UP</a>
</li>
<li class="class-depth-0">
<a href="global.html#VERSION">VERSION</a>
</li>
<li class="class-depth-0">
<a href="global.html#VIDEO">VIDEO</a>
</li>
<li class="class-depth-0">
<a href="global.html#WEBGL">WEBGL</a>
</li>
<li class="class-depth-0">
<a href="global.html#WEBGL_FILTER">WEBGL_FILTER</a>
</li>
</ul>
</li>
<li class="dropdown">
<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.Game.html">Game</a></li>
<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.Cache.html">Cache</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.Input.html">Input Manager</a></li>
<li class="class-depth-1"><a href="Phaser.ScaleManager.html">Scale Manager</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Game Objects<b class="caret"></b></a>
<ul class="dropdown-menu ">
<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.Video.html">Video</a></li>
<li class="class-depth-1"><a href="Phaser.Particles.Arcade.Emitter.html">Particle Emitter</a></li>
<li class="class-depth-1"><a href="Phaser.Particle.html">Particle</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.Ellipse.html">Ellipse</a></li>
<li class="class-depth-1"><a href="Phaser.Line.html">Line</a></li>
<li class="class-depth-1"><a href="Phaser.Matrix.html">Matrix</a></li>
<li class="class-depth-1"><a href="Phaser.Point.html">Point</a></li>
<li class="class-depth-1"><a href="Phaser.Polygon.html">Polygon</a></li>
<li class="class-depth-1"><a href="Phaser.Rectangle.html">Rectangle</a></li>
<li class="class-depth-1"><a href="Phaser.RoundedRectangle.html">Rounded Rectangle</a></li>
</ul>
</li>
<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>
</ul>
</li>
<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.DeviceButton.html">Device Button</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="http://phaser.io">Phaser Web Site</a></li>
<li class="class-depth-1"><a href="https://github.com/photonstorm/phaser">Phaser Github</a></li>
<li class="class-depth-1"><a href="http://phaser.io/examples">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="http://phaser.io/learn">Tutorials</a></li>
<li class="class-depth-1"><a href="http://phaser.io/community/newsletter">Newsletter</a></li>
<li class="class-depth-1"><a href="http://phaser.io/community/twitter">Twitter</a></li>
<li class="class-depth-1"><a href="http://phaser.io/news/2015/08/phaser-slack-channel">Slack</a></li>
<li class="class-depth-1"><a href="https://www.codeandweb.com/texturepacker/phaser">Texture Packer</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span8">
<div id="main">
<!--<h1 class="page-title">Class: Sound</h1>-->
<section>
<header>
<h2>
<span class="ancestors"><a href="Phaser.html">Phaser</a>.</span>
Sound
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<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>
</dt>
<dd>
<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">
&lt;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">
&lt;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>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-17">line 17</a>
</dt>
</dl>
</dd>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name "
id="allowMultiple"><span class="type-signature"></span>allowMultiple<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<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>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-149">line 149</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="autoplay"><span class="type-signature"></span>autoplay<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>Boolean indicating whether the sound should start automatically.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-62">line 62</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="context"><span class="type-signature"></span>context<span class="type-signature"> :AudioContext</span></h4>
</dt>
<dd>
<div class="description">
<p>Reference to the AudioContext instance.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-57">line 57</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="currentMarker"><span class="type-signature"></span>currentMarker<span class="type-signature"> :string</span></h4>
</dt>
<dd>
<div class="description">
<p>The string ID of the currently playing marker, if any.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-126">line 126</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="currentTime"><span class="type-signature"></span>currentTime<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The current time the sound is at.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-78">line 78</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="duration"><span class="type-signature"></span>duration<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The duration of the current sound marker in seconds.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-83">line 83</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="durationMS"><span class="type-signature"></span>durationMS<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The duration of the current sound marker in ms.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-88">line 88</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="externalNode"><span class="type-signature"></span>externalNode<span class="type-signature"> :object</span></h4>
</dt>
<dd>
<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>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-165">line 165</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="fadeTween"><span class="type-signature"></span>fadeTween<span class="type-signature"> :<a href="Phaser.Tween.html">Phaser.Tween</a></span></h4>
</dt>
<dd>
<div class="description">
<p>The tween that fades the audio, set via Sound.fadeIn and Sound.fadeOut.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-131">line 131</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="gainNode"><span class="type-signature"></span>gainNode<span class="type-signature"> :object</span></h4>
</dt>
<dd>
<div class="description">
<p>The gain node in a Web Audio system.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-175">line 175</a>
</dt>
</dl>
</dd>
<dt>
<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>
</dt>
<dd>
<div class="description">
<p>A reference to the currently running Game.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-27">line 27</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="isDecoded"><span class="type-signature">&lt;readonly> </span>isDecoded<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns true if the sound file has decoded.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-1088">line 1088</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="isDecoding"><span class="type-signature">&lt;readonly> </span>isDecoding<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns true if the sound file is still decoding.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-1075">line 1075</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="isPlaying"><span class="type-signature"></span>isPlaying<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>true if the sound is currently playing, otherwise false.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-120">line 120</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="key"><span class="type-signature"></span>key<span class="type-signature"> :string</span></h4>
</dt>
<dd>
<div class="description">
<p>Asset key for the sound.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-37">line 37</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="loop"><span class="type-signature"></span>loop<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>Whether or not the sound or current sound marker will loop.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-42">line 42</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="markers"><span class="type-signature"></span>markers<span class="type-signature"> :object</span></h4>
</dt>
<dd>
<div class="description">
<p>The sound markers.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-52">line 52</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="masterGainNode"><span class="type-signature"></span>masterGainNode<span class="type-signature"> :object</span></h4>
</dt>
<dd>
<div class="description">
<p>The master gain node in a Web Audio system.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-170">line 170</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="mute"><span class="type-signature"></span>mute<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>Gets or sets the muted state of this sound.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-1101">line 1101</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="name"><span class="type-signature"></span>name<span class="type-signature"> :string</span></h4>
</dt>
<dd>
<div class="description">
<p>Name of the sound.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-32">line 32</a>
</dt>
</dl>
</dd>
<dt>
<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>
</dt>
<dd>
<div class="description">
<p>The onDecoded event is dispatched when the sound has finished decoding (typically for mp3 files)</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-225">line 225</a>
</dt>
</dl>
</dd>
<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>
<div class="description">
<p>The onFadeComplete event is dispatched when this sound finishes fading either in or out.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-265">line 265</a>
</dt>
</dl>
</dd>
<dt>
<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>
</dt>
<dd>
<div class="description">
<p>The onLoop event is dispatched when this sound loops during playback.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-245">line 245</a>
</dt>
</dl>
</dd>
<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>
<div class="description">
<p>The onMarkerComplete event is dispatched when a marker within this sound completes playback.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-260">line 260</a>
</dt>
</dl>
</dd>
<dt>
<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>
</dt>
<dd>
<div class="description">
<p>The onMouse event is dispatched when this sound is muted.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-255">line 255</a>
</dt>
</dl>
</dd>
<dt>
<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>
</dt>
<dd>
<div class="description">
<p>The onPause event is dispatched when this sound is paused.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-235">line 235</a>
</dt>
</dl>
</dd>
<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>
<div class="description">
<p>The onPlay event is dispatched each time this sound is played.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-230">line 230</a>
</dt>
</dl>
</dd>
<dt>
<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>
</dt>
<dd>
<div class="description">
<p>The onResume event is dispatched when this sound is resumed from a paused state.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-240">line 240</a>
</dt>
</dl>
</dd>
<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>
<div class="description">
<p>The onStop event is dispatched when this sound stops playback.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-250">line 250</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="override"><span class="type-signature"></span>override<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>if true when you play this sound it will always start from the beginning.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-143">line 143</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="paused"><span class="type-signature"></span>paused<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>true if the sound is paused, otherwise false.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-104">line 104</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="pausedPosition"><span class="type-signature"></span>pausedPosition<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The position the sound had reached when it was paused.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-109">line 109</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="pausedTime"><span class="type-signature"></span>pausedTime<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The game time at which the sound was paused.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-114">line 114</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="pendingPlayback"><span class="type-signature">&lt;readonly> </span>pendingPlayback<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>true if the sound file is pending playback</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-137">line 137</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="position"><span class="type-signature"></span>position<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The position of the current sound marker.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-93">line 93</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="startTime"><span class="type-signature"></span>startTime<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The time the Sound starts at (typically 0 unless starting from a marker)</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-73">line 73</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="stopTime"><span class="type-signature"></span>stopTime<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The time the sound stopped.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-98">line 98</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="totalDuration"><span class="type-signature"></span>totalDuration<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The total duration of the sound in seconds.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-67">line 67</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="usingAudioTag"><span class="type-signature"></span>usingAudioTag<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>true if the sound is being played via the Audio tag.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-160">line 160</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="usingWebAudio"><span class="type-signature">&lt;readonly> </span>usingWebAudio<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>true if this sound is being played with Web Audio.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-155">line 155</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="volume"><span class="type-signature">&lt;readonly> </span>volume<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>Gets or sets the volume of this sound, a value between 0 and 1.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-1156">line 1156</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="volume"><span class="type-signature"></span>volume<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The sound or sound marker volume. A value between 0 (silence) and 1 (full volume).</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-47">line 47</a>
</dt>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<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>
</dt>
<dd>
<div class="description">
<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>
</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>name</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>A unique name for this marker, i.e. 'explosion', 'gunshot', etc.</p></td>
</tr>
<tr>
<td class="name"><code>start</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<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>
</tr>
<tr>
<td class="name"><code>duration</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The duration of the marker in seconds. 2.5 = 2500ms, 0.5 = 500ms, etc.</p></td>
</tr>
<tr>
<td class="name"><code>volume</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<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>
</tr>
<tr>
<td class="name"><code>loop</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>Sets if the sound will loop or not.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-353">line 353</a>
</dt>
</dl>
</dd>
<dt>
<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>
</dt>
<dd>
<div class="description">
<p>Destroys this sound and all associated events and removes it from the SoundManager.</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>remove</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>If true this Sound is automatically removed from the SoundManager.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-1036">line 1036</a>
</dt>
</dl>
</dd>
<dt>
<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 class="optional">marker</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<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.</p>
<p>At the end of the fade Sound.onFadeComplete is dispatched with this Sound object as the first parameter,
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">
&lt;optional><br>
</td>
<td class="default">
1000
</td>
<td class="description last"><p>The time in milliseconds over which the Sound should fade in.</p></td>
</tr>
<tr>
<td class="name"><code>loop</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;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>
<tr>
<td class="name"><code>marker</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
(current marker)
</td>
<td class="description last"><p>The marker to start at; defaults to the current (last played) marker. To start playing from the beginning specify specify a marker of <code>''</code>.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-925">line 925</a>
</dt>
</dl>
</dd>
<dt>
<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>
</dt>
<dd>
<div class="description">
<p>Decreases the volume of this Sound from its current value to 0 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 (0) 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">
&lt;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>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-953">line 953</a>
</dt>
</dl>
</dd>
<dt>
<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>
</dt>
<dd>
<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>
<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">
&lt;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>
<tr>
<td class="name"><code>volume</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;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>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-967">line 967</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="loopFull"><span class="type-signature"></span>loopFull<span class="signature">(<span class="optional">volume</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Sound.html">Phaser.Sound</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Loops this entire sound. If you need to loop a section of it then use Sound.play and the marker and loop parameters.</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>volume</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
1
</td>
<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>
</tr>
</tbody>
</table>
<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>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-495">line 495</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="onEndedHandler"><span class="type-signature">&lt;internal> </span>onEndedHandler<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Called automatically by the AudioContext when the sound stops playing.
Doesn't get called if the sound is set to loop or is a section of an Audio Sprite.</p>
</div>
<dl class="details">
<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>
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-392">line 392</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="pause"><span class="type-signature"></span>pause<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Pauses the sound.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-764">line 764</a>
</dt>
</dl>
</dd>
<dt>
<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"> &rarr; {<a href="Phaser.Sound.html">Phaser.Sound</a>}</span></h4>
</dt>
<dd>
<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">
&lt;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">
&lt;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">
&lt;optional><br>
</td>
<td class="default">
1
</td>
<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>
</tr>
<tr>
<td class="name"><code>loop</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>Loop when finished playing? If not using a marker / audio sprite the looping will be done via the WebAudio loop property, otherwise it's time based.</p></td>
</tr>
<tr>
<td class="name"><code>forceRestart</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;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>
<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>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-508">line 508</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="removeMarker"><span class="type-signature"></span>removeMarker<span class="signature">(name)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<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>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-381">line 381</a>
</dt>
</dl>
</dd>
<dt>
<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>
</dt>
<dd>
<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">
&lt;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">
&lt;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">
&lt;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">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>Loop when it finished playing?</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-744">line 744</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="resume"><span class="type-signature"></span>resume<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Resumes the sound.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-783">line 783</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="soundHasUnlocked"><span class="type-signature">&lt;internal> </span>soundHasUnlocked<span class="signature">(key)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<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>
<td class="description last"><p>The Phaser.Cache key of the sound file to check for decoding.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<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>
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-337">line 337</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="stop"><span class="type-signature"></span>stop<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Stop playing this sound.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-859">line 859</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="update"><span class="type-signature">&lt;internal> </span>update<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Called automatically by Phaser.SoundManager.</p>
</div>
<dl class="details">
<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>
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-408">line 408</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="updateGlobalVolume"><span class="type-signature">&lt;internal> </span>updateGlobalVolume<span class="signature">(globalVolume)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Called automatically by SoundManager.volume.</p>
<p>Sets the volume of AudioTag Sounds as a percentage of the Global Volume.</p>
<p>You should not normally call this directly.</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>globalVolume</code></td>
<td class="type">
<span class="param-type">float</span>
</td>
<td class="description last"><p>The global SoundManager volume.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<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>
<dt class="tag-source">Source -
<a href="src_sound_Sound.js.html">sound/Sound.js</a>, <a href="src_sound_Sound.js.html#sunlight-1-line-1014">line 1014</a>
</dt>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
Phaser Copyright © 2012-2016 Photon Storm Ltd.
</span>
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a>
on Thu May 19 2016 12:35:45 GMT+0100 (GMT Daylight Time) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</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( {
anchorName : function(i, heading, prefix) {
return $(heading).attr("id") || ( prefix + i );
},
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>
Reference in a new issue View git blame Copy permalink