@tencentcloud/tuiroom-engine-electron 1.4.0 → 1.4.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tencentcloud/tuiroom-engine-electron",
-  "version": "1.4.0",
+  "version": "1.4.3",
   "description": "TUIRoomEngine Electron SDK",
   "main": "index.js",
   "types": "index.d.ts",
@@ -20,7 +20,7 @@
   "dependencies": {
     "rtc-detect": "^0.0.5",
     "tim-js-sdk": "^2.27.0",
-    "trtc-electron-sdk": "11.3.502-beta.0",
+    "trtc-electron-sdk": "11.3.502-beta.2",
     "tsignaling": "^1.0.6"
   }
 }

package/types.d.ts

@@ -46,7 +46,7 @@ export declare enum TUIErrorCode {
     ERR_SEND_MESSAGE_DISABLED_FOR_ALL = -2380,
     ERR_SEND_MESSAGE_DISABLED_FOR_CURRENT = -2381
 }
-export type TUIRoomInfo = {
+export declare type TUIRoomInfo = {
     roomId: string;
     roomName: string;
     roomType: TUIRoomType;
@@ -59,13 +59,13 @@ export type TUIRoomInfo = {
     createTime: number;
     roomMemberCount: number;
 };
-export type TUILoginUserInfo = {
+export declare type TUILoginUserInfo = {
     userId: string;
     userName: string;
     avatarUrl: string;
     customInfo: Record<string, any>;
 };
-export type TUISeatLockParams = {
+export declare type TUISeatLockParams = {
     lockSeat: boolean;
     lockVideo: boolean;
     lockAudio: boolean;
@@ -85,7 +85,7 @@ export declare enum TUIRole {
  * @property {boolean} userName 用户名称
  * @property {boolean} avatarUrl 用户头像地址
  */
-export type TUIMessage = {
+export declare type TUIMessage = {
     messageId: string;
     message: string;
     timestamp: number;
@@ -118,6 +118,22 @@ export declare enum TUINetworkQuality {
     kQualityVeryBad = 5,
     kQualityDown = 6
 }
+/**
+ * 消息结构体
+ * @typedef {object} TUINetwork
+ * @property {string} userId 用户 Id
+ * @property {TUINetworkQuality} quality 网络质量
+ * @property {number} upLoss 上行丢包率，单位 (%) 该数值越小越好，目前仅本地用户有该信息
+ * @property {TUIRole} downLoss 下行丢包率，单位 (%) 该数值越小越好，目前仅本地用户有该信息
+ * @property {Number} delay 网络延迟，单位 ms，目前仅本地用户有该信息
+ */
+export declare type TUINetwork = {
+    userId: string;
+    quality: TUINetworkQuality;
+    upLoss: number;
+    downLoss: number;
+    delay: number;
+};
 export declare enum TUIRoomType {
     kConference = 1,
     kLivingRoom = 2
@@ -166,7 +182,7 @@ export declare enum TRTCRole {
     kAnchor = 0,
     kAudience = 1
 }
-export type TUIUserInfo = {
+export declare type TUIUserInfo = {
     userId: string;
     userName: string;
     avatarUrl: string;
@@ -176,21 +192,21 @@ export type TUIUserInfo = {
     hasScreenStream: boolean;
     roomCustomInfo: Record<string, any>;
 };
-export type TUISeatInfo = {
+export declare type TUISeatInfo = {
     index: number;
     userId: string;
     locked: boolean;
     isVideoLocked: boolean;
     isAudioLocked: boolean;
 };
-export type TUIRequest = {
+export declare type TUIRequest = {
     requestAction: TUIRequestAction;
     timestamp: number;
     requestId: string;
     userId: string;
     content: string;
 };
-export type TUIRequestCallback = {
+export declare type TUIRequestCallback = {
     requestCallbackType: TUIRequestCallbackType;
     requestId: string;
     userId: string;
@@ -458,12 +474,12 @@ export declare enum TUIRoomEvents {
      * @default 'onUserNetworkQualityChanged'
      * @event TUIRoomEvents#onUserNetworkQualityChanged
      * @param {object} options
-     * @param {TUINetworkQuality} options.networkMap 遍历网络质量等级
+     * @param {TUINetwork} options.userNetworkList 网络质量信息
      * @example
      * const roomEngine = new TUIRoomEngine();
      * roomEngine.on(TUIRoomEvents.onUserNetworkQualityChanged, ({ userNetworkList }) => {
      *   userNetworkList.forEach(userNetwork => {
-     *     console.log('roomEngine.onUserNetworkQualityChanged', userNetwork.userId, userNetwork.volume);
+     *     console.log('roomEngine.onUserNetworkQualityChanged', userNetwork.userId, userNetwork.quality, userNetwork.upLoss, userNetwork.downLoss, userNetwork.delay);
      *   })
      * });
      */