React-Native-WebRTC

A WebRTC module for React Native tailored for the @stream-io/video-react-native-sdk needs.

Getting Started

Use one of the following preferred package install methods to immediately get going.
Don't forget to follow platform guides below to cover any extra required steps.

npm: npm install @stream-io/react-native-webrtc --save
yarn: yarn add @stream-io/react-native-webrtc
pnpm: pnpm install @stream-io/react-native-webrtc

Guides

• Android Install
• iOS Install
• tvOS Install
• Basic Usage
• Step by Step Call Guide
• Improving Call Reliability
• Migrating to Unified Plan

Example Projects

We have some very basic example projects included in the examples directory.
Don't worry, there are plans to include a much more broader example with backend included.

Releasing

Releases are automated with semantic-release via the Release workflow, which is triggered manually from the Actions tab (Run workflow).

There is no channel input — the branch you dispatch from selects the release channel, using the "Use workflow from" branch dropdown:

Dispatch from	Version	npm dist-tag
master	145.1.0	latest
beta	145.1.0-beta.1	beta
alpha	145.1.0-alpha.1	alpha
<major>.x (e.g. 145.x)	145.0.1	145.x

A branch only appears in the dropdown once it exists on the remote and contains the workflow file, so alpha/beta/<major>.x need to be branched off master before their first use.

Tick dry_run to run semantic-release --dry-run: it computes the next version and prints the release notes without publishing, tagging, or pushing.

The version is derived from the Conventional Commits since the last tag — never by hand-editing package.json. feat: yields a minor, fix: a patch, and refactor: and any deps-scoped commit also yield a patch. Publishing uses npm Trusted Publishing (OIDC), so no npm token is involved.

Related Projects

Looking for extra functionality coverage?
The react-native-webrtc organization provides a number of packages which are more than useful when developing Real Time Communication applications.