SoundSlot(component, [name], [options]) 

Create a new SoundSlot.

Parameters

component	SoundComponent	The Component that created this slot.
name	string	The name of the slot. Defaults to 'Untitled'.
options	object	Settings for the slot.
options.volume	number	The playback volume, between 0 and 1.
options.pitch	number	The relative pitch, default of 1, plays at normal pitch.
options.loop	boolean	If true the sound will restart when it reaches the end.
options.startTime	number	The start time from which the sound will start playing.
options.duration	number	The duration of the sound that the slot will play starting from startTime.
options.overlap	boolean	If true then sounds played from slot will be played independently of each other. Otherwise the slot will first stop the current sound before starting the new one.
options.autoPlay	boolean	If true the slot will start playing as soon as its audio asset is loaded.
options.asset	number	The asset id of the audio asset that is going to be played by this slot.

number, nullasset 

The asset id.

booleanautoPlay 

If true the slot will begin playing as soon as it is loaded.

numberduration 

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

SoundInstance[]instances 

An array that contains all the SoundInstances currently being played by the slot.

booleanisLoaded 

Returns true if the asset of the slot is loaded.

booleanisPaused 

Returns true if the slot is currently paused.

booleanisPlaying 

Returns true if the slot is currently playing.

booleanisStopped 

Returns true if the slot is currently stopped.

booleanloop 

If true the slot will restart when it finishes playing.

stringname 

The name of the slot.

booleanoverlap 

If true then sounds played from slot will be played independently of each other. Otherwise the slot will first stop the current sound before starting the new one.

numberpitch 

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

numberstartTime 

The start time from which the sound will start playing.

numbervolume 

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

clearExternalNodes() 

Clears any external nodes set by SoundSlot#setExternalNodes.

getExternalNodes() 

Gets an array that contains the two external nodes set by SoundSlot#setExternalNodes.

Returns

AudioNode[]

An array of 2 elements that contains the first and last nodes set by SoundSlot#setExternalNodes.

load() 

Loads the asset assigned to this slot.

pause() 

Pauses all sound instances. To continue playback call SoundSlot#resume.

Returns

boolean

True if the sound instances paused successfully, false otherwise.

play() 

Plays a sound. If SoundSlot#overlap is true the new sound instance will be played independently of any other instances already playing. Otherwise existing sound instances will stop before playing the new sound.

Returns

SoundInstance

The new sound instance.

resume() 

Resumes playback of all paused sound instances.

Returns

boolean

True if any instances were resumed.

setExternalNodes(firstNode, [lastNode]) 

Connect external Web Audio API nodes. Any sound played by this slot will automatically attach the specified nodes to the source that plays the sound. 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).

const context = app.systems.sound.context;
const analyzer = context.createAnalyzer();
const distortion = context.createWaveShaper();
const filter = context.createBiquadFilter();
analyzer.connect(distortion);
distortion.connect(filter);
slot.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 all sound instances.

Returns

boolean

True if any instances were stopped.

load 

Fired when the asset assigned to the slot is loaded.

Parameters

sound

Sound

The sound resource that was loaded.

pause 

Fired when a sound instance is paused.

Parameters

instance

SoundInstance

The instance that was paused created to play the sound.

play 

Fired when a sound instance starts playing.

Parameters

instance

SoundInstance

The instance that started playing.

resume 

Fired when a sound instance is resumed.

Parameters

instance

SoundInstance

The instance that was resumed.

stop 

Fired when a sound instance is stopped.

Parameters

instance

SoundInstance

The instance that was stopped.

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

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

name

string

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.

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

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

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

EventHandle

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