Skip to content

software-mansion/react-native-audio-api

Repository files navigation

React Native Audio API

High-performance audio engine for React Native based on web audio api specification

NPM latest NPM nightly
github ci Audio Api tests

react-native-audio-api provides system for controlling audio in React Native environment compatible with Web Audio API specification, allowing developers to generate and modify audio in exact same way it is possible in browsers.

Installation

check out the Getting Started section of our documentation for detailed instructions!

Roadmap

Planned

  • JS Audio Worklets V1 🐎
    Receive events and data callbacks from audio thread to synchronize with UI on UI thread.

  • Convolver Node 🐐
    Realistic reverb and spatial effects in the browser by applying impulse responses. It makes audio sound like it’s being played in real spaces, from small rooms to cathedrals, or through hardware like amps and speakers

  • Decoding and utility modules πŸ”§
    Decode and modify audio data without the need to create AudioContext first through a set of utility classes

  • DynamicCompressorNode 〽️
    Reduce the volume of loud sounds and boost quieter nodes to balance the audio signal, avoid clipping or distorted sounds

  • Audio tag 🏷️
    Simple ability to play and buffer audio, with all of the most commonly used functions, same as on the web, without the need to create and manipulate an audio graph.

  • MIDI support 🎸
    Complementary lib for react-native-audio-api, that will allow to communicate with MIDI devices or read/write MIDI files.

  • Spatial Audio πŸ›’οΈ
    manipulate audio in 3D space

  • Noise Cancellation πŸ¦‡
    System-based active noise and echo cancellation support

  • JS Audio Worklets V2 🐎
    Customize the process pipeline with JS functions running on audio thread.

  • Decoding support for m4a/mp4/aac/ogg/opus πŸ“
    Decode m4a/mp4/aac/ogg/opus audio files, allowing for playback of these formats in the audio graph.

  • HLS streaming support 🌊
    Stream audio from HLS sources, allowing for playback of live audio streams or pre-recorded audio files.

  • Microphone support πŸŽ™οΈ
    Grab audio data from device microphone or connected device, connect it to the audio graph or stream through the internet.

  • Custom Audio Processor βš™οΈ
    Write your own processing AudioNode.

See more in Changelog

Web Audio API Specification Coverage

Our current coverage of Web Audio API specification can be found here: Web Audio API coverage.

Examples

The source code for the example application is under the /apps/common-app directory. If you want to play with the API but don't feel like trying it on a real app, you can run the example project. Check Example README for installation instructions.

Your feedback

We are open to new ideas and general feedback. If you want to share your opinion about react-native-audio-api or have some thoughts about how it could be further developed, don't hesitate to create an issue or contact the maintainers directly.

License

react-native-audio-api library is licensed under The MIT License. Some of the source code uses implementation directly copied from Webkit and utilizes FFmpeg binaries. Copyrights are held by respective organizations, check THIRD_PARTY file for further details.

Credits

This project has been built and is maintained thanks to the support from Software Mansion

swm

Community Discord

Join the Software Mansion Community Discord to chat about React Native Audio API or other Software Mansion libraries.

react-native-audio-api is created by Software Mansion

Since 2012 Software Mansion is a software agency with experience in building web and mobile apps. We are Core React Native Contributors and experts in dealing with all kinds of React Native issues. We can help you build your next dream product – Hire us.