@coze/realtime-api 1.3.1 → 1.3.2

package/dist/cjs/index.js

@@ -702,6 +702,7 @@ class RealtimeClient extends RealtimeEventHandler {
                     };
                 }
                 if (this._config.translateConfig) config.translate_config = this._config.translateConfig;
+                if (this._config.turnDetection) config.turn_detection = this._config.turnDetection;
                 const params = {
                     bot_id: botId,
                     conversation_id: conversationId || void 0,

package/dist/esm/index.js

@@ -673,6 +673,7 @@ class RealtimeClient extends RealtimeEventHandler {
                     };
                 }
                 if (this._config.translateConfig) config.translate_config = this._config.translateConfig;
+                if (this._config.turnDetection) config.turn_detection = this._config.turnDetection;
                 const params = {
                     bot_id: botId,
                     conversation_id: conversationId || void 0,

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

@@ -1,5 +1,5 @@
 import { type ScreenConfig, type AudioPropertiesConfig, type IRTCEngine } from '@volcengine/rtc';
-import { RoomMode, type CreateRoomData, type GetToken, type TranslateConfig } from '@coze/api';
+import { RoomMode, type CreateRoomData, type GetToken, type TranslateConfig, type CreateRoomTurnDetection } from '@coze/api';
 import * as RealtimeUtils from './utils';
 import EventNames from './event-names';
 import { RealtimeEventHandler } from './event-handler';
@@ -33,6 +33,7 @@ export interface RealtimeClientConfig {
     prologueContent?: string /** optional, Prologue content */;
     roomMode?: RoomMode /** optional, Room mode */;
     translateConfig?: TranslateConfig /** optional, Translation configuration */;
+    turnDetection?: CreateRoomTurnDetection /** optional, Turn detection */;
 }
 declare class RealtimeClient extends RealtimeEventHandler {
     _config: RealtimeClientConfig;

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
 import { type ScreenConfig, type AudioPropertiesConfig, type IRTCEngine } from '@volcengine/rtc';
-import { RoomMode, type CreateRoomData, type GetToken, type TranslateConfig } from '@coze/api';
+import { RoomMode, type CreateRoomData, type GetToken, type TranslateConfig, type CreateRoomTurnDetection } from '@coze/api';
 import * as RealtimeUtils from './utils';
 import EventNames from './event-names';
 import { RealtimeEventHandler } from './event-handler';
@@ -33,6 +33,7 @@ export interface RealtimeClientConfig {
     prologueContent?: string /** optional, Prologue content */;
     roomMode?: RoomMode /** optional, Room mode */;
     translateConfig?: TranslateConfig /** optional, Translation configuration */;
+    turnDetection?: CreateRoomTurnDetection /** optional, Turn detection */;
 }
 declare class RealtimeClient extends RealtimeEventHandler {
     _config: RealtimeClientConfig;

package/dist/types/live/index.d.ts

@@ -1,86 +1,165 @@
-/**
- * WebRTC资源状态
- */
-export declare enum ResourceStatus {
-    IDLE = "idle",// 初始状态
-    CONNECTING = "connecting",// 连接中
-    CONNECTED = "connected",// 已连接
-    FAILED = "failed",// 连接失败
-    CLOSING = "closing",// 关闭中
-    CLOSED = "closed"
+import { type ScreenConfig, type AudioPropertiesConfig, type IRTCEngine } from '@volcengine/rtc';
+import { RoomMode, type CreateRoomData, type GetToken, type TranslateConfig, type CreateRoomTurnDetection } from '@coze/api';
+import * as RealtimeUtils from './utils';
+import EventNames from './event-names';
+import { RealtimeEventHandler } from './event-handler';
+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 type StatusChangeCallback = (status: ResourceStatus) => void;
-/**
- * 同声传译客户端
- */
-export declare class WebLiveClient {
-    private peerConnection;
-    private resourceUrl;
-    private status;
-    private player;
-    private statusListeners;
-    private liveId;
-    constructor(liveId: string);
+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 */;
+    workflowId?: string /** optional, Workflow Id */;
+    baseURL?: string /** optional, defaults to "https://api.coze.cn" */;
+    debug?: boolean /** optional, defaults to false */;
+    getRoomInfo?: () => Promise<CreateRoomData> /** optional, Customize get room info */;
+    /** Whether Personal Access Tokens (PAT) are allowed in browser environments */
+    allowPersonalAccessTokenInBrowser?: boolean;
+    /** Whether to mute by default, defaults to false
+     * If set to true, audio streams will not be automatically published and subscribed */
+    audioMutedDefault?: boolean;
+    connectorId: string /** required, Connector Id */;
+    suppressStationaryNoise?: boolean /** optional, Suppress stationary noise, defaults to false */;
+    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 */;
+    roomMode?: RoomMode /** optional, Room mode */;
+    translateConfig?: TranslateConfig /** optional, Translation configuration */;
+    turnDetection?: CreateRoomTurnDetection /** optional, Turn detection */;
+}
+declare class RealtimeClient extends RealtimeEventHandler {
+    _config: RealtimeClientConfig;
+    private _client;
+    isConnected: boolean;
+    private _api;
+    private _isTestEnv;
+    _isSupportVideo: boolean;
+    /**
+     * Constructor for initializing a RealtimeClient instance.
+     *
+     * 构造函数，初始化RealtimeClient实例。
+     *
+     * @param config
+     * @param config.accessToken - Required, Access Token. |
+     *                            必填，Access Token。
+     * @param config.botId - Required, Bot Id. |
+     *                       必填，Bot Id。
+     * @param config.voiceId - Optional, Voice Id. |
+     *                         可选，音色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.
+     *                      可选，默认值为 false。
+     * @param config.allowPersonalAccessTokenInBrowser
+     * - Optional, whether to allow personal access tokens in browser environment. |
+     *   可选，是否允许在浏览器环境中使用个人访问令牌。
+     * @param config.audioMutedDefault - Optional, whether audio is muted by default, defaults to false. |
+     *                                  可选，默认是否静音，默认值为 false。
+     * @param config.connectorId - Required, Connector Id. |
+     *                             必填，渠道 Id。
+     * @param config.suppressStationaryNoise - Optional, suppress stationary noise, defaults to false. |
+     *                                       可选，默认是否抑制静态噪声，默认值为 false。
+     * @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 了解更多详情。
+     * @param config.prologueContent - Optional, Prologue content. | 可选，开场白内容。
+     * @param config.roomMode - Optional, Room mode. | 可选，房间模式。
+     */
+    constructor(config: RealtimeClientConfig);
     /**
-     * 获取当前连接状态
+     * en: Establish a connection to the Coze API and join the room
+     *
+     * zh: 建立与 Coze API 的连接并加入房间
      */
-    getStatus(): ResourceStatus;
+    connect(): Promise<void>;
     /**
-     * 添加状态变化监听器
-     * @param callback 状态变化回调函数
+     * en: Interrupt the current conversation
+     *
+     * zh: 中断当前对话
      */
-    onStatusChange(callback: StatusChangeCallback): void;
+    interrupt(): Promise<void>;
     /**
-     * 移除状态变化监听器
-     * @param callback 要移除的回调函数
+     * en: Disconnect from the current session
+     *
+     * zh: 断开与当前会话的连接
      */
-    offStatusChange(callback: StatusChangeCallback): void;
+    disconnect(): Promise<void>;
     /**
-     * 移除状态变化监听器
-     * @param callback 要移除的回调函数
+     * en: Send a message to the bot
+     *
+     * zh: 发送消息给Bot
      */
-    removeStatusListener(callback: StatusChangeCallback): void;
+    sendMessage(message: Record<string, unknown>): Promise<void>;
     /**
-     * 订阅音频资源
-     * @param appId 应用ID
-     * @param streamId 流ID
-     * @param clientId 客户端ID
+     * en: Enable or disable audio
+     *
+     * zh: 启用或禁用音频
      */
-    subscribe(appId: string, streamId: string, clientId?: string): Promise<{
-        status: ResourceStatus;
-        peerConnection: RTCPeerConnection;
-    }>;
+    setAudioEnable(isEnable: boolean): Promise<void>;
+    setVideoEnable(isEnable: boolean): Promise<void>;
     /**
-     * 销毁订阅资源
+     * en: Enable audio properties reporting (debug mode only)
+     *
+     * zh: 启用音频属性报告（仅限调试模式）
      */
-    unsubscribe(): Promise<boolean>;
+    enableAudioPropertiesReport(config?: AudioPropertiesConfig): boolean;
     /**
-     * 静音/取消静音
-     * @param muted 是否静音
+     * en: Start audio playback device test (debug mode only)
+     *
+     * zh: 开始音频播放设备测试（仅限调试模式）
      */
-    setMuted(muted: boolean): void;
+    startAudioPlaybackDeviceTest(): Promise<void>;
     /**
-     * 关闭并清理资源
+     * en: Stop audio playback device test (debug mode only)
+     *
+     * zh: 停止音频播放设备测试（仅限调试模式）
      */
-    close(): void;
+    stopAudioPlaybackDeviceTest(): void;
     /**
-     * 获取直播信息
+     * en: Set the audio input device
+     *
+     * zh: 设置音频输入设备
      */
-    getLiveData: () => Promise<import("@coze/api").RetrieveLiveData>;
+    setAudioInputDevice(deviceId: string): Promise<void>;
     /**
-     * 等待ICE收集完成
-     * @param pc RTCPeerConnection实例
+     * en: Set the audio output device
+     *
+     * zh: 设置音频输出设备
      */
-    private waitForIceGathering;
-    private setupPeerConnectionListeners;
+    setAudioOutputDevice(deviceId: string): Promise<void>;
     /**
-     * 关闭PeerConnection
+     * en: Set the video input device
+     *
+     * zh: 设置视频输入设备
      */
-    private closePeerConnection;
+    setVideoInputDevice(deviceId: string | 'screenShare' | 'user' | 'environment'): Promise<void>;
     /**
-     * 设置状态并触发监听回调
-     * @param newStatus 新状态
-     * @private 私有方法，仅内部使用
+     * 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
      */
-    private setStatus;
+    getRtcEngine(): IRTCEngine | undefined;
 }
+export { RealtimeUtils, RealtimeClient, RealtimeAPIError, RealtimeError, EventNames, };

package/dist/umd/index.js

@@ -740,6 +740,7 @@
                             };
                         }
                         if (this._config.translateConfig) config.translate_config = this._config.translateConfig;
+                        if (this._config.turnDetection) config.turn_detection = this._config.turnDetection;
                         const params = {
                             bot_id: botId,
                             conversation_id: conversationId || void 0,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coze/realtime-api",
-  "version": "1.3.1",
+  "version": "1.3.2",
   "description": "A powerful real-time communication SDK for voice interactions with Coze AI bots | 扣子官方实时通信 SDK，用于与 Coze AI bots 进行语音交互",
   "keywords": [
     "coze",
@@ -59,7 +59,7 @@
     "test:cov": "vitest --coverage --run"
   },
   "dependencies": {
-    "@coze/api": "1.3.3",
+    "@coze/api": "1.3.7",
     "@volcengine/rtc": "~4.62.11"
   },
   "devDependencies": {