`sounds-control` is a versatile JavaScript/TypeScript audio library designed to provide advanced sound control functions, making it an ideal choice for games and various web applications. This library stands out by offering seamless audio integration for mobile environments, particularly addressing the common conflicts found in other libraries when used with frameworks like Ionic, React Native, and Vue. With `sounds-control`, you can effortlessly manage audio in web, Ionic, React Native (Android and iOS), ensuring a smooth and reliable experience across all platforms.

Quick Links

• 📖 Read the blog

Installation

1npm install sounds-control

Available Functions

loadSound(url: string, id: string): Promise<void>

Loads an audio file from a URL and decodes it for later use.

isSoundLoaded(id: string): boolean

Checks if a sound has been loaded.

play(id: string, startTime: number = 0): Promise<void>

Plays a sound from a specified start time.

playEffect(id: string): Promise<void>

Plays a sound effect.

stop(id: string): void

Stops the playback of a sound and stores the pause time.

loop(id: string, startTime: number = 0): void

Loops a sound from a specified start time.

setVolume(volume: number): void

Sets the overall playback volume.

setEffectVolume(volume: number): void

Sets the volume for sound effects.

setPlaybackRate(id: string, rate: number): void

Sets the playback rate for a specific sound.

setGlobalPlaybackRate(rate: number): void

Sets the global playback rate for all sounds.

faster(id: string, rate: number = 1.5): void

Sets a faster playback rate for a specific sound.

slow(id: string, rate: number = 0.75): void

Sets a slower playback rate for a specific sound.

fasterEffect(id: string, rate: number = 1.5): void

Sets a faster playback rate for a specific sound effect.

slowEffect(id: string, rate: number = 0.75): void

Sets a slower playback rate for a specific sound effect.

pauseAll(): void

Pauses all sounds and stores the pause time.

resumeAll(): void

Resumes playback of all sounds from the stored pause time.

Usage Examples

Plain JavaScript

1import { SoundsControl } from 'sounds-control';
2
3const soundsControl = new SoundsControl();
4
5async function init() {
6  await soundsControl.loadSound('path/to/sound.mp3', 'sound1');
7  soundsControl.play('sound1');
8}
9
10init();

Angular / Ionic

1// app.module.ts
2import { NgModule } from '@angular/core';
3import { BrowserModule } from '@angular/platform-browser';
4import { AppComponent } from './app.component';
5import { AudioService } from './audio.service';
6
7@NgModule({
8  declarations: [AppComponent],
9  imports: [BrowserModule],
10  providers: [AudioService],
11  bootstrap: [AppComponent]
12})
13export class AppModule {}
14
15// audio.service.ts
16import { Injectable } from '@angular/core';
17import { SoundsControl } from 'sounds-control';
18
19@Injectable({
20  providedIn: 'root'
21})
22export class AudioService {
23  private soundsControl: SoundsControl;
24
25  constructor() {
26    this.soundsControl = new SoundsControl();
27  }
28
29  async loadSound(url: string, id: string): Promise<void> {
30    await this.soundsControl.loadSound(url, id);
31  }
32
33  play(id: string): void {
34    this.soundsControl.play(id);
35  }
36}

Angular / Ionic Pause and Resume

1  ngOnInit() {
2    App.addListener('appStateChange', ({ isActive }) => {
3      if (isActive) {
4        this.audioService.resumeAll();
5      } else {
6        this.audioService.pauseAll();
7      }
8    });
9  }

React

1import React, { useEffect } from 'react';
2import { SoundsControl } from 'sounds-control';
3
4const soundsControl = new SoundsControl();
5
6function App() {
7  useEffect(() => {
8    async function init() {
9      await soundsControl.loadSound('path/to/sound.mp3', 'sound1');
10      soundsControl.play('sound1');
11    }
12    init();
13  }, []);
14
15  return <div className="App">Playing sound...</div>;
16}
17
18export default App;

Vue

1<template>
2  <div>
3    <button @click="playSound">Play Sound</button>
4  </div>
5</template>
6
7<script>
8import { SoundsControl } from 'sounds-control';
9
10const soundsControl = new SoundsControl();
11
12export default {
13  methods: {
14    async playSound() {
15      await soundsControl.loadSound('path/to/sound.mp3', 'sound1');
16      soundsControl.play('sound1');
17    }
18  }
19};
20</script>

License

Sounds Control is licensed under the MIT license. Please refer to the LICENSE file for more information. © Rodrigo Rangel

Doações

If you enjoyed using sounds-control, please consider making a donation to support the continuous development of the project. You can make a donation using one of the following options:

• Pix: rodrigo@hangell.org