@coze/realtime-api 1.0.4-beta.1 → 1.0.4-beta.2

package/dist/types/index.d.ts

@@ -1,4 +1,4 @@
-import { type AudioPropertiesConfig } from '@volcengine/rtc';
+import { type ScreenConfig, type AudioPropertiesConfig, type IRTCEngine } from '@volcengine/rtc';
 import { type GetToken } from '@coze/api';
 import * as RealtimeUtils from './utils';
 import { RealtimeEventHandler, EventNames } from './event-handler';
@@ -6,12 +6,15 @@ import { RealtimeAPIError, RealtimeError } from './error';
 export interface VideoConfig {
     videoOnDefault?: boolean /** optional, Whether to turn on video by default, defaults to true */;
     renderDom?: string /** optional, The DOM element to render the video stream to */;
+    videoInputDeviceId?: string /** optional, The device ID of the video input device to use */;
+    screenConfig?: ScreenConfig;
 }
 export interface RealtimeClientConfig {
     accessToken: GetToken /** required, Access Token */;
     botId: string /** required, Bot Id */;
     voiceId?: string /** optional, Voice Id */;
     conversationId?: string /** optional, Conversation Id */;
+    userId?: string /** optional, User Id */;
     baseURL?: string /** optional, defaults to "https://api.coze.cn" */;
     debug?: boolean /** optional, defaults to false */;
     /** Whether Personal Access Tokens (PAT) are allowed in browser environments */
@@ -46,6 +49,8 @@ declare class RealtimeClient extends RealtimeEventHandler {
      *                         可选，音色Id。
      * @param config.conversationId - Optional, Conversation Id. |
      *                               可选，会话Id。
+     * @param config.userId - Optional, User Id. |
+     *                        可选，用户Id。
      * @param config.baseURL - Optional, defaults to "https://api.coze.cn". |
      *                        可选，默认值为 "https://api.coze.cn"。
      * @param config.debug - Optional, defaults to false.
@@ -62,6 +67,16 @@ declare class RealtimeClient extends RealtimeEventHandler {
      * @param config.suppressNonStationaryNoise - Optional, suppress non-stationary noise, defaults to false. |
      *                                         可选，默认是否抑制非静态噪声，默认值为 false。
      * @param config.isAutoSubscribeAudio - Optional, whether to automatically subscribe to bot reply audio streams, defaults to true. |
+     * @param config.videoConfig - Optional, Video configuration. |
+     *                            可选，视频配置。
+     * @param config.videoConfig.videoOnDefault - Optional, Whether to turn on video by default, defaults to true. |
+     *                                            可选，默认是否开启视频，默认值为 true。
+     * @param config.videoConfig.renderDom - Optional, The DOM element to render the video stream to. |
+     *                                       可选，渲染视频流的 DOM 元素。
+     * @param config.videoConfig.videoInputDeviceId - Optional, The device ID of the video input device to use. |
+     *                                               可选，视频输入设备的设备 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 了解更多详情。
      */
     constructor(config: RealtimeClientConfig);
     /**
@@ -125,5 +140,12 @@ declare class RealtimeClient extends RealtimeEventHandler {
      * zh: 设置音频输出设备
      */
     setAudioOutputDevice(deviceId: string): Promise<void>;
+    setVideoInputDevice(deviceId: string): Promise<void>;
+    /**
+     * en: Get the RTC engine instance, for detail visit https://www.volcengine.com/docs/6348/104481
+     *
+     * zh: 获取 RTC 引擎实例，详情请访问 https://www.volcengine.com/docs/6348/104481
+     */
+    getRtcEngine(): IRTCEngine | undefined;
 }
 export { RealtimeUtils, RealtimeClient, RealtimeAPIError, RealtimeError, EventNames, };

package/dist/types/utils.d.ts

@@ -13,6 +13,11 @@ export declare const checkPermission: ({ audio, video, }?: {
     audio?: boolean;
     video?: boolean;
 }) => Promise<boolean>;
+/**
+ * Checks device permissions for audio and video
+ * @param checkVideo Whether to check video permissions (default: false)
+ * @returns Promise that resolves with the device permission status
+ */
 export declare const checkDevicePermission: (checkVideo?: boolean) => Promise<{
     video: boolean;
     audio: boolean;
@@ -30,3 +35,9 @@ export declare const getAudioDevices: ({ video, }?: {
     audioOutputs: MediaDeviceInfo[];
     videoInputs: MediaDeviceInfo[];
 }>;
+export declare const isScreenShareDevice: (deviceId?: string) => boolean;
+/**
+ * Check if browser supports screen sharing
+ * 检查浏览器是否支持屏幕共享
+ */
+export declare function isScreenShareSupported(): boolean;

package/dist/umd/index.js

@@ -101,7 +101,7 @@
             hasBrowserEnv: ()=>hasBrowserEnv,
             hasStandardBrowserEnv: ()=>hasStandardBrowserEnv,
             hasStandardBrowserWebWorkerEnv: ()=>hasStandardBrowserWebWorkerEnv,
-            navigator: ()=>_navigator,
+            navigator: ()=>utils_navigator,
             origin: ()=>origin
         });
         // NAMESPACE OBJECT: ./src/utils.ts
@@ -111,6 +111,8 @@
             checkDevicePermission: ()=>checkDevicePermission,
             checkPermission: ()=>checkPermission,
             getAudioDevices: ()=>getAudioDevices,
+            isScreenShareDevice: ()=>isScreenShareDevice,
+            isScreenShareSupported: ()=>isScreenShareSupported,
             sleep: ()=>src_utils_sleep
         });
         class APIResource {
@@ -1634,7 +1636,7 @@
             ]
         };
         const hasBrowserEnv = 'undefined' != typeof window && 'undefined' != typeof document;
