An instance of this class represents a sound file, specified by a URI.

An instance of Sound traverses through various states during its lifetime, which are defined in AR.CONST.STATE. At each point in time, a Sound instance has exactly one of the following states:

• INITIALIZED
• LOADING
• LOADED
• PLAYING
• PAUSED
• ERROR

The typical state transitions during the lifecycle of a Sound instance is as follows:

• Creation of the object with new AR.Sound(...) -> INITIALIZE
• sound.load() -> LOADING
• Loading finished -> LOADED
• Start playing -> PLAYING
• Pause playing -> PAUSED
• Resume playing -> PLAYING
• Playing finished -> LOADED
• Call sound.destroy() -> Object destroyed

On important state changes, a trigger (onLoaded(), onFinishedPlaying(), onError()) will be called by the system. A developer can react on these events by providing custom logic to these triggers. In case no custom logic is applied to a trigger, the trigger will not fire. The triggers can be passed on creation time, or added later.

In case no preloading should be performed, a Sound file can also be played right after it has been initialized. The Sound file will then be streamed and not stored on the device. Keep in mind that this might cause a delay in playing the file, as it has to be loaded first. Please note that the state will not change to either LOADING, LOADED, PLAYING or PAUSED, it will remain in INITIALIZED state as it is streamed onto the phone. Still, the triggers will fire.

var sound = new AR.Sound("http://www.myuri.com/sound.mp3", {
  onLoaded : function(){sound.play();},
  onError : function(){
    // alert the user that the sound file could not be loaded
    },
});
sound.onFinishedPlaying = function(){alert("Playing finished");};
sound.load();

Note that reloading the content is not possible - calling sound.load() while the sound file is in a state different from INITIALIZED does not have any effect.

Executing sound.play() while the file is in a state different from LOADED, PAUSED or INITIALIZED will have no effect.

When a Sound file in LOADED state is no longer needed, it is essential to call destroy() to clean up ressources on the device.

When a Sound file has been paused, there are two ways to resume playing: Calling resume() will continue playing at the time the file was paused. Calling play() will start playing the file from the very beginning. If a Sound file is initialized, and resume() is called, it will have the same effect as play(1).

The ERROR state indicates that a problem was detected either while loading or playing the file.