Class createjs.Sound

Extends .

Defined in: sound.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	createjs.Sound() A class that plays sound.

Field Summary
Field Attributes	Field Name and Description
<static>	createjs.Sound.DELIMITER The character (or characters) that are used to split multiple paths from an audio source.
<static>	createjs.Sound.exports A table of exported functions.
<static>	createjs.Sound.INTERRUPT_ANY The interrupt value to interrupt any currently playing instance with the same source, if the maximum number of instances of the sound are already playing.
<static>	createjs.Sound.INTERRUPT_EARLY The interrupt value to interrupt the earliest currently playing instance with the same source that progressed the least distance in the audio track, if the maximum number of instances of the sound are already playing.
<static>	createjs.Sound.INTERRUPT_LATE The interrupt value to interrupt the currently playing instance with the same source that progressed the most distance in the audio track, if the maximum number of instances of the sound are already playing.
<static>	createjs.Sound.INTERRUPT_NONE The interrupt value to not interrupt any currently playing instances with the same source, if the maximum number of instances of the sound are already playing.
<static>	createjs.Sound.PLAY_FAILED Defines the playState of an instance that failed to play.
<static>	createjs.Sound.PLAY_FINISHED Defines the playState of an instance that completed playback.
<static>	createjs.Sound.PLAY_INITED Defines the playState of an instance that is still initializing.
<static>	createjs.Sound.PLAY_INTERRUPTED Defines the playState of an instance that was interrupted by another instance.
<static>	createjs.Sound.PLAY_SUCCEEDED Defines the playState of an instance that is currently playing or paused.

Method Summary
Method Attributes	Method Name and Description
<static>	createjs.Sound.addListener(type, listener, opt_useCapture) Adds an event listener.
<static>	createjs.Sound.createInstance(source) Creates a new sound instance.
<static>	createjs.Sound.dispatch(event, opt_target) Dispatches the specified event to all listeners.
<static>	createjs.Sound.getActivePlugin() Returns whether there is at least one listener for the specified event type.
	getCapability_(key) Returns a specific capability of the active plugin.
<static>	createjs.Sound.getInstance_() Returns the global instance of the createjs.Sound object.
<static>	createjs.Sound.getMute() Returns the mute status.
<static>	createjs.Sound.getVolume() Returns the master volume.
<static>	createjs.Sound.hasListener(type) Returns whether there is at least one listener for the specified event type.
<static>	createjs.Sound.initializeDefaultPlugins() Initializes the default plug-ins.
<static>	createjs.Sound.isReady() Returns whether this module can play sound.
	loadComplete(source) Returns whether a source has been loaded.
<static>	createjs.Sound.play(source, value, opt_delay, opt_offset, opt_loop, opt_volume, opt_pan) Plays a sound.
<static>	createjs.Sound.Plugin() An inner interface that provides methods for the original SoundJS plug-ins.
<static>	createjs.Sound.registerManifest(manifest, basePath) Registers a manifest of audio files for loading.
<static>	createjs.Sound.registerPlugin(plugin) Registers a plug-in.
<static>	createjs.Sound.registerPlugins(plugins) Registers plug-ins.
<static>	createjs.Sound.registerSound(source, opt_id, opt_data, opt_preload, opt_basePath) Creates audio sprites from an audio file and registers them.
<static>	createjs.Sound.registerSounds(sources, opt_basePath) Creates audio sprites from audio files and registers them.
<static>	createjs.Sound.removeAllListeners(opt_type) Removes all listeners for the specified type, or all listeners of all types.
<static>	createjs.Sound.removeAllSounds() Removes all sounds registered to this object.
<static>	createjs.Sound.removeListener(type, listener, opt_useCapture) Removes the specified event listener.
<static>	createjs.Sound.removeManifest(manifest, basePath) Removes all sound files in a manifest.
<static>	createjs.Sound.removeSound(src, basePath) Removes a sound.
<static>	createjs.Sound.reset(opt_destroy) Resets the global variables used by this class and the inner classes in this file.
<static>	createjs.Sound.setMute(value) Mutes/Unmutes all audio.
<static>	createjs.Sound.setVolume(value) Sets the master volume.
<static>	createjs.Sound.stop() Stops all audio (global stop)