-        const _navigator = 'object' == typeof navigator && navigator || void 0;
+        const utils_navigator = 'object' == typeof navigator && navigator || void 0;
         /**
  * Determine if we're running in a standard browser environment
  *
@@ -1651,11 +1653,11 @@
  *  navigator.product -> 'NativeScript' or 'NS'
  *
  * @returns {boolean}
- */ const hasStandardBrowserEnv = hasBrowserEnv && (!_navigator || [
+ */ const hasStandardBrowserEnv = hasBrowserEnv && (!utils_navigator || [
             'ReactNative',
             'NativeScript',
             'NS'
-        ].indexOf(_navigator.product) < 0);
+        ].indexOf(utils_navigator.product) < 0);
         /**
  * Determine if we're running in a standard browser webWorker environment
  *
@@ -3677,9 +3679,9 @@
    * @param params.page - Optional The page number for paginated queries. Default is 1. | 可选 分页查询时的页码。默认为 1。
    * @param params.page_size - Optional The size of pagination. Default is 10. | 可选 分页大小。默认为 10。
    * @returns ListDocumentData | 知识库文件列表
-   */ list(params, options) {
+   */ async list(params, options) {
                 const apiUrl = '/open_api/knowledge/document/list';
-                const response = this._client.get(apiUrl, params, false, mergeConfig(options, {
+                const response = await this._client.get(apiUrl, params, false, mergeConfig(options, {
                     headers: documents_documents_headers
                 }));
                 return response;
@@ -3728,9 +3730,104 @@
                 }));
             }
         }
