react-native-compressor

Before building your app, you must start Metro, the JavaScript build tool for React Native. Run this command from the root of your project:

# Using npm
npm start

# OR using Yarn
yarn start

React Native

Install using yarn:

yarn add react-native-compressor

Note: Automatic linking is supported for React Native >= 0.60 for both Android and iOS.

For React Native <= 0.59, you must link manually:

react-native link react-native-compressor

If automatic linking fails, follow these steps for Android:

1. Modify MainActivity.java:

   • Add import com.reactnativecompressor.CompressorPackage; to the imports.
   • Add new CompressorPackage() to the list returned by the getPackages() method.

2. Modify android/settings.gradle: Append these lines:

   include ':react-native-compressor'
   project(':react-native-compressor').projectDir = new File(rootProject.projectDir,'../node_modules/react-native-compressor/android')

3. Modify android/app/build.gradle: Insert this line inside the dependencies block:

   compile project(':react-native-compressor')

If automatic linking fails, follow these steps for iOS:

1. Open your Podfile in Xcode.
2. Paste the following line: pod 'react-native-compressor', :path => '../node_modules/react-native-compressor'.
3. Run pod install inside the ios folder.
4. Run your project.

If you want to clear the existing example code and start with a blank project structure, run the following command:

npm run reset-project

This will move the current starter code into the app-example directory and create a fresh, empty app directory for your own development.

To run the provided Expo example project, follow these steps:

1. Install the project dependencies:

   npm install

2. Start the Expo development server:

   npx expo start

Once the server is running, you can open the app in a development build, an Android emulator, an iOS simulator, or Expo Go.

For iOS, you must first install CocoaPods dependencies. If this is your first time or you have updated native dependencies, run bundle exec pod install. Then, run the following command to launch the app on an iOS Simulator or connected device:

# Install CocoaPods dependencies
bundle exec pod install

# Using npm
npm run ios

# OR using Yarn
yarn ios

If you need to forcefully reload the app to reset its state, use the following platform-specific shortcuts:

• Android: Press the <kbd>R</kbd> key twice or select "Reload" from the Dev Menu (accessed via <kbd>Ctrl</kbd> + <kbd>M</kbd> on Windows/Linux or <kbd>Cmd ⌘</kbd> + <kbd>M</kbd> on macOS).
• iOS: Press <kbd>R</kbd> in the iOS Simulator.

To use react-native-compressor in a Managed Expo project, follow these steps:

1. Install the package:

expo install react-native-compressor

2. Add the Compressor plugin to your Expo config (app.json, app.config.json, or app.config.js):

{
  "name": "my app",
  "plugins": ["react-native-compressor"]
}

3. Run prebuild to compile the mods:

expo prebuild

4. Build a new binary with EAS:

eas build

With Metro running, open a new terminal and run the following command to build and launch the app on an Android Emulator or connected device:

# Using npm
npm run android

# OR using Yarn
yarn android

Use the Audio module to compress audio files. You can use preset quality levels or manual bitrate/samplerate settings.

Using Quality Presets

import { Audio } from 'react-native-compressor';

const result = await Audio.compress(
  'file://path_of_file/file_example_MP3_2MG.wav',
  { quality: 'medium' }
);

Manual Settings

import { Audio } from 'react-native-compressor';

const result = await Audio.compress(
  'file://path_of_file/file_example_MP3_2MG.wav',
  {
    bitrate: 64000,
    samplerate: 44100,
    channels: 1,
  }
);

Use generateFilePath to create a random file path within the cache directory for saving files.

import { generateFilePath } from 'react-native-compressor';

const randomFilePath = await generateFilePath('mp4'); // file://file_path.mp4

import { generateFilePath } from 'react-native-compressor';

const randomFilePathForSaveFile = await generateFilePath('mp4'); // file://file_path.mp4