@hiyve/rtc-client-rn

React Native WebRTC client library for building mobile video conferencing applications on iOS and Android. Provides the same core functionality as @hiyve/rtc-client (web) with native mobile support including camera switching, platform-aware permissions, and RTCView-compatible media streams.

Features

• Real-time audio/video communication via WebRTC
• iOS and Android support with react-native-webrtc
• Front/back camera switching
• Audio and video mute controls
• Room creation and joining
• Remote participant track events
• Recording and streaming status events
• Real-time transcription events
• Audio-only mode
• Bandwidth monitoring
• Branded aliases (HiyveClient, HiyveClientEvents)

Installation

npm install @hiyve/rtc-client-rn
Copy

Peer Dependencies

npm install react-native-webrtc @react-native-async-storage/async-storage
Copy

iOS: Install CocoaPods after adding react-native-webrtc:

cd ios && bundle exec pod install
Copy

iOS Info.plist — add camera and microphone usage descriptions:

NSCameraUsageDescription
This app needs camera access for video calls
NSMicrophoneUsageDescription
This app needs microphone access for audio calls
Copy

Android AndroidManifest.xml — add permissions:

Copy

Quick Start

import { Client, ClientEvents } from '@hiyve/rtc-client-rn';
import { RTCView } from 'react-native-webrtc';

// 1. Create client with a room token from your server
const client = new Client({
  roomToken: 'your-room-token',
  serverRegionUrl: 'https://us-east-1.mediaserver.example.com',
  regions: ['us-east-1'],
});

// 2. Listen for events
client.on(ClientEvents.LOCAL_STREAM_READY, ({ stream }) => {
  // Render with <RTCView streamURL={stream.toURL()} mirror={true} />
});

client.on(ClientEvents.CONNECTED, () => {
  console.log('Connected to room');
});

client.on(ClientEvents.MEDIA_TRACK_ADDED, ({ userId, kind, stream }) => {
  // Store stream per userId+kind, render with <RTCView streamURL={stream.toURL()} />
});

client.on(ClientEvents.USER_DISCONNECTED, ({ userId }) => {
  // Remove participant from state
});

// 3. Create or join a room
await client.createRoom({ roomName: 'my-room', userId: 'user-123' });

// 4. Connect media transports (starts producing audio/video)
await client.connectTransports({});

// 5. Controls
await client.muteLocalAudio(true);   // Mute mic
await client.muteLocalVideo(true);   // Disable camera
await client.switchCamera();          // Flip front/back camera

// 6. Cleanup
client.removeAllListeners();
await client.closeConnection();
Copy

API Reference

Constructor

new Client({ roomToken, serverRegionUrl, regions?, options? })
Copy

Methods

Events

Register listeners with client.on(ClientEvents.EVENT_NAME, callback).

Connection Events

Participant Events

Media Events

Feature Events

Additional Exports

Types

Branded Aliases

import { HiyveClient, HiyveClientEvents } from '@hiyve/rtc-client-rn';
// Equivalent to Client and ClientEvents
Copy

Rendering Video

Use RTCView from react-native-webrtc to render streams:

import { RTCView } from 'react-native-webrtc';

// Local video (front camera, mirrored)


// Remote video

Copy

Key differences from web <video> elements:

• Use streamURL (from stream.toURL()) instead of srcObject
• objectFit and mirror are component props, not CSS
• Each consumer provides its own MediaStream via MEDIA_TRACK_ADDED

Platform Notes

iOS

• Camera and microphone usage descriptions must be in Info.plist
• CocoaPods required for react-native-webrtc native modules
• iOS Simulator has limited camera support; use a physical device for full testing
• iOS Simulator can access localhost directly

Android

• Camera and microphone permissions must be requested at runtime via PermissionsAndroid
• Android Emulator maps 10.0.2.2 to the host machine's localhost
• Requires Android SDK 24+
• Use an x86_64 emulator image with hardware acceleration

Requirements

• React Native 0.73+
• react-native-webrtc >= 118.0.0
• @react-native-async-storage/async-storage >= 1.0.0
• A Hiyve room token (obtained from your backend server)

Related Packages

License

Commercial - IWantToPractice, LLC