@coze/realtime-api 0.0.4 → 1.0.0-alpha.7419f0

package/dist/tsconfig.build.tsbuildinfo

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

package/dist/types/client.d.ts

@@ -1,27 +1,34 @@
 import { type AudioPropertiesConfig, type onUserJoinedEvent, type onUserLeaveEvent, type UserMessageEvent } from '@volcengine/rtc';
 import { RealtimeEventHandler } from './event-handler';
+import { type VideoConfig } from '.';
 export declare class EngineClient extends RealtimeEventHandler {
     private engine;
     private joinUserId;
     private _AIAnsExtension;
-    constructor(appId: string, debug?: boolean, isTestEnv?: boolean);
+    private _isSupportVideo;
+    constructor(appId: string, debug?: boolean, isTestEnv?: boolean, isSupportVideo?: boolean);
     bindEngineEvents(): void;
     removeEventListener(): void;
+    _parseMessage(event: UserMessageEvent): any;
     handleMessage(event: UserMessageEvent): void;
     handleEventError(e: unknown): void;
     handleUserJoin(event: onUserJoinedEvent): void;
     handleUserLeave(event: onUserLeaveEvent): void;
+    handlePlayerEvent(event: unknown): void;
     joinRoom(options: {
         token: string;
         roomId: string;
         uid: string;
         audioMutedDefault?: boolean;
+        videoOnDefault?: boolean;
+        isAutoSubscribeAudio?: boolean;
     }): Promise<void>;
     setAudioInputDevice(deviceId: string): Promise<void>;
     setAudioOutputDevice(deviceId: string): Promise<void>;
-    createLocalStream(): Promise<void>;
+    createLocalStream(userId?: string, videoConfig?: VideoConfig): Promise<void>;
     disconnect(): Promise<void>;
     changeAudioState(isMicOn: boolean): Promise<void>;
+    changeVideoState(isVideoOn: boolean): Promise<void>;
     stop(): Promise<void>;
     sendMessage(message: Record<string, unknown>): Promise<void>;
     enableAudioPropertiesReport(config?: AudioPropertiesConfig): void;

package/dist/types/error.d.ts

@@ -8,10 +8,18 @@ export declare enum RealtimeError {
     PERMISSION_DENIED = "PERMISSION_DENIED",
     NETWORK_ERROR = "NETWORK_ERROR",
     INVALID_STATE = "INVALID_STATE",
-    CREATE_ROOM_ERROR = "CREATE_ROOM_ERROR"
+    CREATE_ROOM_ERROR = "CREATE_ROOM_ERROR",
+    PARSE_MESSAGE_ERROR = "PARSE_MESSAGE_ERROR",
+    HANDLER_MESSAGE_ERROR = "HANDLER_MESSAGE_ERROR"
 }
 export declare const ErrorMessages: Record<RealtimeError, string>;
 export declare class RealtimeAPIError extends Error {
     code: RealtimeError;
-    constructor(code: RealtimeError, message: string);
+    error?: unknown;
+    /**
+     * @param code - Error code
+     * @param message - Error message
+     * @param error - Error object
+     */
+    constructor(code: RealtimeError, message: string, error?: unknown);
 }

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

@@ -39,6 +39,21 @@ export declare enum EventNames {
      * zh: 客户端音频静音
      */
     AUDIO_MUTED = "client.audio.muted",
+    /**
+     * en: Client video on
+     * zh: 客户端视频开启
+     */
+    VIDEO_ON = "client.video.on",
+    /**
+     * en: Client video off
+     * zh: 客户端视频关闭
+     */
+    VIDEO_OFF = "client.video.off",
+    /**
+     * en: Client video event
+     * zh: 客户端视频事件
+     */
+    PLAYER_EVENT = "client.video.event",
     /**
      * en: Client error
      * zh: 客户端错误
@@ -63,9 +78,54 @@ export declare enum EventNames {
      * en: Audio output device changed
      * zh: 音频输出设备改变
      */
-    AUDIO_OUTPUT_DEVICE_CHANGED = "client.output.device.changed"
+    AUDIO_OUTPUT_DEVICE_CHANGED = "client.output.device.changed",
+    /**
+     * en: Bot joined
+     * zh: Bot 加入
+     */
+    BOT_JOIN = "server.bot.join",
+    /**
+     * en: Bot left
+     * zh: Bot 离开
+     */
+    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;
@@ -74,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,9 +1,14 @@
 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';
+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 */;
+}
 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 */;
@@ -17,14 +22,16 @@ export interface RealtimeClientConfig {
     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 */;
 }
 declare class RealtimeClient extends RealtimeEventHandler {
     private _config;
     private _client;
-    private _roomInfo;
     isConnected: boolean;
     private _api;
     private _isTestEnv;
+    _isSupportVideo: boolean;
     /**
      * Constructor for initializing a RealtimeClient instance.
      *
@@ -54,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);
     /**
@@ -86,6 +94,7 @@ declare class RealtimeClient extends RealtimeEventHandler {
      * zh: 启用或禁用音频
      */
     setAudioEnable(isEnable: boolean): Promise<void>;
+    setVideoEnable(isEnable: boolean): Promise<void>;
     /**
      * en: Enable audio properties reporting (debug mode only)
      *

package/dist/types/utils.d.ts

@@ -6,14 +6,27 @@
 + */
 export declare const sleep: (milliseconds: number) => Promise<void>;
 /**
+ * @deprecated use checkDevicePermission instead
  * Check microphone permission，return boolean
  */
-export declare const checkPermission: () => Promise<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[];
 }>;