React Native SDK Guide

React Native bridge, install, join and events.

Interface sections generated from the public SDK definitions

Version v1.1.0 · Updated 2026-10-26 · revision 1

The React Native SDK has the RtcEngine + IRtcEngineEventHandler shape and is exposed to JS through a native bridge (Kotlin/Java on Android, Objective-C on iOS).

Prerequisites#

• React Native 0.74+, Node.js ≥ 22, Xcode 16+ / Android SDK 35.
• Android needs the CAMERA and RECORD_AUDIO runtime permissions; iOS needs NSCameraUsageDescription / NSMicrophoneUsageDescription.
• An appId and a token service (see Enable Services and Get Credentials).

Installation#

# planned package name, not published to npm yet
npm install react-native-nimeet-rtc
cd ios && pod install

Expo projects need a prebuild (npx expo prebuild) before the native module can be added.

Get a token#

Your backend issues the token (POST /v1/tokens), and the RN side only keeps { appId, rtcToken, rtcUid }; never bundle customerSecret into the JS bundle.

const { appId, rtcToken, rtcUid } = await fetch('/api/rtc-token?channel=weekly-sync&uid=10001').then(r => r.json());

Join a channel#

import {
  createAgoraRtcEngine,
  ChannelProfileType,
  ClientRoleType,
  IRtcEngineEventHandler,
} from 'react-native-nimeet-rtc';

const engine = createAgoraRtcEngine();

const handler: IRtcEngineEventHandler = {
  onJoinChannelSuccess: (connection, elapsed) => console.log('joined', connection.channelId),
  onUserJoined: (connection, remoteUid, elapsed) => console.log('remote joined', remoteUid),
  onUserOffline: (connection, remoteUid, reason) => console.log('remote left', remoteUid),
  onTokenPrivilegeWillExpire: () => refreshToken(),
  onError: (err) => console.warn('rtc error', err),
};

engine.initialize({ appId, logConfig: { level: 1 } });
engine.registerEventHandler(handler);
engine.setChannelProfile(ChannelProfileType.ChannelProfileLiveBroadcasting);
engine.enableVideo();
engine.startPreview();

engine.joinChannel(rtcToken, 'weekly-sync', rtcUid, {
  clientRoleType: ClientRoleType.ClientRoleBroadcaster,
});

Publishing and subscribing#

engine.muteLocalAudioStream(true);
engine.muteLocalVideoStream(true);
engine.enableLocalVideo(false);
engine.updateChannelMediaOptions({ clientRoleType: ClientRoleType.ClientRoleAudience });

Screen sharing relies on native capability: MediaProjection (with a foreground service) on Android, a Broadcast Upload Extension on iOS; the method names are in this platform's API reference (startScreenCapture, getScreenCaptureSources and so on).

Events#

An IRtcEngineEventHandler is a plain object: fill in the methods you need. The common ones: onJoinChannelSuccess, onUserJoined, onUserOffline, onFirstRemoteVideoDecoded, onTokenPrivilegeWillExpire, onError, onConnectionStateChanged.

Error handling#

• Synchronous methods return a numeric error code; 0 means success and a negative value is an Agora error number;
• Asynchronous errors arrive through onError;
• Unimplemented capabilities return -4 (ERR_NOT_SUPPORTED).

Troubleshooting#

Next steps#

• Full interfaces and overloads: API reference for this platform
• Error codes and troubleshooting: Error code table, FAQ
• Issue tokens on your server: Token authentication

Platform information

The public interfaces are aligned with the Agora rn API; installation and runtime requirements are listed under Prerequisites above.

Availability

This platform's SDK: Generally available. The examples use the public API; runtime capability follows the published SDK package.

join-channel flow

The method names, parameter types and return values match the API reference for the same platform. Where a method has several overloads, the most common one is shown here; see the API reference for all overloads.

muteRemoteAudioStream(uid: number, mute: boolean): number
initialize(): number
renewToken(token: string): number
enableVideo(): number
joinChannel(token: string, channelId: string, uid: number, options: ChannelMediaOptions): number
leaveChannel(options?: LeaveChannelOptions): number
setChannelProfile(profile: ChannelProfileType): number
setClientRole(role: ClientRoleType, options?: ClientRoleOptions): number

Events and callbacks

Callbacks are registered on IRtcEngineEventHandler; naming differs by platform, and the full list is in the API reference for the same platform.

Error codes

the platform REST layer uses REST error codes；the SDK layer maps connection/authentication failures to Agora error numbers, for the mapping table see SDK error identifiers per platform。