@byteplus/rtc 4.62.1 → 4.63.0

package/index.d.ts

@@ -28,6 +28,7 @@ declare class VERTC implements IVERTC {
 	setParameter: typeof setParameter;
 	isSupported: () => Promise<boolean>;
 	getSupportedCodecs: () => Promise<string[]>;
+	getElectronScreenSources: typeof getElectronScreenSources;
 	events: typeof EngineEventsTypes;
 	ErrorCode: typeof ErrorCode;
 	platform: string;
@@ -69,7 +70,7 @@ declare const Config: {
 	STATS_LOOP_INTERVAL: number;
 	HIDDEN_STATS: boolean;
 	UPLOAD_REMOTE_STATS: ExtendMediaType;
-	DISABLE_COMPUTE_PRESSURE: boolean;
+	SDK_CODEC_NEGOTIATION: boolean;
 };
 declare const _default: VERTC;
 declare enum AudioMixingError {
@@ -828,7 +829,30 @@ declare enum ErrorCode {
 	/** 
 	 * @brief The user is banned. Triggered when you call `joinRoom` after the local user is banned.
 	 */
-	USER_FORBIDDEN = "USER_FORBIDDEN"
+	USER_FORBIDDEN = "USER_FORBIDDEN",
+	
+	/** 
+	 * @brief Failed to get the Electron instance. Ensure the environment meets the requirements for Electron development. Refer to [PC Screen Sharing by Web SDK in Electron](https://docs.byteplus.com/en/docs/byteplus-rtc/docs-1340581) for more.
+	 */
+	ERR_ELECTRON_IS_NULL = "ERR_ELECTRON_IS_NULL",
+	
+	/** 
+	 * @brief Failed to get the screen sharing source in Electron environment.
+	 */
+	ELECTRON_DESKTOP_CAPTURER_GET_SOURCES_ERROR = "ELECTRON_DESKTOP_CAPTURER_GET_SOURCES_ERROR",
+	
+	/** 
+	 * @brief Failed to change the simulcast settings. Ensure that the timing of calling [`setLocalSimulcastMode`](104478#rtcengine-setlocalsimulcastmode) is correct.
+	 * You can change the resolution after publishing, but not the number of streams.
+	 */
+	SET_SIMULCAST_FAILED = "SET_SIMULCAST_FAILED",
+	
+	/** 
+	 * @brief Mixed the deprecated methods of Simulcast feature with the current methods is forbidden. The deprecated methods will no longer be maintained in future versions and are expected to be removed after several updates. It is advised to switch to the current methods as soon as possible.
+	 * + `setRemoteVideoConfig` is deprecated. Please use [`setRemoteSimulcastStreamType`](104478#rtcengine-setremotesimulcaststreamtype) instead.
+	 * + `enableSimulcastMode` is deprecated. Please use [`setLocalSimulcastMode`](104478#rtcengine-setlocalsimulcastmode) instead.
+	 */
+	MIXING_OLD_AND_NEW_APIS = "MIXING_OLD_AND_NEW_APIS"
 }
 declare enum ExtendMediaType {
 	NONE = 0
@@ -926,6 +950,7 @@ declare enum StreamMixingEventType {
 	 */
 	STOP_FAILED = 9
 }
+declare function getElectronScreenSources(type?: ScreenSourceType): Promise<ElectronDesktopCapturerSource[]>;
 declare function getParameter(key: keyof typeof Config): string | number | boolean | string[] | IJoinRoomConfig;
 declare function setParameter<T extends SetParamKey>(key: T, value: (SetParamInterface & CoreSetParamterInterface)[T]): IJoinRoomConfig | undefined;
 
@@ -1148,6 +1173,27 @@ export declare enum ConnectionState {
 	CONNECTION_STATE_LOST = 6
 }
 
+/** 
+ * @brief The preference for the quality of the subscribed stream.
+ */
+export declare enum EarMonitorPosition {
+	
+	/** 
+	 * @brief Disables the ear monitor.
+	 */
+	NONE = 0,
+	
+	/** 
+	 * @brief  Plays the local audio without any processing and audio mixing.
+	 */
+	AFTER_CAPTURE = 1,
+	
+	/** 
+	 * @brief Plays the local audio after processing, without audio mixing.
+	 */
+	AFTER_PROCESS = 2
+}
+
 /** 
  * @brief The reason for media stream fallback or recovery
  */
@@ -1505,6 +1551,27 @@ export declare enum SUBTITLE_MODE {
 	ASR_AND_TRANSLATION = 1
 }
 
+/** 
+ * @brief The preference for the quality of the subscribed stream.
+ */
+export declare enum SimulcastStreamType {
+	
+	/** 
+	 * @brief The stream with the best quality.
+	 */
+	VIDEO_STREAM_HIGH = "high",
+	
+	/** 
+	 * @brief The stream with a medium quality.
+	 */
+	VIDEO_STREAM_MID = "mid",
+	
+	/** 
+	 * @brief The stream with a low quality.
+	 */
+	VIDEO_STREAM_LOW = "low"
+}
+
 /** 
  * @brief Stream specification
  */
@@ -1708,6 +1775,27 @@ export declare enum UserOfflineReason {
 	KICKED_BY_ADMIN = 3
 }
 
+/** 
+ * @brief The preferred codec for the video stream.
+ */
+export declare enum VideoCodecType {
+	
+	/** 
+	 * @brief Not specified. The SDK will automatically match the best codec based on the current video resolution and device performance.
+	 */
+	AUTO = "auto",
+	
+	/** 
+	 * @brief H.264
+	 */
+	H264 = "h264",
+	
+	/** 
+	 * @brief VP8
+	 */
+	VP8 = "vp8"
+}
+
 /** 
  * @brief Rendering modes
  */
@@ -1732,6 +1820,27 @@ export declare enum VideoRenderMode {
 	RENDER_MODE_FILL = 2
 }
 
+/** 
+ * @brief Multiple quality streams
+ */
+export declare enum VideoSimulcastMode {
+	
+	/** 
+	 * @brief Single. The video stream is sent in only set of specification.
+	 */
+	VIDEO_ONLY_ONE = 0,
+	
+	/** 
+	 * @brief On-demand. The publisher will publish streams according to the subscriber's demands. When no subscription preference is taking effect, 2 streams will be published.
+	 */
+	VIDEO_ON_DEMAND = 1,
+	
+	/** 
+	 * @brief Manual. The publisher will publish streams in the qualities of the settings. The default is to publish 2 streams.
+	 */
+	VIDEO_ALWAYS_SIMULCAST = 2
+}
+
 /** 
  * @brief Video source type
  */
@@ -1747,6 +1856,27 @@ export declare enum VideoSourceType {
 	 */
 	VIDEO_SOURCE_TYPE_INTERNAL = 1
 }
+
+/** 
+ * @brief The object to be shared during screen-sharing in Electron.
+ */
+export declare interface ElectronDesktopCapturerSource {
+	
+	/** 
+	 * @brief Identifier.
+	 */
+	id: string;
+	
+	/** 
+	 * @brief Name.
+	 */
+	name: string;
+	
+	/** 
+	 * @brief Thumbnail.
+	 */
+	thumbnail: IElectronNativeImage;
+}
 export declare type RTCExtension = any;
 
 /** 
@@ -1926,6 +2056,11 @@ export interface AutoPlayFailedEvent {
 	 * @brief Player ID. An empty value indicates the default player.
 	 */
 	playerId?: string;
+	
+	/** 
+	 * @brief Whether the ear monitor is enabled. And whether the in-ear monitoring audio is processed.
+	 */
+	position?: EarMonitorPosition;
 }
 
 /** 
@@ -2247,6 +2382,17 @@ export interface IBLWRTCEngine extends IRTCEngine {
 	setRemoteScreenVideoStreamIndex: (streamIndex: StreamIndex) => boolean;
 }
 
+/** 
+ * @brief The thumbnail of the screen-sharing source in Electron.
+ */
+export interface IElectronNativeImage {
+	
+	/** 
+	 * @brief A base 64 encoded Data URL string. Refer to [nativeImage](http://electron.atom.io/docs/api/native-image) for more details.
+	 */
+	toDataURL: () => string;
+}
+
 /** 
  * @id EngineEvents
  * @list overview
@@ -2422,15 +2568,15 @@ export interface IEngineEvents {
 	/** 
 	 * @brief Event of video device state changing.
 	 * @param event Information and state of a media device.
-	 * @group Video Management
-	 * @order 50
+	 * @group Device Management
+	 * @order 60
 	 */
 	[EngineEventsTypes.onVideoDeviceStateChanged]: (event: DeviceInfo) => void;
 	
 	/** 
 	 * @brief Event of audio device state changing.
 	 * @param event Information and state of a media device.
-	 * @group Audio Management
+	 * @group Device Management
 	 * @order 50
 	 */
 	[EngineEventsTypes.onAudioDeviceStateChanged]: (event: DeviceInfo) => void;
@@ -2580,7 +2726,7 @@ export interface IEngineEvents {
 	}) => void;
 	
 	/** 
-	 * @brief After calling [enableAudioPropertiesReport](docs-104478#enableaudiopropertiesreport), you will periodically receive this callback for the information about local audio.
+	 * @brief After calling [enableAudioPropertiesReport](docs-104478#enableaudiopropertiesreport), you will periodically receive this callback for the instant information about local audio.
 	 *        Local audio includes the microphone audio and the screen audio captured using RTC SDK internal mechanisms.
 	 * @param event Information about local audio.
 	 * @group Audio Management
@@ -3288,8 +3434,8 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @param deviceId Device ID. Call [enumerateDevices](#enumeratedevices) to get the device list.
 	 * @return
 	 * @notes  If the internal audio capturing is on, the switch is effective once you call this API. If the internal audio capturing is off, the setting will be effective when capture starts.
-	 * @group Audio Management
-	 * @order 0
+	 * @group Device Management
+	 * @order 45
 	 */
 	setAudioCaptureDevice: (deviceId: string) => Promise<void>;
 	
@@ -3300,8 +3446,8 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @notes + If the internal video capturing is on, the switch is effective once you call this API. If the internal video capturing is off, the setting will be effective when capture starts.
 	 *        + For mobile devices, set deviceId as `"user"` to use the front camera. Set deviceId as `"environment"` to use the rear camera.
 	 *        + The default camera is set by the browser.
-	 * @group Video Management
-	 * @order 0
+	 * @group Device Management
+	 * @order 55
 	 */
 	setVideoCaptureDevice: (deviceId: string) => Promise<void>;
 	
@@ -3513,7 +3659,8 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @param mediaType For audio or video. It defaults to `AUDIO_AND_VIDEO`. The local audio is not included. While the Audio selection is enabled, it can only be set to `VIDEO`.
 	 * @param streamIndex Main stream or screen-sharing stream. By default, the action will apply to both the main stream and the screen-sharing stream.
 	 * @param playerId Player ID. An empty value indicates the default player.
-	 * @notes After using this method to pause the media stream,
+	 * @notes When the audio selection is enabled, this method will not take effect.
+	 * After using this method to pause the media stream,
 	 * + The billing duration will not stop counting since the subscription doesn't cancel.
 	 * + The stream will not remove from the player. You can call [play](#play) to resume the stream.
 	 * + The volume of the stream will not be `0`, which you can obtain via [getAudioLevel](getAudioLevel) or the callback of [onLocalAudioPropertiesReport](docs-104479#onlocalaudiopropertiesreport) or [onRemoteAudioPropertiesReport](docs-104479#onremoteaudiopropertiesreport).
@@ -3552,7 +3699,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @brief Toggle the callbacks carrying the audio frames.
 	 * @param streamIndex Audio from microphone or device audio.
 	 * @param userId ID of the remote user who published the audio. An empty value indicates the local audio.
-	 * When the Audio seclection enabled, only the local audio frames are available.
+	 * When the Audio selection enabled, only the local audio frames are available.
 	 * You will get the callback carrying the audio data as soon as the user starts publish audio.
 	 * @param callback The callback function to receive the audio frames. An empty value indicates disabling the callback.
 	 * When the user disconnects, the audio data is zero amplitude.
@@ -3644,7 +3791,9 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @brief Send supplemental enhancement information (SEI) through video frames.
 	 *        In the video call scenario, the SEI data will be sent with the video frames. In the voice call scenario, the SDK will generate a 16px × 16px black frame video stream to send the data.
 	 * @param streamIndex Specify the type of media stream carrying SEI information. In the voice call scenario, it is recommended to set this value to `STREAM_INDEX_MAIN`.
-	 * @param message SEI message within 4 KB. Empty message or message exceeding this size will not be sent with respective error prompt.
+	 * @param message SEI message within 4 KB.
+	 * Empty message or message exceeding this size will not be sent with respective error prompt.
+	 * The SEI PayLoadType must be `5` or `100`.
 	 * @param repeatCount Number of times a message is sent repeatedly. The SEI will be added to a consecutive `repeatCount+1` number of video frames starting from the current frame. The value range is `[0, min{30, %{video frame rate}×2}]`, and the recommended range is `[2,4]`.
 	 * @notes + **Compatibility**<br/>
 	 *         &ensp; - SEI messages only support H.264 encoding, and use on browsers with Chromium 86+.
@@ -3660,18 +3809,14 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	sendSEIMessage: (streamIndex: StreamIndex, message: Uint8Array | string, repeatCount: number) => void;
 	
 	/** 
-	 * @brief Set the video stream configurations from the video publishing end.
-	 * @param descriptions The configurations of multiple video streams to be published. The resolution set is the maximum resolution for each stream.
-	 *                     Up to 3 sets of configurations can be set. When there are more than 3 sets, the values of the first 3 sets will be used.
-	 *                     When multiple configurations are set, the resolution and frame rate must be arranged in descending order. For better compatibility, it is recommended that the ratio between the maximum level resolution and other level resolutions be an integer multiple.
-	 *                     When the resolution of the first stream is greater than or equal to 540P, it supports publishing 3 streams; when it is between 270P (inclusive) and 450P (inclusive), it supports publishing 2 streams; when it is 180P or below, you cannot enable simulcasting.
-	 * @notes + Before calling this method, the SDK defaults to publishing a stream with a resolution of 640 × 480 pixels, a frame rate of 15 FPS, and a maximum encoding bitrate of 600 Kbps.
-	 *        + When publishing a single stream, you can call this method before or after publishing the video stream. After the video stream is published, dynamic switching between single stream and multiple streams is not supported, and modifying the parameters of the published multiple streams is not supported.
-	 *        + When using a mobile device to publish a video stream in portrait mode, the set resolution width and height are reversed in the actual streaming parameters. For example, when setting the sending resolution to 640 × 480 pixels, the actual streaming parameters are 480 × 640 pixels.
-	 *        + If the set parameters are not supported by the browser, the RTC SDK will capture and encode based on the parameter range supported by the browser, and notify the actual parameters through the [onLocalVideoSizeChanged](docs-104479#onlocalvideosizechanged) callback.
-	 *        + If you want to simulcast, you need to disable automatic publishing, call this method and [enableSimulcastMode](#enablesimulcastmode) to enable multiple stream mode, and then call [publishStream](#publishstream) to manually publish the audio and video streams.
-	 *        + If this method is called to set multiple resolutions but multiple stream mode is not enabled, the SDK will default to publishing the stream with the highest resolution. If multiple stream publishing is enabled but only one set of stream parameters is set, the SDK will automatically fill in 1-2 sets of small stream parameters.
-	 *        + This method is applicable to video streams captured by the camera. For setting the screen sharing stream parameters, refer to [setScreenEncoderConfig](#setscreenencoderconfig).
+	 * @brief Configure the encdoing settings for the camera videos on the publisher side.
+	 * @param descriptions The configurations of the video streams to be published.
+	 * @notes + If you want to publish multiple streams with different resolutions, you need to enable and specify the configurations of the lower-quality streams through [setLocalSimulcastMode](#rtcengine-setlocalsimulcastmode). When publishing multiple streams with different resolutions, the parameters set through this method are the highest resolution among the video streams.
+	 * + Before calling this method, the SDK defaults to publishing a stream with a resolution of 640 × 480 pixels, a frame rate of 15 FPS, and a maximum encoding bitrate of 600 Kbps.
+	 * + You can call this method before or after publishing the video stream.
+	 * + When using a mobile device to publish a video stream in portrait mode, the set resolution width and height are reversed in the actual streaming parameters. For example, when setting the sending resolution to 640 × 480 pixels, the actual streaming parameters are 480 × 640 pixels.
+	 * + If the set parameters are not supported by the browser, the RTC SDK will capture and encode based on the parameter range supported by the browser, and notify the actual parameters through the [onLocalVideoSizeChanged](docs-104479#onlocalvideosizechanged) callback.
+	 * + This method is applicable to video streams captured by the camera. For setting the screen sharing stream parameters, refer to [setScreenEncoderConfig](#setscreenencoderconfig).
 	 * @group Video Management
 	 * @order 35
 	 */
@@ -3689,6 +3834,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	setScreenEncoderConfig: (description: ScreenEncoderConfig) => Promise<void>;
 	
 	/** 
+	 * @hidden Deprecated since V4.63, use setRemoteSimulcastStreamType instead.
 	 * @brief Sets your expected configuration of the remote video stream that you want to subscribe to or have subscribed to.
 	 * @param userId ID of the remote video stream publisher you expect to configure subscription parameters for.
 	 * @param remoteVideoConfig The parameters you expect to configure for the remote video stream.
@@ -3701,6 +3847,22 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	setRemoteVideoConfig: (userId: string, remoteVideoConfig: RemoteVideoConfig) => Promise<void>;
 	
 	/** 
+	 * @brief Sets your expected quality level of the remote video stream that you want to subscribe to or have subscribed to.
+	 * @param userId ID of the remote video stream publisher you expect to configure subscription parameters for.
+	 * If the low-quality stream to be subscribed to is not published, the standard stream would be subscribed to. If the mid-quality stream to be subscribed to is not published, the low-quality stream would be subscribed to.
+	 * @param streamType The preference for the quality of the subscribed stream.
+	 * @return Refer to [MIXING_OLD_AND_NEW_APIS](docs-104480#errorcode) for the details of the error code.
+	 * @notes + This API only works after the publisher calls [setLocalSimulcastMode](#setLocalSimulcastMode) to enable publishing multiple video streams, in which case the subscriber will receive a stream that is closest to the set configuration.
+	 *        + If you don't call this API after the publisher enables the function of publishing multiple streams, you will receive the highest-quality video stream by default.
+	 *        + You can call this method before or after joining a room.
+	 *        - Refer to [Simulcasting](https://docs.byteplus.com/en/docs/byteplus-rtc/docs-70139) for more information.
+	 * @group Audio & Video Transport
+	 * @order 25
+	 */
+	setRemoteSimulcastStreamType: (userId: string, streamType: SimulcastStreamType) => Promise<void>;
+	
+	/** 
+	 * @hidden Deprecated since V4.63, use setLocalSimulcastMode instead.
 	 * @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 Whether to enable simulcast.
 	 * @return + `true`: Success.
@@ -3713,6 +3875,27 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 */
 	enableSimulcastMode: (enabled: boolean) => boolean;
 	
+	/** 
+	 * @valid since V4.63
+	 * @brief Enable the Simulcast feature and configure the lower-quality camera videos for the stream publisher.
+	 * @param mode Whether to publish lower-quality streams and how many of them to be published. By default, it is set to Single, where the publisher sends the video in a single profile.
+	 *             This parameter must be set before joining a room.
+	 * @param streamConfig The specification of the lower quality stream(s).
+	 *                     The resolution of the lower quality stream must be smaller than the standard stream set via [setVideoEncoderConfig](#rtcengine-setvideoencoderconfig). The specifications in the array must be arranged in ascending order based on resolution.
+	 *                     You can configure the lower quality stream(s) before or after joining a room. However, after publishing the streams, you can no longer change the number of lower quality streams.
+	 *                     When the Simulcast feature is enabled, the low-quality stream is set to a default resolution of 120px × 90px @10fps with a bitrate of 100Kbps.
+	 * - For the stream exceeding 540P in resolution, the browser supports up to three distinct video stream resolutions.
+	 * - For the stream below 180P in resolution, publishing is limited to a single stream only.
+	 * - For the stream falls between 180P and 540P in resolution, you can publish an additional lower-quality stream.
+	 * @return Refer to [SET_SIMULCAST_FAILED](docs-104480#errorcode) and [MIXING_OLD_AND_NEW_APIS](docs-104480#errorcode) for the details of the error code.
+	 * @note - The default setting is to publish a single stream.
+	 *       - The method applies to the camera video only.
+	 *       - Refer to [Simulcasting](https://docs.byteplus.com/en/docs/byteplus-rtc/docs-70139) for more information.
+	 * @group Audio & Video Transport
+	 * @order 20
+	 */
+	setLocalSimulcastMode: (mode: VideoSimulcastMode, streamConfig?: VideoEncoderConfig[]) => Promise<void>;
+	
 	/** 
 	 * @hidden
 	 * @deprecated since 4.42, use enableAudioPropertiesReport instead
@@ -4262,8 +4445,9 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @brief Take a snapshot of the local video.
 	 * @param streamIndex The specified video stream.
 	 * @param playerId Player ID. An empty value indicates the default player. If the default player does not exist by then, the call will not take effect.
-	 * @notes + The snapshot is taken with all video effects on, including the beauty effect, virtual background and mirroring.
-	 *        + You can take the snapshot either using SDK internal video capture or customized capture.
+	 * @notes + Before using this method to capture a snapshot, make sure the local camera is actively streaming. You can check this via [getLocalStreamTrack](docs-104478#rtcengine-getlocalstreamtrack). A non-empty return value indicates that the local video stream is active and ready for snapshot capture.
+	 * + The snapshot is taken with the beauty effect and virtual background.
+	 * + You can take the snapshot either using SDK internal video capture or customized capture.
 	 * @return `INVOKED_BEFORE_CAPTURE`: No such stream. Please make sure that the specified stream has been published.
 	 * @group Video Snapshot
 	 * @order 0
@@ -4276,6 +4460,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @param streamIndex The specified video stream.
 	 * @param playerId Player ID. An empty value indicates the default player. If the default player does not exist by then, the call will not take effect.
 	 * @return `STREAM_NOT_EXIST`: The target stream does not exist. Please enter the correct ID or make sure that the target stream is in the room.
+	 * @notes Before using this method to capture a snapshot, make sure you have successfully received the remote stream on the local client. You can check this via [getRemoteStreamTrack](docs-104478#rtcengine-getremotestreamtrack). A non-empty return value indicates that the remote stream has been successfully subscribed to.
 	 * @group Video Snapshot
 	 * @order 1
 	 */
@@ -4514,6 +4699,31 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @hidden for internal use
 	 */
 	getPublicAudioStats: () => Record<string, RemoteAudioStats>;
+	
+	/** 
+	 * @valid since V4.63
+	 * @brief Enable/Disable in-ear monitoring.
+	 * @param streamIndex Mainstream or screen-sharing stream.
+	 * @param position Whether to enable in-ear monitoring. Specify whether the in-ear monitoring audio is processed.
+	 * @return If the in-ear monitoring audio fails to play automatically, we recommend calling this method again after receiving [onAutoplayFailed](docs-104479#engineevents-onautoplayfailed) to recover.
+	 * @note - You can set the ear monitor volume anytime after creating the engine.
+	 *       - You can adjust the ear monitor volume using [setEarMonitorVolume](docs-104478#rtcengine-setearmonitorvolume).
+	 *       - We recommend that you use wired earbuds/headphones for a high-quality hearing experience.
+	 * @group Audio Management
+	 * @order 75
+	 */
+	setEarMonitorMode: (streamIndex: StreamIndex, position: EarMonitorPosition) => Promise<void>;
+	
+	/** 
+	 * @valid since V4.63
+	 * @brief Set the monitoring volume.
+	 * @param streamIndex Mainstream or screen-sharing stream.
+	 * @param volume  The monitoring volume with the adjustment range between 0 and 400. The initial value is `100`.
+	 * @note  We recommend that you set the ear monitor volume after starting to capture audio and enabling the ear monitor.
+	 * @group Audio Management
+	 * @order 80
+	 */
+	setEarMonitorVolume: (streamIndex: StreamIndex, volume: number) => void;
 }
 
 /** 
@@ -4678,6 +4888,18 @@ export interface IVERTC {
 	 * @order 26
 	 */
 	downloadLog: (key?: string) => void;
+	
+	/** 
+	 * @valid since V4.63
+	 * @brief Get the list of screen-sharing objects.
+	 * @param type The type of screen-sharing object, screen or application. If empty, get all the available screen-sharing objects.
+	 * @notes For more details, see [Implement screen sharing with Web SDK in Electron](https://docs.byteplus.com/byteplus-rtc/docs/1340581).
+	 * @return The list of screen-sharing objects.
+	 * Refer to [ERR_ELECTRON_IS_NULL](docs-104480#errorcode) and [ELECTRON_DESKTOP_CAPTURER_GET_SOURCES_ERROR](docs-104480#errorcode) for the details of the error code.
+	 * @group Screen Sharing
+	 * @order 3
+	 */
+	getElectronScreenSources: (type?: ScreenSourceType) => Promise<ElectronDesktopCapturerSource[]>;
 }
 
 /** 
@@ -5124,7 +5346,7 @@ export interface LocalVideoStats {
 	 *        "H264": H.264 video codec.
 	 *        "VP8": VP8 video codec.
 	 */
-	codecType: string;
+	codecType: "H264" | "VP8";
 	
 	/** 
 	 * @brief Whether it is a screen-sharing stream
@@ -5723,6 +5945,13 @@ export interface RemoteVideoStats {
 	 * @brief Video index
 	 */
 	videoIndex?: number;
+	
+	/** 
+	 * @brief Video codec.
+	 *        "H264": H.264 video codec.
+	 *        "VP8": VP8 video codec.
+	 */
+	codecType: "H264" | "VP8";
 }
 
 /** 
@@ -5789,7 +6018,8 @@ export interface ScreenConfig {
 	 * @brief Whether to include the system audio
 	 * `include`：(Default) Include.
 	 * `exclude`：Exclude.
-	 * For Chrome 107, Edge 107, and later versions on Windows
+	 * For Chrome 107, Edge 107, and later versions on Windows.
+	 * For Electron app, only support sharing the system audio on Windows.
 	 * See [systemAudio](https://developer.chrome.com/docs/web-platform/screen-sharing-controls/#systemAudio).
 	 */
 	systemAudio?: "include" | "exclude";
