# @apirtc/apirtc 中文文档

规范地址：https://npmcn.com/package/%40apirtc/apirtc/

版本：5\.0\.37
npm 元数据更新时间：2026-09-30T14:05:14.351Z
中文译文更新时间：2026-11-06T10:14:39.584Z
软件包许可：ICS

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

原始 npm 页面：https://www.npmjs.com/package/%40apirtc/apirtc
原文对照：https://npmcn.com/package/%40apirtc/apirtc/?lang=original
项目主页：https://apirtc.com/

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

- 包体积（解压后）：1.5 MB，5 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2021-11-10T14:42:33.410Z
- 最新版本发布：2026-09-30T14:05:14.121Z
- 近 30 天下载量：3851（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：146（近 12 个月 15 个）

## 中文简介

ApiRTC - 设置您的 WebRTC 服务!

## 安装

```sh
npm install @apirtc/apirtc
```

也可以使用：`pnpm add @apirtc/apirtc`、`yarn add @apirtc/apirtc`、`bun add @apirtc/apirtc`

## README

# ApiRTC 软件

ApiRTC是实时网络通信库. 这样您就可以在应用程序中方便地添加通讯(聊天、音频、视频、文件传输、绘图).

ApiRTC 使网络通讯成为微风 [ApiRTC的基础设施](https://apirtc.com/) 和WebRTC技术.

ApiRTC的主要优点之一是兼容很多不同的 [浏览器和版本](https://dev.apirtc.com/compatibility). ApiRTC在网络浏览器上的新API和功能的支持下不断演变.

可用更改日志 [gi](https://github.com/ApiRTC/references/blob/master/apirtc-js/CHANGELOG.md)。 。 。 .

## 安装

`npm i @apirtc/apirtc --save`

或者说

`yarn add @apirtc/apirtc`

## 使用量

### 模块

`import { UserAgent, Session } from '@apirtc/apirtc';`

或者说

`import apiRTC from '@apirtc/apirtc';`

缩写:

```
let ua = new UserAgent({
    uri: "apzkey:myDemoApiKey",
});

let registerInformation = {
    cloudUrl: "https://cloud.apirtc.com",
};

ua.register(registerInformation)
    .then((session) => {
        console.log("User registered with session: ", session);
    })
    .catch((error) => {
        console.error("User agent registration failed", error);
    });
```

### 全球目标

你用得着 `apiRTC` 对象来自全局范围.

`<script src="node_modules/@apirtc/apirtc/apiRTC.min.js"></script>`

或者说

`<script src="https://cloud.apirtc.com/apiRTC/apiRTC-latest.min.js"></script>`

```
<script>
let ua = new apiRTC.UserAgent({
    uri: "apzkey:myDemoApiKey",
});
</script> 
```

# 文档

如果你想开始,你应该看看我们 [正在获取指南](https://dev.apirtc.com/getting_started/index) 财务报告和审定财务报表 [API 快速启动指南](https://dev.apirtc.com/api/quick_start)

我们还准备了若干项行动 [教程样本( s)](https://dev.apirtc.com/tutorials/index) 以简化应用程序中的 ApiRTC 集成.

[API 参考文档](https://dev.apirtc.com/reference/)

## 常见问题

### @apirtc/apirtc 是什么？

ApiRTC - 设置您的 WebRTC 服务\!

### 如何安装 @apirtc/apirtc？

在项目目录运行 npm install @apirtc/apirtc，或使用 pnpm add / yarn add / bun add。

### @apirtc/apirtc 支持 TypeScript 吗？

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

### @apirtc/apirtc 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @apirtc/apirtc 可以商用吗？

@apirtc/apirtc 使用 ICS 许可。声明的许可为 ICS，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @apirtc/apirtc 的下载量有多少？

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

### @apirtc/apirtc 还在维护吗？

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