@coze/realtime-api 1.3.0 → 1.3.2-alpha.f7fe14

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

@@ -1,25 +0,0 @@
-export declare enum RealtimeError {
-    DEVICE_ACCESS_ERROR = "DEVICE_ACCESS_ERROR",
-    STREAM_CREATION_ERROR = "STREAM_CREATION_ERROR",
-    CONNECTION_ERROR = "CONNECTION_ERROR",
-    DISCONNECTION_ERROR = "DISCONNECTION_ERROR",
-    INTERRUPT_ERROR = "INTERRUPT_ERROR",
-    EVENT_HANDLER_ERROR = "EVENT_HANDLER_ERROR",
-    PERMISSION_DENIED = "PERMISSION_DENIED",
-    NETWORK_ERROR = "NETWORK_ERROR",
-    INVALID_STATE = "INVALID_STATE",
-    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;
-    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-names/event-handler.d.ts

@@ -1,12 +0,0 @@
-export type EventCallback = (eventName: string, event: unknown) => void;
-export declare class RealtimeEventHandler {
-    private eventHandlers;
-    protected _debug: boolean;
-    constructor(debug?: boolean);
-    clearEventHandlers(): void;
-    on(eventName: string, callback: EventCallback): EventCallback;
-    off(eventName: string, callback: EventCallback): void;
-    private _dispatchToHandlers;
-    dispatch(eventName: string, event: unknown, consoleLog?: boolean): void;
-    _log(message: string, event?: unknown): void;
-}

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

@@ -1,163 +0,0 @@
-import { type ScreenConfig, type AudioPropertiesConfig, type IRTCEngine } from '@volcengine/rtc';
-import { type CreateRoomData, type GetToken, type RoomMode } 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 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 */;
-}
-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 的连接并加入房间
-     */
-    connect(): Promise<void>;
-    /**
-     * en: Interrupt the current conversation
-     *
-     * zh: 中断当前对话
-     */
-    interrupt(): Promise<void>;
-    /**
-     * en: Disconnect from the current session
-     *
-     * zh: 断开与当前会话的连接
-     */
-    disconnect(): Promise<void>;
-    /**
-     * en: Send a message to the bot
-     *
-     * zh: 发送消息给Bot
-     */
-    sendMessage(message: Record<string, unknown>): Promise<void>;
-    /**
-     * en: Enable or disable audio
-     *
-     * zh: 启用或禁用音频
-     */
-    setAudioEnable(isEnable: boolean): Promise<void>;
-    setVideoEnable(isEnable: boolean): Promise<void>;
-    /**
-     * en: Enable audio properties reporting (debug mode only)
-     *
-     * zh: 启用音频属性报告（仅限调试模式）
-     */
-    enableAudioPropertiesReport(config?: AudioPropertiesConfig): boolean;
-    /**
-     * en: Start audio playback device test (debug mode only)
-     *
-     * zh: 开始音频播放设备测试（仅限调试模式）
-     */
-    startAudioPlaybackDeviceTest(): Promise<void>;
-    /**
-     * en: Stop audio playback device test (debug mode only)
-     *
-     * zh: 停止音频播放设备测试（仅限调试模式）
-     */
-    stopAudioPlaybackDeviceTest(): void;
-    /**
-     * en: Set the audio input device
-     *
-     * zh: 设置音频输入设备
-     */
-    setAudioInputDevice(deviceId: string): Promise<void>;
-    /**
-     * en: Set the audio output device
-     *
-     * zh: 设置音频输出设备
-     */
-    setAudioOutputDevice(deviceId: string): Promise<void>;
-    /**
-     * en: Set the video input device
-     *
-     * zh: 设置视频输入设备
-     */
-    setVideoInputDevice(deviceId: string | 'screenShare' | 'user' | 'environment'): 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/event-names/utils.d.ts

@@ -1,49 +0,0 @@
-/**
-+ * Delays execution for the specified duration
-+ * @param milliseconds The time to sleep in milliseconds
-+ * @throws {Error} If milliseconds is negative
-+ * @returns Promise that resolves after the specified duration
-+ */
-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>;
-/**
- * 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;
-    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: ({ video, }?: {
-    video?: boolean;
-}) => Promise<{
-    audioInputs: MediaDeviceInfo[];
-    audioOutputs: MediaDeviceInfo[];
-    videoInputs: MediaDeviceInfo[];
-}>;
-export declare const isScreenShareDevice: (deviceId?: string) => boolean;
-/**
- * 判断是否前后置摄像头
- * @param deviceId
- * @returns
- */
-export declare const isMobileVideoDevice: (deviceId?: string) => boolean;
-/**
- * Check if browser supports screen sharing
- * 检查浏览器是否支持屏幕共享
- */
-export declare function isScreenShareSupported(): boolean;

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

