# react-native-twilio-video-webrtc

**Repository Path**: mirrors_twilio/react-native-twilio-video-webrtc

## Basic Information

- **Project Name**: react-native-twilio-video-webrtc
- **Description**: Twilio Video (WebRTC) for React Native
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-05
- **Last Updated**: 2026-06-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Twilio Video (WebRTC) for React Native

This is a Twilio-maintained fork of [blackuy/react-native-twilio-video-webrtc](https://github.com/blackuy/react-native-twilio-video-webrtc). This React Native SDK allows you to add real-time video calling to your React Native apps. If you are new to Twilio Video, check out the developer documentation [here](https://www.twilio.com/docs/video).

[![GitHub License](https://img.shields.io/github/license/twilio/react-native-twilio-video-webrtc)](https://github.com/twilio/react-native-twilio-video-webrtc/blob/master/LICENSE)
[![NPM version](https://img.shields.io/npm/v/@twilio/video-react-native-sdk)](https://www.npmjs.com/package/@twilio/video-react-native-sdk)

Platforms:

- iOS
- Android

### Install Node Package

[![NPM version](https://img.shields.io/npm/v/@twilio/video-react-native-sdk)](https://www.npmjs.com/package/@twilio/video-react-native-sdk)

#### Option A: yarn

```shell
yarn add @twilio/video-react-native-sdk
```

#### Option B: npm

```shell
npm install @twilio/video-react-native-sdk
```

### Usage with Expo

To use this library with [`Expo`](https://expo.dev) we recommend using our config plugin that you can configure like the following example:

```json
{
  "name": "my app",
  "plugins": [
    [
      "@twilio/video-react-native-sdk",
      {
        "cameraPermission": "Allow $(PRODUCT_NAME) to access your camera",
        "microphonePermission": "Allow $(PRODUCT_NAME) to access your microphone"
      }
    ]
  ]
}
```

Also, you will need to install `expo-build-properties` package:

```shell
npx expo install expo-build-properties
```

#### Expo Config Plugin Props

The plugin support the following properties:

- `cameraPermission`: Specifies the text to show when requesting the camera permission to the user.

- `microphonePermission`: Specifies the text to show when requesting the microphone permission to the user.

#### Permissions

To enable camera usage and microphone usage you will need to add the following entries to your `Info.plist` file:

```
<key>NSCameraUsageDescription</key>
<string>Your message to user when the camera is accessed for the first time</string>
<key>NSMicrophoneUsageDescription</key>
<string>Your message to user when the microphone is accessed for the first time</string>
```

## Docs

You can see the API documentation [here](./docs).

## Usage

We have three important components to understand:

```javascript
import {
  TwilioVideo,
  TwilioVideoLocalView,
  TwilioVideoParticipantView,
} from "@twilio/video-react-native-sdk";
```

- `TwilioVideo` / is responsible for connecting to rooms, events delivery and camera/audio.
- `TwilioVideoLocalView` / is responsible for the local camera feed
- `TwilioVideoParticipantView` / is responsible for a remote peer's camera feed

The [Example App](./ExampleApp) provides an example how the Video React Native SDK can be used.

**Before running the Example App**, ensure you first install dependencies in the root SDK directory to generate the version constants:
```shell
yarn install
```
Please check out the Example App's [README](./ExampleApp/README.md) for more details.

## Contributing

### Version Constants

The SDK version is embedded in both iOS and Android native code for reporting to Twilio Video Insights. This is handled automatically:

- **Template files**: `ios/RCTTWVideoConstants.h.template` and `android/src/main/java/com/twiliorn/library/TwilioVideoConstants.java.template`
- **Generated files**: `ios/RCTTWVideoConstants.h` and `android/.../TwilioVideoConstants.java` (gitignored)

The `prepare` script runs automatically on `yarn install` and before `npm publish`, generating the constants from `package.json` version.

**Important for contributors:**
- Never edit the generated `.h` or `.java` files directly - they will be overwritten
- Edit the `.template` files if you need to change the structure
- The version is the single source of truth from `package.json`

To manually regenerate constants:
```shell
yarn build:constants
```

## License

See [LICENSE](https://github.com/twilio/react-native-twilio-video-webrtc/blob/master/LICENSE)