Skip to content

Latest commit

 

History

History
73 lines (52 loc) · 2.41 KB

README.md

File metadata and controls

73 lines (52 loc) · 2.41 KB
description
The Whereby browser SDK includes React hooks and components which allow integrating a fully custom video experience into your web application.

React Hooks Reference

{% hint style="warning" %} 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. {% endhint %}

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

Video Call UI Kithttps://www.figma.com/community/file/1411023646481069706/video-call-ui-kit-by-wherebyDocs_landing@2x.jpg

Getting started

Installation

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

{% tabs %} {% tab title="npm" %}

npm install @whereby.com/browser-sdk

{% endtab %}

{% tab title="yarn" %}

yarn add @whereby.com/browser-sdk

{% endtab %}

{% tab title="pnpm" %}

pnpm add @whereby.com/browser-sdk

{% endtab %} {% endtabs %}

Quick Start

{% content-ref url="quick-start/" %} quick-start {% endcontent-ref %}

Available hooks

{% content-ref url="api-reference/useroomconnection.md" %} useroomconnection.md {% endcontent-ref %}

{% content-ref url="api-reference/uselocalmedia.md" %} uselocalmedia.md {% endcontent-ref %}

Available components

{% content-ref url="api-reference/wherebyprovider.md" %} wherebyprovider.md {% endcontent-ref %}

{% content-ref url="api-reference/videoview.md" %} videoview.md {% endcontent-ref %}

{% content-ref url="api-reference/videogrid.md" %} videogrid.md {% endcontent-ref %}