React Native SDK Overview

The EnableX React Native SDK is designed for build hybrid applications for Android and iOS based devices. The SDK contains methods to communicate with EnableX Signalling and Media servers and to listen to event-based notifications during a session.

Getting Started

1. Install the React Native SDK through NPM. For installation instructions, click here.

2. Open the terminal.

3. Go to your React Native project directory and run the following command:

   npm install enx-rtc-react-native --save

4. To automatically install the dependencies in your project, run the following command:

   react-native link enx-rtc-react-native

5. Import enx-rtc-react-native into the class where you want to access the EnableX capabilities.

   import { Enx, EnxRoom, EnxStream, EnxPlayerView } from 'enx-rtc-react-native'

SDK Methods

The SDK provides several methods for implementing different features and functionalities. For more information, see SDK Methods.

Media Devices

The SDK provides several methods to access device cameras and microphones that can be used to create media streams to publish into the video rooms.

For more information, see Get Media Devices.

Stream Configuration

The SDK supports configuration of local and remote streams. For more information, see:

• Create a Local Stream
• Handle a Local Stream
• Handle a Remote Stream
• Play a Stream

Room Configuration

The SDK supports the following room configurations:

• Room Connection
• Room Information

In-session Communication

The SDK provides several methods for managing in-session communication including messaging, sending chat data, file sharing, screen sharing, canvas streaming, custom signalling, and annotations.

For more information, see In-session Communication.

Session Management

The SDK provides several methods for managing different aspects of video sessions including recording a session, muting or unmuting a room or a participant, forcing room entry restrictions, disconnecting a user from a session, extending, concluding, or destroying a session, switching participant roles, pinning or unpinning a user, spotlighting a user, and switching the room mode.

For more information, see Session Management.

Floor Access Control in Lecture Mode

Participants can request for floor access in the Lecture mode. The SDK provides different methods to implement floor access.

For more information, see Floor Access Control.

Live Statistics

The SDK provides several methods to obtain live statistics of local, remote, canvas streaming, and screen sharing during a session.

For more information, see Live Statistics.

Utilities

The SDK provides several methods for managing different aspects of video sessions through different utilities.

For more information, see Utilities.