@seastart/srtc-web-sdk 0.0.5 → 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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seastart/srtc-web-sdk",
3
- "version": "0.0.5",
3
+ "version": "0.0.6",
4
4
  "description": "srtc sdk for web",
5
5
  "main": "srtc.js",
6
6
  "module": "srtc.mjs",
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
- * 获取对sdk外部展现的流信息
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,11 +319,6 @@ 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
324
  */
@@ -375,28 +375,76 @@ export declare class SRTC extends BaseSRTC {
375
375
  * 摄像头预设参数
376
376
  */
377
377
  export declare const CameraPresets: {
378
+ /** 分辨率1920*1080,帧率15,码率2.5Mbps */
378
379
  "1080p": CameraPreset;
380
+ /** 分辨率1280*720,帧率15,码率1.2Mbps,createLocalCameraTrack的默认预设参数 */
379
381
  "720p": CameraPreset;
382
+ /** 分辨率640*360,帧率15,码率550Kbps */
380
383
  "360p": CameraPreset;
384
+ /** 分辨率320*180,帧率15,码率250Kbps */
381
385
  "180p": CameraPreset;
382
386
  };
383
387
  /**
384
388
  * 麦克风预设参数
385
389
  */
386
390
  export declare const MicPresets: {
391
+ /** 单声道,采样率48kHz,码率24Kbps */
387
392
  speech: MicPreset;
393
+ /** 单声道,采样率48kHz,码率32Kbps,createLocalMicTrack的默认预设参数 */
388
394
  music: MicPreset;
395
+ /** 双声道,采样率48kHz,码率48Kbps */
389
396
  musicStereo: MicPreset;
397
+ /** 单声道,采样率48kHz,码率64Kbps */
390
398
  musicHighQuality: MicPreset;
399
+ /** 双声道,采样率48kHz,码率96Kbps */
391
400
  musicHighQualityStereo: MicPreset;
392
401
  };
393
402
  /**
394
403
  * 屏幕共享预设参数
395
404
  */
396
405
  export declare const ScreenPresets: {
406
+ /** 分辨率1920*1080,帧率10,码率2Mbps,createLocalScreenTrack时的默认预设参数 */
397
407
  "1080p": ScreenPreset;
408
+ /** 分辨率1280*720,帧率10,码率1.5Mbps */
398
409
  "720p": ScreenPreset;
399
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
+ }
400
448
  /**
401
449
  * 用户离开频道的原因
402
450
  */
@@ -523,6 +571,21 @@ export interface CameraPreset {
523
571
  capture: CameraCaptureOptions;
524
572
  publish: VideoPublishOptions;
525
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
+ }
526
589
  /**
527
590
  * 强制离开事件data
528
591
  */
@@ -533,7 +596,7 @@ export interface DisconnectEventData {
533
596
  error?: any;
534
597
  }
535
598
  /**
536
- * web环境响应
599
+ * web环境详情
537
600
  */
538
601
  export interface EnvWebInfo extends Bowser$1.Parser.ParsedResult {
539
602
  /**
@@ -773,16 +836,6 @@ interface BaseChannelInfo {
773
836
  created_at: number;
774
837
  /** 频道更新时间 */
775
838
  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
839
  }
787
840
  /**
788
841
  * 流轨道信息
@@ -810,8 +863,6 @@ interface BaseTrackInfo {
810
863
  sampleRate: number;
811
864
  /** 流扩展属性 */
812
865
  props?: Record<string, any>;
813
- /** 轨道号 */
814
- track: number;
815
866
  }
816
867
  /**
817
868
  * 用户信息
@@ -824,7 +875,7 @@ interface BaseUserInfo {
824
875
  /** 会中昵称 */
825
876
  name: string;
826
877
  /** 设备类型 */
827
- device_type: number;
878
+ device_type: DeviceType;
828
879
  /** 设备ID */
829
880
  device_id: string;
830
881
  /** 客户端RTCsdk版本号 */
@@ -849,10 +900,6 @@ interface BaseUserInfo {
849
900
  leave_at: number;
850
901
  /** 流轨道 */
851
902
  stream_tracks?: BaseTrackInfo[];
852
- /** 流媒体连接id */
853
- link_id: number;
854
- /** 流媒体服务器id */
855
- upload_id: string;
856
903
  }
