easemob-websdk 4.19.1 → 4.21.0

package/Easemob-chat.d.ts

@@ -44,6 +44,28 @@ export declare namespace EasemobChat {
 		jid: Jid;
 	}
 
+	interface AudioParams {
+		/** The audio format. */
+		format?: string;
+		/** The sample rate. */
+		sampleRate?: number;
+		/** The bits per sample. */
+		bitsPerSample?: number;
+		/** The number of channels. */
+		channels?: number;
+	}
+
+	interface MiniProgramVoiceFile {
+		/** The local file path in mini program. */
+		filePath: string;
+		/** The optional file name. */
+		name?: string;
+		/** The optional file size in bytes. */
+		size?: number;
+	}
+
+	type VoiceSourceFile = File | MiniProgramVoiceFile;
+
 	type ExcludeAckMessageBody = Exclude<
 		MessageBody,
 		ReadMsgBody | DeliveryMsgBody | ChannelMsgBody
@@ -1449,6 +1471,16 @@ export declare namespace EasemobChat {
 		WEBIM_DOWNLOADFILE_ERROR_NO_PERMISSION = 222,
 		/** The file has expired. */
 		WEBIM_DOWNLOADFILE_ERROR_EXPIRED = 223,
+		/** Invalid voice file. */
+		FILE_INVALID = 407,
+		/** Voice duration exceeds the limit. */
+		FILE_DURATION_TOO_LONG = 408,
+		/** Voice-to-text failed. */
+		FILE_VOICE_TO_TEXT_FAILED = 409,
+		/** Voice file not found. */
+		FILE_NOT_FOUND = 410,
+		/** Voice file too large. */
+		FILE_TOO_LARGE = 411,
 
 		/** get DNS failed */
 		SERVER_GET_DNSLIST_FAILED = 304,
@@ -3833,7 +3865,7 @@ export declare namespace EasemobChat {
 				success?: (res: AsyncResult<GroupRequestResult[]>) => void;
 				error?: (error: ErrorEvent) => void;
 			}
-		): Promise<AsyncResult<GroupRequestResult[]>>;
+		): Promise<AsyncResult<GroupRequestResult[] | GroupRequestResult>>;
 
 		/**
 		 * Adds members to the group allowlist. Members on the allowlist can still post messages even if they are muted in the group. Only the group admin or above can call this method. Members added to the allowlist will receive "operation: 'addUserToAllowlist'" in the callback of onGroupEvent.
@@ -3852,7 +3884,7 @@ export declare namespace EasemobChat {
 				success?: (res: AsyncResult<GroupRequestResult[]>) => void;
 				error?: (error: ErrorEvent) => void;
 			}
-		): Promise<AsyncResult<GroupRequestResult[]>>;
+		): Promise<AsyncResult<GroupRequestResult[] | GroupRequestResult[]>>;
 
 		/**  @deprecated  Use {@link removeGroupWhitelistMember} instead. */
 		rmUsersFromGroupWhitelist(
@@ -5477,6 +5509,55 @@ export declare namespace EasemobChat {
 			}
 		): Promise<AsyncResult<CursorPinnedMessagesResult>>;
 
+		/**
+		 * Transcribes a voice message to text.
+		 * 
+		 * This method only supports successfully sent voice messages. 
+         * 
+         * Once transcribed, the text is returned via callback and can also be retrieved through {res.data.text} .
+         * 
+         * This method supports AMR and MP3 voice messages, but does not support direct transcription of PCM format.
+		 *
+		 * ```typescript
+		 * connection.voiceMessageToText(messageBody, audioParams)
+		 * ```
+		 */
+		voiceMessageToText(
+			this: Connection,
+			/** The voice message body. */
+			messageBody: AudioMsgBody,
+			/**
+		     * Voice parameters for local voice file recognition.
+		     * 
+		     *  For {@link AudioParams.AudioFormat }, since it lacks header information, you must provide parameters such as the sample rate and the number of channels via audioParams.
+             * 
+		     */
+			audioParams?: AudioParams
+		): Promise<
+			AsyncResult<{
+				text: string;
+			}>
+		>;
+
+		/**
+		 * Transcribes a local voice file to text.
+		 *
+		 * ```typescript
+		 * connection.voiceFileToText(file, audioParams)
+		 * ```
+		 */
+		voiceFileToText(
+			this: Connection,
+			/** The voice file object or the local file path object (for mini programs).  */
+			file: VoiceSourceFile,
+			/** Optional voice parameters for local voice file recognition.*/
+			audioParams?: AudioParams
+		): Promise<
+			AsyncResult<{
+				text: string;
+			}>
+		>;
+
 		getUserIdByRTCUIds(
 			this: Connection,
 			RTCUIds: number[]