@videosdk.live/react-native-sdk

Version:

docs.videosdk.live/docs/realtime-communication/sdk-reference/react-native-sdk/setup

101 lines (75 loc) • 7.32 kB

Markdown

<h1 align="center"> <img src="https://cdn.videosdk.live/docs/images/react-native/banner.png" /><br/> </h1> <p align="center"> <a href="https://www.npmjs.com/package/@videosdk.live/react-native-sdk"> <img src="https://img.shields.io/npm/dw/@videosdk.live/react-native-sdk.svg?style=for-the-badge" alt="NPM downloads" /> </a> <a href="https://www.npmjs.com/package/@videosdk.live/react-native-sdk"> <img src="https://img.shields.io/npm/v/@videosdk.live/react-native-sdk/latest.svg?style=for-the-badge" alt="NPM latest version" /> </a> <a href="https://discord.gg/kgAvyxtTxv"> <img src="https://img.shields.io/discord/734858252939952248?logo=discord&style=for-the-badge" /> </a> <a href="http://youtube.com/videosdk?sub_confirmation=1"> <img src="https://img.shields.io/youtube/channel/subscribers/UCuY7JzXnpp874oa7uQbUwsA?logo=Youtube&style=for-the-badge"/> </a> </p> # VideoSDK React Native SDK 🚀 Build fast, scalable, and customizable real-time video applications for mobile using **VideoSDK**. Whether you’re creating a video conferencing app, virtual classroom, or live streaming platform, VideoSDK provides a robust foundation with minimal setup. --- ## Why VideoSDK? VideoSDK enables developers to ship production-grade real-time communication features quickly. - Supports **5,000+ participants** - Low-latency audio, video, and data streams - Fully customizable UI and workflows - Works across modern browsers - Designed for scale and reliability --- ## 🌍 OS Support VideoSDK React Native SDK supports all major mobile operating systems. 📖 Full compatibility guide: https://docs.videosdk.live/react-native/guide/video-and-audio-calling-api-sdk/supported-device-os --- ## ⚙️ Installation Get started by installing `@videosdk.live/react-native-sdk` in your React Native application. **Using npm** ```bash npm install @videosdk.live/react-native-sdk ``` **Using yarn** ```bash yarn add @videosdk.live/react-native-sdk ``` --- ## 🔥 Meeting Features Unlock a suite of powerful features to enhance your meetings: | Feature | Documentation | Description | |--------|---------------|-------------| | 📋 **Precall Setup** | [Setup Precall](https://docs.videosdk.live/react-native/guide/video-and-audio-calling-api-sdk/setup-call/precall) | Configure audio, video devices, and other settings before joining the meeting. | | 🤝 **Join Meeting** | [Join Meeting](https://docs.videosdk.live/react-native/guide/video-and-audio-calling-api-sdk/setup-call/join-meeting) | Allows participants to join a meeting. | | 🚪 **Leave Meeting** | [Leave Meeting](https://docs.videosdk.live/react-native/guide/video-and-audio-calling-api-sdk/setup-call/leave-end-meeting) | Allows participants to leave a meeting. | | 🎤 **Toggle Mic** | [Mic Control](https://docs.videosdk.live/react-native/guide/video-and-audio-calling-api-sdk/handling-media/mute-unmute-mic) | Toggle the microphone on or off during a meeting. | | 📷 **Toggle Camera** | [Camera Control](https://docs.videosdk.live/react-native/guide/video-and-audio-calling-api-sdk/handling-media/on-off-camera) | Turn the video camera on or off during a meeting. | | 🖥️ **Screen Share** | [Screen Share](https://docs.videosdk.live/react-native/guide/video-and-audio-calling-api-sdk/handling-media/screen-share) | Share your screen with other participants during the call. | | 📸 **Image Capture** | [Image Capturer](https://docs.videosdk.live/react-native/guide/video-and-audio-calling-api-sdk/handling-media/image-capturer) | Capture images of participants from their video stream. Useful for Video KYC and identity verification. | | 🔊 **Change Audio Output** | [Switch Audio Output](https://docs.videosdk.live/react-native/guide/video-and-audio-calling-api-sdk/handling-media/change-audio-ouptut-device) | Select an output device for audio during a meeting. | | 🔌 **Change Video Output** | [Switch Video Output](https://docs.videosdk.live/react-native/guide/video-and-audio-calling-api-sdk/handling-media/change-video-input-device) | Select an output device for video during a meeting. | | ⚙️ **Optimize Audio Track** | [Audio Track Optimization](https://docs.videosdk.live/react-native/guide/video-and-audio-calling-api-sdk/render-media/optimize-audio-track) | Enhance the quality and performance of media tracks. | | ⚙️ **Optimize Video Track** | [Video Track Optimization](https://docs.videosdk.live/react-native/guide/video-and-audio-calling-api-sdk/render-media/optimize-video-track) | Enhance the quality and performance of media tracks. | | 🖼️ **Virtual Background** | [Virtual Background](https://docs.videosdk.live/react-native/guide/video-and-audio-calling-api-sdk/render-media/virtual-background) | Add a virtual background or blur effect to your video during the call. | | 💬 **Chat** | [In-Meeting Chat](https://docs.videosdk.live/react-native/guide/video-and-audio-calling-api-sdk/collaboration-in-meeting/pubsub) | Exchange messages with participants through a Publish-Subscribe mechanism. | | 📝 **Whiteboard** | [Whiteboard](https://docs.videosdk.live/react-native/guide/video-and-audio-calling-api-sdk/collaboration-in-meeting/whiteboard) | Collaborate visually by drawing and annotating on a shared whiteboard. | | 📁 **File Sharing** | [File Sharing](https://docs.videosdk.live/react-native/guide/video-and-audio-calling-api-sdk/collaboration-in-meeting/upload-fetch-temporary-file) | Share files with participants during the meeting. | | 📺 **Picture-in-Picture** | [Picture-in-Picture](https://docs.videosdk.live/react-native/guide/video-and-audio-calling-api-sdk/render-media/picture-in-picture) | Allows the video call to continue in a floating, minimized window. | | 📼 **Recording** | [Recording](https://docs.videosdk.live/react-native/guide/video-and-audio-calling-api-sdk/recording/Overview) | Record the meeting for future reference. | | 📡 **RTMP Livestream** | [RTMP Livestream](https://docs.videosdk.live/react-native/guide/video-and-audio-calling-api-sdk/live-streaming/rtmp-livestream) | Stream the meeting live to platforms like YouTube or Facebook. | | 📝 **Real-time Transcription** | [Real-time Transcription](https://docs.videosdk.live/react-native/guide/video-and-audio-calling-api-sdk/transcription-and-summary/realtime-transcribe-meeting) | Generate real-time transcriptions of the meeting. | | 🔇 **Toggle Remote Media** | [Remote Media Control](https://docs.videosdk.live/react-native/guide/video-and-audio-calling-api-sdk/control-remote-participant/remote-participant-media) | Control the microphone or camera of remote participants. | | 🚫 **Mute All Participants** | [Mute All](https://docs.videosdk.live/react-native/guide/video-and-audio-calling-api-sdk/control-remote-participant/mute-all-participants) | Mute all participants simultaneously during the call. | | 🗑️ **Remove Participant** | [Remove Participant](https://docs.videosdk.live/react-native/guide/video-and-audio-calling-api-sdk/control-remote-participant/remove-participant) | Eject a participant from the meeting. | --- ## 🧪 Sample Application Explore a fully functional React example that demonstrates real-world implementation of the VideoSDK: 👉 https://github.com/videosdk-live/videosdk-rtc-react-native-sdk-example