+        class Images extends APIResource {
+            /**
+   * Update the description of an image in the knowledge base | 更新知识库中的图片描述
+   * @docs en: https://www.coze.com/docs/developer_guides/developer_guides/update_image_caption?_lang=en
+   * @docs zh: https://www.coze.cn/docs/developer_guides/developer_guides/update_image_caption?_lang=zh
+   * @param datasetId - The ID of the dataset | 必选 知识库 ID
+   * @param documentId - The ID of the document | 必选 知识库文件 ID
+   * @param params - The parameters for updating the image
+   * @param params.caption - Required. The description of the image | 必选 图片的描述信息
+   * @returns undefined
+   */ // eslint-disable-next-line max-params
+            async update(datasetId, documentId, params, options) {
+                const apiUrl = `/v1/datasets/${datasetId}/images/${documentId}`;
+                await this._client.put(apiUrl, params, false, options);
+            }
+            /**
+   * List images in the knowledge base | 列出知识库中的图片
+   * @docs en: https://www.coze.com/docs/developer_guides/developer_guides/get_images?_lang=en
+   * @docs zh: https://www.coze.cn/docs/developer_guides/developer_guides/get_images?_lang=zh
+   * @param datasetId - The ID of the dataset | 必选 知识库 ID
+   * @param params - The parameters for listing images
+   * @param params.page_num - Optional. Page number for pagination, minimum value is 1, defaults to 1 | 可选 分页查询时的页码。默认为 1。
+   * @param params.page_size - Optional. Number of items per page, range 1-299, defaults to 10 | 可选 分页大小。默认为 10。
+   * @param params.keyword - Optional. Search keyword for image descriptions | 可选 图片描述的搜索关键词。
+   * @param params.has_caption - Optional. Filter for images with/without captions | 可选 是否过滤有/无描述的图片。
+   */ async list(datasetId, params, options) {
+                const apiUrl = `/v1/datasets/${datasetId}/images`;
+                const response = await this._client.get(apiUrl, params, false, options);
+                return response.data;
+            }
+        }
         class Datasets extends APIResource {
+            /**
+   * Creates a new dataset | 创建数据集
+   * @docs en: https://www.coze.com/docs/developer_guides/create_dataset?_lang=en
+   * @docs zh: https://www.coze.cn/docs/developer_guides/create_dataset?_lang=zh
+   * @param params - The parameters for creating a dataset
+   * @param {string} params.name - Required. Dataset name, maximum length of 100 characters | 必选 数据集名称，最大长度为 100 个字符
+   * @param {string} params.space_id - Required. Space ID where the dataset belongs | 必选 数据集所属的空间 ID
+   * @param {number} params.format_type - Required. Dataset type (0: Text type, 2: Image type) | 必选 数据集类型 (0: 文本类型, 2: 图片类型)
+   * @param {string} [params.description] - Optional. Dataset description | 可选 数据集描述
+   * @param {string} [params.file_id] - Optional. Dataset icon file ID from file upload
+   */ async create(params, options) {
+                const apiUrl = '/v1/datasets';
+                const response = await this._client.post(apiUrl, params, false, options);
+                return response.data;
+            }
+            /**
+   * Lists all datasets in a space | 列出空间中的所有数据集
+   * @docs en: https://www.coze.com/docs/developer_guides/list_dataset?_lang=en
+   * @docs zh: https://www.coze.cn/docs/developer_guides/list_dataset?_lang=zh
+   * @param params - The parameters for listing datasets | 列出数据集的参数
+   * @param {string} params.space_id - Required. Space ID where the datasets belong | 必选 数据集所属的空间 ID
+   * @param {string} [params.name] - Optional. Dataset name for fuzzy search | 可选 数据集名称用于模糊搜索
+   * @param {number} [params.format_type] - Optional. Dataset type (0: Text type, 2: Image type) | 可选 数据集类型 (0: 文本类型, 2: 图片类型)
+   * @param {number} [params.page_num] - Optional. Page number for pagination (default: 1) | 可选 分页查询时的页码。默认为 1。
+   * @param {number} [params.page_size] - Optional. Number of items per page (default: 10) | 可选 分页大小。默认为 10。
+   */ async list(params, options) {
+                const apiUrl = '/v1/datasets';
+                const response = await this._client.get(apiUrl, params, false, options);
+                return response.data;
+            }
+            /**
+   * Updates a dataset | 更新数据集
+   * @docs en: https://www.coze.com/docs/developer_guides/update_dataset?_lang=en
+   * @docs zh: https://www.coze.cn/docs/developer_guides/update_dataset?_lang=zh
+   * @param dataset_id - Required. The ID of the dataset to update | 必选 数据集 ID
+   * @param params - Required. The parameters for updating the dataset | 必选 更新数据集的参数
+   * @param params.name - Required. Dataset name, maximum length of 100 characters. | 必选 数据集名称，最大长度为 100 个字符。
+   * @param params.file_id - Optional. Dataset icon, should pass the file_id obtained from the file upload interface. | 可选 数据集图标，应传递从文件上传接口获取的 file_id。
+   * @param params.description - Optional. Dataset description. | 可选 数据集描述。
+   */ async update(dataset_id, params, options) {
+                const apiUrl = `/v1/datasets/${dataset_id}`;
+                await this._client.put(apiUrl, params, false, options);
+            }
+            /**
+   * Deletes a dataset | 删除数据集
+   * @docs en: https://www.coze.com/docs/developer_guides/delete_dataset?_lang=en
+   * @docs zh: https://www.coze.cn/docs/developer_guides/delete_dataset?_lang=zh
+   * @param dataset_id - Required. The ID of the dataset to delete | 必选 数据集 ID
+   */ async delete(dataset_id, options) {
+                const apiUrl = `/v1/datasets/${dataset_id}`;
+                await this._client.delete(apiUrl, false, options);
+            }
+            /**
+   * Views the progress of dataset upload | 查看数据集上传进度
+   * @docs en: https://www.coze.com/docs/developer_guides/get_dataset_progress?_lang=en
+   * @docs zh: https://www.coze.cn/docs/developer_guides/get_dataset_progress?_lang=zh
+   * @param dataset_id - Required. The ID of the dataset to process | 必选 数据集 ID
+   * @param params - Required. The parameters for processing the dataset | 必选 处理数据集的参数
+   * @param params.dataset_ids - Required. List of dataset IDs | 必选 数据集 ID 列表
+   */ async process(dataset_id, params, options) {
+                const apiUrl = `/v1/datasets/${dataset_id}/process`;
+                const response = await this._client.post(apiUrl, params, false, options);
+                return response.data;
+            }
             constructor(...args){
-                super(...args), this.documents = new documents_Documents(this._client);
+                super(...args), this.documents = new documents_Documents(this._client), this.images = new Images(this._client);
             }
         }
         class Voices extends APIResource {
@@ -3750,6 +3847,8 @@
    * | 如果传入会基于该文本生成预览音频，否则使用默认的文本
    * @param params.text - Optional. Users can read this text, service will compare audio with text. Returns error if difference is too large
    * | 可以让用户按照该文本念诵，服务会对比音频与该文本的差异。若差异过大会返回错误
+   * @param params.space_id - Optional.  The space id of the voice. | 空间ID
+   * @param params.description- Optional. The description of the voice. | 音色描述
    * @param options - Request options
    * @returns Clone voice data
    */ async clone(params, options) {
@@ -3774,6 +3873,17 @@
                 return response.data;
             }
         }
