> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stmlink.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> 对外开放的服务端接口有两组前缀，都用同一套鉴权：`/server/v1/...`（SRTC 与 SMeeting 的主接口）和 `/stm/srvapi/v1/...`（SMeeting 的用户体系，服务端极简对接会用到）。鉴权是 app_id + nonce + timestamp + signature 四个请求头，用 app_key 做 HMAC-SHA256 签名，只能从业务方自己的后端调用。除这两组前缀外的接口均为内部接口，不要建议客户调用。 Public server APIs use two path prefixes with the same authentication: `/server/v1/...` (the main APIs of both SRTC and SMeeting) and `/stm/srvapi/v1/...` (the SMeeting user system, used by server-side low-code integration). Authenticate with four request headers, app_id + nonce + timestamp + signature, where signature is HMAC-SHA256 keyed with app_key; call these APIs only from the customer's own backend. Any other path is internal: never suggest calling it.
> app_key 是服务端密钥，绝不能出现在客户端代码、前端配置或移动 App 里。客户端加入频道用的 token 必须由业务方后端签发后下发（SRTC 走 `/server/v1/channel/grant`，SMeeting 走 `/stm/srvapi/v1/member/grant`）。 app_key is a server-side secret and must never appear in client code, frontend config, or a mobile app. The token a client uses to join must be issued by the customer's backend and passed down to the client (SRTC: `/server/v1/channel/grant`; SMeeting: `/stm/srvapi/v1/member/grant`).
> SRTC 与 SMeeting 是上下两层不同的产品，术语不通用：SRTC 是音视频底座，说「频道 channel」「加入 / 退出」；SMeeting 建在 SRTC 之上，说「房间 room」「会议 meeting」「进入 / 退出」。回答时按用户所在的层用对应术语，不要把「房间」「会议」安到 SRTC 的接口上，也不要用「频道」「加入 / 离开」描述 SMeeting 的概念（接口标识符原样保留）。 SRTC and SMeeting are two separate layers with different terminology. SRTC is the audio/video foundation: it has channels, and users join and leave a channel. SMeeting is built on top of SRTC: it has rooms and meetings, and members enter and exit a meeting. Answer in the terms of the layer the user is working with: never apply "room" or "meeting" to SRTC APIs, and never describe SMeeting concepts in prose with "channel", "join", or "leave" (API identifiers such as `force_join` keep their literal names).
> 同一能力在各端 SDK 里的包名、类名、方法名并不相同。写示例代码时请使用文档中该端自己的 API，不要把一个端的写法套到另一个端上。苹果平台每个产品都有两套 SDK（Swift 原生与 Objective-C），两套 API 不能混用。 Package, class, and method names differ between platform SDKs for the same capability. In sample code, use the API documented for that platform; never carry one platform's code over to another. On Apple platforms each product ships two SDKs (native Swift and Objective-C) whose APIs must not be mixed.

# Integration

> Supported browsers, WeChat Mini Program embedding via web-view, protocol requirements for publishing and receiving streams, and how to install the SMeeting Web SDK via npm or a local copy. Read this before writing any meeting code for the Web.

## Supported platforms

The SMeeting Web SDK supports mainstream desktop and mobile browsers:

| Browser | Minimum version | Notes |
| - | :-: | - |
| Chrome | 72+ | Recommended, full feature support |
| Edge | 79+ | Chromium-based |
| Firefox | 66+ | Selecting a speaker output device is not supported |
| Safari | 14+ | Sharing system audio during screen sharing is not supported |
| WeChat in-app browser | iOS 14.3+ / Android | Sending and receiving are supported. Older iOS versions below 14.3 can only receive streams |
| Mobile Chrome / Safari | Latest | Basic audio and video calls are supported |

> **Tip:** We recommend that users use the latest version of Chrome for the best experience.

## WeChat Mini Program scenario

When you need meetings inside a WeChat Mini Program, **we recommend embedding a page built on this Web SDK through the Mini Program's `<web-view>`**, rather than building a separate native Mini Program implementation. This way one set of Web code covers both browsers and the Mini Program, features and future iterations naturally stay in sync, and maintenance cost is lowest.

Key points:

* The embedded page must be served over **HTTPS**, and its domain must be configured as a **business domain** in the Mini Program admin console and pass verification
* Pass parameters between the Mini Program and the embedded page through the `web-view` communication mechanism; the room number, token, and so on can be delivered in the URL query
* The page runs in the WeChat in-app browser. On iOS 14.3 and later and on Android, both publishing and receiving work normally; only older iOS versions below 14.3 are limited by the system WebView and can only receive streams

## URL domain and protocol restrictions

| Scenario | Protocol | Receive audio and video | Publish audio and video | Notes |
| - | - | - | - | - |
| Production | HTTPS | Supported | Supported | **Recommended** |
| Production | HTTP | Supported | Not supported | |
| Local development | [http://localhost](http://localhost) | Supported | Supported | **Recommended** |
| Local development | [http://127.0.0.1](http://127.0.0.1) | Supported | Supported | |
| Local development | http\://\[local IP] | Supported | Not supported | |
| Local development | file:/// | Supported | Supported | |

## Install

### npm

```bash theme={null}
npm install @seastart/smeeting-web-sdk@latest --save
```

### Local copy

Download the SDK package manually:

1. Download [smeeting.js](https://www.unpkg.com/@seastart/smeeting-web-sdk@latest/smeeting.js) and [smeeting.d.ts](https://www.unpkg.com/@seastart/smeeting-web-sdk@latest/smeeting.d.ts)
2. Copy `smeeting.js` and `smeeting.d.ts` into your project.

## Usage

Import it with `import` or load it with a `script` tag

```typescript theme={null}
import { SMeeting } from '@seastart/smeeting-web-sdk';
// or
<script src="smeeting.js"></script>
```
