API Reference

Class List

pc.SoundInstance

Extends: pc.EventHandler

A pc.SoundInstance plays a pc.Sound.

Summary

Properties

currentTime

Gets or sets the current time of the sound that is playing.

duration

The duration of the sound that the instance will play starting from startTime.

isPaused

Returns true if the instance is currently paused.

isPlaying

Returns true if the instance is currently playing.

isStopped

Returns true if the instance is currently stopped.

isSuspended

Returns true if the instance is currently suspended because the window is not focused.

loop

If true the instance will restart when it finishes playing.

pitch

The pitch modifier to play the sound with.

sound

The sound resource that the instance will play.

source

Gets the source that plays the sound resource.

startTime

The start time from which the sound will start playing.

volume

The volume modifier to play the sound with.

Methods

clearExternalNodes

Clears any external nodes set by pc.SoundInstance#setExternalNodes.

getExternalNodes

Gets any external nodes set by pc.SoundInstance#setExternalNodes.

pause

Pauses playback of sound.

play

Begins playback of sound.

resume

Resumes playback of the sound.

setExternalNodes

Connects external Web Audio API nodes.

stop

Stops playback of sound.

Events

end

Fired when the sound currently played by the instance ends.

pause

Fired when the instance is paused.

play

Fired when the instance starts playing its source.

resume

Fired when the instance is resumed.

stop

Fired when the instance is stopped.

Inherited

Methods

fire

Fire an event, all additional arguments are passed on to the event listener.

hasEvent

Test if there are any handlers bound to an event name.

off

Detach an event handler from an event.

on

Attach an event handler to an event.

once

Attach an event handler to an event.

Details

Constructor

SoundInstance(manager, sound, options)

Parameters

managerpc.SoundManager

The sound manager.

soundpc.Sound

The sound to play.

optionsobject

Options for the instance.

options.volumenumber

The playback volume, between 0 and 1.

options.pitchnumber

The relative pitch, default of 1, plays at normal pitch.

options.loopboolean

Whether the sound should loop when it reaches the end or not.

options.startTimenumber

The time from which the playback will start in seconds. Default is 0 to start at the beginning.

options.durationnumber

The total time after the startTime in seconds when playback will stop or restart if loop is true.

options.onPlayfunction

Function called when the instance starts playing.

options.onPausefunction

Function called when the instance is paused.

options.onResumefunction

Function called when the instance is resumed.

options.onStopfunction

Function called when the instance is stopped.

options.onEndfunction

Function called when the instance ends.

Properties

numbercurrentTime

Gets or sets the current time of the sound that is playing. If the value provided is bigger than the duration of the instance it will wrap from the beginning.

numberduration

The duration of the sound that the instance will play starting from startTime.

booleanisPaused

Returns true if the instance is currently paused.

booleanisPlaying

Returns true if the instance is currently playing.

booleanisStopped

Returns true if the instance is currently stopped.

booleanisSuspended

Returns true if the instance is currently suspended because the window is not focused.

booleanloop

If true the instance will restart when it finishes playing.

numberpitch

The pitch modifier to play the sound with. Must be larger than 0.01.

pc.Soundsound

The sound resource that the instance will play.

AudioBufferSourceNodesource

Gets the source that plays the sound resource. If the Web Audio API is not supported the type of source is Audio. Source is only available after calling play.

numberstartTime

The start time from which the sound will start playing.

numbervolume

The volume modifier to play the sound with. In range 0-1.

Methods

clearExternalNodes()

Clears any external nodes set by pc.SoundInstance#setExternalNodes.

getExternalNodes()

Gets any external nodes set by pc.SoundInstance#setExternalNodes.

Returns

AudioNode[]

Returns an array that contains the two nodes set by pc.SoundInstance#setExternalNodes.

pause()

Pauses playback of sound. Call resume() to resume playback from the same position.

Returns

boolean

Returns true if the sound was paused.

play()

