@byteplus/rtc 4.53.1 → 4.54.1

package/index.d.ts

@@ -694,7 +694,12 @@ declare enum ErrorCode {
 	/** 
 	 * @brief The client side failed to identity error codes sent by cloud media processing. Please contact the technical support.
 	 */
-	SUBTITLE_ERR_UNKNOWN = "SUBTITLE_ERR_UNKNOWN"
+	SUBTITLE_ERR_UNKNOWN = "SUBTITLE_ERR_UNKNOWN",
+	
+	/** 
+	 * @brief Unexpected cross-room media stream forwarding API call. For example, calling `stopForwardStreamToRooms` when media forwarding has already stopped.
+	 */
+	UNEXPECTED_INVOKE_FORWARD_STREAM = "UNEXPECTED_INVOKE_FORWARD_STREAM"
 }
 declare enum AudioMixingError {
 	
@@ -1909,7 +1914,11 @@ declare enum EngineEventsTypes {
 	onSubtitleStateChanged = "onSubtitleStateChanged",
 	onSubtitleMessageReceived = "onSubtitleMessageReceived",
 	onServerParamsSetResult = "onServerParamsSetResult",
-	onVendorConnectionStateChanged = "onVendorConnectionStateChanged"
+	onLocalStreamTrackChangedByExtension = "onLocalStreamTrackChangedByExtension",
+	onVendorConnectionStateChanged = "onVendorConnectionStateChanged",
+	onForwardStreamError = "onForwardStreamError",
+	onRejoinWithTcp = "onRejoinWithTcp",
+	onIceConnectWithTcp = "onIceConnectWithTcp"
 }
 
 /** 
@@ -2589,6 +2598,30 @@ export interface IEngineEvents {
 	 * + If the client losts connection after the call of [setServerParams](104478#setserverparams) this event notifies once the client reconnects.
 	 */
 	[EngineEventsTypes.onServerParamsSetResult]: (error?: ErrorCode) => void;
+	
+	/** 
+	 * @hidden
+	 */
+	[EngineEventsTypes.onLocalStreamTrackChangedByExtension]: (e: {
+		streamIndex: StreamIndex;
+		type: "video" | "audio";
+	}) => void;
+	
+	/** 
+	 * @brief Event of failing to forward stream across rooms.
+	 * @param e Status information for forwarding media stream across rooms.
+	 */
+	[EngineEventsTypes.onForwardStreamError]: (e: ForwardStreamStateInfo) => void;
+	
+	/** 
+	 * @hidden
+	 */
+	[EngineEventsTypes.onRejoinWithTcp]: () => void;
+	
+	/** 
+	 * @hidden
+	 */
+	[EngineEventsTypes.onIceConnectWithTcp]: () => void;
 }
 
 /** 
@@ -2605,12 +2638,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 *         You need to bring Token to enter the room. When testing, you can use the console to generate temporary tokens. The official launch requires the use of the key SDK to generate and issue tokens at your server level. See [Use Token to complete authentication](70121) for token validity and generation method.
 	 *         Apps with different AppIDs are not interoperable.
 	 *         Make sure that the AppID used to generate the Token is the same as the AppID used to create the engine, otherwise it will cause the join room to fail.
-	 * @param roomId  The ID of the room to be added.
-	 *     The room ID is a non-empty string with a length of less than 128 bytes, and the following character set ranges are supported:
-	 *      1. 26 capital letters A~ Z.
-	 *      2. 26 lowercase letters a~ z.
-	 *      3. 10 numbers 0~ 9.
-	 *      4. Underscore "_", the at sign "@", and the minus sign "-".
+	 * @param roomId  The Room ID. The string must conform to the regular expression: `[a-zA-Z0-9_@\-\.]{1,128}`.
 	 * @param userInfo  User information.
 	 * @param roomConfig  Room parameter configuration, set the room mode and whether to automatically publish or subscribe to the flow.
 	 * @return
@@ -3517,6 +3545,51 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 *        + If the playing has not yet started when you call this API, the setting will take effect after it starts.
 	 */
 	setPublicStreamVolume: (publicStreamId: string, volume: number) => void;
