跳转到主要内容

rtk-recording-toggle

{/* AUTO-GENERATED FILE. DO NOT EDIT MANUALLY. Any manual changes will be overwritten the next time the docs are generated.

Source: https://github.com/cloudflare/realtimekit-ui/blob/main/packages/core/src/components/rtk-recording-toggle/rtk-recording-toggle.tsx Generator: https://github.com/cloudflare/realtimekit-ui/blob/main/scripts/generate-stencil-docs.js

To update this page, edit the component source in the realtimekit-ui repository and submit a pull request against the staging branch; the changes will automatically sync here upon the next release. */}

A button which toggles recording state of a meeting. Only a privileged user can perform this action, thus the button will not be visible for participants who don't have the permission to record a meeting.

Properties

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

Usage Examples

Basic Usage

<!-- component.html -->
<rtk-recording-toggle></rtk-recording-toggle>

With Properties

<!-- component.html -->
<rtk-recording-toggle
 [disabled]="true"
 [meeting]="meeting"
 size="md">
</rtk-recording-toggle>