react-native-audio-streaming

React native audio streaming library for android and iOS

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
react-native-audio-streaming
781872.3.27 years ago8 years agoMinified + gzip package size for react-native-audio-streaming in KB

Popular Searches

Readme

react-native-audio-streaming

Features

  • Background audio streaming of remote stream
  • Control via sticky notification on android and media center on iOS
  • Shoutcast/Icy meta data support
  • Simple UI player component (if needed, an api to control the sound is available)

If you are only looking to play local audio file with app in foreground, please see other audio libs.
Demo iOS Demo android

First installation step (applied for both iOS & Android)

$ npm install react-native-audio-streaming --save

Next installation steps for iOS (choose one of three options below)

  1. Cocoapods installation

  1. add pod 'RNAudioStreaming', :path => '../node_modules/react-native-audio-streaming' to Podfile
  2. run pod install

  1. Mostly automatic installation

$ react-native link react-native-audio-streaming
Go to node_modules ➜ react-native-audio-streaming => ios => Pods and drag/drop Pods.xcodeproj to the Libraries folder in your XCode project.
In XCode, in the project navigator, select your project. Add libReactNativeAudioStreaming.a and libStreamingKit.a to your project's Build Phases ➜ Link Binary With Libraries

  1. Manual installation

  1. In XCode, in the project navigator, right click Libraries ➜ Add Files to [your project's name]
  2. Go to node_modules ➜ react-native-audio-streaming => ios
- run `pod install` to download StreamingKit dependency
- add `ReactNativeAudioStreaming.xcodeproj` to the Libraries folder in your XCode project
- add `Pods/Pods.xcodeproj` to the Libraries folder in your XCode project
  1. In XCode, in the project navigator, select your project. Add libReactNativeAudioStreaming.a and libStreamingKit.a to your project's Build Phases ➜ Link Binary With Libraries
  2. Run your project (Cmd+R)

Final steps for iOS (required after doing any of three options above)

  1. Make sure $(SRCROOT)/../node_modules/react-native-audio-streaming/ios is added to your project's Header Search Paths within the Build Settings section.

  1. Update Info.plist file of your Xcode project and add audio background mode

<key>UIBackgroundModes</key>
<array>
  <string>audio</string>
</array>

Next installation steps for Android

  1. Open up android/app/src/main/java/[...]/MainApplication.java
- Add import com.audioStreaming.ReactNativeAudioStreamingPackage; to the imports at the top of the file - Add new ReactNativeAudioStreamingPackage() to the list returned by the getPackages() method If you're using Android 23 or above - Add new ReactNativeAudioStreamingPackage(MainActivity.class) to he list returned by the getPackages()method instead.
  1. Append the following lines to android/settings.gradle:
``` include ':react-native-audio-streaming' project(':react-native-audio-streaming').projectDir = new File(rootProject.projectDir, '../nodemodules/react-native-audio-streaming/android') `` 3. Insert the following lines inside the dependencies block in android/app/build.gradle`: ```
compile project(':react-native-audio-streaming')
```

Usage

Playing sound (similar code used by the player UI)

import { ReactNativeAudioStreaming } from 'react-native-audio-streaming';

const url = "http://lacavewebradio.chickenkiller.com:8000/stream.mp3";
ReactNativeAudioStreaming.pause();
ReactNativeAudioStreaming.resume();
ReactNativeAudioStreaming.play(url, {showIniOSMediaCenter: true, showInAndroidNotifications: true});
ReactNativeAudioStreaming.stop();

For more information see the Example app.

Player UI

import { Player } from 'react-native-audio-streaming';

class PlayerUI extends Component {
  render() {
    return (
        <Player url={"http://lacavewebradio.chickenkiller.com:8000/stream.mp3"} />
    );
  }
}

TODO

  • Allow to play local files
  • Allow to specify custom style for the android notification (maybe a custom view ?)
  • Allow to specify custom styles for the player
  • Handle artwork of artist
  • Add tests

Other RN audio projects

Credits

  • Android version based on the work of @EstebanFuentealba https://github.com/EstebanFuentealba/react-native-android-audio-streaming-aac
  • iOS version based on the work of @jhabdas https://github.com/jhabdas/lumpen-radio

See also the list of contributors who participated in this project.

Contribute

Since symlink support is still lacking on React Native, I use the wml cli tool created by the nice folks at wix.
wml add ~/react-native-audio-streaming ~/react-native-audio-streaming/Example/node_modules/react-native-audio-streaming

Changelog

License

This project is licensed under the MIT License - see the LICENSE file for details