Class: Sound

Constructor

new Sound(path)

Parameters:

Name	Type	Description
`path`	String	The path to the sound file

Source: audio.js, line 77

Example

let mySound = new gameify.audio.Sound("my-sound.mp3");

Members

(readonly) loaded

If the sound has loaded yet

Source: audio.js, line 91

(readonly) path

The sound path. Modifying this will not do anything.

Source: audio.js, line 86

Methods

changePath(path)

Change and load a new image path. Resets the image's crop

Parameters:

Name	Type	Description
`path`	string	The new image path

Source: audio.js, line 250

fromJSON(data, ref) → {gameify.Image}

Creates a object from JSON data

Parameters:

Name	Type	Description
`data`	Object \| Array	Serialized object data (from object.toJSON)
`ref`	function	A function that returns a name for other objects, so they can be restored later

Source: audio.js, line 102

Returns:

Type:: gameify.Image

getCalculatedVolume() → {Number}

Get the calculated volume of the sound (after audioManager volume is applied)

Source: audio.js, line 240

Returns:

The calculated volume of the sound, between 0 and 1

Type:: Number

getCurrentTime() → {Number}

Get the current seek time of the sound

Source: audio.js, line 192

Returns:

The current seek time, in seconds

Type:: Number

getDuration() → {Number}

Get the duration of the audio (in seconds)

Source: audio.js, line 184

Returns:

The duration of the sound in seconds

Type:: Number

getLoop() → {Boolean}

Check if the sound is set to loop

Source: audio.js, line 176

Returns:

If the sound is set to loop

Type:: Boolean

getVolume() → {Number}

Get the volume of the sound. Note that this volume is mixed with the audioManager's volume to get the actual volume. Use getCalculatedVolume() to get the actual volume the sound will be played at.

Source: audio.js, line 233
See: {gameify.audio.Sound.getCalculatedVolume}

Returns:

The volume of the sound, between 0 and 1

Type:: Number

isPlaying() → {Boolean}

Check if the sound currently is playing

Source: audio.js, line 136

Returns:

Type:: Boolean

onLoad(callback)

Set a function to be run when the sound is loaded (Can be played through w/o buffering)

Parameters:

Name	Type	Description
`callback`	function	The function to be called when the sound is loaded.

Source: audio.js, line 266

pause()

Pause the sound

Source: audio.js, line 153

play()

Play the sound. Please be aware some browsers block autoplay by default.

Source: audio.js, line 143

seek(time)

Seek to a specific point in the audio

Parameters:

Name	Type	Description
`time`	Number	The time to seek to, in seconds

Source: audio.js, line 200

seekRelative(time)

Seek a percentage of the way through the audio

Parameters:

Name	Type	Description
`time`	Number	Where to seek to, from 0 to 1

Source: audio.js, line 208

setLoop(loop)

Choose whether the sound should loop or not (default is not looping)

Parameters:

Name	Type	Description
`loop`	Boolean	If the sound should loop

Source: audio.js, line 169

setVolume(volume)

Sets the volume of the sound

Parameters:

Name	Type	Description
`volume`	Number	The desired volume level, a number between 0 and 1.

Source: audio.js, line 216

stop()

Stop the sound (resets the seek time)

Source: audio.js, line 160

toJSON(keyopt, ref) → {Object}

Convert the object to JSON

Parameters:

Name	Type	Attributes	Description
`key`	string	<optional>	Key object is stored under (unused, here for consistency with e.g. Date.toJSON, etc.)
`ref`	function		A function that returns a name for other objects, so they can be restored later

Source: audio.js, line 124

Returns:

Type:: Object