+	
+	/** 
+	 * @brief Start forwarding media stream across rooms. See [Forward media stream across rooms](https://docs.byteplus.com/en/byteplus-rtc/docs/104398) for details.
+	 *        After calling [joinRoom]({{api}}#RTCEngine.joinRoom), you can call this API to publish the media stream to multiple rooms. This feature is suitable for scenarios such as co-host PK and online karaoke.
+	 * @param forwardStreamInfos Information of the target rooms where the stream will be forwarded.
+	 * @return Status information for forwarding media stream across rooms.
+	 * @notes + Once the forwarding begins, other users in the target room will receive [onUserJoined]({{callback}}#EngineEvents.onUserJoined) and [onUserPublishStream]({{callback}}#EngineEvents.onUserPublishStream)/[onUserPublishScreen]({{callback}}#EngineEvents.onUserPublishScreen).
+	 *        + Call [updateForwardStreamToRooms]({{api}}#RTCEngine.updateForwardStreamToRooms) to add or remove the target room(s).
+	 *        + Call [stopForwardStreamToRooms]({{api}}#RTCEngine.stopForwardStreamToRooms) to stop forwarding media stream to all rooms.
+	 *        + Call [pauseForwardStreamToAllRooms]({{api}}#RTCEngine.pauseForwardStreamToAllRooms) to pause forwarding media stream to all rooms.
+	 */
+	startForwardStreamToRooms: (forwardStreamInfos: ForwardStreamInfo[]) => Promise<ForwardStreamStateInfo[]>;
+	
+	/** 
+	 * @brief Update information of the rooms where the stream will be forwarded after calling [startForwardStreamToRooms]({{api}}#RTCEngine.startForwardStreamToRooms).
+	 * @param forwardStreamInfos Information of the target rooms where the stream will be forwarded.
+	 * @return Status information for forwarding media stream across rooms.
+	 * @notes + Users in the added room will receive [onUserJoined]({{callback}}#EngineEvents.onUserJoined) and [onUserPublishStream]({{callback}}#EngineEvents.onUserPublishStream)/[onUserPublishScreen]({{callback}}#EngineEvents.onUserPublishScreen).
+	 *        + Users in the removed room will receive [onUserUnpublishStream]({{callback}}#EngineEvents.onUserUnpublishStream)/[onUserUnpublishScreen]({{callback}}#EngineEvents.onUserUnpublishScreen) and [onUserLeave]({{callback}}#EngineEvents.onUserLeave).
+	 */
+	updateForwardStreamToRooms: (forwardStreamInfos: ForwardStreamInfo[]) => Promise<ForwardStreamStateInfo[]>;
+	
+	/** 
+	 * @brief Stop forwarding media stream to all rooms.
+	 * @return Status information for forwarding media stream across rooms.
+	 * @notes + Users in the former target rooms will receive [onUserUnpublishStream]({{callback}}#EngineEvents.onUserUnpublishStream)/[onUserUnpublishScreen]({{callback}}#EngineEvents.onUserUnpublishScreen) and [onUserLeave]({{callback}}#EngineEvents.onUserLeave).
+	 *        + Call [updateForwardStreamToRooms]({{api}}#RTCEngine.updateForwardStreamToRooms) to stop forwarding media stream to specific rooms.
+	 *        + Call [pauseForwardStreamToAllRooms]({{api}}#RTCEngine.pauseForwardStreamToAllRooms) and [resumeForwardStreamToAllRooms]({{api}}#RTCEngine.resumeForwardStreamToAllRooms) to pause and resume fowarding media stream to all rooms.
+	 */
+	stopForwardStreamToRooms: () => Promise<ForwardStreamStateInfo[]>;
+	
+	/** 
+	 * @brief Pause forwarding media stream to all rooms.
+	 *        After calling this API, call [resumeForwardStreamToAllRooms]({{api}}#RTCEngine.resumeForwardStreamToAllRooms) to resume.
+	 * @return Status information for forwarding media stream across rooms.
+	 * @notes Users in the target rooms will receive [onUserUnpublishStream]({{callback}}#EngineEvents.onUserUnpublishStream)/[onUserUnpublishScreen]({{callback}}#EngineEvents.onUserUnpublishScreen) and [onUserLeave]({{callback}}#EngineEvents.onUserLeave).
+	 */
+	pauseForwardStreamToAllRooms: () => Promise<ForwardStreamStateInfo[]>;
+	
+	/** 
+	 * @brief Resume forwarding media stream to all rooms.
+	 * @return Status information for forwarding media stream across rooms.
+	 * @notes Users in the target room will receive [onUserJoined]({{callback}}#EngineEvents.onUserJoined) and [onUserPublishStream]({{callback}}#EngineEvents.onUserPublishStream)/[onUserPublishScreen]({{callback}}#EngineEvents.onUserPublishScreen).
+	 */
+	resumeForwardStreamToAllRooms: () => Promise<ForwardStreamStateInfo[]>;
 }
 
 /** 
@@ -4009,19 +4082,19 @@ export interface ScreenConfig {
 export interface VideoEncoderConfig {
 	
 	/** 
-	 * @brief Video width in pixels. The default value is 640 px。
+	 * @brief Video width in pixels. The default value is 640 px.
 	 *        The input can be a number or a [ConstrainULong](https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints#constrainulong).
 	 */
 	width: ConstrainULong;
 	
 	/** 
-	 * @brief Video height in pixels. The default value is 480 px。
+	 * @brief Video height in pixels. The default value is 480 px.
 	 *        The input can be a number or a [ConstrainULong](https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints#constrainulong).
 	 */
 	height: ConstrainULong;
 	
 	/** 
-	 * @brief Video framerate in FPS. The default value is 15 FPS。
+	 * @brief Video framerate in FPS. The default value is 15 FPS.
 	 *        The input can be a number or a [ConstrainDouble](https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints#constraindouble).
 	 */
 	frameRate: ConstrainDouble;
