Skip to content
Platform docs
Auth, users, webhooks & more
Info:
This is beta documentation for Stream Video React Native SDK v2. For the latest stable version, see the latest version (v1).

Lobby

Pre-meeting component for testing setup before joining. Includes:

  • Call details - ID and meeting information
  • Current participants - Who's already in the meeting
  • Media controls - Audio/video mute status before joining
  • Join button - Handler for entering the meeting
Preview of the Lobby component.

General usage

import { useCallback } from "react";
import { Lobby, useCall } from "@stream-io/video-react-native-sdk";

const LobbyComponent = () => {
  const onJoinCallHandler = () => {
    // Handle what should happen after the call is joined. Eg: navigation, etc.
  };

  return <Lobby onJoinCallHandler={onJoinCallHandler} />;
};

Props

landscape

Applies the landscape mode styles to the component, if true.

Type
boolean | undefined

onJoinCallHandler

Handler to be called when the call is joined using the join button in the Lobby.

Type
() => void | undefined

LobbyControls

Prop to customize the media controls in the Lobby component entirely.

Type Default Value
ComponentType| undefined LobbyControls

JoinCallButton

Prop to customize the Join call button in the Lobby component.

Type Default Value
ComponentType| undefined JoinCallButton

LobbyFooter

Prop to customize the Lobby Footer in the Lobby component.

Type Default Value
ComponentType| undefined LobbyFooter