https://github.com/yspreen/ffmpeg-kit-react-native-config
https://github.com/yspreen/ffmpeg-kit-react-native-config
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/yspreen/ffmpeg-kit-react-native-config
- Owner: yspreen
- Created: 2025-03-19T14:04:22.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-19T15:04:03.000Z (over 1 year ago)
- Last Synced: 2025-03-19T15:23:29.286Z (over 1 year ago)
- Language: JavaScript
- Size: 15.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# config-plugins/ffmpeg-kit-react-native
Config plugin to auto-configure `ffmpeg-kit-react-native` when the native code is generated (`npx expo prebuild`).
## Versioning
| `expo` | `ffmpeg-kit-react-native` | `@spreen/ffmpeg-kit-react-native-config` |
| ------ | ------------------------- | ---------------------------------------- |
| 52.0.0 | 6.0.2 | ^9.0.5 |
| 51.0.0 | 6.0.2 | ^8.0.0 |
| 50.0.0 | 6.0.2 | ^7.0.0 |
| 49.0.0 | 5.1.0 | ^6.0.0 |
| 48.0.0 | 5.1.0 | ^5.0.0 |
| 47.0.0 | 5.1.0 | ^4.0.0 |
| 46.0.0 | 4.5.2 | ^3.0.0 |
| 45.0.0 | 4.5.1 | ^2.0.0 |
## Expo installation
> Tested against Expo SDK 50. Most packages worked on iOS. Not all packages have been tested on Android.
> This package cannot be used in the "Expo Go" app because [it requires custom native code](https://docs.expo.io/workflow/customizing/).
First install the package with yarn, npm, or [`npx expo install`](https://docs.expo.io/workflow/expo-cli/#expo-install).
```sh
npx expo install ffmpeg-kit-react-native @spreen/ffmpeg-kit-react-native-config
```
After installing this npm package, add the [config plugin](https://docs.expo.io/guides/config-plugins/) to the [`plugins`](https://docs.expo.io/versions/latest/config/app/#plugins) array of your `app.json` or `app.config.js`:
```json
{
"expo": {
"plugins": ["@spreen/ffmpeg-kit-react-native-config"]
}
}
```
Next, rebuild your app as described in the ["Adding custom native code"](https://docs.expo.io/workflow/customizing/) guide.
## API
The plugin provides props for extra customization. Every time you change the props or plugins, you'll need to rebuild (and `prebuild`) the native app. If no extra properties are added, defaults will be used.
- `package` (_string_): Package to use. Options are: `min`, `min-gpl`, `https`, `https-gpl`, `audio`, `video`, `full`, `full-gpl`. [Learn more](https://github.com/tanersener/ffmpeg-kit/tree/main/react-native#211-package-names).
- `ios.package` (_string_): Specify an iOS-only package.
- `android.package` (_string_): Specify an Android-only package.
#### Example
```json
{
"plugins": [
[
"@spreen/ffmpeg-kit-react-native-config",
{
"package": "min",
"ios": {
"package": "video"
}
}
]
]
}
```
## Important Notes
- This plugin changes the minimum deployment target on Android to `24` (from `21`) which may break other packages in your app!
- Changing the "package" field on iOS will require re-running `pod install` after updating with `npx expo prebuild -p ios --no-install`.
- Most of the modifications in this plugin are dangerous meaning it's highly likely that something may break over time. The plugin is heavily unit-tested to attempt to prevent breaking.