Skip to main content
Version: 2.x.x

Getting Started - React Native SDK

React Native apps require native configuration on both Android and iOS. The quickest way to get started is:

  1. Install the SDK package

    npm install "@videosdk.live/react-native-sdk@2.0.0"
    # or
    yarn add "@videosdk.live/react-native-sdk@2.0.0"

    v2.0.0 needs React Native 0.74 or later and React 18.0 or later.

  2. Configure the native projects

    • Android: set minSdkVersion to 24. React Native links the SDK automatically, so settings.gradle and MainApplication need no changes.

      android/build.gradle
      buildscript {
      ext {
      minSdkVersion = 24
      }
      }

      If you minify your release build, add -keep class videosdk.org.** { *; } and -dontwarn videosdk.org.** to android/app/proguard-rules.pro. The Android setup guide has the full steps, including the permissions in AndroidManifest.xml.

    • iOS: add the VideoSDKRTC pod inside your app's target block, raise the platform to iOS 18.0, and run pod install. Set the iOS Deployment Target of your app target to 18.0 in Xcode as well, and add NSCameraUsageDescription and NSMicrophoneUsageDescription to Info.plist. The iOS setup guide has the full steps.

      ios/Podfile
      platform :ios, '18.0'

      target 'YourApp' do
      # ...
      pod 'VideoSDKRTC', :podspec => '../node_modules/@videosdk.live/react-native-sdk/ios/VideoSDKRTC.podspec'
      end
    • Expo: use version 2 of @videosdk.live/expo-config-plugin, which adds the VideoSDKRTC pod for you, and set the iOS deployment target to 18.0. You still need a development build. Follow the Expo setup guide.

  3. Ask for camera and microphone access

    On Android, the SDK does not ask the user for camera and microphone access. Call requestPermission() from useMediaDevice before a host joins, and before changeMode("SEND_AND_RECV") turns a viewer into a host. iOS asks on its own.

Refer to the platform-specific guides linked above for detailed code snippets and troubleshooting tips. To upgrade an app from v1.x.x, follow the Migration Guide.

Got a Question? Ask us on discord