@seastart/srtc-web-sdk 0.0.1 → 0.0.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/index.d.mts ADDED
@@ -0,0 +1,851 @@
1
+ import Bowser$1 from 'bowser';
2
+ import EventEmitter from 'events';
3
+
4
+ declare abstract class BaseSRTC {
5
+ /**
6
+ * 获取sdk编译信息
7
+ */
8
+ abstract buildInfo(): BuildInfo;
9
+ /**
10
+ * 频道事件通知回调
11
+ */
12
+ onNotifyChannelEvent?: ((event: ChannelEvent) => void) | null;
13
+ constructor(initParams: RtcInitParams);
14
+ /**
15
+ * 加入频道
16
+ * @param token 加入频道token
17
+ */
18
+ join(token: string, params?: JoinParams): Promise<BaseChannelInfo>;
19
+ /**
20
+ * 离开频道
21
+ */
22
+ leave(): Promise<void>;
23
+ /**
24
+ * 获取频道信息
25
+ * @returns
26
+ */
27
+ getChannelInfo(): BaseChannelInfo | null;
28
+ /**
29
+ * 获取某用户信息
30
+ * @returns
31
+ */
32
+ getUserInfo(uid: string): BaseUserInfo;
33
+ /**
34
+ * 获取频道内用户信息列表
35
+ * @returns
36
+ */
37
+ getUsersInfo(): BaseUserInfo[];
38
+ /**
39
+ * 订阅远端频道混音流
40
+ */
41
+ subscribeRemoteAudioMixTrack(filterUids?: string[]): Promise<BaseTrack>;
42
+ /**
43
+ * 订阅远端用户音频流
44
+ * @param uid 用户id
45
+ * @param id 流轨道id
46
+ */
47
+ subscribeRemoteAudioTrack(uid: string, id: string): Promise<BaseTrack>;
48
+ /**
49
+ * 订阅远端用户视频流
50
+ * @param uid 用户id
51
+ * @param id 流轨道id
52
+ */
53
+ subscribeRemoteVideoTrack(uid: string, id: string): Promise<BaseTrack>;
54
+ /**
55
+ * 取消订阅远端流
56
+ */
57
+ unsubscribeRemoteTrack(track: BaseTrack): Promise<void>;
58
+ }
59
+ declare abstract class BaseTrack extends EventEmitter {
60
+ constructor(info: BaseTrackInfo, uid: string);
61
+ /**
62
+ * 轨道id
63
+ */
64
+ get id(): string;
65
+ /**
66
+ * 轨道类型
67
+ */
68
+ get kind(): TrackKind;
69
+ /**
70
+ * 轨道描述
71
+ */
72
+ get desc(): string;
73
+ /**
74
+ * 获取对sdk外部展现的流信息
75
+ * @returns
76
+ */
77
+ getInfo(): BaseTrackInfo;
78
+ /**
79
+ * 轨道所属用户
80
+ * @returns
81
+ */
82
+ getUid(): string;
83
+ toString(): string;
84
+ }
85
+ declare abstract class BaseWebrtcTrack extends BaseTrack {
86
+ constructor(info: BaseTrackInfo, uid: string);
87
+ setMediaStreamTrack(mediaStreamTrack?: MediaStreamTrack): void;
88
+ getMediaStreamTrack(): MediaStreamTrack | undefined;
89
+ }
90
+ declare class CommonChannelEventType {
91
+ /** 频道自定义props更新 */
92
+ static readonly CHANNEL_UPDATE = "channel_update";
93
+ /** 首次加入频道成功 */
94
+ static readonly JOIN_SUCCEED = "join_succeed";
95
+ /** 自己信息被改变 */
96
+ static readonly ME_UPDATE = "me_update";
97
+ /** 开始断线自动重连 */
98
+ static readonly RECONNECTING = "reconnecting";
99
+ /** 重连成功,断线重连成功后会触发 */
100
+ static readonly RECONNECTED = "reconnected";
101
+ /** 自己被强制离开频道*/
102
+ static readonly DISCONNECTED = "disconnected";
103
+ /** 其他用户加入频道 */
104
+ static readonly USER_JOIN = "user_join";
105
+ /** 其他用户信息改变 */
106
+ static readonly USER_UPDATE = "user_update";
107
+ /** 其他用户离开频道 */
108
+ static readonly USER_LEAVE = "user_leave";
109
+ /** 其他用户发布流轨道 */
110
+ static readonly USER_TRACK_ADD = "user_track_add";
111
+ /** 其他用户更新流轨道 */
112
+ static readonly USER_TRACK_UPDATE = "user_track_update";
113
+ /** 其他用户删除流轨道 */
114
+ static readonly USER_TRACK_REMOVE = "user_track_remove";
115
+ /** 频道内自定义消息 */
116
+ static readonly CUSTOM_MSG = "custom_msg";
117
+ /** 流轨道没有数据 */
118
+ static readonly TRACK_MUTED = "track_muted";
119
+ /** 流轨道恢复数据 */
120
+ static readonly TRACK_UNMUTED = "track_unmuted";
121
+ /** 流轨道停止 */
122
+ static readonly TRACK_ENDED = "track_ended";
123
+ }
124
+ declare enum Codec {
125
+ /** 未知编码类型 */
126
+ Unknown = 0,
127
+ /** h264编码 */
128
+ H264 = 27,
129
+ /** h265编码 */
130
+ H265 = 36,
131
+ /** AAC编码 */
132
+ AAC = 15,
133
+ /** OPUS编码 */
134
+ OPUS = 1398100047
135
+ }
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
+ /** 频道事件通知 */
154
+ export declare class ChannelEvent {
155
+ /** 事件类型 */
156
+ type: CommonChannelEventType;
157
+ /** 事件携带的数据 */
158
+ data?: any;
159
+ constructor(type: CommonChannelEventType, data?: any);
160
+ }
161
+ /** 扩展的频道事件 */
162
+ export declare class ChannelEventType extends CommonChannelEventType {
163
+ /** 外设插入 */
164
+ static readonly DEVICE_ADD = "device_add";
165
+ /** 外设移除 */
166
+ static readonly DEVICE_REMOVE = "device_remove";
167
+ /** 轨道自动播放失败 */
168
+ static readonly TRACK_AUTOPLAY_FAIL = "track_autoplay_fail";
169
+ }
170
+ /**
171
+ * 本地音频流轨道
172
+ */
173
+ export declare class LocalAudioTrack extends BaseWebrtcTrack {
174
+ constructor();
175
+ /**
176
+ * 获取音量
177
+ */
178
+ getVolume(): number;
179
+ /**
180
+ * 播放音频(可指定播放设备)
181
+ */
182
+ startPlay(opt?: AudioOutputOptions): Promise<void>;
183
+ /**
184
+ * 停止播放并释放对播放设备的占用
185
+ */
186
+ stopPlay(): void;
187
+ }
188
+ /**
189
+ * 本地摄像头视频流轨道
190
+ */
191
+ export declare class LocalCameraTrack extends LocalVideoTrack {
192
+ constructor(captureOptions: CameraCaptureOptions);
193
+ /**
194
+ * 开始采集
195
+ * @param opt 采集参数
196
+ */
197
+ startCapture(opt?: CameraCaptureOptions): Promise<void>;
198
+ /**
199
+ * 停止采集
200
+ */
201
+ stopCapture(): void;
202
+ /**
203
+ * 切换指定摄像头
204
+ * @param deviceId
205
+ * @returns
206
+ */
207
+ changeDeviceId(deviceId: string): Promise<void>;
208
+ /**
209
+ * 切换摄像头朝向(仅手机)
210
+ * @returns
211
+ */
212
+ switchFacingMode(): Promise<void>;
213
+ }
214
+ /**
215
+ * 本地麦克风流轨道
216
+ */
217
+ export declare class LocalMicTrack extends LocalAudioTrack {
218
+ constructor(captureOptions: MicCaptureOptions);
219
+ /**
220
+ * 开始采集
221
+ * @param opt 采集参数
222
+ */
223
+ startCapture(opt?: MicCaptureOptions): Promise<void>;
224
+ /**
225
+ * 停止采集
226
+ */
227
+ stopCapture(): Promise<void>;
228
+ /**
229
+ * 切换麦克风
230
+ * @param deviceId
231
+ * @returns
232
+ */
233
+ changeDeviceId(deviceId: string): Promise<void>;
234
+ }
235
+ /**
236
+ * 本地屏幕视频流轨道
237
+ */
238
+ export declare class LocalScreenTrack extends LocalVideoTrack {
239
+ constructor(captureOptions: ScreenCaptureOptions);
240
+ /**
241
+ * 开始采集
242
+ * @param opt 采集参数
243
+ */
244
+ startCapture(opt?: ScreenCaptureOptions): Promise<void>;
245
+ /**
246
+ * 停止采集
247
+ */
248
+ stopCapture(): void;
249
+ }
250
+ /**
251
+ * 本地视频流轨道
252
+ */
253
+ export declare class LocalVideoTrack extends BaseWebrtcTrack {
254
+ constructor();
255
+ /**
256
+ * 添加联播轨道(小流)
257
+ * @param opt 联播轨道的发布参数
258
+ */
259
+ addSimulcastTrack(opt: VideoPublishOptions): LocalVideoTrack;
260
+ /**
261
+ * 添加播放窗口
262
+ */
263
+ addPlayView(container: HTMLElement): void;
264
+ /**
265
+ * 移除播放窗口
266
+ */
267
+ removePlayView(container: HTMLElement): void;
268
+ /**
269
+ * 移除所有播放窗口
270
+ */
271
+ removeAllPlayViews(): void;
272
+ }
273
+ /**
274
+ * 远端混音流
275
+ */
276
+ export declare class RemoteAudioMixTrack extends RemoteAudioTrack {
277
+ constructor(info: BaseTrackInfo, filterUids?: string[]);
278
+ getFilterUids(): string[];
279
+ }
280
+ /**
281
+ * 远端音频流轨道
282
+ */
283
+ export declare class RemoteAudioTrack extends BaseWebrtcTrack {
284
+ constructor(info: BaseTrackInfo, uid: string);
285
+ /**
286
+ * 播放音频(可指定播放设备)
287
+ */
288
+ startPlay(opt?: AudioOutputOptions): Promise<void>;
289
+ /**
290
+ * 停止播放并释放对播放设备的占用
291
+ */
292
+ stopPlay(): void;
293
+ }
294
+ /**
295
+ * 远端视频流轨道
296
+ */
297
+ export declare class RemoteVideoTrack extends BaseWebrtcTrack {
298
+ constructor(info: BaseTrackInfo, uid: string);
299
+ /**
300
+ * 添加播放窗口
301
+ */
302
+ addPlayView(container: HTMLElement): void;
303
+ /**
304
+ * 移除播放窗口
305
+ */
306
+ removePlayView(container: HTMLElement): void;
307
+ /**
308
+ * 移除所有播放窗口
309
+ */
310
+ removeAllPlayViews(): void;
311
+ }
312
+ export declare class SRTC extends BaseSRTC {
313
+ buildInfo(): BuildInfo;
314
+ constructor(initParams: RtcInitParams);
315
+ leave(): Promise<void>;
316
+ /**
317
+ * 获取设备列表
318
+ * @param kind
319
+ * @param requestPermissions
320
+ * @returns
321
+ */
322
+ 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
+ /**
334
+ * 创建麦克风本地音频流
335
+ */
336
+ createLocalMicTrack(preset?: MicPreset): LocalMicTrack;
337
+ /**
338
+ * 创建自定义本地音频流
339
+ */
340
+ createLocalCustomAudioTrack(msTrack: MediaStreamTrack): LocalAudioTrack;
341
+ /**
342
+ * 创建摄像头本地视频流
343
+ */
344
+ createLocalCameraTrack(preset?: CameraPreset): LocalCameraTrack;
345
+ /**
346
+ * 创建屏幕采集本地视频流
347
+ */
348
+ createLocalScreenTrack(preset?: ScreenPreset): LocalScreenTrack;
349
+ /**
350
+ * 创建自定义本地视频流
351
+ */
352
+ createLocalCustomVideoTrack(msTrack: MediaStreamTrack): LocalVideoTrack;
353
+ /**
354
+ * 发布本地流轨道
355
+ * @param track
356
+ * @returns
357
+ */
358
+ publishLocalTrack(track: LocalAudioTrack | LocalVideoTrack, opt: AudioPublishOptions | VideoPublishOptions): Promise<void>;
359
+ /**
360
+ * 取消发布本地流
361
+ * @param track
362
+ */
363
+ unpublishLocalTrack(track: LocalAudioTrack | LocalVideoTrack): Promise<void>;
364
+ /**
365
+ * 订阅远端频道混音流
366
+ */
367
+ subscribeRemoteAudioMixTrack(filterUids?: string[]): Promise<RemoteAudioMixTrack>;
368
+ /**
369
+ * 订阅远端用户音频流
370
+ * @param uid 用户id
371
+ * @param id 流轨道id
372
+ */
373
+ subscribeRemoteAudioTrack(uid: string, id: string): Promise<RemoteAudioTrack>;
374
+ /**
375
+ * 订阅远端用户视频流
376
+ * @param uid 用户id
377
+ * @param id 流轨道id
378
+ */
379
+ subscribeRemoteVideoTrack(uid: string, id: string): Promise<RemoteVideoTrack>;
380
+ /**
381
+ * 取消订阅远端流
382
+ */
383
+ unsubscribeRemoteTrack(track: RemoteAudioMixTrack | RemoteAudioTrack | RemoteVideoTrack): Promise<void>;
384
+ }
385
+ /**
386
+ * 摄像头预设参数
387
+ */
388
+ export declare const CameraPresets: {
389
+ "1080p": CameraPreset;
390
+ "720p": CameraPreset;
391
+ "360p": CameraPreset;
392
+ "180p": CameraPreset;
393
+ };
394
+ /**
395
+ * 麦克风预设参数
396
+ */
397
+ export declare const MicPresets: {
398
+ speech: MicPreset;
399
+ music: MicPreset;
400
+ musicStereo: MicPreset;
401
+ musicHighQuality: MicPreset;
402
+ musicHighQualityStereo: MicPreset;
403
+ };
404
+ /**
405
+ * 屏幕共享预设参数
406
+ */
407
+ export declare const ScreenPresets: {
408
+ "1080p": ScreenPreset;
409
+ "720p": ScreenPreset;
410
+ };
411
+ /**
412
+ * 日志打印等级
413
+ */
414
+ export declare enum LogLevel {
415
+ DEBUG = "debug",
416
+ INFO = "info",
417
+ WARN = "warn",
418
+ ERROR = "error"
419
+ }
420
+ /**
421
+ * 日志打印目标
422
+ */
423
+ export declare enum LogTarget {
424
+ /** 控制台打印 */
425
+ CONSOLE = "console",
426
+ /** 微信实时日志 */
427
+ WXREALTIME = "wxrealtime",
428
+ /** 不打任何日志 */
429
+ NONE = "none"
430
+ }
431
+ /**
432
+ * 流轨道类型
433
+ */
434
+ export declare enum TrackKind {
435
+ Video = "video",
436
+ Audio = "audio"
437
+ }
438
+ /**
439
+ * 扬声器配置
440
+ */
441
+ export interface AudioOutputOptions {
442
+ /**
443
+ * deviceId to output audio
444
+ *
445
+ * Only supported on browsers where `setSinkId` is available
446
+ */
447
+ deviceId?: string;
448
+ /**
449
+ * 当因权限问题自动播放失败时,禁用sdk自带的播放弹窗,手动处理
450
+ */
451
+ disableAutoPlayDialog?: boolean;
452
+ }
453
+ /**
454
+ * 音频发布配置
455
+ */
456
+ export interface AudioPublishOptions {
457
+ /** 描述 */
458
+ desc: string;
459
+ /** 编码格式 */
460
+ codec?: Codec;
461
+ /** 最大码率 */
462
+ maxBitrate?: number;
463
+ /**
464
+ * dtx (Discontinuous Transmission of audio), enabled by default for mono tracks.
465
+ */
466
+ dtx?: boolean;
467
+ /**
468
+ * red (Redundant Audio Data), enabled by default for mono tracks.
469
+ */
470
+ red?: boolean;
471
+ /**
472
+ * 优先级,默认音频优先
473
+ */
474
+ priority?: RTCPriorityType;
475
+ /** 自定义属性 */
476
+ props?: Record<string, any>;
477
+ }
478
+ /**
479
+ * sdk编译信息
480
+ */
481
+ export interface BuildInfo {
482
+ /** 编译时间s */
483
+ timestamp: number;
484
+ /** sdk版本号 */
485
+ version: string;
486
+ }
487
+ /**
488
+ * 摄像头采集配置
489
+ */
490
+ export interface CameraCaptureOptions {
491
+ /**
492
+ * 设备id
493
+ */
494
+ deviceId?: string;
495
+ /**
496
+ * webrtc专用:摄像头朝向
497
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints/facingMode
498
+ */
499
+ facingMode?: "user" | "environment" | "left" | "right";
500
+ /**
501
+ * 宽
502
+ */
503
+ width?: number;
504
+ /**
505
+ * 高
506
+ */
507
+ height?: number;
508
+ /**
509
+ * 最大帧率
510
+ */
511
+ frameRate?: number;
512
+ }
513
+ /**
514
+ * 摄像头预设值
515
+ */
516
+ export interface CameraPreset {
517
+ capture: CameraCaptureOptions;
518
+ publish: VideoPublishOptions;
519
+ }
520
+ /**
521
+ * 强制离开事件data
522
+ */
523
+ export interface DisconnectEventData {
524
+ /** 离开原因 */
525
+ reason: DisconnectReason;
526
+ /** 错误 */
527
+ error?: any;
528
+ }
529
+ /**
530
+ * web环境响应
531
+ */
532
+ export interface EnvWebInfo extends Bowser$1.Parser.ParsedResult {
533
+ /**
534
+ * 是否支持webrtc
535
+ */
536
+ supported: boolean;
537
+ /**
538
+ * 当前上下文是否安全(https或localhost或127.0.0.1)
539
+ */
540
+ secure: boolean;
541
+ /**
542
+ * 是否支持获取麦克风、摄像头等媒体设备进行枚举、音视频采集、推流
543
+ */
544
+ mediaDevices: boolean;
545
+ /**
546
+ * 是否支持发起屏幕共享
547
+ */
548
+ screenshare: boolean;
549
+ /**
550
+ * 是否支持h264编码
551
+ */
552
+ h264Enc: boolean;
553
+ /**
554
+ * 是否支持h264解码
555
+ */
556
+ h264Dec: boolean;
557
+ /**
558
+ * 是否支持vp8编码
559
+ */
560
+ vp8Enc: boolean;
561
+ /**
562
+ * 是否支持vp8解码
563
+ */
564
+ vp8Dec: boolean;
565
+ /**
566
+ * 是否支持opus编码
567
+ */
568
+ opusEnc: boolean;
569
+ /**
570
+ * 是否支持opus解码
571
+ */
572
+ opusDec: boolean;
573
+ /**
574
+ * 当前支持的视频编码
575
+ */
576
+ videoEncCodecs: RTCRtpCapabilities | null;
577
+ /**
578
+ * 当前支持的视频解码
579
+ */
580
+ videoDecCodecs: RTCRtpCapabilities | null;
581
+ /**
582
+ * 当前支持的音频编码
583
+ */
584
+ audeoEncCodecs: RTCRtpCapabilities | null;
585
+ /**
586
+ * 当前支持的音频解码
587
+ */
588
+ audeoDecCodecs: RTCRtpCapabilities | null;
589
+ /**
590
+ * ua
591
+ */
592
+ ua: string;
593
+ /**
594
+ * 屏幕宽度
595
+ */
596
+ screenWidth: number;
597
+ /**
598
+ * 屏幕高度
599
+ */
600
+ screenHeight: number;
601
+ /**
602
+ * 可视区域宽度
603
+ */
604
+ clientWidth: number;
605
+ /**
606
+ * 可视区域高度
607
+ */
608
+ clientHeight: number;
609
+ /**
610
+ * 设备的物理像素分辨率与CSS像素分辨率之比
611
+ */
612
+ devicePixelRatio: number;
613
+ }
614
+ /**
615
+ * 加入频道选项
616
+ */
617
+ export interface JoinParams {
618
+ /** 线路号 */
619
+ netID: string;
620
+ /** 服务器分组id */
621
+ sgID: string;
622
+ }
623
+ /**
624
+ * 麦克风采集配置
625
+ */
626
+ export interface MicCaptureOptions {
627
+ /**
628
+ * 设备id
629
+ */
630
+ deviceId?: string;
631
+ /**
632
+ * AEC回声消除
633
+ */
634
+ echoCancellation?: boolean;
635
+ /**
636
+ * ANS降噪
637
+ */
638
+ noiseSuppression?: boolean;
639
+ /**
640
+ * AGC自动增益
641
+ */
642
+ autoGainControl?: boolean;
643
+ /**
644
+ * 声道数,目前只支持单声道
645
+ */
646
+ channelCount?: number;
647
+ /**
648
+ * 采样率16k/48k,目前固定16k
649
+ */
650
+ sampleRate?: number;
651
+ /**
652
+ * 每个采样点大小的位数(bits per sample),默认16
653
+ */
654
+ sampleSize?: number;
655
+ /**
656
+ * the latency or range of latencies which are acceptable and/or required.
657
+ */
658
+ latency?: ConstrainDouble;
659
+ }
660
+ /**
661
+ * 麦克风预设值
662
+ */
663
+ export interface MicPreset {
664
+ capture: MicCaptureOptions;
665
+ publish: AudioPublishOptions;
666
+ }
667
+ /**
668
+ * sdk构造参数
669
+ */
670
+ export interface RtcInitParams {
671
+ /** 日志等级 */
672
+ logLevel?: LogLevel;
673
+ /** 日志目标 */
674
+ logTarget?: LogTarget;
675
+ }
676
+ /**
677
+ * 屏幕采集配置
678
+ */
679
+ export interface ScreenCaptureOptions {
680
+ /**
681
+ * 宽
682
+ */
683
+ width?: number;
684
+ /**
685
+ * 高
686
+ */
687
+ height?: number;
688
+ /**
689
+ * 帧率
690
+ */
691
+ frameRate?: number;
692
+ /**
693
+ * 是否显示鼠标
694
+ */
695
+ showCursor: boolean;
696
+ /**
697
+ * windows专用
698
+ */
699
+ rect: {
700
+ x: number;
701
+ y: number;
702
+ w: number;
703
+ h: number;
704
+ };
705
+ }
706
+ /**
707
+ * 屏幕采集预设值
708
+ */
709
+ export interface ScreenPreset {
710
+ capture: ScreenCaptureOptions;
711
+ publish: VideoPublishOptions;
712
+ }
713
+ /**
714
+ * 用户离开事件data
715
+ */
716
+ export interface UserLeaveEventData {
717
+ /** 用户id */
718
+ uid: string;
719
+ /** 离开原因 */
720
+ reason: DisconnectReason;
721
+ }
722
+ /**
723
+ * 视频发布配置
724
+ */
725
+ export interface VideoPublishOptions {
726
+ /** 描述 */
727
+ desc: string;
728
+ /** 编码格式 */
729
+ codec?: Codec;
730
+ /**
731
+ * 宽(默认采集到的宽)
732
+ */
733
+ width?: number;
734
+ /**
735
+ * 高(默认采集到的高)
736
+ */
737
+ height?: number;
738
+ /** 最大码率 */
739
+ maxBitrate?: number;
740
+ /** 最大帧率 */
741
+ maxFramerate?: number;
742
+ /**
743
+ * 优先级,默认音频优先
744
+ */
745
+ priority?: RTCPriorityType;
746
+ /** 自定义属性 */
747
+ props?: Record<string, any>;
748
+ }
749
+ /**
750
+ * 频道信息
751
+ */
752
+ interface BaseChannelInfo {
753
+ /** 应用id */
754
+ app_id: string;
755
+ /** 频道名 */
756
+ channel: string;
757
+ /** 频道扩展属性 */
758
+ props?: Record<string, any>;
759
+ /** 频道创建时间 */
760
+ created_at: number;
761
+ /** 频道更新时间 */
762
+ 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
+ }
774
+ /**
775
+ * 流轨道信息
776
+ */
777
+ interface BaseTrackInfo {
778
+ /** 轨道id,在stream里唯一,在全局不一定唯一 */
779
+ id: string;
780
+ /** 自定义描述,如摄像头大流、摄像头小流、共享桌面流等 */
781
+ desc: string;
782
+ /** 轨道类型 */
783
+ kind: TrackKind;
784
+ /** 编码类型 */
785
+ codec: Codec;
786
+ /** 视频宽 */
787
+ width: number;
788
+ /** 视频高 */
789
+ height: number;
790
+ /** 视频帧率 */
791
+ fps: number;
792
+ /** 视频角度 */
793
+ angle: number;
794
+ /** 码率 */
795
+ bitrate: number;
796
+ /** 音频采样率 */
797
+ sampleRate: number;
798
+ /** 流扩展属性 */
799
+ props?: Record<string, any>;
800
+ /** 轨道号 */
801
+ track: number;
802
+ }
803
+ /**
804
+ * 用户信息
805
+ */
806
+ interface BaseUserInfo {
807
+ /** 应用id */
808
+ app_id: string;
809
+ /** 用户id */
810
+ uid: string;
811
+ /** 会中昵称 */
812
+ name: string;
813
+ /** 设备类型 */
814
+ device_type: number;
815
+ /** 设备ID */
816
+ device_id: string;
817
+ /** 客户端RTCsdk版本号 */
818
+ version: string;
819
+ /** 用户扩展属性 */
820
+ props?: Record<string, any>;
821
+ /** 线路号 */
822
+ netid: string;
823
+ /** 服务器分组id */
824
+ sgid: string;
825
+ /** 更新时间 */
826
+ updated_at: number;
827
+ /** 频道名 */
828
+ channel: string;
829
+ /** 会话id */
830
+ sid: string;
831
+ /** 是否观众,类似研讨会观众,只收流 */
832
+ is_audience: boolean;
833
+ /** 进入时间 */
834
+ join_at: number;
835
+ /** 退出时间 */
836
+ leave_at: number;
837
+ /** 流轨道 */
838
+ stream_tracks?: BaseTrackInfo[];
839
+ /** 流媒体连接id */
840
+ link_id: number;
841
+ /** 流媒体服务器id */
842
+ upload_id: string;
843
+ }
844
+
845
+ export {
846
+ BaseChannelInfo as ChannelInfo,
847
+ BaseTrackInfo as TrackInfo,
848
+ BaseUserInfo as UserInfo,
849
+ DisconnectReason as LeaveReason,
850
+ };
851
+