@coze/realtime-api 1.2.0 → 1.2.1-beta.3

package/dist/cjs/event-names/index.js

@@ -49,6 +49,10 @@ var EventNames = /*#__PURE__*/ function(EventNames) {
    * zh: 所有服务端事件
    */ EventNames["ALL_SERVER"] = "server.*";
     /**
+   * en: Room info
+   * zh: 房间信息
+   */ EventNames["ROOM_INFO"] = "client.room.info";
+    /**
    * en: Client connected
    * zh: 客户端连接
    */ EventNames["CONNECTED"] = "client.connected";

package/dist/cjs/index.js

@@ -61,6 +61,7 @@ __webpack_require__.d(utils_namespaceObject, {
     checkDevicePermission: ()=>checkDevicePermission,
     checkPermission: ()=>checkPermission,
     getAudioDevices: ()=>getAudioDevices,
+    isMobileVideoDevice: ()=>isMobileVideoDevice,
     isScreenShareDevice: ()=>isScreenShareDevice,
     isScreenShareSupported: ()=>isScreenShareSupported,
     sleep: ()=>sleep
@@ -135,6 +136,11 @@ var rtc_default = /*#__PURE__*/ __webpack_require__.n(rtc_namespaceObject);
     };
 };
 const isScreenShareDevice = (deviceId)=>'screenShare' === deviceId;
+/**
+ * 判断是否前后置摄像头
+ * @param deviceId
+ * @returns
+ */ const isMobileVideoDevice = (deviceId)=>'user' === deviceId || 'environment' === deviceId;
 /**
  * Check if browser supports screen sharing
  * 检查浏览器是否支持屏幕共享
@@ -156,6 +162,10 @@ var event_names_EventNames = /*#__PURE__*/ function(EventNames) {
    * zh: 所有服务端事件
    */ EventNames["ALL_SERVER"] = "server.*";
     /**
+   * en: Room info
+   * zh: 房间信息
+   */ EventNames["ROOM_INFO"] = "client.room.info";
+    /**
    * en: Client connected
    * zh: 客户端连接
    */ EventNames["CONNECTED"] = "client.connected";
@@ -439,7 +449,7 @@ class EngineClient extends RealtimeEventHandler {
         const devices = await getAudioDevices({
             video: true
         });
-        if (-1 === devices.videoInputs.findIndex((i)=>i.deviceId === deviceId)) throw new RealtimeAPIError(error_RealtimeError.DEVICE_ACCESS_ERROR, `Video input device not found: ${deviceId}`);
+        if (!isMobileVideoDevice(deviceId) && -1 === devices.videoInputs.findIndex((i)=>i.deviceId === deviceId)) throw new RealtimeAPIError(error_RealtimeError.DEVICE_ACCESS_ERROR, `Video input device not found: ${deviceId}`);
         await this.changeVideoState(false);
         if (isScreenShareDevice(deviceId)) {
             if (this._streamIndex === rtc_namespaceObject.StreamIndex.STREAM_INDEX_MAIN) this.engine.setLocalVideoPlayer(rtc_namespaceObject.StreamIndex.STREAM_INDEX_MAIN);
@@ -620,16 +630,16 @@ class RealtimeClient extends RealtimeEventHandler {
             // Step1 get token
             if (getRoomInfo) roomInfo = await getRoomInfo();
             else {
-                let config;
-                if (this._config.videoConfig) config = isScreenShareDevice(this._config.videoConfig.videoInputDeviceId) ? {
-                    video_config: {
+                const config = {};
+                if (this._config.prologueContent) config.prologue_content = this._config.prologueContent;
+                if (this._config.videoConfig) {
+                    if (isScreenShareDevice(this._config.videoConfig.videoInputDeviceId)) config.video_config = {
                         stream_video_type: 'screen'
-                    }
-                } : {
-                    video_config: {
+                    };
+                    else config.video_config = {
                         stream_video_type: 'main'
-                    }
-                };
+                    };
+                }
                 roomInfo = await this._api.audio.rooms.create({
                     bot_id: botId,
                     conversation_id: conversationId || void 0,
@@ -644,6 +654,12 @@ class RealtimeClient extends RealtimeEventHandler {
             this.dispatch(event_names.ERROR, error);
             throw new RealtimeAPIError(error_RealtimeError.CREATE_ROOM_ERROR, error instanceof Error ? error.message : 'Unknown error', error);
         }
+        this.dispatch(event_names.ROOM_INFO, {
+            roomId: roomInfo.room_id,
+            uid: roomInfo.uid,
+            token: roomInfo.token,
+            appId: roomInfo.app_id
+        });
         this._isTestEnv = TEST_APP_ID === roomInfo.app_id;
         // Step2 create engine
         this._client = new EngineClient(roomInfo.app_id, this._config.debug, this._isTestEnv, this._isSupportVideo, this._config.videoConfig);
@@ -785,7 +801,11 @@ class RealtimeClient extends RealtimeEventHandler {
             deviceId
         });
     }
-    async setVideoInputDevice(deviceId) {
+    /**
+   * en: Set the video input device
+   *
+   * zh: 设置视频输入设备
+   */ async setVideoInputDevice(deviceId) {
         var _this__client;
         await (null === (_this__client = this._client) || void 0 === _this__client ? void 0 : _this__client.setVideoInputDevice(deviceId));
         this.dispatch(event_names.VIDEO_INPUT_DEVICE_CHANGED, {
@@ -842,6 +862,7 @@ class RealtimeClient extends RealtimeEventHandler {
    *                                               可选，视频输入设备的设备 ID。
    * @param config.videoConfig.screenConfig - Optional, Screen share configuration if videoInputDeviceId is 'screenShare' see https://www.volcengine.com/docs/6348/104481#screenconfig for more details. |
    *                                         可选，屏幕共享配置，如果 videoInputDeviceId 是 'screenShare'，请参考 https://www.volcengine.com/docs/6348/104481#screenconfig 了解更多详情。
+   * @param config.prologueContent - Optional, Prologue content. | 可选，开场白内容。
    */ constructor(config){
         super(config.debug), this._client = null, this.isConnected = false, this._isTestEnv = false, this._isSupportVideo = false;
         this._config = config;

package/dist/esm/event-names/index.js

@@ -12,6 +12,10 @@ var event_names_EventNames = /*#__PURE__*/ function(EventNames) {
    * zh: 所有服务端事件
    */ EventNames["ALL_SERVER"] = "server.*";
     /**
+   * en: Room info
+   * zh: 房间信息
+   */ EventNames["ROOM_INFO"] = "client.room.info";
+    /**
    * en: Client connected
    * zh: 客户端连接
    */ EventNames["CONNECTED"] = "client.connected";

package/dist/esm/index.js

@@ -37,6 +37,7 @@ __webpack_require__.d(utils_namespaceObject, {
     checkDevicePermission: ()=>checkDevicePermission,
     checkPermission: ()=>checkPermission,
     getAudioDevices: ()=>getAudioDevices,
+    isMobileVideoDevice: ()=>isMobileVideoDevice,
     isScreenShareDevice: ()=>isScreenShareDevice,
     isScreenShareSupported: ()=>isScreenShareSupported,
     sleep: ()=>sleep
@@ -108,6 +109,11 @@ __webpack_require__.d(utils_namespaceObject, {
     };
 };
 const isScreenShareDevice = (deviceId)=>'screenShare' === deviceId;
+/**
+ * 判断是否前后置摄像头
+ * @param deviceId
+ * @returns
+ */ const isMobileVideoDevice = (deviceId)=>'user' === deviceId || 'environment' === deviceId;
 /**
  * Check if browser supports screen sharing
  * 检查浏览器是否支持屏幕共享
@@ -129,6 +135,10 @@ var event_names_EventNames = /*#__PURE__*/ function(EventNames) {
    * zh: 所有服务端事件
    */ EventNames["ALL_SERVER"] = "server.*";
     /**
+   * en: Room info
+   * zh: 房间信息
+   */ EventNames["ROOM_INFO"] = "client.room.info";
+    /**
    * en: Client connected
    * zh: 客户端连接
    */ EventNames["CONNECTED"] = "client.connected";
@@ -410,7 +420,7 @@ class EngineClient extends RealtimeEventHandler {
         const devices = await getAudioDevices({
             video: true
         });
-        if (-1 === devices.videoInputs.findIndex((i)=>i.deviceId === deviceId)) throw new RealtimeAPIError(error_RealtimeError.DEVICE_ACCESS_ERROR, `Video input device not found: ${deviceId}`);
+        if (!isMobileVideoDevice(deviceId) && -1 === devices.videoInputs.findIndex((i)=>i.deviceId === deviceId)) throw new RealtimeAPIError(error_RealtimeError.DEVICE_ACCESS_ERROR, `Video input device not found: ${deviceId}`);
         await this.changeVideoState(false);
         if (isScreenShareDevice(deviceId)) {
             if (this._streamIndex === __WEBPACK_EXTERNAL_MODULE__volcengine_rtc__.StreamIndex.STREAM_INDEX_MAIN) this.engine.setLocalVideoPlayer(__WEBPACK_EXTERNAL_MODULE__volcengine_rtc__.StreamIndex.STREAM_INDEX_MAIN);
@@ -591,16 +601,16 @@ class RealtimeClient extends RealtimeEventHandler {
             // Step1 get token
             if (getRoomInfo) roomInfo = await getRoomInfo();
             else {
-                let config;
-                if (this._config.videoConfig) config = isScreenShareDevice(this._config.videoConfig.videoInputDeviceId) ? {
-                    video_config: {
+                const config = {};
+                if (this._config.prologueContent) config.prologue_content = this._config.prologueContent;
+                if (this._config.videoConfig) {
+                    if (isScreenShareDevice(this._config.videoConfig.videoInputDeviceId)) config.video_config = {
                         stream_video_type: 'screen'
-                    }
-                } : {
-                    video_config: {
+                    };
+                    else config.video_config = {
                         stream_video_type: 'main'
-                    }
-                };
+                    };
+                }
                 roomInfo = await this._api.audio.rooms.create({
                     bot_id: botId,
                     conversation_id: conversationId || void 0,
@@ -615,6 +625,12 @@ class RealtimeClient extends RealtimeEventHandler {
             this.dispatch(event_names.ERROR, error);
             throw new RealtimeAPIError(error_RealtimeError.CREATE_ROOM_ERROR, error instanceof Error ? error.message : 'Unknown error', error);
         }
+        this.dispatch(event_names.ROOM_INFO, {
+            roomId: roomInfo.room_id,
+            uid: roomInfo.uid,
+            token: roomInfo.token,
+            appId: roomInfo.app_id
+        });
         this._isTestEnv = TEST_APP_ID === roomInfo.app_id;
         // Step2 create engine
         this._client = new EngineClient(roomInfo.app_id, this._config.debug, this._isTestEnv, this._isSupportVideo, this._config.videoConfig);
@@ -756,7 +772,11 @@ class RealtimeClient extends RealtimeEventHandler {
             deviceId
         });
     }
-    async setVideoInputDevice(deviceId) {
+    /**
+   * en: Set the video input device
+   *
+   * zh: 设置视频输入设备
+   */ async setVideoInputDevice(deviceId) {
         var _this__client;
         await (null === (_this__client = this._client) || void 0 === _this__client ? void 0 : _this__client.setVideoInputDevice(deviceId));
         this.dispatch(event_names.VIDEO_INPUT_DEVICE_CHANGED, {
@@ -813,6 +833,7 @@ class RealtimeClient extends RealtimeEventHandler {
    *                                               可选，视频输入设备的设备 ID。
    * @param config.videoConfig.screenConfig - Optional, Screen share configuration if videoInputDeviceId is 'screenShare' see https://www.volcengine.com/docs/6348/104481#screenconfig for more details. |
    *                                         可选，屏幕共享配置，如果 videoInputDeviceId 是 'screenShare'，请参考 https://www.volcengine.com/docs/6348/104481#screenconfig 了解更多详情。
+   * @param config.prologueContent - Optional, Prologue content. | 可选，开场白内容。
    */ constructor(config){
         super(config.debug), this._client = null, this.isConnected = false, this._isTestEnv = false, this._isSupportVideo = false;
         this._config = config;

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

@@ -14,6 +14,11 @@ declare enum EventNames {
      * zh: 所有服务端事件
      */
     ALL_SERVER = "server.*",
+    /**
+     * en: Room info
+     * zh: 房间信息
+     */
+    ROOM_INFO = "client.room.info",
     /**
      * en: Client connected
      * zh: 客户端连接

package/dist/types/event-names/index.d.ts

@@ -30,6 +30,7 @@ export interface RealtimeClientConfig {
     suppressNonStationaryNoise?: boolean /** optional, Suppress non-stationary noise, defaults to false */;
     videoConfig?: VideoConfig /** optional, Video configuration */;
     isAutoSubscribeAudio?: boolean /** optional, Whether to automatically subscribe to bot reply audio streams, defaults to true */;
+    prologueContent?: string /** optional, Prologue content */;
 }
 declare class RealtimeClient extends RealtimeEventHandler {
     _config: RealtimeClientConfig;
@@ -80,6 +81,7 @@ declare class RealtimeClient extends RealtimeEventHandler {
      *                                               可选，视频输入设备的设备 ID。
      * @param config.videoConfig.screenConfig - Optional, Screen share configuration if videoInputDeviceId is 'screenShare' see https://www.volcengine.com/docs/6348/104481#screenconfig for more details. |
      *                                         可选，屏幕共享配置，如果 videoInputDeviceId 是 'screenShare'，请参考 https://www.volcengine.com/docs/6348/104481#screenconfig 了解更多详情。
+     * @param config.prologueContent - Optional, Prologue content. | 可选，开场白内容。
      */
     constructor(config: RealtimeClientConfig);
     /**
@@ -143,7 +145,12 @@ declare class RealtimeClient extends RealtimeEventHandler {
      * zh: 设置音频输出设备
      */
     setAudioOutputDevice(deviceId: string): Promise<void>;
-    setVideoInputDevice(deviceId: string): Promise<void>;
+    /**
+     * en: Set the video input device
+     *
+     * zh: 设置视频输入设备
+     */
+    setVideoInputDevice(deviceId: string | 'screenShare' | 'user' | 'environment'): Promise<void>;
     /**
      * en: Get the RTC engine instance, for detail visit https://www.volcengine.com/docs/6348/104481
      *

package/dist/types/event-names/utils.d.ts

@@ -36,6 +36,12 @@ export declare const getAudioDevices: ({ video, }?: {
     videoInputs: MediaDeviceInfo[];
 }>;
 export declare const isScreenShareDevice: (deviceId?: string) => boolean;
+/**
+ * 判断是否前后置摄像头
+ * @param deviceId
+ * @returns
+ */
+export declare const isMobileVideoDevice: (deviceId?: string) => boolean;
 /**
  * Check if browser supports screen sharing
  * 检查浏览器是否支持屏幕共享

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

@@ -14,6 +14,11 @@ declare enum EventNames {
      * zh: 所有服务端事件
      */
     ALL_SERVER = "server.*",
+    /**
+     * en: Room info
+     * zh: 房间信息
+     */
+    ROOM_INFO = "client.room.info",
     /**
      * en: Client connected
      * zh: 客户端连接

package/dist/types/index.d.ts

@@ -30,6 +30,7 @@ export interface RealtimeClientConfig {
     suppressNonStationaryNoise?: boolean /** optional, Suppress non-stationary noise, defaults to false */;
     videoConfig?: VideoConfig /** optional, Video configuration */;
     isAutoSubscribeAudio?: boolean /** optional, Whether to automatically subscribe to bot reply audio streams, defaults to true */;
+    prologueContent?: string /** optional, Prologue content */;
 }
 declare class RealtimeClient extends RealtimeEventHandler {
     _config: RealtimeClientConfig;
@@ -80,6 +81,7 @@ declare class RealtimeClient extends RealtimeEventHandler {
      *                                               可选，视频输入设备的设备 ID。
      * @param config.videoConfig.screenConfig - Optional, Screen share configuration if videoInputDeviceId is 'screenShare' see https://www.volcengine.com/docs/6348/104481#screenconfig for more details. |
      *                                         可选，屏幕共享配置，如果 videoInputDeviceId 是 'screenShare'，请参考 https://www.volcengine.com/docs/6348/104481#screenconfig 了解更多详情。
+     * @param config.prologueContent - Optional, Prologue content. | 可选，开场白内容。
      */
     constructor(config: RealtimeClientConfig);
     /**
@@ -143,7 +145,12 @@ declare class RealtimeClient extends RealtimeEventHandler {
      * zh: 设置音频输出设备
      */
     setAudioOutputDevice(deviceId: string): Promise<void>;
-    setVideoInputDevice(deviceId: string): Promise<void>;
+    /**
+     * en: Set the video input device
+     *
+     * zh: 设置视频输入设备
+     */
+    setVideoInputDevice(deviceId: string | 'screenShare' | 'user' | 'environment'): Promise<void>;
     /**
      * en: Get the RTC engine instance, for detail visit https://www.volcengine.com/docs/6348/104481
      *

package/dist/types/utils.d.ts

@@ -36,6 +36,12 @@ export declare const getAudioDevices: ({ video, }?: {
     videoInputs: MediaDeviceInfo[];
 }>;
 export declare const isScreenShareDevice: (deviceId?: string) => boolean;
+/**
+ * 判断是否前后置摄像头
+ * @param deviceId
+ * @returns
+ */
+export declare const isMobileVideoDevice: (deviceId?: string) => boolean;
 /**
  * Check if browser supports screen sharing
  * 检查浏览器是否支持屏幕共享

package/dist/umd/index.js

@@ -96,6 +96,7 @@
             checkDevicePermission: ()=>checkDevicePermission,
             checkPermission: ()=>checkPermission,
             getAudioDevices: ()=>getAudioDevices,
+            isMobileVideoDevice: ()=>isMobileVideoDevice,
             isScreenShareDevice: ()=>isScreenShareDevice,
             isScreenShareSupported: ()=>isScreenShareSupported,
             sleep: ()=>sleep
@@ -173,6 +174,11 @@
         };
         const isScreenShareDevice = (deviceId)=>'screenShare' === deviceId;
         /**
+ * 判断是否前后置摄像头
+ * @param deviceId
+ * @returns
+ */ const isMobileVideoDevice = (deviceId)=>'user' === deviceId || 'environment' === deviceId;
+        /**
  * Check if browser supports screen sharing
  * 检查浏览器是否支持屏幕共享
  */ function isScreenShareSupported() {
@@ -193,6 +199,10 @@
    * zh: 所有服务端事件
    */ EventNames["ALL_SERVER"] = "server.*";
             /**
+   * en: Room info
+   * zh: 房间信息
+   */ EventNames["ROOM_INFO"] = "client.room.info";
+            /**
    * en: Client connected
    * zh: 客户端连接
    */ EventNames["CONNECTED"] = "client.connected";
@@ -477,7 +487,7 @@
                 const devices = await getAudioDevices({
                     video: true
                 });
-                if (-1 === devices.videoInputs.findIndex((i)=>i.deviceId === deviceId)) throw new RealtimeAPIError(error_RealtimeError.DEVICE_ACCESS_ERROR, `Video input device not found: ${deviceId}`);
+                if (!isMobileVideoDevice(deviceId) && -1 === devices.videoInputs.findIndex((i)=>i.deviceId === deviceId)) throw new RealtimeAPIError(error_RealtimeError.DEVICE_ACCESS_ERROR, `Video input device not found: ${deviceId}`);
                 await this.changeVideoState(false);
                 if (isScreenShareDevice(deviceId)) {
                     if (this._streamIndex === rtc_.StreamIndex.STREAM_INDEX_MAIN) this.engine.setLocalVideoPlayer(rtc_.StreamIndex.STREAM_INDEX_MAIN);
@@ -658,16 +668,16 @@
                     // Step1 get token
                     if (getRoomInfo) roomInfo = await getRoomInfo();
                     else {
-                        let config;
-                        if (this._config.videoConfig) config = isScreenShareDevice(this._config.videoConfig.videoInputDeviceId) ? {
-                            video_config: {
+                        const config = {};
+                        if (this._config.prologueContent) config.prologue_content = this._config.prologueContent;
+                        if (this._config.videoConfig) {
+                            if (isScreenShareDevice(this._config.videoConfig.videoInputDeviceId)) config.video_config = {
                                 stream_video_type: 'screen'
-                            }
-                        } : {
-                            video_config: {
+                            };
+                            else config.video_config = {
                                 stream_video_type: 'main'
-                            }
-                        };
+                            };
+                        }
                         roomInfo = await this._api.audio.rooms.create({
                             bot_id: botId,
                             conversation_id: conversationId || void 0,
@@ -682,6 +692,12 @@
                     this.dispatch(event_names.ERROR, error);
                     throw new RealtimeAPIError(error_RealtimeError.CREATE_ROOM_ERROR, error instanceof Error ? error.message : 'Unknown error', error);
                 }
+                this.dispatch(event_names.ROOM_INFO, {
+                    roomId: roomInfo.room_id,
+                    uid: roomInfo.uid,
+                    token: roomInfo.token,
+                    appId: roomInfo.app_id
+                });
                 this._isTestEnv = TEST_APP_ID === roomInfo.app_id;
                 // Step2 create engine
                 this._client = new EngineClient(roomInfo.app_id, this._config.debug, this._isTestEnv, this._isSupportVideo, this._config.videoConfig);
@@ -823,7 +839,11 @@
                     deviceId
                 });
             }
-            async setVideoInputDevice(deviceId) {
+            /**
+   * en: Set the video input device
+   *
+   * zh: 设置视频输入设备
+   */ async setVideoInputDevice(deviceId) {
                 var _this__client;
                 await (null === (_this__client = this._client) || void 0 === _this__client ? void 0 : _this__client.setVideoInputDevice(deviceId));
                 this.dispatch(event_names.VIDEO_INPUT_DEVICE_CHANGED, {
@@ -880,6 +900,7 @@
    *                                               可选，视频输入设备的设备 ID。
    * @param config.videoConfig.screenConfig - Optional, Screen share configuration if videoInputDeviceId is 'screenShare' see https://www.volcengine.com/docs/6348/104481#screenconfig for more details. |
    *                                         可选，屏幕共享配置，如果 videoInputDeviceId 是 'screenShare'，请参考 https://www.volcengine.com/docs/6348/104481#screenconfig 了解更多详情。
+   * @param config.prologueContent - Optional, Prologue content. | 可选，开场白内容。
    */ constructor(config){
                 super(config.debug), this._client = null, this.isConnected = false, this._isTestEnv = false, this._isSupportVideo = false;
                 this._config = config;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coze/realtime-api",
-  "version": "1.2.0",
+  "version": "1.2.1-beta.3",
   "description": "A powerful real-time communication SDK for voice interactions with Coze AI bots | 扣子官方实时通信 SDK，用于与 Coze AI bots 进行语音交互",
   "keywords": [
     "coze",
@@ -54,7 +54,7 @@
     "test:cov": "vitest --coverage --run"
   },
   "dependencies": {
-    "@coze/api": "1.2.0",
+    "@coze/api": "1.2.1-beta.9",
     "@volcengine/rtc": "^4.62.1"
   },
   "devDependencies": {