@banuba/react-native
v1.0.2
Published
Banuba SDK for React Native
Downloads
81
Readme
React Native Face AR SDK is a version of Banuba Face AR SDK. It is intended to provide a suite of augmented reality features applicable on photos and live video feed (live streaming, video conferencing, etc.). The package includes:
- Face and hand tracking
- 3D face filters
- Virtual try-on of jewelry, cosmetics, headwear, glasses, contacts, and more
- Color filters (LUTs)
- Face touch-up
- Virtual backgrounds
- Screen recording, take screenshot
- etc.
Requirements
Usage
Token
Before you commit to a license, you are free to test all the features of the SDK for free. To start it, send us a message.
Feel free to contact us if you have any questions.
Getting Started
- Clone the repository, ensure that you have setted up React Native CLI development environment.
- Copy and Paste your Client Token into appropriate section of
example/src/App.tsx
. - Run
yarn
command. This will install all required dependences. - (iOS only) Go to
example/ios
directory and runpod install
. Return back to root. This will install all required iOS dependencies. - Connect a device and run
yarn example ios
oryarn example android
. Alternatively you may may open XCode or Android Studio projects fromexample/ios
andexample/android
directories.
You may also use npm
to run the sample. See example/README.md.
Integration steps
This is how to integrate Banuba SDK into existing React Native app. You still need a Client Token for this.
- Add
@banuba/react-native
dependency:yarn add @banuba/react-native
. - For iOS: add a link to the native Banuba SDK into
ios/Podfile
:source 'https://github.com/sdk-banuba/banuba-sdk-podspecs.git'
, add desired$bnb_sdk_version = '~> 1.13.0
, list Banuba SDK packages you need. For Android: add our maven repository, defineext.bnb_sdk_version
. Inexample/android/app/build.gradle
list the packages you need. - Add code from
example/src/App.tsx
into your app. - Add
effects
folder into your project. Link it with your app- iOS: just link effects folder into XCode project (
File
->Add Files to ...
). - Android: add the following code into app
build.gradle
.
- iOS: just link effects folder into XCode project (
- For iOS: add
NSCameraUsageDescription
.
Docs
Refer this file about availabl API. You can find more info about Banuba Face AR SDK here.
Made with create-react-native-library