@tencentcloud/tuiroom-engine-electron 1.4.0-beta.4 → 1.4.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tencentcloud/tuiroom-engine-electron",
-  "version": "1.4.0-beta.4",
+  "version": "1.4.2",
   "description": "TUIRoomEngine Electron SDK",
   "main": "index.js",
   "types": "index.d.ts",

package/types.d.ts

@@ -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 type TUINetwork = {
+    userId: string;
+    quality: TUINetworkQuality;
+    upLoss: number;
+    downLoss: number;
+    delay: number;
+};
 export declare enum TUIRoomType {
     kConference = 1,
     kLivingRoom = 2
@@ -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);
      *   })
      * });
      */