@@ -1,208 +0,0 @@
-declare enum EventNames {
-    /**
-     * en: All events
-     * zh: 所有事件
-     */
-    ALL = "realtime.event",
-    /**
-     * en: All client events
-     * zh: 所有客户端事件
-     */
-    ALL_CLIENT = "client.*",
-    /**
-     * en: All server events
-     * zh: 所有服务端事件
-     */
-    ALL_SERVER = "server.*",
-    /**
-     * en: Room info
-     * zh: 房间信息
-     */
-    ROOM_INFO = "client.room.info",
-    /**
-     * en: Client connected
-     * zh: 客户端连接
-     */
-    CONNECTED = "client.connected",
-    /**
-     * en: Client connecting
-     * zh: 客户端连接中
-     */
-    CONNECTING = "client.connecting",
-    /**
-     * en: Client interrupted
-     * zh: 客户端中断
-     */
-    INTERRUPTED = "client.interrupted",
-    /**
-     * en: Client disconnected
-     * zh: 客户端断开
-     */
-    DISCONNECTED = "client.disconnected",
-    /**
-     * en: Client audio unmuted
-     * zh: 客户端音频未静音
-     */
-    AUDIO_UNMUTED = "client.audio.unmuted",
-    /**
-     * en: Client audio muted
-     * 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 error
-     * zh: 客户端视频(或屏幕共享）错误
-     */
-    VIDEO_ERROR = "client.video.error",
-    /**
-     * en: Client video event
-     * zh: 客户端视频事件
-     */
-    PLAYER_EVENT = "client.video.event",
-    /**
-     * en: Client error
-     * zh: 客户端错误
-     */
-    ERROR = "client.error",
-    /**
-     * en: Audio noise reduction enabled
-     * zh: 抑制平稳噪声
-     */
-    SUPPRESS_STATIONARY_NOISE = "client.suppress.stationary.noise",
-    /**
-     * en: Suppress non-stationary noise
-     * zh: 抑制非平稳噪声
-     */
-    SUPPRESS_NON_STATIONARY_NOISE = "client.suppress.non.stationary.noise",
-    /**
-     * en: Audio input device changed
-     * zh: 音频输入设备改变
-     */
-    AUDIO_INPUT_DEVICE_CHANGED = "client.input.device.changed",
-    /**
-     * en: Audio output device changed
-     * zh: 音频输出设备改变
-     */
-    AUDIO_OUTPUT_DEVICE_CHANGED = "client.output.device.changed",
-    /**
-     * en: Video input device changed
-     * zh: 视频输入设备改变
-     */
-    VIDEO_INPUT_DEVICE_CHANGED = "client.video.input.device.changed",
-    /**
-     * en: Network quality changed
-     * zh: 网络质量改变
-     */
-    NETWORK_QUALITY = "client.network.quality",
-    /**
-     * 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_AGENT_SPEECH_STOPPED = "server.audio.agent.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_UPDATED = "server.session.updated",
-    /**
-     * en: Conversation created
-     * zh: 会话创建
-     */
-    CONVERSATION_CREATED = "server.conversation.created",
-    /**
-     * en: Conversation chat created
-     * zh: 会话对话创建
-     */
-    CONVERSATION_CHAT_CREATED = "server.conversation.chat.created",
-    /**
-     * en: Conversation chat in progress
-     * zh: 对话正在处理中
-     */
-    CONVERSATION_CHAT_IN_PROGRESS = "server.conversation.chat.in_progress",
-    /**
-     * en: Conversation message delta received
-     * zh: 文本消息增量返回
-     */
-    CONVERSATION_MESSAGE_DELTA = "server.conversation.message.delta",
-    /**
-     * en: Conversation message completed
-     * zh: 文本消息完成
-     */
-    CONVERSATION_MESSAGE_COMPLETED = "server.conversation.message.completed",
-    /**
-     * en: Conversation chat completed
-     * zh: 对话完成
-     */
-    CONVERSATION_CHAT_COMPLETED = "server.conversation.chat.completed",
-    /**
-     * en: Conversation chat requires action
-     * zh: 对话需要插件
-     */
-    CONVERSATION_CHAT_REQUIRES_ACTION = "server.conversation.chat.requires_action",
-    /**
-     * en: Conversation chat failed
-     * zh: 对话失败
-     */
-    CONVERSATION_CHAT_FAILED = "server.conversation.chat.failed",
-    /**
-     * en: Session pre answer updated
-     * zh: 安抚配置更新成功
-     */
-    SESSION_PRE_ANSWER_UPDATED = "server.session.pre_answer.updated",
-    /**
-     * en: Conversation audio transcript delta
-     * zh: 用户语音识别字幕
-     */
-    CONVERSATION_AUDIO_TRANSCRIPT_DELTA = "server.conversation.audio_transcript.delta",
-    /**
-     * en: Mode updated
-     * zh: 更新房间模式成功
-     */
-    MODE_UPDATED = "server.mode.updated"
-}
-export default EventNames;

package/dist/types/utils.d.ts

@@ -1,49 +0,0 @@
-/**
-+ * Delays execution for the specified duration
-+ * @param milliseconds The time to sleep in milliseconds
-+ * @throws {Error} If milliseconds is negative
-+ * @returns Promise that resolves after the specified duration
-+ */
-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>;
-/**
- * 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;
-    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: ({ video, }?: {
-    video?: boolean;
-}) => Promise<{
-    audioInputs: MediaDeviceInfo[];
-    audioOutputs: MediaDeviceInfo[];
-    videoInputs: MediaDeviceInfo[];
-}>;
-export declare const isScreenShareDevice: (deviceId?: string) => boolean;
-/**
- * 判断是否前后置摄像头
- * @param deviceId
- * @returns
- */
-export declare const isMobileVideoDevice: (deviceId?: string) => boolean;
-/**
- * Check if browser supports screen sharing
- * 检查浏览器是否支持屏幕共享
- */
-export declare function isScreenShareSupported(): boolean;