Class: Sound

Constructor

new Sound(assetopt, randomnessopt, rangeopt, taperopt, onloadCallbackopt)

Create a sound object and cache the audio for later use

Parameters:

Name	Type	Attributes	Default	Description
`asset`	string \| Array	<optional>		Filename of audio file or zzfx array
`randomness`	number	<optional>		How much to randomize frequency each time sound plays, for zzfx sounds the zzfx default is used if undefined
`range`	number	<optional>	soundDefaultRange	World space max range of sound
`taper`	number	<optional>	soundDefaultTaper	At what percentage of range should it start tapering
`onloadCallback`	SoundLoadCallback	<optional>		callback function to call when sound is loaded

Source: src/engineAudio.js, line 65

Example

// load an audio asset file
const sound_example = new Sound('sound.mp3');

// create a zzfx sound
const sound_example = new Sound([.5,.5]);

// play a sound
sound_example.play();

Members

loadedPercent

Properties

Type	Description
number	Percentage of this sound currently loaded

Source: src/engineAudio.js, line 99

onloadCallback

Properties

Type	Description
SoundLoadCallback	function to call when sound is loaded

Source: src/engineAudio.js, line 101

randomness

Properties

Type	Description
number	How much to randomize frequency each time sound plays

Source: src/engineAudio.js, line 95

range

Properties

Type	Description
number	World space max range of sound

Source: src/engineAudio.js, line 91

sampleRate

Properties

Type	Description
number	Sample rate for this sound

Source: src/engineAudio.js, line 97

taper

Properties

Type	Description
number	At what percentage of range should it start tapering

Source: src/engineAudio.js, line 93

Methods

getDuration() → {number}

Get how long this sound is in seconds

Source: src/engineAudio.js, line 197

Returns:

How long the sound is in seconds (undefined if loading)

Type:: number

isLoaded() → {boolean}

Check if sound is loaded, for sounds fetched from a url

Source: src/engineAudio.js, line 203

Returns:

True if sound is loaded and ready to play

Type:: boolean

(async) loadSound(filename) → {Promise.<void>}

Loads a sound from a URL and decodes it into sample data.

Parameters:

Name	Type	Description
`filename`	string

Source: src/engineAudio.js, line 208

Returns:

Type:: Promise.<void>

play(posopt, volumeopt, pitchopt, randomnessScaleopt, loopopt, pausedopt) → {SoundInstance}

Play the sound Sounds may not play until a user interaction occurs

Parameters:

Name	Type	Attributes	Default	Description
`pos`	Vector2	<optional>		World space position to play the sound if any
`volume`	number	<optional>	1	How much to scale volume by
`pitch`	number	<optional>	1	How much to scale pitch by
`randomnessScale`	number	<optional>	1	How much to scale pitch randomness
`loop`	boolean	<optional>	false	Should the sound loop?
`paused`	boolean	<optional>	false	Should the sound start paused

Source: src/engineAudio.js, line 137

Returns:

The audio source node

Type:: SoundInstance

playMusic(volumeopt, loopopt, pausedopt) → {SoundInstance}

Play a music track that loops by default

Parameters:

Name	Type	Attributes	Default	Description
`volume`	number	<optional>	1	Volume to play the music at
`loop`	boolean	<optional>	true	Should the music loop?
`paused`	boolean	<optional>	false	Should the music start paused

Source: src/engineAudio.js, line 177

Returns:

The sound instance

Type:: SoundInstance

playNote(semitoneOffsetopt, posopt, volumeopt) → {SoundInstance}

Play the sound as a musical note with a semitone offset This can be used to play music with chromatic scales

Parameters:

Name	Type	Attributes	Default	Description
`semitoneOffset`	number	<optional>	0	How many semitones to offset pitch
`pos`	Vector2	<optional>		World space position to play the sound if any
`volume`	number	<optional>	1	How much to scale volume by

Source: src/engineAudio.js, line 187

Returns:

The sound instance

Type:: SoundInstance