Class Detail

createjs.Sound()

A class that plays sound.

Field Detail

<static> createjs.Sound.DELIMITER

The character (or characters) that are used to split multiple paths from an audio source.

<static> createjs.Sound.exports

A table of exported functions.

<static> createjs.Sound.INTERRUPT_ANY

The interrupt value to interrupt any currently playing instance with the same source, if the maximum number of instances of the sound are already playing.

<static> createjs.Sound.INTERRUPT_EARLY

The interrupt value to interrupt the earliest currently playing instance with the same source that progressed the least distance in the audio track, if the maximum number of instances of the sound are already playing.

<static> createjs.Sound.INTERRUPT_LATE

The interrupt value to interrupt the currently playing instance with the same source that progressed the most distance in the audio track, if the maximum number of instances of the sound are already playing.

<static> createjs.Sound.INTERRUPT_NONE

The interrupt value to not interrupt any currently playing instances with the same source, if the maximum number of instances of the sound are already playing.

<static> createjs.Sound.PLAY_FAILED

Defines the playState of an instance that failed to play.

<static> createjs.Sound.PLAY_FINISHED

Defines the playState of an instance that completed playback.

<static> createjs.Sound.PLAY_INITED

Defines the playState of an instance that is still initializing.

<static> createjs.Sound.PLAY_INTERRUPTED

Defines the playState of an instance that was interrupted by another instance.

<static> createjs.Sound.PLAY_SUCCEEDED

Defines the playState of an instance that is currently playing or paused.

Method Detail

<static> {Function|Object} createjs.Sound.addListener(type, listener, opt_useCapture)

Adds an event listener.

Parameters:
{string} type
{Function|Object} listener
{boolean=} opt_useCapture

Returns:: {Function|Object}

<static> {createjs.Sound.Player} createjs.Sound.createInstance(source)

Creates a new sound instance.

Parameters:
{string} source

Returns:: {createjs.Sound.Player}

<static> {boolean} createjs.Sound.dispatch(event, opt_target)

Dispatches the specified event to all listeners.

Parameters:
{Object|string|Event} event
{Object=} opt_target

Returns:: {boolean}

<static> {createjs.Sound.Plugin} createjs.Sound.getActivePlugin()

Returns whether there is at least one listener for the specified event type.

Returns:: {createjs.Sound.Plugin}

{number} getCapability_(key)

Returns a specific capability of the active plugin.

Parameters:
{string} key

Returns:: {number}

<static> {createjs.Sound} createjs.Sound.getInstance_()

Returns the global instance of the createjs.Sound object.

Returns:: {createjs.Sound}

<static> {boolean} createjs.Sound.getMute()

Returns the mute status.

Returns:: {boolean}

<static> {number} createjs.Sound.getVolume()

Returns the master volume.

Returns:: {number}

<static> {boolean} createjs.Sound.hasListener(type)

Returns whether there is at least one listener for the specified event type.

Parameters:
{string} type

Returns:: {boolean}

<static> {boolean} createjs.Sound.initializeDefaultPlugins()

Initializes the default plug-ins.

Returns:: {boolean}

<static> {boolean} createjs.Sound.isReady()

Returns whether this module can play sound.

Returns:: {boolean}

{boolean} loadComplete(source)

Returns whether a source has been loaded.

Parameters:
{string} source

Returns:: {boolean}

<static> createjs.Sound.play(source, value, opt_delay, opt_offset, opt_loop, opt_volume, opt_pan)

Plays a sound.

Parameters:
{string} source
{string|Object} value
{number=} opt_delay
{number=} opt_offset
{number=} opt_loop
{number=} opt_volume
{number=} opt_pan

<static> createjs.Sound.Plugin()

An inner interface that provides methods for the original SoundJS plug-ins.

<static> {Array.

Classes

Class createjs.Sound