@seastart/srtc-web-sdk 0.3.1 → 0.3.6
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/package.json +1 -1
- package/srtc.d.mts +146 -23
- package/srtc.d.ts +146 -23
- package/srtc.js +1 -1
- package/srtc.mjs +1 -1
package/package.json
CHANGED
package/srtc.d.mts
CHANGED
|
@@ -27,8 +27,9 @@ declare abstract class BaseSRTC {
|
|
|
27
27
|
/**
|
|
28
28
|
* 加入频道
|
|
29
29
|
* @param token 加入频道token
|
|
30
|
+
* @param options 加入频道选项
|
|
30
31
|
*/
|
|
31
|
-
join(token: string): Promise<BaseChannelInfo>;
|
|
32
|
+
join(token: string, options?: JoinOptions): Promise<BaseChannelInfo>;
|
|
32
33
|
/**
|
|
33
34
|
* 离开频道
|
|
34
35
|
*/
|
|
@@ -38,6 +39,11 @@ declare abstract class BaseSRTC {
|
|
|
38
39
|
* @returns
|
|
39
40
|
*/
|
|
40
41
|
getChannelInfo(): BaseChannelInfo | null;
|
|
42
|
+
/**
|
|
43
|
+
* 获取流媒体引擎的metric快照
|
|
44
|
+
* @returns
|
|
45
|
+
*/
|
|
46
|
+
getStreamMetric(): Record<string, any> | undefined;
|
|
41
47
|
/**
|
|
42
48
|
* 获取某用户信息
|
|
43
49
|
* @returns
|
|
@@ -50,10 +56,10 @@ declare abstract class BaseSRTC {
|
|
|
50
56
|
getUsersInfo(map: true): Record<string, BaseUserInfo>;
|
|
51
57
|
getUsersInfo(map: false): BaseUserInfo[];
|
|
52
58
|
/**
|
|
53
|
-
*
|
|
54
|
-
* @param
|
|
59
|
+
* 订阅频道混音流
|
|
60
|
+
* @param filter 音频轨道过滤器,传递string[]时,根据uid过滤
|
|
55
61
|
*/
|
|
56
|
-
subscribeRemoteAudioMixTrack(
|
|
62
|
+
subscribeRemoteAudioMixTrack(filter?: ((track: BaseTrack) => boolean) | string[]): Promise<BaseTrack>;
|
|
57
63
|
/**
|
|
58
64
|
* 订阅远端用户音频流
|
|
59
65
|
* @param uid 用户id
|
|
@@ -122,6 +128,7 @@ declare abstract class BaseWebrtcTrack extends BaseTrack {
|
|
|
122
128
|
constructor(info: BaseTrackInfo, uid: string);
|
|
123
129
|
setMediaStreamTrack(mediaStreamTrack?: MediaStreamTrack): void;
|
|
124
130
|
getMediaStreamTrack(): MediaStreamTrack | undefined;
|
|
131
|
+
getMediaStream(): MediaStream;
|
|
125
132
|
}
|
|
126
133
|
declare class CommonChannelEventType {
|
|
127
134
|
/** 频道自定义props更新,对应data为ChannelInfo */
|
|
@@ -202,18 +209,6 @@ declare class SdkError {
|
|
|
202
209
|
msg: string;
|
|
203
210
|
};
|
|
204
211
|
}
|
|
205
|
-
declare enum Codec {
|
|
206
|
-
/** 未知编码类型 */
|
|
207
|
-
Unknown = 0,
|
|
208
|
-
/** h264编码 */
|
|
209
|
-
H264 = 27,
|
|
210
|
-
/** h265编码 */
|
|
211
|
-
H265 = 36,
|
|
212
|
-
/** AAC编码 */
|
|
213
|
-
AAC = 15,
|
|
214
|
-
/** OPUS编码 */
|
|
215
|
-
OPUS = 1398100047
|
|
216
|
-
}
|
|
217
212
|
declare function dateFormat(format: string, date?: Date): string;
|
|
218
213
|
declare function dct(t: string): any;
|
|
219
214
|
declare function genNonce(len?: number): string;
|
|
@@ -283,7 +278,7 @@ export declare class LocalCameraTrack extends LocalVideoTrack {
|
|
|
283
278
|
* 开始采集
|
|
284
279
|
* @param opt 采集参数
|
|
285
280
|
*/
|
|
286
|
-
startCapture(opt?: CameraCaptureOptions): Promise<void>;
|
|
281
|
+
startCapture(opt?: Partial<CameraCaptureOptions>): Promise<void>;
|
|
287
282
|
/**
|
|
288
283
|
* 停止采集
|
|
289
284
|
*/
|
|
@@ -309,7 +304,7 @@ export declare class LocalMicTrack extends LocalAudioTrack {
|
|
|
309
304
|
* 开始采集
|
|
310
305
|
* @param opt 采集参数
|
|
311
306
|
*/
|
|
312
|
-
startCapture(opt?: MicCaptureOptions): Promise<void>;
|
|
307
|
+
startCapture(opt?: Partial<MicCaptureOptions>): Promise<void>;
|
|
313
308
|
/**
|
|
314
309
|
* 停止采集
|
|
315
310
|
*/
|
|
@@ -321,16 +316,30 @@ export declare class LocalMicTrack extends LocalAudioTrack {
|
|
|
321
316
|
*/
|
|
322
317
|
changeDeviceId(deviceId: string): Promise<void>;
|
|
323
318
|
}
|
|
319
|
+
/**
|
|
320
|
+
* 屏幕共享音频流轨道
|
|
321
|
+
*/
|
|
322
|
+
export declare class LocalScreenAudioTrack extends LocalAudioTrack {
|
|
323
|
+
constructor(captureOptions: ScreenAudioCaptureOptions | true);
|
|
324
|
+
/**
|
|
325
|
+
* 停止采集
|
|
326
|
+
*/
|
|
327
|
+
stopCapture(): void;
|
|
328
|
+
}
|
|
324
329
|
/**
|
|
325
330
|
* 本地屏幕视频流轨道
|
|
326
331
|
*/
|
|
327
332
|
export declare class LocalScreenTrack extends LocalVideoTrack {
|
|
328
333
|
constructor(captureOptions: ScreenCaptureOptions);
|
|
334
|
+
/**
|
|
335
|
+
* 获取音频轨道
|
|
336
|
+
*/
|
|
337
|
+
getAudioTrack(): LocalScreenAudioTrack | undefined;
|
|
329
338
|
/**
|
|
330
339
|
* 开始采集
|
|
331
340
|
* @param opt 采集参数
|
|
332
341
|
*/
|
|
333
|
-
startCapture(opt?: ScreenCaptureOptions): Promise<void>;
|
|
342
|
+
startCapture(opt?: Partial<ScreenCaptureOptions>): Promise<void>;
|
|
334
343
|
/**
|
|
335
344
|
* 停止采集
|
|
336
345
|
*/
|
|
@@ -369,7 +378,7 @@ export declare class LocalVideoTrack extends BaseWebrtcTrack {
|
|
|
369
378
|
/**
|
|
370
379
|
* 远端混音流
|
|
371
380
|
*/
|
|
372
|
-
export declare class RemoteAudioMixTrack extends RemoteAudioTrack {
|
|
381
|
+
export declare class RemoteAudioMixTrack extends RemoteAudioTrack implements IRemoteAudioMixTrack {
|
|
373
382
|
constructor(info: BaseTrackInfo, filterUids?: string[]);
|
|
374
383
|
/**
|
|
375
384
|
* 混音流中过滤的uid
|
|
@@ -382,6 +391,10 @@ export declare class RemoteAudioMixTrack extends RemoteAudioTrack {
|
|
|
382
391
|
*/
|
|
383
392
|
export declare class RemoteAudioTrack extends BaseWebrtcTrack {
|
|
384
393
|
constructor(info: BaseTrackInfo, uid: string);
|
|
394
|
+
/**
|
|
395
|
+
* 是否正在播放
|
|
396
|
+
*/
|
|
397
|
+
isPlaying(): boolean;
|
|
385
398
|
/**
|
|
386
399
|
* 播放音频(可指定播放设备)
|
|
387
400
|
*/
|
|
@@ -445,18 +458,28 @@ export declare class SRTC extends BaseSRTC {
|
|
|
445
458
|
/**
|
|
446
459
|
* 创建屏幕共享本地视频流
|
|
447
460
|
* @param preset 屏幕共享预设,默认为 ScreenPresets["1080p"]
|
|
461
|
+
* @param audioPreset 屏幕共享音频预设,默认为 ScreenAudioPresets["default"]
|
|
448
462
|
*/
|
|
449
|
-
createLocalScreenTrack(preset?: ScreenPreset): LocalScreenTrack;
|
|
463
|
+
createLocalScreenTrack(preset?: ScreenPreset, audioPreset?: ScreenAudioPreset): LocalScreenTrack;
|
|
450
464
|
/**
|
|
451
465
|
* 创建自定义本地视频流
|
|
452
466
|
*/
|
|
453
467
|
createLocalCustomVideoTrack(msTrack: MediaStreamTrack): LocalVideoTrack;
|
|
468
|
+
/**
|
|
469
|
+
* 临时enable本地流轨道,如取消静音麦克风
|
|
470
|
+
*/
|
|
471
|
+
enableLocalTrack(track: LocalAudioTrack | LocalVideoTrack): void;
|
|
472
|
+
/**
|
|
473
|
+
* 临时disable本地流轨道,如临时静音麦克风
|
|
474
|
+
* 比unpublishLocalTrack取消发布轨道轻
|
|
475
|
+
*/
|
|
476
|
+
disableLocalTrack(track: LocalAudioTrack | LocalVideoTrack): void;
|
|
454
477
|
/**
|
|
455
478
|
* 发布本地流轨道
|
|
456
479
|
* @param track
|
|
457
480
|
* @returns
|
|
458
481
|
*/
|
|
459
|
-
publishLocalTrack(track: LocalAudioTrack | LocalVideoTrack, opt?: AudioPublishOptions | VideoPublishOptions): Promise<void>;
|
|
482
|
+
publishLocalTrack(track: LocalAudioTrack | LocalVideoTrack, opt?: Partial<AudioPublishOptions> | Partial<VideoPublishOptions>): Promise<void>;
|
|
460
483
|
/**
|
|
461
484
|
* 取消发布本地流
|
|
462
485
|
* @param track
|
|
@@ -464,8 +487,9 @@ export declare class SRTC extends BaseSRTC {
|
|
|
464
487
|
unpublishLocalTrack(track: LocalAudioTrack | LocalVideoTrack): Promise<void>;
|
|
465
488
|
/**
|
|
466
489
|
* 订阅远端频道混音流
|
|
490
|
+
* @param filter 音频轨道过滤器,传递string[]时,根据uid过滤
|
|
467
491
|
*/
|
|
468
|
-
subscribeRemoteAudioMixTrack(
|
|
492
|
+
subscribeRemoteAudioMixTrack(filter?: ((track: BaseTrack) => boolean) | string[]): Promise<RemoteAudioMixTrack>;
|
|
469
493
|
/**
|
|
470
494
|
* 订阅远端用户音频流
|
|
471
495
|
* @param uid 用户id
|
|
@@ -516,6 +540,13 @@ export declare const MicPresets: {
|
|
|
516
540
|
/** 双声道,采样率48kHz,码率96Kbps */
|
|
517
541
|
musicHighQualityStereo: MicPreset;
|
|
518
542
|
};
|
|
543
|
+
/**
|
|
544
|
+
* 屏幕共享系统音频预设参数
|
|
545
|
+
*/
|
|
546
|
+
export declare const ScreenAudioPresets: {
|
|
547
|
+
/** 系统音频,码率24Kbps */
|
|
548
|
+
default: ScreenAudioPreset;
|
|
549
|
+
};
|
|
519
550
|
/**
|
|
520
551
|
* 屏幕共享预设参数
|
|
521
552
|
*/
|
|
@@ -525,6 +556,25 @@ export declare const ScreenPresets: {
|
|
|
525
556
|
/** 分辨率1280*720,帧率10,码率1.5Mbps */
|
|
526
557
|
"720p": ScreenPreset;
|
|
527
558
|
};
|
|
559
|
+
/**
|
|
560
|
+
* 编码类型
|
|
561
|
+
*/
|
|
562
|
+
export declare enum Codec {
|
|
563
|
+
/** h264编码 */
|
|
564
|
+
H264 = 27,
|
|
565
|
+
/** h265编码 */
|
|
566
|
+
H265 = 36,
|
|
567
|
+
/** AAC编码 */
|
|
568
|
+
AAC = 15,
|
|
569
|
+
/** VP8编码 */
|
|
570
|
+
VP8 = 56,
|
|
571
|
+
/** VP9编码 */
|
|
572
|
+
VP9 = 57,
|
|
573
|
+
/** AV1编码 */
|
|
574
|
+
AV1 = 58,
|
|
575
|
+
/** OPUS编码 */
|
|
576
|
+
OPUS = 1398100047
|
|
577
|
+
}
|
|
528
578
|
/**
|
|
529
579
|
* 终端类型枚举
|
|
530
580
|
*/
|
|
@@ -619,6 +669,16 @@ export declare enum TrackKind {
|
|
|
619
669
|
Video = "video",
|
|
620
670
|
Audio = "audio"
|
|
621
671
|
}
|
|
672
|
+
/**
|
|
673
|
+
* 编码类型转字符串
|
|
674
|
+
* @param codec
|
|
675
|
+
* @returns
|
|
676
|
+
*/
|
|
677
|
+
export declare function codec2str(codec: Codec): string;
|
|
678
|
+
/**
|
|
679
|
+
* 创建混音后的音频轨
|
|
680
|
+
*/
|
|
681
|
+
export declare function createMixedAudioMediaStreamTrack(canvasContext?: CanvasRenderingContext2D): MixedAudioMediaStreamTrack;
|
|
622
682
|
export declare namespace __INNER__ {
|
|
623
683
|
const BaseSRTC_I: typeof BaseSRTC;
|
|
624
684
|
const CommonChannelEventType_I: typeof CommonChannelEventType;
|
|
@@ -829,6 +889,14 @@ export interface EnvWebInfo extends Bowser$1.Parser.ParsedResult {
|
|
|
829
889
|
*/
|
|
830
890
|
devicePixelRatio: number;
|
|
831
891
|
}
|
|
892
|
+
/** 远端混音流轨接口 */
|
|
893
|
+
export interface IRemoteAudioMixTrack {
|
|
894
|
+
readonly __type: "RemoteAudioMixTrack";
|
|
895
|
+
/**
|
|
896
|
+
* 获取过滤音频的用户id
|
|
897
|
+
*/
|
|
898
|
+
getFilterUids(): string[];
|
|
899
|
+
}
|
|
832
900
|
/**
|
|
833
901
|
* im强制断开事件data
|
|
834
902
|
*/
|
|
@@ -853,6 +921,27 @@ export interface ImMsgData {
|
|
|
853
921
|
/** 发送者昵称 */
|
|
854
922
|
name: string;
|
|
855
923
|
}
|
|
924
|
+
/**
|
|
925
|
+
* 加入频道选项
|
|
926
|
+
*/
|
|
927
|
+
export interface JoinOptions {
|
|
928
|
+
/**
|
|
929
|
+
* 是否自动订阅音频流
|
|
930
|
+
*/
|
|
931
|
+
autoSubscribeAudio?: boolean;
|
|
932
|
+
/**
|
|
933
|
+
* 是否自动订阅视频流
|
|
934
|
+
*/
|
|
935
|
+
autoSubscribeVideo?: boolean;
|
|
936
|
+
/**
|
|
937
|
+
* 希望的优先视频编码类型
|
|
938
|
+
*/
|
|
939
|
+
preferVideoCodec?: Codec;
|
|
940
|
+
/**
|
|
941
|
+
* 希望的优先音频编码类型
|
|
942
|
+
*/
|
|
943
|
+
preferAudioCodec?: Codec;
|
|
944
|
+
}
|
|
856
945
|
/**
|
|
857
946
|
* 麦克风采集配置
|
|
858
947
|
*/
|
|
@@ -897,6 +986,14 @@ export interface MicPreset {
|
|
|
897
986
|
capture: MicCaptureOptions;
|
|
898
987
|
publish: AudioPublishOptions;
|
|
899
988
|
}
|
|
989
|
+
/**
|
|
990
|
+
* 混音后的音频轨
|
|
991
|
+
*/
|
|
992
|
+
export interface MixedAudioMediaStreamTrack extends MediaStreamTrack {
|
|
993
|
+
context: AudioContext;
|
|
994
|
+
addTrack(track: MediaStreamTrack): void;
|
|
995
|
+
removeTrack(track: MediaStreamTrack): void;
|
|
996
|
+
}
|
|
900
997
|
/**
|
|
901
998
|
* 属性更改项
|
|
902
999
|
*/
|
|
@@ -908,6 +1005,18 @@ export interface PropChangeItem<T> {
|
|
|
908
1005
|
/** 更改前的值 */
|
|
909
1006
|
old: any;
|
|
910
1007
|
}
|
|
1008
|
+
/**
|
|
1009
|
+
* 屏幕采集音频配置
|
|
1010
|
+
*/
|
|
1011
|
+
export interface ScreenAudioCaptureOptions extends Omit<MicCaptureOptions, "deviceId"> {
|
|
1012
|
+
}
|
|
1013
|
+
/**
|
|
1014
|
+
* 屏幕共享音频预设值
|
|
1015
|
+
*/
|
|
1016
|
+
export interface ScreenAudioPreset {
|
|
1017
|
+
capture: ScreenAudioCaptureOptions | true;
|
|
1018
|
+
publish: AudioPublishOptions;
|
|
1019
|
+
}
|
|
911
1020
|
/**
|
|
912
1021
|
* 屏幕采集配置
|
|
913
1022
|
*/
|
|
@@ -924,6 +1033,11 @@ export interface ScreenCaptureOptions {
|
|
|
924
1033
|
* 帧率
|
|
925
1034
|
*/
|
|
926
1035
|
frameRate?: number;
|
|
1036
|
+
/**
|
|
1037
|
+
* specify the type of content, see: https://www.w3.org/TR/mst-content-hint/#video-content-hints
|
|
1038
|
+
* https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack/contentHint
|
|
1039
|
+
*/
|
|
1040
|
+
contentHint?: "detail" | "text" | "motion";
|
|
927
1041
|
/**
|
|
928
1042
|
* 是否显示鼠标
|
|
929
1043
|
*/
|
|
@@ -987,6 +1101,11 @@ export interface VideoPublishOptions {
|
|
|
987
1101
|
* 优先级,默认音频优先
|
|
988
1102
|
*/
|
|
989
1103
|
priority?: RTCPriorityType;
|
|
1104
|
+
/**
|
|
1105
|
+
* degradationPreference 弱网降级策略
|
|
1106
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/API/RTCRtpSender/setParameters#degradationpreference
|
|
1107
|
+
*/
|
|
1108
|
+
degradationPreference?: RTCDegradationPreference;
|
|
990
1109
|
/** 自定义属性 */
|
|
991
1110
|
props?: Record<string, any>;
|
|
992
1111
|
simulcasts?: VideoPublishOptions[];
|
|
@@ -1011,6 +1130,8 @@ interface BaseChannelInfo {
|
|
|
1011
1130
|
created_at: number;
|
|
1012
1131
|
/** 频道更新时间 */
|
|
1013
1132
|
updated_at: number;
|
|
1133
|
+
/** 白板地址 */
|
|
1134
|
+
white_board: string;
|
|
1014
1135
|
}
|
|
1015
1136
|
/**
|
|
1016
1137
|
* 流轨道信息
|
|
@@ -1036,6 +1157,8 @@ interface BaseTrackInfo {
|
|
|
1036
1157
|
bitrate: number;
|
|
1037
1158
|
/** 音频采样率 */
|
|
1038
1159
|
sample_rate: number;
|
|
1160
|
+
/** 音频声道数 */
|
|
1161
|
+
channel_count: number;
|
|
1039
1162
|
/** 流扩展属性 */
|
|
1040
1163
|
props?: Record<string, any>;
|
|
1041
1164
|
}
|
package/srtc.d.ts
CHANGED
|
@@ -27,8 +27,9 @@ declare abstract class BaseSRTC {
|
|
|
27
27
|
/**
|
|
28
28
|
* 加入频道
|
|
29
29
|
* @param token 加入频道token
|
|
30
|
+
* @param options 加入频道选项
|
|
30
31
|
*/
|
|
31
|
-
join(token: string): Promise<BaseChannelInfo>;
|
|
32
|
+
join(token: string, options?: JoinOptions): Promise<BaseChannelInfo>;
|
|
32
33
|
/**
|
|
33
34
|
* 离开频道
|
|
34
35
|
*/
|
|
@@ -38,6 +39,11 @@ declare abstract class BaseSRTC {
|
|
|
38
39
|
* @returns
|
|
39
40
|
*/
|
|
40
41
|
getChannelInfo(): BaseChannelInfo | null;
|
|
42
|
+
/**
|
|
43
|
+
* 获取流媒体引擎的metric快照
|
|
44
|
+
* @returns
|
|
45
|
+
*/
|
|
46
|
+
getStreamMetric(): Record<string, any> | undefined;
|
|
41
47
|
/**
|
|
42
48
|
* 获取某用户信息
|
|
43
49
|
* @returns
|
|
@@ -50,10 +56,10 @@ declare abstract class BaseSRTC {
|
|
|
50
56
|
getUsersInfo(map: true): Record<string, BaseUserInfo>;
|
|
51
57
|
getUsersInfo(map: false): BaseUserInfo[];
|
|
52
58
|
/**
|
|
53
|
-
*
|
|
54
|
-
* @param
|
|
59
|
+
* 订阅频道混音流
|
|
60
|
+
* @param filter 音频轨道过滤器,传递string[]时,根据uid过滤
|
|
55
61
|
*/
|
|
56
|
-
subscribeRemoteAudioMixTrack(
|
|
62
|
+
subscribeRemoteAudioMixTrack(filter?: ((track: BaseTrack) => boolean) | string[]): Promise<BaseTrack>;
|
|
57
63
|
/**
|
|
58
64
|
* 订阅远端用户音频流
|
|
59
65
|
* @param uid 用户id
|
|
@@ -122,6 +128,7 @@ declare abstract class BaseWebrtcTrack extends BaseTrack {
|
|
|
122
128
|
constructor(info: BaseTrackInfo, uid: string);
|
|
123
129
|
setMediaStreamTrack(mediaStreamTrack?: MediaStreamTrack): void;
|
|
124
130
|
getMediaStreamTrack(): MediaStreamTrack | undefined;
|
|
131
|
+
getMediaStream(): MediaStream;
|
|
125
132
|
}
|
|
126
133
|
declare class CommonChannelEventType {
|
|
127
134
|
/** 频道自定义props更新,对应data为ChannelInfo */
|
|
@@ -202,18 +209,6 @@ declare class SdkError {
|
|
|
202
209
|
msg: string;
|
|
203
210
|
};
|
|
204
211
|
}
|
|
205
|
-
declare enum Codec {
|
|
206
|
-
/** 未知编码类型 */
|
|
207
|
-
Unknown = 0,
|
|
208
|
-
/** h264编码 */
|
|
209
|
-
H264 = 27,
|
|
210
|
-
/** h265编码 */
|
|
211
|
-
H265 = 36,
|
|
212
|
-
/** AAC编码 */
|
|
213
|
-
AAC = 15,
|
|
214
|
-
/** OPUS编码 */
|
|
215
|
-
OPUS = 1398100047
|
|
216
|
-
}
|
|
217
212
|
declare function dateFormat(format: string, date?: Date): string;
|
|
218
213
|
declare function dct(t: string): any;
|
|
219
214
|
declare function genNonce(len?: number): string;
|
|
@@ -283,7 +278,7 @@ export declare class LocalCameraTrack extends LocalVideoTrack {
|
|
|
283
278
|
* 开始采集
|
|
284
279
|
* @param opt 采集参数
|
|
285
280
|
*/
|
|
286
|
-
startCapture(opt?: CameraCaptureOptions): Promise<void>;
|
|
281
|
+
startCapture(opt?: Partial<CameraCaptureOptions>): Promise<void>;
|
|
287
282
|
/**
|
|
288
283
|
* 停止采集
|
|
289
284
|
*/
|
|
@@ -309,7 +304,7 @@ export declare class LocalMicTrack extends LocalAudioTrack {
|
|
|
309
304
|
* 开始采集
|
|
310
305
|
* @param opt 采集参数
|
|
311
306
|
*/
|
|
312
|
-
startCapture(opt?: MicCaptureOptions): Promise<void>;
|
|
307
|
+
startCapture(opt?: Partial<MicCaptureOptions>): Promise<void>;
|
|
313
308
|
/**
|
|
314
309
|
* 停止采集
|
|
315
310
|
*/
|
|
@@ -321,16 +316,30 @@ export declare class LocalMicTrack extends LocalAudioTrack {
|
|
|
321
316
|
*/
|
|
322
317
|
changeDeviceId(deviceId: string): Promise<void>;
|
|
323
318
|
}
|
|
319
|
+
/**
|
|
320
|
+
* 屏幕共享音频流轨道
|
|
321
|
+
*/
|
|
322
|
+
export declare class LocalScreenAudioTrack extends LocalAudioTrack {
|
|
323
|
+
constructor(captureOptions: ScreenAudioCaptureOptions | true);
|
|
324
|
+
/**
|
|
325
|
+
* 停止采集
|
|
326
|
+
*/
|
|
327
|
+
stopCapture(): void;
|
|
328
|
+
}
|
|
324
329
|
/**
|
|
325
330
|
* 本地屏幕视频流轨道
|
|
326
331
|
*/
|
|
327
332
|
export declare class LocalScreenTrack extends LocalVideoTrack {
|
|
328
333
|
constructor(captureOptions: ScreenCaptureOptions);
|
|
334
|
+
/**
|
|
335
|
+
* 获取音频轨道
|
|
336
|
+
*/
|
|
337
|
+
getAudioTrack(): LocalScreenAudioTrack | undefined;
|
|
329
338
|
/**
|
|
330
339
|
* 开始采集
|
|
331
340
|
* @param opt 采集参数
|
|
332
341
|
*/
|
|
333
|
-
startCapture(opt?: ScreenCaptureOptions): Promise<void>;
|
|
342
|
+
startCapture(opt?: Partial<ScreenCaptureOptions>): Promise<void>;
|
|
334
343
|
/**
|
|
335
344
|
* 停止采集
|
|
336
345
|
*/
|
|
@@ -369,7 +378,7 @@ export declare class LocalVideoTrack extends BaseWebrtcTrack {
|
|
|
369
378
|
/**
|
|
370
379
|
* 远端混音流
|
|
371
380
|
*/
|
|
372
|
-
export declare class RemoteAudioMixTrack extends RemoteAudioTrack {
|
|
381
|
+
export declare class RemoteAudioMixTrack extends RemoteAudioTrack implements IRemoteAudioMixTrack {
|
|
373
382
|
constructor(info: BaseTrackInfo, filterUids?: string[]);
|
|
374
383
|
/**
|
|
375
384
|
* 混音流中过滤的uid
|
|
@@ -382,6 +391,10 @@ export declare class RemoteAudioMixTrack extends RemoteAudioTrack {
|
|
|
382
391
|
*/
|
|
383
392
|
export declare class RemoteAudioTrack extends BaseWebrtcTrack {
|
|
384
393
|
constructor(info: BaseTrackInfo, uid: string);
|
|
394
|
+
/**
|
|
395
|
+
* 是否正在播放
|
|
396
|
+
*/
|
|
397
|
+
isPlaying(): boolean;
|
|
385
398
|
/**
|
|
386
399
|
* 播放音频(可指定播放设备)
|
|
387
400
|
*/
|
|
@@ -445,18 +458,28 @@ export declare class SRTC extends BaseSRTC {
|
|
|
445
458
|
/**
|
|
446
459
|
* 创建屏幕共享本地视频流
|
|
447
460
|
* @param preset 屏幕共享预设,默认为 ScreenPresets["1080p"]
|
|
461
|
+
* @param audioPreset 屏幕共享音频预设,默认为 ScreenAudioPresets["default"]
|
|
448
462
|
*/
|
|
449
|
-
createLocalScreenTrack(preset?: ScreenPreset): LocalScreenTrack;
|
|
463
|
+
createLocalScreenTrack(preset?: ScreenPreset, audioPreset?: ScreenAudioPreset): LocalScreenTrack;
|
|
450
464
|
/**
|
|
451
465
|
* 创建自定义本地视频流
|
|
452
466
|
*/
|
|
453
467
|
createLocalCustomVideoTrack(msTrack: MediaStreamTrack): LocalVideoTrack;
|
|
468
|
+
/**
|
|
469
|
+
* 临时enable本地流轨道,如取消静音麦克风
|
|
470
|
+
*/
|
|
471
|
+
enableLocalTrack(track: LocalAudioTrack | LocalVideoTrack): void;
|
|
472
|
+
/**
|
|
473
|
+
* 临时disable本地流轨道,如临时静音麦克风
|
|
474
|
+
* 比unpublishLocalTrack取消发布轨道轻
|
|
475
|
+
*/
|
|
476
|
+
disableLocalTrack(track: LocalAudioTrack | LocalVideoTrack): void;
|
|
454
477
|
/**
|
|
455
478
|
* 发布本地流轨道
|
|
456
479
|
* @param track
|
|
457
480
|
* @returns
|
|
458
481
|
*/
|
|
459
|
-
publishLocalTrack(track: LocalAudioTrack | LocalVideoTrack, opt?: AudioPublishOptions | VideoPublishOptions): Promise<void>;
|
|
482
|
+
publishLocalTrack(track: LocalAudioTrack | LocalVideoTrack, opt?: Partial<AudioPublishOptions> | Partial<VideoPublishOptions>): Promise<void>;
|
|
460
483
|
/**
|
|
461
484
|
* 取消发布本地流
|
|
462
485
|
* @param track
|
|
@@ -464,8 +487,9 @@ export declare class SRTC extends BaseSRTC {
|
|
|
464
487
|
unpublishLocalTrack(track: LocalAudioTrack | LocalVideoTrack): Promise<void>;
|
|
465
488
|
/**
|
|
466
489
|
* 订阅远端频道混音流
|
|
490
|
+
* @param filter 音频轨道过滤器,传递string[]时,根据uid过滤
|
|
467
491
|
*/
|
|
468
|
-
subscribeRemoteAudioMixTrack(
|
|
492
|
+
subscribeRemoteAudioMixTrack(filter?: ((track: BaseTrack) => boolean) | string[]): Promise<RemoteAudioMixTrack>;
|
|
469
493
|
/**
|
|
470
494
|
* 订阅远端用户音频流
|
|
471
495
|
* @param uid 用户id
|
|
@@ -516,6 +540,13 @@ export declare const MicPresets: {
|
|
|
516
540
|
/** 双声道,采样率48kHz,码率96Kbps */
|
|
517
541
|
musicHighQualityStereo: MicPreset;
|
|
518
542
|
};
|
|
543
|
+
/**
|
|
544
|
+
* 屏幕共享系统音频预设参数
|
|
545
|
+
*/
|
|
546
|
+
export declare const ScreenAudioPresets: {
|
|
547
|
+
/** 系统音频,码率24Kbps */
|
|
548
|
+
default: ScreenAudioPreset;
|
|
549
|
+
};
|
|
519
550
|
/**
|
|
520
551
|
* 屏幕共享预设参数
|
|
521
552
|
*/
|
|
@@ -525,6 +556,25 @@ export declare const ScreenPresets: {
|
|
|
525
556
|
/** 分辨率1280*720,帧率10,码率1.5Mbps */
|
|
526
557
|
"720p": ScreenPreset;
|
|
527
558
|
};
|
|
559
|
+
/**
|
|
560
|
+
* 编码类型
|
|
561
|
+
*/
|
|
562
|
+
export declare enum Codec {
|
|
563
|
+
/** h264编码 */
|
|
564
|
+
H264 = 27,
|
|
565
|
+
/** h265编码 */
|
|
566
|
+
H265 = 36,
|
|
567
|
+
/** AAC编码 */
|
|
568
|
+
AAC = 15,
|
|
569
|
+
/** VP8编码 */
|
|
570
|
+
VP8 = 56,
|
|
571
|
+
/** VP9编码 */
|
|
572
|
+
VP9 = 57,
|
|
573
|
+
/** AV1编码 */
|
|
574
|
+
AV1 = 58,
|
|
575
|
+
/** OPUS编码 */
|
|
576
|
+
OPUS = 1398100047
|
|
577
|
+
}
|
|
528
578
|
/**
|
|
529
579
|
* 终端类型枚举
|
|
530
580
|
*/
|
|
@@ -619,6 +669,16 @@ export declare enum TrackKind {
|
|
|
619
669
|
Video = "video",
|
|
620
670
|
Audio = "audio"
|
|
621
671
|
}
|
|
672
|
+
/**
|
|
673
|
+
* 编码类型转字符串
|
|
674
|
+
* @param codec
|
|
675
|
+
* @returns
|
|
676
|
+
*/
|
|
677
|
+
export declare function codec2str(codec: Codec): string;
|
|
678
|
+
/**
|
|
679
|
+
* 创建混音后的音频轨
|
|
680
|
+
*/
|
|
681
|
+
export declare function createMixedAudioMediaStreamTrack(canvasContext?: CanvasRenderingContext2D): MixedAudioMediaStreamTrack;
|
|
622
682
|
export declare namespace __INNER__ {
|
|
623
683
|
const BaseSRTC_I: typeof BaseSRTC;
|
|
624
684
|
const CommonChannelEventType_I: typeof CommonChannelEventType;
|
|
@@ -829,6 +889,14 @@ export interface EnvWebInfo extends Bowser$1.Parser.ParsedResult {
|
|
|
829
889
|
*/
|
|
830
890
|
devicePixelRatio: number;
|
|
831
891
|
}
|
|
892
|
+
/** 远端混音流轨接口 */
|
|
893
|
+
export interface IRemoteAudioMixTrack {
|
|
894
|
+
readonly __type: "RemoteAudioMixTrack";
|
|
895
|
+
/**
|
|
896
|
+
* 获取过滤音频的用户id
|
|
897
|
+
*/
|
|
898
|
+
getFilterUids(): string[];
|
|
899
|
+
}
|
|
832
900
|
/**
|
|
833
901
|
* im强制断开事件data
|
|
834
902
|
*/
|
|
@@ -853,6 +921,27 @@ export interface ImMsgData {
|
|
|
853
921
|
/** 发送者昵称 */
|
|
854
922
|
name: string;
|
|
855
923
|
}
|
|
924
|
+
/**
|
|
925
|
+
* 加入频道选项
|
|
926
|
+
*/
|
|
927
|
+
export interface JoinOptions {
|
|
928
|
+
/**
|
|
929
|
+
* 是否自动订阅音频流
|
|
930
|
+
*/
|
|
931
|
+
autoSubscribeAudio?: boolean;
|
|
932
|
+
/**
|
|
933
|
+
* 是否自动订阅视频流
|
|
934
|
+
*/
|
|
935
|
+
autoSubscribeVideo?: boolean;
|
|
936
|
+
/**
|
|
937
|
+
* 希望的优先视频编码类型
|
|
938
|
+
*/
|
|
939
|
+
preferVideoCodec?: Codec;
|
|
940
|
+
/**
|
|
941
|
+
* 希望的优先音频编码类型
|
|
942
|
+
*/
|
|
943
|
+
preferAudioCodec?: Codec;
|
|
944
|
+
}
|
|
856
945
|
/**
|
|
857
946
|
* 麦克风采集配置
|
|
858
947
|
*/
|
|
@@ -897,6 +986,14 @@ export interface MicPreset {
|
|
|
897
986
|
capture: MicCaptureOptions;
|
|
898
987
|
publish: AudioPublishOptions;
|
|
899
988
|
}
|
|
989
|
+
/**
|
|
990
|
+
* 混音后的音频轨
|
|
991
|
+
*/
|
|
992
|
+
export interface MixedAudioMediaStreamTrack extends MediaStreamTrack {
|
|
993
|
+
context: AudioContext;
|
|
994
|
+
addTrack(track: MediaStreamTrack): void;
|
|
995
|
+
removeTrack(track: MediaStreamTrack): void;
|
|
996
|
+
}
|
|
900
997
|
/**
|
|
901
998
|
* 属性更改项
|
|
902
999
|
*/
|
|
@@ -908,6 +1005,18 @@ export interface PropChangeItem<T> {
|
|
|
908
1005
|
/** 更改前的值 */
|
|
909
1006
|
old: any;
|
|
910
1007
|
}
|
|
1008
|
+
/**
|
|
1009
|
+
* 屏幕采集音频配置
|
|
1010
|
+
*/
|
|
1011
|
+
export interface ScreenAudioCaptureOptions extends Omit<MicCaptureOptions, "deviceId"> {
|
|
1012
|
+
}
|
|
1013
|
+
/**
|
|
1014
|
+
* 屏幕共享音频预设值
|
|
1015
|
+
*/
|
|
1016
|
+
export interface ScreenAudioPreset {
|
|
1017
|
+
capture: ScreenAudioCaptureOptions | true;
|
|
1018
|
+
publish: AudioPublishOptions;
|
|
1019
|
+
}
|
|
911
1020
|
/**
|
|
912
1021
|
* 屏幕采集配置
|
|
913
1022
|
*/
|
|
@@ -924,6 +1033,11 @@ export interface ScreenCaptureOptions {
|
|
|
924
1033
|
* 帧率
|
|
925
1034
|
*/
|
|
926
1035
|
frameRate?: number;
|
|
1036
|
+
/**
|
|
1037
|
+
* specify the type of content, see: https://www.w3.org/TR/mst-content-hint/#video-content-hints
|
|
1038
|
+
* https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack/contentHint
|
|
1039
|
+
*/
|
|
1040
|
+
contentHint?: "detail" | "text" | "motion";
|
|
927
1041
|
/**
|
|
928
1042
|
* 是否显示鼠标
|
|
929
1043
|
*/
|
|
@@ -987,6 +1101,11 @@ export interface VideoPublishOptions {
|
|
|
987
1101
|
* 优先级,默认音频优先
|
|
988
1102
|
*/
|
|
989
1103
|
priority?: RTCPriorityType;
|
|
1104
|
+
/**
|
|
1105
|
+
* degradationPreference 弱网降级策略
|
|
1106
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/API/RTCRtpSender/setParameters#degradationpreference
|
|
1107
|
+
*/
|
|
1108
|
+
degradationPreference?: RTCDegradationPreference;
|
|
990
1109
|
/** 自定义属性 */
|
|
991
1110
|
props?: Record<string, any>;
|
|
992
1111
|
simulcasts?: VideoPublishOptions[];
|
|
@@ -1011,6 +1130,8 @@ interface BaseChannelInfo {
|
|
|
1011
1130
|
created_at: number;
|
|
1012
1131
|
/** 频道更新时间 */
|
|
1013
1132
|
updated_at: number;
|
|
1133
|
+
/** 白板地址 */
|
|
1134
|
+
white_board: string;
|
|
1014
1135
|
}
|
|
1015
1136
|
/**
|
|
1016
1137
|
* 流轨道信息
|
|
@@ -1036,6 +1157,8 @@ interface BaseTrackInfo {
|
|
|
1036
1157
|
bitrate: number;
|
|
1037
1158
|
/** 音频采样率 */
|
|
1038
1159
|
sample_rate: number;
|
|
1160
|
+
/** 音频声道数 */
|
|
1161
|
+
channel_count: number;
|
|
1039
1162
|
/** 流扩展属性 */
|
|
1040
1163
|
props?: Record<string, any>;
|
|
1041
1164
|
}
|