react-native-sound-player

Play audio files, stream audio from URL, using ReactNative.

Installation

1. yarn or npm

    // yarn
    yarn add react-native-sound-player
    // or npm
    npm install --save react-native-sound-player

2. Link

    react-native link react-native-sound-player

Usage

Play sound with file name and type

1. Add sound files to iOS/Android.

• On iOS, drag and drop sound file into project in Xcode. Remember to check "Copy items if needed" option and "Add to targets".
• On Android, put sound files in {project_root}/android/app/src/main/res/raw/. Just create the folder if it doesn't exist.

2. Import the library and call the playSoundFile(fileName, fileType) function:

1import SoundPlayer from 'react-native-sound-player'
2
3try {
4    // play the file tone.mp3
5    SoundPlayer.playSoundFile('tone', 'mp3')
6    // or play from url
7    SoundPlayer.playUrl('https://example.com/music.mp3')
8} catch (e) {
9    console.log(`cannot play the sound file`, e)
10}

Please note that the device can still go to sleep (screen goes off) while audio is playing. When this happens, the audio will stop playing. To prevent this, you can something like react-native-keep-awake.

Finished playing/loading event

1...
2
3// subscribe to the finished playing event in componentDidMount
4componentDidMount() {
5  SoundPlayer.onFinishedPlaying((success: boolean) => { // success is true when the sound is played
6    console.log('finished playing', success)
7  })
8  SoundPlayer.onFinishedLoading(async (success: boolean) => {
9    console.log('finished loading', success)
10    // ready to `play()`, `getInfo()`, etc
11    console.log(await SoundPlayer.getInfo())
12  })
13}
14
15// unsubscribe when unmount
16componentWillUnmount() {
17  SoundPlayer.unmount()
18}
19
20
21}
22
23...

Functions

playSound(fileName: string, fileType: string)

Play the sound file named fileName with file type fileType.

loadSoundFile(fileName: string, fileType: string)

Load the sound file named fileName with file type fileType, without playing it. This is useful when you want to play a large file, which can be slow to mount, and have precise control on when the sound is played. This can also be used in combination with getInfo() to get audio file duration without playing it. You should subscribe to the onFinishedLoading event to get notified when the file is loaded.

playUrl(url: string)

Play the audio from url. Supported formats are:

• AVPlayer (iOS)
• MediaPlayer (Android)

onFinishedPlaying(callback: (success: boolean) => any)

Subscribe to the "finished playing" event. The callback function is called whenever a file is finished playing.

onFinishedLoading(callback: (success: boolean) => any)

Subscribe to the "finished loading" event. The callback function is called whenever a file is finished loading, i.e. the file is ready to be play(), resume(), getInfo(), etc.

unmount()

Unsubscribe the "finished playing" and "finished loading" event.

play()

Play the loaded sound file. This function is the same as resume().

pause()

Pause the currently playing file.

resume()

Resume from pause and continue playing the same file. This function is the same as play().

stop()

Stop playing, call playSound(fileName: string, fileType: string) to start playing again.

setVolume(volume: number)

Set the volume of the current player. This does not change the volume of the device.

getInfo() => Promise<{currentTime: number, duration: number}>

Get the currentTime and duration of the currently mounted audio media. This function returns a promise which resolves to an Object containing currentTime and duration properties.

1// Example
2...
3  playSong() {
4    try {
5      SoundPlayer.playSoundFile('engagementParty', 'm4a')
6    } catch (e) {
7      alert('Cannot play the file')
8      console.log('cannot play the song file', e)
9    }
10  }
11
12  async getInfo() { // You need the keyword `async`
13    try {
14      const info = await SoundPlayer.getInfo() // Also, you need to await this because it is async
15      console.log('getInfo', info) // {duration: 12.416, currentTime: 7.691}
16    } catch (e) {
17      console.log('There is no song playing', e)
18    }
19  }
20
21  onPressPlayButton() {
22    this.playSong()
23    this.getInfo()
24  }
25
26...