This is an Example to Play Music / Sound in React Native App for Android and iOS. In the current time, every app developer or the app owner wants to make a different mark of its app on the user and to do that they have many options like making the UI very different or to put a rememberable thing which makes their app different from other.
While talking about the attractive thing I mean anything which makes your app rememberable. If you have noticed the sound of WhatsApp while sending a message or the different ringtone of Hangout the yu can understand what I mean. This both apps have their own identity with there sound and other than this app you also have many other apps which are known for some small sounds they make.
Here we are going to see how can you play music or sound in your React Native App. We will cover how to make sound from the local project directory and from the remote URL.
To Play Sound in React Native
To play Sound / Music in React Native app we are going to use Sound component provided by react-native-sound which support playing sound clips on iOS, Android, and Windows. react-native-sound does not support streaming.
You can run 3 different types of sounds using this library which are listed below:
- aac
- mp3
- wav
To play the sound from remote URL
1 2 3 4 5 6 7 8 9 10 | var sound1 = new Sound('https://raw.githubusercontent.com/zmxv/react-native-sound-demo/master/pew2.aac', '', (error, sound) => { if (error) { alert('error' + error.message); return; } sound1.play(() => { sound1.release(); }); }); |
From the local project directory
1 2 3 4 5 6 7 8 9 10 | var sound1 = new Sound(require('./pew2.aac'), (error, sound) => { if (error) { alert('error' + error.message); return; } sound1.play(() => { sound1.release(); }); }); |
To stop the sound
1 2 3 | sound4.stop(() => { console.log('Stop'); }); |
I think this is enough to know about the library, now let’s move towards the example. In this example, we are going to make a screen with a list which will have 6 types of different sound options. I have covered both the ways, play local sound and remote sound.
Now let’s get started with the example.
To Make a React Native App
Getting started with React Native will help you to know more about the way you can make a React Native project. We are going to use react-native init to make our React Native App. Assuming that you have node installed, you can use npm to install the react-native-cli command line utility. Open the terminal and go to the workspace and run
npm install -g react-native-cliRun the following commands to create a new React Native project
react-native init ProjectNameIf you want to start a new project with a specific React Native version, you can use the --version argument:
react-native init ProjectName --version X.XX.Xreact-native init ProjectName --version react-native@nextThis will make a project structure with an index file named App.js in your project directory.
Installation of Dependency
To use Sound component we have to install react-native-sound dependency. To install the dependency open the terminal and jump into your project
1 | cd ProjectName |
Now install the dependency
1 | npm install react-native-sound --save |
CocoaPods Installation
After the updation of React Native 0.60, they have introduced autolinking so we do not require to link the libraries but need to install pods. In this example, we need to install the pods for react-native-sound.
Please use the following command to install CocoaPods
1 | cd ios && pod install && cd .. |
Code to Play Music / Sound in React Native App
Now Open App.js in any code editor and replace the code with the following code.
App.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 | //Example to play music in React Native import React, { Component } from 'react'; //Import React import { StyleSheet, Text, TouchableOpacity, View, ScrollView, SafeAreaView, } from 'react-native'; //Import basic elements we need from React Native import Sound from 'react-native-sound'; //Import library for Sound Component //List of the dummy sound track const audioList = [ { title: 'Play mp3 sound from Local', isRequire: true, url: require('./advertising.mp3'), }, { title: 'Play mp3 sound from remote URL', url: 'https://raw.githubusercontent.com/zmxv/react-native-sound-demo/master/advertising.mp3', }, { title: 'Play aac sound from Local', isRequire: true, url: require('./pew2.aac'), }, { title: 'Play aac sound from remote URL', url: 'https://raw.githubusercontent.com/zmxv/react-native-sound-demo/master/pew2.aac', }, { title: 'Play wav sound from Local', isRequire: true, url: require('./frog.wav'), }, { title: 'Play wav sound from remote URL', url: 'https://raw.githubusercontent.com/zmxv/react-native-sound-demo/master/frog.wav', }, ]; var sound1, sound2, sound3, sound4, sound5, sound6; function playSound(item, index) { if (index == 0) { sound1 = new Sound(item.url, (error, sound) => { if (error) { alert('error' + error.message); return; } sound1.play(() => { sound1.release(); }); }); } else if (index == 1) { sound2 = new Sound(item.url, '', (error, sound) => { if (error) { alert('error' + error.message); return; } sound2.play(() => { sound2.release(); }); }); } else if (index == 2) { sound3 = new Sound(item.url, (error, sound) => { if (error) { alert('error' + error.message); return; } sound3.play(() => { sound3.release(); }); }); } else if (index == 3) { sound4 = new Sound(item.url, '', (error, sound) => { if (error) { alert('error' + error.message); return; } sound4.play(() => { sound4.release(); }); }); } else if (index == 4) { sound5 = new Sound(item.url, (error, sound) => { if (error) { alert('error' + error.message); return; } sound5.play(() => { sound5.release(); }); }); } else if (index == 5) { sound6 = new Sound(item.url, '', (error, sound) => { if (error) { alert('error' + error.message); return; } sound6.play(() => { sound6.release(); }); }); } } function stopSound(item, index) { if (index == 0 && sound1) { sound1.stop(() => { console.log('Stop'); }); } else if (index == 1 && sound2) { sound2.stop(() => { console.log('Stop'); }); } else if (index == 2 && sound3) { sound3.stop(() => { console.log('Stop'); }); } else if (index == 3 && sound4) { sound4.stop(() => { console.log('Stop'); }); } else if (index == 4 && sound5) { sound5.stop(() => { console.log('Stop'); }); } else if (index == 5 && sound6) { sound6.stop(() => { console.log('Stop'); }); } } function componentWillUnmount() { sound1.release(); sound2.release(); sound3.release(); sound4.release(); sound5.release(); sound6.release(); } class App extends Component { constructor(props) { super(props); Sound.setCategory('Playback', true); // true = mixWithOthers this.state = { tests: {}, }; } render() { return ( <SafeAreaView style={{ flex: 1 }}> <View style={styles.container}> <Text style={styles.headerTitle}> Example to Play Music in React Native </Text> <ScrollView style={styles.container}> {audioList.map((item, index) => { return ( <View style={styles.feature} key={item.title}> <Text style={{ flex: 1, fontSize: 14 }}>{item.title}</Text> <TouchableOpacity onPress={() => { return playSound(item, index); }}> <Text style={styles.buttonPlay}>Play</Text> </TouchableOpacity> <TouchableOpacity onPress={() => { return stopSound(item, index); }}> <Text style={styles.buttonStop}>Stop</Text> </TouchableOpacity> </View> ); })} </ScrollView> </View> </SafeAreaView> ); } } export default App; const styles = StyleSheet.create({ container: { flex: 1, }, headerTitle: { fontSize: 16, color: 'white', fontWeight: 'bold', paddingVertical: 20, textAlign: 'center', backgroundColor: 'rgba(00,00,80,1)', }, buttonPlay: { fontSize: 16, color: 'white', backgroundColor: 'rgba(00,80,00,1)', borderWidth: 1, borderColor: 'rgba(80,80,80,0.5)', overflow: 'hidden', paddingHorizontal: 15, paddingVertical: 7, }, buttonStop: { fontSize: 16, color: 'white', backgroundColor: 'rgba(80,00,00,1)', borderWidth: 1, borderColor: 'rgba(80,80,80,0.5)', overflow: 'hidden', paddingHorizontal: 15, paddingVertical: 7, }, feature: { flexDirection: 'row', padding: 10, alignSelf: 'stretch', alignItems: 'center', borderTopWidth: 1, borderTopColor: 'rgb(180,180,180)', borderBottomWidth: 1, borderBottomColor: 'rgb(230,230,230)', }, }); |
To Run the React Native App
Open the terminal again and jump into your project using.cd ProjectNamereact-native run-androidreact-native run-ios (macOS only).
This is how you can Play Music / Sound in React Native App for Android and iOS. If you have any doubt or you want to share something about the topic you can comment below or contact us here. There will be more posts coming soon. Stay tuned!
Hope you liked it. 🙂