@koodu-platform/resonance
v0.1.0
Published
Simple DOM Event Driven Sound Abstraction Library
Downloads
6
Maintainers
Readme
Resonance
Simple DOM Event Driven Sound Abstraction Library
Installation
$ npm install @koodu-platform/resonance
Usage
const soundOptions ={
baseURL: 'fixtures/',
audioPaths: ['./whoosh.mp3']
}
const mySound = new resonance.sound(soundOptions);
const playButton = document.getElementById('btn');
playButton.addEventListener('click', async (ev) => {
try {
await mySound.play(1);
} catch (error) {
console.error('Error playing sound:', error.message);
}
});
API
resonance.sound(options)
Creates a new instance of the Resonance sound, which is a simple DOM event-driven sound abstraction library.
Parameters
options
: An object that contains the following properties:baseURL
: The base URL for the audio file paths.audioPaths
: An array or string of audio file paths.searchParams
: Optional search parameters for audio file URLs.
Instance Methods
load(filePaths)
Loads the audio files.
filePaths
: An array or string of file paths to the audio files.
play(volume)
Plays the loaded audio.
volume
: The volume level (default is 1).
resume(resumeTime)
Resumes playing from a specified time.
resumeTime
: The time to resume from.
pause()
Pauses the currently playing audio.
stop()
Stops the currently playing audio.
dispose()
Disposes of the sound instance.
prev()
Loads and plays the previously loaded sound.
next()
Loads and plays the next loaded sound.
Enums
SOUND_PLAY_STATES
SOUND_CREATED
SOUND_PAUSED
SOUND_PLAYING
SOUND_RESUMED
SOUND_STOPPED
SOUND_PRELOAD_STATES
SOUND_LOADING
SOUND_LOADED
SOUND_ERROR