Voximplant SDK for React Native

Voximplant Mobile SDK module for React Native. It lets developers embed realtime voice and video communication into React Native apps and works together with Voximplant cloud platform. The SDK uses WebRTC for media processing.

Voximplant-SDK-for-React-Native

Getting started

iOS

Manual install

  1. Make sure you have "React Native" project created with react-native init
  2. cd into a project directory where package.json file is located.
  3. Run npm install react-native-voximplant@latest --save.
  4. Open or create ios/Podfile and add the following dependencies:
pod 'React', :path => ‘../node_modules/react-native', :subspecs => [
'Core',
'RCTImage',
'RCTNetwork',
'RCTText',
'RCTWebSocket',
'DevSupport',
'BatchedBridge'
# Add any other subspecs you want to use in your project
]
pod 'react-native-voximplant', path: '../node_modules/react-native-voximplant'
pod 'Yoga', path: '../node_modules/react-native/ReactCommon/yoga'

Please take a look at the demo project Podfile as an example.

  1. Run pod install from <your_project>/ios/
  2. Start XCode and open generated <your_project>.xcworkspace
  3. Check in project navigation that there is no *.xcodeproj in Libraries section. In case of any please remove them. Since React dependencies are added via Podfile, double integration of its modules may lead to unpredictable/incorrect behavior of an application.
  4. Run your project (Cmd+R)

Android

Manual install

  1. Make sure you have "React Native" project created with react-native init

  2. cd into a project directory where package.json file is located.

  3. Run npm install react-native-voximplant@latest --save

  4. Open up android/app/main/java/[...]/MainApplication.java

    • Add import com.voximplant.reactnative.VoxImplantReactPackage; to the imports at the top of the file
    • Add new VoxImplantReactPackage() to the list returned by the getPackages() method

  5. Append the following lines to android/settings.gradle:

    include ':react-native-voximplant'
project(':react-native-voximplant').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-voximplant/android')

  6. Insert the following lines inside the dependencies block in android/app/build.gradle:

    compile project(':react-native-voximplant')

Usage

import the react-native-voximplant module:

import VoxImplant from "react-native-voximplant";

Add event listeners using DeviceEventEmitter:

DeviceEventEmitter.addListener(
    'ConnectionSuccessful',
    () => {
        console.log('Connection successful');
    }
);

All events are described at http://voximplant.com/docs/references/mobilesdk/ios/Protocols/VoxImplantDelegate.html

Connect the SDK to the cloud:

VoxImplant.SDK.connect();

Make calls:

VoxImplant.SDK.createCall(number, video, null, function(callId) {
  currentCallId = callId;      
  VoxImplant.SDK.startCall(callId);      
});

Receive calls:

DeviceEventEmitter.addListener(
  'IncomingCall',
    (incomingCall) => {
        console.log('Inbound call');
        currentCallId = incomingCall.callId;
        // answer call VoxImplant.SDK.answerCall(currentCallId);
        // or
        // reject call VoxImplant.SDK.declineCall(currentCallId);
    }
);

All methods are described at http://voximplant.com/docs/references/mobilesdk/ios/Classes/VoxImplant.html

Video view components:

    /* remote video */
    <VoxImplant.RemoteView style={styles.remotevideo}>
    </VoxImplant.RemoteView>
    /* camera preview (local) */
    <VoxImplant.Preview style={styles.selfview}>
    </VoxImplant.Preview>

You will need free VoxImplant developer account setup for making and receiving calls using the SDK. Learn more at http://voximplant.com/docs/quickstart/1/your-first-voximplant-application/

Todo

These are some features I think would be important/beneficial to have included with this module. Pull requests welcome!

  • [ ] Add InstantMessaging/Presence support

GitHub