@seastart/srtc-web-sdk 0.0.4 → 0.0.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 +126 -67
- package/srtc.d.ts +126 -67
- package/srtc.js +1 -1
- package/srtc.mjs +1 -1
package/package.json
CHANGED
package/srtc.d.mts
CHANGED
|
@@ -6,6 +6,11 @@ declare abstract class BaseSRTC {
|
|
|
6
6
|
* 获取sdk编译信息
|
|
7
7
|
*/
|
|
8
8
|
abstract buildInfo(): BuildInfo;
|
|
9
|
+
/**
|
|
10
|
+
* 获取运行环境信息
|
|
11
|
+
* @returns
|
|
12
|
+
*/
|
|
13
|
+
getEnvInfo(): EnvWxInfo | EnvWebInfo;
|
|
9
14
|
/**
|
|
10
15
|
* 频道事件通知回调
|
|
11
16
|
*/
|
|
@@ -34,9 +39,11 @@ declare abstract class BaseSRTC {
|
|
|
34
39
|
* 获取频道内用户信息列表
|
|
35
40
|
* @returns
|
|
36
41
|
*/
|
|
37
|
-
getUsersInfo(): BaseUserInfo
|
|
42
|
+
getUsersInfo(map: true): Record<string, BaseUserInfo>;
|
|
43
|
+
getUsersInfo(map: false): BaseUserInfo[];
|
|
38
44
|
/**
|
|
39
45
|
* 订阅远端频道混音流
|
|
46
|
+
* @param filterUids 过滤音频的用户id
|
|
40
47
|
*/
|
|
41
48
|
subscribeRemoteAudioMixTrack(filterUids?: string[]): Promise<BaseTrack>;
|
|
42
49
|
/**
|
|
@@ -71,7 +78,7 @@ declare abstract class BaseTrack extends EventEmitter {
|
|
|
71
78
|
*/
|
|
72
79
|
get desc(): string;
|
|
73
80
|
/**
|
|
74
|
-
*
|
|
81
|
+
* 获取流轨道信息
|
|
75
82
|
* @returns
|
|
76
83
|
*/
|
|
77
84
|
getInfo(): BaseTrackInfo;
|
|
@@ -88,37 +95,37 @@ declare abstract class BaseWebrtcTrack extends BaseTrack {
|
|
|
88
95
|
getMediaStreamTrack(): MediaStreamTrack | undefined;
|
|
89
96
|
}
|
|
90
97
|
declare class CommonChannelEventType {
|
|
91
|
-
/** 频道自定义props
|
|
98
|
+
/** 频道自定义props更新,对应data为ChannelInfo */
|
|
92
99
|
static readonly CHANNEL_UPDATE = "channel_update";
|
|
93
|
-
/**
|
|
100
|
+
/** 首次加入频道成功,对应data为ChannelInfo */
|
|
94
101
|
static readonly JOIN_SUCCEED = "join_succeed";
|
|
95
|
-
/**
|
|
102
|
+
/** 自己信息被改变,对应data为UserInfo */
|
|
96
103
|
static readonly ME_UPDATE = "me_update";
|
|
97
|
-
/**
|
|
104
|
+
/** 开始断线自动重连,无data */
|
|
98
105
|
static readonly RECONNECTING = "reconnecting";
|
|
99
|
-
/**
|
|
106
|
+
/** 重连成功,断线重连成功后会触发,对应data为ChannelInfo */
|
|
100
107
|
static readonly RECONNECTED = "reconnected";
|
|
101
|
-
/**
|
|
108
|
+
/** 自己被强制离开频道,对应data为DisconnectEventData */
|
|
102
109
|
static readonly DISCONNECTED = "disconnected";
|
|
103
|
-
/**
|
|
110
|
+
/** 其他用户加入频道,对应data为UserInfo */
|
|
104
111
|
static readonly USER_JOIN = "user_join";
|
|
105
|
-
/**
|
|
112
|
+
/** 其他用户信息改变,对应data为UserInfo */
|
|
106
113
|
static readonly USER_UPDATE = "user_update";
|
|
107
|
-
/**
|
|
114
|
+
/** 其他用户离开频道,对应data为UserLeaveEventData */
|
|
108
115
|
static readonly USER_LEAVE = "user_leave";
|
|
109
|
-
/**
|
|
116
|
+
/** 其他用户发布流轨道,对应data为{ user: UserInfo, track: TrackInfo } */
|
|
110
117
|
static readonly USER_TRACK_ADD = "user_track_add";
|
|
111
|
-
/**
|
|
118
|
+
/** 其他用户更新流轨道,对应data为{ user: UserInfo, track: TrackInfo } */
|
|
112
119
|
static readonly USER_TRACK_UPDATE = "user_track_update";
|
|
113
|
-
/**
|
|
120
|
+
/** 其他用户删除流轨道,对应data为{ user: UserInfo, track: TrackInfo } */
|
|
114
121
|
static readonly USER_TRACK_REMOVE = "user_track_remove";
|
|
115
|
-
/**
|
|
122
|
+
/** 频道内自定义消息,对应data为CustomMsgData */
|
|
116
123
|
static readonly CUSTOM_MSG = "custom_msg";
|
|
117
|
-
/**
|
|
124
|
+
/** 流轨道没有数据,对应data为BaseTrack */
|
|
118
125
|
static readonly TRACK_MUTED = "track_muted";
|
|
119
|
-
/**
|
|
126
|
+
/** 流轨道恢复数据,对应data为BaseTrack */
|
|
120
127
|
static readonly TRACK_UNMUTED = "track_unmuted";
|
|
121
|
-
/**
|
|
128
|
+
/** 流轨道停止,对应data为BaseTrack */
|
|
122
129
|
static readonly TRACK_ENDED = "track_ended";
|
|
123
130
|
}
|
|
124
131
|
declare enum Codec {
|
|
@@ -133,23 +140,6 @@ declare enum Codec {
|
|
|
133
140
|
/** OPUS编码 */
|
|
134
141
|
OPUS = 1398100047
|
|
135
142
|
}
|
|
136
|
-
/**
|
|
137
|
-
* 用户离开频道的原因
|
|
138
|
-
*/
|
|
139
|
-
declare enum DisconnectReason {
|
|
140
|
-
/** 错误 */
|
|
141
|
-
Error = -1,
|
|
142
|
-
/** 主动离开 */
|
|
143
|
-
Self = 1,
|
|
144
|
-
/** 被踢离开 */
|
|
145
|
-
Kicked = 2,
|
|
146
|
-
/** 被顶号 */
|
|
147
|
-
Replace = 3,
|
|
148
|
-
/** 心跳超时离开 */
|
|
149
|
-
Timeout = 4,
|
|
150
|
-
/** 频道销毁离开 */
|
|
151
|
-
Destroy = 5
|
|
152
|
-
}
|
|
153
143
|
/** 频道事件通知 */
|
|
154
144
|
export declare class ChannelEvent {
|
|
155
145
|
/** 事件类型 */
|
|
@@ -160,11 +150,11 @@ export declare class ChannelEvent {
|
|
|
160
150
|
}
|
|
161
151
|
/** 扩展的频道事件 */
|
|
162
152
|
export declare class ChannelEventType extends CommonChannelEventType {
|
|
163
|
-
/**
|
|
153
|
+
/** 外设插入,对应data为MediaDeviceInfo */
|
|
164
154
|
static readonly DEVICE_ADD = "device_add";
|
|
165
|
-
/**
|
|
155
|
+
/** 外设移除,对应data为MediaDeviceInfo */
|
|
166
156
|
static readonly DEVICE_REMOVE = "device_remove";
|
|
167
|
-
/**
|
|
157
|
+
/** 轨道自动播放失败,对应data为BaseTrack */
|
|
168
158
|
static readonly TRACK_AUTOPLAY_FAIL = "track_autoplay_fail";
|
|
169
159
|
}
|
|
170
160
|
/**
|
|
@@ -275,6 +265,10 @@ export declare class LocalVideoTrack extends BaseWebrtcTrack {
|
|
|
275
265
|
*/
|
|
276
266
|
export declare class RemoteAudioMixTrack extends RemoteAudioTrack {
|
|
277
267
|
constructor(info: BaseTrackInfo, filterUids?: string[]);
|
|
268
|
+
/**
|
|
269
|
+
* 混音流中过滤的uid
|
|
270
|
+
* @returns
|
|
271
|
+
*/
|
|
278
272
|
getFilterUids(): string[];
|
|
279
273
|
}
|
|
280
274
|
/**
|
|
@@ -311,6 +305,11 @@ export declare class RemoteVideoTrack extends BaseWebrtcTrack {
|
|
|
311
305
|
}
|
|
312
306
|
export declare class SRTC extends BaseSRTC {
|
|
313
307
|
buildInfo(): BuildInfo;
|
|
308
|
+
/**
|
|
309
|
+
* 获取web运行环境信息,如是否支持webrtc等
|
|
310
|
+
* @returns
|
|
311
|
+
*/
|
|
312
|
+
getEnvInfo(): EnvWebInfo;
|
|
314
313
|
constructor(initParams: RtcInitParams);
|
|
315
314
|
leave(): Promise<void>;
|
|
316
315
|
/**
|
|
@@ -320,16 +319,6 @@ export declare class SRTC extends BaseSRTC {
|
|
|
320
319
|
* @returns
|
|
321
320
|
*/
|
|
322
321
|
getDevices(kind?: MediaDeviceKind, requestPermissions?: boolean): Promise<MediaDeviceInfo[]>;
|
|
323
|
-
/**
|
|
324
|
-
* 获取环境信息,如是否支持webrtc等
|
|
325
|
-
* @returns
|
|
326
|
-
*/
|
|
327
|
-
getEnvInfo(): EnvWebInfo;
|
|
328
|
-
/**
|
|
329
|
-
* 将track事件转化为频道事件
|
|
330
|
-
* @param track
|
|
331
|
-
*/
|
|
332
|
-
private addTrackListeners;
|
|
333
322
|
/**
|
|
334
323
|
* 创建麦克风本地音频流
|
|
335
324
|
*/
|
|
@@ -386,28 +375,93 @@ export declare class SRTC extends BaseSRTC {
|
|
|
386
375
|
* 摄像头预设参数
|
|
387
376
|
*/
|
|
388
377
|
export declare const CameraPresets: {
|
|
378
|
+
/** 分辨率1920*1080,帧率15,码率2.5Mbps */
|
|
389
379
|
"1080p": CameraPreset;
|
|
380
|
+
/** 分辨率1280*720,帧率15,码率1.2Mbps,createLocalCameraTrack的默认预设参数 */
|
|
390
381
|
"720p": CameraPreset;
|
|
382
|
+
/** 分辨率640*360,帧率15,码率550Kbps */
|
|
391
383
|
"360p": CameraPreset;
|
|
384
|
+
/** 分辨率320*180,帧率15,码率250Kbps */
|
|
392
385
|
"180p": CameraPreset;
|
|
393
386
|
};
|
|
394
387
|
/**
|
|
395
388
|
* 麦克风预设参数
|
|
396
389
|
*/
|
|
397
390
|
export declare const MicPresets: {
|
|
391
|
+
/** 单声道,采样率48kHz,码率24Kbps */
|
|
398
392
|
speech: MicPreset;
|
|
393
|
+
/** 单声道,采样率48kHz,码率32Kbps,createLocalMicTrack的默认预设参数 */
|
|
399
394
|
music: MicPreset;
|
|
395
|
+
/** 双声道,采样率48kHz,码率48Kbps */
|
|
400
396
|
musicStereo: MicPreset;
|
|
397
|
+
/** 单声道,采样率48kHz,码率64Kbps */
|
|
401
398
|
musicHighQuality: MicPreset;
|
|
399
|
+
/** 双声道,采样率48kHz,码率96Kbps */
|
|
402
400
|
musicHighQualityStereo: MicPreset;
|
|
403
401
|
};
|
|
404
402
|
/**
|
|
405
403
|
* 屏幕共享预设参数
|
|
406
404
|
*/
|
|
407
405
|
export declare const ScreenPresets: {
|
|
406
|
+
/** 分辨率1920*1080,帧率10,码率2Mbps,createLocalScreenTrack时的默认预设参数 */
|
|
408
407
|
"1080p": ScreenPreset;
|
|
408
|
+
/** 分辨率1280*720,帧率10,码率1.5Mbps */
|
|
409
409
|
"720p": ScreenPreset;
|
|
410
410
|
};
|
|
411
|
+
/**
|
|
412
|
+
* 终端类型枚举
|
|
413
|
+
*/
|
|
414
|
+
export declare enum DeviceType {
|
|
415
|
+
/**
|
|
416
|
+
* 未知设备
|
|
417
|
+
*/
|
|
418
|
+
Unknown = 0,
|
|
419
|
+
/**
|
|
420
|
+
* Windows
|
|
421
|
+
*/
|
|
422
|
+
Windows = 1,
|
|
423
|
+
/**
|
|
424
|
+
* Android
|
|
425
|
+
*/
|
|
426
|
+
Android = 2,
|
|
427
|
+
/**
|
|
428
|
+
* iOS
|
|
429
|
+
*/
|
|
430
|
+
IOS = 3,
|
|
431
|
+
/**
|
|
432
|
+
* Linux
|
|
433
|
+
*/
|
|
434
|
+
Linux = 4,
|
|
435
|
+
/**
|
|
436
|
+
* MacOS
|
|
437
|
+
*/
|
|
438
|
+
MacOS = 5,
|
|
439
|
+
/**
|
|
440
|
+
* webrtc
|
|
441
|
+
*/
|
|
442
|
+
WebRTC = 6,
|
|
443
|
+
/**
|
|
444
|
+
* 小程序
|
|
445
|
+
*/
|
|
446
|
+
XCX = 7
|
|
447
|
+
}
|
|
448
|
+
/**
|
|
449
|
+
* 用户离开频道的原因
|
|
450
|
+
*/
|
|
451
|
+
export declare enum DisconnectReason {
|
|
452
|
+
/** 错误 */
|
|
453
|
+
Error = -1,
|
|
454
|
+
/** 主动离开 */
|
|
455
|
+
Self = 1,
|
|
456
|
+
/** 被踢离开 */
|
|
457
|
+
Kicked = 2,
|
|
458
|
+
/** 被顶号 */
|
|
459
|
+
Replace = 3,
|
|
460
|
+
/** 心跳超时离开 */
|
|
461
|
+
Timeout = 4,
|
|
462
|
+
/** 频道销毁离开 */
|
|
463
|
+
Destroy = 5
|
|
464
|
+
}
|
|
411
465
|
/**
|
|
412
466
|
* 日志打印等级
|
|
413
467
|
*/
|
|
@@ -517,6 +571,21 @@ export interface CameraPreset {
|
|
|
517
571
|
capture: CameraCaptureOptions;
|
|
518
572
|
publish: VideoPublishOptions;
|
|
519
573
|
}
|
|
574
|
+
/**
|
|
575
|
+
* 自定义消息
|
|
576
|
+
*/
|
|
577
|
+
export interface CustomMsgData {
|
|
578
|
+
/** 消息命令 */
|
|
579
|
+
action: string;
|
|
580
|
+
/** 消息体 */
|
|
581
|
+
content: any;
|
|
582
|
+
/** 发送者会话id */
|
|
583
|
+
sid: string;
|
|
584
|
+
/** 发送者ID */
|
|
585
|
+
uid: string;
|
|
586
|
+
/** 频道名(如果非频道内自定义消息,为空) */
|
|
587
|
+
channel: string;
|
|
588
|
+
}
|
|
520
589
|
/**
|
|
521
590
|
* 强制离开事件data
|
|
522
591
|
*/
|
|
@@ -527,7 +596,7 @@ export interface DisconnectEventData {
|
|
|
527
596
|
error?: any;
|
|
528
597
|
}
|
|
529
598
|
/**
|
|
530
|
-
* web
|
|
599
|
+
* web环境详情
|
|
531
600
|
*/
|
|
532
601
|
export interface EnvWebInfo extends Bowser$1.Parser.ParsedResult {
|
|
533
602
|
/**
|
|
@@ -611,6 +680,13 @@ export interface EnvWebInfo extends Bowser$1.Parser.ParsedResult {
|
|
|
611
680
|
*/
|
|
612
681
|
devicePixelRatio: number;
|
|
613
682
|
}
|
|
683
|
+
/**
|
|
684
|
+
* 微信小程序环境详情
|
|
685
|
+
*/
|
|
686
|
+
export interface EnvWxInfo {
|
|
687
|
+
system: WechatMiniprogram.SystemInfo;
|
|
688
|
+
device: WechatMiniprogram.DeviceInfo;
|
|
689
|
+
}
|
|
614
690
|
/**
|
|
615
691
|
* 加入频道选项
|
|
616
692
|
*/
|
|
@@ -760,16 +836,6 @@ interface BaseChannelInfo {
|
|
|
760
836
|
created_at: number;
|
|
761
837
|
/** 频道更新时间 */
|
|
762
838
|
updated_at: number;
|
|
763
|
-
/** 流媒体连接id */
|
|
764
|
-
link_id: number;
|
|
765
|
-
/** 房间最大人数,含义参考:https://www.yuque.com/anyconf/czwlh6/prtk0l4s8ylf7mk3 */
|
|
766
|
-
max_user: number;
|
|
767
|
-
/** 房间最大参与音频能量竞争路数(针对整个房间设置) */
|
|
768
|
-
max_speech: number;
|
|
769
|
-
/** 单人最大转发的人数(音频、视频路数)(针对单人设置) */
|
|
770
|
-
max_peer: number;
|
|
771
|
-
/** 单人非主动pick模式下最大转发视频路数(针对单人设置,目前我们视频都是主动pick,所以这个设置没有意义) */
|
|
772
|
-
max_video: number;
|
|
773
839
|
}
|
|
774
840
|
/**
|
|
775
841
|
* 流轨道信息
|
|
@@ -797,8 +863,6 @@ interface BaseTrackInfo {
|
|
|
797
863
|
sampleRate: number;
|
|
798
864
|
/** 流扩展属性 */
|
|
799
865
|
props?: Record<string, any>;
|
|
800
|
-
/** 轨道号 */
|
|
801
|
-
track: number;
|
|
802
866
|
}
|
|
803
867
|
/**
|
|
804
868
|
* 用户信息
|
|
@@ -811,7 +875,7 @@ interface BaseUserInfo {
|
|
|
811
875
|
/** 会中昵称 */
|
|
812
876
|
name: string;
|
|
813
877
|
/** 设备类型 */
|
|
814
|
-
device_type:
|
|
878
|
+
device_type: DeviceType;
|
|
815
879
|
/** 设备ID */
|
|
816
880
|
device_id: string;
|
|
817
881
|
/** 客户端RTCsdk版本号 */
|
|
@@ -836,16 +900,11 @@ interface BaseUserInfo {
|
|
|
836
900
|
leave_at: number;
|
|
837
901
|
/** 流轨道 */
|
|
838
902
|
stream_tracks?: BaseTrackInfo[];
|
|
839
|
-
/** 流媒体连接id */
|
|
840
|
-
link_id: number;
|
|
841
|
-
/** 流媒体服务器id */
|
|
842
|
-
upload_id: string;
|
|
843
903
|
}
|
|
844
904
|
|
|
845
905
|
export {
|
|
846
906
|
BaseChannelInfo as ChannelInfo,
|
|
847
907
|
BaseTrackInfo as TrackInfo,
|
|
848
908
|
BaseUserInfo as UserInfo,
|
|
849
|
-
DisconnectReason as LeaveReason,
|
|
850
909
|
};
|
|
851
910
|
|
package/srtc.d.ts
CHANGED
|
@@ -6,6 +6,11 @@ declare abstract class BaseSRTC {
|
|
|
6
6
|
* 获取sdk编译信息
|
|
7
7
|
*/
|
|
8
8
|
abstract buildInfo(): BuildInfo;
|
|
9
|
+
/**
|
|
10
|
+
* 获取运行环境信息
|
|
11
|
+
* @returns
|
|
12
|
+
*/
|
|
13
|
+
getEnvInfo(): EnvWxInfo | EnvWebInfo;
|
|
9
14
|
/**
|
|
10
15
|
* 频道事件通知回调
|
|
11
16
|
*/
|
|
@@ -34,9 +39,11 @@ declare abstract class BaseSRTC {
|
|
|
34
39
|
* 获取频道内用户信息列表
|
|
35
40
|
* @returns
|
|
36
41
|
*/
|
|
37
|
-
getUsersInfo(): BaseUserInfo
|
|
42
|
+
getUsersInfo(map: true): Record<string, BaseUserInfo>;
|
|
43
|
+
getUsersInfo(map: false): BaseUserInfo[];
|
|
38
44
|
/**
|
|
39
45
|
* 订阅远端频道混音流
|
|
46
|
+
* @param filterUids 过滤音频的用户id
|
|
40
47
|
*/
|
|
41
48
|
subscribeRemoteAudioMixTrack(filterUids?: string[]): Promise<BaseTrack>;
|
|
42
49
|
/**
|
|
@@ -71,7 +78,7 @@ declare abstract class BaseTrack extends EventEmitter {
|
|
|
71
78
|
*/
|
|
72
79
|
get desc(): string;
|
|
73
80
|
/**
|
|
74
|
-
*
|
|
81
|
+
* 获取流轨道信息
|
|
75
82
|
* @returns
|
|
76
83
|
*/
|
|
77
84
|
getInfo(): BaseTrackInfo;
|
|
@@ -88,37 +95,37 @@ declare abstract class BaseWebrtcTrack extends BaseTrack {
|
|
|
88
95
|
getMediaStreamTrack(): MediaStreamTrack | undefined;
|
|
89
96
|
}
|
|
90
97
|
declare class CommonChannelEventType {
|
|
91
|
-
/** 频道自定义props
|
|
98
|
+
/** 频道自定义props更新,对应data为ChannelInfo */
|
|
92
99
|
static readonly CHANNEL_UPDATE = "channel_update";
|
|
93
|
-
/**
|
|
100
|
+
/** 首次加入频道成功,对应data为ChannelInfo */
|
|
94
101
|
static readonly JOIN_SUCCEED = "join_succeed";
|
|
95
|
-
/**
|
|
102
|
+
/** 自己信息被改变,对应data为UserInfo */
|
|
96
103
|
static readonly ME_UPDATE = "me_update";
|
|
97
|
-
/**
|
|
104
|
+
/** 开始断线自动重连,无data */
|
|
98
105
|
static readonly RECONNECTING = "reconnecting";
|
|
99
|
-
/**
|
|
106
|
+
/** 重连成功,断线重连成功后会触发,对应data为ChannelInfo */
|
|
100
107
|
static readonly RECONNECTED = "reconnected";
|
|
101
|
-
/**
|
|
108
|
+
/** 自己被强制离开频道,对应data为DisconnectEventData */
|
|
102
109
|
static readonly DISCONNECTED = "disconnected";
|
|
103
|
-
/**
|
|
110
|
+
/** 其他用户加入频道,对应data为UserInfo */
|
|
104
111
|
static readonly USER_JOIN = "user_join";
|
|
105
|
-
/**
|
|
112
|
+
/** 其他用户信息改变,对应data为UserInfo */
|
|
106
113
|
static readonly USER_UPDATE = "user_update";
|
|
107
|
-
/**
|
|
114
|
+
/** 其他用户离开频道,对应data为UserLeaveEventData */
|
|
108
115
|
static readonly USER_LEAVE = "user_leave";
|
|
109
|
-
/**
|
|
116
|
+
/** 其他用户发布流轨道,对应data为{ user: UserInfo, track: TrackInfo } */
|
|
110
117
|
static readonly USER_TRACK_ADD = "user_track_add";
|
|
111
|
-
/**
|
|
118
|
+
/** 其他用户更新流轨道,对应data为{ user: UserInfo, track: TrackInfo } */
|
|
112
119
|
static readonly USER_TRACK_UPDATE = "user_track_update";
|
|
113
|
-
/**
|
|
120
|
+
/** 其他用户删除流轨道,对应data为{ user: UserInfo, track: TrackInfo } */
|
|
114
121
|
static readonly USER_TRACK_REMOVE = "user_track_remove";
|
|
115
|
-
/**
|
|
122
|
+
/** 频道内自定义消息,对应data为CustomMsgData */
|
|
116
123
|
static readonly CUSTOM_MSG = "custom_msg";
|
|
117
|
-
/**
|
|
124
|
+
/** 流轨道没有数据,对应data为BaseTrack */
|
|
118
125
|
static readonly TRACK_MUTED = "track_muted";
|
|
119
|
-
/**
|
|
126
|
+
/** 流轨道恢复数据,对应data为BaseTrack */
|
|
120
127
|
static readonly TRACK_UNMUTED = "track_unmuted";
|
|
121
|
-
/**
|
|
128
|
+
/** 流轨道停止,对应data为BaseTrack */
|
|
122
129
|
static readonly TRACK_ENDED = "track_ended";
|
|
123
130
|
}
|
|
124
131
|
declare enum Codec {
|
|
@@ -133,23 +140,6 @@ declare enum Codec {
|
|
|
133
140
|
/** OPUS编码 */
|
|
134
141
|
OPUS = 1398100047
|
|
135
142
|
}
|
|
136
|
-
/**
|
|
137
|
-
* 用户离开频道的原因
|
|
138
|
-
*/
|
|
139
|
-
declare enum DisconnectReason {
|
|
140
|
-
/** 错误 */
|
|
141
|
-
Error = -1,
|
|
142
|
-
/** 主动离开 */
|
|
143
|
-
Self = 1,
|
|
144
|
-
/** 被踢离开 */
|
|
145
|
-
Kicked = 2,
|
|
146
|
-
/** 被顶号 */
|
|
147
|
-
Replace = 3,
|
|
148
|
-
/** 心跳超时离开 */
|
|
149
|
-
Timeout = 4,
|
|
150
|
-
/** 频道销毁离开 */
|
|
151
|
-
Destroy = 5
|
|
152
|
-
}
|
|
153
143
|
/** 频道事件通知 */
|
|
154
144
|
export declare class ChannelEvent {
|
|
155
145
|
/** 事件类型 */
|
|
@@ -160,11 +150,11 @@ export declare class ChannelEvent {
|
|
|
160
150
|
}
|
|
161
151
|
/** 扩展的频道事件 */
|
|
162
152
|
export declare class ChannelEventType extends CommonChannelEventType {
|
|
163
|
-
/**
|
|
153
|
+
/** 外设插入,对应data为MediaDeviceInfo */
|
|
164
154
|
static readonly DEVICE_ADD = "device_add";
|
|
165
|
-
/**
|
|
155
|
+
/** 外设移除,对应data为MediaDeviceInfo */
|
|
166
156
|
static readonly DEVICE_REMOVE = "device_remove";
|
|
167
|
-
/**
|
|
157
|
+
/** 轨道自动播放失败,对应data为BaseTrack */
|
|
168
158
|
static readonly TRACK_AUTOPLAY_FAIL = "track_autoplay_fail";
|
|
169
159
|
}
|
|
170
160
|
/**
|
|
@@ -275,6 +265,10 @@ export declare class LocalVideoTrack extends BaseWebrtcTrack {
|
|
|
275
265
|
*/
|
|
276
266
|
export declare class RemoteAudioMixTrack extends RemoteAudioTrack {
|
|
277
267
|
constructor(info: BaseTrackInfo, filterUids?: string[]);
|
|
268
|
+
/**
|
|
269
|
+
* 混音流中过滤的uid
|
|
270
|
+
* @returns
|
|
271
|
+
*/
|
|
278
272
|
getFilterUids(): string[];
|
|
279
273
|
}
|
|
280
274
|
/**
|
|
@@ -311,6 +305,11 @@ export declare class RemoteVideoTrack extends BaseWebrtcTrack {
|
|
|
311
305
|
}
|
|
312
306
|
export declare class SRTC extends BaseSRTC {
|
|
313
307
|
buildInfo(): BuildInfo;
|
|
308
|
+
/**
|
|
309
|
+
* 获取web运行环境信息,如是否支持webrtc等
|
|
310
|
+
* @returns
|
|
311
|
+
*/
|
|
312
|
+
getEnvInfo(): EnvWebInfo;
|
|
314
313
|
constructor(initParams: RtcInitParams);
|
|
315
314
|
leave(): Promise<void>;
|
|
316
315
|
/**
|
|
@@ -320,16 +319,6 @@ export declare class SRTC extends BaseSRTC {
|
|
|
320
319
|
* @returns
|
|
321
320
|
*/
|
|
322
321
|
getDevices(kind?: MediaDeviceKind, requestPermissions?: boolean): Promise<MediaDeviceInfo[]>;
|
|
323
|
-
/**
|
|
324
|
-
* 获取环境信息,如是否支持webrtc等
|
|
325
|
-
* @returns
|
|
326
|
-
*/
|
|
327
|
-
getEnvInfo(): EnvWebInfo;
|
|
328
|
-
/**
|
|
329
|
-
* 将track事件转化为频道事件
|
|
330
|
-
* @param track
|
|
331
|
-
*/
|
|
332
|
-
private addTrackListeners;
|
|
333
322
|
/**
|
|
334
323
|
* 创建麦克风本地音频流
|
|
335
324
|
*/
|
|
@@ -386,28 +375,93 @@ export declare class SRTC extends BaseSRTC {
|
|
|
386
375
|
* 摄像头预设参数
|
|
387
376
|
*/
|
|
388
377
|
export declare const CameraPresets: {
|
|
378
|
+
/** 分辨率1920*1080,帧率15,码率2.5Mbps */
|
|
389
379
|
"1080p": CameraPreset;
|
|
380
|
+
/** 分辨率1280*720,帧率15,码率1.2Mbps,createLocalCameraTrack的默认预设参数 */
|
|
390
381
|
"720p": CameraPreset;
|
|
382
|
+
/** 分辨率640*360,帧率15,码率550Kbps */
|
|
391
383
|
"360p": CameraPreset;
|
|
384
|
+
/** 分辨率320*180,帧率15,码率250Kbps */
|
|
392
385
|
"180p": CameraPreset;
|
|
393
386
|
};
|
|
394
387
|
/**
|
|
395
388
|
* 麦克风预设参数
|
|
396
389
|
*/
|
|
397
390
|
export declare const MicPresets: {
|
|
391
|
+
/** 单声道,采样率48kHz,码率24Kbps */
|
|
398
392
|
speech: MicPreset;
|
|
393
|
+
/** 单声道,采样率48kHz,码率32Kbps,createLocalMicTrack的默认预设参数 */
|
|
399
394
|
music: MicPreset;
|
|
395
|
+
/** 双声道,采样率48kHz,码率48Kbps */
|
|
400
396
|
musicStereo: MicPreset;
|
|
397
|
+
/** 单声道,采样率48kHz,码率64Kbps */
|
|
401
398
|
musicHighQuality: MicPreset;
|
|
399
|
+
/** 双声道,采样率48kHz,码率96Kbps */
|
|
402
400
|
musicHighQualityStereo: MicPreset;
|
|
403
401
|
};
|
|
404
402
|
/**
|
|
405
403
|
* 屏幕共享预设参数
|
|
406
404
|
*/
|
|
407
405
|
export declare const ScreenPresets: {
|
|
406
|
+
/** 分辨率1920*1080,帧率10,码率2Mbps,createLocalScreenTrack时的默认预设参数 */
|
|
408
407
|
"1080p": ScreenPreset;
|
|
408
|
+
/** 分辨率1280*720,帧率10,码率1.5Mbps */
|
|
409
409
|
"720p": ScreenPreset;
|
|
410
410
|
};
|
|
411
|
+
/**
|
|
412
|
+
* 终端类型枚举
|
|
413
|
+
*/
|
|
414
|
+
export declare enum DeviceType {
|
|
415
|
+
/**
|
|
416
|
+
* 未知设备
|
|
417
|
+
*/
|
|
418
|
+
Unknown = 0,
|
|
419
|
+
/**
|
|
420
|
+
* Windows
|
|
421
|
+
*/
|
|
422
|
+
Windows = 1,
|
|
423
|
+
/**
|
|
424
|
+
* Android
|
|
425
|
+
*/
|
|
426
|
+
Android = 2,
|
|
427
|
+
/**
|
|
428
|
+
* iOS
|
|
429
|
+
*/
|
|
430
|
+
IOS = 3,
|
|
431
|
+
/**
|
|
432
|
+
* Linux
|
|
433
|
+
*/
|
|
434
|
+
Linux = 4,
|
|
435
|
+
/**
|
|
436
|
+
* MacOS
|
|
437
|
+
*/
|
|
438
|
+
MacOS = 5,
|
|
439
|
+
/**
|
|
440
|
+
* webrtc
|
|
441
|
+
*/
|
|
442
|
+
WebRTC = 6,
|
|
443
|
+
/**
|
|
444
|
+
* 小程序
|
|
445
|
+
*/
|
|
446
|
+
XCX = 7
|
|
447
|
+
}
|
|
448
|
+
/**
|
|
449
|
+
* 用户离开频道的原因
|
|
450
|
+
*/
|
|
451
|
+
export declare enum DisconnectReason {
|
|
452
|
+
/** 错误 */
|
|
453
|
+
Error = -1,
|
|
454
|
+
/** 主动离开 */
|
|
455
|
+
Self = 1,
|
|
456
|
+
/** 被踢离开 */
|
|
457
|
+
Kicked = 2,
|
|
458
|
+
/** 被顶号 */
|
|
459
|
+
Replace = 3,
|
|
460
|
+
/** 心跳超时离开 */
|
|
461
|
+
Timeout = 4,
|
|
462
|
+
/** 频道销毁离开 */
|
|
463
|
+
Destroy = 5
|
|
464
|
+
}
|
|
411
465
|
/**
|
|
412
466
|
* 日志打印等级
|
|
413
467
|
*/
|
|
@@ -517,6 +571,21 @@ export interface CameraPreset {
|
|
|
517
571
|
capture: CameraCaptureOptions;
|
|
518
572
|
publish: VideoPublishOptions;
|
|
519
573
|
}
|
|
574
|
+
/**
|
|
575
|
+
* 自定义消息
|
|
576
|
+
*/
|
|
577
|
+
export interface CustomMsgData {
|
|
578
|
+
/** 消息命令 */
|
|
579
|
+
action: string;
|
|
580
|
+
/** 消息体 */
|
|
581
|
+
content: any;
|
|
582
|
+
/** 发送者会话id */
|
|
583
|
+
sid: string;
|
|
584
|
+
/** 发送者ID */
|
|
585
|
+
uid: string;
|
|
586
|
+
/** 频道名(如果非频道内自定义消息,为空) */
|
|
587
|
+
channel: string;
|
|
588
|
+
}
|
|
520
589
|
/**
|
|
521
590
|
* 强制离开事件data
|
|
522
591
|
*/
|
|
@@ -527,7 +596,7 @@ export interface DisconnectEventData {
|
|
|
527
596
|
error?: any;
|
|
528
597
|
}
|
|
529
598
|
/**
|
|
530
|
-
* web
|
|
599
|
+
* web环境详情
|
|
531
600
|
*/
|
|
532
601
|
export interface EnvWebInfo extends Bowser$1.Parser.ParsedResult {
|
|
533
602
|
/**
|
|
@@ -611,6 +680,13 @@ export interface EnvWebInfo extends Bowser$1.Parser.ParsedResult {
|
|
|
611
680
|
*/
|
|
612
681
|
devicePixelRatio: number;
|
|
613
682
|
}
|
|
683
|
+
/**
|
|
684
|
+
* 微信小程序环境详情
|
|
685
|
+
*/
|
|
686
|
+
export interface EnvWxInfo {
|
|
687
|
+
system: WechatMiniprogram.SystemInfo;
|
|
688
|
+
device: WechatMiniprogram.DeviceInfo;
|
|
689
|
+
}
|
|
614
690
|
/**
|
|
615
691
|
* 加入频道选项
|
|
616
692
|
*/
|
|
@@ -760,16 +836,6 @@ interface BaseChannelInfo {
|
|
|
760
836
|
created_at: number;
|
|
761
837
|
/** 频道更新时间 */
|
|
762
838
|
updated_at: number;
|
|
763
|
-
/** 流媒体连接id */
|
|
764
|
-
link_id: number;
|
|
765
|
-
/** 房间最大人数,含义参考:https://www.yuque.com/anyconf/czwlh6/prtk0l4s8ylf7mk3 */
|
|
766
|
-
max_user: number;
|
|
767
|
-
/** 房间最大参与音频能量竞争路数(针对整个房间设置) */
|
|
768
|
-
max_speech: number;
|
|
769
|
-
/** 单人最大转发的人数(音频、视频路数)(针对单人设置) */
|
|
770
|
-
max_peer: number;
|
|
771
|
-
/** 单人非主动pick模式下最大转发视频路数(针对单人设置,目前我们视频都是主动pick,所以这个设置没有意义) */
|
|
772
|
-
max_video: number;
|
|
773
839
|
}
|
|
774
840
|
/**
|
|
775
841
|
* 流轨道信息
|
|
@@ -797,8 +863,6 @@ interface BaseTrackInfo {
|
|
|
797
863
|
sampleRate: number;
|
|
798
864
|
/** 流扩展属性 */
|
|
799
865
|
props?: Record<string, any>;
|
|
800
|
-
/** 轨道号 */
|
|
801
|
-
track: number;
|
|
802
866
|
}
|
|
803
867
|
/**
|
|
804
868
|
* 用户信息
|
|
@@ -811,7 +875,7 @@ interface BaseUserInfo {
|
|
|
811
875
|
/** 会中昵称 */
|
|
812
876
|
name: string;
|
|
813
877
|
/** 设备类型 */
|
|
814
|
-
device_type:
|
|
878
|
+
device_type: DeviceType;
|
|
815
879
|
/** 设备ID */
|
|
816
880
|
device_id: string;
|
|
817
881
|
/** 客户端RTCsdk版本号 */
|
|
@@ -836,16 +900,11 @@ interface BaseUserInfo {
|
|
|
836
900
|
leave_at: number;
|
|
837
901
|
/** 流轨道 */
|
|
838
902
|
stream_tracks?: BaseTrackInfo[];
|
|
839
|
-
/** 流媒体连接id */
|
|
840
|
-
link_id: number;
|
|
841
|
-
/** 流媒体服务器id */
|
|
842
|
-
upload_id: string;
|
|
843
903
|
}
|
|
844
904
|
|
|
845
905
|
export {
|
|
846
906
|
BaseChannelInfo as ChannelInfo,
|
|
847
907
|
BaseTrackInfo as TrackInfo,
|
|
848
908
|
BaseUserInfo as UserInfo,
|
|
849
|
-
DisconnectReason as LeaveReason,
|
|
850
909
|
};
|
|
851
910
|
|