Realtimekit 说明文档

# Cloudflare RealtimeKit 使用 **Cloudflare RealtimeKit** 构建实时视频和音频应用程序的专家指南——这是一个用于在 Web 或移动应用中添加可定制实时视频和语音功能的综合 SDK 套件。 ## 概览 RealtimeKit 是 Cloudflare 基于实时 SFU 构建的 SDK 套件，通过快速集成、预构建 UI 组件、全球性能（300+ 城市）和生产级功能（录制、转录、聊天、投票）抽象了 WebRTC 的复杂性。 **使用场景**：团队会议、网络研讨会、社交视频、音频通话、交互式插件 ## 核心概念 - **App (应用)**：工作区，用于对会议、参与者、预设和录制内容进行分组。请为测试/生产环境使用不同的 App - **Meeting (会议)**：可重用的虚拟房间。每次加入都会创建新的 **Session (会话)** - **Session (会话)**：实时会议实例。在首次加入时创建，在最后一人离开后结束 - **Participant (参与者)**：通过 REST API 添加的用户。返回用于客户端 SDK 的 `authToken`。**请勿重复使用令牌** - **Preset (预设)**：可重用的权限/UI 模板（权限、会议类型、主题）。在创建参与者时应用 - **Peer ID (`id`)**：每个会话唯一，重新加入时会更改 - **Participant ID (`userId`)**：跨会话持久存在 ## 快速入门 ### 1. 创建应用与会议 (后端) bash # 创建应用 curl -X POST 'https://api.cloudflare.com/client/v4/accounts//realtime/kit/apps' -H 'Authorization: Bearer ' -d '{"name": "My RealtimeKit App"}' # 创建会议 curl -X POST 'https://api.cloudflare.com/client/v4/accounts//realtime/kit//meetings' -H 'Authorization: Bearer ' -d '{"title": "Team Standup"}' # 添加参与者 curl -X POST 'https://api.cloudflare.com/client/v4/accounts//realtime/kit//meetings//participants' -H 'Authorization: Bearer ' -d '{"name": "Alice", "preset_name": "host"}' # 返回: { authToken } ### 2. 客户端集成 **React**: tsx import { RtkMeeting } from '@cloudflare/realtimekit-react-ui'; function App() { return <RtkMeeting authToken="" onLeave={() => {}} />; } **核心 SDK**: typescript import RealtimeKitClient from '@cloudflare/realtimekit'; const meeting = new RealtimeKitClient({ authToken: '', video: true, audio: true }); await meeting.join(); ## 阅读顺序 | 任务 | 文件 | |------|-------| | 快速集成 | 仅 README | | 自定义 UI | README → patterns → api | | 后端设置 | README → c