@seastart/srtc-web-sdk 0.0.5 → 0.0.7
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 +95 -45
- package/srtc.d.ts +95 -45
- package/srtc.js +1 -1
- package/srtc.mjs +1 -1
package/package.json
CHANGED
package/srtc.d.mts
CHANGED
|
@@ -43,6 +43,7 @@ declare abstract class BaseSRTC {
|
|
|
43
43
|
getUsersInfo(map: false): BaseUserInfo[];
|
|
44
44
|
/**
|
|
45
45
|
* 订阅远端频道混音流
|
|
46
|
+
* @param filterUids 过滤音频的用户id
|
|
46
47
|
*/
|
|
47
48
|
subscribeRemoteAudioMixTrack(filterUids?: string[]): Promise<BaseTrack>;
|
|
48
49
|
/**
|
|
@@ -77,7 +78,7 @@ declare abstract class BaseTrack extends EventEmitter {
|
|
|
77
78
|
*/
|
|
78
79
|
get desc(): string;
|
|
79
80
|
/**
|
|
80
|
-
*
|
|
81
|
+
* 获取流轨道信息
|
|
81
82
|
* @returns
|
|
82
83
|
*/
|
|
83
84
|
getInfo(): BaseTrackInfo;
|
|
@@ -94,37 +95,37 @@ declare abstract class BaseWebrtcTrack extends BaseTrack {
|
|
|
94
95
|
getMediaStreamTrack(): MediaStreamTrack | undefined;
|
|
95
96
|
}
|
|
96
97
|
declare class CommonChannelEventType {
|
|
97
|
-
/** 频道自定义props
|
|
98
|
+
/** 频道自定义props更新,对应data为ChannelInfo */
|
|
98
99
|
static readonly CHANNEL_UPDATE = "channel_update";
|
|
99
|
-
/**
|
|
100
|
+
/** 首次加入频道成功,对应data为ChannelInfo */
|
|
100
101
|
static readonly JOIN_SUCCEED = "join_succeed";
|
|
101
|
-
/**
|
|
102
|
+
/** 自己信息被改变,对应data为UserInfo */
|
|
102
103
|
static readonly ME_UPDATE = "me_update";
|
|
103
|
-
/**
|
|
104
|
+
/** 开始断线自动重连,无data */
|
|
104
105
|
static readonly RECONNECTING = "reconnecting";
|
|
105
|
-
/**
|
|
106
|
+
/** 重连成功,断线重连成功后会触发,对应data为ChannelInfo */
|
|
106
107
|
static readonly RECONNECTED = "reconnected";
|
|
107
|
-
/**
|
|
108
|
+
/** 自己被强制离开频道,对应data为DisconnectEventData */
|
|
108
109
|
static readonly DISCONNECTED = "disconnected";
|
|
109
|
-
/**
|
|
110
|
+
/** 其他用户加入频道,对应data为UserInfo */
|
|
110
111
|
static readonly USER_JOIN = "user_join";
|
|
111
|
-
/**
|
|
112
|
+
/** 其他用户信息改变,对应data为UserInfo */
|
|
112
113
|
static readonly USER_UPDATE = "user_update";
|
|
113
|
-
/**
|
|
114
|
+
/** 其他用户离开频道,对应data为UserLeaveEventData */
|
|
114
115
|
static readonly USER_LEAVE = "user_leave";
|
|
115
|
-
/**
|
|
116
|
+
/** 其他用户发布流轨道,对应data为{ user: UserInfo, track: TrackInfo } */
|
|
116
117
|
static readonly USER_TRACK_ADD = "user_track_add";
|
|
117
|
-
/**
|
|
118
|
+
/** 其他用户更新流轨道,对应data为{ user: UserInfo, track: TrackInfo } */
|
|
118
119
|
static readonly USER_TRACK_UPDATE = "user_track_update";
|
|
119
|
-
/**
|
|
120
|
+
/** 其他用户删除流轨道,对应data为{ user: UserInfo, track: TrackInfo } */
|
|
120
121
|
static readonly USER_TRACK_REMOVE = "user_track_remove";
|
|
121
|
-
/**
|
|
122
|
+
/** 频道内自定义消息,对应data为CustomMsgData */
|
|
122
123
|
static readonly CUSTOM_MSG = "custom_msg";
|
|
123
|
-
/**
|
|
124
|
+
/** 流轨道没有数据,对应data为BaseTrack */
|
|
124
125
|
static readonly TRACK_MUTED = "track_muted";
|
|
125
|
-
/**
|
|
126
|
+
/** 流轨道恢复数据,对应data为BaseTrack */
|
|
126
127
|
static readonly TRACK_UNMUTED = "track_unmuted";
|
|
127
|
-
/**
|
|
128
|
+
/** 流轨道停止,对应data为BaseTrack */
|
|
128
129
|
static readonly TRACK_ENDED = "track_ended";
|
|
129
130
|
}
|
|
130
131
|
declare enum Codec {
|
|
@@ -149,11 +150,11 @@ export declare class ChannelEvent {
|
|
|
149
150
|
}
|
|
150
151
|
/** 扩展的频道事件 */
|
|
151
152
|
export declare class ChannelEventType extends CommonChannelEventType {
|
|
152
|
-
/**
|
|
153
|
+
/** 外设插入,对应data为MediaDeviceInfo */
|
|
153
154
|
static readonly DEVICE_ADD = "device_add";
|
|
154
|
-
/**
|
|
155
|
+
/** 外设移除,对应data为MediaDeviceInfo */
|
|
155
156
|
static readonly DEVICE_REMOVE = "device_remove";
|
|
156
|
-
/**
|
|
157
|
+
/** 轨道自动播放失败,对应data为BaseTrack */
|
|
157
158
|
static readonly TRACK_AUTOPLAY_FAIL = "track_autoplay_fail";
|
|
158
159
|
}
|
|
159
160
|
/**
|
|
@@ -264,6 +265,10 @@ export declare class LocalVideoTrack extends BaseWebrtcTrack {
|
|
|
264
265
|
*/
|
|
265
266
|
export declare class RemoteAudioMixTrack extends RemoteAudioTrack {
|
|
266
267
|
constructor(info: BaseTrackInfo, filterUids?: string[]);
|
|
268
|
+
/**
|
|
269
|
+
* 混音流中过滤的uid
|
|
270
|
+
* @returns
|
|
271
|
+
*/
|
|
267
272
|
getFilterUids(): string[];
|
|
268
273
|
}
|
|
269
274
|
/**
|
|
@@ -314,13 +319,9 @@ export declare class SRTC extends BaseSRTC {
|
|
|
314
319
|
* @returns
|
|
315
320
|
*/
|
|
316
321
|
getDevices(kind?: MediaDeviceKind, requestPermissions?: boolean): Promise<MediaDeviceInfo[]>;
|
|
317
|
-
/**
|
|
318
|
-
* 将track事件转化为频道事件
|
|
319
|
-
* @param track
|
|
320
|
-
*/
|
|
321
|
-
private addTrackListeners;
|
|
322
322
|
/**
|
|
323
323
|
* 创建麦克风本地音频流
|
|
324
|
+
* @param preset 麦克风预设,默认为 MicPresets.music
|
|
324
325
|
*/
|
|
325
326
|
createLocalMicTrack(preset?: MicPreset): LocalMicTrack;
|
|
326
327
|
/**
|
|
@@ -329,10 +330,12 @@ export declare class SRTC extends BaseSRTC {
|
|
|
329
330
|
createLocalCustomAudioTrack(msTrack: MediaStreamTrack): LocalAudioTrack;
|
|
330
331
|
/**
|
|
331
332
|
* 创建摄像头本地视频流
|
|
333
|
+
* @param preset 摄像头预设,默认为 CameraPresets["720p"]
|
|
332
334
|
*/
|
|
333
335
|
createLocalCameraTrack(preset?: CameraPreset): LocalCameraTrack;
|
|
334
336
|
/**
|
|
335
|
-
*
|
|
337
|
+
* 创建屏幕共享本地视频流
|
|
338
|
+
* @param preset 屏幕共享预设,默认为 ScreenPresets["1080p"]
|
|
336
339
|
*/
|
|
337
340
|
createLocalScreenTrack(preset?: ScreenPreset): LocalScreenTrack;
|
|
338
341
|
/**
|
|
@@ -375,28 +378,76 @@ export declare class SRTC extends BaseSRTC {
|
|
|
375
378
|
* 摄像头预设参数
|
|
376
379
|
*/
|
|
377
380
|
export declare const CameraPresets: {
|
|
381
|
+
/** 分辨率1920*1080,帧率15,码率2.5Mbps */
|
|
378
382
|
"1080p": CameraPreset;
|
|
383
|
+
/** 分辨率1280*720,帧率15,码率1.2Mbps,createLocalCameraTrack的默认预设参数 */
|
|
379
384
|
"720p": CameraPreset;
|
|
385
|
+
/** 分辨率640*360,帧率15,码率550Kbps */
|
|
380
386
|
"360p": CameraPreset;
|
|
387
|
+
/** 分辨率320*180,帧率15,码率250Kbps */
|
|
381
388
|
"180p": CameraPreset;
|
|
382
389
|
};
|
|
383
390
|
/**
|
|
384
391
|
* 麦克风预设参数
|
|
385
392
|
*/
|
|
386
393
|
export declare const MicPresets: {
|
|
394
|
+
/** 单声道,采样率48kHz,码率24Kbps */
|
|
387
395
|
speech: MicPreset;
|
|
396
|
+
/** 单声道,采样率48kHz,码率32Kbps,createLocalMicTrack的默认预设参数 */
|
|
388
397
|
music: MicPreset;
|
|
398
|
+
/** 双声道,采样率48kHz,码率48Kbps */
|
|
389
399
|
musicStereo: MicPreset;
|
|
400
|
+
/** 单声道,采样率48kHz,码率64Kbps */
|
|
390
401
|
musicHighQuality: MicPreset;
|
|
402
|
+
/** 双声道,采样率48kHz,码率96Kbps */
|
|
391
403
|
musicHighQualityStereo: MicPreset;
|
|
392
404
|
};
|
|
393
405
|
/**
|
|
394
406
|
* 屏幕共享预设参数
|
|
395
407
|
*/
|
|
396
408
|
export declare const ScreenPresets: {
|
|
409
|
+
/** 分辨率1920*1080,帧率10,码率2Mbps,createLocalScreenTrack时的默认预设参数 */
|
|
397
410
|
"1080p": ScreenPreset;
|
|
411
|
+
/** 分辨率1280*720,帧率10,码率1.5Mbps */
|
|
398
412
|
"720p": ScreenPreset;
|
|
399
413
|
};
|
|
414
|
+
/**
|
|
415
|
+
* 终端类型枚举
|
|
416
|
+
*/
|
|
417
|
+
export declare enum DeviceType {
|
|
418
|
+
/**
|
|
419
|
+
* 未知设备
|
|
420
|
+
*/
|
|
421
|
+
Unknown = 0,
|
|
422
|
+
/**
|
|
423
|
+
* Windows
|
|
424
|
+
*/
|
|
425
|
+
Windows = 1,
|
|
426
|
+
/**
|
|
427
|
+
* Android
|
|
428
|
+
*/
|
|
429
|
+
Android = 2,
|
|
430
|
+
/**
|
|
431
|
+
* iOS
|
|
432
|
+
*/
|
|
433
|
+
IOS = 3,
|
|
434
|
+
/**
|
|
435
|
+
* Linux
|
|
436
|
+
*/
|
|
437
|
+
Linux = 4,
|
|
438
|
+
/**
|
|
439
|
+
* MacOS
|
|
440
|
+
*/
|
|
441
|
+
MacOS = 5,
|
|
442
|
+
/**
|
|
443
|
+
* webrtc
|
|
444
|
+
*/
|
|
445
|
+
WebRTC = 6,
|
|
446
|
+
/**
|
|
447
|
+
* 小程序
|
|
448
|
+
*/
|
|
449
|
+
XCX = 7
|
|
450
|
+
}
|
|
400
451
|
/**
|
|
401
452
|
* 用户离开频道的原因
|
|
402
453
|
*/
|
|
@@ -523,6 +574,21 @@ export interface CameraPreset {
|
|
|
523
574
|
capture: CameraCaptureOptions;
|
|
524
575
|
publish: VideoPublishOptions;
|
|
525
576
|
}
|
|
577
|
+
/**
|
|
578
|
+
* 自定义消息
|
|
579
|
+
*/
|
|
580
|
+
export interface CustomMsgData {
|
|
581
|
+
/** 消息命令 */
|
|
582
|
+
action: string;
|
|
583
|
+
/** 消息体 */
|
|
584
|
+
content: any;
|
|
585
|
+
/** 发送者会话id */
|
|
586
|
+
sid: string;
|
|
587
|
+
/** 发送者ID */
|
|
588
|
+
uid: string;
|
|
589
|
+
/** 频道名(如果非频道内自定义消息,为空) */
|
|
590
|
+
channel: string;
|
|
591
|
+
}
|
|
526
592
|
/**
|
|
527
593
|
* 强制离开事件data
|
|
528
594
|
*/
|
|
@@ -533,7 +599,7 @@ export interface DisconnectEventData {
|
|
|
533
599
|
error?: any;
|
|
534
600
|
}
|
|
535
601
|
/**
|
|
536
|
-
* web
|
|
602
|
+
* web环境详情
|
|
537
603
|
*/
|
|
538
604
|
export interface EnvWebInfo extends Bowser$1.Parser.ParsedResult {
|
|
539
605
|
/**
|
|
@@ -717,7 +783,7 @@ export interface ScreenCaptureOptions {
|
|
|
717
783
|
};
|
|
718
784
|
}
|
|
719
785
|
/**
|
|
720
|
-
*
|
|
786
|
+
* 屏幕共享预设值
|
|
721
787
|
*/
|
|
722
788
|
export interface ScreenPreset {
|
|
723
789
|
capture: ScreenCaptureOptions;
|
|
@@ -773,16 +839,6 @@ interface BaseChannelInfo {
|
|
|
773
839
|
created_at: number;
|
|
774
840
|
/** 频道更新时间 */
|
|
775
841
|
updated_at: number;
|
|
776
|
-
/** 流媒体连接id */
|
|
777
|
-
link_id: number;
|
|
778
|
-
/** 房间最大人数,含义参考:https://www.yuque.com/anyconf/czwlh6/prtk0l4s8ylf7mk3 */
|
|
779
|
-
max_user: number;
|
|
780
|
-
/** 房间最大参与音频能量竞争路数(针对整个房间设置) */
|
|
781
|
-
max_speech: number;
|
|
782
|
-
/** 单人最大转发的人数(音频、视频路数)(针对单人设置) */
|
|
783
|
-
max_peer: number;
|
|
784
|
-
/** 单人非主动pick模式下最大转发视频路数(针对单人设置,目前我们视频都是主动pick,所以这个设置没有意义) */
|
|
785
|
-
max_video: number;
|
|
786
842
|
}
|
|
787
843
|
/**
|
|
788
844
|
* 流轨道信息
|
|
@@ -810,8 +866,6 @@ interface BaseTrackInfo {
|
|
|
810
866
|
sampleRate: number;
|
|
811
867
|
/** 流扩展属性 */
|
|
812
868
|
props?: Record<string, any>;
|
|
813
|
-
/** 轨道号 */
|
|
814
|
-
track: number;
|
|
815
869
|
}
|
|
816
870
|
/**
|
|
817
871
|
* 用户信息
|
|
@@ -824,7 +878,7 @@ interface BaseUserInfo {
|
|
|
824
878
|
/** 会中昵称 */
|
|
825
879
|
name: string;
|
|
826
880
|
/** 设备类型 */
|
|
827
|
-
device_type:
|
|
881
|
+
device_type: DeviceType;
|
|
828
882
|
/** 设备ID */
|
|
829
883
|
device_id: string;
|
|
830
884
|
/** 客户端RTCsdk版本号 */
|
|
@@ -849,10 +903,6 @@ interface BaseUserInfo {
|
|
|
849
903
|
leave_at: number;
|
|
850
904
|
/** 流轨道 */
|
|
851
905
|
stream_tracks?: BaseTrackInfo[];
|
|
852
|
-
/** 流媒体连接id */
|
|
853
|
-
link_id: number;
|
|
854
|
-
/** 流媒体服务器id */
|
|
855
|
-
upload_id: string;
|
|
856
906
|
}
|
|
857
907
|
|
|
858
908
|
export {
|
package/srtc.d.ts
CHANGED
|
@@ -43,6 +43,7 @@ declare abstract class BaseSRTC {
|
|
|
43
43
|
getUsersInfo(map: false): BaseUserInfo[];
|
|
44
44
|
/**
|
|
45
45
|
* 订阅远端频道混音流
|
|
46
|
+
* @param filterUids 过滤音频的用户id
|
|
46
47
|
*/
|
|
47
48
|
subscribeRemoteAudioMixTrack(filterUids?: string[]): Promise<BaseTrack>;
|
|
48
49
|
/**
|
|
@@ -77,7 +78,7 @@ declare abstract class BaseTrack extends EventEmitter {
|
|
|
77
78
|
*/
|
|
78
79
|
get desc(): string;
|
|
79
80
|
/**
|
|
80
|
-
*
|
|
81
|
+
* 获取流轨道信息
|
|
81
82
|
* @returns
|
|
82
83
|
*/
|
|
83
84
|
getInfo(): BaseTrackInfo;
|
|
@@ -94,37 +95,37 @@ declare abstract class BaseWebrtcTrack extends BaseTrack {
|
|
|
94
95
|
getMediaStreamTrack(): MediaStreamTrack | undefined;
|
|
95
96
|
}
|
|
96
97
|
declare class CommonChannelEventType {
|
|
97
|
-
/** 频道自定义props
|
|
98
|
+
/** 频道自定义props更新,对应data为ChannelInfo */
|
|
98
99
|
static readonly CHANNEL_UPDATE = "channel_update";
|
|
99
|
-
/**
|
|
100
|
+
/** 首次加入频道成功,对应data为ChannelInfo */
|
|
100
101
|
static readonly JOIN_SUCCEED = "join_succeed";
|
|
101
|
-
/**
|
|
102
|
+
/** 自己信息被改变,对应data为UserInfo */
|
|
102
103
|
static readonly ME_UPDATE = "me_update";
|
|
103
|
-
/**
|
|
104
|
+
/** 开始断线自动重连,无data */
|
|
104
105
|
static readonly RECONNECTING = "reconnecting";
|
|
105
|
-
/**
|
|
106
|
+
/** 重连成功,断线重连成功后会触发,对应data为ChannelInfo */
|
|
106
107
|
static readonly RECONNECTED = "reconnected";
|
|
107
|
-
/**
|
|
108
|
+
/** 自己被强制离开频道,对应data为DisconnectEventData */
|
|
108
109
|
static readonly DISCONNECTED = "disconnected";
|
|
109
|
-
/**
|
|
110
|
+
/** 其他用户加入频道,对应data为UserInfo */
|
|
110
111
|
static readonly USER_JOIN = "user_join";
|
|
111
|
-
/**
|
|
112
|
+
/** 其他用户信息改变,对应data为UserInfo */
|
|
112
113
|
static readonly USER_UPDATE = "user_update";
|
|
113
|
-
/**
|
|
114
|
+
/** 其他用户离开频道,对应data为UserLeaveEventData */
|
|
114
115
|
static readonly USER_LEAVE = "user_leave";
|
|
115
|
-
/**
|
|
116
|
+
/** 其他用户发布流轨道,对应data为{ user: UserInfo, track: TrackInfo } */
|
|
116
117
|
static readonly USER_TRACK_ADD = "user_track_add";
|
|
117
|
-
/**
|
|
118
|
+
/** 其他用户更新流轨道,对应data为{ user: UserInfo, track: TrackInfo } */
|
|
118
119
|
static readonly USER_TRACK_UPDATE = "user_track_update";
|
|
119
|
-
/**
|
|
120
|
+
/** 其他用户删除流轨道,对应data为{ user: UserInfo, track: TrackInfo } */
|
|
120
121
|
static readonly USER_TRACK_REMOVE = "user_track_remove";
|
|
121
|
-
/**
|
|
122
|
+
/** 频道内自定义消息,对应data为CustomMsgData */
|
|
122
123
|
static readonly CUSTOM_MSG = "custom_msg";
|
|
123
|
-
/**
|
|
124
|
+
/** 流轨道没有数据,对应data为BaseTrack */
|
|
124
125
|
static readonly TRACK_MUTED = "track_muted";
|
|
125
|
-
/**
|
|
126
|
+
/** 流轨道恢复数据,对应data为BaseTrack */
|
|
126
127
|
static readonly TRACK_UNMUTED = "track_unmuted";
|
|
127
|
-
/**
|
|
128
|
+
/** 流轨道停止,对应data为BaseTrack */
|
|
128
129
|
static readonly TRACK_ENDED = "track_ended";
|
|
129
130
|
}
|
|
130
131
|
declare enum Codec {
|
|
@@ -149,11 +150,11 @@ export declare class ChannelEvent {
|
|
|
149
150
|
}
|
|
150
151
|
/** 扩展的频道事件 */
|
|
151
152
|
export declare class ChannelEventType extends CommonChannelEventType {
|
|
152
|
-
/**
|
|
153
|
+
/** 外设插入,对应data为MediaDeviceInfo */
|
|
153
154
|
static readonly DEVICE_ADD = "device_add";
|
|
154
|
-
/**
|
|
155
|
+
/** 外设移除,对应data为MediaDeviceInfo */
|
|
155
156
|
static readonly DEVICE_REMOVE = "device_remove";
|
|
156
|
-
/**
|
|
157
|
+
/** 轨道自动播放失败,对应data为BaseTrack */
|
|
157
158
|
static readonly TRACK_AUTOPLAY_FAIL = "track_autoplay_fail";
|
|
158
159
|
}
|
|
159
160
|
/**
|
|
@@ -264,6 +265,10 @@ export declare class LocalVideoTrack extends BaseWebrtcTrack {
|
|
|
264
265
|
*/
|
|
265
266
|
export declare class RemoteAudioMixTrack extends RemoteAudioTrack {
|
|
266
267
|
constructor(info: BaseTrackInfo, filterUids?: string[]);
|
|
268
|
+
/**
|
|
269
|
+
* 混音流中过滤的uid
|
|
270
|
+
* @returns
|
|
271
|
+
*/
|
|
267
272
|
getFilterUids(): string[];
|
|
268
273
|
}
|
|
269
274
|
/**
|
|
@@ -314,13 +319,9 @@ export declare class SRTC extends BaseSRTC {
|
|
|
314
319
|
* @returns
|
|
315
320
|
*/
|
|
316
321
|
getDevices(kind?: MediaDeviceKind, requestPermissions?: boolean): Promise<MediaDeviceInfo[]>;
|
|
317
|
-
/**
|
|
318
|
-
* 将track事件转化为频道事件
|
|
319
|
-
* @param track
|
|
320
|
-
*/
|
|
321
|
-
private addTrackListeners;
|
|
322
322
|
/**
|
|
323
323
|
* 创建麦克风本地音频流
|
|
324
|
+
* @param preset 麦克风预设,默认为 MicPresets.music
|
|
324
325
|
*/
|
|
325
326
|
createLocalMicTrack(preset?: MicPreset): LocalMicTrack;
|
|
326
327
|
/**
|
|
@@ -329,10 +330,12 @@ export declare class SRTC extends BaseSRTC {
|
|
|
329
330
|
createLocalCustomAudioTrack(msTrack: MediaStreamTrack): LocalAudioTrack;
|
|
330
331
|
/**
|
|
331
332
|
* 创建摄像头本地视频流
|
|
333
|
+
* @param preset 摄像头预设,默认为 CameraPresets["720p"]
|
|
332
334
|
*/
|
|
333
335
|
createLocalCameraTrack(preset?: CameraPreset): LocalCameraTrack;
|
|
334
336
|
/**
|
|
335
|
-
*
|
|
337
|
+
* 创建屏幕共享本地视频流
|
|
338
|
+
* @param preset 屏幕共享预设,默认为 ScreenPresets["1080p"]
|
|
336
339
|
*/
|
|
337
340
|
createLocalScreenTrack(preset?: ScreenPreset): LocalScreenTrack;
|
|
338
341
|
/**
|
|
@@ -375,28 +378,76 @@ export declare class SRTC extends BaseSRTC {
|
|
|
375
378
|
* 摄像头预设参数
|
|
376
379
|
*/
|
|
377
380
|
export declare const CameraPresets: {
|
|
381
|
+
/** 分辨率1920*1080,帧率15,码率2.5Mbps */
|
|
378
382
|
"1080p": CameraPreset;
|
|
383
|
+
/** 分辨率1280*720,帧率15,码率1.2Mbps,createLocalCameraTrack的默认预设参数 */
|
|
379
384
|
"720p": CameraPreset;
|
|
385
|
+
/** 分辨率640*360,帧率15,码率550Kbps */
|
|
380
386
|
"360p": CameraPreset;
|
|
387
|
+
/** 分辨率320*180,帧率15,码率250Kbps */
|
|
381
388
|
"180p": CameraPreset;
|
|
382
389
|
};
|
|
383
390
|
/**
|
|
384
391
|
* 麦克风预设参数
|
|
385
392
|
*/
|
|
386
393
|
export declare const MicPresets: {
|
|
394
|
+
/** 单声道,采样率48kHz,码率24Kbps */
|
|
387
395
|
speech: MicPreset;
|
|
396
|
+
/** 单声道,采样率48kHz,码率32Kbps,createLocalMicTrack的默认预设参数 */
|
|
388
397
|
music: MicPreset;
|
|
398
|
+
/** 双声道,采样率48kHz,码率48Kbps */
|
|
389
399
|
musicStereo: MicPreset;
|
|
400
|
+
/** 单声道,采样率48kHz,码率64Kbps */
|
|
390
401
|
musicHighQuality: MicPreset;
|
|
402
|
+
/** 双声道,采样率48kHz,码率96Kbps */
|
|
391
403
|
musicHighQualityStereo: MicPreset;
|
|
392
404
|
};
|
|
393
405
|
/**
|
|
394
406
|
* 屏幕共享预设参数
|
|
395
407
|
*/
|
|
396
408
|
export declare const ScreenPresets: {
|
|
409
|
+
/** 分辨率1920*1080,帧率10,码率2Mbps,createLocalScreenTrack时的默认预设参数 */
|
|
397
410
|
"1080p": ScreenPreset;
|
|
411
|
+
/** 分辨率1280*720,帧率10,码率1.5Mbps */
|
|
398
412
|
"720p": ScreenPreset;
|
|
399
413
|
};
|
|
414
|
+
/**
|
|
415
|
+
* 终端类型枚举
|
|
416
|
+
*/
|
|
417
|
+
export declare enum DeviceType {
|
|
418
|
+
/**
|
|
419
|
+
* 未知设备
|
|
420
|
+
*/
|
|
421
|
+
Unknown = 0,
|
|
422
|
+
/**
|
|
423
|
+
* Windows
|
|
424
|
+
*/
|
|
425
|
+
Windows = 1,
|
|
426
|
+
/**
|
|
427
|
+
* Android
|
|
428
|
+
*/
|
|
429
|
+
Android = 2,
|
|
430
|
+
/**
|
|
431
|
+
* iOS
|
|
432
|
+
*/
|
|
433
|
+
IOS = 3,
|
|
434
|
+
/**
|
|
435
|
+
* Linux
|
|
436
|
+
*/
|
|
437
|
+
Linux = 4,
|
|
438
|
+
/**
|
|
439
|
+
* MacOS
|
|
440
|
+
*/
|
|
441
|
+
MacOS = 5,
|
|
442
|
+
/**
|
|
443
|
+
* webrtc
|
|
444
|
+
*/
|
|
445
|
+
WebRTC = 6,
|
|
446
|
+
/**
|
|
447
|
+
* 小程序
|
|
448
|
+
*/
|
|
449
|
+
XCX = 7
|
|
450
|
+
}
|
|
400
451
|
/**
|
|
401
452
|
* 用户离开频道的原因
|
|
402
453
|
*/
|
|
@@ -523,6 +574,21 @@ export interface CameraPreset {
|
|
|
523
574
|
capture: CameraCaptureOptions;
|
|
524
575
|
publish: VideoPublishOptions;
|
|
525
576
|
}
|
|
577
|
+
/**
|
|
578
|
+
* 自定义消息
|
|
579
|
+
*/
|
|
580
|
+
export interface CustomMsgData {
|
|
581
|
+
/** 消息命令 */
|
|
582
|
+
action: string;
|
|
583
|
+
/** 消息体 */
|
|
584
|
+
content: any;
|
|
585
|
+
/** 发送者会话id */
|
|
586
|
+
sid: string;
|
|
587
|
+
/** 发送者ID */
|
|
588
|
+
uid: string;
|
|
589
|
+
/** 频道名(如果非频道内自定义消息,为空) */
|
|
590
|
+
channel: string;
|
|
591
|
+
}
|
|
526
592
|
/**
|
|
527
593
|
* 强制离开事件data
|
|
528
594
|
*/
|
|
@@ -533,7 +599,7 @@ export interface DisconnectEventData {
|
|
|
533
599
|
error?: any;
|
|
534
600
|
}
|
|
535
601
|
/**
|
|
536
|
-
* web
|
|
602
|
+
* web环境详情
|
|
537
603
|
*/
|
|
538
604
|
export interface EnvWebInfo extends Bowser$1.Parser.ParsedResult {
|
|
539
605
|
/**
|
|
@@ -717,7 +783,7 @@ export interface ScreenCaptureOptions {
|
|
|
717
783
|
};
|
|
718
784
|
}
|
|
719
785
|
/**
|
|
720
|
-
*
|
|
786
|
+
* 屏幕共享预设值
|
|
721
787
|
*/
|
|
722
788
|
export interface ScreenPreset {
|
|
723
789
|
capture: ScreenCaptureOptions;
|
|
@@ -773,16 +839,6 @@ interface BaseChannelInfo {
|
|
|
773
839
|
created_at: number;
|
|
774
840
|
/** 频道更新时间 */
|
|
775
841
|
updated_at: number;
|
|
776
|
-
/** 流媒体连接id */
|
|
777
|
-
link_id: number;
|
|
778
|
-
/** 房间最大人数,含义参考:https://www.yuque.com/anyconf/czwlh6/prtk0l4s8ylf7mk3 */
|
|
779
|
-
max_user: number;
|
|
780
|
-
/** 房间最大参与音频能量竞争路数(针对整个房间设置) */
|
|
781
|
-
max_speech: number;
|
|
782
|
-
/** 单人最大转发的人数(音频、视频路数)(针对单人设置) */
|
|
783
|
-
max_peer: number;
|
|
784
|
-
/** 单人非主动pick模式下最大转发视频路数(针对单人设置,目前我们视频都是主动pick,所以这个设置没有意义) */
|
|
785
|
-
max_video: number;
|
|
786
842
|
}
|
|
787
843
|
/**
|
|
788
844
|
* 流轨道信息
|
|
@@ -810,8 +866,6 @@ interface BaseTrackInfo {
|
|
|
810
866
|
sampleRate: number;
|
|
811
867
|
/** 流扩展属性 */
|
|
812
868
|
props?: Record<string, any>;
|
|
813
|
-
/** 轨道号 */
|
|
814
|
-
track: number;
|
|
815
869
|
}
|
|
816
870
|
/**
|
|
817
871
|
* 用户信息
|
|
@@ -824,7 +878,7 @@ interface BaseUserInfo {
|
|
|
824
878
|
/** 会中昵称 */
|
|
825
879
|
name: string;
|
|
826
880
|
/** 设备类型 */
|
|
827
|
-
device_type:
|
|
881
|
+
device_type: DeviceType;
|
|
828
882
|
/** 设备ID */
|
|
829
883
|
device_id: string;
|
|
830
884
|
/** 客户端RTCsdk版本号 */
|
|
@@ -849,10 +903,6 @@ interface BaseUserInfo {
|
|
|
849
903
|
leave_at: number;
|
|
850
904
|
/** 流轨道 */
|
|
851
905
|
stream_tracks?: BaseTrackInfo[];
|
|
852
|
-
/** 流媒体连接id */
|
|
853
|
-
link_id: number;
|
|
854
|
-
/** 流媒体服务器id */
|
|
855
|
-
upload_id: string;
|
|
856
906
|
}
|
|
857
907
|
|
|
858
908
|
export {
|