@seastart/srtc-web-sdk 0.5.1 → 0.5.3
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 +12 -0
- package/package.json +1 -1
- package/srtc.d.mts +198 -0
- package/srtc.d.ts +198 -0
- package/srtc.js +1 -1
- package/srtc.mjs +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,18 @@
|
|
|
2
2
|
|
|
3
3
|
本文档记录 web SDK 各版本的改动点。遵循 [Keep a Changelog](https://keepachangelog.com/zh-CN/1.1.0/) 风格。
|
|
4
4
|
|
|
5
|
+
## v0.5.3 - 2026-05-08
|
|
6
|
+
|
|
7
|
+
- feat: add local composite recorder (47a20b0)
|
|
8
|
+
- chore: 共享屏幕默认配置优化 (f079eeb)
|
|
9
|
+
|
|
10
|
+
## v0.5.2 - 2026-05-08
|
|
11
|
+
|
|
12
|
+
- fix: 恢复音频trackinfo编码参数 (0f694e5)
|
|
13
|
+
- feat: seastart客户端质量上报sfu (6b75025)
|
|
14
|
+
- fix: 修复seastart本地metric chore: 优化demo im (e5aeb3b)
|
|
15
|
+
- feat: 服务端质量增加码率 (a0b327f)
|
|
16
|
+
|
|
5
17
|
## v0.5.1 - 2026-04-27
|
|
6
18
|
|
|
7
19
|
- fix: 视频卡顿 (b7a36c2)
|
package/package.json
CHANGED
package/srtc.d.mts
CHANGED
|
@@ -1130,6 +1130,144 @@ export declare class LocalCameraTrack extends LocalVideoTrack {
|
|
|
1130
1130
|
*/
|
|
1131
1131
|
switchFacingMode(): Promise<void>;
|
|
1132
1132
|
}
|
|
1133
|
+
/**
|
|
1134
|
+
* 本地合成录制器。
|
|
1135
|
+
*
|
|
1136
|
+
* 只处理媒体合成与 MediaRecorder 生命周期,不关心会议分页、布局模式、用户名来源等业务语义。
|
|
1137
|
+
* 调用方需要把当前要录制的视频 track、音频 track 以及每个视频在画布上的位置传进来。
|
|
1138
|
+
*/
|
|
1139
|
+
export declare class LocalCompositeRecorder {
|
|
1140
|
+
private canvas?;
|
|
1141
|
+
private canvasContext?;
|
|
1142
|
+
private canvasStream?;
|
|
1143
|
+
private recordStream?;
|
|
1144
|
+
private mediaRecorder?;
|
|
1145
|
+
private audioContext?;
|
|
1146
|
+
private audioDestination?;
|
|
1147
|
+
private audioSources;
|
|
1148
|
+
private audioInputTracks;
|
|
1149
|
+
private trackedTrackListeners;
|
|
1150
|
+
private videoElements;
|
|
1151
|
+
private chunks;
|
|
1152
|
+
private videoItems;
|
|
1153
|
+
private width;
|
|
1154
|
+
private height;
|
|
1155
|
+
private fps;
|
|
1156
|
+
private background;
|
|
1157
|
+
private labelBackground;
|
|
1158
|
+
private animationFrameId;
|
|
1159
|
+
private onDataAvailable?;
|
|
1160
|
+
/**
|
|
1161
|
+
* 获取当前录制状态。
|
|
1162
|
+
*
|
|
1163
|
+
* inactive 表示未开始或已结束;recording 表示正在写入文件;paused 表示暂停写入但仍保留同一次录制会话。
|
|
1164
|
+
*/
|
|
1165
|
+
getState(): LocalCompositeRecorderState;
|
|
1166
|
+
/**
|
|
1167
|
+
* 开始本地合成录制。
|
|
1168
|
+
*
|
|
1169
|
+
* 会创建内部 canvas、AudioContext、MediaRecorder,并立即开始渲染和写入。
|
|
1170
|
+
* 如果当前不是 inactive 状态,本方法会直接返回,不会重复开启录制。
|
|
1171
|
+
*/
|
|
1172
|
+
start(options: LocalCompositeRecorderStartOptions): Promise<void>;
|
|
1173
|
+
/**
|
|
1174
|
+
* 更新视频绘制列表。
|
|
1175
|
+
*
|
|
1176
|
+
* 用于会议翻页、布局变化、主讲人切换等场景。更新后下一帧会按新的 rect/track/label 绘制。
|
|
1177
|
+
*/
|
|
1178
|
+
updateVideoItems(items: LocalCompositeRecorderVideoItem[]): void;
|
|
1179
|
+
/**
|
|
1180
|
+
* 更新参与混音的音频轨道。
|
|
1181
|
+
*
|
|
1182
|
+
* 适用于本地麦克风切换、远端混音流重订阅等场景。不会替换 MediaRecorder 持有的输出音频轨。
|
|
1183
|
+
*/
|
|
1184
|
+
updateAudioTracks(tracks: LocalCompositeRecorderTrack[]): Promise<void>;
|
|
1185
|
+
/**
|
|
1186
|
+
* 暂停录制写入。
|
|
1187
|
+
*
|
|
1188
|
+
* 暂停期间不会向最终文件写入黑屏或静音片段;只有 recording 状态下调用才生效。
|
|
1189
|
+
*/
|
|
1190
|
+
pause(): void;
|
|
1191
|
+
/**
|
|
1192
|
+
* 恢复录制写入。
|
|
1193
|
+
*
|
|
1194
|
+
* 恢复后继续写入同一个输出文件;只有 paused 状态下调用才生效。
|
|
1195
|
+
*/
|
|
1196
|
+
resume(): void;
|
|
1197
|
+
/**
|
|
1198
|
+
* 停止录制并返回最终 Blob。
|
|
1199
|
+
*
|
|
1200
|
+
* 会释放录制器内部创建的 canvas stream、AudioContext 和隐藏 video;
|
|
1201
|
+
* 不会停止调用方传入的原始音视频 track。
|
|
1202
|
+
*/
|
|
1203
|
+
stop(): Promise<Blob>;
|
|
1204
|
+
/**
|
|
1205
|
+
* 强制销毁录制器内部资源。
|
|
1206
|
+
*
|
|
1207
|
+
* 适用于页面卸载或调用方不再需要输出 Blob 的异常清理场景。
|
|
1208
|
+
*/
|
|
1209
|
+
destroy(): void;
|
|
1210
|
+
/**
|
|
1211
|
+
* 初始化混音管线。
|
|
1212
|
+
*
|
|
1213
|
+
* 通过 MediaStreamAudioDestinationNode 生成一条稳定的输出音频轨,供 MediaRecorder 持有。
|
|
1214
|
+
*/
|
|
1215
|
+
private initAudio;
|
|
1216
|
+
/**
|
|
1217
|
+
* 重新连接输入音频轨道。
|
|
1218
|
+
*
|
|
1219
|
+
* 只替换 Web Audio 的 source 节点,不替换 destination 输出轨,保证录制过程不中断。
|
|
1220
|
+
*/
|
|
1221
|
+
private setAudioTracks;
|
|
1222
|
+
/**
|
|
1223
|
+
* 断开并清空所有输入音频 source。
|
|
1224
|
+
*/
|
|
1225
|
+
private clearAudioSources;
|
|
1226
|
+
/**
|
|
1227
|
+
* 从原生 MediaStreamTrack 或 SDK Track 中取出当前实际媒体轨。
|
|
1228
|
+
*/
|
|
1229
|
+
private resolveMediaStreamTrack;
|
|
1230
|
+
/**
|
|
1231
|
+
* 判断是否为可监听 MSTRACK_REPLACED 的 SDK Track。
|
|
1232
|
+
*/
|
|
1233
|
+
private isTrackLike;
|
|
1234
|
+
/**
|
|
1235
|
+
* 同步 SDK Track 的替换监听。
|
|
1236
|
+
*
|
|
1237
|
+
* 调用方传 SDK Track 时,录制器会监听 MSTRACK_REPLACED,自动把隐藏 video 或混音 source 切到新轨。
|
|
1238
|
+
*/
|
|
1239
|
+
private syncTrackedTrackListeners;
|
|
1240
|
+
/**
|
|
1241
|
+
* 解绑所有 SDK Track 替换监听。
|
|
1242
|
+
*/
|
|
1243
|
+
private clearTrackedTrackListeners;
|
|
1244
|
+
/**
|
|
1245
|
+
* 同步视频解码元素。
|
|
1246
|
+
*
|
|
1247
|
+
* 每个视频 track 都需要一个隐藏 HTMLVideoElement 作为 canvas.drawImage 的帧来源。
|
|
1248
|
+
*/
|
|
1249
|
+
private syncVideoElements;
|
|
1250
|
+
/**
|
|
1251
|
+
* 渲染循环。
|
|
1252
|
+
*
|
|
1253
|
+
* 每帧按最新 videoItems 重绘整张画布,canvas.captureStream 会把这些帧输出给 MediaRecorder。
|
|
1254
|
+
*/
|
|
1255
|
+
private render;
|
|
1256
|
+
/**
|
|
1257
|
+
* 绘制单个视频槽位。
|
|
1258
|
+
*
|
|
1259
|
+
* contain 会完整显示视频,cover 会填满槽位并裁剪溢出区域。
|
|
1260
|
+
*/
|
|
1261
|
+
private drawVideo;
|
|
1262
|
+
/**
|
|
1263
|
+
* 绘制视频标签。
|
|
1264
|
+
*/
|
|
1265
|
+
private drawLabel;
|
|
1266
|
+
/**
|
|
1267
|
+
* 释放内部资源并重置状态。
|
|
1268
|
+
*/
|
|
1269
|
+
private cleanup;
|
|
1270
|
+
}
|
|
1133
1271
|
/**
|
|
1134
1272
|
* 本地麦克风流轨道
|
|
1135
1273
|
*/
|
|
@@ -1370,6 +1508,13 @@ export declare class SRTC extends BaseSRTC {
|
|
|
1370
1508
|
* @returns
|
|
1371
1509
|
*/
|
|
1372
1510
|
getEnvInfo(): EnvWebInfo;
|
|
1511
|
+
/**
|
|
1512
|
+
* 创建本地合成录制器。
|
|
1513
|
+
*
|
|
1514
|
+
* 该录制器只负责把调用方传入的视频轨道、音频轨道合成为本地文件;
|
|
1515
|
+
* 宫格分页、主讲人切换、共享屏幕优先级等业务视角需要由上层计算后通过 updateVideoItems 传入。
|
|
1516
|
+
*/
|
|
1517
|
+
createLocalCompositeRecorder(): LocalCompositeRecorder;
|
|
1373
1518
|
constructor(initParams: SdkInitParams);
|
|
1374
1519
|
/**
|
|
1375
1520
|
* 获取设备列表
|
|
@@ -2446,6 +2591,55 @@ export interface JoinOptions {
|
|
|
2446
2591
|
*/
|
|
2447
2592
|
adaptiveStream?: boolean | AdaptiveStreamOptions;
|
|
2448
2593
|
}
|
|
2594
|
+
/** 视频项在录制画布上的绘制区域,单位为 canvas 像素 */
|
|
2595
|
+
export interface LocalCompositeRecorderRect {
|
|
2596
|
+
/** 距离画布左侧的坐标 */
|
|
2597
|
+
x: number;
|
|
2598
|
+
/** 距离画布顶部的坐标 */
|
|
2599
|
+
y: number;
|
|
2600
|
+
/** 绘制区域宽度 */
|
|
2601
|
+
width: number;
|
|
2602
|
+
/** 绘制区域高度 */
|
|
2603
|
+
height: number;
|
|
2604
|
+
}
|
|
2605
|
+
/** 本地合成录制启动参数 */
|
|
2606
|
+
export interface LocalCompositeRecorderStartOptions {
|
|
2607
|
+
/** 初始视频绘制列表;后续可通过 updateVideoItems 跟随业务视角更新 */
|
|
2608
|
+
videoItems: LocalCompositeRecorderVideoItem[];
|
|
2609
|
+
/** 需要混入录制文件的音频轨道;支持原生 MediaStreamTrack 或 SDK 音视频 Track */
|
|
2610
|
+
audioTracks?: LocalCompositeRecorderTrack[];
|
|
2611
|
+
/** 输出视频宽度,单位为像素;默认 1280 */
|
|
2612
|
+
width?: number;
|
|
2613
|
+
/** 输出视频高度,单位为像素;默认 720 */
|
|
2614
|
+
height?: number;
|
|
2615
|
+
/** canvas.captureStream 的帧率;默认 15 */
|
|
2616
|
+
fps?: number;
|
|
2617
|
+
/** MediaRecorder mimeType,未传或不支持时自动选择浏览器支持的 webm 格式 */
|
|
2618
|
+
mimeType?: string;
|
|
2619
|
+
/** MediaRecorder.start(timeslice) 的分片间隔,单位毫秒;不传则浏览器在 stop 时一次性返回 */
|
|
2620
|
+
timeslice?: number;
|
|
2621
|
+
/** 录制画布整体背景色;默认 #101216 */
|
|
2622
|
+
background?: string;
|
|
2623
|
+
/** 标签背景色;默认 rgba(0, 0, 0, 0.58) */
|
|
2624
|
+
labelBackground?: string;
|
|
2625
|
+
/** 每次 MediaRecorder 输出有效分片时触发,可用于边录边上传或保存分片 */
|
|
2626
|
+
onDataAvailable?: (blob: Blob) => void;
|
|
2627
|
+
}
|
|
2628
|
+
/** 单个视频轨道在本地合成录制中的绘制配置 */
|
|
2629
|
+
export interface LocalCompositeRecorderVideoItem {
|
|
2630
|
+
/** 调用方维护的稳定唯一标识;同一个 id 的 track 变更时会复用槽位并替换解码源 */
|
|
2631
|
+
id: string;
|
|
2632
|
+
/** 要绘制的视频轨道;支持原生 MediaStreamTrack 或 SDK 音视频 Track */
|
|
2633
|
+
track?: LocalCompositeRecorderTrack | null;
|
|
2634
|
+
/** 该视频在录制画布上的绘制区域 */
|
|
2635
|
+
rect: LocalCompositeRecorderRect;
|
|
2636
|
+
/** 绘制在视频左下角的标签文本,例如用户名;不传则不绘制标签 */
|
|
2637
|
+
label?: string;
|
|
2638
|
+
/** 视频填充方式:contain 保留完整画面,cover 填满区域并裁剪溢出部分;默认 contain */
|
|
2639
|
+
fit?: "contain" | "cover";
|
|
2640
|
+
/** 单个视频槽位背景色;默认 #1a1c22 */
|
|
2641
|
+
background?: string;
|
|
2642
|
+
}
|
|
2449
2643
|
/**
|
|
2450
2644
|
* 麦克风采集配置
|
|
2451
2645
|
*/
|
|
@@ -3009,6 +3203,10 @@ export type ImEvent = {
|
|
|
3009
3203
|
readonly data: ImEventDataMap[K];
|
|
3010
3204
|
};
|
|
3011
3205
|
}[keyof ImEventDataMap];
|
|
3206
|
+
/** 本地合成录制器状态 */
|
|
3207
|
+
export type LocalCompositeRecorderState = "inactive" | "recording" | "paused";
|
|
3208
|
+
/** 本地合成录制器可接受的输入轨道 */
|
|
3209
|
+
export type LocalCompositeRecorderTrack = MediaStreamTrack | LocalVideoTrack | RemoteVideoTrack | LocalAudioTrack | RemoteAudioTrack;
|
|
3012
3210
|
/**
|
|
3013
3211
|
* 重试执行器函数:直接调用开始执行,.cancel()取消重试,函数失败会返回maxretry或canceled
|
|
3014
3212
|
*/
|
package/srtc.d.ts
CHANGED
|
@@ -1130,6 +1130,144 @@ export declare class LocalCameraTrack extends LocalVideoTrack {
|
|
|
1130
1130
|
*/
|
|
1131
1131
|
switchFacingMode(): Promise<void>;
|
|
1132
1132
|
}
|
|
1133
|
+
/**
|
|
1134
|
+
* 本地合成录制器。
|
|
1135
|
+
*
|
|
1136
|
+
* 只处理媒体合成与 MediaRecorder 生命周期,不关心会议分页、布局模式、用户名来源等业务语义。
|
|
1137
|
+
* 调用方需要把当前要录制的视频 track、音频 track 以及每个视频在画布上的位置传进来。
|
|
1138
|
+
*/
|
|
1139
|
+
export declare class LocalCompositeRecorder {
|
|
1140
|
+
private canvas?;
|
|
1141
|
+
private canvasContext?;
|
|
1142
|
+
private canvasStream?;
|
|
1143
|
+
private recordStream?;
|
|
1144
|
+
private mediaRecorder?;
|
|
1145
|
+
private audioContext?;
|
|
1146
|
+
private audioDestination?;
|
|
1147
|
+
private audioSources;
|
|
1148
|
+
private audioInputTracks;
|
|
1149
|
+
private trackedTrackListeners;
|
|
1150
|
+
private videoElements;
|
|
1151
|
+
private chunks;
|
|
1152
|
+
private videoItems;
|
|
1153
|
+
private width;
|
|
1154
|
+
private height;
|
|
1155
|
+
private fps;
|
|
1156
|
+
private background;
|
|
1157
|
+
private labelBackground;
|
|
1158
|
+
private animationFrameId;
|
|
1159
|
+
private onDataAvailable?;
|
|
1160
|
+
/**
|
|
1161
|
+
* 获取当前录制状态。
|
|
1162
|
+
*
|
|
1163
|
+
* inactive 表示未开始或已结束;recording 表示正在写入文件;paused 表示暂停写入但仍保留同一次录制会话。
|
|
1164
|
+
*/
|
|
1165
|
+
getState(): LocalCompositeRecorderState;
|
|
1166
|
+
/**
|
|
1167
|
+
* 开始本地合成录制。
|
|
1168
|
+
*
|
|
1169
|
+
* 会创建内部 canvas、AudioContext、MediaRecorder,并立即开始渲染和写入。
|
|
1170
|
+
* 如果当前不是 inactive 状态,本方法会直接返回,不会重复开启录制。
|
|
1171
|
+
*/
|
|
1172
|
+
start(options: LocalCompositeRecorderStartOptions): Promise<void>;
|
|
1173
|
+
/**
|
|
1174
|
+
* 更新视频绘制列表。
|
|
1175
|
+
*
|
|
1176
|
+
* 用于会议翻页、布局变化、主讲人切换等场景。更新后下一帧会按新的 rect/track/label 绘制。
|
|
1177
|
+
*/
|
|
1178
|
+
updateVideoItems(items: LocalCompositeRecorderVideoItem[]): void;
|
|
1179
|
+
/**
|
|
1180
|
+
* 更新参与混音的音频轨道。
|
|
1181
|
+
*
|
|
1182
|
+
* 适用于本地麦克风切换、远端混音流重订阅等场景。不会替换 MediaRecorder 持有的输出音频轨。
|
|
1183
|
+
*/
|
|
1184
|
+
updateAudioTracks(tracks: LocalCompositeRecorderTrack[]): Promise<void>;
|
|
1185
|
+
/**
|
|
1186
|
+
* 暂停录制写入。
|
|
1187
|
+
*
|
|
1188
|
+
* 暂停期间不会向最终文件写入黑屏或静音片段;只有 recording 状态下调用才生效。
|
|
1189
|
+
*/
|
|
1190
|
+
pause(): void;
|
|
1191
|
+
/**
|
|
1192
|
+
* 恢复录制写入。
|
|
1193
|
+
*
|
|
1194
|
+
* 恢复后继续写入同一个输出文件;只有 paused 状态下调用才生效。
|
|
1195
|
+
*/
|
|
1196
|
+
resume(): void;
|
|
1197
|
+
/**
|
|
1198
|
+
* 停止录制并返回最终 Blob。
|
|
1199
|
+
*
|
|
1200
|
+
* 会释放录制器内部创建的 canvas stream、AudioContext 和隐藏 video;
|
|
1201
|
+
* 不会停止调用方传入的原始音视频 track。
|
|
1202
|
+
*/
|
|
1203
|
+
stop(): Promise<Blob>;
|
|
1204
|
+
/**
|
|
1205
|
+
* 强制销毁录制器内部资源。
|
|
1206
|
+
*
|
|
1207
|
+
* 适用于页面卸载或调用方不再需要输出 Blob 的异常清理场景。
|
|
1208
|
+
*/
|
|
1209
|
+
destroy(): void;
|
|
1210
|
+
/**
|
|
1211
|
+
* 初始化混音管线。
|
|
1212
|
+
*
|
|
1213
|
+
* 通过 MediaStreamAudioDestinationNode 生成一条稳定的输出音频轨,供 MediaRecorder 持有。
|
|
1214
|
+
*/
|
|
1215
|
+
private initAudio;
|
|
1216
|
+
/**
|
|
1217
|
+
* 重新连接输入音频轨道。
|
|
1218
|
+
*
|
|
1219
|
+
* 只替换 Web Audio 的 source 节点,不替换 destination 输出轨,保证录制过程不中断。
|
|
1220
|
+
*/
|
|
1221
|
+
private setAudioTracks;
|
|
1222
|
+
/**
|
|
1223
|
+
* 断开并清空所有输入音频 source。
|
|
1224
|
+
*/
|
|
1225
|
+
private clearAudioSources;
|
|
1226
|
+
/**
|
|
1227
|
+
* 从原生 MediaStreamTrack 或 SDK Track 中取出当前实际媒体轨。
|
|
1228
|
+
*/
|
|
1229
|
+
private resolveMediaStreamTrack;
|
|
1230
|
+
/**
|
|
1231
|
+
* 判断是否为可监听 MSTRACK_REPLACED 的 SDK Track。
|
|
1232
|
+
*/
|
|
1233
|
+
private isTrackLike;
|
|
1234
|
+
/**
|
|
1235
|
+
* 同步 SDK Track 的替换监听。
|
|
1236
|
+
*
|
|
1237
|
+
* 调用方传 SDK Track 时,录制器会监听 MSTRACK_REPLACED,自动把隐藏 video 或混音 source 切到新轨。
|
|
1238
|
+
*/
|
|
1239
|
+
private syncTrackedTrackListeners;
|
|
1240
|
+
/**
|
|
1241
|
+
* 解绑所有 SDK Track 替换监听。
|
|
1242
|
+
*/
|
|
1243
|
+
private clearTrackedTrackListeners;
|
|
1244
|
+
/**
|
|
1245
|
+
* 同步视频解码元素。
|
|
1246
|
+
*
|
|
1247
|
+
* 每个视频 track 都需要一个隐藏 HTMLVideoElement 作为 canvas.drawImage 的帧来源。
|
|
1248
|
+
*/
|
|
1249
|
+
private syncVideoElements;
|
|
1250
|
+
/**
|
|
1251
|
+
* 渲染循环。
|
|
1252
|
+
*
|
|
1253
|
+
* 每帧按最新 videoItems 重绘整张画布,canvas.captureStream 会把这些帧输出给 MediaRecorder。
|
|
1254
|
+
*/
|
|
1255
|
+
private render;
|
|
1256
|
+
/**
|
|
1257
|
+
* 绘制单个视频槽位。
|
|
1258
|
+
*
|
|
1259
|
+
* contain 会完整显示视频,cover 会填满槽位并裁剪溢出区域。
|
|
1260
|
+
*/
|
|
1261
|
+
private drawVideo;
|
|
1262
|
+
/**
|
|
1263
|
+
* 绘制视频标签。
|
|
1264
|
+
*/
|
|
1265
|
+
private drawLabel;
|
|
1266
|
+
/**
|
|
1267
|
+
* 释放内部资源并重置状态。
|
|
1268
|
+
*/
|
|
1269
|
+
private cleanup;
|
|
1270
|
+
}
|
|
1133
1271
|
/**
|
|
1134
1272
|
* 本地麦克风流轨道
|
|
1135
1273
|
*/
|
|
@@ -1370,6 +1508,13 @@ export declare class SRTC extends BaseSRTC {
|
|
|
1370
1508
|
* @returns
|
|
1371
1509
|
*/
|
|
1372
1510
|
getEnvInfo(): EnvWebInfo;
|
|
1511
|
+
/**
|
|
1512
|
+
* 创建本地合成录制器。
|
|
1513
|
+
*
|
|
1514
|
+
* 该录制器只负责把调用方传入的视频轨道、音频轨道合成为本地文件;
|
|
1515
|
+
* 宫格分页、主讲人切换、共享屏幕优先级等业务视角需要由上层计算后通过 updateVideoItems 传入。
|
|
1516
|
+
*/
|
|
1517
|
+
createLocalCompositeRecorder(): LocalCompositeRecorder;
|
|
1373
1518
|
constructor(initParams: SdkInitParams);
|
|
1374
1519
|
/**
|
|
1375
1520
|
* 获取设备列表
|
|
@@ -2446,6 +2591,55 @@ export interface JoinOptions {
|
|
|
2446
2591
|
*/
|
|
2447
2592
|
adaptiveStream?: boolean | AdaptiveStreamOptions;
|
|
2448
2593
|
}
|
|
2594
|
+
/** 视频项在录制画布上的绘制区域,单位为 canvas 像素 */
|
|
2595
|
+
export interface LocalCompositeRecorderRect {
|
|
2596
|
+
/** 距离画布左侧的坐标 */
|
|
2597
|
+
x: number;
|
|
2598
|
+
/** 距离画布顶部的坐标 */
|
|
2599
|
+
y: number;
|
|
2600
|
+
/** 绘制区域宽度 */
|
|
2601
|
+
width: number;
|
|
2602
|
+
/** 绘制区域高度 */
|
|
2603
|
+
height: number;
|
|
2604
|
+
}
|
|
2605
|
+
/** 本地合成录制启动参数 */
|
|
2606
|
+
export interface LocalCompositeRecorderStartOptions {
|
|
2607
|
+
/** 初始视频绘制列表;后续可通过 updateVideoItems 跟随业务视角更新 */
|
|
2608
|
+
videoItems: LocalCompositeRecorderVideoItem[];
|
|
2609
|
+
/** 需要混入录制文件的音频轨道;支持原生 MediaStreamTrack 或 SDK 音视频 Track */
|
|
2610
|
+
audioTracks?: LocalCompositeRecorderTrack[];
|
|
2611
|
+
/** 输出视频宽度,单位为像素;默认 1280 */
|
|
2612
|
+
width?: number;
|
|
2613
|
+
/** 输出视频高度,单位为像素;默认 720 */
|
|
2614
|
+
height?: number;
|
|
2615
|
+
/** canvas.captureStream 的帧率;默认 15 */
|
|
2616
|
+
fps?: number;
|
|
2617
|
+
/** MediaRecorder mimeType,未传或不支持时自动选择浏览器支持的 webm 格式 */
|
|
2618
|
+
mimeType?: string;
|
|
2619
|
+
/** MediaRecorder.start(timeslice) 的分片间隔,单位毫秒;不传则浏览器在 stop 时一次性返回 */
|
|
2620
|
+
timeslice?: number;
|
|
2621
|
+
/** 录制画布整体背景色;默认 #101216 */
|
|
2622
|
+
background?: string;
|
|
2623
|
+
/** 标签背景色;默认 rgba(0, 0, 0, 0.58) */
|
|
2624
|
+
labelBackground?: string;
|
|
2625
|
+
/** 每次 MediaRecorder 输出有效分片时触发,可用于边录边上传或保存分片 */
|
|
2626
|
+
onDataAvailable?: (blob: Blob) => void;
|
|
2627
|
+
}
|
|
2628
|
+
/** 单个视频轨道在本地合成录制中的绘制配置 */
|
|
2629
|
+
export interface LocalCompositeRecorderVideoItem {
|
|
2630
|
+
/** 调用方维护的稳定唯一标识;同一个 id 的 track 变更时会复用槽位并替换解码源 */
|
|
2631
|
+
id: string;
|
|
2632
|
+
/** 要绘制的视频轨道;支持原生 MediaStreamTrack 或 SDK 音视频 Track */
|
|
2633
|
+
track?: LocalCompositeRecorderTrack | null;
|
|
2634
|
+
/** 该视频在录制画布上的绘制区域 */
|
|
2635
|
+
rect: LocalCompositeRecorderRect;
|
|
2636
|
+
/** 绘制在视频左下角的标签文本,例如用户名;不传则不绘制标签 */
|
|
2637
|
+
label?: string;
|
|
2638
|
+
/** 视频填充方式:contain 保留完整画面,cover 填满区域并裁剪溢出部分;默认 contain */
|
|
2639
|
+
fit?: "contain" | "cover";
|
|
2640
|
+
/** 单个视频槽位背景色;默认 #1a1c22 */
|
|
2641
|
+
background?: string;
|
|
2642
|
+
}
|
|
2449
2643
|
/**
|
|
2450
2644
|
* 麦克风采集配置
|
|
2451
2645
|
*/
|
|
@@ -3009,6 +3203,10 @@ export type ImEvent = {
|
|
|
3009
3203
|
readonly data: ImEventDataMap[K];
|
|
3010
3204
|
};
|
|
3011
3205
|
}[keyof ImEventDataMap];
|
|
3206
|
+
/** 本地合成录制器状态 */
|
|
3207
|
+
export type LocalCompositeRecorderState = "inactive" | "recording" | "paused";
|
|
3208
|
+
/** 本地合成录制器可接受的输入轨道 */
|
|
3209
|
+
export type LocalCompositeRecorderTrack = MediaStreamTrack | LocalVideoTrack | RemoteVideoTrack | LocalAudioTrack | RemoteAudioTrack;
|
|
3012
3210
|
/**
|
|
3013
3211
|
* 重试执行器函数:直接调用开始执行,.cancel()取消重试,函数失败会返回maxretry或canceled
|
|
3014
3212
|
*/
|