Skip to content

RtkLivestreamToggle

Last updated View as MarkdownAgent setup

A button for starting or stopping a meeting livestream. It appears only for participants who have permission to host the livestream.

Properties

Property Type Required Default Description
iconPack IconPack ❌ defaultIconPack Icon pack
meeting Meeting ✅ - Meeting object
size Size1 ✅ - Size
t RtkI18n ❌ useLanguage() Language
variant ControlBarVariant ✅ - Variant

Usage Examples

Basic Usage

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

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

With Properties

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

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

Was this helpful?