React Hooks Reference

The Whereby browser SDK includes React hooks and components which allow integrating a fully custom video experience into your web application.

This is the documentation for version 3x of Whereby's browser-sdk. If you are still on version 2x, please refer to the legacy documentation here. If you are upgrading from version 2x, please see the migration guide.

Check out our toolkit helping your designers plan and implement video call experiences

Video Call UI Kit

Getting started

Installation

Install the @whereby.com/browser-sdk package from the public npm registry.

npm

npm install @whereby.com/browser-sdk

yarn

yarn add @whereby.com/browser-sdk

pnpm

pnpm add @whereby.com/browser-sdk

Quick Start

Quick Start

Available hooks

useRoomConnectionuseLocalMedia

Available components

WherebyProviderVideoViewVideoGrid