https://github.com/voiceittech/voiceit2-react-native-sdk
VoiceIt
https://github.com/voiceittech/voiceit2-react-native-sdk
Last synced: about 1 year ago
JSON representation
VoiceIt
- Host: GitHub
- URL: https://github.com/voiceittech/voiceit2-react-native-sdk
- Owner: voiceittech
- Created: 2020-07-11T17:23:18.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2023-12-22T01:11:12.000Z (over 2 years ago)
- Last Synced: 2025-02-15T00:05:19.930Z (over 1 year ago)
- Language: Java
- Size: 218 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# react-native-voiceit
* [Getting Started](#getting-started)
* [Billing](#billing)
* [Voiceprint Phrases](#voiceprint-phrases)
* [Plist Permissions](#plist-permissions)
* [Local Installation ](#local-installation)
* [Android](#android)
* [IOS](#ios)
* [Usage](#usage)
* [Funtions](#functions)
* [User Token Initializing](#user-token)
* [Theme Color](#theme)
## Getting started
`$ npm install react-native-voiceit --save`
## Requirements
#### IOS Deployment Target (IOS Version)
Please make sure that the minimum Deployment Target for your project is IOS 11
#### Android SDK Version
The minumum Android SDK version (API level) should be set to 17 in your build.gradle file:
```
minSdkVersion: 17
```
#### Billing
In order to use en-US or other content languages you need to have a developer account that has funds. In order to add funds to your account please login at: https://voiceit.io/login and navigate to: https://voiceit.io/billing and add funds.
#### Voiceprint Phrases
Make sure you review your Voiceprint Phrases by navigating to: https://voiceit.io/phraseManagement in order to know what to pass for voicePrintPhrase parameter
#### Plist Permissions
For IOS, please make sure your project has Camera and Microphone permissions in the info.plist file. Also, make sure that the app runs in light theme. Add the following inside the XML:
```
NSCameraUsageDescription
This app requires to access your camera for biometric services
NSMicrophoneUsageDescription
This app requires to access your microphone for biometric services
UIUserInterfaceStyle
Light
```
### Mostly automatic installation
`$ react-native link react-native-voiceit`
## Local Installation
Firstly, to use the SDK locally, please clone the repo and drag it into your root React Native project. In the Package.json, replace to "react-native-voiceit": "file:./VoiceIt2-React-Native-SDK"
#### Android
Get the Android-SDK locally by doing the following:
- Clone the Android-SDK repo
- Open your main android project/folder in android studio, and navigate to File -> New -> Import Module
- Select the Android SDK repo that you just cloned. Check off the app module, only include the voiceit2 module
- Navigate to you local VoiceIt2-React-Native-SDK Folder
- In the android/build.gradle, add
```
implementation project(path: ':voiceit2')
```
under dependencies
#### IOS
Please navigate to the podfile of your main IOS folder, and replace to:
```
pod 'react-native-voiceit', :path => '../VoiceIt2-React-Native-SDK'
pod "VoiceIt2-IosSDK", :path => './VoiceIt2-IosSDK'
```
## Usage
```javascript
import {NativeModules} from 'react-native';
const Voiceit = NativeModules.Voiceit;
// Initialize the VoiceIt Native Module
// Voiceit.init("API_KEY","API_TOKEN",(res)=>{
// console.log(res);
// } ;
// Call the methods with the same signature as the IOS/Android SDK. For instance
// Voiceit.encapsulatedFaceEnrollment("USR_ID",(res)=>{
// console.log(res);
// });
```
#### Functions
Initialize the module as follows:
```
import {NativeModules} from 'react-native';
const Voiceit = NativeModules.Voiceit;
Voiceit.initVoiceIt("API_KEY","API_TOKEN",(res)=>{
console.log(res);
};
```
The React Native SDK wraps the IOS and Android SDKs, and hence the methods exposed are the same as those.
Please refer to the [The Android SDK](https://github.com/voiceittech/VoiceIt2-AndroidSDK)/[The IOS SDK](https://github.com/voiceittech/VoiceIt2-IosSDK) for complete method reference. For instance
```
voiceItModule.encapsulatedFaceVerification("USER_ID","CONTENT_LANGUAGE", LIVENESS_BOOLEAN, AUDIO_LIVENESS_BOOLEAN, (res)=>{
callback(res);
});
```
#### User Token
To initialize Voiceit Module with User token and not use your API key and token, first generate a user token: https://api.voiceit.io/#user-token-generation
Initialize Voiceit by placing the generated user token in palce of the API Key, and leave the API token as blank:
```
Voiceit.initVoiceIt("GENERATED_USER_TOKEN","",(res)=>{
console.log(res);
};
```
#### Theme
To set a theme color, please initialize the voiceit Object as follows:
```
Voiceit.initVoiceItWithTheme("API_KEY","API_TOKEN", "HEX_COLOR_VALUE",(res)=>{
console.log(res);
};
```
Example:
```
Voiceit.initVoiceItWithTheme("key_...","tok_.....", "#fbc132",(res)=>{
console.log(res);
};
```