description |
---|
The Whereby browser SDK includes React hooks and components which allow integrating a fully custom video experience into your web application. |
{% 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 Kit | https://www.figma.com/community/file/1411023646481069706/video-call-ui-kit-by-whereby | Docs_landing@2x.jpg |
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 %}
{% content-ref url="quick-start/" %} quick-start {% endcontent-ref %}
{% content-ref url="api-reference/useroomconnection.md" %} useroomconnection.md {% endcontent-ref %}
{% content-ref url="api-reference/uselocalmedia.md" %} uselocalmedia.md {% endcontent-ref %}
{% 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 %}