Git Product home page Git Product logo

react-native-notification-sounds's Introduction

react-native-notification-sounds

Example Implementation

Getting started

$ npm install react-native-notification-sounds --save

Mostly automatic installation

$ react-native link react-native-notification-sounds

Manual installation

iOS

  1. In XCode, in the project navigator, right click LibrariesAdd Files to [your project's name]
  2. Go to node_modulesreact-native-notification-sounds and add NotificationSounds.xcodeproj
  3. In XCode, in the project navigator, select your project. Add libNotificationSounds.a to your project's Build PhasesLink Binary With Libraries
  4. Run your project (Cmd+R)<

Android

  1. Open up android/app/src/main/java/[...]/MainApplication.java
  • Add import com.reactlibrary.NotificationSoundsPackage; to the imports at the top of the file
  • Add new NotificationSoundsPackage() to the list returned by the getPackages() method
  1. Append the following lines to android/settings.gradle:
include ':react-native-notification-sounds'
project(':react-native-notification-sounds').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-notification-sounds/android')
  1. Insert the following lines inside the dependencies block in android/app/build.gradle:
compile project(':react-native-notification-sounds')

Usage

import NotificationSounds, { playSampleSound } from  'react-native-notification-sounds';
/*
get the list of System notification sounds. This function returns an array the array contains Title, Url, SoundID
You can pass the following values to the getNotifications:
1. notification: get the list of notification sounds
2. ringtone: get the list of ringtones
3. alarm: get the list of alarm sounds (android only)
*/
NotificationSounds.getNotifications('notification').then(soundsList  => {
	console.warn('SOUNDS', JSON.stringify(soundsList));
	/*
	Play the notification sound.
	pass the complete sound object.
	This function can be used for playing the sample sound
	*/
	playSampleSound(soundsList[1]);
	// if you want to stop any playing sound just call:
	// stopSampleSound();
});

🔥 Methods

Name Description
playSampleSound(SoundItem) Plays the sound item returned by getNotifications(type)
stopSampleSound() call this function to stop the current playing sound
NotificationSounds.getNotifications(type) A promise which returns list of the system sounds filtered by the type. Type can have any of the (notification, ringtone, alarm (android only) ) values

🔥 Features

✅ Get the list of system notification or ringtone sounds.
Filter the sounds by notification, ringtone or alarm.
Play the sound without installing any other library
✅ Stop the currently playing notification sound.

Important Note

Unfortunately, this library WILL NOT return any files in the iOS simulator. You must run it on a real iOS device (iPhone, iPad, iPod Touch).

📄 License

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

react-native-notification-sounds's People

Contributors

mateww avatar pm-florian avatar saadqbal avatar stefan521 avatar xcarpentier avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.