SoundInstance
Extends: EventHandler
A SoundInstance plays a 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 SoundInstance#setExternalNodes. |
getExternalNodes | Gets any external nodes set by SoundInstance#setExternalNodes. |
pause | Pauses playback of sound. |
play | Attempt to begin playback the 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)
Create a new SoundInstance instance.
Parameters
manager | SoundManager | The sound manager. |
sound | Sound | The sound to play. |
options | object | Options for the instance. |
options.volume | number | The playback volume, between 0 and 1. Defaults to 1. |
options.pitch | number | The relative pitch. Defaults to 1 (plays at normal pitch). |
options.loop | boolean | Whether the sound should loop when it reaches the end or not. Defaults to false. |
options.startTime | number | The time from which the playback will start in seconds. Default is 0 to start at the beginning. Defaults to 0. |
options.duration | number | The total time after the startTime in seconds when playback will stop or restart if loop is true. Defaults to 0. |
options.onPlay | function | Function called when the instance starts playing. |
options.onPause | function | Function called when the instance is paused. |
options.onResume | function | Function called when the instance is resumed. |
options.onStop | function | Function called when the instance is stopped. |
options.onEnd | function | Function called when the instance ends. |
Properties
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.
Returns true if the instance is currently suspended because the window is not focused.
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.
Methods
clearExternalNodes()
Clears any external nodes set by SoundInstance#setExternalNodes.
getExternalNodes()
Gets any external nodes set by SoundInstance#setExternalNodes.
Returns
AudioNode[]Returns an array that contains the two nodes set by SoundInstance#setExternalNodes.
pause()
Pauses playback of sound. Call resume() to resume playback from the same position.
Returns
booleanReturns true if the sound was paused.
play()
Attempt to begin playback the sound. If the AudioContext is suspended, the audio will only start once it's resumed. If the sound is already playing, this will restart the sound.
Returns
booleanTrue if the sound was started immediately.
resume()
Resumes playback of the sound. Playback resumes at the point that the audio was paused.
Returns
booleanReturns 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.
const context = app.systems.sound.context;
const analyzer = context.createAnalyzer();
const distortion = context.createWaveShaper();
const filter = context.createBiquadFilter();
analyzer.connect(distortion);
distortion.connect(filter);
instance.setExternalNodes(analyzer, filter);
Parameters
firstNode | AudioNode | The first node that will be connected to the audio source of sound instances. |
lastNode | AudioNode | 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
booleanReturns 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
name | string | 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
EventHandlerSelf 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
name | string | The name of the event to test. |
Returns
booleanTrue 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.
const 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 handler functions, called 'test' with scope this
Parameters
name | string | Name of the event to unbind. |
callback | HandleEventCallback | Function to be unbound. |
scope | object | Scope that was used as the this when the event is fired. |
Returns
EventHandlerSelf 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
const evt = obj.on('test', function (a, b) {
console.log(a + b);
});
// some time later
evt.off();
Parameters
name | string | Name of the event to bind the callback to. |
callback | HandleEventCallback | Function that is called when event is fired. Note the callback is limited to 8 arguments. |
scope | object | Object to use as 'this' when the event is fired, defaults to current this. |
Returns
EventHandleCan be used for removing event in the future.
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
name | string | Name of the event to bind the callback to. |
callback | HandleEventCallback | Function that is called when event is fired. Note the callback is limited to 8 arguments. |
scope | object | Object to use as 'this' when the event is fired, defaults to current this. |
Returns
EventHandle- can be used for removing event in the future.