@seastart/srtc-web-sdk 0.6.3 → 0.7.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +18 -0
- package/README.md +113 -5
- package/package.json +14 -7
- package/srtc.d.mts +137 -0
- package/srtc.d.ts +137 -0
- package/srtc.js +1 -1
- package/srtc.mjs +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,24 @@
|
|
|
2
2
|
|
|
3
3
|
本文档记录 web SDK 各版本的改动点。遵循 [Keep a Changelog](https://keepachangelog.com/zh-CN/1.1.0/) 风格。
|
|
4
4
|
|
|
5
|
+
## v0.7.1 - 2026-11-04
|
|
6
|
+
|
|
7
|
+
- fix: 构建产物语法降到 ES2019(class 字段、可选链、BigInt 字面量等都已转换),修复 webpack 4 / 未转译 node_modules 的老 babel 工具链引入时报 `Module parse failed` 的问题;接口与运行行为不变,产物体积约增加 7% (f700b32)
|
|
8
|
+
|
|
9
|
+
## v0.7.0 - 2026-09-30
|
|
10
|
+
|
|
11
|
+
- feat!: 报错英文化 + 独立错误码:SDK 自身报错的 `message`/`msg` 全部改为英文,并按跨端统一码表分配低 3 位码(不再大多落在 `106000`)。完整码表见文档站错误码总表页;请按 `code` / `baseCode` 判断,不要按文案判断
|
|
12
|
+
- feat!: `SdkError` 改为继承 `Error`(有 `message`、`name`、`stack`,`e instanceof Error` 成立,`msg` 保留兼容);新增 `baseCode`(低 3 位语义码);包导出 `SdkError` 与 `ErrorCode`
|
|
13
|
+
- feat!: HTTP 非 200 / 网络请求失败统一抛 `SdkError(106006)`(原为裸 `Error("500:...")`);wangsu 引擎发布/订阅超时由裸字符串改为 `SdkError(106302/106303)`,发布/订阅 PeerConnection 进入 failed / closed 为 `106015`(PeerConnectionFailed);入会 PeerConnection 超时为 `106007`
|
|
14
|
+
- feat: 初始化参数 `language`(缺省跟随 `navigator.language`,取不到为 `zh`),所有 SDK 接口请求带 `Accept-Language`,后端业务错误文案(>= 1000 的码)据此返回对应语言
|
|
15
|
+
- feat: 自动播放弹窗内置中/英两套文案(按 `language` 选择),可用初始化参数 `autoPlayDialogText` 覆盖;`disableAutoPlayDialog` 行为不变
|
|
16
|
+
- fix: 自动播放弹窗不再拼接轨道 desc、改用 textContent 构建,修复远端 desc 可注入 HTML 的 XSS 问题
|
|
17
|
+
- change: 轨道 `toString()` 前缀改为类名风格(如 `LocalCameraTrack[...]`),日志中的轨道名随之变为英文;连接质量评估 `QualityEvaluation.reasons` 改为英文(诊断用,非契约)
|
|
18
|
+
- change: 接口 HTTP 200 但响应体没有 `code` 字段时,以前按后端业务错误处理(心跳直接退会),现在视为响应解码失败 `011`(`Invalid response: missing code`,`isServerError` 为 false),心跳等继续重试;响应体不是 JSON 同为 `011`
|
|
19
|
+
- change: seastart 引擎重连中发布报 `106014`;引擎未连接 / 已断开(非重连中)时发布报 `106300`、订阅报 `106301`(以前都是 `106014`)
|
|
20
|
+
- change: 已离开(或正在离开)的频道上调用 `publishLocalTrack`、`subscribeRemote*` 改为抛 `SdkError(106001)`(`Channel has been left`),不再撞上已断开的媒体引擎报 `106014`;`unpublishLocalTrack` / `unsubscribeRemoteTrack` 离会后仍静默成功,会控重连期间的发布/订阅行为不变
|
|
21
|
+
- chore: npm 页面说明与许可证更新(README 中英双语、许可证改为 UNLICENSED、补 homepage 等元数据)(373a215)
|
|
22
|
+
|
|
5
23
|
## v0.6.3 - 2026-09-23
|
|
6
24
|
|
|
7
25
|
- fix: 本地混音改为直连 AudioContext 出声,修复 Web 端接收音频发钝 (3e5b181)
|
package/README.md
CHANGED
|
@@ -1,7 +1,115 @@
|
|
|
1
|
-
# SRTC Web SDK
|
|
1
|
+
# SRTC Web SDK
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
[srtc](https://www.stmlink.com)是一款是支持完全私有化部署的实时音视频通信引擎,覆盖全平台 SDK, 支持信创国产化,兼容传统 SIP/H.323 设备,集成 AI Agent 能力。可以快速帮助您搭建低成本、低延时、高品质的音视频互动解决方案。
|
|
3
|
+
**English** | [中文](#srtc-web-sdk中文)
|
|
5
4
|
|
|
6
|
-
|
|
7
|
-
|
|
5
|
+
[SRTC](https://www.stmlink.com) is a real-time audio/video engine built for fully private deployment, with SDKs for every major platform, support for domestic (Xinchuang) OS and hardware, interoperability with legacy SIP/H.323 devices, and built-in AI Agent capabilities.
|
|
6
|
+
|
|
7
|
+
This package is the **browser SDK**: join a channel, capture and publish microphone / camera / screen, subscribe to and play remote audio and video. Full documentation: [docs.stmlink.com](https://docs.stmlink.com/zh/rtc/web/integration).
|
|
8
|
+
|
|
9
|
+
## Install
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
npm install @seastart/srtc-web-sdk
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Ships both ESM (`srtc.mjs`) and UMD (`srtc.js`) builds with TypeScript declarations. Requires a WebRTC-capable browser and a page served over HTTPS (or `localhost`).
|
|
16
|
+
|
|
17
|
+
## Quick start
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { SRTC, LogLevel, MicPresets, CameraPresets, TrackKind, ChannelEventType } from '@seastart/srtc-web-sdk';
|
|
21
|
+
|
|
22
|
+
const srtc = new SRTC({ logLevel: LogLevel.INFO });
|
|
23
|
+
|
|
24
|
+
// Subscribe to remote video as it gets published
|
|
25
|
+
srtc.onNotifyChannelEvent = async (evt) => {
|
|
26
|
+
if (evt.type === ChannelEventType.USER_TRACK_ADD && evt.data.track.kind === TrackKind.Video) {
|
|
27
|
+
const video = await srtc.subscribeRemoteVideoTrack(evt.data.user.uid, evt.data.track.id);
|
|
28
|
+
video.addPlayView(document.querySelector<HTMLElement>(`#remote-${evt.data.user.uid}`)!);
|
|
29
|
+
}
|
|
30
|
+
};
|
|
31
|
+
|
|
32
|
+
await srtc.join(token); // token is issued by your backend
|
|
33
|
+
|
|
34
|
+
const mix = await srtc.subscribeRemoteAudioMixTrack(); // hear everyone in the channel
|
|
35
|
+
await mix.startPlay();
|
|
36
|
+
|
|
37
|
+
const mic = srtc.createLocalMicTrack(MicPresets.music);
|
|
38
|
+
await mic.startCapture();
|
|
39
|
+
await srtc.publishLocalTrack(mic);
|
|
40
|
+
|
|
41
|
+
const camera = srtc.createLocalCameraTrack(CameraPresets['720p']);
|
|
42
|
+
await camera.startCapture();
|
|
43
|
+
camera.addPlayView(document.querySelector<HTMLElement>('#local-video')!);
|
|
44
|
+
await srtc.publishLocalTrack(camera);
|
|
45
|
+
|
|
46
|
+
// ... later
|
|
47
|
+
await srtc.leave();
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
> Import with named imports (`import { SRTC } from ...`). The package has no default export.
|
|
51
|
+
|
|
52
|
+
See the [quick start](https://docs.stmlink.com/zh/rtc/web/quickstart) for the complete flow (environment check, users already in the channel, cleanup), and the docs for screen sharing, noise suppression, simulcast and more. Release notes are in `CHANGELOG.md` inside the package.
|
|
53
|
+
|
|
54
|
+
## License
|
|
55
|
+
|
|
56
|
+
Proprietary. Copyright © Seastart. Use requires an SRTC service license; copying, modification or redistribution without permission is prohibited. A free edition with limited concurrency is available; higher concurrency and private deployments require a commercial license — see [stmlink.com](https://www.stmlink.com).
|
|
57
|
+
|
|
58
|
+
---
|
|
59
|
+
|
|
60
|
+
# SRTC Web SDK(中文)
|
|
61
|
+
|
|
62
|
+
[English](#srtc-web-sdk) | **中文**
|
|
63
|
+
|
|
64
|
+
[SRTC](https://www.stmlink.com) 是一款支持完全私有化部署的实时音视频通信引擎,覆盖全平台 SDK,支持信创国产化,兼容传统 SIP/H.323 设备,集成 AI Agent 能力。
|
|
65
|
+
|
|
66
|
+
本包是**浏览器端 SDK**:加入频道,采集并发布麦克风 / 摄像头 / 屏幕,订阅并播放远端音视频。完整文档见 [SRTC 文档中心](https://docs.stmlink.com/zh/rtc/web/integration)。
|
|
67
|
+
|
|
68
|
+
## 安装
|
|
69
|
+
|
|
70
|
+
```sh
|
|
71
|
+
npm install @seastart/srtc-web-sdk
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
同时提供 ESM(`srtc.mjs`)与 UMD(`srtc.js`)两种构建,自带 TypeScript 类型声明。需要支持 WebRTC 的浏览器,页面须运行在 HTTPS(或 `localhost`)下。
|
|
75
|
+
|
|
76
|
+
## 快速开始
|
|
77
|
+
|
|
78
|
+
```typescript
|
|
79
|
+
import { SRTC, LogLevel, MicPresets, CameraPresets, TrackKind, ChannelEventType } from '@seastart/srtc-web-sdk';
|
|
80
|
+
|
|
81
|
+
const srtc = new SRTC({ logLevel: LogLevel.INFO });
|
|
82
|
+
|
|
83
|
+
// 有人发布视频时订阅并渲染
|
|
84
|
+
srtc.onNotifyChannelEvent = async (evt) => {
|
|
85
|
+
if (evt.type === ChannelEventType.USER_TRACK_ADD && evt.data.track.kind === TrackKind.Video) {
|
|
86
|
+
const video = await srtc.subscribeRemoteVideoTrack(evt.data.user.uid, evt.data.track.id);
|
|
87
|
+
video.addPlayView(document.querySelector<HTMLElement>(`#remote-${evt.data.user.uid}`)!);
|
|
88
|
+
}
|
|
89
|
+
};
|
|
90
|
+
|
|
91
|
+
await srtc.join(token); // token 由你的业务服务端签发
|
|
92
|
+
|
|
93
|
+
const mix = await srtc.subscribeRemoteAudioMixTrack(); // 收听频道里所有人的声音
|
|
94
|
+
await mix.startPlay();
|
|
95
|
+
|
|
96
|
+
const mic = srtc.createLocalMicTrack(MicPresets.music);
|
|
97
|
+
await mic.startCapture();
|
|
98
|
+
await srtc.publishLocalTrack(mic);
|
|
99
|
+
|
|
100
|
+
const camera = srtc.createLocalCameraTrack(CameraPresets['720p']);
|
|
101
|
+
await camera.startCapture();
|
|
102
|
+
camera.addPlayView(document.querySelector<HTMLElement>('#local-video')!);
|
|
103
|
+
await srtc.publishLocalTrack(camera);
|
|
104
|
+
|
|
105
|
+
// ... 离开时
|
|
106
|
+
await srtc.leave();
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
> 请使用具名导入(`import { SRTC } from ...`),本包没有默认导出。
|
|
110
|
+
|
|
111
|
+
完整流程(环境检测、订阅入会前已在推流的用户、离开时的清理)见 [快速开始](https://docs.stmlink.com/zh/rtc/web/quickstart),屏幕共享、降噪、多层视频等见文档中心。版本更新记录见包内的 `CHANGELOG.md`。
|
|
112
|
+
|
|
113
|
+
## 许可证
|
|
114
|
+
|
|
115
|
+
专有软件,版权归 Seastart 所有。使用需获得 SRTC 服务授权,未经许可不得复制、修改或再分发。SRTC 提供免费版(并发量受限),超出限额的并发与私有化部署需购买商业授权,详见 [官网](https://www.stmlink.com)。
|
package/package.json
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@seastart/srtc-web-sdk",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "0.7.1",
|
|
4
|
+
"description": "SRTC Web SDK: real-time audio/video for browsers, built for private deployment | SRTC 浏览器端实时音视频 SDK,支持完全私有化部署",
|
|
5
|
+
"homepage": "https://docs.stmlink.com/zh/rtc/web/integration",
|
|
5
6
|
"main": "srtc.js",
|
|
6
7
|
"module": "srtc.mjs",
|
|
7
8
|
"types": "srtc.d.ts",
|
|
@@ -15,7 +16,8 @@
|
|
|
15
16
|
"types": "./srtc.d.mts",
|
|
16
17
|
"default": "./srtc.mjs"
|
|
17
18
|
}
|
|
18
|
-
}
|
|
19
|
+
},
|
|
20
|
+
"./package.json": "./package.json"
|
|
19
21
|
},
|
|
20
22
|
"dependencies": {
|
|
21
23
|
"bowser": "^2.11.0"
|
|
@@ -27,8 +29,13 @@
|
|
|
27
29
|
"video call",
|
|
28
30
|
"audio call",
|
|
29
31
|
"live streaming",
|
|
30
|
-
"real-time communication"
|
|
32
|
+
"real-time communication",
|
|
33
|
+
"sdk",
|
|
34
|
+
"video conference",
|
|
35
|
+
"private deployment",
|
|
36
|
+
"音视频",
|
|
37
|
+
"私有化部署"
|
|
31
38
|
],
|
|
32
|
-
"author": "dev@seastart.cn",
|
|
33
|
-
"license": "
|
|
34
|
-
}
|
|
39
|
+
"author": "Seastart <dev@seastart.cn>",
|
|
40
|
+
"license": "UNLICENSED"
|
|
41
|
+
}
|
package/srtc.d.mts
CHANGED
|
@@ -928,6 +928,34 @@ export declare class SRTC extends BaseSRTC {
|
|
|
928
928
|
unsubscribeRemoteTrack(track: RemoteAudioMixTrack | RemoteAudioTrack | RemoteVideoTrack): Promise<void>;
|
|
929
929
|
getRemoteTrack(uid: string, id?: string, desc?: string): RemoteAudioTrack | RemoteVideoTrack;
|
|
930
930
|
}
|
|
931
|
+
export declare class SdkError extends Error {
|
|
932
|
+
/** 完整错误码:SDK 错误为端前缀 + 3 位低位码;>= 1000 为后端业务错误码 */
|
|
933
|
+
code: number;
|
|
934
|
+
/** 错误详情(与 message 相同,兼容旧版保留) */
|
|
935
|
+
msg: string;
|
|
936
|
+
/** 原始异常:采集失败时为浏览器的 DOMException,其它情况一般为空 */
|
|
937
|
+
cause?: unknown;
|
|
938
|
+
constructor(msg: string, code?: number);
|
|
939
|
+
/**
|
|
940
|
+
* 低 3 位语义码(跨端统一,对照 ErrorCode);后端错误码(>= 1000)返回自身
|
|
941
|
+
*
|
|
942
|
+
* 只有「本实例前缀 + 3 位」的六位码才取低 3 位(web 106xxx、小程序 107xxx、meeting 子类 206xxx/207xxx)。
|
|
943
|
+
* 其它码原样返回:如 rtc-log-center 的 230001 若按 % 1000 会算成 1,被误认成 NotInChannel。
|
|
944
|
+
*/
|
|
945
|
+
get baseCode(): number;
|
|
946
|
+
/**
|
|
947
|
+
* 从err转化为sdkError
|
|
948
|
+
* @param err 原始error
|
|
949
|
+
* @param code 低 3 位错误码,默认 ErrorCode.Unknown
|
|
950
|
+
* @returns
|
|
951
|
+
*/
|
|
952
|
+
static fromError(err: Error, code?: number): SdkError;
|
|
953
|
+
toString(): string;
|
|
954
|
+
toJSON(): {
|
|
955
|
+
code: number;
|
|
956
|
+
msg: string;
|
|
957
|
+
};
|
|
958
|
+
}
|
|
931
959
|
/**
|
|
932
960
|
* 摄像头预设参数
|
|
933
961
|
*/
|
|
@@ -1058,6 +1086,96 @@ export declare enum DisconnectReason {
|
|
|
1058
1086
|
/** 频道销毁离开 */
|
|
1059
1087
|
Destroy = 5
|
|
1060
1088
|
}
|
|
1089
|
+
/**
|
|
1090
|
+
* SDK 错误码的低 3 位语义码(跨端统一)。
|
|
1091
|
+
*
|
|
1092
|
+
* 完整错误码 = 端前缀(web 106 / 小程序 107)+ 3 位补零的低位码,例如
|
|
1093
|
+
* `ErrorCode.TrackNotCaptured`(33) 在 web 端为 `106033`。
|
|
1094
|
+
* 跨端比较请用 {@link SdkError.baseCode},即:
|
|
1095
|
+
* `e instanceof SdkError && e.baseCode === ErrorCode.TrackNotCaptured`。
|
|
1096
|
+
*
|
|
1097
|
+
* 号段约定(统一码表第 2 版):000–099 通用语义;200–299 频道/设备细分;300–349 流媒体;
|
|
1098
|
+
* 500–599 端特有(须在码表登记适用端)。
|
|
1099
|
+
* 跨端统一码表见 stmlink-docs(文档站)错误码总表页:https://docs.stmlink.com/zh/rtc/error-codes
|
|
1100
|
+
*/
|
|
1101
|
+
export declare enum ErrorCode {
|
|
1102
|
+
/** 000 未分类错误:包装未知异常时的兜底码。rtc-go 同号 */
|
|
1103
|
+
Unknown = 0,
|
|
1104
|
+
/** 001 不在频道内:未入会或已离会后调用频道级方法。rtc-go / rtc-swift(notConnected) / 鸿蒙同号;rtc-android 102001 为历史不同义码 */
|
|
1105
|
+
NotInChannel = 1,
|
|
1106
|
+
/** 002 Token 已过期:join / enableIm 时 token 的 exp_at 已过。rtc-go / rtc-swift / 鸿蒙同号 */
|
|
1107
|
+
TokenExpired = 2,
|
|
1108
|
+
/** 003 流轨道不存在:按 uid + id/desc 查找远端轨道失败。rtc-go / rtc-swift / 鸿蒙同号(rtc-android 同义码 205) */
|
|
1109
|
+
TrackNotFound = 3,
|
|
1110
|
+
/** 004 Token 不合法(本端暂未使用,预留)。各端同号(rtc-go 原 040 已按统一码表第 2 版改为 004) */
|
|
1111
|
+
TokenInvalid = 4,
|
|
1112
|
+
/** 005 已加入:重复 join(不支持多频道的端)/ 重复 enableIm / 重复加入白板。rtc-swift / 鸿蒙同号(rtc-android 同义码 208) */
|
|
1113
|
+
AlreadyJoined = 5,
|
|
1114
|
+
/** 006 连接失败:HTTP 非 200、网络请求失败、SFU 接口多次重试仍失败。rtc-swift / 鸿蒙同号 */
|
|
1115
|
+
ConnectionFailed = 6,
|
|
1116
|
+
/** 007 连接超时:入会时 PeerConnection 等不到 connected。rtc-swift / 鸿蒙同号 */
|
|
1117
|
+
ConnectionTimeout = 7,
|
|
1118
|
+
/** 009 信令连接失败:MQTT 连接 / 取消订阅 / 关闭 / 发布失败,以及连接期的 socket error。rtc-swift / 鸿蒙同号 */
|
|
1119
|
+
SignalingConnectFailed = 9,
|
|
1120
|
+
/** 010 信令订阅失败:MQTT subscribe 失败。rtc-swift / 鸿蒙同号 */
|
|
1121
|
+
SignalingSubscribeFailed = 10,
|
|
1122
|
+
/** 011 响应解码失败:HTTP 200 但响应体不是 JSON 或缺 code 字段(SDK 接口、白板、日志中心、CDN / ook 网关接口均如此)。不算后端错误,重试逻辑与 006 相同。rtc-go / rtc-swift / 鸿蒙同号 */
|
|
1123
|
+
MessageDecodeFailed = 11,
|
|
1124
|
+
/** 013 SDP 协商失败:CDN(网宿等)/ ook 网关的 SDP 交换接口返回错误。rtc-swift / 鸿蒙同号(rtc-android 同义码 313) */
|
|
1125
|
+
SdpNegotiationFailed = 13,
|
|
1126
|
+
/** 014 传输未就绪:频道 / seastart 引擎重连中、发布/订阅 PeerConnection 尚未连接,稍后重试即可。rtc-swift / 鸿蒙同号(rtc-android 同义码 203) */
|
|
1127
|
+
TransportNotReady = 14,
|
|
1128
|
+
/** 015 PeerConnection 失败:发布/订阅的 PeerConnection 进入 failed / closed(不管发生在发布、订阅还是入会阶段)。统一码表第 2 版 */
|
|
1129
|
+
PeerConnectionFailed = 15,
|
|
1130
|
+
/** 018 采集失败:设备被其它程序占用、硬件错误等(浏览器 NotReadableError / AbortError),可提示用户关闭占用设备的程序后重试。rtc-swift / 鸿蒙同号 */
|
|
1131
|
+
CaptureFailed = 18,
|
|
1132
|
+
/** 019 编解码器不支持:当前环境缺 OPUS / H264。rtc-swift / 鸿蒙同号 */
|
|
1133
|
+
CodecNotSupported = 19,
|
|
1134
|
+
/** 020 超过发布上限:流媒体引擎允许的音频/视频发布轨道数已满。rtc-swift / 鸿蒙同号 */
|
|
1135
|
+
MaxPublishLimitReached = 20,
|
|
1136
|
+
/** 021 设备不存在:找不到摄像头/麦克风,或指定的 deviceId 已拔出(浏览器 NotFoundError / OverconstrainedError)。rtc-swift / 鸿蒙同号 */
|
|
1137
|
+
DeviceNotFound = 21,
|
|
1138
|
+
/** 022 流媒体引擎不支持:后端下发了 SDK 不认识的 vendor。rtc-swift / 鸿蒙同号(rtc-android 同义码 206) */
|
|
1139
|
+
EngineNotSupported = 22,
|
|
1140
|
+
/** 024 状态不允许:调用顺序问题(已 destroy、心跳状态异常、本地信息未就绪、多频道发布时调 track.getInfo 等)。rtc-swift / 鸿蒙同号 */
|
|
1141
|
+
InvalidState = 24,
|
|
1142
|
+
/** 025 SDK 内部错误:清理失败、处理器未产出轨道、未知 SDP 方向等,出现即 SDK/插件缺陷。rtc-swift / 鸿蒙同号 */
|
|
1143
|
+
InternalError = 25,
|
|
1144
|
+
/** 026 操作被取消:如离会导致 SFU 接口调用被取消。rtc-swift / 鸿蒙同号 */
|
|
1145
|
+
Cancelled = 26,
|
|
1146
|
+
/** 031 参数非法:必填参数为空、参数类型不符等。新码(rtc-js 首用,已在统一码表登记) */
|
|
1147
|
+
InvalidArgument = 31,
|
|
1148
|
+
/** 032 当前环境不支持该能力:屏幕共享、画中画、联播、MediaRecorder 等。新码 */
|
|
1149
|
+
FeatureNotSupported = 32,
|
|
1150
|
+
/** 033 轨道未采集:轨道没有 MediaStreamTrack(未 startCapture 或已停止)就发布/播放/设置处理器。新码 */
|
|
1151
|
+
TrackNotCaptured = 33,
|
|
1152
|
+
/** 034 超过订阅上限:流媒体引擎允许的音频/视频订阅轨道数已满。新码 */
|
|
1153
|
+
MaxSubscribeLimitReached = 34,
|
|
1154
|
+
/** 035 发布描述冲突:同一 desc(或 CDN 流槽位)已被其它轨道占用。新码 */
|
|
1155
|
+
PublishDescConflict = 35,
|
|
1156
|
+
/** 036 播放失败:audio.play() 失败且不是浏览器自动播放策略导致。新码 */
|
|
1157
|
+
PlayFailed = 36,
|
|
1158
|
+
/** 037 播放容器不存在:画中画/弹出窗口传入未 addPlayView 的容器、小程序节点查询不到。新码 */
|
|
1159
|
+
PlayViewNotFound = 37,
|
|
1160
|
+
/** 038 弹窗被拦截:window.open 被浏览器拦截。新码 */
|
|
1161
|
+
PopupBlocked = 38,
|
|
1162
|
+
/** 039 屏幕共享被拒绝:用户在选择窗口里取消,或系统未授予录屏权限(浏览器 NotAllowedError)。新码 */
|
|
1163
|
+
ScreenShareDenied = 39,
|
|
1164
|
+
/** 204 频道内没有该用户:订阅/查询的 uid 不在频道内。沿用 rtc-android 102204 */
|
|
1165
|
+
UserNotFound = 204,
|
|
1166
|
+
/** 231 无摄像头权限:用户或系统拒绝了摄像头授权(web 为浏览器 NotAllowedError / SecurityError)。沿用 rtc-android 102231 */
|
|
1167
|
+
CameraPermissionDenied = 231,
|
|
1168
|
+
/** 251 无麦克风权限:用户或系统拒绝了麦克风授权(web 为浏览器 NotAllowedError / SecurityError)。沿用 rtc-android 102251 */
|
|
1169
|
+
MicPermissionDenied = 251,
|
|
1170
|
+
/** 300 发布失败:seastart 引擎未连接 / 已断开(非重连中)时发布。rtc-go 同号 */
|
|
1171
|
+
PublishFailed = 300,
|
|
1172
|
+
/** 301 订阅失败:seastart 引擎未连接 / 已断开(非重连中)时订阅。rtc-go 同号 */
|
|
1173
|
+
SubscribeFailed = 301,
|
|
1174
|
+
/** 302 发布超时:CDN 引擎(网宿)发布协商超时。rtc-go 同号 */
|
|
1175
|
+
PublishTimeout = 302,
|
|
1176
|
+
/** 303 订阅超时:CDN 引擎(网宿)订阅协商超时。rtc-go 同号 */
|
|
1177
|
+
SubscribeTimeout = 303
|
|
1178
|
+
}
|
|
1061
1179
|
/** 用户断开im的原因 */
|
|
1062
1180
|
export declare enum ImDisconnectReason {
|
|
1063
1181
|
/** 错误 */
|
|
@@ -1238,6 +1356,13 @@ export interface AudioSenderStats extends SenderStats {
|
|
|
1238
1356
|
/** 音频电平 */
|
|
1239
1357
|
audioLevel?: number;
|
|
1240
1358
|
}
|
|
1359
|
+
/** 自动播放弹窗文案(面向终端用户) */
|
|
1360
|
+
export interface AutoPlayDialogText {
|
|
1361
|
+
/** 弹窗提示语 */
|
|
1362
|
+
message?: string;
|
|
1363
|
+
/** 确认按钮文字 */
|
|
1364
|
+
confirm?: string;
|
|
1365
|
+
}
|
|
1241
1366
|
/**
|
|
1242
1367
|
* 频道的类型化事件重载。
|
|
1243
1368
|
*
|
|
@@ -1937,6 +2062,18 @@ export interface SdkInitParams {
|
|
|
1937
2062
|
logLevel?: LogLevel;
|
|
1938
2063
|
/** 日志目标 */
|
|
1939
2064
|
logTarget?: LogTarget;
|
|
2065
|
+
/**
|
|
2066
|
+
* 语言(BCP 47,如 `zh-CN`、`en`),进程级全局配置。
|
|
2067
|
+
* 影响:请求后端时的 `Accept-Language` 头(后端业务错误文案的语言)、Web 端自动播放弹窗的内置文案。
|
|
2068
|
+
* SDK 自身的报错(106xxx / 107xxx)固定为英文,不受此参数影响。
|
|
2069
|
+
* 不传则跟随系统语言(Web:`navigator.language`;小程序:`wx.getAppBaseInfo().language`),取不到时为 `zh`。
|
|
2070
|
+
*/
|
|
2071
|
+
language?: string;
|
|
2072
|
+
/**
|
|
2073
|
+
* 自动播放弹窗文案覆盖(仅 Web 端),进程级全局配置。
|
|
2074
|
+
* 未覆盖的字段按 `language` 取内置中/英文案;播放参数 `disableAutoPlayDialog: true` 时不弹窗、此项无效。
|
|
2075
|
+
*/
|
|
2076
|
+
autoPlayDialogText?: AutoPlayDialogText;
|
|
1940
2077
|
}
|
|
1941
2078
|
/**
|
|
1942
2079
|
* 发送数据统计
|
package/srtc.d.ts
CHANGED
|
@@ -928,6 +928,34 @@ export declare class SRTC extends BaseSRTC {
|
|
|
928
928
|
unsubscribeRemoteTrack(track: RemoteAudioMixTrack | RemoteAudioTrack | RemoteVideoTrack): Promise<void>;
|
|
929
929
|
getRemoteTrack(uid: string, id?: string, desc?: string): RemoteAudioTrack | RemoteVideoTrack;
|
|
930
930
|
}
|
|
931
|
+
export declare class SdkError extends Error {
|
|
932
|
+
/** 完整错误码:SDK 错误为端前缀 + 3 位低位码;>= 1000 为后端业务错误码 */
|
|
933
|
+
code: number;
|
|
934
|
+
/** 错误详情(与 message 相同,兼容旧版保留) */
|
|
935
|
+
msg: string;
|
|
936
|
+
/** 原始异常:采集失败时为浏览器的 DOMException,其它情况一般为空 */
|
|
937
|
+
cause?: unknown;
|
|
938
|
+
constructor(msg: string, code?: number);
|
|
939
|
+
/**
|
|
940
|
+
* 低 3 位语义码(跨端统一,对照 ErrorCode);后端错误码(>= 1000)返回自身
|
|
941
|
+
*
|
|
942
|
+
* 只有「本实例前缀 + 3 位」的六位码才取低 3 位(web 106xxx、小程序 107xxx、meeting 子类 206xxx/207xxx)。
|
|
943
|
+
* 其它码原样返回:如 rtc-log-center 的 230001 若按 % 1000 会算成 1,被误认成 NotInChannel。
|
|
944
|
+
*/
|
|
945
|
+
get baseCode(): number;
|
|
946
|
+
/**
|
|
947
|
+
* 从err转化为sdkError
|
|
948
|
+
* @param err 原始error
|
|
949
|
+
* @param code 低 3 位错误码,默认 ErrorCode.Unknown
|
|
950
|
+
* @returns
|
|
951
|
+
*/
|
|
952
|
+
static fromError(err: Error, code?: number): SdkError;
|
|
953
|
+
toString(): string;
|
|
954
|
+
toJSON(): {
|
|
955
|
+
code: number;
|
|
956
|
+
msg: string;
|
|
957
|
+
};
|
|
958
|
+
}
|
|
931
959
|
/**
|
|
932
960
|
* 摄像头预设参数
|
|
933
961
|
*/
|
|
@@ -1058,6 +1086,96 @@ export declare enum DisconnectReason {
|
|
|
1058
1086
|
/** 频道销毁离开 */
|
|
1059
1087
|
Destroy = 5
|
|
1060
1088
|
}
|
|
1089
|
+
/**
|
|
1090
|
+
* SDK 错误码的低 3 位语义码(跨端统一)。
|
|
1091
|
+
*
|
|
1092
|
+
* 完整错误码 = 端前缀(web 106 / 小程序 107)+ 3 位补零的低位码,例如
|
|
1093
|
+
* `ErrorCode.TrackNotCaptured`(33) 在 web 端为 `106033`。
|
|
1094
|
+
* 跨端比较请用 {@link SdkError.baseCode},即:
|
|
1095
|
+
* `e instanceof SdkError && e.baseCode === ErrorCode.TrackNotCaptured`。
|
|
1096
|
+
*
|
|
1097
|
+
* 号段约定(统一码表第 2 版):000–099 通用语义;200–299 频道/设备细分;300–349 流媒体;
|
|
1098
|
+
* 500–599 端特有(须在码表登记适用端)。
|
|
1099
|
+
* 跨端统一码表见 stmlink-docs(文档站)错误码总表页:https://docs.stmlink.com/zh/rtc/error-codes
|
|
1100
|
+
*/
|
|
1101
|
+
export declare enum ErrorCode {
|
|
1102
|
+
/** 000 未分类错误:包装未知异常时的兜底码。rtc-go 同号 */
|
|
1103
|
+
Unknown = 0,
|
|
1104
|
+
/** 001 不在频道内:未入会或已离会后调用频道级方法。rtc-go / rtc-swift(notConnected) / 鸿蒙同号;rtc-android 102001 为历史不同义码 */
|
|
1105
|
+
NotInChannel = 1,
|
|
1106
|
+
/** 002 Token 已过期:join / enableIm 时 token 的 exp_at 已过。rtc-go / rtc-swift / 鸿蒙同号 */
|
|
1107
|
+
TokenExpired = 2,
|
|
1108
|
+
/** 003 流轨道不存在:按 uid + id/desc 查找远端轨道失败。rtc-go / rtc-swift / 鸿蒙同号(rtc-android 同义码 205) */
|
|
1109
|
+
TrackNotFound = 3,
|
|
1110
|
+
/** 004 Token 不合法(本端暂未使用,预留)。各端同号(rtc-go 原 040 已按统一码表第 2 版改为 004) */
|
|
1111
|
+
TokenInvalid = 4,
|
|
1112
|
+
/** 005 已加入:重复 join(不支持多频道的端)/ 重复 enableIm / 重复加入白板。rtc-swift / 鸿蒙同号(rtc-android 同义码 208) */
|
|
1113
|
+
AlreadyJoined = 5,
|
|
1114
|
+
/** 006 连接失败:HTTP 非 200、网络请求失败、SFU 接口多次重试仍失败。rtc-swift / 鸿蒙同号 */
|
|
1115
|
+
ConnectionFailed = 6,
|
|
1116
|
+
/** 007 连接超时:入会时 PeerConnection 等不到 connected。rtc-swift / 鸿蒙同号 */
|
|
1117
|
+
ConnectionTimeout = 7,
|
|
1118
|
+
/** 009 信令连接失败:MQTT 连接 / 取消订阅 / 关闭 / 发布失败,以及连接期的 socket error。rtc-swift / 鸿蒙同号 */
|
|
1119
|
+
SignalingConnectFailed = 9,
|
|
1120
|
+
/** 010 信令订阅失败:MQTT subscribe 失败。rtc-swift / 鸿蒙同号 */
|
|
1121
|
+
SignalingSubscribeFailed = 10,
|
|
1122
|
+
/** 011 响应解码失败:HTTP 200 但响应体不是 JSON 或缺 code 字段(SDK 接口、白板、日志中心、CDN / ook 网关接口均如此)。不算后端错误,重试逻辑与 006 相同。rtc-go / rtc-swift / 鸿蒙同号 */
|
|
1123
|
+
MessageDecodeFailed = 11,
|
|
1124
|
+
/** 013 SDP 协商失败:CDN(网宿等)/ ook 网关的 SDP 交换接口返回错误。rtc-swift / 鸿蒙同号(rtc-android 同义码 313) */
|
|
1125
|
+
SdpNegotiationFailed = 13,
|
|
1126
|
+
/** 014 传输未就绪:频道 / seastart 引擎重连中、发布/订阅 PeerConnection 尚未连接,稍后重试即可。rtc-swift / 鸿蒙同号(rtc-android 同义码 203) */
|
|
1127
|
+
TransportNotReady = 14,
|
|
1128
|
+
/** 015 PeerConnection 失败:发布/订阅的 PeerConnection 进入 failed / closed(不管发生在发布、订阅还是入会阶段)。统一码表第 2 版 */
|
|
1129
|
+
PeerConnectionFailed = 15,
|
|
1130
|
+
/** 018 采集失败:设备被其它程序占用、硬件错误等(浏览器 NotReadableError / AbortError),可提示用户关闭占用设备的程序后重试。rtc-swift / 鸿蒙同号 */
|
|
1131
|
+
CaptureFailed = 18,
|
|
1132
|
+
/** 019 编解码器不支持:当前环境缺 OPUS / H264。rtc-swift / 鸿蒙同号 */
|
|
1133
|
+
CodecNotSupported = 19,
|
|
1134
|
+
/** 020 超过发布上限:流媒体引擎允许的音频/视频发布轨道数已满。rtc-swift / 鸿蒙同号 */
|
|
1135
|
+
MaxPublishLimitReached = 20,
|
|
1136
|
+
/** 021 设备不存在:找不到摄像头/麦克风,或指定的 deviceId 已拔出(浏览器 NotFoundError / OverconstrainedError)。rtc-swift / 鸿蒙同号 */
|
|
1137
|
+
DeviceNotFound = 21,
|
|
1138
|
+
/** 022 流媒体引擎不支持:后端下发了 SDK 不认识的 vendor。rtc-swift / 鸿蒙同号(rtc-android 同义码 206) */
|
|
1139
|
+
EngineNotSupported = 22,
|
|
1140
|
+
/** 024 状态不允许:调用顺序问题(已 destroy、心跳状态异常、本地信息未就绪、多频道发布时调 track.getInfo 等)。rtc-swift / 鸿蒙同号 */
|
|
1141
|
+
InvalidState = 24,
|
|
1142
|
+
/** 025 SDK 内部错误:清理失败、处理器未产出轨道、未知 SDP 方向等,出现即 SDK/插件缺陷。rtc-swift / 鸿蒙同号 */
|
|
1143
|
+
InternalError = 25,
|
|
1144
|
+
/** 026 操作被取消:如离会导致 SFU 接口调用被取消。rtc-swift / 鸿蒙同号 */
|
|
1145
|
+
Cancelled = 26,
|
|
1146
|
+
/** 031 参数非法:必填参数为空、参数类型不符等。新码(rtc-js 首用,已在统一码表登记) */
|
|
1147
|
+
InvalidArgument = 31,
|
|
1148
|
+
/** 032 当前环境不支持该能力:屏幕共享、画中画、联播、MediaRecorder 等。新码 */
|
|
1149
|
+
FeatureNotSupported = 32,
|
|
1150
|
+
/** 033 轨道未采集:轨道没有 MediaStreamTrack(未 startCapture 或已停止)就发布/播放/设置处理器。新码 */
|
|
1151
|
+
TrackNotCaptured = 33,
|
|
1152
|
+
/** 034 超过订阅上限:流媒体引擎允许的音频/视频订阅轨道数已满。新码 */
|
|
1153
|
+
MaxSubscribeLimitReached = 34,
|
|
1154
|
+
/** 035 发布描述冲突:同一 desc(或 CDN 流槽位)已被其它轨道占用。新码 */
|
|
1155
|
+
PublishDescConflict = 35,
|
|
1156
|
+
/** 036 播放失败:audio.play() 失败且不是浏览器自动播放策略导致。新码 */
|
|
1157
|
+
PlayFailed = 36,
|
|
1158
|
+
/** 037 播放容器不存在:画中画/弹出窗口传入未 addPlayView 的容器、小程序节点查询不到。新码 */
|
|
1159
|
+
PlayViewNotFound = 37,
|
|
1160
|
+
/** 038 弹窗被拦截:window.open 被浏览器拦截。新码 */
|
|
1161
|
+
PopupBlocked = 38,
|
|
1162
|
+
/** 039 屏幕共享被拒绝:用户在选择窗口里取消,或系统未授予录屏权限(浏览器 NotAllowedError)。新码 */
|
|
1163
|
+
ScreenShareDenied = 39,
|
|
1164
|
+
/** 204 频道内没有该用户:订阅/查询的 uid 不在频道内。沿用 rtc-android 102204 */
|
|
1165
|
+
UserNotFound = 204,
|
|
1166
|
+
/** 231 无摄像头权限:用户或系统拒绝了摄像头授权(web 为浏览器 NotAllowedError / SecurityError)。沿用 rtc-android 102231 */
|
|
1167
|
+
CameraPermissionDenied = 231,
|
|
1168
|
+
/** 251 无麦克风权限:用户或系统拒绝了麦克风授权(web 为浏览器 NotAllowedError / SecurityError)。沿用 rtc-android 102251 */
|
|
1169
|
+
MicPermissionDenied = 251,
|
|
1170
|
+
/** 300 发布失败:seastart 引擎未连接 / 已断开(非重连中)时发布。rtc-go 同号 */
|
|
1171
|
+
PublishFailed = 300,
|
|
1172
|
+
/** 301 订阅失败:seastart 引擎未连接 / 已断开(非重连中)时订阅。rtc-go 同号 */
|
|
1173
|
+
SubscribeFailed = 301,
|
|
1174
|
+
/** 302 发布超时:CDN 引擎(网宿)发布协商超时。rtc-go 同号 */
|
|
1175
|
+
PublishTimeout = 302,
|
|
1176
|
+
/** 303 订阅超时:CDN 引擎(网宿)订阅协商超时。rtc-go 同号 */
|
|
1177
|
+
SubscribeTimeout = 303
|
|
1178
|
+
}
|
|
1061
1179
|
/** 用户断开im的原因 */
|
|
1062
1180
|
export declare enum ImDisconnectReason {
|
|
1063
1181
|
/** 错误 */
|
|
@@ -1238,6 +1356,13 @@ export interface AudioSenderStats extends SenderStats {
|
|
|
1238
1356
|
/** 音频电平 */
|
|
1239
1357
|
audioLevel?: number;
|
|
1240
1358
|
}
|
|
1359
|
+
/** 自动播放弹窗文案(面向终端用户) */
|
|
1360
|
+
export interface AutoPlayDialogText {
|
|
1361
|
+
/** 弹窗提示语 */
|
|
1362
|
+
message?: string;
|
|
1363
|
+
/** 确认按钮文字 */
|
|
1364
|
+
confirm?: string;
|
|
1365
|
+
}
|
|
1241
1366
|
/**
|
|
1242
1367
|
* 频道的类型化事件重载。
|
|
1243
1368
|
*
|
|
@@ -1937,6 +2062,18 @@ export interface SdkInitParams {
|
|
|
1937
2062
|
logLevel?: LogLevel;
|
|
1938
2063
|
/** 日志目标 */
|
|
1939
2064
|
logTarget?: LogTarget;
|
|
2065
|
+
/**
|
|
2066
|
+
* 语言(BCP 47,如 `zh-CN`、`en`),进程级全局配置。
|
|
2067
|
+
* 影响:请求后端时的 `Accept-Language` 头(后端业务错误文案的语言)、Web 端自动播放弹窗的内置文案。
|
|
2068
|
+
* SDK 自身的报错(106xxx / 107xxx)固定为英文,不受此参数影响。
|
|
2069
|
+
* 不传则跟随系统语言(Web:`navigator.language`;小程序:`wx.getAppBaseInfo().language`),取不到时为 `zh`。
|
|
2070
|
+
*/
|
|
2071
|
+
language?: string;
|
|
2072
|
+
/**
|
|
2073
|
+
* 自动播放弹窗文案覆盖(仅 Web 端),进程级全局配置。
|
|
2074
|
+
* 未覆盖的字段按 `language` 取内置中/英文案;播放参数 `disableAutoPlayDialog: true` 时不弹窗、此项无效。
|
|
2075
|
+
*/
|
|
2076
|
+
autoPlayDialogText?: AutoPlayDialogText;
|
|
1940
2077
|
}
|
|
1941
2078
|
/**
|
|
1942
2079
|
* 发送数据统计
|