857
904
 
858
905
  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
- * 获取对sdk外部展现的流信息
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,11 +319,6 @@ 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
324
  */
@@ -375,28 +375,76 @@ export declare class SRTC extends BaseSRTC {
375
375
  * 摄像头预设参数
376
376
  */
377
377
  export declare const CameraPresets: {
378
+ /** 分辨率1920*1080,帧率15,码率2.5Mbps */
378
379
  "1080p": CameraPreset;
380
+ /** 分辨率1280*720,帧率15,码率1.2Mbps,createLocalCameraTrack的默认预设参数 */
379
381
  "720p": CameraPreset;
382
+ /** 分辨率640*360,帧率15,码率550Kbps */
380
383
  "360p": CameraPreset;
384
+ /** 分辨率320*180,帧率15,码率250Kbps */
381
385
  "180p": CameraPreset;
382
386
  };
383
387
  /**
384
388
  * 麦克风预设参数
385
389
  */
386
390
  export declare const MicPresets: {
391
+ /** 单声道,采样率48kHz,码率24Kbps */
387
392
  speech: MicPreset;
393
+ /** 单声道,采样率48kHz,码率32Kbps,createLocalMicTrack的默认预设参数 */
388
394
  music: MicPreset;
395
+ /** 双声道,采样率48kHz,码率48Kbps */
389
396
  musicStereo: MicPreset;
397
+ /** 单声道,采样率48kHz,码率64Kbps */
390
398
  musicHighQuality: MicPreset;
399
+ /** 双声道,采样率48kHz,码率96Kbps */
391
400
  musicHighQualityStereo: MicPreset;
392
401
  };
393
402
  /**
394
403
  * 屏幕共享预设参数
395
404
  */
396
405
  export declare const ScreenPresets: {
406
+ /** 分辨率1920*1080,帧率10,码率2Mbps,createLocalScreenTrack时的默认预设参数 */
397
407
  "1080p": ScreenPreset;
408
+ /** 分辨率1280*720,帧率10,码率1.5Mbps */
398
409
  "720p": ScreenPreset;
399
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
+ }
400
448
  /**
401
449
  * 用户离开频道的原因
402
450
  */
@@ -523,6 +571,21 @@ export interface CameraPreset {
523
571
  capture: CameraCaptureOptions;
524
572
  publish: VideoPublishOptions;
525
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
+ }
526
589
  /**
527
590
  * 强制离开事件data
528
591
  */
@@ -533,7 +596,7 @@ export interface DisconnectEventData {
533
596
  error?: any;
534
597
  }
535
598
  /**
536
- * web环境响应
599
+ * web环境详情
537
600
  */
538
601
  export interface EnvWebInfo extends Bowser$1.Parser.ParsedResult {
539
602
  /**
@@ -773,16 +836,6 @@ interface BaseChannelInfo {
773
836
  created_at: number;
774
837
  /** 频道更新时间 */
775
838
  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
839
  }
787
840
  /**
788
841
  * 流轨道信息
@@ -810,8 +863,6 @@ interface BaseTrackInfo {
810
863
  sampleRate: number;
811
864
  /** 流扩展属性 */
812
865
  props?: Record<string, any>;
813
- /** 轨道号 */
814
- track: number;
815
866
  }
816
867
  /**
817
868
  * 用户信息
@@ -824,7 +875,7 @@ interface BaseUserInfo {
824
875
  /** 会中昵称 */
825
876
  name: string;
826
877
  /** 设备类型 */
827
- device_type: number;
878
+ device_type: DeviceType;
828
879
  /** 设备ID */
829
880
  device_id: string;
830
881
  /** 客户端RTCsdk版本号 */
@@ -849,10 +900,6 @@ interface BaseUserInfo {
849
900
  leave_at: number;
850
901
  /** 流轨道 */
851
902
  stream_tracks?: BaseTrackInfo[];
852
- /** 流媒体连接id */
853
- link_id: number;
854
- /** 流媒体服务器id */
855
- upload_id: string;
856
903
  }
857
904
 
858
905
  export {