2013-10-03 00:21:08 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > Phaser Source: sound/Sound.js< / title >
<!-- [if lt IE 9]>
< script src = "//html5shiv.googlecode.com/svn/trunk/html5.js" > < / script >
<![endif]-->
< 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 class = "navbar-inner" >
< a class = "brand" href = "index.html" > Phaser< / a >
< ul class = "nav" >
< 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 " >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.html" > Phaser< / a >
2013-10-03 00:21:08 +00:00
< / 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 >
< a href = "Phaser.Animation.html" > Animation< / a >
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.AnimationManager.html" > AnimationManager< / a >
2013-10-03 00:21:08 +00:00
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.AnimationParser.html" > AnimationParser< / a >
2013-10-03 00:21:08 +00:00
< / li >
2013-11-28 15:57:09 +00:00
< li >
< a href = "Phaser.BitmapData.html" > BitmapData< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.BitmapText.html" > BitmapText< / a >
< / li >
< li >
< a href = "Phaser.Button.html" > Button< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Cache.html" > Cache< / a >
2013-10-03 00:21:08 +00:00
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Camera.html" > Camera< / a >
2013-10-03 00:21:08 +00:00
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Canvas.html" > Canvas< / a >
2013-10-03 00:21:08 +00:00
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Circle.html" > Circle< / a >
2013-10-03 00:21:08 +00:00
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Color.html" > Color< / a >
2013-10-03 00:21:08 +00:00
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Device.html" > Device< / a >
2013-10-03 00:21:08 +00:00
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.html" > Easing< / a >
< / li >
< li >
< a href = "Phaser.Easing.Back.html" > Back< / a >
< / li >
< li >
< a href = "Phaser.Easing.Bounce.html" > Bounce< / a >
< / li >
< li >
< a href = "Phaser.Easing.Circular.html" > Circular< / a >
< / li >
< li >
< a href = "Phaser.Easing.Cubic.html" > Cubic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Elastic.html" > Elastic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Exponential.html" > Exponential< / a >
< / li >
< li >
< a href = "Phaser.Easing.Linear.html" > Linear< / a >
< / li >
< li >
< a href = "Phaser.Easing.Quadratic.html" > Quadratic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Quartic.html" > Quartic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Quintic.html" > Quintic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Sinusoidal.html" > Sinusoidal< / a >
< / li >
2014-02-18 03:01:51 +00:00
< li >
< a href = "Phaser.Ellipse.html" > Ellipse< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Events.html" > Events< / a >
< / li >
2013-11-28 15:57:09 +00:00
< li >
< a href = "Phaser.Filter.html" > Filter< / a >
< / li >
2013-10-03 01:38:35 +00:00
< li >
< a href = "Phaser.Frame.html" > Frame< / a >
< / li >
< li >
< a href = "Phaser.FrameData.html" > FrameData< / a >
2013-10-03 00:21:08 +00:00
< / li >
< li >
< a href = "Phaser.Game.html" > Game< / a >
< / li >
2014-02-21 15:37:26 +00:00
< li >
< a href = "Phaser.GameObjectCreator.html" > GameObjectCreator< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.GameObjectFactory.html" > GameObjectFactory< / a >
< / li >
2014-02-05 06:29:17 +00:00
< li >
< a href = "Phaser.Gamepad.html" > Gamepad< / a >
< / li >
< li >
< a href = "Phaser.GamepadButton.html" > GamepadButton< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Graphics.html" > Graphics< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.Group.html" > Group< / a >
< / li >
2014-02-08 07:24:22 +00:00
< li >
< a href = "Phaser.Image.html" > Image< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.Input.html" > Input< / a >
< / li >
< li >
< a href = "Phaser.InputHandler.html" > InputHandler< / a >
< / li >
< li >
< a href = "Phaser.Key.html" > Key< / a >
< / li >
< li >
< a href = "Phaser.Keyboard.html" > Keyboard< / a >
< / li >
2014-02-05 06:29:17 +00:00
< li >
< a href = "Phaser.Line.html" > Line< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.LinkedList.html" > LinkedList< / a >
< / li >
< li >
< a href = "Phaser.Loader.html" > Loader< / a >
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.LoaderParser.html" > LoaderParser< / a >
2013-10-03 00:21:08 +00:00
< / li >
< li >
< a href = "Phaser.Math.html" > Math< / a >
< / li >
< li >
< a href = "Phaser.Mouse.html" > Mouse< / a >
< / li >
< li >
< a href = "Phaser.MSPointer.html" > MSPointer< / a >
< / li >
< li >
< a href = "Phaser.Net.html" > Net< / a >
< / li >
< li >
< a href = "Phaser.Particles.html" > Particles< / a >
< / li >
< li >
< a href = "Phaser.Particles.Arcade.Emitter.html" > Emitter< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Physics.html" > Physics< / a >
< / li >
< li >
< a href = "Phaser.Physics.Arcade.html" > Arcade< / a >
< / li >
2014-02-21 15:37:26 +00:00
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Arcade.Body.html" > Body< / a >
< / li >
< li >
< a href = "Phaser.Physics.Ninja.html" > Ninja< / a >
< / li >
< li >
< a href = "Phaser.Physics.Ninja.AABB.html" > AABB< / a >
< / li >
< li >
< a href = "Phaser.Physics.Ninja.Body.html" > Body< / a >
< / li >
< li >
< a href = "Phaser.Physics.Ninja.Circle.html" > Circle< / a >
< / li >
< li >
< a href = "Phaser.Physics.Ninja.Tile.html" > Tile< / a >
< / li >
< li >
< a href = "Phaser.Physics.P2.html" > P2< / a >
2014-02-21 15:37:26 +00:00
< / li >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.Body.html" > Body< / a >
2014-02-21 15:37:26 +00:00
< / li >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.BodyDebug.html" > BodyDebug< / a >
2014-02-21 15:37:26 +00:00
< / li >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.CollisionGroup.html" > CollisionGroup< / a >
2014-02-21 15:37:26 +00:00
< / li >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.ContactMaterial.html" > ContactMaterial< / a >
2014-02-21 15:37:26 +00:00
< / li >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.DistanceConstraint.html" > DistanceConstraint< / a >
2014-02-21 15:37:26 +00:00
< / li >
< li >
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 >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.InversePointProxy.html" > InversePointProxy< / a >
< / li >
< li >
< a href = "Phaser.Physics.P2.LockConstraint.html" > LockConstraint< / a >
< / li >
< li >
< a href = "Phaser.Physics.P2.Material.html" > Material< / a >
< / li >
< li >
< a href = "Phaser.Physics.P2.PointProxy.html" > PointProxy< / a >
< / li >
< li >
< a href = "Phaser.Physics.P2.PrismaticConstraint.html" > PrismaticConstraint< / a >
< / li >
< li >
< a href = "Phaser.Physics.P2.RevoluteConstraint.html" > RevoluteConstraint< / a >
< / li >
< li >
< a href = "Phaser.Physics.P2.Spring.html" > Spring< / a >
2014-02-21 15:37:26 +00:00
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.Plugin.html" > Plugin< / a >
< / li >
< li >
< a href = "Phaser.PluginManager.html" > PluginManager< / a >
< / li >
< li >
< a href = "Phaser.Point.html" > Point< / a >
< / li >
< li >
< a href = "Phaser.Pointer.html" > Pointer< / a >
< / li >
2013-11-07 06:10:15 +00:00
< li >
< a href = "Phaser.Polygon.html" > Polygon< / a >
< / li >
2014-03-14 06:36:05 +00:00
< li >
< a href = "Phaser.QuadTree.html" > QuadTree< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.RandomDataGenerator.html" > RandomDataGenerator< / a >
< / li >
< li >
< a href = "Phaser.Rectangle.html" > Rectangle< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.RenderTexture.html" > RenderTexture< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.RequestAnimationFrame.html" > RequestAnimationFrame< / a >
< / li >
2014-03-14 06:36:05 +00:00
< li >
< a href = "Phaser.RetroFont.html" > RetroFont< / a >
< / li >
< li >
< a href = "Phaser.ScaleManager.html" > ScaleManager< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.Signal.html" > Signal< / a >
< / li >
2014-02-05 06:29:17 +00:00
< li >
< a href = "Phaser.SinglePad.html" > SinglePad< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.Sound.html" > Sound< / a >
< / li >
< li >
< a href = "Phaser.SoundManager.html" > SoundManager< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Sprite.html" > Sprite< / a >
< / li >
2014-02-18 03:01:51 +00:00
< li >
< a href = "Phaser.SpriteBatch.html" > SpriteBatch< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.Stage.html" > Stage< / a >
< / li >
< li >
< a href = "Phaser.State.html" > State< / a >
< / li >
< li >
< a href = "Phaser.StateManager.html" > StateManager< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Text.html" > Text< / a >
< / li >
2013-11-28 15:57:09 +00:00
< li >
< a href = "Phaser.Tile.html" > Tile< / a >
< / li >
< li >
< a href = "Phaser.Tilemap.html" > Tilemap< / a >
< / li >
< li >
< a href = "Phaser.TilemapLayer.html" > TilemapLayer< / a >
< / li >
< li >
< a href = "Phaser.TilemapParser.html" > TilemapParser< / a >
< / li >
< li >
< a href = "Phaser.Tileset.html" > Tileset< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.TileSprite.html" > TileSprite< / a >
< / li >
2013-10-03 01:38:35 +00:00
< li >
< a href = "Phaser.Time.html" > Time< / a >
< / li >
2013-11-28 15:57:09 +00:00
< li >
< a href = "Phaser.Timer.html" > Timer< / a >
< / li >
2014-02-05 06:29:17 +00:00
< li >
< a href = "Phaser.TimerEvent.html" > TimerEvent< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.Touch.html" > Touch< / a >
< / li >
2013-10-03 01:38:35 +00:00
< li >
< a href = "Phaser.Tween.html" > Tween< / a >
< / li >
< li >
< a href = "Phaser.TweenManager.html" > TweenManager< / a >
< / li >
< li >
< a href = "Phaser.Utils.html" > Utils< / a >
< / li >
< li >
< a href = "Phaser.Utils.Debug.html" > Debug< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.World.html" > World< / a >
< / li >
< li >
< a href = "SignalBinding.html" > SignalBinding< / a >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< / div >
< div class = "row-fluid" >
< div class = "span12" >
< div id = "main" >
< h1 class = "page-title" > Source: sound/Sound.js< / h1 >
< section >
< article >
< pre class = "sunlight-highlight-javascript linenums" > /**
* @author Richard Davey < rich@photonstorm.com>
2014-02-05 06:29:17 +00:00
* @copyright 2014 Photon Storm Ltd.
2013-10-03 00:21:08 +00:00
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
/**
* The Sound class constructor.
*
* @class Phaser.Sound
* @classdesc The Sound class
* @constructor
* @param {Phaser.Game} game - Reference to the current game instance.
* @param {string} key - Asset key for the sound.
* @param {number} [volume=1] - Default value for the volume, between 0 and 1.
* @param {boolean} [loop=false] - Whether or not the sound will loop.
*/
2013-11-28 15:57:09 +00:00
Phaser.Sound = function (game, key, volume, loop, connect) {
2014-03-28 01:42:49 +00:00
2013-11-28 15:57:09 +00:00
if (typeof volume == 'undefined') { volume = 1; }
if (typeof loop == 'undefined') { loop = false; }
if (typeof connect === 'undefined') { connect = game.sound.connectToMaster; }
2013-10-03 00:21:08 +00:00
/**
* A reference to the currently running Game.
* @property {Phaser.Game} game
*/
this.game = game;
/**
2013-11-28 15:57:09 +00:00
* @property {string} name - Name of the sound.
2013-10-03 00:21:08 +00:00
*/
this.name = key;
/**
2013-11-28 15:57:09 +00:00
* @property {string} key - Asset key for the sound.
2013-10-03 00:21:08 +00:00
*/
this.key = key;
/**
2013-11-28 15:57:09 +00:00
* @property {boolean} loop - Whether or not the sound will loop.
2013-10-03 00:21:08 +00:00
*/
this.loop = loop;
/**
2013-11-28 15:57:09 +00:00
* @property {number} _volume - The global audio volume. A value between 0 (silence) and 1 (full volume).
2013-10-03 00:21:08 +00:00
* @private
*/
this._volume = volume;
/**
2013-11-28 15:57:09 +00:00
* @property {object} markers - The sound markers.
2013-10-03 00:21:08 +00:00
*/
this.markers = {};
2014-03-28 01:42:49 +00:00
2013-10-03 00:21:08 +00:00
/**
2013-11-28 15:57:09 +00:00
* @property {AudioContext} context - Reference to the AudioContext instance.
2013-10-03 00:21:08 +00:00
*/
this.context = null;
/**
2013-11-28 15:57:09 +00:00
* @property {Description} _buffer - Decoded data buffer / Audio tag.
2013-10-03 00:21:08 +00:00
* @private
*/
this._buffer = null;
/**
2013-11-28 15:57:09 +00:00
* @property {boolean} _muted - Boolean indicating whether the sound is muted or not.
2013-10-03 00:21:08 +00:00
* @private
* @default
*/
this._muted = false;
/**
2013-11-28 15:57:09 +00:00
* @property {boolean} autoplay - Boolean indicating whether the sound should start automatically.
2013-10-03 00:21:08 +00:00
*/
this.autoplay = false;
/**
2013-11-28 15:57:09 +00:00
* @property {number} totalDuration - The total duration of the sound, in milliseconds
2013-10-03 00:21:08 +00:00
*/
this.totalDuration = 0;
2014-03-28 01:42:49 +00:00
2013-10-03 00:21:08 +00:00
/**
2013-11-28 15:57:09 +00:00
* @property {number} startTime - The time the Sound starts at (typically 0 unless starting from a marker)
2013-10-03 00:21:08 +00:00
* @default
*/
this.startTime = 0;
2014-03-28 01:42:49 +00:00
2013-10-03 00:21:08 +00:00
/**
2013-11-28 15:57:09 +00:00
* @property {number} currentTime - The current time the sound is at.
2013-10-03 00:21:08 +00:00
*/
this.currentTime = 0;
2014-03-28 01:42:49 +00:00
2013-10-03 00:21:08 +00:00
/**
2013-11-28 15:57:09 +00:00
* @property {number} duration - The duration of the sound.
2013-10-03 00:21:08 +00:00
*/
this.duration = 0;
2014-03-28 01:42:49 +00:00
2013-10-03 00:21:08 +00:00
/**
2013-11-28 15:57:09 +00:00
* @property {number} stopTime - The time the sound stopped.
2013-10-03 00:21:08 +00:00
*/
this.stopTime = 0;
2014-03-28 01:42:49 +00:00
2013-10-03 00:21:08 +00:00
/**
2013-11-28 15:57:09 +00:00
* @property {boolean} paused - true if the sound is paused, otherwise false.
2013-10-03 00:21:08 +00:00
* @default
*/
this.paused = false;
2014-03-28 01:42:49 +00:00
2013-10-25 15:54:40 +00:00
/**
2013-11-28 15:57:09 +00:00
* @property {number} pausedPosition - The position the sound had reached when it was paused.
2013-10-25 15:54:40 +00:00
*/
this.pausedPosition = 0;
/**
2013-11-28 15:57:09 +00:00
* @property {number} pausedTime - The game time at which the sound was paused.
2013-10-25 15:54:40 +00:00
*/
this.pausedTime = 0;
2013-10-03 00:21:08 +00:00
/**
2013-11-28 15:57:09 +00:00
* @property {boolean} isPlaying - true if the sound is currently playing, otherwise false.
2013-10-03 00:21:08 +00:00
* @default
*/
this.isPlaying = false;
2014-03-28 01:42:49 +00:00
2013-10-03 00:21:08 +00:00
/**
2013-11-28 15:57:09 +00:00
* @property {string} currentMarker - The string ID of the currently playing marker, if any.
2013-10-03 00:21:08 +00:00
* @default
*/
this.currentMarker = '';
2014-03-28 01:42:49 +00:00
2013-10-03 00:21:08 +00:00
/**
2013-11-28 15:57:09 +00:00
* @property {boolean} pendingPlayback - true if the sound file is pending playback
* @readonly
2013-10-03 00:21:08 +00:00
*/
this.pendingPlayback = false;
2014-03-28 01:42:49 +00:00
2013-10-03 00:21:08 +00:00
/**
2013-11-28 15:57:09 +00:00
* @property {boolean} override - if true when you play this sound it will always start from the beginning.
2013-10-03 00:21:08 +00:00
* @default
*/
this.override = false;
2014-03-28 01:42:49 +00:00
2013-10-03 00:21:08 +00:00
/**
2013-11-28 15:57:09 +00:00
* @property {boolean} usingWebAudio - true if this sound is being played with Web Audio.
* @readonly
2013-10-03 00:21:08 +00:00
*/
this.usingWebAudio = this.game.sound.usingWebAudio;
2014-03-28 01:42:49 +00:00
2013-10-03 00:21:08 +00:00
/**
2013-11-28 15:57:09 +00:00
* @property {boolean} usingAudioTag - true if the sound is being played via the Audio tag.
2013-10-03 00:21:08 +00:00
*/
this.usingAudioTag = this.game.sound.usingAudioTag;
2013-11-28 15:57:09 +00:00
/**
* @property {object} externalNode - If defined this Sound won't connect to the SoundManager master gain node, but will instead connect to externalNode.input.
*/
this.externalNode = null;
2013-10-03 00:21:08 +00:00
if (this.usingWebAudio)
{
this.context = this.game.sound.context;
this.masterGainNode = this.game.sound.masterGain;
if (typeof this.context.createGain === 'undefined')
{
this.gainNode = this.context.createGainNode();
}
else
{
this.gainNode = this.context.createGain();
}
this.gainNode.gain.value = volume * this.game.sound.volume;
2013-11-28 15:57:09 +00:00
if (connect)
{
this.gainNode.connect(this.masterGainNode);
}
2013-10-03 00:21:08 +00:00
}
else
{
if (this.game.cache.getSound(key) & & this.game.cache.isSoundReady(key))
{
this._sound = this.game.cache.getSoundData(key);
this.totalDuration = 0;
if (this._sound.duration)
{
this.totalDuration = this._sound.duration;
}
}
else
{
this.game.cache.onSoundUnlock.add(this.soundHasUnlocked, this);
}
}
/**
2013-11-28 15:57:09 +00:00
* @property {Phaser.Signal} onDecoded - The onDecoded event is dispatched when the sound has finished decoding (typically for mp3 files)
2013-10-03 00:21:08 +00:00
*/
2013-11-28 15:57:09 +00:00
this.onDecoded = new Phaser.Signal();
2014-03-28 01:42:49 +00:00
2013-10-03 00:21:08 +00:00
/**
2013-11-28 15:57:09 +00:00
* @property {Phaser.Signal} onPlay - The onPlay event is dispatched each time this sound is played.
2013-10-03 00:21:08 +00:00
*/
2013-11-28 15:57:09 +00:00
this.onPlay = new Phaser.Signal();
2014-03-28 01:42:49 +00:00
2013-10-03 00:21:08 +00:00
/**
2013-11-28 15:57:09 +00:00
* @property {Phaser.Signal} onPause - The onPause event is dispatched when this sound is paused.
2013-10-03 00:21:08 +00:00
*/
2013-11-28 15:57:09 +00:00
this.onPause = new Phaser.Signal();
2014-03-28 01:42:49 +00:00
2013-10-03 00:21:08 +00:00
/**
2013-11-28 15:57:09 +00:00
* @property {Phaser.Signal} onResume - The onResume event is dispatched when this sound is resumed from a paused state.
2013-10-03 00:21:08 +00:00
*/
2013-11-28 15:57:09 +00:00
this.onResume = new Phaser.Signal();
2014-03-28 01:42:49 +00:00
2013-10-03 00:21:08 +00:00
/**
2013-11-28 15:57:09 +00:00
* @property {Phaser.Signal} onLoop - The onLoop event is dispatched when this sound loops during playback.
2013-10-03 00:21:08 +00:00
*/
2013-11-28 15:57:09 +00:00
this.onLoop = new Phaser.Signal();
2014-03-28 01:42:49 +00:00
2013-10-03 00:21:08 +00:00
/**
2013-11-28 15:57:09 +00:00
* @property {Phaser.Signal} onStop - The onStop event is dispatched when this sound stops playback.
2013-10-03 00:21:08 +00:00
*/
2013-11-28 15:57:09 +00:00
this.onStop = new Phaser.Signal();
2014-03-28 01:42:49 +00:00
2013-10-03 00:21:08 +00:00
/**
2013-11-28 15:57:09 +00:00
* @property {Phaser.Signal} onMute - The onMouse event is dispatched when this sound is muted.
2013-10-03 00:21:08 +00:00
*/
2013-11-28 15:57:09 +00:00
this.onMute = new Phaser.Signal();
2014-03-28 01:42:49 +00:00
2013-10-03 00:21:08 +00:00
/**
2013-11-28 15:57:09 +00:00
* @property {Phaser.Signal} onMarkerComplete - The onMarkerComplete event is dispatched when a marker within this sound completes playback.
2013-10-03 00:21:08 +00:00
*/
2013-11-28 15:57:09 +00:00
this.onMarkerComplete = new Phaser.Signal();
2013-10-03 00:21:08 +00:00
};
Phaser.Sound.prototype = {
2013-11-28 15:57:09 +00:00
/**
2013-10-03 00:21:08 +00:00
* Called automatically when this sound is unlocked.
2013-11-28 15:57:09 +00:00
* @method Phaser.Sound#soundHasUnlocked
* @param {string} key - The Phaser.Cache key of the sound file to check for decoding.
2013-10-03 00:21:08 +00:00
* @protected
2013-11-28 15:57:09 +00:00
*/
2013-10-03 00:21:08 +00:00
soundHasUnlocked: function (key) {
if (key == this.key)
{
this._sound = this.game.cache.getSoundData(this.key);
this.totalDuration = this._sound.duration;
// console.log('sound has unlocked' + this._sound);
2013-11-28 15:57:09 +00:00
}
},
/**
* Description.
* @method Phaser.Sound#addMarker
* @param {string} name - Description.
* @param {Description} start - Description.
* @param {Description} stop - Description.
* @param {Description} volume - Description.
* @param {Description} loop - Description.
2013-10-03 00:21:08 +00:00
addMarker: function (name, start, stop, volume, loop) {
2013-11-28 15:57:09 +00:00
volume = volume || 1;
if (typeof loop == 'undefined') { loop = false; }
2013-10-03 00:21:08 +00:00
this.markers[name] = {
name: name,
start: start,
stop: stop,
volume: volume,
duration: stop - start,
loop: loop
};
},
*/
/**
* 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.
*
* @method Phaser.Sound#addMarker
* @param {string} name - A unique name for this marker, i.e. 'explosion', 'gunshot', etc.
* @param {number} start - The start point of this marker in the audio file, given in seconds. 2.5 = 2500ms, 0.5 = 500ms, etc.
* @param {number} duration - The duration of the marker in seconds. 2.5 = 2500ms, 0.5 = 500ms, etc.
* @param {number} [volume=1] - The volume the sound will play back at, between 0 (silent) and 1 (full volume).
* @param {boolean} [loop=false] - Sets if the sound will loop or not.
*/
addMarker: function (name, start, duration, volume, loop) {
2014-03-24 12:41:45 +00:00
if (typeof volume == 'undefined') { volume = 1; }
2013-10-03 00:21:08 +00:00
if (typeof loop == 'undefined') { loop = false; }
this.markers[name] = {
name: name,
start: start,
stop: start + duration,
volume: volume,
duration: duration,
durationMS: duration * 1000,
loop: loop
};
},
2013-11-28 15:57:09 +00:00
/**
* Removes a marker from the sound.
* @method Phaser.Sound#removeMarker
* @param {string} name - The key of the marker to remove.
*/
2013-10-03 00:21:08 +00:00
removeMarker: function (name) {
delete this.markers[name];
},
2013-11-28 15:57:09 +00:00
/**
* Called automatically by Phaser.SoundManager.
* @method Phaser.Sound#update
2013-10-03 00:21:08 +00:00
* @protected
2013-11-28 15:57:09 +00:00
*/
2013-10-03 00:21:08 +00:00
update: function () {
if (this.pendingPlayback & & this.game.cache.isSoundReady(this.key))
{
this.pendingPlayback = false;
this.play(this._tempMarker, this._tempPosition, this._tempVolume, this._tempLoop);
}
if (this.isPlaying)
{
this.currentTime = this.game.time.now - this.startTime;
if (this.currentTime >= this.durationMS)
{
2014-03-14 06:36:05 +00:00
// console.log(this.currentMarker, 'has hit duration');
2013-10-03 00:21:08 +00:00
if (this.usingWebAudio)
{
if (this.loop)
{
2014-02-05 06:29:17 +00:00
// console.log('loop1');
2013-10-03 00:21:08 +00:00
// won't work with markers, needs to reset the position
this.onLoop.dispatch(this);
2013-11-28 15:57:09 +00:00
if (this.currentMarker === '')
2013-10-03 00:21:08 +00:00
{
2014-02-05 06:29:17 +00:00
// console.log('loop2');
2013-10-03 00:21:08 +00:00
this.currentTime = 0;
this.startTime = this.game.time.now;
}
else
{
2014-02-05 06:29:17 +00:00
// console.log('loop3');
2014-03-14 06:36:05 +00:00
this.onMarkerComplete.dispatch(this.currentMarker, this);
2013-10-03 00:21:08 +00:00
this.play(this.currentMarker, 0, this.volume, true, true);
}
}
else
{
2014-02-05 06:29:17 +00:00
// console.log('stopping, no loop for marker');
2013-10-03 00:21:08 +00:00
this.stop();
}
}
else
{
if (this.loop)
{
this.onLoop.dispatch(this);
this.play(this.currentMarker, 0, this.volume, true, true);
}
else
{
this.stop();
}
}
}
}
},
2013-11-28 15:57:09 +00:00
/**
2013-10-03 00:21:08 +00:00
* Play this sound, or a marked section of it.
* @method Phaser.Sound#play
* @param {string} [marker=''] - If you want to play a marker then give the key here, otherwise leave blank to play the full sound.
* @param {number} [position=0] - The starting position to play the sound from - this is ignored if you provide a marker.
2013-11-28 15:57:09 +00:00
* @param {number} [volume=1] - 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).
2013-10-03 00:21:08 +00:00
* @param {boolean} [loop=false] - Loop when it finished playing?
* @param {boolean} [forceRestart=true] - If the sound is already playing you can set forceRestart to restart it from the beginning.
2013-11-28 15:57:09 +00:00
* @return {Phaser.Sound} This sound instance.
2013-10-03 00:21:08 +00:00
*/
play: function (marker, position, volume, loop, forceRestart) {
2014-03-24 12:41:45 +00:00
if (typeof marker === 'undefined') { marker = ''; }
2013-11-28 15:57:09 +00:00
if (typeof forceRestart === 'undefined') { forceRestart = true; }
2013-10-03 00:21:08 +00:00
2013-11-28 15:57:09 +00:00
if (this.isPlaying === true & & forceRestart === false & & this.override === false)
2013-10-03 00:21:08 +00:00
{
// Use Restart instead
return;
}
if (this.isPlaying & & this.override)
{
if (this.usingWebAudio)
{
if (typeof this._sound.stop === 'undefined')
{
this._sound.noteOff(0);
}
else
{
this._sound.stop(0);
}
}
else if (this.usingAudioTag)
{
this._sound.pause();
this._sound.currentTime = 0;
}
}
this.currentMarker = marker;
if (marker !== '')
{
if (this.markers[marker])
{
2014-03-24 12:41:45 +00:00
// Playing a marker? Then we default to the marker values
2013-10-03 00:21:08 +00:00
this.position = this.markers[marker].start;
this.volume = this.markers[marker].volume;
this.loop = this.markers[marker].loop;
this.duration = this.markers[marker].duration;
this.durationMS = this.markers[marker].durationMS;
2014-03-24 12:41:45 +00:00
if (typeof volume !== 'undefined')
{
this.volume = volume;
}
if (typeof loop !== 'undefined')
{
this.loop = loop;
}
2013-10-03 00:21:08 +00:00
this._tempMarker = marker;
this._tempPosition = this.position;
this._tempVolume = this.volume;
this._tempLoop = this.loop;
}
else
{
console.warn("Phaser.Sound.play: audio marker " + marker + " doesn't exist");
return;
}
}
else
{
2014-03-24 12:41:45 +00:00
position = position || 0;
if (typeof volume === 'undefined') { volume = this._volume; }
if (typeof loop === 'undefined') { loop = this.loop; }
2013-10-03 00:21:08 +00:00
this.position = position;
this.volume = volume;
this.loop = loop;
this.duration = 0;
this.durationMS = 0;
this._tempMarker = marker;
this._tempPosition = position;
this._tempVolume = volume;
this._tempLoop = loop;
}
if (this.usingWebAudio)
{
// Does the sound need decoding?
if (this.game.cache.isSoundDecoded(this.key))
{
// Do we need to do this every time we play? How about just if the buffer is empty?
if (this._buffer == null)
{
this._buffer = this.game.cache.getSoundData(this.key);
}
this._sound = this.context.createBufferSource();
this._sound.buffer = this._buffer;
2014-03-28 01:42:49 +00:00
2013-11-28 15:57:09 +00:00
if (this.externalNode)
{
this._sound.connect(this.externalNode.input);
}
else
{
this._sound.connect(this.gainNode);
}
2013-10-03 00:21:08 +00:00
this.totalDuration = this._sound.buffer.duration;
2013-11-28 15:57:09 +00:00
if (this.duration === 0)
2013-10-03 00:21:08 +00:00
{
// console.log('duration reset');
this.duration = this.totalDuration;
this.durationMS = this.totalDuration * 1000;
}
2013-11-28 15:57:09 +00:00
if (this.loop & & marker === '')
2013-10-03 00:21:08 +00:00
{
this._sound.loop = true;
}
// Useful to cache this somewhere perhaps?
if (typeof this._sound.start === 'undefined')
{
this._sound.noteGrainOn(0, this.position, this.duration);
// this._sound.noteGrainOn(0, this.position, this.duration / 1000);
//this._sound.noteOn(0); // the zero is vitally important, crashes iOS6 without it
2013-11-28 15:57:09 +00:00
}
else
{
2013-10-03 00:21:08 +00:00
// this._sound.start(0, this.position, this.duration / 1000);
this._sound.start(0, this.position, this.duration);
}
this.isPlaying = true;
this.startTime = this.game.time.now;
this.currentTime = 0;
this.stopTime = this.startTime + this.durationMS;
this.onPlay.dispatch(this);
2013-11-28 15:57:09 +00:00
}
else
{
2013-10-03 00:21:08 +00:00
this.pendingPlayback = true;
2013-11-28 15:57:09 +00:00
if (this.game.cache.getSound(this.key) & & this.game.cache.getSound(this.key).isDecoding === false)
2013-10-03 00:21:08 +00:00
{
this.game.sound.decode(this.key, this);
}
}
}
else
{
// console.log('Sound play Audio');
if (this.game.cache.getSound(this.key) & & this.game.cache.getSound(this.key).locked)
{
// console.log('tried playing locked sound, pending set, reload started');
this.game.cache.reloadSound(this.key);
this.pendingPlayback = true;
}
else
{
// console.log('sound not locked, state?', this._sound.readyState);
2014-02-05 06:29:17 +00:00
if (this._sound & & (this.game.device.cocoonJS || this._sound.readyState === 4))
2013-10-03 00:21:08 +00:00
{
this._sound.play();
// This doesn't become available until you call play(), wonderful ...
this.totalDuration = this._sound.duration;
2013-11-28 15:57:09 +00:00
if (this.duration === 0)
2013-10-03 00:21:08 +00:00
{
this.duration = this.totalDuration;
this.durationMS = this.totalDuration * 1000;
}
// console.log('playing', this._sound);
this._sound.currentTime = this.position;
this._sound.muted = this._muted;
2014-03-28 01:42:49 +00:00
2013-10-03 00:21:08 +00:00
if (this._muted)
{
this._sound.volume = 0;
}
else
{
this._sound.volume = this._volume;
}
this.isPlaying = true;
this.startTime = this.game.time.now;
this.currentTime = 0;
this.stopTime = this.startTime + this.durationMS;
this.onPlay.dispatch(this);
}
else
{
this.pendingPlayback = true;
}
}
}
},
/**
* Restart the sound, or a marked section of it.
* @method Phaser.Sound#restart
* @param {string} [marker=''] - If you want to play a marker then give the key here, otherwise leave blank to play the full sound.
* @param {number} [position=0] - The starting position to play the sound from - this is ignored if you provide a marker.
* @param {number} [volume=1] - Volume of the sound you want to play.
* @param {boolean} [loop=false] - Loop when it finished playing?
*/
restart: function (marker, position, volume, loop) {
2013-11-28 15:57:09 +00:00
marker = marker || '';
position = position || 0;
volume = volume || 1;
if (typeof loop == 'undefined') { loop = false; }
2013-10-03 00:21:08 +00:00
this.play(marker, position, volume, loop, true);
},
/**
* Pauses the sound
* @method Phaser.Sound#pause
*/
pause: function () {
if (this.isPlaying & & this._sound)
{
this.stop();
this.isPlaying = false;
this.paused = true;
2013-10-25 15:54:40 +00:00
this.pausedPosition = this.currentTime;
this.pausedTime = this.game.time.now;
2013-10-03 00:21:08 +00:00
this.onPause.dispatch(this);
}
},
2013-10-25 15:54:40 +00:00
2013-10-03 00:21:08 +00:00
/**
* Resumes the sound
* @method Phaser.Sound#resume
*/
resume: function () {
if (this.paused & & this._sound)
{
if (this.usingWebAudio)
{
2013-10-25 15:54:40 +00:00
var p = this.position + (this.pausedPosition / 1000);
this._sound = this.context.createBufferSource();
this._sound.buffer = this._buffer;
2014-02-05 06:29:17 +00:00
if (this.externalNode)
{
this._sound.connect(this.externalNode.input);
}
else
{
this._sound.connect(this.gainNode);
}
if (this.loop)
{
this._sound.loop = true;
}
2013-10-25 15:54:40 +00:00
2013-10-03 00:21:08 +00:00
if (typeof this._sound.start === 'undefined')
{
2013-10-25 15:54:40 +00:00
this._sound.noteGrainOn(0, p, this.duration);
2013-10-03 00:21:08 +00:00
//this._sound.noteOn(0); // the zero is vitally important, crashes iOS6 without it
2013-11-28 15:57:09 +00:00
}
else
{
2013-10-25 15:54:40 +00:00
this._sound.start(0, p, this.duration);
2013-10-03 00:21:08 +00:00
}
}
else
{
this._sound.play();
}
this.isPlaying = true;
this.paused = false;
2013-10-25 15:54:40 +00:00
this.startTime += (this.game.time.now - this.pausedTime);
2013-10-03 00:21:08 +00:00
this.onResume.dispatch(this);
}
},
2013-11-28 15:57:09 +00:00
/**
2013-10-03 00:21:08 +00:00
* Stop playing this sound.
* @method Phaser.Sound#stop
*/
stop: function () {
if (this.isPlaying & & this._sound)
{
if (this.usingWebAudio)
{
if (typeof this._sound.stop === 'undefined')
{
this._sound.noteOff(0);
}
else
{
this._sound.stop(0);
}
}
else if (this.usingAudioTag)
{
this._sound.pause();
this._sound.currentTime = 0;
}
}
this.isPlaying = false;
var prevMarker = this.currentMarker;
2014-03-28 01:42:49 +00:00
2014-03-14 06:36:05 +00:00
if (this.currentMarker !== '')
{
this.onMarkerComplete.dispatch(this.currentMarker, this);
}
2013-10-03 00:21:08 +00:00
this.currentMarker = '';
this.onStop.dispatch(this, prevMarker);
}
};
2014-02-05 06:29:17 +00:00
Phaser.Sound.prototype.constructor = Phaser.Sound;
2013-10-03 00:21:08 +00:00
/**
* @name Phaser.Sound#isDecoding
* @property {boolean} isDecoding - Returns true if the sound file is still decoding.
* @readonly
*/
Object.defineProperty(Phaser.Sound.prototype, "isDecoding", {
get: function () {
return this.game.cache.getSound(this.key).isDecoding;
}
});
/**
* @name Phaser.Sound#isDecoded
* @property {boolean} isDecoded - Returns true if the sound file has decoded.
* @readonly
*/
Object.defineProperty(Phaser.Sound.prototype, "isDecoded", {
get: function () {
return this.game.cache.isSoundDecoded(this.key);
}
});
/**
* @name Phaser.Sound#mute
* @property {boolean} mute - Gets or sets the muted state of this sound.
*/
Object.defineProperty(Phaser.Sound.prototype, "mute", {
2014-03-28 01:42:49 +00:00
2013-10-03 00:21:08 +00:00
get: function () {
return this._muted;
},
2014-03-28 01:42:49 +00:00
2013-10-03 00:21:08 +00:00
set: function (value) {
2013-11-28 15:57:09 +00:00
value = value || null;
2013-10-03 00:21:08 +00:00
if (value)
{
this._muted = true;
if (this.usingWebAudio)
{
this._muteVolume = this.gainNode.gain.value;
this.gainNode.gain.value = 0;
}
else if (this.usingAudioTag & & this._sound)
{
this._muteVolume = this._sound.volume;
this._sound.volume = 0;
}
}
else
{
this._muted = false;
if (this.usingWebAudio)
{
this.gainNode.gain.value = this._muteVolume;
}
else if (this.usingAudioTag & & this._sound)
{
this._sound.volume = this._muteVolume;
}
}
this.onMute.dispatch(this);
}
});
/**
* @name Phaser.Sound#volume
* @property {number} volume - Gets or sets the volume of this sound, a value between 0 and 1.
* @readonly
*/
Object.defineProperty(Phaser.Sound.prototype, "volume", {
get: function () {
return this._volume;
},
set: function (value) {
if (this.usingWebAudio)
{
this._volume = value;
this.gainNode.gain.value = value;
}
else if (this.usingAudioTag & & this._sound)
{
// Causes an Index size error in Firefox if you don't clamp the value
if (value >= 0 & & value < = 1)
{
this._volume = value;
this._sound.volume = value;
}
}
}
});
< / pre >
< / 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" >
2013-10-25 15:54:40 +00:00
Documentation generated by < a href = "https://github.com/jsdoc3/jsdoc" > JSDoc 3.3.0-dev< / a >
2014-03-28 01:42:49 +00:00
on Fri Mar 28 2014 01:41:23 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 >
< 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-03-14 06:36:05 +00:00
anchorName : function(i, heading, prefix) {
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 >
