@byteplus/rtc 4.42.2 → 4.42.4

package/index.d.ts

@@ -15,28 +15,16 @@ declare enum ErrorCode {
 	INVALID_PARAMS = "INVALID_PARAMS",
 	
 	/** 
-	 * @brief Invalid Token
+	 * @brief Token is invalid or has expired.
 	 */
 	INVALID_TOKEN = "INVALID_TOKEN",
-	
-	/** 
-	 * @brief Token expired.
-	 */
 	EXPIRED_TOKEN = "EXPIRED_TOKEN",
 	
 	/** 
 	 * @brief Failure of joining room
 	 */
 	JOIN_ROOM_FAILED = "JOIN_ROOM_FAILED",
-	
-	/** 
-	 * @brief Fail to update Token failed because the Token is invalid.
-	 */
 	UPDATE_TOKEN_WITH_INVALID_TOKEN = "UPDATE_TOKEN_WITH_INVALID_TOKEN",
-	
-	/** 
-	 * @brief Fail to update Token failed because the user has not joined any room.
-	 */
 	UPDATE_TOKEN_BEFORE_JOIN = "UPDATE_TOKEN_BEFORE_JOIN",
 	
 	/** 
@@ -258,15 +246,7 @@ declare enum ErrorCode {
 	 * @brief Unknown error
 	 */
 	UNEXPECTED_ERROR = "UNEXPECTED_ERROR",
-	
-	/** 
-	 * @brief You have started another device test while the current one is still ongoing.
-	 */
 	REPEAT_DEVICE_TEST = "REPEAT_DEVICE_TEST",
-	
-	/** 
-	 * @brief The audio device test failed.
-	 */
 	AUDIO_DEVICE_TEST_FAILED = "AUDIO_DEVICE_RECORD_FAILED",
 	
 	/** 
@@ -1958,11 +1938,6 @@ export interface IEngineEvents {
 	 * @region Message Event
 	 */
 	[EngineEventsTypes.onUserBinaryMessageReceivedOutsideRoom]: (event: UserBinaryMessageEvent) => void;
-	
-	/** 
-	 * @brief You will receive this callback 30 s before the Token expires.
-	 * Call [updateToken](104478#updatetoken) to submit a new Token。The user will be removed from the room when the Token expires.
-	 */
 	[EngineEventsTypes.onTokenWillExpire]: () => void;
 	
 	/** 
@@ -1973,7 +1948,7 @@ export interface IEngineEvents {
 	
 	/** 
 	 * @brief Callback of the result of publishing the public stream.
-	 *        After calling [startPushPublicStream](104478#startpushpublicstream), you will be informed of the result through this callback.
+	 *        After calling [startPushPublicStream](#startpushpublicstream), you will be informed of the result through this callback.
 	 * @param event
 	 */
 	[EngineEventsTypes.onPushPublicStreamResult]: (event: PublicStreamResultEvent) => void;
@@ -1981,7 +1956,7 @@ export interface IEngineEvents {
 	/** 
 	 * @hidden
 	 * @brief Callback of the SEI carried by the public video stream.
-	 *        You will receive SEI by this callback if the public stream you subscribed to by calling [startPlayPublicStream](104478#startplaypublicstream) is carrying SEI.
+	 *        You will receive SEI by this callback if the public stream you subscribed to by calling [startPlayPublicStream](#startplaypublicstream) is carrying SEI.
 	 * @param event
 	 * @notes When multiple streams in the public stream contain SEI:
 	 *        + You will receive SEI from all the video frames if the SEI do not have conflicts.
@@ -1991,14 +1966,14 @@ export interface IEngineEvents {
 	
 	/** 
 	 * @brief Callback of the successful decoding of the first video frame of the public stream.
-	 *        Refer to [startPlayPublicStream](104478#startplaypublicstream) for details about subscribing to a public stream.
+	 *        Refer to [startPlayPublicStream](#startplaypublicstream) for details about subsribing to a public stream.
 	 * @param event
 	 */
 	[EngineEventsTypes.onFirstPublicStreamVideoFrameDecoded]: (event: PublicStreamVideoFirstFrameDecodedEvent) => void;
 	
 	/** 
 	 * @brief Callback of the successful decoding of the first audio frame of the public stream.
-	 *        Refer to [startPlayPublicStream](104478#startplaypublicstream) for details about subscribing to a public stream.
+	 *        Refer to [startPlayPublicStream](#startplaypublicstream) for details about subsribing to a public stream.
 	 * @param event
 	 */
 	[EngineEventsTypes.onFirstPublicStreamAudioFrameDecoded]: (event: PublicStreamAudioFirstFrameDecodedEvent) => void;
@@ -2008,12 +1983,6 @@ export interface IEngineEvents {
 	 * @param event
 	 */
 	[EngineEventsTypes.onFirstPublicStreamVideoFrameRendered]: (event: PublicStreamAudioFirstFrameDecodedEvent) => void;
-	
-	/** 
-	 * @brief Notification on the playing volume during the test for the local audio devices
-	 * @param volume playing volume during the test for the local audio devices in milliseconds. We recommend to set it to 200 ms.The range is [0,255].
-	 * @notes Start an audio-device test by calling [startAudioPlaybackDeviceTest](104478#startaudioplaybackdevicetest) or [startAudioDeviceRecordTest](104478#startaudiodevicerecordtest) will register this callback for regular notification on playing volume. You can set the time interval between each callback by passing a proper value when calling the API above.
-	 */
 	[EngineEventsTypes.onAudioPlaybackDeviceTestVolume]: (volume: number) => void;
 }
 
@@ -2066,6 +2035,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @region Room Management
 	 */
 	joinRoom(token: string | null, roomId: string, userInfo: UserInfo, roomConfig: RoomConfig): Promise<void>;
+	setConnectionMode(mode: ConnectionMode): void;
 	
 	/** 
 	 * @brief Leave the room.   <br>
@@ -2134,11 +2104,11 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	
 	/** 
 	 * @brief Update Token. <br>
-	 * You will receive [onTokenWillExpire](104479#ontokenwillexpire) 30 s before the Token expires. Call this API to submit a new Token.
+	 * Call this API to update the Token information of the room when the Token expires <br>
 	 * @param token A valid token <br>
 	 * @notes + If you call [joinRoom](#joinroom) with an expired token, the joining will fail with an error code `INVALID_TOKEN`. And you need to obtain a valid token and call this API to update the token. <br>
 	 *      + If joining a room failed because the token expired, call this API with an updated token. And then RTC SDK will automatically rejoin the room without calling [joinRoom](#joinroom) again.  <br>
-	 *      + The user will be removed from the room when the Token expires.
+	 *      + You have no need to worry about the token expiration after the user joining successfully. Because RTC SDK only verifies the token when the user joins.
 	 * @region Room Management
 	 */
 	updateToken(token: string): void;
@@ -2162,11 +2132,11 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	switchCamera(deviceId: string): Promise<void>;
 	
 	/** 
-	 * @brief Enable internal video capture. The default state is off.
+	 * @brief Enable internal video capture. The default state is off.   <br>
 	 * Internal video capture refers to: capturing video using the built-in module.
-	 * The remote clients in the room will be informed of the state change via [onUserStartVideoCapture](104479#onuserstartvideocapture) after the publisher starts video capture by calling this API.
+	 * The remote clients in the room will be informed of the state change via [onUserStartVideoCapture](104479#onuserstartvideocapture) after the publisher starts video capture by calling this API.<br>
 	 * @param deviceId ID of the device need to enable which you can call [getDevices](#getdevices) to obtain.
-	 * @return The actual effective video capture parameters. See [MediaTrackSettings](https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints). Pay attention to the properties: `frameRate`, `height`, and `width`.
+	 * @return
 	 * @notes + Call [stopVideoCapture](#stopvideocapture) to stop the internal video capture. Otherwise, the internal video capture will sustain until you destroy the engine instance.<br>
 	 *     + Once you create the engine instance, you can start internal video capture regardless of the video publishing state. The video stream will start publishing only after the video capture starts. <br>
 	 *     + Call [switchCamera](#switchcamera) to switch the camera used by the internal video capture module.<br>
@@ -2191,7 +2161,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * The remote clients in the room will be informed of the state change via [onUserStartAudioCapture](104479#onuserstartaudiocapture) after the publisher starts audio capture by calling this API.
 	 * @param deviceId ID of the device need to enable which you can call [getDevices](#getdevices) to obtain.
 	 * @return
-	 * @notes + Call [stopAudioCapture](#stopaudiocapture) to stop the internal audio capture. Otherwise, the internal audio capture will sustain until you destroy the engine instance. <br>
+	 * @notes + Call [stopVideoCapture](#stopvideocapture) to stop the internal audio capture. Otherwise, the internal audio capture will sustain until you destroy the engine instance. <br>
 	 *     + Once you create the engine instance, you can start internal audio capture regardless of the audio publishing state. The audio stream will start publishing only after the audio capture starts. <br>
 	 * @region Audio Management
 	 */
@@ -2392,23 +2362,15 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	sendSEIMessage(streamIndex: StreamIndex, message: Uint8Array | string, repeatCount: number): void;
 	
 	/** 
-	 * @region Video Management
-	 * @brief Sets the video encoder configuration of the publishing streams.
+	 * @brief Sets the video encoder configuration of each individual stream for simulcasting, including resolution, frame rate, bitrate, scale mode, fallback strategy under poor network conditions.
 	 * @param streamIndex
-	 * @param descriptions The max parameters of the video stream.
-	 *         When you call [enableSimulcastMode](#enableSimulcastMode) and enable simulcasting, you can call this API to set the parameters of the multiple video streams. The length of `descriptions` is no more than 3. The code rate of the parameters must be in descending order.
-	 *        When the resolution of the max stream is in [540P, 1080P], you can simulcast 3 streams; when in [270P, 450P], you can simulcast 2 streams; when in [0, 180P], you can not enable simulcast.
-	 * @notes For the video stream captured by the camera, the default value is 360P, 15FPS; for the screen-sharing stream, the default value is 1080P, 15FPS.
+	 * @param descriptions Video parameters of each individual stream for simulcasting.
+	 *                     The length of `VideoEncoderConfig` is no more than 3. The resolutions must be in descending sort.
+	 * @notes + The video streams are encoded by default with a bitrate of 500bps. <br>
+	 *        + The screen stream takes the first set of parameters. <br>
+	 * @region Media Transmission
 	 */
 	setVideoEncoderConfig(streamIndex: StreamIndex, descriptions: VideoEncoderConfig | VideoEncoderConfig[]): Promise<void>;
-	
-	/** 
-	 * @region Video Management
-	 * @brief Enables the simulcast mode of the video stream captured by the camera at the publishing end.imulcasting, including resolution, frame rate, bitrate, scale mode, fallback strategy under poor network conditions.
-	 * @param enabled
-	 * @param + You must call this API before publishing the video streams. <br>
-	 *    + After enabling the simulcast mode, SDK automatically sets the encoding parameters for the video streams. For manual setting, call [setVideoEncoderConfig](#setVideoEncoderConfig).
-	 */
 	enableSimulcastMode(enabled: boolean): boolean;
 	
 	/** 
@@ -2708,17 +2670,6 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @param videoPlayerOption Player information and rendering mode.
 	 */
 	setPublicStreamVideoPlayer(publicStreamId: string, videoPlayerOption: Omit<VideoPlayerOption, "userId">): void;
-	
-	/** 
-	 * @region Video Management
-	 * @brief Set the placeholder image during local video capture pause
-	 * @param index
-	 * @param filePath Image path in Http protocal; or Blob object.
-	 *    The format of the image can be: JPG, PNG, or BMP.
-	 *    When the ratio of the image is not the same as the video encoder configuration, the image will be resized with fixed ratio until the width and the height are no more than that of the encoder configuration.
-	 * @return + It's recommended to call this API before stopping video capture to avoid blank frame in video recording. <br>
-	 *    + You cannot see the image during local preview.
-	 */
 	setDummyCaptureImagePath(index: StreamIndex, filePath: string): Promise<void>;
 	
 	/** 
@@ -2726,46 +2677,10 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @return The default parameters of `LiveTranscodeConfig`
 	 */
 	defaultTranscoding(): Required<LiveTranscodeConfig>;
-	
-	/** 
-	 * @brief Start the playback test for the local audio device. RTC will start playing the audio file specified. And RTC will notify the audio volume via the [onAudioPlaybackDeviceTestVolume](104479#onaudioplaybackdevicetestvolume) periodically.
-	 * @param filePath Specify the path of the audio file for the playback test, including *.wav and *.mp3.
-	 * @param indicationInterval The time interval between each callback in milliseconds. We recommend setting it to 200 ms. The minimal value is 100 ms.
-	 * @return Resolve when the test ends.
-	 * @notes + You can call this API whether the user is in the room.
-	 * + Call [stopAudioPlaybackDeviceTest](#stopaudioplaybackdevicetest) to stop the playback test before moving on to the other device tests.
-	 */
 	startAudioPlaybackDeviceTest(filePath: string, indicationInterval: number): Promise<void>;
-	
-	/** 
-	 * @brief Stop the playback test for the local audio device.
-	 * @notes Call this API to stop the playback test started by calling [startAudioPlaybackDeviceTest](#startaudioplaybackdevicetest) before moving on to the other device tests.
-	 */
 	stopAudioPlaybackDeviceTest(): void;
-	
-	/** 
-	 * @brief Start the capture and playback test for local audio devices.
-	 * We recommend to register [onLocalAudioPropertiesReport](104479#onlocalaudiopropertiesreport) callback via [enableAudioPropertiesReport](enableaudiopropertiesreport). Once the test starts, you can get the volume of the capturing audio by this callback.
-	 * @param indicationInterval The time interval between each callback of [onAudioPlaybackDeviceTestVolume](104479#onaudioplaybackdevicetestvolume) via which you get informed of the playback volume during the test.  We recommend setting it to 200 ms. The minimal value is 100 ms.
-	 * @return Resolve when the test ends.
-	 * @notes + You can call this API whether the user is in a room.
-	 * + The audio capturing will stop and begins to play the recording in 30 s after calling this API. Before that, call [stopAudioDeviceRecordAndPlayTest](#stopaudiodevicerecordandplayTest) to stop capturing and start playing the recording.
-	 * + You must stop the test before starting another test for audio devices.
-	 * + Call [stopAudioDeviceRecordTest](#stopaudiodevicerecordtest) to stop the test, including capturing and playing the recording.
-	 * + This test performs locally and does not involve network connection testing.
-	 */
 	startAudioDeviceRecordTest(indicationInterval: number): Promise<void>;
-	
-	/** 
-	 * @brief Call this API to stop recording in the test and start to play the recording.
-	 * @notes After calling this API, the recording starts playing during which you can call [stopAudioDeviceRecordTest](#stopaudiodevicerecordtest) to stop playing.
-	*/
 	stopAudioDeviceRecordAndPlayTest(): void;
-	
-	/** 
-	 * @brief Stop the capture and playback test for local audio devices which is started by calling [startAudioDeviceRecordTest](#startaudiodevicerecordtest).
-	 * Before the test ends by itself, you can call this API to stop the recording or playing.
-	 */
 	stopAudioDevicePlayTest(): void;
 }
 
@@ -2863,7 +2778,6 @@ export interface RoomConfig {
 	
 	/** 
 	 * @brief Enable/disable auto-subscribe audio. Enable by default.
-	 *        Call publish[104481#publish] to publish media streams if you disable `isAutoPublish`.
 	 */
 	isAutoPublish: boolean;
 	
@@ -3013,7 +2927,7 @@ export interface VideoPlayerOption {
 	renderDom?: string | HTMLElement;
 	
 	/** 
-	 * @brief Rendering modes: optional  `RENDER_MODE_HIDDEN` and `RENDER_MODE_FIT` .
+	 * @brief Rendering modes: optional  `RENDER_MODE_HIDDEN`, `RENDER_MODE_FIT` and `RENDER_MODE_ADAPTIVE`.
 	 */
 	renderMode?: VideoRenderMode;
 	
@@ -3277,20 +3191,8 @@ export interface ScreenConfig {
  * @brief Video encoding configuration
  */
 export interface VideoEncoderConfig {
-	
-	/** 
-	 * @brief width in px
-	 */
 	width: number;
-	
-	/** 
-	 * @brief height in px
-	 */
 	height: number;
-	
-	/** 
-	 * @brief frame rate
-	 */
 	frameRate: number;
 	
 	/** 
@@ -3720,6 +3622,15 @@ export interface PublicStreamConfig {
 	};
 }
 
+/** 
+ * @brief Configurations of the public stream.
+ */
+export declare enum ConnectionMode {
+	AUTO = "auto",
+	FORCE_TCP = "forceTCP",
+	FORCE_UDP = "forceUDP"
+}
+
 /** 
  * @brief Point-to-point text message
  */
@@ -3793,6 +3704,7 @@ declare const Config: {
 	EXPECTED_ADDR: string;
 	LOG_SERVER_URL: string;
 	CONFIG_REQUEST_DOMAINS: string[];
+	CONNECTION_MODE: ConnectionMode;
 };
 declare function setParameter(key: keyof typeof Config, value: any): void;
 declare function getParameter(key: keyof typeof Config): string | string[] | never[];
@@ -3918,6 +3830,7 @@ declare class VERTC implements IVERTC {
 	setParameter: typeof setParameter;
 	isSupported: () => Promise<boolean>;
 	getSupportedCodecs: () => Promise<string[]>;
+	ConnectionMode: typeof ConnectionMode;
 	events: typeof EngineEventsTypes;
 	ErrorCode: typeof ErrorCode;
 	platform: string;