@seastart/srtc-web-sdk 0.0.3 → 0.0.5

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,19 +1,19 @@
1
1
  {
2
2
  "name": "@seastart/srtc-web-sdk",
3
- "version": "0.0.3",
3
+ "version": "0.0.5",
4
4
  "description": "srtc sdk for web",
5
- "main": "index.js",
6
- "module": "index.mjs",
7
- "types": "index.d.ts",
5
+ "main": "srtc.js",
6
+ "module": "srtc.mjs",
7
+ "types": "srtc.d.ts",
8
8
  "exports": {
9
9
  ".": {
10
10
  "require": {
11
- "types": "./index.d.ts",
12
- "default": "./index.js"
11
+ "types": "./srtc.d.ts",
12
+ "default": "./srtc.js"
13
13
  },
14
14
  "import": {
15
- "types": "./index.d.mts",
16
- "default": "./index.mjs"
15
+ "types": "./srtc.d.mts",
16
+ "default": "./srtc.mjs"
17
17
  }
18
18
  }
19
19
  },
@@ -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,7 +39,8 @@ 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
  * 订阅远端频道混音流
40
46
  */
@@ -133,23 +139,6 @@ declare enum Codec {
133
139
  /** OPUS编码 */
134
140
  OPUS = 1398100047
135
141
  }
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
142
  /** 频道事件通知 */
154
143
  export declare class ChannelEvent {
155
144
  /** 事件类型 */
@@ -311,6 +300,11 @@ export declare class RemoteVideoTrack extends BaseWebrtcTrack {
311
300
  }
312
301
  export declare class SRTC extends BaseSRTC {
313
302
  buildInfo(): BuildInfo;
303
+ /**
304
+ * 获取web运行环境信息,如是否支持webrtc等
305
+ * @returns
306
+ */
307
+ getEnvInfo(): EnvWebInfo;
314
308
  constructor(initParams: RtcInitParams);
315
309
  leave(): Promise<void>;
316
310
  /**
@@ -320,11 +314,6 @@ export declare class SRTC extends BaseSRTC {
320
314
  * @returns
321
315
  */
322
316
  getDevices(kind?: MediaDeviceKind, requestPermissions?: boolean): Promise<MediaDeviceInfo[]>;
323
- /**
324
- * 获取环境信息,如是否支持webrtc等
325
- * @returns
326
- */
327
- getEnvInfo(): EnvWebInfo;
328
317
  /**
329
318
  * 将track事件转化为频道事件
330
319
  * @param track
@@ -408,6 +397,23 @@ export declare const ScreenPresets: {
408
397
  "1080p": ScreenPreset;
409
398
  "720p": ScreenPreset;
410
399
  };
400
+ /**
401
+ * 用户离开频道的原因
402
+ */
403
+ export declare enum DisconnectReason {
404
+ /** 错误 */
405
+ Error = -1,
406
+ /** 主动离开 */
407
+ Self = 1,
408
+ /** 被踢离开 */
409
+ Kicked = 2,
410
+ /** 被顶号 */
411
+ Replace = 3,
412
+ /** 心跳超时离开 */
413
+ Timeout = 4,
414
+ /** 频道销毁离开 */
415
+ Destroy = 5
416
+ }
411
417
  /**
412
418
  * 日志打印等级
413
419
  */
@@ -611,6 +617,13 @@ export interface EnvWebInfo extends Bowser$1.Parser.ParsedResult {
611
617
  */
612
618
  devicePixelRatio: number;
613
619
  }
620
+ /**
621
+ * 微信小程序环境详情
622
+ */
623
+ export interface EnvWxInfo {
624
+ system: WechatMiniprogram.SystemInfo;
625
+ device: WechatMiniprogram.DeviceInfo;
626
+ }
614
627
  /**
615
628
  * 加入频道选项
616
629
  */
@@ -846,6 +859,5 @@ export {
846
859
  BaseChannelInfo as ChannelInfo,
847
860
  BaseTrackInfo as TrackInfo,
848
861
  BaseUserInfo as UserInfo,
849
- DisconnectReason as LeaveReason,
850
862
  };
851
863
 
@@ -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,7 +39,8 @@ 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
  * 订阅远端频道混音流
40
46
  */
@@ -133,23 +139,6 @@ declare enum Codec {
133
139
  /** OPUS编码 */
134
140
  OPUS = 1398100047
135
141
  }
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
142
  /** 频道事件通知 */
154
143
  export declare class ChannelEvent {
155
144
  /** 事件类型 */
@@ -311,6 +300,11 @@ export declare class RemoteVideoTrack extends BaseWebrtcTrack {
311
300
  }
312
301
  export declare class SRTC extends BaseSRTC {
313
302
  buildInfo(): BuildInfo;
303
+ /**
304
+ * 获取web运行环境信息,如是否支持webrtc等
305
+ * @returns
306
+ */
307
+ getEnvInfo(): EnvWebInfo;
314
308
  constructor(initParams: RtcInitParams);
315
309
  leave(): Promise<void>;
316
310
  /**
@@ -320,11 +314,6 @@ export declare class SRTC extends BaseSRTC {
320
314
  * @returns
321
315
  */
322
316
  getDevices(kind?: MediaDeviceKind, requestPermissions?: boolean): Promise<MediaDeviceInfo[]>;
323
- /**
324
- * 获取环境信息,如是否支持webrtc等
325
- * @returns
326
- */
327
- getEnvInfo(): EnvWebInfo;
328
317
  /**
329
318
  * 将track事件转化为频道事件
330
319
  * @param track
@@ -408,6 +397,23 @@ export declare const ScreenPresets: {
408
397
  "1080p": ScreenPreset;
409
398
  "720p": ScreenPreset;
410
399
  };
400
+ /**
401
+ * 用户离开频道的原因
402
+ */
403
+ export declare enum DisconnectReason {
404
+ /** 错误 */
405
+ Error = -1,
406
+ /** 主动离开 */
407
+ Self = 1,
408
+ /** 被踢离开 */
409
+ Kicked = 2,
410
+ /** 被顶号 */
411
+ Replace = 3,
412
+ /** 心跳超时离开 */
413
+ Timeout = 4,
414
+ /** 频道销毁离开 */
415
+ Destroy = 5
416
+ }
411
417
  /**
412
418
  * 日志打印等级
413
419
  */
@@ -611,6 +617,13 @@ export interface EnvWebInfo extends Bowser$1.Parser.ParsedResult {
611
617
  */
612
618
  devicePixelRatio: number;
613
619
  }
620
+ /**
621
+ * 微信小程序环境详情
622
+ */
623
+ export interface EnvWxInfo {
624
+ system: WechatMiniprogram.SystemInfo;
625
+ device: WechatMiniprogram.DeviceInfo;
626
+ }
614
627
  /**
615
628
  * 加入频道选项
616
629
  */
@@ -846,6 +859,5 @@ export {
846
859
  BaseChannelInfo as ChannelInfo,
847
860
  BaseTrackInfo as TrackInfo,
848
861
  BaseUserInfo as UserInfo,
849
- DisconnectReason as LeaveReason,
850
862
  };
851
863