@seastart/srtc-web-sdk 0.4.2 → 0.4.4
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 +11 -0
- package/README.md +2 -2
- package/package.json +1 -1
- package/srtc.d.mts +276 -3
- package/srtc.d.ts +276 -3
- package/srtc.js +1 -1
- package/srtc.mjs +1 -1
package/CHANGELOG.md
ADDED
package/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# SRTC Web SDK (SRTC浏览器sdk)
|
|
2
2
|
|
|
3
3
|
## 介绍
|
|
4
|
-
srtc(
|
|
4
|
+
[srtc](https://www.stmlink.com)是一款是支持完全私有化部署的实时音视频通信引擎,覆盖全平台 SDK, 支持信创国产化,兼容传统 SIP/H.323 设备,集成 AI Agent 能力。可以快速帮助您搭建低成本、低延时、高品质的音视频互动解决方案。
|
|
5
5
|
|
|
6
6
|
## sdk使用帮助
|
|
7
|
-
|
|
7
|
+
[srtc使用帮助](https://docs.stmlink.com/zh/rtc/web/integration)
|
package/package.json
CHANGED
package/srtc.d.mts
CHANGED
|
@@ -40,10 +40,18 @@ declare abstract class BaseSRTC {
|
|
|
40
40
|
*/
|
|
41
41
|
getChannelInfo(): BaseChannelInfo | null;
|
|
42
42
|
/**
|
|
43
|
-
* 获取流媒体引擎的metric
|
|
44
|
-
|
|
43
|
+
* 获取流媒体引擎的metric快照(全量,含每条轨道的统计)
|
|
44
|
+
*/
|
|
45
|
+
getStreamMetric(): StreamMetric | undefined;
|
|
46
|
+
/**
|
|
47
|
+
* 获取当前网络总体统计,只关心网络全景时用,比 getStreamMetric 更轻量
|
|
45
48
|
*/
|
|
46
|
-
|
|
49
|
+
getNetworkStats(): NetworkStats | undefined;
|
|
50
|
+
/**
|
|
51
|
+
* 获取当前连接质量评估结果(等级 / MOS / 触发原因)
|
|
52
|
+
* 配合 CONNECTION_QUALITY_CHANGED 事件使用
|
|
53
|
+
*/
|
|
54
|
+
getConnectionQuality(): QualityEvaluation | undefined;
|
|
47
55
|
/**
|
|
48
56
|
* 获取某用户信息
|
|
49
57
|
* @returns
|
|
@@ -112,6 +120,10 @@ declare abstract class BaseTrack extends EventEmitter {
|
|
|
112
120
|
* 轨道描述
|
|
113
121
|
*/
|
|
114
122
|
get desc(): string;
|
|
123
|
+
/**
|
|
124
|
+
* 是否为 simulcast 副层
|
|
125
|
+
*/
|
|
126
|
+
get variant(): boolean | undefined;
|
|
115
127
|
/**
|
|
116
128
|
* 获取流轨道信息
|
|
117
129
|
* @returns
|
|
@@ -163,6 +175,12 @@ declare class CommonChannelEventType {
|
|
|
163
175
|
static readonly TRACK_UNMUTED = "track_unmuted";
|
|
164
176
|
/** 流轨道停止,对应data为BaseTrack */
|
|
165
177
|
static readonly TRACK_ENDED = "track_ended";
|
|
178
|
+
/** 连接质量等级变化,对应data为 ConnectionQualityEventData */
|
|
179
|
+
static readonly CONNECTION_QUALITY_CHANGED = "connection_quality_changed";
|
|
180
|
+
/** 发送端被CPU持续限制,对应data为 QualityEvaluation */
|
|
181
|
+
static readonly CPU_CONSTRAINED = "cpu_constrained";
|
|
182
|
+
/** 发送端被带宽持续限制,对应data为 QualityEvaluation */
|
|
183
|
+
static readonly BANDWIDTH_CONSTRAINED = "bandwidth_constrained";
|
|
166
184
|
}
|
|
167
185
|
/** 频道外事件类型 */
|
|
168
186
|
declare class CommonImEventType {
|
|
@@ -651,6 +669,21 @@ export declare enum Codec {
|
|
|
651
669
|
/** OPUS编码 */
|
|
652
670
|
OPUS = 1398100047
|
|
653
671
|
}
|
|
672
|
+
/**
|
|
673
|
+
* 连接质量等级(对齐 LiveKit 5 档)
|
|
674
|
+
*/
|
|
675
|
+
export declare enum ConnectionQuality {
|
|
676
|
+
/** 初始占位,采样不足时使用,避免误报 */
|
|
677
|
+
Unknown = "unknown",
|
|
678
|
+
/** 优秀:几乎无损 */
|
|
679
|
+
Excellent = "excellent",
|
|
680
|
+
/** 良好:轻微丢包或延迟 */
|
|
681
|
+
Good = "good",
|
|
682
|
+
/** 较差:明显卡顿、丢包或被 cpu/bandwidth 限制 */
|
|
683
|
+
Poor = "poor",
|
|
684
|
+
/** 连接已丢失,媒体无法传输,应触发重连 */
|
|
685
|
+
Lost = "lost"
|
|
686
|
+
}
|
|
654
687
|
/**
|
|
655
688
|
* 终端类型枚举
|
|
656
689
|
*/
|
|
@@ -816,6 +849,30 @@ export interface AudioPublishOptions {
|
|
|
816
849
|
/** 自定义属性 */
|
|
817
850
|
props?: Record<string, any>;
|
|
818
851
|
}
|
|
852
|
+
export interface AudioReceiverStats extends ReceiverStats {
|
|
853
|
+
/** 类型 */
|
|
854
|
+
type: "audio";
|
|
855
|
+
/** 音频电平 */
|
|
856
|
+
audioLevel?: number;
|
|
857
|
+
/** 隐藏样本数 */
|
|
858
|
+
concealedSamples?: number;
|
|
859
|
+
/** 隐藏事件次数 */
|
|
860
|
+
concealmentEvents?: number;
|
|
861
|
+
/** 静音隐藏样本数 */
|
|
862
|
+
silentConcealedSamples?: number;
|
|
863
|
+
/** 静音隐藏事件次数 */
|
|
864
|
+
silentConcealmentEvents?: number;
|
|
865
|
+
/** 总音频能量 */
|
|
866
|
+
totalAudioEnergy?: number;
|
|
867
|
+
/** 总样本时长 */
|
|
868
|
+
totalSamplesDuration?: number;
|
|
869
|
+
}
|
|
870
|
+
export interface AudioSenderStats extends SenderStats {
|
|
871
|
+
/** 类型 */
|
|
872
|
+
type: "audio";
|
|
873
|
+
/** 音频电平 */
|
|
874
|
+
audioLevel?: number;
|
|
875
|
+
}
|
|
819
876
|
/**
|
|
820
877
|
* sdk编译信息
|
|
821
878
|
*/
|
|
@@ -858,6 +915,15 @@ export interface CameraPreset {
|
|
|
858
915
|
capture: CameraCaptureOptions;
|
|
859
916
|
publish: VideoPublishOptions;
|
|
860
917
|
}
|
|
918
|
+
/**
|
|
919
|
+
* 连接质量变化事件 data
|
|
920
|
+
*/
|
|
921
|
+
export interface ConnectionQualityEventData {
|
|
922
|
+
/** 当前评估结果(等级、MOS、原因等) */
|
|
923
|
+
evaluation: QualityEvaluation;
|
|
924
|
+
/** 变化前的质量等级 */
|
|
925
|
+
previous: ConnectionQuality;
|
|
926
|
+
}
|
|
861
927
|
/**
|
|
862
928
|
* 自定义消息
|
|
863
929
|
*/
|
|
@@ -1075,6 +1141,33 @@ export interface MixedAudioMediaStreamTrack extends MediaStreamTrack {
|
|
|
1075
1141
|
removeTrack(track: MediaStreamTrack): void;
|
|
1076
1142
|
trackCount: number;
|
|
1077
1143
|
}
|
|
1144
|
+
/**
|
|
1145
|
+
* 网络总体统计
|
|
1146
|
+
*/
|
|
1147
|
+
export interface NetworkStats {
|
|
1148
|
+
/** 下行码率kb/s */
|
|
1149
|
+
bitrate_down: number;
|
|
1150
|
+
/** 上行码率kb/s */
|
|
1151
|
+
bitrate_up: number;
|
|
1152
|
+
/** 下行丢包率 */
|
|
1153
|
+
lossrate_down: number;
|
|
1154
|
+
/** 上行丢包率 */
|
|
1155
|
+
lossrate_up: number;
|
|
1156
|
+
/** 上行包数 */
|
|
1157
|
+
pkt_up: number;
|
|
1158
|
+
/** 下行包数 */
|
|
1159
|
+
pkt_down: number;
|
|
1160
|
+
/** 上行丢包数 */
|
|
1161
|
+
pkt_loss_up: number;
|
|
1162
|
+
/** 下行丢包数 */
|
|
1163
|
+
pkt_loss_down: number;
|
|
1164
|
+
/** SFU/BWE 估算的可用上行带宽 kb/s,来自 candidate-pair */
|
|
1165
|
+
available_outgoing_bitrate?: number;
|
|
1166
|
+
/** SFU/BWE 估算的可用下行带宽 kb/s,来自 candidate-pair */
|
|
1167
|
+
available_incoming_bitrate?: number;
|
|
1168
|
+
/** candidate-pair 实时链路 RTT ms,比 remote-inbound-rtp 更准确 */
|
|
1169
|
+
current_rtt?: number;
|
|
1170
|
+
}
|
|
1078
1171
|
/** 画中画句柄,用于控制画中画状态 */
|
|
1079
1172
|
export interface PipHandle {
|
|
1080
1173
|
/** 画中画类型:document-pip 支持自定义UI,video-pip 为传统模式 */
|
|
@@ -1129,6 +1222,42 @@ export interface PropChangeItem<T> {
|
|
|
1129
1222
|
/** 更改前的值 */
|
|
1130
1223
|
old: any;
|
|
1131
1224
|
}
|
|
1225
|
+
/**
|
|
1226
|
+
* 质量评估结果快照
|
|
1227
|
+
*/
|
|
1228
|
+
export interface QualityEvaluation {
|
|
1229
|
+
/** 上行质量 */
|
|
1230
|
+
uplink: ConnectionQuality;
|
|
1231
|
+
/** 下行质量 */
|
|
1232
|
+
downlink: ConnectionQuality;
|
|
1233
|
+
/** 总体质量,取上下行中较差的一档 */
|
|
1234
|
+
overall: ConnectionQuality;
|
|
1235
|
+
/** 音频 MOS 估算,范围 1.0 ~ 4.5 */
|
|
1236
|
+
mos: number;
|
|
1237
|
+
/** 触发当前等级的主要原因描述,便于排查 */
|
|
1238
|
+
reasons: string[];
|
|
1239
|
+
/** 采样时间戳 */
|
|
1240
|
+
timestamp: number;
|
|
1241
|
+
}
|
|
1242
|
+
/**
|
|
1243
|
+
* 接收数据统计
|
|
1244
|
+
*/
|
|
1245
|
+
export interface ReceiverStats {
|
|
1246
|
+
/** 抖动缓冲延迟 */
|
|
1247
|
+
jitterBufferDelay?: number;
|
|
1248
|
+
/** 丢包数 */
|
|
1249
|
+
packetsLost?: number;
|
|
1250
|
+
/** 已接收的包数 */
|
|
1251
|
+
packetsReceived?: number;
|
|
1252
|
+
/** 已接收的字节数 */
|
|
1253
|
+
bytesReceived?: number;
|
|
1254
|
+
/** 流ID */
|
|
1255
|
+
streamId?: string;
|
|
1256
|
+
/** 抖动 */
|
|
1257
|
+
jitter?: number;
|
|
1258
|
+
/** 时间戳 */
|
|
1259
|
+
timestamp: number;
|
|
1260
|
+
}
|
|
1132
1261
|
/**
|
|
1133
1262
|
* 屏幕采集音频配置
|
|
1134
1263
|
*/
|
|
@@ -1192,6 +1321,62 @@ export interface SdkInitParams {
|
|
|
1192
1321
|
/** 日志目标 */
|
|
1193
1322
|
logTarget?: LogTarget;
|
|
1194
1323
|
}
|
|
1324
|
+
/**
|
|
1325
|
+
* 发送数据统计
|
|
1326
|
+
*/
|
|
1327
|
+
export interface SenderStats {
|
|
1328
|
+
/** 已发送的包数 */
|
|
1329
|
+
packetsSent?: number;
|
|
1330
|
+
/** 已发送的字节数 */
|
|
1331
|
+
bytesSent?: number;
|
|
1332
|
+
/** 远端感知到的抖动 */
|
|
1333
|
+
jitter?: number;
|
|
1334
|
+
/** 远端报告的丢包数 */
|
|
1335
|
+
packetsLost?: number;
|
|
1336
|
+
/** 远端报告的往返时延(ms) */
|
|
1337
|
+
roundTripTime?: number;
|
|
1338
|
+
/** 出站流ID */
|
|
1339
|
+
streamId?: string;
|
|
1340
|
+
/** 时间戳 */
|
|
1341
|
+
timestamp: number;
|
|
1342
|
+
}
|
|
1343
|
+
/**
|
|
1344
|
+
* 流媒体引擎周期性输出的 metric 快照
|
|
1345
|
+
*/
|
|
1346
|
+
export interface StreamMetric {
|
|
1347
|
+
/** 网络总体统计 */
|
|
1348
|
+
network: NetworkStats;
|
|
1349
|
+
/** 本地发布的音频轨道 */
|
|
1350
|
+
local_audios: TrackMetric[];
|
|
1351
|
+
/** 本地发布的视频轨道 */
|
|
1352
|
+
local_videos: TrackMetric[];
|
|
1353
|
+
/** 订阅的远端音频轨道 */
|
|
1354
|
+
remote_audios: TrackMetric[];
|
|
1355
|
+
/** 订阅的远端视频轨道 */
|
|
1356
|
+
remote_videos: TrackMetric[];
|
|
1357
|
+
}
|
|
1358
|
+
/**
|
|
1359
|
+
* 单条轨道的实时 metric 快照
|
|
1360
|
+
* 由 BaseTrack.getInfo() 展开 + 运行时计算字段
|
|
1361
|
+
*/
|
|
1362
|
+
export interface TrackMetric {
|
|
1363
|
+
/** 实时码率 kb/s */
|
|
1364
|
+
bitrate?: number;
|
|
1365
|
+
/** 音频电平 dBFS */
|
|
1366
|
+
db?: number;
|
|
1367
|
+
/** 视频宽 */
|
|
1368
|
+
width?: number;
|
|
1369
|
+
/** 视频高 */
|
|
1370
|
+
height?: number;
|
|
1371
|
+
/** 实时帧率 */
|
|
1372
|
+
fps?: number;
|
|
1373
|
+
/** 原始 sender/receiver stats */
|
|
1374
|
+
stats?: AudioSenderStats | VideoSenderStats | AudioReceiverStats | VideoReceiverStats;
|
|
1375
|
+
/** 订阅端轨道所属用户 uid */
|
|
1376
|
+
uid?: string;
|
|
1377
|
+
/** 其他由 track.getInfo() 展开的字段 */
|
|
1378
|
+
[key: string]: any;
|
|
1379
|
+
}
|
|
1195
1380
|
/**
|
|
1196
1381
|
* 用户离开事件data
|
|
1197
1382
|
*/
|
|
@@ -1232,8 +1417,82 @@ export interface VideoPublishOptions {
|
|
|
1232
1417
|
degradationPreference?: RTCDegradationPreference;
|
|
1233
1418
|
/** 自定义属性 */
|
|
1234
1419
|
props?: Record<string, any>;
|
|
1420
|
+
/**
|
|
1421
|
+
* 联播轨道的发布参数。
|
|
1422
|
+
* **顺序约定:按画质从高到低排列**,即 simulcasts[0] 是仅次于主层的次高画质,
|
|
1423
|
+
* simulcasts[length-1] 是最低画质。该顺序决定了 fallback_track_ids 候选池的排序,
|
|
1424
|
+
* 也是订阅侧降级时的搜索顺序。底层 chrome encodings 顺序(要求低→高)由各 streamengine 内部反序适配。
|
|
1425
|
+
*/
|
|
1235
1426
|
simulcasts?: VideoPublishOptions[];
|
|
1236
1427
|
}
|
|
1428
|
+
export interface VideoReceiverStats extends ReceiverStats {
|
|
1429
|
+
/** 类型 */
|
|
1430
|
+
type: "video";
|
|
1431
|
+
/** 已解码的帧数 */
|
|
1432
|
+
framesDecoded: number;
|
|
1433
|
+
/** 丢帧数 */
|
|
1434
|
+
framesDropped: number;
|
|
1435
|
+
/** 已接收的帧数 */
|
|
1436
|
+
framesReceived: number;
|
|
1437
|
+
/** 帧率 */
|
|
1438
|
+
framesPerSecond?: number;
|
|
1439
|
+
/** 帧宽度 */
|
|
1440
|
+
frameWidth?: number;
|
|
1441
|
+
/** 帧高度 */
|
|
1442
|
+
frameHeight?: number;
|
|
1443
|
+
/** 发送的FIR(Full Intra Request)请求次数 */
|
|
1444
|
+
firCount?: number;
|
|
1445
|
+
/** 发送的PLI(Picture Loss Indication)请求次数 */
|
|
1446
|
+
pliCount?: number;
|
|
1447
|
+
/** 发送的NACK(Negative Acknowledgement)请求次数 */
|
|
1448
|
+
nackCount?: number;
|
|
1449
|
+
/** 解码器实现 */
|
|
1450
|
+
decoderImplementation?: string;
|
|
1451
|
+
/** MIME类型 */
|
|
1452
|
+
mimeType?: string;
|
|
1453
|
+
/** 视频卡顿次数(单次冻结 > 1s 或 > 3倍平均帧间隔,W3C 定义) */
|
|
1454
|
+
freezeCount?: number;
|
|
1455
|
+
/** 视频卡顿累计时长(s) */
|
|
1456
|
+
totalFreezesDuration?: number;
|
|
1457
|
+
/** 视频暂停次数(远端暂停发送) */
|
|
1458
|
+
pauseCount?: number;
|
|
1459
|
+
/** 视频暂停累计时长(s) */
|
|
1460
|
+
totalPausesDuration?: number;
|
|
1461
|
+
/** 由多 RTP 包拼装的帧数 */
|
|
1462
|
+
framesAssembledFromMultiplePackets?: number;
|
|
1463
|
+
/** 所有帧累计拼装耗时(s) */
|
|
1464
|
+
totalAssemblyTime?: number;
|
|
1465
|
+
}
|
|
1466
|
+
export interface VideoSenderStats extends SenderStats {
|
|
1467
|
+
/** 类型 */
|
|
1468
|
+
type: "video";
|
|
1469
|
+
/** 收到的FIR(Full Intra Request)请求次数 */
|
|
1470
|
+
firCount: number;
|
|
1471
|
+
/** 收到的PLI(Picture Loss Indication)请求次数 */
|
|
1472
|
+
pliCount: number;
|
|
1473
|
+
/** 收到的NACK(Negative Acknowledgement)请求次数 */
|
|
1474
|
+
nackCount: number;
|
|
1475
|
+
/** RTP流ID */
|
|
1476
|
+
rid: string;
|
|
1477
|
+
/** 帧宽度 */
|
|
1478
|
+
frameWidth: number;
|
|
1479
|
+
/** 帧高度 */
|
|
1480
|
+
frameHeight: number;
|
|
1481
|
+
/** 帧率 */
|
|
1482
|
+
framesPerSecond: number;
|
|
1483
|
+
/** 已发送的帧数 */
|
|
1484
|
+
framesSent: number;
|
|
1485
|
+
/** 质量限制原因(bandwidth, cpu, other, none) */
|
|
1486
|
+
qualityLimitationReason?: string;
|
|
1487
|
+
/** 质量限制持续时间 */
|
|
1488
|
+
qualityLimitationDurations?: Record<string, number>;
|
|
1489
|
+
/** 质量限制分辨率变化次数 */
|
|
1490
|
+
qualityLimitationResolutionChanges?: number;
|
|
1491
|
+
/** 重传包数 */
|
|
1492
|
+
retransmittedPacketsSent?: number;
|
|
1493
|
+
/** 目标码率 */
|
|
1494
|
+
targetBitrate: number;
|
|
1495
|
+
}
|
|
1237
1496
|
/**
|
|
1238
1497
|
* 重试执行器函数:直接调用开始执行,.cancel()取消重试,函数失败会返回maxretry或canceled
|
|
1239
1498
|
*/
|
|
@@ -1287,6 +1546,20 @@ interface BaseTrackInfo {
|
|
|
1287
1546
|
channel_count: number;
|
|
1288
1547
|
/** 流扩展属性 */
|
|
1289
1548
|
props?: Record<string, any>;
|
|
1549
|
+
/**
|
|
1550
|
+
* simulcast 降级候选层 id 列表,按画质从高到低排列;仅"自己之下的更低层",不含自己
|
|
1551
|
+
* - 主层:含所有副层 id
|
|
1552
|
+
* - 中间副层:含比自己更低的副层 id
|
|
1553
|
+
* - 最低层:空数组或 undefined
|
|
1554
|
+
* 订阅侧用于拼 SFU 的 prefer_track_ids = [当前层 id, ...fallback_track_ids]
|
|
1555
|
+
*/
|
|
1556
|
+
fallback_ids?: string[];
|
|
1557
|
+
/**
|
|
1558
|
+
* 是否为 simulcast 副层。仅副层为 true,主层不写
|
|
1559
|
+
* 用于 autoSubscribe 跳过副层(避免主+副被独立订阅成多路),
|
|
1560
|
+
* 真正的层切换由订阅主层时通过 fallback_track_ids 候选池统一交给 SFU
|
|
1561
|
+
*/
|
|
1562
|
+
variant?: boolean;
|
|
1290
1563
|
}
|
|
1291
1564
|
/**
|
|
1292
1565
|
* 用户信息
|