@byteplus/rtc 4.60.7 → 4.60.9

package/index.d.ts

@@ -1616,7 +1616,13 @@ export declare enum SubtitleEventType {
 	/** 
 	 * @brief Errors occurred concerning the subtitling task.
 	 */
-	ERROR = 2
+	ERROR = 2,
+	
+	/** 
+	 * @hidden
+	 * @brief Subtitles are updated.
+	 */
+	UPDATED = 3
 }
 
 /** 
@@ -2966,7 +2972,7 @@ export interface IEngineEvents {
 	 * @hidden currently not available
 	 * @brief Callback on subtitle messages.
 	 *        After calling [startSubtitle](104478#startsubtitle) successfully, you will receive this callback which informs you of the related information on subtitles.
-	 * @param e Subtitle message.
+	 * @param e Subtitle message. The subtitle messages will include multiple languages as the task specified. You can collect the `text` by `userId` and `language`.
 	 * @group Live Caption and Translation
 	 * @order 11
 	 */
@@ -4160,6 +4166,18 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 */
 	startSubtitle: (config: RTCSubtitleConfig) => Promise<void>;
 	
+	/** 
+	 * @hidden currently not available
+	 * @brief Update the source language after turning on subtitles.
+	 * @param config Subtitle configurations.
+	 * @return After updating the configurations, you will receive the [onSubtitleStateChanged](104479#onsubtitlestatechanged) to inform you.
+	 * @notes + You must call this method after turning on the subtitles via [startSubtitle]({{api}}#RTCEngine.startSubtitle).
+	 *        + You can set your source language to Chinese by calling `joinRoom`  and importing a JSON formatted string `"source_language": "zh"` through the parameter of extraInfo, to English by importing `"source_language": "en"`, to Korean by importing  `"source_language": "ko"`, and to Japanese by importing `"source_language": "ja"`. The language of your browser will be automatically set as the source language if you don't set it. If the language of your browser is not Chinese, English, or Japanese, SDK will set Chinese as the source language.
+	 * @group Live Caption and Translation
+	 * @order 2
+	 */
+	updateSubtitleConfig: (config: UpdateSubtitleConfig) => Promise<void>;
+	
 	/** 
 	 * @hidden currently not available
 	 * @brief Turns off subtitles.
@@ -5090,7 +5108,7 @@ export interface RTCSubtitleConfig {
 	/** 
 	 * @brief Target language.
 	 */
-	targetLanguage?: string;
+	targetLanguage?: string | string[];
 	
 	/** 
 	 * @brief Subtitle mode.
@@ -5673,6 +5691,22 @@ export interface SubtitleMessage {
 	mode: SUBTITLE_MODE;
 }
 
+/** 
+ * @hidden
+ * @brief Subtitle configurations to be updated to.
+ */
+export interface UpdateSubtitleConfig {
+	
+	/** 
+	 * @brief The source language code.
+	 * + zh: Chinese
+	 * + ja: Japanese
+	 * + en: English
+	 * + ko: Korean
+	 */
+	sourceLanguage: string;
+}
+
 /** 
  * @brief Point-to-point binary message
  */