React Native library for using OpenTok / Vonage Video API. This library is officially supported by Vonage.
📚 For complete documentation, installation instructions, API reference, and samples, visit:
https://tokbox.com/developer/sdks/react-native/
npm install opentok-react-native@<VERSION>
# or
yarn add opentok-react-native@<VERSION>Note: Replace <VERSION> with the target version to use.
For complete installation instructions including iOS and Android setup, see the official installation guide.
<OTSession apiKey="your-api-key" sessionId="your-session-id" token="your-session-token">
<OTPublisher style={{ width: 100, height: 100 }}/>
<OTSubscriber style={{ width: 100, height: 100 }} />
</OTSession>Starting from version 2.31.1, the OpenTok React Native SDK is built with the React Native new architecture.
- ✅ Supported: React Native 0.76+ (new architecture)
- ❌ Not supported: Older React Native versions (legacy architecture)
Applications using older SDK versions will need to migrate to React Native's new architecture before upgrading. See the installation guide for required package registration steps.
| Resource | Link |
|---|---|
| SDK Documentation | https://tokbox.com/developer/sdks/react-native/ |
| API Reference | https://tokbox.com/developer/sdks/react-native/reference |
| Sample Applications | opentok-react-native-samples |
| Release Notes | https://tokbox.com/developer/sdks/react-native/release-notes |
| Developer Guides | https://tokbox.com/developer/guides |
To see this library in action, check out the opentok-react-native-samples repo, which includes:
- Basic Video Chat - Connect, publish, and subscribe to streams
- Archiving - Display recording indicators
- Background Blur - Apply video transformers
- Multiparty - Manage multiple participants
- Signaling - Send and receive text signals
- Screen Sharing - Publish screen-sharing streams
Interested in contributing? We ❤️ pull requests! See the Contribution guidelines.
We love to hear from you! If you have questions, comments, or find a bug in the project, let us know:
- Open an issue on this repository
- Visit support: https://support.tokbox.com/
- Tweet at us: @VonageDev
- Join the community: Vonage Developer Community Slack
This project is licensed under the Adobe-2 License. See the LICENSE file for details.