+        class Transcriptions extends APIResource {
+            /**
+   * ASR voice to text | ASR 语音转文本
+   * @param params - Required The parameters for file upload | 上传文件所需的参数
+   * @param params.file - Required The audio file to be uploaded. | 需要上传的音频文件。
+   */ async create(params, options) {
+                const apiUrl = '/v1/audio/transcriptions';
+                const response = await this._client.post(apiUrl, axios_toFormData(params), false, options);
+                return response.data;
+            }
+        }
         class Speech extends APIResource {
             /**
    * @description Speech synthesis | 语音合成
@@ -3787,7 +3897,10 @@
    * @returns Speech synthesis data
    */ async create(params, options) {
                 const apiUrl = '/v1/audio/speech';
-                const response = await this._client.post(apiUrl, params, false, mergeConfig(options, {
+                const response = await this._client.post(apiUrl, {
+                    ...params,
+                    sample_rate: params.sample_rate || 24000
+                }, false, mergeConfig(options, {
                     responseType: 'arraybuffer'
                 }));
                 return response;
@@ -3802,13 +3915,27 @@
         }
         class audio_Audio extends APIResource {
             constructor(...args){
-                super(...args), this.rooms = new Rooms(this._client), this.voices = new Voices(this._client), this.speech = new Speech(this._client);
+                super(...args), this.rooms = new Rooms(this._client), this.voices = new Voices(this._client), this.speech = new Speech(this._client), this.transcriptions = new Transcriptions(this._client);
+            }
+        }
+        class Templates extends APIResource {
+            /**
+   * Duplicate a template. | 复制一个模板。
+   * @param templateId - Required. The ID of the template to duplicate. | 要复制的模板的 ID。
+   * @param params - Optional. The parameters for the duplicate operation. | 可选参数，用于复制操作。
+   * @param params.workspace_id - Required. The ID of the workspace to duplicate the template into. | 要复制到的目标工作空间的 ID。
+   * @param params.name - Optional. The name of the new template. | 新模板的名称。
+   * @returns TemplateDuplicateRes | 复制模板结果
+   */ async duplicate(templateId, params, options) {
+                const apiUrl = `/v1/templates/${templateId}/duplicate`;
+                const response = await this._client.post(apiUrl, params, false, options);
+                return response.data;
             }
         }
         // EXTERNAL MODULE: os (ignored)
         var os_ignored_ = __webpack_require__("?9050");
         var os_ignored_default = /*#__PURE__*/ __webpack_require__.n(os_ignored_);
-        var package_namespaceObject = JSON.parse('{"name":"@coze/api","version":"1.0.16-beta.1","description":"Official Coze Node.js SDK for seamless AI integration into your applications | 扣子官方 Node.js SDK，助您轻松集成 AI 能力到应用中","keywords":["coze","ai","nodejs","sdk","chatbot","typescript"],"homepage":"https://github.com/coze-dev/coze-js/tree/main/packages/coze-js","bugs":{"url":"https://github.com/coze-dev/coze-js/issues"},"repository":{"type":"git","url":"https://github.com/coze-dev/coze-js.git","directory":"packages/coze-js"},"license":"MIT","author":"Leeight <leeight@gmail.com>","type":"module","main":"src/index.ts","browser":{"crypto":false,"os":false,"jsonwebtoken":false},"types":"src/index.ts","files":["dist","LICENSE","README.md"],"scripts":{"build":"rm -rf dist && rslib build","format":"prettier --write .","lint":"eslint ./ --cache --quiet","start":"rm -rf dist && rslib build -w","test":"vitest","test:cov":"vitest --coverage --run"},"dependencies":{"jsonwebtoken":"^9.0.2"},"devDependencies":{"@coze-infra/eslint-config":"workspace:*","@coze-infra/ts-config":"workspace:*","@coze-infra/vitest-config":"workspace:*","@rslib/core":"0.0.18","@swc/core":"^1.3.14","@types/jsonwebtoken":"^9.0.0","@types/node":"^20","@types/uuid":"^9.0.1","@types/whatwg-fetch":"^0.0.33","@vitest/coverage-v8":"~2.1.4","axios":"^1.7.7","typescript":"^5.5.3","vitest":"~2.1.4"},"peerDependencies":{"axios":"^1.7.1"},"cozePublishConfig":{"exports":{".":{"require":"./dist/cjs/index.cjs","import":"./dist/esm/index.js","types":"./dist/types/index.d.ts"}},"main":"dist/cjs/index.cjs","module":"dist/esm/index.js","types":"dist/types/index.d.ts"}}'); // CONCATENATED MODULE: ../coze-js/src/version.ts
+        var package_namespaceObject = JSON.parse('{"name":"@coze/api","version":"1.0.16","description":"Official Coze Node.js SDK for seamless AI integration into your applications | 扣子官方 Node.js SDK，助您轻松集成 AI 能力到应用中","keywords":["coze","ai","nodejs","sdk","chatbot","typescript"],"homepage":"https://github.com/coze-dev/coze-js/tree/main/packages/coze-js","bugs":{"url":"https://github.com/coze-dev/coze-js/issues"},"repository":{"type":"git","url":"https://github.com/coze-dev/coze-js.git","directory":"packages/coze-js"},"license":"MIT","author":"Leeight <leeight@gmail.com>","type":"module","exports":{".":"./src/index.ts"},"main":"src/index.ts","module":"src/index.ts","browser":{"crypto":false,"os":false,"jsonwebtoken":false},"types":"src/index.ts","files":["dist","LICENSE","README.md","README.zh-CN.md"],"scripts":{"build":"rm -rf dist && rslib build","format":"prettier --write .","lint":"eslint ./ --cache --quiet","start":"rm -rf dist && rslib build -w","test":"vitest","test:cov":"vitest --coverage --run"},"dependencies":{"jsonwebtoken":"^9.0.2"},"devDependencies":{"@coze-infra/eslint-config":"workspace:*","@coze-infra/ts-config":"workspace:*","@coze-infra/vitest-config":"workspace:*","@rslib/core":"0.0.18","@swc/core":"^1.3.14","@types/jsonwebtoken":"^9.0.0","@types/node":"^20","@types/uuid":"^9.0.1","@types/whatwg-fetch":"^0.0.33","@vitest/coverage-v8":"~2.1.4","axios":"^1.7.7","typescript":"^5.5.3","vitest":"~2.1.4"},"peerDependencies":{"axios":"^1.7.1"},"cozePublishConfig":{"exports":{".":{"require":"./dist/cjs/index.cjs","import":"./dist/esm/index.js","types":"./dist/types/index.d.ts"}},"main":"dist/cjs/index.cjs","module":"dist/esm/index.js","types":"dist/types/index.d.ts"}}'); // CONCATENATED MODULE: ../coze-js/src/version.ts
         const { version: version_version } = package_namespaceObject;
         const getEnv = ()=>{
             const nodeVersion = process.version.slice(1); // Remove 'v' prefix
@@ -3858,6 +3985,55 @@
             };
             return JSON.stringify(ua);
         };
+        const getBrowserClientUserAgent = ()=>{
+            const browserInfo = {
+                name: 'unknown',
+                version: 'unknown'
+            };
+            const osInfo = {
+                name: 'unknown',
+                version: 'unknown'
+            };
+            const { userAgent } = navigator;
+            // 检测操作系统及版本
+            if (userAgent.indexOf('Windows') > -1) {
+                var _userAgent_match;
+                osInfo.name = 'windows';
+                const windowsVersion = (null === (_userAgent_match = userAgent.match(/Windows NT ([0-9.]+)/)) || void 0 === _userAgent_match ? void 0 : _userAgent_match[1]) || 'unknown';
+                osInfo.version = windowsVersion;
+            } else if (userAgent.indexOf('Mac OS X') > -1) {
+                var _userAgent_match1;
+                osInfo.name = 'macos';
+                // 将 10_15_7 格式转换为 10.15.7
+                osInfo.version = ((null === (_userAgent_match1 = userAgent.match(/Mac OS X ([0-9_]+)/)) || void 0 === _userAgent_match1 ? void 0 : _userAgent_match1[1]) || 'unknown').replace(/_/g, '.');
+            } else if (userAgent.indexOf('Linux') > -1) {
+                var _userAgent_match2;
+                osInfo.name = 'linux';
+                osInfo.version = (null === (_userAgent_match2 = userAgent.match(/Linux ([0-9.]+)/)) || void 0 === _userAgent_match2 ? void 0 : _userAgent_match2[1]) || 'unknown';
+            }
+            // 检测浏览器及版本
+            if (userAgent.indexOf('Chrome') > -1) {
+                var _userAgent_match3;
+                browserInfo.name = 'chrome';
+                browserInfo.version = (null === (_userAgent_match3 = userAgent.match(/Chrome\/([0-9.]+)/)) || void 0 === _userAgent_match3 ? void 0 : _userAgent_match3[1]) || 'unknown';
+            } else if (userAgent.indexOf('Firefox') > -1) {
+                var _userAgent_match4;
+                browserInfo.name = 'firefox';
+                browserInfo.version = (null === (_userAgent_match4 = userAgent.match(/Firefox\/([0-9.]+)/)) || void 0 === _userAgent_match4 ? void 0 : _userAgent_match4[1]) || 'unknown';
+            } else if (userAgent.indexOf('Safari') > -1) {
+                var _userAgent_match5;
+                browserInfo.name = 'safari';
+                browserInfo.version = (null === (_userAgent_match5 = userAgent.match(/Version\/([0-9.]+)/)) || void 0 === _userAgent_match5 ? void 0 : _userAgent_match5[1]) || 'unknown';
+            }
+            const ua = {
+                version: version_version,
+                browser: browserInfo.name,
+                browser_version: browserInfo.version,
+                os_name: osInfo.name,
+                os_version: osInfo.version
+            };
+            return JSON.stringify(ua);
+        };
         /* eslint-disable @typescript-eslint/no-explicit-any */ const fetcher_handleError = (error)=>{
             if (!error.isAxiosError && (!error.code || !error.message)) return new CozeError(`Unexpected error: ${error.message}`);
             if ('ECONNABORTED' === error.code && error.message.includes('timeout') || 'ETIMEDOUT' === error.code) {
@@ -3957,12 +4133,15 @@
                 const headers = {
                     authorization: `Bearer ${token}`
                 };
-                if (!utils_isBrowser()) {
+                if (utils_isBrowser()) headers['X-Coze-Client-User-Agent'] = getBrowserClientUserAgent();
+                else {
                     headers['User-Agent'] = getUserAgent();
                     headers['X-Coze-Client-User-Agent'] = getNodeClientUserAgent();
                 }
                 const config = mergeConfig(this.axiosOptions, options, {
                     headers
+                }, {
+                    headers: this.headers || {}
                 });
                 config.method = method;
                 config.data = body;
@@ -3973,11 +4152,11 @@
                 const fetchOptions = await this.buildOptions(method, body, options);
                 fetchOptions.isStreaming = isStream;
                 fetchOptions.axiosInstance = this.axiosInstance;
-                this.debugLog(`--- request url: ${fullUrl}`);
-                this.debugLog('--- request options:', fetchOptions);
+                this.debugLog(null == options ? void 0 : options.debug, `--- request url: ${fullUrl}`);
+                this.debugLog(null == options ? void 0 : options.debug, '--- request options:', fetchOptions);
                 const { response, stream, json } = await fetchAPI(fullUrl, fetchOptions);
-                this.debugLog(`--- response status: ${response.status}`);
-                this.debugLog('--- response headers: ', response.headers);
+                this.debugLog(null == options ? void 0 : options.debug, `--- response status: ${response.status}`);
+                this.debugLog(null == options ? void 0 : options.debug, '--- response headers: ', response.headers);
                 var _response_headers;
                 // Taro use `header`
                 const contentType = (null !== (_response_headers = response.headers) && void 0 !== _response_headers ? _response_headers : response.header)['content-type'];
@@ -4020,8 +4199,9 @@
             }
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
             debugLog() {
-                for(var _len = arguments.length, msgs = new Array(_len), _key = 0; _key < _len; _key++)msgs[_key] = arguments[_key];
-                if (this.debug) console.debug(...msgs);
+                let forceDebug = arguments.length > 0 && void 0 !== arguments[0] && arguments[0];
+                for(var _len = arguments.length, msgs = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++)msgs[_key - 1] = arguments[_key];
+                if (this.debug || forceDebug) console.debug(...msgs);
             }
             constructor(config){
                 this._config = config;
@@ -4053,7 +4233,7 @@
             constructor(...args){
                 super(...args), this.bots = new Bots(this), this.chat = new Chat(this), this.conversations = new Conversations(this), this.files = new Files(this), /**
    * @deprecated
-   */ this.knowledge = new Knowledge(this), this.datasets = new Datasets(this), this.workflows = new Workflows(this), this.workspaces = new WorkSpaces(this), this.audio = new audio_Audio(this);
+   */ this.knowledge = new Knowledge(this), this.datasets = new Datasets(this), this.workflows = new Workflows(this), this.workspaces = new WorkSpaces(this), this.audio = new audio_Audio(this), this.templates = new Templates(this);
             }
         }
         /**
@@ -38458,7 +38638,11 @@
                 return false;
             }
         };
-        const checkDevicePermission = async function() {
+        /**
+ * Checks device permissions for audio and video
+ * @param checkVideo Whether to check video permissions (default: false)
+ * @returns Promise that resolves with the device permission status
+ */ const checkDevicePermission = async function() {
             let checkVideo = arguments.length > 0 && void 0 !== arguments[0] && arguments[0];
             return await index_esm_min_index.enableDevices({
                 audio: true,
@@ -38471,7 +38655,16 @@
  */ const getAudioDevices = async function() {
             let { video = false } = arguments.length > 0 && void 0 !== arguments[0] ? arguments[0] : {};
             let devices = [];
-            devices = video ? await index_esm_min_index.enumerateDevices() : await [
+            if (video) {
+                devices = await index_esm_min_index.enumerateDevices();
+                if (isScreenShareSupported()) // @ts-expect-error - add screenShare device to devices
+                devices.push({
+                    deviceId: 'screenShare',
+                    kind: 'videoinput',
+                    label: 'Screen Share',
+                    groupId: 'screenShare'
+                });
+            } else devices = await [
                 ...await index_esm_min_index.enumerateAudioCaptureDevices(),
                 ...await index_esm_min_index.enumerateAudioPlaybackDevices()
             ];
@@ -38486,6 +38679,14 @@
                 videoInputs: devices.filter((i)=>i.deviceId && 'videoinput' === i.kind)
             };
         };
+        const isScreenShareDevice = (deviceId)=>'screenShare' === deviceId;
+        /**
+ * Check if browser supports screen sharing
+ * 检查浏览器是否支持屏幕共享
+ */ function isScreenShareSupported() {
+            var _navigator_mediaDevices, _navigator;
+            return !!(null === (_navigator = navigator) || void 0 === _navigator ? void 0 : null === (_navigator_mediaDevices = _navigator.mediaDevices) || void 0 === _navigator_mediaDevices ? void 0 : _navigator_mediaDevices.getDisplayMedia);
+        }
         var error_RealtimeError = /*#__PURE__*/ function(RealtimeError) {
             RealtimeError["DEVICE_ACCESS_ERROR"] = "DEVICE_ACCESS_ERROR";
             RealtimeError["STREAM_CREATION_ERROR"] = "STREAM_CREATION_ERROR";
@@ -38579,6 +38780,10 @@
    * zh: 音频输出设备改变
    */ EventNames["AUDIO_OUTPUT_DEVICE_CHANGED"] = "client.output.device.changed";
             /**
+   * en: Video input device changed
+   * zh: 视频输入设备改变
+   */ EventNames["VIDEO_INPUT_DEVICE_CHANGED"] = "client.video.input.device.changed";
+            /**
    * en: Bot joined
    * zh: Bot 加入
    */ EventNames["BOT_JOIN"] = "server.bot.join";
@@ -41996,23 +42201,47 @@
                 if (-1 === devices.audioOutputs.findIndex((i)=>i.deviceId === deviceId)) throw new RealtimeAPIError(error_RealtimeError.DEVICE_ACCESS_ERROR, `Audio output device not found: ${deviceId}`);
                 await this.engine.setAudioPlaybackDevice(deviceId);
             }
+            async setVideoInputDevice(deviceId) {
+                let isAutoCapture = !(arguments.length > 1) || void 0 === arguments[1] || arguments[1];
+                var _this__videoConfig;
+                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}`);
+                await this.changeVideoState(false);
+                if (isScreenShareDevice(deviceId)) {
+                    if (this._streamIndex === StreamIndex$1.STREAM_INDEX_MAIN) this.engine.setLocalVideoPlayer(StreamIndex$1.STREAM_INDEX_MAIN);
+                    if (isAutoCapture) {
+                        var _this__videoConfig1;
+                        this.engine.setVideoSourceType(StreamIndex$1.STREAM_INDEX_SCREEN, VideoSourceType.VIDEO_SOURCE_TYPE_INTERNAL);
+                        await this.engine.startScreenCapture(null === (_this__videoConfig1 = this._videoConfig) || void 0 === _this__videoConfig1 ? void 0 : _this__videoConfig1.screenConfig);
+                        await this.engine.publishScreen(MediaType$1.VIDEO);
+                    }
+                    this._streamIndex = StreamIndex$1.STREAM_INDEX_SCREEN;
+                } else {
+                    if (this._streamIndex === StreamIndex$1.STREAM_INDEX_SCREEN) this.engine.setLocalVideoPlayer(StreamIndex$1.STREAM_INDEX_SCREEN);
+                    if (isAutoCapture) await this.engine.startVideoCapture(deviceId);
+                    this._streamIndex = StreamIndex$1.STREAM_INDEX_MAIN;
+                }
+                this.engine.setLocalVideoPlayer(this._streamIndex, {
+                    renderDom: (null === (_this__videoConfig = this._videoConfig) || void 0 === _this__videoConfig ? void 0 : _this__videoConfig.renderDom) || 'local-player',
+                    userId: this._roomUserId
+                });
+            }
             async createLocalStream(userId, videoConfig) {
+                this._roomUserId = userId;
                 const devices = await getAudioDevices({
                     video: this._isSupportVideo
                 });
                 if (!devices.audioInputs.length) throw new RealtimeAPIError(error_RealtimeError.DEVICE_ACCESS_ERROR, 'Failed to get audio devices');
                 if (this._isSupportVideo && !devices.videoInputs.length) throw new RealtimeAPIError(error_RealtimeError.DEVICE_ACCESS_ERROR, 'Failed to get video devices');
                 await this.engine.startAudioCapture(devices.audioInputs[0].deviceId);
-                if (this._isSupportVideo && (null == videoConfig ? void 0 : videoConfig.videoOnDefault)) await this.engine.startVideoCapture(devices.videoInputs[0].deviceId);
-                if (this._isSupportVideo) this.engine.setLocalVideoPlayer(StreamIndex$1.STREAM_INDEX_MAIN, {
-                    renderDom: (null == videoConfig ? void 0 : videoConfig.renderDom) || 'local-player',
-                    userId
-                });
+                if (this._isSupportVideo) this.setVideoInputDevice((null == videoConfig ? void 0 : videoConfig.videoInputDeviceId) || devices.videoInputs[0].deviceId, null == videoConfig ? void 0 : videoConfig.videoOnDefault);
             }
             async disconnect() {
                 try {
-                    if (this._isSupportVideo) await this.engine.stopVideoCapture();
-                    await this.engine.stopAudioCapture();
+                    if (this._isSupportVideo) await this.changeVideoState(false);
+                    await this.changeAudioState(false);
                     await this.engine.unpublishStream(MediaType$1.AUDIO);
                     await this.engine.leaveRoom();
                     this.removeEventListener();
@@ -42032,8 +42261,19 @@
             }
             async changeVideoState(isVideoOn) {
                 try {
-                    if (isVideoOn) await this.engine.startVideoCapture();
-                    else await this.engine.stopVideoCapture();
+                    if (isVideoOn) {
+                        if (this._streamIndex === StreamIndex$1.STREAM_INDEX_MAIN) await this.engine.startVideoCapture();
+                        else {
+                            var _this__videoConfig;
+                            this.engine.setVideoSourceType(StreamIndex$1.STREAM_INDEX_SCREEN, VideoSourceType.VIDEO_SOURCE_TYPE_INTERNAL);
+                            await this.engine.startScreenCapture(null === (_this__videoConfig = this._videoConfig) || void 0 === _this__videoConfig ? void 0 : _this__videoConfig.screenConfig);
+                            await this.engine.publishScreen(MediaType$1.VIDEO);
+                        }
+                    } else if (this._streamIndex === StreamIndex$1.STREAM_INDEX_MAIN) await this.engine.stopVideoCapture();
+                    else {
+                        await this.engine.stopScreenCapture();
+                        await this.engine.unpublishScreen(MediaType$1.VIDEO);
+                    }
                 } catch (e) {
                     this.dispatch(event_handler_EventNames.ERROR, e);
                     throw e;
@@ -42110,8 +42350,11 @@
                     throw e;
                 }
             }
+            getRtcEngine() {
+                return this.engine;
+            }
             // eslint-disable-next-line max-params
-            constructor(appId, debug = false, isTestEnv = false, isSupportVideo = false){
+            constructor(appId, debug = false, isTestEnv = false, isSupportVideo = false, videoConfig){
                 super(debug), this.joinUserId = '', this._AIAnsExtension = null, this._isSupportVideo = false;
                 if (isTestEnv) index_esm_min_index.setParameter('ICE_CONFIG_REQUEST_URLS', [
                     'rtc-test.bytedance.com'
@@ -42126,6 +42369,7 @@
                 this.handleLocalAudioPropertiesReport = this.handleLocalAudioPropertiesReport.bind(this);
                 this.handleRemoteAudioPropertiesReport = this.handleRemoteAudioPropertiesReport.bind(this);
                 this._isSupportVideo = isSupportVideo;
+                this._videoConfig = videoConfig;
             }
         }
         class RealtimeClient extends RealtimeEventHandler {
@@ -42141,16 +42385,17 @@
                     // Step1 get token
                     roomInfo = await this._api.audio.rooms.create({
                         bot_id: botId,
-                        conversation_id: conversationId,
+                        conversation_id: conversationId || void 0,
                         voice_id: voiceId && voiceId.length > 0 ? voiceId : void 0,
-                        connector_id: this._config.connectorId
+                        connector_id: this._config.connectorId,
+                        uid: this._config.userId || void 0
                     });
                 } catch (error) {
                     this.dispatch(event_handler_EventNames.ERROR, error);
                     throw new RealtimeAPIError(error_RealtimeError.CREATE_ROOM_ERROR, error instanceof Error ? error.message : 'Unknown error', error);
                 }
                 // Step2 create engine
-                this._client = new EngineClient(roomInfo.app_id, this._config.debug, this._isTestEnv, this._isSupportVideo);
+                this._client = new EngineClient(roomInfo.app_id, this._config.debug, this._isTestEnv, this._isSupportVideo, this._config.videoConfig);
                 // Step3 bind engine events
                 this._client.bindEngineEvents();
                 this._client.on(event_handler_EventNames.ALL, (eventName, data)=>{
@@ -42286,6 +42531,21 @@
                     deviceId
                 });
             }
+            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_handler_EventNames.VIDEO_INPUT_DEVICE_CHANGED, {
+                    deviceId
+                });
+            }
+            /**
+   * en: Get the RTC engine instance, for detail visit https://www.volcengine.com/docs/6348/104481
+   *
+   * zh: 获取 RTC 引擎实例，详情请访问 https://www.volcengine.com/docs/6348/104481
+   */ getRtcEngine() {
+                var _this__client;
+                return null === (_this__client = this._client) || void 0 === _this__client ? void 0 : _this__client.getRtcEngine();
+            }
             /**
    * Constructor for initializing a RealtimeClient instance.
    *
@@ -42300,6 +42560,8 @@
    *                         可选，音色Id。
    * @param config.conversationId - Optional, Conversation Id. |
    *                               可选，会话Id。
+   * @param config.userId - Optional, User Id. |
+   *                        可选，用户Id。
    * @param config.baseURL - Optional, defaults to "https://api.coze.cn". |
    *                        可选，默认值为 "https://api.coze.cn"。
    * @param config.debug - Optional, defaults to false.
@@ -42316,6 +42578,16 @@
    * @param config.suppressNonStationaryNoise - Optional, suppress non-stationary noise, defaults to false. |
    *                                         可选，默认是否抑制非静态噪声，默认值为 false。
    * @param config.isAutoSubscribeAudio - Optional, whether to automatically subscribe to bot reply audio streams, defaults to true. |
+   * @param config.videoConfig - Optional, Video configuration. |
+   *                            可选，视频配置。
+   * @param config.videoConfig.videoOnDefault - Optional, Whether to turn on video by default, defaults to true. |
+   *                                            可选，默认是否开启视频，默认值为 true。
+   * @param config.videoConfig.renderDom - Optional, The DOM element to render the video stream to. |
+   *                                       可选，渲染视频流的 DOM 元素。
+   * @param config.videoConfig.videoInputDeviceId - Optional, The device ID of the video input device to use. |
+   *                                               可选，视频输入设备的设备 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 了解更多详情。
    */ constructor(config){
                 super(config.debug), this._client = null, this.isConnected = false, this._isTestEnv = false, this._isSupportVideo = false;
                 this._config = config;