CreateJS/SoundJS
SoundJS
SoundJS is a JavaScript audio library and asset manager designed to load and play audio across different browsers using a consistent API. It serves as a wrapper that abstracts the Web Audio API and HTML5 Audio to provide a cross-platform playback system.
The project ensures consistent sound across devices by supporting Web Audio, HTML5, and mobile plugins. It includes specific mechanisms for mobile environments, such as unlocking audio playback on iOS via user-initiated touch events and managing playback continuity during screen locks.
The library covers asset management through the registration and preloading of sound files to prevent playback delays. It provides controls for both global and instance-level playback, including volume, mute states, stereo panning, and the use of a dynamics compressor to prevent audio distortion.
The system includes support for hybrid applications via Cordova and PhoneGap plugins and maintains legacy compatibility through Flash audio fallbacks.
Features
- Audio Playback - Implements a consistent JavaScript API for playing audio files across different browsers and devices.
- Asset Registries - Maintains a central store of loaded audio files to prevent redundant network requests.
- Audio Asset Loaders - Implements a system for registering and loading sound files with alternate extension support for cross-environment compatibility.
- HTML5 Audio Playbacks - Integrates native HTML5 Audio elements to ensure playback compatibility across various devices.
- Playback Controls - Provides functionality to start, stop, pause, and manually adjust the playhead position of audio playback.
- Audio Asset Caching - Provides a system for preloading, registering, and caching sound files to ensure immediate playback.
- Instance Playback Controls - Provides tools for pausing, muting, stopping, or adjusting the volume and panning of specific active audio instances.
- Cross-Browser Adapters - Provides a consistent API by abstracting Web Audio and HTML5 Audio backends for cross-browser compatibility.
- Cross-Platform Audio Engines - Provides a playback system that works across Web Audio, HTML5, and mobile plugins for consistent sound.
- Web Audio Libraries - Acts as a JavaScript library for loading and playing audio across different browsers using a consistent API.
- Audio Volume Controls - Provides master volume controls that proportionally scale the gain across all active sound instances.
- Instance Controllers - Wraps each active playback session in a control object to independently manage volume, panning, and looping.
- Browser Audio API Wrappers - Provides a unified wrapper around the Web Audio API for high-performance and consistent playback.
- Web Audio Integration - Uses the Web Audio API to implement high-quality interactive sound features and dynamics compression.
- Signal Compression - Uses a dynamics compressor to improve sound quality and prevent clipping during audio playback.
- Playback Event Handlers - Implements callbacks to notify applications when audio files finish loading or complete playback.
- Playback Preloaders - Provides capabilities to prepare and preload audio files in the background for immediate playback.
- User-Gesture Unlocking - Includes a utility to unlock audio playback on iOS devices using user-initiated touch events.
- Mobile Plugin Integrations - Supports audio playback in hybrid applications through integration with Cordova and PhoneGap plugins.
- Global Playback Controllers - Provides functionality to halt all currently playing audio and immediately reset playback positions.
- Stereo Panning and Volume Controls - Provides granular control over volume, mute status, and stereo panning for individual active sound instances.
- Game Audio Management - Provides background preloading and registration of sound files to eliminate delays in interactive game environments.
- Hybrid App Audio Implementations - Integrates audio playback into cross-platform mobile applications using Cordova and PhoneGap plugins.
- Mobile Web Audio Constraints Management - Handles audio playback constraints on iOS and Android, including sound unlocking and screen lock behavior.
- Platform Capability Resolution - Detects environmental capabilities to automatically select the most compatible audio driver for the current platform.
- Autoplay Unlocking - Triggers initial sounds during touch events to bypass mobile browser restrictions on autoplaying audio.
- Audio And Music - Simple API for web audio.
- Media and Audio - Simplifies cross-browser audio playback management.
- Media Playback and Processing - Unified API for web audio management.