@@ -5811,6 +6041,12 @@ export interface ScreenConfig {
 	 * See [selfBrowserSurface](https://developer.chrome.com/docs/web-platform/screen-sharing-controls/#selfBrowserSurface).
 	 */
 	selfBrowserSurface?: "include" | "exclude";
+	
+	/** 
+	 * @brief The ID of the object to be shared during screen-sharing in Electron.
+	 * You can get the ID from [getElectronScreenSources](docs-104478#vertc-getelectronscreensources).
+	 */
+	sourceId?: string;
 }
 
 /** 
@@ -5881,6 +6117,7 @@ export interface SetParamInterface {
 	PRE_ICE: boolean;
 	STATS_LOOP_INTERVAL: number;
 	UPLOAD_REMOTE_STATS: string;
+	SDK_CODEC_NEGOTIATION: boolean;
 }
 
 /** 
@@ -6446,6 +6683,7 @@ export type CoreSetParamterInterface = {
 
 /** 
  * @brief Layout configuration of a media stream
+ * This struct contains all parameters in [LiveTranscodeLayoutRegion](#livetranscodelayoutregion) except for `isLocalUser` and `contentControl`, as well as the following parameters.
  */
 export type PublicStreamLayoutRegion = Omit<LiveTranscodeLayoutRegion, "isLocalUser" | "contentControl"> & {
 	
@@ -6517,6 +6755,13 @@ onVideoFirstFrameDecodedEvent, "userId"> & {
 	 */
 	publicStreamId: string;
 };
+
+/** 
+ * @brief The type of screen-sharing object in Electron.
+ * • `screen`: Screens.
+ * • `window`: Windows and applications.
+ */
+export type ScreenSourceType = "screen" | "window";
 export type SetParamKey = keyof (SetParamInterface & CoreSetParamterInterface);
 
 /**