Begins playback of sound. If the sound is not loaded this will return false. If the sound is already playing this will restart the sound.

Returns

boolean

True if the sound was started.

resume()

Resumes playback of the sound. Playback resumes at the point that the audio was paused.

Returns

boolean

Returns true if the sound was resumed.

setExternalNodes(firstNode, [lastNode])

Connects external Web Audio API nodes. You need to pass the first node of the node graph that you created externally and the last node of that graph. The first node will be connected to the audio source and the last node will be connected to the destination of the AudioContext (e.g. speakers). Requires Web Audio API support.

var context = app.systems.sound.context;
var analyzer = context.createAnalyzer();
var distortion = context.createWaveShaper();
var filter = context.createBiquadFilter();
analyzer.connect(distortion);
distortion.connect(filter);
instance.setExternalNodes(analyzer, filter);

Parameters

firstNodeAudioNode

The first node that will be connected to the audio source of sound instances.

lastNodeAudioNode

The last node that will be connected to the destination of the AudioContext. If unspecified then the firstNode will be connected to the destination instead.

stop()

Stops playback of sound. Calling play() again will restart playback from the beginning of the sound.

Returns

boolean

Returns true if the sound was stopped.

Events

end

Fired when the sound currently played by the instance ends.

pause

Fired when the instance is paused.

play

Fired when the instance starts playing its source.

resume

Fired when the instance is resumed.

stop

Fired when the instance is stopped.

Inherited

Methods

fire(name, [arg1], [arg2], [arg3], [arg4], [arg5], [arg6], [arg7], [arg8])

Fire an event, all additional arguments are passed on to the event listener.

obj.fire('test', 'This is the message');

Parameters

nameobject

Name of event to fire.

arg1*

First argument that is passed to the event handler.

arg2*

Second argument that is passed to the event handler.

arg3*

Third argument that is passed to the event handler.

arg4*

Fourth argument that is passed to the event handler.

arg5*

Fifth argument that is passed to the event handler.

arg6*

Sixth argument that is passed to the event handler.

arg7*

Seventh argument that is passed to the event handler.

arg8*

Eighth argument that is passed to the event handler.

Returns

pc.EventHandler

Self for chaining.

hasEvent(name)

Test if there are any handlers bound to an event name.

obj.on('test', function () { }); // bind an event to 'test'
obj.hasEvent('test'); // returns true
obj.hasEvent('hello'); // returns false

Parameters

namestring

The name of the event to test.

Returns

boolean

True if the object has handlers bound to the specified event name.

off([name], [callback], [scope])

Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.

var handler = function () {
};
obj.on('test', handler);

obj.off(); // Removes all events
obj.off('test'); // Removes all events called 'test'
obj.off('test', handler); // Removes all handler functions, called 'test'
obj.off('test', handler, this); // Removes all hander functions, called 'test' with scope this

Parameters

namestring

Name of the event to unbind.

callbackpc.callbacks.HandleEvent

Function to be unbound.

scopeobject

Scope that was used as the this when the event is fired.

Returns

pc.EventHandler

Self for chaining.

on(name, callback, [scope])

Attach an event handler to an event.

obj.on('test', function (a, b) {
    console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console

Parameters

namestring

Name of the event to bind the callback to.

callbackpc.callbacks.HandleEvent

Function that is called when event is fired. Note the callback is limited to 8 arguments.

scopeobject

Object to use as 'this' when the event is fired, defaults to current this.

Returns

pc.EventHandler

Self for chaining.

once(name, callback, [scope])

Attach an event handler to an event. This handler will be removed after being fired once.

obj.once('test', function (a, b) {
    console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console
obj.fire('test', 1, 2); // not going to get handled

Parameters

namestring

Name of the event to bind the callback to.

callbackpc.callbacks.HandleEvent

Function that is called when event is fired. Note the callback is limited to 8 arguments.

scopeobject

Object to use as 'this' when the event is fired, defaults to current this.

Returns

pc.EventHandler

Self for chaining.