agora-electron-sdk 4.2.2-dev.4 → 4.2.2

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 
 
+## [4.2.2](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.2.1...v4.2.2) (2023-08-01)
+
+
+### Bug Fixes
+
+* CSD-57615 render mode not working on software renderer ([1097ebc](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/1097ebcdf21cb6f5c66821174e8f46ec470976db))
+* CSD-57699 removeEventListener `webglcontextlost` while unbind ([2a280c8](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/2a280c87242fe3abecb61bc23ffb0996029d6fec))
+
+
+### Features
+
+* support native 4.2.2 ([#1033](https://github.com/AgoraIO-Extensions/Electron-SDK/issues/1033)) ([f151e69](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/f151e69abf22286eb5fbec3bcee8f703188c7515))
+
+## [4.2.1](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.2.0...v4.2.1) (2023-06-30)
+
+
+### Features
+
+* support native 4.2.1 ([#1029](https://github.com/AgoraIO-Extensions/Electron-SDK/issues/1029)) ([31ca560](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/31ca560bcd6434c4d3badad1b2e8d40eaae8be36))
+
 # [4.2.0](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.2.0-rc.6...v4.2.0) (2023-05-26)
 
 # [4.2.0-rc.6](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.1.1-rc.1...v4.2.0-rc.6) (2023-05-25)

package/js/Private/AgoraBase.js

@@ -181,15 +181,24 @@ var ErrorCodeType;
      */
     ErrorCodeType[ErrorCodeType["ErrInvalidArgument"] = 2] = "ErrInvalidArgument";
     /**
-     * 3: The SDK is not ready. Possible reasons include the following:The initialization of IRtcEngine fails. Reinitialize the IRtcEngine.No user has joined the channel when the method is called. Check the code logic.The user has not left the channel when the rate or complain method is called. Check the code logic.The audio module is disabled.The program is not complete.
+     * 3: The SDK is not ready. Possible reasons include the following:
+     *  The initialization of IRtcEngine fails. Reinitialize the IRtcEngine.
+     *  No user has joined the channel when the method is called. Check the code logic.
+     *  The user has not left the channel when the rate or complain method is called. Check the code logic.
+     *  The audio module is disabled.
+     *  The program is not complete.
      */
     ErrorCodeType[ErrorCodeType["ErrNotReady"] = 3] = "ErrNotReady";
     /**
-     * 4: The IRtcEngine does not support the request. Possible reasons include the following:The built-in encryption mode is incorrect, or the SDK fails to load the external encryption library. Check the encryption mode setting, or reload the external encryption library.
+     * 4: The IRtcEngine does not support the request. Possible reasons include the following:
+     *  The built-in encryption mode is incorrect, or the SDK fails to load the external encryption library. Check the encryption mode setting, or reload the external encryption library.
      */
     ErrorCodeType[ErrorCodeType["ErrNotSupported"] = 4] = "ErrNotSupported";
     /**
-     * 5: The request is rejected. Possible reasons include the following:The IRtcEngine initialization fails. Reinitialize the IRtcEngine.The channel name is set as the empty string "" when joining the channel. Reset the channel name.When the joinChannelEx method is called to join multiple channels, the specified channel name is already in use. Reset the channel name.
+     * 5: The request is rejected. Possible reasons include the following:
+     *  The IRtcEngine initialization fails. Reinitialize the IRtcEngine.
+     *  The channel name is set as the empty string "" when joining the channel. Reset the channel name.
+     *  When the joinChannelEx method is called to join multiple channels, the specified channel name is already in use. Reset the channel name.
      */
     ErrorCodeType[ErrorCodeType["ErrRefused"] = 5] = "ErrRefused";
     /**
@@ -229,11 +238,15 @@ var ErrorCodeType;
      */
     ErrorCodeType[ErrorCodeType["ErrNetDown"] = 14] = "ErrNetDown";
     /**
-     * 17: The request to join the channel is rejected. Possible reasons include the following:The user is already in the channel. Agora recommends that you use the onConnectionStateChanged callback to determine whether the user exists in the channel. Do not call this method to join the channel unless you receive the ConnectionStateDisconnected(1) state.After calling startEchoTest for the call test, the user tries to join the channel without calling stopEchoTest to end the current test. To join a channel, the call test must be ended by calling stopEchoTest.
+     * 17: The request to join the channel is rejected. Possible reasons include the following:
+     *  The user is already in the channel. Agora recommends that you use the onConnectionStateChanged callback to determine whether the user exists in the channel. Do not call this method to join the channel unless you receive the ConnectionStateDisconnected (1) state.
+     *  After calling startEchoTest for the call test, the user tries to join the channel without calling stopEchoTest to end the current test. To join a channel, the call test must be ended by calling stopEchoTest.
      */
     ErrorCodeType[ErrorCodeType["ErrJoinChannelRejected"] = 17] = "ErrJoinChannelRejected";
     /**
-     * 18: Fails to leave the channel. Possible reasons include the following:The user has left the channel before calling the leaveChannel method. Stop calling this method to clear this error.The user calls the leaveChannel method to leave the channel before joining the channel. In this case, no extra operation is needed.
+     * 18: Fails to leave the channel. Possible reasons include the following:
+     *  The user has left the channel before calling the leaveChannel method. Stop calling this method to clear this error.
+     *  The user calls the leaveChannel method to leave the channel before joining the channel. In this case, no extra operation is needed.
      */
     ErrorCodeType[ErrorCodeType["ErrLeaveChannelRejected"] = 18] = "ErrLeaveChannelRejected";
     /**
@@ -265,11 +278,13 @@ var ErrorCodeType;
      */
     ErrorCodeType[ErrorCodeType["ErrNoServerResources"] = 103] = "ErrNoServerResources";
     /**
-     * 109: The current token has expired. Apply for a new token on the server and call renewToken.Deprecated:This enumerator is deprecated. Use ConnectionChangedTokenExpired(9) in the onConnectionStateChanged callback instead.
+     * 109: The current token has expired. Apply for a new token on the server and call renewToken. Deprecated: This enumerator is deprecated. Use ConnectionChangedTokenExpired (9) in the onConnectionStateChanged callback instead.
      */
     ErrorCodeType[ErrorCodeType["ErrTokenExpired"] = 109] = "ErrTokenExpired";
     /**
-     * 110: Invalid token. Typical reasons include the following:App Certificate is enabled in Agora Console, but the code still uses App ID for authentication. Once App Certificate is enabled for a project, you must use token-based authentication.The uid used to generate the token is not the same as the uid used to join the channel.Deprecated:This enumerator is deprecated. Use ConnectionChangedInvalidToken(8) in the onConnectionStateChanged callback instead.
+     * 110: Invalid token. Typical reasons include the following:
+     *  App Certificate is enabled in Agora Console, but the code still uses App ID for authentication. Once App Certificate is enabled for a project, you must use token-based authentication.
+     *  The uid used to generate the token is not the same as the uid used to join the channel. Deprecated: This enumerator is deprecated. Use ConnectionChangedInvalidToken (8) in the onConnectionStateChanged callback instead.
      */
     ErrorCodeType[ErrorCodeType["ErrInvalidToken"] = 110] = "ErrInvalidToken";
     /**
@@ -495,7 +510,7 @@ var UserOfflineReasonType;
      */
     UserOfflineReasonType[UserOfflineReasonType["UserOfflineQuit"] = 0] = "UserOfflineQuit";
     /**
-     * 1: The SDK times out and the user drops offline because no data packet is received within a certain period of time.If the user quits the call and the message is not passed to the SDK (due to an unreliable channel), the SDK assumes the user dropped offline.
+     * 1: The SDK times out and the user drops offline because no data packet is received within a certain period of time. If the user quits the call and the message is not passed to the SDK (due to an unreliable channel), the SDK assumes the user dropped offline.
      */
     UserOfflineReasonType[UserOfflineReasonType["UserOfflineDropped"] = 1] = "UserOfflineDropped";
     /**
@@ -537,7 +552,7 @@ var InterfaceIdType;
      */
     InterfaceIdType[InterfaceIdType["AgoraIidRtcConnection"] = 7] = "AgoraIidRtcConnection";
     /**
-     * This interface class is deprecated.
+     * @ignore
      */
     InterfaceIdType[InterfaceIdType["AgoraIidSignalingEngine"] = 8] = "AgoraIidSignalingEngine";
     /**
@@ -737,7 +752,9 @@ var VideoFrameType;
 var OrientationMode;
 (function (OrientationMode) {
     /**
-     * 0: (Default) The output video always follows the orientation of the captured video. The receiver takes the rotational information passed on from the video encoder. This mode applies to scenarios where video orientation can be adjusted on the receiver.If the captured video is in landscape mode, the output video is in landscape mode.If the captured video is in portrait mode, the output video is in portrait mode.
+     * 0: (Default) The output video always follows the orientation of the captured video. The receiver takes the rotational information passed on from the video encoder. This mode applies to scenarios where video orientation can be adjusted on the receiver.
+     *  If the captured video is in landscape mode, the output video is in landscape mode.
+     *  If the captured video is in portrait mode, the output video is in portrait mode.
      */
     OrientationMode[OrientationMode["OrientationModeAdaptive"] = 0] = "OrientationModeAdaptive";
     /**
@@ -763,7 +780,7 @@ var DegradationPreference;
      */
     DegradationPreference[DegradationPreference["MaintainFramerate"] = 1] = "MaintainFramerate";
     /**
-     * 2: Reduces the video frame rate and video resolution simultaneously during video encoding under limited bandwidth. The MaintainBalanced has a lower reduction than MaintainQuality and MaintainFramerate, and this preference is suitable for scenarios where both smoothness and video quality are a priority.The resolution of the video sent may change, so remote users need to handle this issue. See onVideoSizeChanged.
+     * 2: Reduces the video frame rate and video resolution simultaneously during video encoding under limited bandwidth. The MaintainBalanced has a lower reduction than MaintainQuality and MaintainFramerate, and this preference is suitable for scenarios where both smoothness and video quality are a priority. The resolution of the video sent may change, so remote users need to handle this issue. See onVideoSizeChanged.
      */
     DegradationPreference[DegradationPreference["MaintainBalanced"] = 2] = "MaintainBalanced";
     /**
@@ -850,7 +867,7 @@ var VideoCodecType;
      */
     VideoCodecType[VideoCodecType["VideoCodecH265"] = 3] = "VideoCodecH265";
     /**
-     * 6: Generic.This type is used for transmitting raw video data, such as encrypted video frames. The SDK returns this type of video frames in callbacks, and you need to decode and render the frames yourself.
+     * 6: Generic. This type is used for transmitting raw video data, such as encrypted video frames. The SDK returns this type of video frames in callbacks, and you need to decode and render the frames yourself.
      */
     VideoCodecType[VideoCodecType["VideoCodecGeneric"] = 6] = "VideoCodecGeneric";
     /**
@@ -866,7 +883,7 @@ var VideoCodecType;
      */
     VideoCodecType[VideoCodecType["VideoCodecVp9"] = 13] = "VideoCodecVp9";
     /**
-     * 20: Generic JPEG.This type consumes minimum computing resources and applies to IoT devices.
+     * 20: Generic JPEG. This type consumes minimum computing resources and applies to IoT devices.
      */
     VideoCodecType[VideoCodecType["VideoCodecGenericJpeg"] = 20] = "VideoCodecGenericJpeg";
 })(VideoCodecType = exports.VideoCodecType || (exports.VideoCodecType = {}));
@@ -1119,7 +1136,9 @@ exports.AdvanceOptions = AdvanceOptions;
 var VideoMirrorModeType;
 (function (VideoMirrorModeType) {
     /**
-     * 0: The SDK determines the mirror mode.For the mirror mode of the local video view: If you use a front camera, the SDK enables the mirror mode by default; if you use a rear camera, the SDK disables the mirror mode by default.For the remote user: The mirror mode is disabled by default.
+     * 0: The SDK determines the mirror mode.
+     *  For the mirror mode of the local video view: If you use a front camera, the SDK enables the mirror mode by default; if you use a rear camera, the SDK disables the mirror mode by default.
+     *  For the remote user: The mirror mode is disabled by default.
      */
     VideoMirrorModeType[VideoMirrorModeType["VideoMirrorModeAuto"] = 0] = "VideoMirrorModeAuto";
     /**
@@ -1158,7 +1177,7 @@ var CodecCapMask;
     CodecCapMask[CodecCapMask["CodecCapMaskSwEnc"] = 8] = "CodecCapMaskSwEnc";
 })(CodecCapMask = exports.CodecCapMask || (exports.CodecCapMask = {}));
 /**
- * @ignore
+ * The level of the codec capability.
  */
 var CodecCapLevels = /** @class */ (function () {
     function CodecCapLevels() {
@@ -1234,7 +1253,9 @@ exports.Rectangle = Rectangle;
 /**
  * The position and size of the watermark on the screen.
  *
- * The position and size of the watermark on the screen are determined by xRatio , yRatio , and widthRatio : ( xRatio , yRatio ) refers to the coordinates of the upper left corner of the watermark, which determines the distance from the upper left corner of the watermark to the upper left corner of the screen. The widthRatio determines the width of the watermark.
+ * The position and size of the watermark on the screen are determined by xRatio, yRatio, and widthRatio :
+ *  (xRatio, yRatio) refers to the coordinates of the upper left corner of the watermark, which determines the distance from the upper left corner of the watermark to the upper left corner of the screen.
+ *  The widthRatio determines the width of the watermark.
  */
 var WatermarkRatio = /** @class */ (function () {
     function WatermarkRatio() {
@@ -1379,7 +1400,10 @@ var AudioAinsMode;
 var AudioProfileType;
 (function (AudioProfileType) {
     /**
-     * 0: The default audio profile.For the interactive streaming profile: A sample rate of 48 kHz, music encoding, mono, and a bitrate of up to 64 Kbps.For the communication profile: Windows: A sample rate of 16 kHz, audio encoding, mono, and a bitrate of up to 16 Kbps.macOS: A sample rate of 32 kHz, audio encoding, mono, and a bitrate of up to 18 Kbps.
+     * 0: The default audio profile.
+     *  For the interactive streaming profile: A sample rate of 48 kHz, music encoding, mono, and a bitrate of up to 64 Kbps.
+     *  For the communication profile:
+     *  Windows: A sample rate of 16 kHz, audio encoding, mono, and a bitrate of up to 16 Kbps. macOS: A sample rate of 32 kHz, audio encoding, mono, and a bitrate of up to 18 Kbps.
      */
     AudioProfileType[AudioProfileType["AudioProfileDefault"] = 0] = "AudioProfileDefault";
     /**
@@ -1391,7 +1415,7 @@ var AudioProfileType;
      */
     AudioProfileType[AudioProfileType["AudioProfileMusicStandard"] = 2] = "AudioProfileMusicStandard";
     /**
-     * 3: A sample rate of 48 kHz, music encoding, stereo, and a bitrate of up to 80 Kbps.To implement stereo audio, you also need to call setAdvancedAudioOptions and set audioProcessingChannels to AudioProcessingStereo in AdvancedAudioOptions.
+     * 3: A sample rate of 48 kHz, music encoding, stereo, and a bitrate of up to 80 Kbps. To implement stereo audio, you also need to call setAdvancedAudioOptions and set audioProcessingChannels to AudioProcessingStereo in AdvancedAudioOptions.
      */
     AudioProfileType[AudioProfileType["AudioProfileMusicStandardStereo"] = 3] = "AudioProfileMusicStandardStereo";
     /**
@@ -1399,7 +1423,7 @@ var AudioProfileType;
      */
     AudioProfileType[AudioProfileType["AudioProfileMusicHighQuality"] = 4] = "AudioProfileMusicHighQuality";
     /**
-     * 5: A sample rate of 48 kHz, music encoding, stereo, and a bitrate of up to 128 Kbps.To implement stereo audio, you also need to call setAdvancedAudioOptions and set audioProcessingChannels to AudioProcessingStereo in AdvancedAudioOptions.
+     * 5: A sample rate of 48 kHz, music encoding, stereo, and a bitrate of up to 128 Kbps. To implement stereo audio, you also need to call setAdvancedAudioOptions and set audioProcessingChannels to AudioProcessingStereo in AdvancedAudioOptions.
      */
     AudioProfileType[AudioProfileType["AudioProfileMusicHighQualityStereo"] = 5] = "AudioProfileMusicHighQualityStereo";
     /**
@@ -1500,7 +1524,20 @@ var VideoApplicationScenarioType;
      */
     VideoApplicationScenarioType[VideoApplicationScenarioType["ApplicationScenarioGeneral"] = 0] = "ApplicationScenarioGeneral";
     /**
-     * If set to ApplicationScenarioMeeting (1), the SDK automatically enables the following strategies:In meeting scenarios where low-quality video streams are required to have a high bitrate, the SDK automatically enables multiple technologies used to deal with network congestions, to enhance the performance of the low-quality streams and to ensure the smooth reception by subscribers.The SDK monitors the number of subscribers to the high-quality video stream in real time and dynamically adjusts its configuration based on the number of subscribers.If nobody subscribers to the high-quality stream, the SDK automatically reduces its bitrate and frame rate to save upstream bandwidth.If someone subscribes to the high-quality stream, the SDK resets the high-quality stream to the VideoEncoderConfiguration configuration used in the most recent calling of setVideoEncoderConfiguration. If no configuration has been set by the user previously, the following values are used:Resolution: 1280 × 720Frame rate: 15 fpsBitrate: 1600 KbpsThe SDK monitors the number of subscribers to the low-quality video stream in real time and dynamically enables or disables it based on the number of subscribers.If the user has called setDualStreamMode to set that never send low-quality video stream (DisableSimulcastStream), the dynamic adjustment of the low-quality stream in meeting scenarios will not take effect.If nobody subscribes to the low-quality stream, the SDK automatically disables it to save upstream bandwidth.If someone subscribes to the low-quality stream, the SDK enables the low-quality stream and resets it to the SimulcastStreamConfig configuration used in the most recent calling of setDualStreamMode. If no configuration has been set by the user previously, the following values are used:Resolution: 480 × 272Frame rate: 15 fpsBitrate: 500 Kbps1: The meeting scenario.
+     * If set to ApplicationScenarioMeeting (1), the SDK automatically enables the following strategies:
+     *  In meeting scenarios where low-quality video streams are required to have a high bitrate, the SDK automatically enables multiple technologies used to deal with network congestions, to enhance the performance of the low-quality streams and to ensure the smooth reception by subscribers.
+     *  The SDK monitors the number of subscribers to the high-quality video stream in real time and dynamically adjusts its configuration based on the number of subscribers.
+     *  If nobody subscribers to the high-quality stream, the SDK automatically reduces its bitrate and frame rate to save upstream bandwidth.
+     *  If someone subscribes to the high-quality stream, the SDK resets the high-quality stream to the VideoEncoderConfiguration configuration used in the most recent calling of setVideoEncoderConfiguration. If no configuration has been set by the user previously, the following values are used:
+     *  Resolution: 1280 × 720
+     *  Frame rate: 15 fps
+     *  Bitrate: 1600 Kbps
+     *  The SDK monitors the number of subscribers to the low-quality video stream in real time and dynamically enables or disables it based on the number of subscribers. If the user has called setDualStreamMode to set that never send low-quality video stream (DisableSimulcastStream), the dynamic adjustment of the low-quality stream in meeting scenarios will not take effect.
+     *  If nobody subscribes to the low-quality stream, the SDK automatically disables it to save upstream bandwidth.
+     *  If someone subscribes to the low-quality stream, the SDK enables the low-quality stream and resets it to the SimulcastStreamConfig configuration used in the most recent calling of setDualStreamMode. If no configuration has been set by the user previously, the following values are used:
+     *  Resolution: 480 × 272
+     *  Frame rate: 15 fps
+     *  Bitrate: 500 Kbps 1: The meeting scenario.
      */
     VideoApplicationScenarioType[VideoApplicationScenarioType["ApplicationScenarioMeeting"] = 1] = "ApplicationScenarioMeeting";
 })(VideoApplicationScenarioType = exports.VideoApplicationScenarioType || (exports.VideoApplicationScenarioType = {}));
@@ -1562,7 +1599,7 @@ var LocalAudioStreamError;
      */
     LocalAudioStreamError[LocalAudioStreamError["LocalAudioStreamErrorFailure"] = 1] = "LocalAudioStreamErrorFailure";
     /**
-     * 2: No permission to use the local audio capturing device. Remind your users to grant permission.Deprecated:This enumerator is deprecated. Please use RecordAudio in the onPermissionError callback instead.
+     * 2: No permission to use the local audio capturing device. Remind your users to grant permission. Deprecated: This enumerator is deprecated. Please use RecordAudio in the onPermissionError callback instead.
      */
     LocalAudioStreamError[LocalAudioStreamError["LocalAudioStreamErrorDeviceNoPermission"] = 2] = "LocalAudioStreamErrorDeviceNoPermission";
     /**
@@ -1634,7 +1671,7 @@ var LocalVideoStreamError;
      */
     LocalVideoStreamError[LocalVideoStreamError["LocalVideoStreamErrorFailure"] = 1] = "LocalVideoStreamErrorFailure";
     /**
-     * 2: No permission to use the local video capturing device. Remind the user to grant permissions and rejoin the channel.Deprecated:This enumerator is deprecated. Please use CAMERA in the onPermissionError callback instead.
+     * 2: No permission to use the local video capturing device. Remind the user to grant permissions and rejoin the channel. Deprecated: This enumerator is deprecated. Please use CAMERA in the onPermissionError callback instead.
      */
     LocalVideoStreamError[LocalVideoStreamError["LocalVideoStreamErrorDeviceNoPermission"] = 2] = "LocalVideoStreamErrorDeviceNoPermission";
     /**
@@ -1662,7 +1699,7 @@ var LocalVideoStreamError;
      */
     LocalVideoStreamError[LocalVideoStreamError["LocalVideoStreamErrorDeviceNotFound"] = 8] = "LocalVideoStreamErrorDeviceNotFound";
     /**
-     * 9:(For macOS only) The video capture device currently in use is disconnected (such as being unplugged).
+     * 9: (For macOS only) The video capture device currently in use is disconnected (such as being unplugged).
      */
     LocalVideoStreamError[LocalVideoStreamError["LocalVideoStreamErrorDeviceDisconnected"] = 9] = "LocalVideoStreamErrorDeviceDisconnected";
     /**
@@ -1678,7 +1715,10 @@ var LocalVideoStreamError;
      */
     LocalVideoStreamError[LocalVideoStreamError["LocalVideoStreamErrorScreenCaptureWindowMinimized"] = 11] = "LocalVideoStreamErrorScreenCaptureWindowMinimized";
     /**
-     * 12: (For macOS and Windows only) The error code indicates that a window shared by the window ID has been closed or a full-screen window shared by the window ID has exited full-screen mode. After exiting full-screen mode, remote users cannot see the shared window. To prevent remote users from seeing a black screen, Agora recommends that you immediately stop screen sharing.Common scenarios for reporting this error code:When the local user closes the shared window, the SDK reports this error code.The local user shows some slides in full-screen mode first, and then shares the windows of the slides. After the user exits full-screen mode, the SDK reports this error code.The local user watches a web video or reads a web document in full-screen mode first, and then shares the window of the web video or document. After the user exits full-screen mode, the SDK reports this error code.
+     * 12: (For macOS and Windows only) The error code indicates that a window shared by the window ID has been closed or a full-screen window shared by the window ID has exited full-screen mode. After exiting full-screen mode, remote users cannot see the shared window. To prevent remote users from seeing a black screen, Agora recommends that you immediately stop screen sharing. Common scenarios for reporting this error code:
+     *  When the local user closes the shared window, the SDK reports this error code.
+     *  The local user shows some slides in full-screen mode first, and then shares the windows of the slides. After the user exits full-screen mode, the SDK reports this error code.
+     *  The local user watches a web video or reads a web document in full-screen mode first, and then shares the window of the web video or document. After the user exits full-screen mode, the SDK reports this error code.
      */
     LocalVideoStreamError[LocalVideoStreamError["LocalVideoStreamErrorScreenCaptureWindowClosed"] = 12] = "LocalVideoStreamErrorScreenCaptureWindowClosed";
     /**
@@ -1846,7 +1886,7 @@ var RemoteVideoStateReason;
      */
     RemoteVideoStateReason[RemoteVideoStateReason["RemoteVideoStateReasonSdkInBackground"] = 12] = "RemoteVideoStateReasonSdkInBackground";
     /**
-     * @ignore
+     * 13: The local video decoder does not support decoding the remote video stream.
      */
     RemoteVideoStateReason[RemoteVideoStateReason["RemoteVideoStateReasonCodecNotSupport"] = 13] = "RemoteVideoStateReasonCodecNotSupport";
 })(RemoteVideoStateReason = exports.RemoteVideoStateReason || (exports.RemoteVideoStateReason = {}));
@@ -2029,7 +2069,9 @@ var RtmpStreamPublishState;
      */
     RtmpStreamPublishState[RtmpStreamPublishState["RtmpStreamPublishStateRunning"] = 2] = "RtmpStreamPublishStateRunning";
     /**
-     * 3: The RTMP or RTMPS streaming is recovering. When exceptions occur to the CDN, or the streaming is interrupted, the SDK tries to resume RTMP or RTMPS streaming and returns this state.If the SDK successfully resumes the streaming, RtmpStreamPublishStateRunning(2) returns.If the streaming does not resume within 60 seconds or server errors occur, RtmpStreamPublishStateFailure(4) returns. If you feel that 60 seconds is too long, you can also actively try to reconnect.
+     * 3: The RTMP or RTMPS streaming is recovering. When exceptions occur to the CDN, or the streaming is interrupted, the SDK tries to resume RTMP or RTMPS streaming and returns this state.
+     *  If the SDK successfully resumes the streaming, RtmpStreamPublishStateRunning (2) returns.
+     *  If the streaming does not resume within 60 seconds or server errors occur, RtmpStreamPublishStateFailure (4) returns. If you feel that 60 seconds is too long, you can also actively try to reconnect.
      */
     RtmpStreamPublishState[RtmpStreamPublishState["RtmpStreamPublishStateRecovering"] = 3] = "RtmpStreamPublishStateRecovering";
     /**
@@ -2151,7 +2193,7 @@ exports.RtcImage = RtcImage;
 /**
  * The configuration for advanced features of the RTMP or RTMPS streaming with transcoding.
  *
- * If you want to enable the advanced features of streaming with transcoding, contact .
+ * If you want to enable the advanced features of streaming with transcoding, contact.
  */
 var LiveStreamAdvancedFeature = /** @class */ (function () {
     function LiveStreamAdvancedFeature() {
@@ -2165,11 +2207,15 @@ exports.LiveStreamAdvancedFeature = LiveStreamAdvancedFeature;
 var ConnectionStateType;
 (function (ConnectionStateType) {
     /**
-     * 1: The SDK is disconnected from the Agora edge server. The state indicates the SDK is in one of the following phases:Theinitial state before calling the joinChannel method.The app calls the leaveChannel method.
+     * 1: The SDK is disconnected from the Agora edge server. The state indicates the SDK is in one of the following phases:
+     *  Theinitial state before calling the joinChannel method.
+     *  The app calls the leaveChannel method.
      */
     ConnectionStateType[ConnectionStateType["ConnectionStateDisconnected"] = 1] = "ConnectionStateDisconnected";
     /**
-     * 2: The SDK is connecting to the Agora edge server. This state indicates that the SDK is establishing a connection with the specified channel after the app calls joinChannel.If the SDK successfully joins the channel, it triggers the onConnectionStateChanged callback and the connection state switches to ConnectionStateConnected.After the connection is established, the SDK also initializes the media and triggers onJoinChannelSuccess when everything is ready.
+     * 2: The SDK is connecting to the Agora edge server. This state indicates that the SDK is establishing a connection with the specified channel after the app calls joinChannel.
+     *  If the SDK successfully joins the channel, it triggers the onConnectionStateChanged callback and the connection state switches to ConnectionStateConnected.
+     *  After the connection is established, the SDK also initializes the media and triggers onJoinChannelSuccess when everything is ready.
      */
     ConnectionStateType[ConnectionStateType["ConnectionStateConnecting"] = 2] = "ConnectionStateConnecting";
     /**
@@ -2177,11 +2223,15 @@ var ConnectionStateType;
      */
     ConnectionStateType[ConnectionStateType["ConnectionStateConnected"] = 3] = "ConnectionStateConnected";
     /**
-     * 4: The SDK keeps reconnecting to the Agora edge server. The SDK keeps rejoining the channel after being disconnected from a joined channel because of network issues.If the SDK cannot rejoin the channel within 10 seconds, it triggers onConnectionLost, stays in the ConnectionStateReconnecting state, and keeps rejoining the channel.If the SDK fails to rejoin the channel 20 minutes after being disconnected from the Agora edge server, the SDK triggers the onConnectionStateChanged callback, switches to the ConnectionStateFailed state, and stops rejoining the channel.
+     * 4: The SDK keeps reconnecting to the Agora edge server. The SDK keeps rejoining the channel after being disconnected from a joined channel because of network issues.
+     *  If the SDK cannot rejoin the channel within 10 seconds, it triggers onConnectionLost, stays in the ConnectionStateReconnecting state, and keeps rejoining the channel.
+     *  If the SDK fails to rejoin the channel 20 minutes after being disconnected from the Agora edge server, the SDK triggers the onConnectionStateChanged callback, switches to the ConnectionStateFailed state, and stops rejoining the channel.
      */
     ConnectionStateType[ConnectionStateType["ConnectionStateReconnecting"] = 4] = "ConnectionStateReconnecting";
     /**
-     * 5: The SDK fails to connect to the Agora edge server or join the channel. This state indicates that the SDK stops trying to rejoin the channel. You must call leaveChannel to leave the channel.You can call joinChannel to rejoin the channel.If the SDK is banned from joining the channel by the Agora edge server through the RESTful API, the SDK triggers the onConnectionStateChanged callback.
+     * 5: The SDK fails to connect to the Agora edge server or join the channel. This state indicates that the SDK stops trying to rejoin the channel. You must call leaveChannel to leave the channel.
+     *  You can call joinChannel to rejoin the channel.
+     *  If the SDK is banned from joining the channel by the Agora edge server through the RESTful API, the SDK triggers the onConnectionStateChanged callback.
      */
     ConnectionStateType[ConnectionStateType["ConnectionStateFailed"] = 5] = "ConnectionStateFailed";
 })(ConnectionStateType = exports.ConnectionStateType || (exports.ConnectionStateType = {}));
@@ -2338,7 +2388,9 @@ var ConnectionChangedReasonType;
      */
     ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedInvalidChannelName"] = 7] = "ConnectionChangedInvalidChannelName";
     /**
-     * 8: The connection failed because the token is not valid. Possible reasons are as follows:The App Certificate for the project is enabled in Agora Console, but you do not use a token when joining the channel. If you enable the App Certificate, you must use a token to join the channel.The uid specified when calling joinChannel to join the channel is inconsistent with the uid passed in when generating the token.
+     * 8: The connection failed because the token is not valid. Possible reasons are as follows:
+     *  The App Certificate for the project is enabled in Agora Console, but you do not use a token when joining the channel. If you enable the App Certificate, you must use a token to join the channel.
+     *  The uid specified when calling joinChannel to join the channel is inconsistent with the uid passed in when generating the token.
      */
     ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedInvalidToken"] = 8] = "ConnectionChangedInvalidToken";
     /**
@@ -2346,7 +2398,9 @@ var ConnectionChangedReasonType;
      */
     ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedTokenExpired"] = 9] = "ConnectionChangedTokenExpired";
     /**
-     * 10: The connection is rejected by server. Possible reasons are as follows:The user is already in the channel and still calls a method, for example, joinChannel, to join the channel. Stop calling this method to clear this error.The user tries to join a channel while a test call is in progress. The user needs to join the channel after the call test ends.
+     * 10: The connection is rejected by server. Possible reasons are as follows:
+     *  The user is already in the channel and still calls a method, for example, joinChannel, to join the channel. Stop calling this method to clear this error.
+     *  The user tries to join a channel while a test call is in progress. The user needs to join the channel after the call test ends.
      */
     ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedRejectedByServer"] = 10] = "ConnectionChangedRejectedByServer";
     /**
@@ -2400,7 +2454,7 @@ var ConnectionChangedReasonType;
 var ClientRoleChangeFailedReason;
 (function (ClientRoleChangeFailedReason) {
     /**
-     * 1: The number of hosts in the channel is already at the upper limit.This enumerator is reported only when the support for 128 users is enabled. The maximum number of hosts is based on the actual number of hosts configured when you enable the 128-user feature.
+     * 1: The number of hosts in the channel is already at the upper limit. This enumerator is reported only when the support for 128 users is enabled. The maximum number of hosts is based on the actual number of hosts configured when you enable the 128-user feature.
      */
     ClientRoleChangeFailedReason[ClientRoleChangeFailedReason["ClientRoleChangeFailedTooManyBroadcasters"] = 1] = "ClientRoleChangeFailedTooManyBroadcasters";
     /**
@@ -2722,11 +2776,11 @@ var AudioTrackType;
      */
     AudioTrackType[AudioTrackType["AudioTrackInvalid"] = -1] = "AudioTrackInvalid";
     /**
-     * 0: Mixable audio tracks. You can publish multiple mixable audio tracks in one channel, and SDK will automatically mix these tracks into one. The latency of mixable audio tracks is higher than that of direct audio tracks.
+     * 0: Mixable audio tracks. This type of audio track supports mixing with other audio streams (such as audio streams captured by microphone) and playing locally or publishing to channels after mixing. The latency of mixable audio tracks is higher than that of direct audio tracks.
      */
     AudioTrackType[AudioTrackType["AudioTrackMixable"] = 0] = "AudioTrackMixable";
     /**
-     * 1: Direct audio tracks. When creating multiple audio tracks of this type, each direct audio track can only be published in one channel and cannot be mixed with others. The latency of direct audio tracks is lower than that of mixable audio tracks.
+     * 1: Direct audio tracks. This type of audio track will replace the audio streams captured by the microphone and does not support mixing with other audio streams. The latency of direct audio tracks is lower than that of mixable audio tracks. If AudioTrackDirect is specified for this parameter, you must set publishMicrophoneTrack to false in ChannelMediaOptions when calling joinChannel to join the channel; otherwise, joining the channel fails and returns the error code -2.
      */
     AudioTrackType[AudioTrackType["AudioTrackDirect"] = 1] = "AudioTrackDirect";
 })(AudioTrackType = exports.AudioTrackType || (exports.AudioTrackType = {}));
@@ -2749,19 +2803,21 @@ var VoiceBeautifierPreset;
      */
     VoiceBeautifierPreset[VoiceBeautifierPreset["VoiceBeautifierOff"] = 0] = "VoiceBeautifierOff";
     /**
-     * A more magnetic voice.Agora recommends using this enumerator to process a male-sounding voice; otherwise, you may experience vocal distortion.
+     * A more magnetic voice. Agora recommends using this enumerator to process a male-sounding voice; otherwise, you may experience vocal distortion.
      */
     VoiceBeautifierPreset[VoiceBeautifierPreset["ChatBeautifierMagnetic"] = 16843008] = "ChatBeautifierMagnetic";
     /**
-     * A fresher voice.Agora recommends using this enumerator to process a female-sounding voice; otherwise, you may experience vocal distortion.
+     * A fresher voice. Agora recommends using this enumerator to process a female-sounding voice; otherwise, you may experience vocal distortion.
      */
     VoiceBeautifierPreset[VoiceBeautifierPreset["ChatBeautifierFresh"] = 16843264] = "ChatBeautifierFresh";
     /**
-     * A more vital voice.Agora recommends using this enumerator to process a female-sounding voice; otherwise, you may experience vocal distortion.
+     * A more vital voice. Agora recommends using this enumerator to process a female-sounding voice; otherwise, you may experience vocal distortion.
      */
     VoiceBeautifierPreset[VoiceBeautifierPreset["ChatBeautifierVitality"] = 16843520] = "ChatBeautifierVitality";
     /**
-     * Singing beautifier effect.If you call setVoiceBeautifierPreset(SingingBeautifier), you can beautify a male-sounding voice and add a reverberation effect that sounds like singing in a small room. Agora recommends using this enumerator to process a male-sounding voice; otherwise, you might experience vocal distortion.If you call setVoiceBeautifierParameters(SingingBeautifier, param1, param2), you can beautify a male or female-sounding voice and add a reverberation effect.
+     * Singing beautifier effect.
+     *  If you call setVoiceBeautifierPreset (SingingBeautifier), you can beautify a male-sounding voice and add a reverberation effect that sounds like singing in a small room. Agora recommends using this enumerator to process a male-sounding voice; otherwise, you might experience vocal distortion.
+     *  If you call setVoiceBeautifierParameters (SingingBeautifier, param1, param2), you can beautify a male or female-sounding voice and add a reverberation effect.
      */
     VoiceBeautifierPreset[VoiceBeautifierPreset["SingingBeautifier"] = 16908544] = "SingingBeautifier";
     /**
@@ -2797,7 +2853,9 @@ var VoiceBeautifierPreset;
      */
     VoiceBeautifierPreset[VoiceBeautifierPreset["TimbreTransformationRinging"] = 16975872] = "TimbreTransformationRinging";
     /**
-     * A ultra-high quality voice, which makes the audio clearer and restores more details.To achieve better audio effect quality, Agora recommends that you set the profile of to AudioProfileMusicHighQuality(4) or AudioProfileMusicHighQualityStereo(5) and scenario to AudioScenarioGameStreaming(3) before calling setVoiceBeautifierPreset.If you have an audio capturing device that can already restore audio details to a high degree, Agora recommends that you do not enable ultra-high quality; otherwise, the SDK may over-restore audio details, and you may not hear the anticipated voice effect.
+     * A ultra-high quality voice, which makes the audio clearer and restores more details.
+     *  To achieve better audio effect quality, Agora recommends that you set the profile of to AudioProfileMusicHighQuality (4) or AudioProfileMusicHighQualityStereo (5) and scenario to AudioScenarioGameStreaming (3) before calling setVoiceBeautifierPreset.
+     *  If you have an audio capturing device that can already restore audio details to a high degree, Agora recommends that you do not enable ultra-high quality; otherwise, the SDK may over-restore audio details, and you may not hear the anticipated voice effect.
      */
     VoiceBeautifierPreset[VoiceBeautifierPreset["UltraHighQualityVoice"] = 17039616] = "UltraHighQualityVoice";
 })(VoiceBeautifierPreset = exports.VoiceBeautifierPreset || (exports.VoiceBeautifierPreset = {}));
@@ -2841,31 +2899,31 @@ var AudioEffectPreset;
      */
     AudioEffectPreset[AudioEffectPreset["RoomAcousticsEthereal"] = 33621760] = "RoomAcousticsEthereal";
     /**
-     * A 3D voice effect that makes the voice appear to be moving around the user. The default cycle period is 10 seconds. After setting this effect, you can call setAudioEffectParameters to modify the movement period.If the 3D voice effect is enabled, users need to use stereo audio playback devices to hear the anticipated voice effect.
+     * A 3D voice effect that makes the voice appear to be moving around the user. The default cycle period is 10 seconds. After setting this effect, you can call setAudioEffectParameters to modify the movement period. If the 3D voice effect is enabled, users need to use stereo audio playback devices to hear the anticipated voice effect.
      */
     AudioEffectPreset[AudioEffectPreset["RoomAcoustics3dVoice"] = 33622016] = "RoomAcoustics3dVoice";
     /**
-     * Virtual surround sound, that is, the SDK generates a simulated surround sound field on the basis of stereo channels, thereby creating a surround sound effect.If the virtual surround sound is enabled, users need to use stereo audio playback devices to hear the anticipated audio effect.
+     * Virtual surround sound, that is, the SDK generates a simulated surround sound field on the basis of stereo channels, thereby creating a surround sound effect. If the virtual surround sound is enabled, users need to use stereo audio playback devices to hear the anticipated audio effect.
      */
     AudioEffectPreset[AudioEffectPreset["RoomAcousticsVirtualSurroundSound"] = 33622272] = "RoomAcousticsVirtualSurroundSound";
     /**
-     * A middle-aged man's voice.Agora recommends using this preset to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.
+     * A middle-aged man's voice. Agora recommends using this preset to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.
      */
     AudioEffectPreset[AudioEffectPreset["VoiceChangerEffectUncle"] = 33685760] = "VoiceChangerEffectUncle";
     /**
-     * An older man's voice.Agora recommends using this preset to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.
+     * An older man's voice. Agora recommends using this preset to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.
      */
     AudioEffectPreset[AudioEffectPreset["VoiceChangerEffectOldman"] = 33686016] = "VoiceChangerEffectOldman";
     /**
-     * A boy's voice.Agora recommends using this preset to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.
+     * A boy's voice. Agora recommends using this preset to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.
      */
     AudioEffectPreset[AudioEffectPreset["VoiceChangerEffectBoy"] = 33686272] = "VoiceChangerEffectBoy";
     /**
-     * A young woman's voice.Agora recommends using this preset to process a female-sounding voice; otherwise, you may not hear the anticipated voice effect.
+     * A young woman's voice. Agora recommends using this preset to process a female-sounding voice; otherwise, you may not hear the anticipated voice effect.
      */
     AudioEffectPreset[AudioEffectPreset["VoiceChangerEffectSister"] = 33686528] = "VoiceChangerEffectSister";
     /**
-     * A girl's voice.Agora recommends using this preset to process a female-sounding voice; otherwise, you may not hear the anticipated voice effect.
+     * A girl's voice. Agora recommends using this preset to process a female-sounding voice; otherwise, you may not hear the anticipated voice effect.
      */
     AudioEffectPreset[AudioEffectPreset["VoiceChangerEffectGirl"] = 33686784] = "VoiceChangerEffectGirl";
     /**
@@ -3144,7 +3202,7 @@ var ChannelMediaRelayError;
      */
     ChannelMediaRelayError[ChannelMediaRelayError["RelayErrorServerErrorResponse"] = 1] = "RelayErrorServerErrorResponse";
     /**
-     * 2: No server response.You can call leaveChannel to leave the channel.This error can also occur if your project has not enabled co-host token authentication. You can to enable the service for cohosting across channels before starting a channel media relay.
+     * 2: No server response. You can call leaveChannel to leave the channel. This error can also occur if your project has not enabled co-host token authentication. You can to enable the service for cohosting across channels before starting a channel media relay.
      */
     ChannelMediaRelayError[ChannelMediaRelayError["RelayErrorServerNoResponse"] = 2] = "RelayErrorServerNoResponse";
     /**
@@ -3448,7 +3506,15 @@ var StreamSubscribeState;
      */
     StreamSubscribeState[StreamSubscribeState["SubStateIdle"] = 0] = "SubStateIdle";
     /**
-     * 1: Fails to subscribe to the remote stream. Possible reasons:The remote user:Calls muteLocalAudioStream(true) or muteLocalVideoStream(true) to stop sending local media stream.Calls disableAudio or disableVideo to disable the local audio or video module.Calls enableLocalAudio(false) or enableLocalVideo(false) to disable local audio or video capture.The role of the remote user is audience.The local user calls the following methods to stop receiving remote streams:Call muteRemoteAudioStream(true) or muteAllRemoteAudioStreams(true) to stop receiving the remote audio stream.Call muteRemoteVideoStream(true) or muteAllRemoteVideoStreams(true) to stop receiving the remote video stream.
+     * 1: Fails to subscribe to the remote stream. Possible reasons:
+     *  The remote user:
+     *  Calls muteLocalAudioStream (true) or muteLocalVideoStream (true) to stop sending local media stream.
+     *  Calls disableAudio or disableVideo to disable the local audio or video module.
+     *  Calls enableLocalAudio (false) or enableLocalVideo (false) to disable local audio or video capture.
+     *  The role of the remote user is audience.
+     *  The local user calls the following methods to stop receiving remote streams:
+     *  Call muteRemoteAudioStream (true) or muteAllRemoteAudioStreams (true) to stop receiving the remote audio stream.
+     *  Call muteRemoteVideoStream (true) or muteAllRemoteVideoStreams (true) to stop receiving the remote video stream.
      */
     StreamSubscribeState[StreamSubscribeState["SubStateNoSubscribed"] = 1] = "SubStateNoSubscribed";
     /**
@@ -3470,7 +3536,11 @@ var StreamPublishState;
      */
     StreamPublishState[StreamPublishState["PubStateIdle"] = 0] = "PubStateIdle";
     /**
-     * 1: Fails to publish the local stream. Possible reasons:The local user calls muteLocalAudioStream(true) or muteLocalVideoStream(true) to stop sending local media streams.The local user calls disableAudio or disableVideo to disable the local audio or video module.The local user calls enableLocalAudio(false) or enableLocalVideo(false) to disable the local audio or video capture.The role of the local user is audience.
+     * 1: Fails to publish the local stream. Possible reasons:
+     *  The local user calls muteLocalAudioStream (true) or muteLocalVideoStream (true) to stop sending local media streams.
+     *  The local user calls disableAudio or disableVideo to disable the local audio or video module.
+     *  The local user calls enableLocalAudio (false) or enableLocalVideo (false) to disable the local audio or video capture.
+     *  The role of the local user is audience.
      */
     StreamPublishState[StreamPublishState["PubStateNoPublished"] = 1] = "PubStateNoPublished";
     /**
@@ -3560,7 +3630,7 @@ exports.ScreenVideoParameters = ScreenVideoParameters;
 /**
  * The audio configuration for the shared screen stream.
  *
- * Only available where captureAudio is true .
+ * Only available where captureAudio is true.
  */
 var ScreenAudioParameters = /** @class */ (function () {
     function ScreenAudioParameters() {
@@ -3578,7 +3648,7 @@ var ScreenCaptureParameters2 = /** @class */ (function () {
 }());
 exports.ScreenCaptureParameters2 = ScreenCaptureParameters2;
 /**
- * The rendering state of the media frame.`
+ * The rendering state of the media frame.
  */
 var MediaTraceEvent;
 (function (MediaTraceEvent) {

package/js/Private/AgoraMediaBase.js

@@ -64,15 +64,15 @@ var VideoSourceType;
      */
     VideoSourceType[VideoSourceType["VideoSourceCameraThird"] = 11] = "VideoSourceCameraThird";
     /**
-     * 12:The fourth camera.
+     * 12: The fourth camera.
      */
     VideoSourceType[VideoSourceType["VideoSourceCameraFourth"] = 12] = "VideoSourceCameraFourth";
     /**
-     * 13:The third screen.
+     * 13: The third screen.
      */
     VideoSourceType[VideoSourceType["VideoSourceScreenThird"] = 13] = "VideoSourceScreenThird";
     /**
-     * 14:The fourth screen.
+     * 14: The fourth screen.
      */
     VideoSourceType[VideoSourceType["VideoSourceScreenFourth"] = 14] = "VideoSourceScreenFourth";
     /**
@@ -262,7 +262,7 @@ var ContentInspectType;
     ContentInspectType[ContentInspectType["ContentInspectSupervision"] = 2] = "ContentInspectSupervision";
 })(ContentInspectType = exports.ContentInspectType || (exports.ContentInspectType = {}));
 /**
- * A structure used to configure the frequency of video screenshot and upload.ContentInspectModule
+ * A ContentInspectModule structure used to configure the frequency of video screenshot and upload.
  */
 var ContentInspectModule = /** @class */ (function () {
     function ContentInspectModule() {
@@ -558,7 +558,9 @@ var AudioFramePosition;
 /**
  * Audio data format.
  *
- * The SDK sets the audio data format in the following callbacks according to AudioParams . onRecordAudioFrame onPlaybackAudioFrame onMixedAudioFrame The SDK calculates the sampling interval through the samplesPerCall , sampleRate , and channel parameters in AudioParams , and triggers the onRecordAudioFrame , onPlaybackAudioFrame , onMixedAudioFrame , and onEarMonitoringAudioFrame callbacks according to the sampling interval. Sample interval (sec) = samplePerCall /( sampleRate × channel ) . Ensure that the sample interval ≥ 0.01 (s).
+ * The SDK sets the audio data format in the following callbacks according to AudioParams. onRecordAudioFrame onPlaybackAudioFrame onMixedAudioFrame
+ *  The SDK calculates the sampling interval through the samplesPerCall, sampleRate, and channel parameters in AudioParams, and triggers the onRecordAudioFrame, onPlaybackAudioFrame, onMixedAudioFrame, and onEarMonitoringAudioFrame callbacks according to the sampling interval. Sample interval (sec) = samplePerCall /(sampleRate × channel).
+ *  Ensure that the sample interval ≥ 0.01 (s).
  */
 var AudioParams = /** @class */ (function () {
     function AudioParams() {
@@ -590,11 +592,11 @@ exports.UserAudioSpectrumInfo = UserAudioSpectrumInfo;
 var VideoFrameProcessMode;
 (function (VideoFrameProcessMode) {
     /**
-     * Read-only mode.In this mode, you do not modify the video frame. The video frame observer is a renderer.
+     * Read-only mode. In this mode, you do not modify the video frame. The video frame observer is a renderer.
      */
     VideoFrameProcessMode[VideoFrameProcessMode["ProcessModeReadOnly"] = 0] = "ProcessModeReadOnly";
     /**
-     * Read and write mode.In this mode, you modify the video frame. The video frame observer is a video filter.
+     * Read and write mode. In this mode, you modify the video frame. The video frame observer is a video filter.
      */
     VideoFrameProcessMode[VideoFrameProcessMode["ProcessModeReadWrite"] = 1] = "ProcessModeReadWrite";
 })(VideoFrameProcessMode = exports.VideoFrameProcessMode || (exports.VideoFrameProcessMode = {}));