react-native-sound

React Native module for playing sound clips on iOS, Android, and Windows.

Be warned, this software is alpha quality and may have bugs. Test on your own and use at your own risk!

Feature matrix

React-native-sound does not support streaming. See #353 for more info. Of course, we would welcome a PR if someone wants to take this on.

In iOS, the library uses AVAudioPlayer, not AVPlayer.

Feature	iOS	Android	Windows
Load sound from the app bundle	✓	✓	✓
Load sound from other directories	✓	✓	✓
Load sound from the network	✓	✓
Play sound	✓	✓	✓
Playback completion callback	✓	✓	✓
Pause	✓	✓	✓
Resume	✓	✓	✓
Stop	✓	✓	✓
Reset		✓
Release resource	✓	✓	✓
Get duration	✓	✓	✓
Get number of channels	✓
Get/set volume	✓	✓	✓
Get system volume	✓	✓
Set system volume		✓
Get/set pan	✓
Get/set loops	✓	✓	✓
Get/set exact loop count	✓
Get/set current time	✓	✓	✓
Set speed	✓	✓

Installation

First install the npm package from your app directory:

1npm install react-native-sound --save

Note: If your react-native version is >= 0.60 then linking is done automatically.

If your react-native version is < 0.60 then link it using:

1react-native link react-native-sound

If you encounter this error

undefined is not an object (evaluating 'RNSound.IsAndroid')

you may additionally need to fully clear your build caches for Android. You can do this using

1cd android
2./gradlew cleanBuildCache

After clearing your build cache, you should execute a new react-native build.

If you still experience issues, know that this is the most common build issue. See #592 and the several issues linked from it for possible resolution. A pull request with improved documentation on this would be welcome!

Manual Installation Notes

Please see the Wiki for these details https://github.com/zmxv/react-native-sound/wiki/Installation

Help with React-Native-Sound

• For react-native-sound developers
• For help using react-native-sound

Demo project

https://github.com/zmxv/react-native-sound-demo

Player

https://github.com/benevbright/react-native-sound-playerview

Basic usage

First you'll need to add audio files to your project.

• Android: Save your sound clip files under the directory android/app/src/main/res/raw. Note that files in this directory must be lowercase and underscored (e.g. my_file_name.mp3) and that subdirectories are not supported by Android.
• iOS: Open Xcode and add your sound files to the project (Right-click the project and select Add Files to [PROJECTNAME])

1// Import the react-native-sound module
2var Sound = require('react-native-sound');
3
4// Enable playback in silence mode
5Sound.setCategory('Playback');
6
7// Load the sound file 'whoosh.mp3' from the app bundle
8// See notes below about preloading sounds within initialization code below.
9var whoosh = new Sound('whoosh.mp3', Sound.MAIN_BUNDLE, (error) => {
10  if (error) {
11    console.log('failed to load the sound', error);
12    return;
13  }
14  // loaded successfully
15  console.log('duration in seconds: ' + whoosh.getDuration() + 'number of channels: ' + whoosh.getNumberOfChannels());
16
17  // Play the sound with an onEnd callback
18  whoosh.play((success) => {
19    if (success) {
20      console.log('successfully finished playing');
21    } else {
22      console.log('playback failed due to audio decoding errors');
23    }
24  });
25});
26
27// Reduce the volume by half
28whoosh.setVolume(0.5);
29
30// Position the sound to the full right in a stereo field
31whoosh.setPan(1);
32
33// Loop indefinitely until stop() is called
34whoosh.setNumberOfLoops(-1);
35
36// Get properties of the player instance
37console.log('volume: ' + whoosh.getVolume());
38console.log('pan: ' + whoosh.getPan());
39console.log('loops: ' + whoosh.getNumberOfLoops());
40
41// Seek to a specific point in seconds
42whoosh.setCurrentTime(2.5);
43
44// Get the current playback point in seconds
45whoosh.getCurrentTime((seconds) => console.log('at ' + seconds));
46
47// Pause the sound
48whoosh.pause();
49
50// Stop the sound and rewind to the beginning
51whoosh.stop(() => {
52  // Note: If you want to play a sound after stopping and rewinding it,
53  // it is important to call play() in a callback.
54  whoosh.play();
55});
56
57// Release the audio player resource
58whoosh.release();

Notes

• To minimize playback delay, you may want to preload a sound file without calling play() (e.g. var s = new Sound(...);) during app initialization. This also helps avoid a race condition where play() may be called before loading of the sound is complete, which results in no sound but no error because loading is still being processed.
• You can play multiple sound files at the same time. Under the hood, this module uses AVAudioSessionCategoryAmbient to mix sounds on iOS.
• You may reuse a Sound instance for multiple playbacks.
• On iOS, the module wraps AVAudioPlayer that supports aac, aiff, mp3, wav etc. The full list of supported formats can be found at https://developer.apple.com/library/content/documentation/MusicAudio/Conceptual/CoreAudioOverview/SupportedAudioFormatsMacOSX/SupportedAudioFormatsMacOSX.html
• On Android, the module wraps android.media.MediaPlayer. The full list of supported formats can be found at https://developer.android.com/guide/topics/media/media-formats.html
• On Android, the absolute path can start with '/sdcard/'. So, if you want to access a sound called "my_sound.mp3" on Downloads folder, the absolute path will be: '/sdcard/Downloads/my_sound.mp3'.
• You may chain non-getter calls, for example, sound.setVolume(.5).setPan(.5).play().

Audio on React Native

• The State of Audio Libraries in React Native (Oct. 2018)
• react-native-audio-toolkit
• react-native-video (also plays audio)
• Expo Audio SDK
• #media on awesome-react-native

Contributing

Pull requests welcome with bug fixes, documentation improvements, and enhancements.

When making big changes, please open an issue first to discuss.

License

This project is licensed under the MIT License.