Skip to main content

AudioQ Documentation

NPM VersionGitHub StarsLicense

Welcome to AudioQ - the most comprehensive solution for managing audio playback in browser applications!

What is AudioQ?​

AudioQ is a powerful TypeScript library that enables you to manage multiple independent audio queues simultaneously. Perfect for games, interactive applications, and any project requiring sophisticated audio control.

Key Features​

  • Multi-channel Management - Independent audio queues for concurrent playback
  • Pause/Resume Control - Full playback control for individual channels or all channels
  • Volume Control & Ducking - Dynamic volume management with automatic background reduction
  • Global Volume Control - Global volume slider with preserved channel ratios
  • Loop Support - Seamless audio looping for background music and ambient sounds
  • Priority Queueing - Add urgent audio to the front of any queue
  • Advanced Queue Manipulation - Remove, reorder, and swap queue items with precision
  • Real-time Progress Tracking - Comprehensive playback monitoring and metadata
  • Event-driven Architecture - Extensive callback system for UI integration
  • Full TypeScript Support - Complete type definitions and IntelliSense
  • Zero Dependencies - Lightweight and self-contained
  • iOS Compatible - Full Web Audio API support with fallback mechanisms
  • MIT Licensed - Free for commercial and personal use

Quick Start​

Get up and running in 2 minutes:

npm install audioq
import { queueAudio, setChannelVolume } from 'audioq';

// Play audio on channel 0
await queueAudio('./sounds/music.mp3', 0);

// Play sound effects on channel 1 
await queueAudio('./sounds/explosion.wav', 1);

// Set volumes independently
setChannelVolume(0, 0.3); // Background music at 30%
setChannelVolume(1, 0.8); // Sound effects at 80%

🗺️ Documentation Sections​

🚀 Getting Started​

Installation, setup, and your first audio queue

💡 Core Concepts​

Understanding channels, queues, and audio lifecycle

📚 API Reference​

Complete function reference with examples

🎯 Examples​

Real-world use cases for games and interactive apps

🔥 Advanced Features​

Volume ducking, priority queuing, and progress tracking

🔄 Migration & Help​

Upgrading guides and troubleshooting

🎮 Use Cases​

Gaming Audio Systems

// Background music (channel 0)
await queueAudio('./music/background.mp3', 0, { loop: true, volume: 0.4 });

// Sound effects (channel 1) 
await queueAudio('./sfx/explosion.wav', 1);

// Set up voice announcements (channel 2) to duck all other audio
setVolumeDucking({ 
  priorityChannel: 2, 
  priorityVolume: 1.0,
  duckingVolume: 0.1 
});

// When voice plays on channel 2, all other channels will reduce to 10% volume
await queueAudio('./voice/game-over.wav', 2);

Interactive Applications

// UI feedback sounds
await queueAudio('./ui/button-click.wav', 1);

// Notification alerts (priority)
await queueAudioPriority('./alerts/incoming-message.wav', 2);

// Ambient background
await queueAudio('./ambient/office-noise.mp3', 0, { loop: true });

Browser Support​

  • ✅ Chrome 51+ (June 2016)
  • ✅ Firefox 54+ (June 2017)
  • ✅ Safari 10+ (September 2016)
  • ✅ Edge 15+ (April 2017)
  • ✅ Mobile browsers with HTML5 audio support

Community & Support​

Need help? Have questions?

Ready to build amazing audio experiences? Let's get started!