# @cloudflare/realtimekit-react 中文文档

规范地址：https://npmcn.com/package/%40cloudflare/realtimekit-react/

版本：2\.1\.0
npm 元数据更新时间：2026-11-16T07:23:04.253Z
中文译文更新时间：2026-11-16T07:23:45.690Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40cloudflare/realtimekit-react
原文对照：https://npmcn.com/package/%40cloudflare/realtimekit-react/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：29.9 kB，6 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：react \>=16\.8\.6
- 首次发布：2025-04-04T16:44:33.961Z
- 最新版本发布：2026-11-16T07:23:03.862Z
- 近 30 天下载量：344843（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：228（近 12 个月 101 个）

## 中文简介

实时视频和音频SDK用于构建自定义,合作交流体验.

## 安装

```sh
npm install @cloudflare/realtimekit-react
```

也可以使用：`pnpm add @cloudflare/realtimekit-react`、`yarn add @cloudflare/realtimekit-react`、`bun add @cloudflare/realtimekit-react`

## README

[![Logo](https://cf-assets.www.cloudflare.com/slt3lc6tev37/6EYsdkdfBcHtgPmgp3YtkD/0b203affd2053988264b9253b13de6b3/logo-thumbnail.png)](https://cloudflare.com/)

### 实时 Kit

实时视频和音频SDK用于构建自定义,合作交流体验.  
[**探索文件“**](https://developers.cloudflare.com/realtime/realtimekit/)  
  
[查看演示](https://demo.realtime.cloudflare.com/) • 妇女 [报告错误](https://community.cloudflare.com/) • 妇女 [请求特性](https://community.cloudflare.com/)

## 目录

-   [关于项目](https://npmcn.com/package/%40cloudflare/realtimekit-react/#readme-about-the-project)
    -   [内设](https://npmcn.com/package/%40cloudflare/realtimekit-react/#readme-built-with)
-   [安装](https://npmcn.com/package/%40cloudflare/realtimekit-react/#readme-installation)
-   [使用量](https://npmcn.com/package/%40cloudflare/realtimekit-react/#readme-usage)
-   [关于](https://npmcn.com/package/%40cloudflare/realtimekit-react/#readme-about)

## 关于项目

实时视频和音频SDK用于构建自定义,合作交流体验.

### 内设

-   [云雾花](https://cloudflare.com/)
-   [字体](https://typescriptlang.org/)

## 安装

```sh
npm install @cloudflare/realtimekit-react
```

## 使用量

A 类 `meeting` 对象可以使用 `useRealtimeKitClient` 钩.

```ts
const [meeting, initMeeting] = useRealtimeKitClient();
useEffect(() => {
  await initMeeting({
    authToken: "<AuthTokenHere>",
    defaults: {
        audio: false,
        video: false,
    }
  });
}, []);
```

这个 `meeting` 对象用于与 Cloudflare 服务器的所有交互。 例如,下列代码片段用于用户加入一个房间.

```ts
await meeting.join();
```

_欲了解更多实例,请参见: [文档](https://developers.cloudflare.com/realtime/realtimekit/)。 。 。 ._

## 关于

`@cloudflare/realtimekit` 由Cloudflare公司创建和维护.

名称和标志为Cloudflare股份有限公司的商标.

## 常见问题

### @cloudflare/realtimekit-react 是什么？

实时视频和音频SDK用于构建自定义,合作交流体验\.

### 如何安装 @cloudflare/realtimekit-react？

在项目目录运行 npm install @cloudflare/realtimekit-react，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=16\.8\.6）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @cloudflare/realtimekit-react 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @cloudflare/realtimekit-react 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @cloudflare/realtimekit-react 可以商用吗？

@cloudflare/realtimekit-react 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @cloudflare/realtimekit-react 的下载量有多少？

根据 npm 官方下载统计，@cloudflare/realtimekit-react 在 2026/10/10 – 2026/11/08 这 30 天内被下载 344,843 次，日均约 11,495 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @cloudflare/realtimekit-react 还在维护吗？

最新版本 2\.1\.0 发布于 2026/11/16（今天）；至今共发布 228 个版本，其中过去 12 个月发布了 101 个；首次发布于 2025/04/05。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

