API Reference

Class List

pc.SoundInstance3d

Extends: pc.SoundInstance

A pc.SoundInstance3d plays a pc.Sound in 3D

Summary

Properties

distanceModelDetermines which algorithm to use to reduce the volume of the audio as it moves away from the listener.
maxDistanceThe maximum distance from the listener at which audio falloff stops.
positionThe position of the sound in 3D space.
refDistanceThe reference distance for reducing volume as the sound source moves further from the listener.
rollOffFactorThe factor used in the falloff equation.
velocityThe velocity of the sound.

Inherited

Properties

currentTimeGets or sets the current time of the sound that is playing.
durationThe duration of the sound that the instance will play starting from startTime.
isPausedReturns true if the instance is currently paused.
isPlayingReturns true if the instance is currently playing.
isStoppedReturns true if the instance is currently stopped.
isSuspendedReturns true if the instance is currently suspended because the window is not focused.
loopIf true the instance will restart when it finishes playing
pitchThe pitch modifier to play the sound with.
soundThe sound resource that the instance will play.
sourceGets the source that plays the sound resource.
startTimeThe start time from which the sound will start playing.
volumeThe volume modifier to play the sound with.

Methods

clearExternalNodesClears any external nodes set by pc.SoundInstance#setExternalNodes.
fireFire an event, all additional arguments are passed on to the event listener
getExternalNodesGets any external nodes set by pc.SoundInstance#setExternalNodes.
hasEventTest if there are any handlers bound to an event name
offDetach an event handler from an event.
onAttach an event handler to an event
onceAttach an event handler to an event.
pausePauses playback of sound.
playBegins playback of sound.
resumeResumes playback of the sound.
setExternalNodesConnects external Web Audio API nodes.
stopStops playback of sound.

Events

endFired when the sound currently played by the instance ends.
pauseFired when the instance is paused.
playFired when the instance starts playing its source
resumeFired when the instance is resumed.
stopFired when the instance is stopped.

Details

Constructor

SoundInstance3d(manager, sound, options)

Parameters

managerpc.SoundManagerThe sound manager
soundpc.SoundThe sound to play
optionsObjectOptions for the instance
options.volumeNumberThe playback volume, between 0 and 1.
options.pitchNumberThe relative pitch, default of 1, plays at normal pitch.
options.loopBooleanWhether the sound should loop when it reaches the end or not.
options.startTimeNumberThe time from which the playback will start. Default is 0 to start at the beginning.
options.durationNumberThe total time after the startTime when playback will stop or restart if loop is true.
options.positionpc.Vec3The position of the sound in 3D space.
options.velocitypc.Vec3The velocity of the sound.
options.distanceModelStringDetermines which algorithm to use to reduce the volume of the audio as it moves away from the listener. Can be one of pc.DISTANCE_LINEAR, pc.DISTANCE_INVERSE or pc.DISTANCE_EXPONENTIAL. Default is pc.DISTANCE_LINEAR.
options.refDistanceNumberThe reference distance for reducing volume as the sound source moves further from the listener.
options.maxDistanceNumberThe maximum distance from the listener at which audio falloff stops. Note the volume of the audio is not 0 after this distance, but just doesn't fall off anymore.
options.rollOffFactorNumberThe factor used in the falloff equation.

Properties

StringdistanceModel

Determines which algorithm to use to reduce the volume of the audio as it moves away from the listener. Can be one of pc.DISTANCE_LINEAR, pc.DISTANCE_INVERSE or pc.DISTANCE_EXPONENTIAL. Default is pc.DISTANCE_LINEAR.

NumbermaxDistance

The maximum distance from the listener at which audio falloff stops. Note the volume of the audio is not 0 after this distance, but just doesn't fall off anymore.

pc.Vec3position

The position of the sound in 3D space.

NumberrefDistance

The reference distance for reducing volume as the sound source moves further from the listener.

NumberrollOffFactor

The factor used in the falloff equation.

pc.Vec3velocity

The velocity of the sound.

Inherited

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.

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

nameObjectName 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.

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.

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

nameStringThe 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

nameStringName of the event to unbind
callbackpc.callbacks.HandleEventFunction to be unbound.
scopeObjectScope 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

nameStringName of the event to bind the callback to
callbackpc.callbacks.HandleEventFunction that is called when event is fired. Note the callback is limited to 8 arguments.
scopeObjectObject 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

nameStringName of the event to bind the callback to
callbackpc.callbacks.HandleEventFunction that is called when event is fired. Note the callback is limited to 8 arguments.
scopeObjectObject to use as 'this' when the event is fired, defaults to current this

Returns

pc.EventHandler Self for chaining.

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

firstNodeAudioNodeThe first node that will be connected to the audio source of sound instances.
lastNodeAudioNodeThe 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.