Skip to content

RtkSetupScreen

Last updated View as MarkdownAgent setup

A screen shown before joining the meeting, where you can edit your display name, and media settings.

Properties

Property Type Required Default Description
config UIConfig ❌ createDefaultConfig() Config object
iconPack IconPack ❌ defaultIconPack Icon pack
meeting Meeting ✅ - Meeting object
size Size ✅ - Size
states States ✅ - States object
t RtkI18n ❌ useLanguage() Language

Usage Examples

Basic Usage

import { RtkSetupScreen } from '@cloudflare/realtimekit-react-ui';

function MyComponent() {
  return <RtkSetupScreen />;
}

With Properties

import { RtkSetupScreen } from '@cloudflare/realtimekit-react-ui';

function MyComponent() {
  return (
    <RtkSetupScreen
      meeting={meeting}
      size="md"
    />
  );
}

Was this helpful?