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

package/dist/esm/index.js.LICENSE.txt

@@ -1 +1,23 @@
+/*!
+ * Reconnecting WebSocket
+ * by Pedro Ladaria <pedro.ladaria@gmail.com>
+ * https://github.com/pladaria/reconnecting-websocket
+ * License MIT
+ */
+
+/*! *****************************************************************************
+Copyright (c) Microsoft Corporation. All rights reserved.
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+this file except in compliance with the License. You may obtain a copy of the
+License at http://www.apache.org/licenses/LICENSE-2.0
+
+THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
+WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
+MERCHANTABLITY OR NON-INFRINGEMENT.
+
+See the Apache Version 2.0 License for specific language governing permissions
+and limitations under the License.
+***************************************************************************** */
+
 /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */

package/dist/types/client.d.ts

@@ -1,4 +1,4 @@
-import { type AudioPropertiesConfig, type onUserJoinedEvent, type onUserLeaveEvent, type UserMessageEvent } from '@volcengine/rtc';
+import { type AudioPropertiesConfig, type IRTCEngine, type onUserJoinedEvent, type onUserLeaveEvent, type UserMessageEvent } from '@volcengine/rtc';
 import { RealtimeEventHandler } from './event-handler';
 import { type VideoConfig } from '.';
 export declare class EngineClient extends RealtimeEventHandler {
@@ -43,4 +43,5 @@ export declare class EngineClient extends RealtimeEventHandler {
     changeAIAnsExtension(enable: boolean): void;
     startAudioPlaybackDeviceTest(): Promise<void>;
     stopAudioPlaybackDeviceTest(): void;
+    getRtcEngine(): IRTCEngine;
 }

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
-import { type ScreenConfig, type AudioPropertiesConfig } from '@volcengine/rtc';
-import { type GetToken } from '@coze/api';
+import { type ScreenConfig, type AudioPropertiesConfig, type IRTCEngine } from '@volcengine/rtc';
+import { type CreateRoomData, type GetToken } from '@coze/api';
 import * as RealtimeUtils from './utils';
 import { RealtimeEventHandler, EventNames } from './event-handler';
 import { RealtimeAPIError, RealtimeError } from './error';
@@ -14,8 +14,11 @@ export interface RealtimeClientConfig {
     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
@@ -48,6 +51,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.
@@ -138,5 +143,11 @@ declare class RealtimeClient extends RealtimeEventHandler {
      */
     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, };