api.video React Native video uploader

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.

Project description

This module is an easy way to upload video with delegated token to api.video

Getting started

Installation

npm install @api.video/react-native-video-uploader

or

yarn add @api.video/react-native-video-uploader

Note: if you are on iOS, you will need two extra steps:

  1. Don't forget to install the native dependencies with Cocoapods
cd ios && pod install
  1. This project contains Swift code, and if it's your first dependency with Swift code, you need to create an empty Swift file in your project (with the bridging header) from XCode. Find how to do that

Code sample

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
  });

Android

Permissions

Permissions android.permission.READ_MEDIA_VIDEO (for API 33+) or android.permission.READ_EXTERNAL_STORAGE (for API < 33) will be requested by this library at runtime.

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 <application> tag:

    <service
        android:name="androidx.work.impl.foreground.SystemForegroundService"
        android:foregroundServiceType="location|dataSync"
        tools:node="merge" />

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/.

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.

PluginREADME
swift-video-uploaderswift-video-uploader
android-video-uploaderandroid-video-uploader

FAQ

If you have any questions, ask our community or use Issues.

Was this page helpful?