https://github.com/mikehedman/react-native-simple-sound

React Native module for playing, pausing, and stopping sound clips
https://github.com/mikehedman/react-native-simple-sound

Last synced: about 2 months ago
JSON representation

React Native module for playing, pausing, and stopping sound clips

• Host: GitHub
• URL: https://github.com/mikehedman/react-native-simple-sound
• Owner: mikehedman
• License: mit
• Created: 2015-11-07T00:41:33.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2016-02-01T03:29:14.000Z (almost 9 years ago)
• Last Synced: 2024-11-15T02:41:44.427Z (2 months ago)
• Language: Objective-C
• Size: 6.84 KB
• Stars: 11
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-react-native - react-native-simple-sound ★11 - Start, stop, and pause a sound. iOS only. Derived from `react-native-sound` (Components / Media)
• awesome-react-native - react-native-simple-sound ★11 - Start, stop, and pause a sound. iOS only. Derived from `react-native-sound` (Components / Media)
• awesome-react-native - react-native-simple-sound ★11 - Start, stop, and pause a sound. iOS only. Derived from `react-native-sound` (Components / Media)
• awesome-react-native - react-native-simple-sound ★11 - Start, stop, and pause a sound. iOS only. Derived from `react-native-sound` (Components / Media)
• awesome-react-native-ui - react-native-simple-sound ★9 - Start, stop, and pause a sound. iOS only. Derived from https://github.com/zmxv/react-native-sound (Components / Media)

README

        
# react-native-simple-sound

React Native module for playing, pausing, and stopping sound clips.

Derived from [react-native-sound](https://github.com/zmxv/react-native-sound), which allows multiple sound files to be played at once, but does not offer pause or stop.

## Installation

```javascript

npm install react-native-simple-sound --save

```

In XCode, right click **Libraries**.

Click **Add Files to "[Your project]"**.

Navigate to **node_modules/react-native-simple-sound**.

Add the file **RNSimpleSound.xcodeproj**.

In the project navigator, select your project.

Click the build target.

Click **Build Phases**.

Expand **Link Binary With Libraries**.

Click the plus button and add **libRNSimpleSound.a** under **Workspace**.

Run your project (⌘+R).

## Example

```js

var Sound = require('react-native-simple-sound');

Sound.enable(true); // Enable sound

Sound.prepare('tap.aac'); // Preload the sound file 'tap.aac' in the app bundle

Sound.play(); // Play the sound 'tap.aac'

Sound.pause(); // Pause the sound

Sound.play(); // Resume playing the sound

Sound.stop(); // Stop and reset the sound.

```

## Notes

- Sound.enable(true) must be called before playing any sound.

- Sound.prepare(...) must be called before playing - preloads a sound file and prepares it for playback.

- To change sounds, stop() the current sound and call prepare() with the new sound.

- The module wraps AVAudioPlayer which supports aac, aiff, mp3, wav etc. The full list of supported formats can be found [here](https://developer.apple.com/library/ios/documentation/AudioVideo/Conceptual/MultimediaPG/UsingAudio/UsingAudio.html).

- The stop() function resets the sound back to the beginning, this is different from the standard behavior of AVAudioPlayer

- Sound files must be in the bundle (in your app's main folder in Xcode)