public class | source

Sounds

You can directly use an instance of this class. sounds

A class containing multiple Sound instances

Constructor Summary

Public Constructor
public	constructor() Create an instance of Sounds

Public Methods
public	add(name: String, audio: Audio \| String): Sound Adds a Sound instance to the Sounds
public	create(): Sounds Returns a new instance of Sounds
public	enable(enable: Boolean) Sets the Sounds class to enabled or disabled
public	get(name: String): Sound Returns a specific Sound instance
public	init(): Promise Initializes the Sounds class.
public	mute(mute: Boolean) Sets the Sounds class to muted or unmuted
public	remove(name: String) Remove a Sound instance from the Sounds

Create an instance of Sounds

Adds a Sound instance to the Sounds

Name	Type	Attribute	Description
name	String		An identifer to represent the Audio added
audio	Audio \| String		An Audio instance or an url to an audio file

Sound

Returns the Sound instance

Returns a new instance of Sounds

The newly created Sounds instance

Sets the Sounds class to enabled or disabled

Name	Type	Attribute	Description
enable	Boolean		If true the Sound instances will be enabled

Returns a specific Sound instance

Name	Type	Attribute	Description
name	String		The Sound identifier

Sound

The Sound which is represented by the identifier

Initializes the Sounds class. This is needed to enable Audio on some devices

The promise is resolved once audio is available

Sets the Sounds class to muted or unmuted

Name	Type	Attribute	Description
mute	Boolean		If true the Sound instances will be muted

Remove a Sound instance from the Sounds

Name	Type	Attribute	Description
name	String		An identifer to represent the Audio to be removed