agora-rtc-sdk-ng/README-zh_CN.md

Agora WebRTC SDK for JavaScript

# AgoraRTC SDK (Version 4.x)

[English](./README.md) | 简体中文

## 开始

### 安装

使用 `npm`, `pnpm` 或 `yarn`

```bash
# 使用 npm
npm i agora-rtc-sdk-ng
# 或者使用 pnpm
pnpm add agora-rtc-sdk-ng
# 或者使用 yarn
yarn add agora-rtc-sdk-ng
```

我们也提供了 CDN。SDK 会在全局导出 `AgoraRTC`。

```html
<!-- 默认 UMD，不含 AI QoS -->
<script src="https://download.agora.io/sdk/release/AgoraRTC_N-4.24.8.js"></script>
```

CDN 使用 AI QoS 时只引入 full 包，AI 已注册，不必再挂扩展脚本：

```html
<script src="https://download.agora.io/sdk/release/AgoraRTC_N-4.24.8-full.js"></script>
<script>
  const client = AgoraRTC.createClient({ mode: "live", codec: "vp8", aiClientMode: true });
  await client.join(appId, channel, token, uid);
</script>
```

npm 的 UMD 同样拆分。默认入口不含 AI QoS；完整包走 `agora-rtc-sdk-ng/full`：

```javascript
import AgoraRTC from "agora-rtc-sdk-ng/full";

const client = AgoraRTC.createClient({ mode: "live", codec: "vp8", aiClientMode: true });
await client.join(appId, channel, token, uid);
```

ESM 逻辑不变：主 ESM + 可选 service：

```javascript
import AgoraRTC from "agora-rtc-sdk-ng/esm";
import { AiAudioModeService } from "agora-rtc-sdk-ng/services/ai-audio-mode";

AgoraRTC.use(AiAudioModeService);
const client = AgoraRTC.createClient({ mode: "live", codec: "vp8", aiClientMode: true });
await client.join(appId, channel, token, uid);
```

### 快速开始

我们提供了 `React`, `Vue`, `Svelte` 的 Demo, 访问地址 [Quick Start Demo](https://github.com/AgoraIO/agora-rtc-web/blob/main/projects).

详细可参考文档 [api-ref.agora.io](https://doc.shengwang.cn/api-ref/rtc/javascript/overview).

## 变更记录

变更记录访问地址为 [Release Notes](https://doc.shengwang.cn/doc/rtc/javascript/overview/release-notes).