@coze/realtime-api 1.0.1 → 1.0.3-beta.1

package/dist/tsconfig.build.tsbuildinfo

@@ -0,0 +1 @@
+{"version":"5.6.3"}

package/dist/types/client.d.ts

@@ -21,6 +21,7 @@ export declare class EngineClient extends RealtimeEventHandler {
         uid: string;
         audioMutedDefault?: boolean;
         videoOnDefault?: boolean;
+        isAutoSubscribeAudio?: boolean;
     }): Promise<void>;
     setAudioInputDevice(deviceId: string): Promise<void>;
     setAudioOutputDevice(deviceId: string): Promise<void>;

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

@@ -88,9 +88,44 @@ export declare enum EventNames {
      * en: Bot left
      * zh: Bot 离开
      */
-    BOT_LEAVE = "server.bot.leave"
+    BOT_LEAVE = "server.bot.leave",
+    /**
+     * en: Audio speech started
+     * zh: 开始说话
+     */
+    AUDIO_AGENT_SPEECH_STARTED = "server.audio.agent.speech_started",
+    /**
+     * en: Audio speech stopped
+     * zh: 停止说话
+     */
+    AUDIO_SPEECH_STOPPED = "server.audio.speech_stopped",
+    /**
+     * en: Server error
+     * zh: 服务端错误
+     */
+    SERVER_ERROR = "server.error",
+    /**
+     * en: User speech started
+     * zh: 用户开始说话
+     */
+    AUDIO_USER_SPEECH_STARTED = "server.audio.user.speech_started",
+    /**
+     * en: User speech stopped
+     * zh: 用户停止说话
+     */
+    AUDIO_USER_SPEECH_STOPPED = "server.audio.user.speech_stopped",
+    /**
+     * en: User successfully enters the room
+     * zh: 用户成功进入房间后，会收到该事件
+     */
+    SESSION_CREATED = "server.session.created",
+    /**
+     * en: Session updated
+     * zh: 会话更新
+     */
+    SESSION_UPDATE = "server.session.update"
 }
-type EventCallback = (eventName: string, event: unknown) => void;
+export type EventCallback = (eventName: string, event: unknown) => void;
 export declare class RealtimeEventHandler {
     private eventHandlers;
     protected _debug: boolean;
@@ -99,7 +134,6 @@ export declare class RealtimeEventHandler {
     on(eventName: string, callback: EventCallback): EventCallback;
     off(eventName: string, callback: EventCallback): void;
     private _dispatchToHandlers;
-    dispatch(eventName: string, event: unknown): void;
+    dispatch(eventName: string, event: unknown, consoleLog?: boolean): void;
     _log(message: string): void;
 }
-export {};

package/dist/types/index.d.ts

@@ -1,4 +1,5 @@
 import { type AudioPropertiesConfig } from '@volcengine/rtc';
+import { type GetToken } from '@coze/api';
 import * as RealtimeUtils from './utils';
 import { RealtimeEventHandler, EventNames } from './event-handler';
 import { RealtimeAPIError, RealtimeError } from './error';
@@ -7,7 +8,7 @@ export interface VideoConfig {
     renderDom?: string /** optional, The DOM element to render the video stream to */;
 }
 export interface RealtimeClientConfig {
-    accessToken: string /** required, Access Token */;
+    accessToken: GetToken /** required, Access Token */;
     botId: string /** required, Bot Id */;
     voiceId?: string /** optional, Voice Id */;
     conversationId?: string /** optional, Conversation Id */;
@@ -22,6 +23,7 @@ export interface RealtimeClientConfig {
     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 */;
 }
 declare class RealtimeClient extends RealtimeEventHandler {
     private _config;
@@ -59,6 +61,7 @@ declare class RealtimeClient extends RealtimeEventHandler {
      *                                       可选，默认是否抑制静态噪声，默认值为 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. |
      */
     constructor(config: RealtimeClientConfig);
     /**

package/dist/types/utils.d.ts

@@ -6,19 +6,27 @@
 + */
 export declare const sleep: (milliseconds: number) => Promise<void>;
 /**
+ * @deprecated use checkDevicePermission instead
  * Check microphone permission，return boolean
  */
 export declare const checkPermission: ({ audio, video, }?: {
     audio?: boolean;
     video?: boolean;
 }) => Promise<boolean>;
+export declare const checkDevicePermission: (checkVideo?: boolean) => Promise<{
+    video: boolean;
+    audio: boolean;
+    videoExceptionError?: DOMException | undefined;
+    audioExceptionError?: DOMException | undefined;
+}>;
 /**
  * Get audio devices
  * @returns Promise<AudioDevices> Object containing arrays of audio input and output devices
  */
-export declare const getAudioDevices: () => Promise<{
+export declare const getAudioDevices: ({ video, }?: {
+    video?: boolean;
+}) => Promise<{
     audioInputs: MediaDeviceInfo[];
     audioOutputs: MediaDeviceInfo[];
     videoInputs: MediaDeviceInfo[];
-    videoOutputs: MediaDeviceInfo[];
 }>;