https://github.com/apivideo/api.video-reactnative-uploader
The official ReactNative video uploader for api.video
https://github.com/apivideo/api.video-reactnative-uploader
react-native video video-uploader
Last synced: about 1 year ago
JSON representation
The official ReactNative video uploader for api.video
- Host: GitHub
- URL: https://github.com/apivideo/api.video-reactnative-uploader
- Owner: apivideo
- License: mit
- Created: 2021-09-01T07:56:02.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-01-28T10:51:07.000Z (over 1 year ago)
- Last Synced: 2025-03-23T19:44:41.716Z (over 1 year ago)
- Topics: react-native, video, video-uploader
- Language: Kotlin
- Homepage: https://api.video
- Size: 3.07 MB
- Stars: 17
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://twitter.com/intent/follow?screen_name=api_video) [](https://github.com/apivideo/api.video-reactnative-uploader) [](https://community.api.video)
 
api.video React Native video uploader module
[api.video](https://api.video) is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in your app.
## Table of contents
- [Table of contents](#table-of-contents)
- [Project description](#project-description)
- [Getting started](#getting-started)
- [Installation](#installation)
- [Code sample](#code-sample)
- [Regular upload](#regular-upload)
- [Progressive upload](#progressive-upload)
- [Android](#android)
- [Permissions](#permissions)
- [Notifications](#notifications)
- [Example](#example)
- [Dependencies](#dependencies)
- [FAQ](#faq)
## Project description
This module is an easy way to upload video with delegated token to api.video
## Getting started
### Installation
```sh
npm install @api.video/react-native-video-uploader
```
or
```sh
yarn add @api.video/react-native-video-uploader
```
### Code sample
#### Regular upload
```js
import ApiVideoUploader from '@api.video/react-native-video-uploader';
ApiVideoUploader.uploadWithUploadToken('YOUR_UPLOAD_TOKEN', 'path/to/my-video.mp4')
.then((value: Video) => {
// Manages success here
})
.catch((e: any) => {
// Manages error here
});
```
#### Progressive upload
For more details about progressive uploads, see the [progressive upload documentation](https://docs.api.video/vod/progressive-upload).
```js
import ApiVideoUploader from '@api.video/react-native-video-uploader';
(async () => {
const uploadSession = ApiVideoUploader.createProgressiveUploadSession({token: 'YOUR_UPLOAD_TOKEN'});
try {
await session.uploadPart("path/to/video.mp4.part1");
await session.uploadPart("path/to/video.mp4.part2");
// ...
const video = await session.uploadLastPart("path/to/video.mp4.partn");
// ...
} catch(e: any) {
// Manages error here
}
})();
```
### Android
#### Permissions
Permissions `android.permission.READ_MEDIA_VIDEO` (for API 33+) or `android.permission.READ_EXTERNAL_STORAGE` (for API < 33) are in the library manifest and will be requested by this library at runtime. You don't have to request them in your application.
On Android 33+, the upload comes with a notification to show the progress. So if your application targets Android 33+, you might request `android.permission.POST_NOTIFICATIONS` permission at runtime.
When targeting Android API Level 34+, you must declare the service type in your application's manifest file.
In your `AndroidManifest.xml` file, add the following lines in the `` tag:
```xml
```
#### Notifications
To customize the notification to your own brand, you can change the icon, color or channel name by overwriting the following resources in your own application resources:
- the icon: `R.drawable.ic_upload_notification`
- the color: `R.color.upload_notification_color`
- the channel name: `R.string.upload_notification_channel_name`
## Example
An example that demonstrates how to use the API is provided in folder [example/](https://github.com/apivideo/api.video-reactnative-uploader/tree/main/example).
To run the example:
- for Android:
`yarn && yarn example android`
- for iOS:
`yarn && yarn example ios`
## Dependencies
api.video-reactnative-uploader is using external libraries.
| Plugin | README |
| ---------------------- | ------------------------ |
| swift-video-uploader | [swift-video-uploader] |
| android-video-uploader | [android-video-uploader] |
## FAQ
If you have any questions, ask [our community](https://community.api.video) or use [Issues].
[//]: # "These are reference links used in the body of this note and get stripped out when the markdown processor does its job. There is no need to format nicely because it shouldn't be seen. Thanks SO - http://stackoverflow.com/questions/4823468/store-comments-in-markdown-syntax"
[swift-video-uploader]: https://github.com/apivideo/api.video-swift-uploader
[android-video-uploader]: https://github.com/apivideo/api.video-android-uploader
[issues]: https://github.com/apivideo/api.video-reactnative-uploader/issues