@coze/realtime-api 1.0.5-alpha.126a93 → 1.0.5-alpha.feed0d

package/dist/cjs/index.cjs

@@ -39488,6 +39488,10 @@ var event_handler_EventNames = /*#__PURE__*/ function(EventNames) {
    * zh: 客户端连接
    */ EventNames["CONNECTED"] = "client.connected";
     /**
+   * en: Client connecting
+   * zh: 客户端连接中
+   */ EventNames["CONNECTING"] = "client.connecting";
+    /**
    * en: Client interrupted
    * zh: 客户端中断
    */ EventNames["INTERRUPTED"] = "client.interrupted";
@@ -39540,6 +39544,10 @@ var event_handler_EventNames = /*#__PURE__*/ function(EventNames) {
    * zh: 视频输入设备改变
    */ EventNames["VIDEO_INPUT_DEVICE_CHANGED"] = "client.video.input.device.changed";
     /**
+   * en: Network quality changed
+   * zh: 网络质量改变
+   */ EventNames["NETWORK_QUALITY"] = "client.network.quality";
+    /**
    * en: Bot joined
    * zh: Bot 加入
    */ EventNames["BOT_JOIN"] = "server.bot.join";
@@ -39592,7 +39600,10 @@ class RealtimeEventHandler {
         const handlers = this.eventHandlers[eventName] || [];
         if (callback) {
             const index = handlers.indexOf(callback);
-            if (-1 === index) throw new RealtimeAPIError(error_RealtimeError.EVENT_HANDLER_ERROR, `Could not turn off specified event listener for "${eventName}": not found as a listener`);
+            if (-1 === index) {
+                console.warn(`Could not turn off specified event listener for "${eventName}": not found as a listener`);
+                return;
+            }
             handlers.splice(index, 1);
         } else delete this.eventHandlers[eventName];
     }
@@ -39606,7 +39617,7 @@ class RealtimeEventHandler {
     }
     dispatch(eventName, event) {
         let consoleLog = !(arguments.length > 2) || void 0 === arguments[2] || arguments[2];
-        if (consoleLog) this._log(`dispatch ${eventName} event`);
+        if (consoleLog) this._log(`dispatch ${eventName} event`, event);
         const handlers = (this.eventHandlers[eventName] || []).slice();
         this._dispatchToHandlers(eventName, event, handlers);
         const allHandlers = (this.eventHandlers["realtime.event"] || []).slice();
@@ -39616,8 +39627,8 @@ class RealtimeEventHandler {
         const allServerHandlers = (this.eventHandlers["server.*"] || []).slice();
         this._dispatchToHandlers(eventName, event, allServerHandlers, 'server.');
     }
-    _log(message) {
-        if (this._debug) console.log(`[RealtimeClient] ${message}`);
+    _log(message, event) {
+        if (this._debug) console.log(`[RealtimeClient] ${message}`, event);
     }
     constructor(debug = false){
         this.eventHandlers = {};
@@ -42875,6 +42886,7 @@ class EngineClient extends RealtimeEventHandler {
         this.engine.on(index_esm_min_index.events.onUserJoined, this.handleUserJoin);
         this.engine.on(index_esm_min_index.events.onUserLeave, this.handleUserLeave);
         this.engine.on(index_esm_min_index.events.onError, this.handleEventError);
+        this.engine.on(index_esm_min_index.events.onNetworkQuality, this.handleNetworkQuality);
         if (this._isSupportVideo) this.engine.on(index_esm_min_index.events.onPlayerEvent, this.handlePlayerEvent);
         if (this._debug) {
             this.engine.on(index_esm_min_index.events.onLocalAudioPropertiesReport, this.handleLocalAudioPropertiesReport);
@@ -42886,6 +42898,7 @@ class EngineClient extends RealtimeEventHandler {
         this.engine.off(index_esm_min_index.events.onUserJoined, this.handleUserJoin);
         this.engine.off(index_esm_min_index.events.onUserLeave, this.handleUserLeave);
         this.engine.off(index_esm_min_index.events.onError, this.handleEventError);
+        this.engine.off(index_esm_min_index.events.onNetworkQuality, this.handleNetworkQuality);
         if (this._isSupportVideo) this.engine.off(index_esm_min_index.events.onPlayerEvent, this.handlePlayerEvent);
         if (this._debug) {
             this.engine.off(index_esm_min_index.events.onLocalAudioPropertiesReport, this.handleLocalAudioPropertiesReport);
@@ -42930,6 +42943,12 @@ class EngineClient extends RealtimeEventHandler {
     handlePlayerEvent(event) {
         this.dispatch(event_handler_EventNames.PLAYER_EVENT, event);
     }
+    handleNetworkQuality(uplinkNetworkQuality, downlinkNetworkQuality) {
+        this.dispatch(event_handler_EventNames.NETWORK_QUALITY, {
+            uplinkNetworkQuality,
+            downlinkNetworkQuality
+        });
+    }
     async joinRoom(options) {
         const { token, roomId, uid, audioMutedDefault, videoOnDefault, isAutoSubscribeAudio } = options;
         try {
@@ -42996,11 +43015,10 @@ class EngineClient extends RealtimeEventHandler {
     }
     async disconnect() {
         try {
-            if (this._isSupportVideo) await this.changeVideoState(false);
-            await this.changeAudioState(false);
-            await this.engine.unpublishStream(MediaType$1.AUDIO);
             await this.engine.leaveRoom();
             this.removeEventListener();
+            this.clearEventHandlers();
+            index_esm_min_index.destroyEngine(this.engine);
         } catch (e) {
             this.dispatch(event_handler_EventNames.ERROR, e);
             throw e;
@@ -43121,6 +43139,7 @@ class EngineClient extends RealtimeEventHandler {
         this.handleUserLeave = this.handleUserLeave.bind(this);
         this.handleEventError = this.handleEventError.bind(this);
         this.handlePlayerEvent = this.handlePlayerEvent.bind(this);
+        this.handleNetworkQuality = this.handleNetworkQuality.bind(this);
         // Debug only
         this.handleLocalAudioPropertiesReport = this.handleLocalAudioPropertiesReport.bind(this);
         this.handleRemoteAudioPropertiesReport = this.handleRemoteAudioPropertiesReport.bind(this);
@@ -43136,6 +43155,7 @@ class RealtimeClient extends RealtimeEventHandler {
    */ async connect() {
         var _this__config_videoConfig;
         const { botId, conversationId, voiceId } = this._config;
+        this.dispatch(event_handler_EventNames.CONNECTING, {});
         let roomInfo;
         try {
             // Step1 get token
@@ -43216,6 +43236,7 @@ class RealtimeClient extends RealtimeEventHandler {
         var _this__client;
         await (null === (_this__client = this._client) || void 0 === _this__client ? void 0 : _this__client.disconnect());
         this.isConnected = false;
+        this._client = null;
         this.dispatch(event_handler_EventNames.DISCONNECTED, {});
     }
     /**

package/dist/esm/index.js

@@ -39476,6 +39476,10 @@ var event_handler_EventNames = /*#__PURE__*/ function(EventNames) {
    * zh: 客户端连接
    */ EventNames["CONNECTED"] = "client.connected";
     /**
+   * en: Client connecting
+   * zh: 客户端连接中
+   */ EventNames["CONNECTING"] = "client.connecting";
+    /**
    * en: Client interrupted
    * zh: 客户端中断
    */ EventNames["INTERRUPTED"] = "client.interrupted";
@@ -39528,6 +39532,10 @@ var event_handler_EventNames = /*#__PURE__*/ function(EventNames) {
    * zh: 视频输入设备改变
    */ EventNames["VIDEO_INPUT_DEVICE_CHANGED"] = "client.video.input.device.changed";
     /**
+   * en: Network quality changed
+   * zh: 网络质量改变
+   */ EventNames["NETWORK_QUALITY"] = "client.network.quality";
+    /**
    * en: Bot joined
    * zh: Bot 加入
    */ EventNames["BOT_JOIN"] = "server.bot.join";
@@ -39580,7 +39588,10 @@ class RealtimeEventHandler {
         const handlers = this.eventHandlers[eventName] || [];
         if (callback) {
             const index = handlers.indexOf(callback);
-            if (-1 === index) throw new RealtimeAPIError(error_RealtimeError.EVENT_HANDLER_ERROR, `Could not turn off specified event listener for "${eventName}": not found as a listener`);
+            if (-1 === index) {
+                console.warn(`Could not turn off specified event listener for "${eventName}": not found as a listener`);
+                return;
+            }
             handlers.splice(index, 1);
         } else delete this.eventHandlers[eventName];
     }
@@ -39594,7 +39605,7 @@ class RealtimeEventHandler {
     }
     dispatch(eventName, event) {
         let consoleLog = !(arguments.length > 2) || void 0 === arguments[2] || arguments[2];
-        if (consoleLog) this._log(`dispatch ${eventName} event`);
+        if (consoleLog) this._log(`dispatch ${eventName} event`, event);
         const handlers = (this.eventHandlers[eventName] || []).slice();
         this._dispatchToHandlers(eventName, event, handlers);
         const allHandlers = (this.eventHandlers["realtime.event"] || []).slice();
@@ -39604,8 +39615,8 @@ class RealtimeEventHandler {
         const allServerHandlers = (this.eventHandlers["server.*"] || []).slice();
         this._dispatchToHandlers(eventName, event, allServerHandlers, 'server.');
     }
-    _log(message) {
-        if (this._debug) console.log(`[RealtimeClient] ${message}`);
+    _log(message, event) {
+        if (this._debug) console.log(`[RealtimeClient] ${message}`, event);
     }
     constructor(debug = false){
         this.eventHandlers = {};
@@ -42863,6 +42874,7 @@ class EngineClient extends RealtimeEventHandler {
         this.engine.on(index_esm_min_index.events.onUserJoined, this.handleUserJoin);
         this.engine.on(index_esm_min_index.events.onUserLeave, this.handleUserLeave);
         this.engine.on(index_esm_min_index.events.onError, this.handleEventError);
+        this.engine.on(index_esm_min_index.events.onNetworkQuality, this.handleNetworkQuality);
         if (this._isSupportVideo) this.engine.on(index_esm_min_index.events.onPlayerEvent, this.handlePlayerEvent);
         if (this._debug) {
             this.engine.on(index_esm_min_index.events.onLocalAudioPropertiesReport, this.handleLocalAudioPropertiesReport);
@@ -42874,6 +42886,7 @@ class EngineClient extends RealtimeEventHandler {
         this.engine.off(index_esm_min_index.events.onUserJoined, this.handleUserJoin);
         this.engine.off(index_esm_min_index.events.onUserLeave, this.handleUserLeave);
         this.engine.off(index_esm_min_index.events.onError, this.handleEventError);
+        this.engine.off(index_esm_min_index.events.onNetworkQuality, this.handleNetworkQuality);
         if (this._isSupportVideo) this.engine.off(index_esm_min_index.events.onPlayerEvent, this.handlePlayerEvent);
         if (this._debug) {
             this.engine.off(index_esm_min_index.events.onLocalAudioPropertiesReport, this.handleLocalAudioPropertiesReport);
@@ -42918,6 +42931,12 @@ class EngineClient extends RealtimeEventHandler {
     handlePlayerEvent(event) {
         this.dispatch(event_handler_EventNames.PLAYER_EVENT, event);
     }
+    handleNetworkQuality(uplinkNetworkQuality, downlinkNetworkQuality) {
+        this.dispatch(event_handler_EventNames.NETWORK_QUALITY, {
+            uplinkNetworkQuality,
+            downlinkNetworkQuality
+        });
+    }
     async joinRoom(options) {
         const { token, roomId, uid, audioMutedDefault, videoOnDefault, isAutoSubscribeAudio } = options;
         try {
@@ -42984,11 +43003,10 @@ class EngineClient extends RealtimeEventHandler {
     }
     async disconnect() {
         try {
-            if (this._isSupportVideo) await this.changeVideoState(false);
-            await this.changeAudioState(false);
-            await this.engine.unpublishStream(MediaType$1.AUDIO);
             await this.engine.leaveRoom();
             this.removeEventListener();
+            this.clearEventHandlers();
+            index_esm_min_index.destroyEngine(this.engine);
         } catch (e) {
             this.dispatch(event_handler_EventNames.ERROR, e);
             throw e;
@@ -43109,6 +43127,7 @@ class EngineClient extends RealtimeEventHandler {
         this.handleUserLeave = this.handleUserLeave.bind(this);
         this.handleEventError = this.handleEventError.bind(this);
         this.handlePlayerEvent = this.handlePlayerEvent.bind(this);
+        this.handleNetworkQuality = this.handleNetworkQuality.bind(this);
         // Debug only
         this.handleLocalAudioPropertiesReport = this.handleLocalAudioPropertiesReport.bind(this);
         this.handleRemoteAudioPropertiesReport = this.handleRemoteAudioPropertiesReport.bind(this);
@@ -43124,6 +43143,7 @@ class RealtimeClient extends RealtimeEventHandler {
    */ async connect() {
         var _this__config_videoConfig;
         const { botId, conversationId, voiceId } = this._config;
+        this.dispatch(event_handler_EventNames.CONNECTING, {});
         let roomInfo;
         try {
             // Step1 get token
@@ -43204,6 +43224,7 @@ class RealtimeClient extends RealtimeEventHandler {
         var _this__client;
         await (null === (_this__client = this._client) || void 0 === _this__client ? void 0 : _this__client.disconnect());
         this.isConnected = false;
+        this._client = null;
         this.dispatch(event_handler_EventNames.DISCONNECTED, {});
     }
     /**

package/dist/types/client.d.ts

@@ -1,4 +1,4 @@
-import { type AudioPropertiesConfig, type IRTCEngine, type onUserJoinedEvent, type onUserLeaveEvent, type UserMessageEvent } from '@volcengine/rtc';
+import { type AudioPropertiesConfig, type IRTCEngine, type NetworkQuality, type onUserJoinedEvent, type onUserLeaveEvent, type UserMessageEvent } from '@volcengine/rtc';
 import { RealtimeEventHandler } from './event-handler';
 import { type VideoConfig } from '.';
 export declare class EngineClient extends RealtimeEventHandler {
@@ -18,6 +18,7 @@ export declare class EngineClient extends RealtimeEventHandler {
     handleUserJoin(event: onUserJoinedEvent): void;
     handleUserLeave(event: onUserLeaveEvent): void;
     handlePlayerEvent(event: unknown): void;
+    handleNetworkQuality(uplinkNetworkQuality: NetworkQuality, downlinkNetworkQuality: NetworkQuality): void;
     joinRoom(options: {
         token: string;
         roomId: string;

package/dist/types/event-handler.d.ts

@@ -19,6 +19,11 @@ export declare enum EventNames {
      * zh: 客户端连接
      */
     CONNECTED = "client.connected",
+    /**
+     * en: Client connecting
+     * zh: 客户端连接中
+     */
+    CONNECTING = "client.connecting",
     /**
      * en: Client interrupted
      * zh: 客户端中断
@@ -84,6 +89,11 @@ export declare enum EventNames {
      * zh: 视频输入设备改变
      */
     VIDEO_INPUT_DEVICE_CHANGED = "client.video.input.device.changed",
+    /**
+     * en: Network quality changed
+     * zh: 网络质量改变
+     */
+    NETWORK_QUALITY = "client.network.quality",
     /**
      * en: Bot joined
      * zh: Bot 加入
@@ -140,5 +150,5 @@ export declare class RealtimeEventHandler {
     off(eventName: string, callback: EventCallback): void;
     private _dispatchToHandlers;
     dispatch(eventName: string, event: unknown, consoleLog?: boolean): void;
-    _log(message: string): void;
+    _log(message: string, event?: unknown): void;
 }

package/dist/umd/index.js

@@ -39494,6 +39494,10 @@ and limitations under the License.
    * zh: 客户端连接
    */ EventNames["CONNECTED"] = "client.connected";
             /**
+   * en: Client connecting
+   * zh: 客户端连接中
+   */ EventNames["CONNECTING"] = "client.connecting";
+            /**
    * en: Client interrupted
    * zh: 客户端中断
    */ EventNames["INTERRUPTED"] = "client.interrupted";
@@ -39546,6 +39550,10 @@ and limitations under the License.
    * zh: 视频输入设备改变
    */ EventNames["VIDEO_INPUT_DEVICE_CHANGED"] = "client.video.input.device.changed";
             /**
+   * en: Network quality changed
+   * zh: 网络质量改变
+   */ EventNames["NETWORK_QUALITY"] = "client.network.quality";
+            /**
    * en: Bot joined
    * zh: Bot 加入
    */ EventNames["BOT_JOIN"] = "server.bot.join";
@@ -39598,7 +39606,10 @@ and limitations under the License.
                 const handlers = this.eventHandlers[eventName] || [];
                 if (callback) {
                     const index = handlers.indexOf(callback);
-                    if (-1 === index) throw new RealtimeAPIError(error_RealtimeError.EVENT_HANDLER_ERROR, `Could not turn off specified event listener for "${eventName}": not found as a listener`);
+                    if (-1 === index) {
+                        console.warn(`Could not turn off specified event listener for "${eventName}": not found as a listener`);
+                        return;
+                    }
                     handlers.splice(index, 1);
                 } else delete this.eventHandlers[eventName];
             }
@@ -39612,7 +39623,7 @@ and limitations under the License.
             }
             dispatch(eventName, event) {
                 let consoleLog = !(arguments.length > 2) || void 0 === arguments[2] || arguments[2];
-                if (consoleLog) this._log(`dispatch ${eventName} event`);
+                if (consoleLog) this._log(`dispatch ${eventName} event`, event);
                 const handlers = (this.eventHandlers[eventName] || []).slice();
                 this._dispatchToHandlers(eventName, event, handlers);
                 const allHandlers = (this.eventHandlers["realtime.event"] || []).slice();
@@ -39622,8 +39633,8 @@ and limitations under the License.
                 const allServerHandlers = (this.eventHandlers["server.*"] || []).slice();
                 this._dispatchToHandlers(eventName, event, allServerHandlers, 'server.');
             }
-            _log(message) {
-                if (this._debug) console.log(`[RealtimeClient] ${message}`);
+            _log(message, event) {
+                if (this._debug) console.log(`[RealtimeClient] ${message}`, event);
             }
             constructor(debug = false){
                 this.eventHandlers = {};
@@ -42881,6 +42892,7 @@ and limitations under the License.
                 this.engine.on(index_esm_min_index.events.onUserJoined, this.handleUserJoin);
                 this.engine.on(index_esm_min_index.events.onUserLeave, this.handleUserLeave);
                 this.engine.on(index_esm_min_index.events.onError, this.handleEventError);
+                this.engine.on(index_esm_min_index.events.onNetworkQuality, this.handleNetworkQuality);
                 if (this._isSupportVideo) this.engine.on(index_esm_min_index.events.onPlayerEvent, this.handlePlayerEvent);
                 if (this._debug) {
                     this.engine.on(index_esm_min_index.events.onLocalAudioPropertiesReport, this.handleLocalAudioPropertiesReport);
@@ -42892,6 +42904,7 @@ and limitations under the License.
                 this.engine.off(index_esm_min_index.events.onUserJoined, this.handleUserJoin);
                 this.engine.off(index_esm_min_index.events.onUserLeave, this.handleUserLeave);
                 this.engine.off(index_esm_min_index.events.onError, this.handleEventError);
+                this.engine.off(index_esm_min_index.events.onNetworkQuality, this.handleNetworkQuality);
                 if (this._isSupportVideo) this.engine.off(index_esm_min_index.events.onPlayerEvent, this.handlePlayerEvent);
                 if (this._debug) {
                     this.engine.off(index_esm_min_index.events.onLocalAudioPropertiesReport, this.handleLocalAudioPropertiesReport);
@@ -42936,6 +42949,12 @@ and limitations under the License.
             handlePlayerEvent(event) {
                 this.dispatch(event_handler_EventNames.PLAYER_EVENT, event);
             }
+            handleNetworkQuality(uplinkNetworkQuality, downlinkNetworkQuality) {
+                this.dispatch(event_handler_EventNames.NETWORK_QUALITY, {
+                    uplinkNetworkQuality,
+                    downlinkNetworkQuality
+                });
+            }
             async joinRoom(options) {
                 const { token, roomId, uid, audioMutedDefault, videoOnDefault, isAutoSubscribeAudio } = options;
                 try {
@@ -43002,11 +43021,10 @@ and limitations under the License.
             }
             async disconnect() {
                 try {
-                    if (this._isSupportVideo) await this.changeVideoState(false);
-                    await this.changeAudioState(false);
-                    await this.engine.unpublishStream(MediaType$1.AUDIO);
                     await this.engine.leaveRoom();
                     this.removeEventListener();
+                    this.clearEventHandlers();
+                    index_esm_min_index.destroyEngine(this.engine);
                 } catch (e) {
                     this.dispatch(event_handler_EventNames.ERROR, e);
                     throw e;
@@ -43127,6 +43145,7 @@ and limitations under the License.
                 this.handleUserLeave = this.handleUserLeave.bind(this);
                 this.handleEventError = this.handleEventError.bind(this);
                 this.handlePlayerEvent = this.handlePlayerEvent.bind(this);
+                this.handleNetworkQuality = this.handleNetworkQuality.bind(this);
                 // Debug only
                 this.handleLocalAudioPropertiesReport = this.handleLocalAudioPropertiesReport.bind(this);
                 this.handleRemoteAudioPropertiesReport = this.handleRemoteAudioPropertiesReport.bind(this);
@@ -43142,6 +43161,7 @@ and limitations under the License.
    */ async connect() {
                 var _this__config_videoConfig;
                 const { botId, conversationId, voiceId } = this._config;
+                this.dispatch(event_handler_EventNames.CONNECTING, {});
                 let roomInfo;
                 try {
                     // Step1 get token
@@ -43222,6 +43242,7 @@ and limitations under the License.
                 var _this__client;
                 await (null === (_this__client = this._client) || void 0 === _this__client ? void 0 : _this__client.disconnect());
                 this.isConnected = false;
+                this._client = null;
                 this.dispatch(event_handler_EventNames.DISCONNECTED, {});
             }
             /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coze/realtime-api",
-  "version": "1.0.5-alpha.126a93",
+  "version": "1.0.5-alpha.feed0d",
   "description": "A powerful real-time communication SDK for voice interactions with Coze AI bots | 扣子官方实时通信 SDK，用于与 Coze AI bots 进行语音交互",
   "keywords": [
     "coze",
@@ -21,7 +21,6 @@
   },
   "license": "MIT",
   "author": "jackshen <jackshen310@gmail.com>",
-  "sideEffects": false,
   "type": "module",
   "exports": {
     ".": {