@@ -4038,19 +4111,19 @@ export interface VideoEncoderConfig {
 export interface ScreenEncoderConfig {
 	
 	/** 
-	 * @brief Video width in pixels. The default value is 1920 px。
+	 * @brief Video width in pixels. The default value is 1920 px.
 	 *        The input can be a number or a [ConstrainULong](https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints#constrainulong).
 	 */
 	width: ConstrainULong;
 	
 	/** 
-	 * @brief Video height in pixels. The default value is 1080 px。
+	 * @brief Video height in pixels. The default value is 1080 px.
 	 *        The input can be a number or a [ConstrainULong](https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints#constrainulong).
 	 */
 	height: ConstrainULong;
 	
 	/** 
-	 * @brief Video framerate in FPS. The default value is 15 FPS。
+	 * @brief Video framerate in FPS. The default value is 15 FPS.
 	 *        The input can be a number or a [ConstrainDouble](https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints#constraindouble).
 	 */
 	frameRate: ConstrainDouble;
@@ -4526,7 +4599,7 @@ export declare enum SubscribeFallbackOption {
 	DISABLE = 0,
 	
 	/** 
-	 * @brief When the downstream network quality is bad, the video stream fallbacks to stream of lower resolution and then to voice only. See [Media Stream Fallback](https://www.volcengine.com/docs/6348/70137) for fallback rules.
+	 * @brief When the downstream network quality is bad, the video stream fallbacks to stream of lower resolution and then to voice only. See [Media Stream Fallback](https://docs.byteplus.com/en/byteplus-rtc/docs/70137) for fallback rules.
 	 *        This setting takes effect only when the publisher enables simulcast mode through [EnableSimulcastMode](104478#enablesimulcastmode).
 	 */
 	VIDEO_STREAM_LOW = 1,
@@ -4943,6 +5016,90 @@ export interface CloudProxyInfo {
 	configProxy: string;
 }
 
+/** 
+ * @brief Information of the target rooms where the stream will be forwarded.
+ */
+export interface ForwardStreamInfo {
+	
+	/** 
+	 * @brief The target room ID for forwarding media streams.
+	 */
+	roomId: string;
+	
+	/** 
+	 * @brief Tokens generated using the target room's roomId and userId.
+	 *        You can use the temporary token generated on the [console](https://console.byteplus.com/rtc/workplaceRTC) for testing purposes only. The official launch requires token generated by your server.
+	 */
+	token: string;
+}
+
+/** 
+ * @brief Status information for forwarding media stream across rooms.
+ */
+export interface ForwardStreamStateInfo {
+	
+	/** 
+	 * @brief The target room ID for forwarding media streams.
+	 */
+	roomId: string;
+	
+	/** 
+	 * @brief Status information for forwarding media stream across rooms.
+	 */
+	state: ForwardStreamState;
+	
+	/** 
+	 * @brief Forward stream error code.
+	 */
+	error: ForwardStreamError;
+}
+
+/** 
+ * @brief Status information for forwarding media stream across rooms.
+ */
+export declare enum ForwardStreamState {
+	
+	/** 
+	 * @brief Success.
+	 */
+	FORWARD_STREAM_STATE_SUCCESS = 0,
+	
+	/** 
+	 * @brief Failure.
+	 */
+	FORWARD_STREAM_STATE_FAILURE = 1
+}
+
+/** 
+ * @brief Forward stream error code.
+ */
+export declare enum ForwardStreamError {
+	
+	/** 
+	 * @brief Success.
+	 */
+	FORWARD_STREAM_ERROR_OK = 0,
+	
+	/** 
+	 * @brief Target room's token is invalid.
+	 */
+	FORWARD_STREAM_ERROR_INVALID_TOKEN = 1202,
+	
+	/** 
+	 * @brief Server side error.
+	 */
+	FORWARD_STREAM_ERROR_RESPONSE = 1203,
+	
+	/** 
+	 * @brief The source room is set as the target room.
+	 */
+	FORWARD_STREAM_ERROR_REMOTE_KICKED = 1204,
+	/**
+	 * @hidden
+	 */
+	FORWARD_STREAM_ERROR_NOT_SUPPORT = 1205
+}
+
 /** 
  * @brief Point-to-point text message
  */
@@ -5027,7 +5184,11 @@ export interface CloudProxyConnectedEvent {
 declare const Config: {
 	[key: string]: any;
 };
-declare function setParameter(key: keyof typeof Config, value: any): void;
+declare function setParameter(key: keyof typeof Config, value: any): {
+	useTcpAfterJoinTimeout: boolean;
+	joinWithTcpOnly: boolean;
+	joinWithTcpOnlyDelay: number;
+} | undefined;
 declare function getParameter(key: keyof typeof Config): any;
 
 /**