agora-electron-sdk 4.5.2 → 4.5.3-dev.1

package/js/{Private → ts/Private}/IAgoraRtcEngine.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AudioDeviceInfo = exports.VideoDeviceInfo = exports.SDKBuildInfo = exports.VideoProfileType = exports.MediaDeviceStateType = exports.QualityReportFormatType = exports.IRtcEngine = exports.ExtensionInfo = exports.DirectCdnStreamingMediaOptions = exports.DirectCdnStreamingStats = exports.DirectCdnStreamingState = exports.DirectCdnStreamingReason = exports.Metadata = exports.MaxMetadataSizeType = exports.MetadataType = exports.RtcEngineContext = exports.IVideoDeviceManager = exports.LeaveChannelOptions = exports.FeatureType = exports.ProxyType = exports.ChannelMediaOptions = exports.ImageTrackOptions = exports.AdvancedAudioOptions = exports.ScreenCaptureSourceInfo = exports.ScreenCaptureSourceType = exports.ThumbImageBuffer = exports.Size = exports.ScreenCaptureConfiguration = exports.CameraCapturerConfiguration = exports.CloudProxyType = exports.CameraDirection = exports.PublisherConfiguration = exports.RtmpStreamLifeCycleType = exports.InjectStreamConfig = exports.VideoCompositingLayout = exports.Region = exports.RemoteVideoStats = exports.RemoteAudioStats = exports.LocalVideoStats = exports.PriorityType = exports.StreamFallbackOptions = exports.AudioReverbType = exports.AudioEqualizationBandFrequency = exports.InjectStreamStatus = exports.AudioMixingReasonType = exports.AudioMixingStateType = exports.MediaDeviceType = void 0;
+exports.AudioDeviceInfo = exports.VideoDeviceInfo = exports.SDKBuildInfo = exports.VideoProfileType = exports.MediaDeviceStateType = exports.QualityReportFormatType = exports.IRtcEngine = exports.ExtensionInfo = exports.DirectCdnStreamingMediaOptions = exports.DirectCdnStreamingStats = exports.DirectCdnStreamingState = exports.DirectCdnStreamingReason = exports.Metadata = exports.MaxMetadataSizeType = exports.MetadataType = exports.RtcEngineContext = exports.IVideoEffectObject = exports.VideoEffectAction = exports.VideoEffectNodeId = exports.IVideoDeviceManager = exports.LeaveChannelOptions = exports.FeatureType = exports.ProxyType = exports.ChannelMediaOptions = exports.ImageTrackOptions = exports.AdvancedAudioOptions = exports.ScreenCaptureSourceInfo = exports.ScreenCaptureSourceType = exports.ThumbImageBuffer = exports.Size = exports.ScreenCaptureConfiguration = exports.CameraCapturerConfiguration = exports.CloudProxyType = exports.CameraDirection = exports.PublisherConfiguration = exports.RtmpStreamLifeCycleType = exports.InjectStreamConfig = exports.VideoCompositingLayout = exports.Region = exports.RemoteVideoStats = exports.RemoteAudioStats = exports.LocalVideoStats = exports.PriorityType = exports.StreamFallbackOptions = exports.AudioReverbType = exports.AudioEqualizationBandFrequency = exports.InjectStreamStatus = exports.AudioMixingReasonType = exports.AudioMixingStateType = exports.MediaDeviceType = void 0;
 require("./extension/IAgoraRtcEngineExtension");
 /**
- * Media device types.
+ * Device type.
  */
 var MediaDeviceType;
 (function (MediaDeviceType) {
@@ -16,79 +16,86 @@ var MediaDeviceType;
      */
     MediaDeviceType[MediaDeviceType["AudioPlayoutDevice"] = 0] = "AudioPlayoutDevice";
     /**
-     * 1: Audio capturing device.
+     * 1: Audio recording device.
      */
     MediaDeviceType[MediaDeviceType["AudioRecordingDevice"] = 1] = "AudioRecordingDevice";
     /**
-     * 2: Video rendering device (graphics card).
+     * 2: Video rendering device (GPU).
      */
     MediaDeviceType[MediaDeviceType["VideoRenderDevice"] = 2] = "VideoRenderDevice";
     /**
-     * 3: Video capturing device.
+     * 3: Video capture device.
      */
     MediaDeviceType[MediaDeviceType["VideoCaptureDevice"] = 3] = "VideoCaptureDevice";
     /**
-     * 4: Audio playback device for an app.
+     * 4: Audio application playback device.
      */
     MediaDeviceType[MediaDeviceType["AudioApplicationPlayoutDevice"] = 4] = "AudioApplicationPlayoutDevice";
     /**
-     * (For macOS only) 5: Virtual audio playback device (virtual sound card).
+     * (macOS only) 5: Virtual audio playback device (virtual sound card).
      */
     MediaDeviceType[MediaDeviceType["AudioVirtualPlayoutDevice"] = 5] = "AudioVirtualPlayoutDevice";
     /**
-     * (For macOS only) 6: Virtual audio capturing device (virtual sound card).
+     * (macOS only) 6: Virtual audio recording device (virtual sound card).
      */
     MediaDeviceType[MediaDeviceType["AudioVirtualRecordingDevice"] = 6] = "AudioVirtualRecordingDevice";
 })(MediaDeviceType = exports.MediaDeviceType || (exports.MediaDeviceType = {}));
 /**
- * The playback state of the music file.
+ * Music file playback state.
  */
 var AudioMixingStateType;
 (function (AudioMixingStateType) {
     /**
-     * 710: The music file is playing.
+     * 710: Music file is playing normally.
      */
     AudioMixingStateType[AudioMixingStateType["AudioMixingStatePlaying"] = 710] = "AudioMixingStatePlaying";
     /**
-     * 711: The music file pauses playing.
+     * 711: Music file playback is paused.
      */
     AudioMixingStateType[AudioMixingStateType["AudioMixingStatePaused"] = 711] = "AudioMixingStatePaused";
     /**
-     * 713: The music file stops playing. The possible reasons include: AudioMixingReasonAllLoopsCompleted (723) AudioMixingReasonStoppedByUser (724)
+     * 713: Music file playback is stopped.
+     * This state may be caused by the following reasons:
+     *  AudioMixingReasonAllLoopsCompleted(723)
+     *  AudioMixingReasonStoppedByUser(724)
      */
     AudioMixingStateType[AudioMixingStateType["AudioMixingStateStopped"] = 713] = "AudioMixingStateStopped";
     /**
-     * 714: An error occurs during the playback of the audio mixing file. The possible reasons include: AudioMixingReasonCanNotOpen (701) AudioMixingReasonTooFrequentCall (702) AudioMixingReasonInterruptedEof (703)
+     * 714: Error occurred during music file playback.
+     * This state may be caused by the following reasons:
+     *  AudioMixingReasonCanNotOpen(701)
+     *  AudioMixingReasonTooFrequentCall(702)
+     *  AudioMixingReasonInterruptedEof(703)
      */
     AudioMixingStateType[AudioMixingStateType["AudioMixingStateFailed"] = 714] = "AudioMixingStateFailed";
 })(AudioMixingStateType = exports.AudioMixingStateType || (exports.AudioMixingStateType = {}));
 /**
- * The reason why the playback state of the music file changes. Reported in the onAudioMixingStateChanged callback.
+ * Reason for music file playback state change. Reported in the onAudioMixingStateChanged callback.
  */
 var AudioMixingReasonType;
 (function (AudioMixingReasonType) {
     /**
-     * 701: The SDK cannot open the music file. For example, the local music file does not exist, the SDK does not support the file format, or the the SDK cannot access the music file URL.
+     * 701: Failed to open the music file. For example, the local music file does not exist, the file format is not supported, or the online music file URL is not accessible.
      */
     AudioMixingReasonType[AudioMixingReasonType["AudioMixingReasonCanNotOpen"] = 701] = "AudioMixingReasonCanNotOpen";
     /**
-     * 702: The SDK opens the music file too frequently. If you need to call startAudioMixing multiple times, ensure that the call interval is more than 500 ms.
+     * 702: Music file opened too frequently. If you need to call startAudioMixing multiple times, make sure the interval between calls is greater than 500 ms.
      */
     AudioMixingReasonType[AudioMixingReasonType["AudioMixingReasonTooFrequentCall"] = 702] = "AudioMixingReasonTooFrequentCall";
     /**
-     * 703: The music file playback is interrupted.
+     * 703: Music file playback was interrupted.
      */
     AudioMixingReasonType[AudioMixingReasonType["AudioMixingReasonInterruptedEof"] = 703] = "AudioMixingReasonInterruptedEof";
     /**
-     * 721: The music file completes a loop playback.
+     * 721: One loop of the music file playback completed.
      */
     AudioMixingReasonType[AudioMixingReasonType["AudioMixingReasonOneLoopCompleted"] = 721] = "AudioMixingReasonOneLoopCompleted";
     /**
-     * 723: The music file completes all loop playback.
+     * 723: All loops of the music file playback completed.
      */
     AudioMixingReasonType[AudioMixingReasonType["AudioMixingReasonAllLoopsCompleted"] = 723] = "AudioMixingReasonAllLoopsCompleted";
     /**
-     * 724: Successfully call stopAudioMixing to stop playing the music file.
+     * 724: Successfully called stopAudioMixing to stop music file playback.
      */
     AudioMixingReasonType[AudioMixingReasonType["AudioMixingReasonStoppedByUser"] = 724] = "AudioMixingReasonStoppedByUser";
     /**
@@ -96,7 +103,7 @@ var AudioMixingReasonType;
      */
     AudioMixingReasonType[AudioMixingReasonType["AudioMixingReasonResumedByUser"] = 726] = "AudioMixingReasonResumedByUser";
     /**
-     * 0: The SDK opens music file successfully.
+     * 0: Successfully opened the music file.
      */
     AudioMixingReasonType[AudioMixingReasonType["AudioMixingReasonOk"] = 0] = "AudioMixingReasonOk";
 })(AudioMixingReasonType = exports.AudioMixingReasonType || (exports.AudioMixingReasonType = {}));
@@ -151,7 +158,7 @@ var InjectStreamStatus;
     InjectStreamStatus[InjectStreamStatus["InjectStreamStatusBroken"] = 10] = "InjectStreamStatusBroken";
 })(InjectStreamStatus = exports.InjectStreamStatus || (exports.InjectStreamStatus = {}));
 /**
- * The midrange frequency for audio equalization.
+ * Center frequency of voice effect equalization bands.
  */
 var AudioEqualizationBandFrequency;
 (function (AudioEqualizationBandFrequency) {
@@ -197,28 +204,28 @@ var AudioEqualizationBandFrequency;
     AudioEqualizationBandFrequency[AudioEqualizationBandFrequency["AudioEqualizationBand16k"] = 9] = "AudioEqualizationBand16k";
 })(AudioEqualizationBandFrequency = exports.AudioEqualizationBandFrequency || (exports.AudioEqualizationBandFrequency = {}));
 /**
- * Audio reverberation types.
+ * Audio reverb types.
  */
 var AudioReverbType;
 (function (AudioReverbType) {
     /**
-     * 0: The level of the dry signal (dB). The value is between -20 and 10.
+     * 0: Original sound intensity, also known as dry signal, range [-20,10], unit: dB.
      */
     AudioReverbType[AudioReverbType["AudioReverbDryLevel"] = 0] = "AudioReverbDryLevel";
     /**
-     * 1: The level of the early reflection signal (wet signal) (dB). The value is between -20 and 10.
+     * 1: Early reflection signal intensity, also known as wet signal, range [-20,10], unit: dB.
      */
     AudioReverbType[AudioReverbType["AudioReverbWetLevel"] = 1] = "AudioReverbWetLevel";
     /**
-     * 2: The room size of the reflection. The value is between 0 and 100.
+     * 2: Room size for desired reverb effect. Generally, the larger the room, the stronger the reverb. Range [0,100], unit: dB.
      */
     AudioReverbType[AudioReverbType["AudioReverbRoomSize"] = 2] = "AudioReverbRoomSize";
     /**
-     * 3: The length of the initial delay of the wet signal (ms). The value is between 0 and 200.
+     * 3: Initial delay length of the wet signal, range [0,200], unit: milliseconds.
      */
     AudioReverbType[AudioReverbType["AudioReverbWetDelay"] = 3] = "AudioReverbWetDelay";
     /**
-     * 4: The reverberation strength. The value is between 0 and 100.
+     * 4: Intensity of reverb persistence, range [0,100].
      */
     AudioReverbType[AudioReverbType["AudioReverbStrength"] = 4] = "AudioReverbStrength";
 })(AudioReverbType = exports.AudioReverbType || (exports.AudioReverbType = {}));
@@ -279,7 +286,7 @@ var PriorityType;
     PriorityType[PriorityType["PriorityNormal"] = 100] = "PriorityNormal";
 })(PriorityType = exports.PriorityType || (exports.PriorityType = {}));
 /**
- * The statistics of the local video stream.
+ * Local video stream statistics.
  */
 class LocalVideoStats {
 }
@@ -315,18 +322,18 @@ class InjectStreamConfig {
 }
 exports.InjectStreamConfig = InjectStreamConfig;
 /**
- * Lifecycle of the CDN live video stream.
+ * Lifecycle of server-side transcoding streaming.
  *
- * Deprecated
+ * Deprecated Deprecated
  */
 var RtmpStreamLifeCycleType;
 (function (RtmpStreamLifeCycleType) {
     /**
-     * Bind to the channel lifecycle. If all hosts leave the channel, the CDN live streaming stops after 30 seconds.
+     * Bound to the channel lifecycle. When all hosts leave the channel, server-side transcoding streaming stops after 30 seconds.
      */
     RtmpStreamLifeCycleType[RtmpStreamLifeCycleType["RtmpStreamLifeCycleBind2channel"] = 1] = "RtmpStreamLifeCycleBind2channel";
     /**
-     * Bind to the owner of the RTMP stream. If the owner leaves the channel, the CDN live streaming stops immediately.
+     * Bound to the lifecycle of the host who starts the server-side transcoding streaming. When the host leaves, the streaming stops immediately.
      */
     RtmpStreamLifeCycleType[RtmpStreamLifeCycleType["RtmpStreamLifeCycleBind2owner"] = 2] = "RtmpStreamLifeCycleBind2owner";
 })(RtmpStreamLifeCycleType = exports.RtmpStreamLifeCycleType || (exports.RtmpStreamLifeCycleType = {}));
@@ -337,45 +344,45 @@ class PublisherConfiguration {
 }
 exports.PublisherConfiguration = PublisherConfiguration;
 /**
- * The camera direction.
+ * Camera direction.
  */
 var CameraDirection;
 (function (CameraDirection) {
     /**
-     * 0: The rear camera.
+     * 0: Rear camera.
      */
     CameraDirection[CameraDirection["CameraRear"] = 0] = "CameraRear";
     /**
-     * 1: (Default) The front camera.
+     * 1: (Default) Front camera.
      */
     CameraDirection[CameraDirection["CameraFront"] = 1] = "CameraFront";
 })(CameraDirection = exports.CameraDirection || (exports.CameraDirection = {}));
 /**
- * The cloud proxy type.
+ * Cloud proxy types.
  */
 var CloudProxyType;
 (function (CloudProxyType) {
     /**
-     * 0: The automatic mode. The SDK has this mode enabled by default. In this mode, the SDK attempts a direct connection to SD-RTN™ and automatically switches to TCP/TLS 443 if the attempt fails.
+     * 0: Auto mode. This is the default mode enabled by the SDK. In this mode, the SDK first tries to connect via SD-RTN™. If that fails, it automatically switches to TLS 443.
      */
     CloudProxyType[CloudProxyType["NoneProxy"] = 0] = "NoneProxy";
     /**
-     * 1: The cloud proxy for the UDP protocol, that is, the Force UDP cloud proxy mode. In this mode, the SDK always transmits data over UDP.
+     * 1: UDP protocol cloud proxy, i.e., Force UDP mode. In this mode, the SDK always transmits data using the UDP protocol.
      */
     CloudProxyType[CloudProxyType["UdpProxy"] = 1] = "UdpProxy";
     /**
-     * 2: The cloud proxy for the TCP (encryption) protocol, that is, the Force TCP cloud proxy mode. In this mode, the SDK always transmits data over TCP/TLS 443.
+     * 2: TCP (encrypted) protocol cloud proxy, i.e., Force TCP mode. In this mode, the SDK always transmits data using TLS 443.
      */
     CloudProxyType[CloudProxyType["TcpProxy"] = 2] = "TcpProxy";
 })(CloudProxyType = exports.CloudProxyType || (exports.CloudProxyType = {}));
 /**
- * The camera capturer preference.
+ * Camera capture configuration.
  */
 class CameraCapturerConfiguration {
 }
 exports.CameraCapturerConfiguration = CameraCapturerConfiguration;
 /**
- * The configuration of the captured screen.
+ * Screen capture configuration.
  */
 class ScreenCaptureConfiguration {
 }
@@ -387,84 +394,84 @@ class Size {
 }
 exports.Size = Size;
 /**
- * The image content of the thumbnail or icon. Set in ScreenCaptureSourceInfo.
+ * Image content of a thumbnail or icon. Set in ScreenCaptureSourceInfo.
  *
- * The default image is in the ARGB format. If you need to use another format, you need to convert the image on your own.
+ * The image is in ARGB format by default. If you need another format, please convert it manually.
  */
 class ThumbImageBuffer {
 }
 exports.ThumbImageBuffer = ThumbImageBuffer;
 /**
- * The type of the shared target. Set in ScreenCaptureSourceInfo.
+ * Type of the sharing target. Set in ScreenCaptureSourceInfo.
  */
 var ScreenCaptureSourceType;
 (function (ScreenCaptureSourceType) {
     /**
-     * -1: Unknown type.
+     * -1: Unknown.
      */
     ScreenCaptureSourceType[ScreenCaptureSourceType["ScreencapturesourcetypeUnknown"] = -1] = "ScreencapturesourcetypeUnknown";
     /**
-     * 0: The shared target is a window.
+     * 0: The sharing target is a specific window.
      */
     ScreenCaptureSourceType[ScreenCaptureSourceType["ScreencapturesourcetypeWindow"] = 0] = "ScreencapturesourcetypeWindow";
     /**
-     * 1: The shared target is a screen of a particular monitor.
+     * 1: The sharing target is the screen of a specific monitor.
      */
     ScreenCaptureSourceType[ScreenCaptureSourceType["ScreencapturesourcetypeScreen"] = 1] = "ScreencapturesourcetypeScreen";
     /**
-     * 2: Reserved parameter
+     * 2: Reserved parameter.
      */
     ScreenCaptureSourceType[ScreenCaptureSourceType["ScreencapturesourcetypeCustom"] = 2] = "ScreencapturesourcetypeCustom";
 })(ScreenCaptureSourceType = exports.ScreenCaptureSourceType || (exports.ScreenCaptureSourceType = {}));
 /**
- * The information about the specified shareable window or screen.
+ * Information about shareable windows or screens.
  */
 class ScreenCaptureSourceInfo {
 }
 exports.ScreenCaptureSourceInfo = ScreenCaptureSourceInfo;
 /**
- * The advanced options for audio.
+ * Advanced options for audio.
  */
 class AdvancedAudioOptions {
 }
 exports.AdvancedAudioOptions = AdvancedAudioOptions;
 /**
- * Image configurations.
+ * Settings options for filler image.
  */
 class ImageTrackOptions {
 }
 exports.ImageTrackOptions = ImageTrackOptions;
 /**
- * The channel media options.
+ * Channel media configuration options.
  *
- * Agora supports publishing multiple audio streams and one video stream at the same time and in the same RtcConnection. For example, publishMicrophoneTrack, publishCustomAudioTrack, and publishMediaPlayerAudioTrack can be set as true at the same time, but only one of publishCameraTrack, publishScreenTrack, publishCustomVideoTrack, or publishEncodedVideoTrack can be set as true. Agora recommends that you set member parameter values yourself according to your business scenario, otherwise the SDK will automatically assign values to member parameters.
+ * RtcConnection publishMicrophoneTrack publishCustomAudioTrack publishMediaPlayerAudioTrack true publishCameraTrack publishScreenTrack 、 publishCustomVideoTrack publishEncodedVideoTrack true It is recommended that you configure the member parameters based on your business scenario. Otherwise, the SDK will automatically assign values to the member parameters.
  */
 class ChannelMediaOptions {
 }
 exports.ChannelMediaOptions = ChannelMediaOptions;
 /**
- * The cloud proxy type.
+ * Proxy type.
  */
 var ProxyType;
 (function (ProxyType) {
     /**
-     * 0: Reserved for future use.
+     * 0: Reserved parameter, not supported yet.
      */
     ProxyType[ProxyType["NoneProxyType"] = 0] = "NoneProxyType";
     /**
-     * 1: The cloud proxy for the UDP protocol, that is, the Force UDP cloud proxy mode. In this mode, the SDK always transmits data over UDP.
+     * 1: Cloud proxy using UDP protocol, i.e., Force UDP cloud proxy mode. In this mode, the SDK always transmits data via the UDP protocol.
      */
     ProxyType[ProxyType["UdpProxyType"] = 1] = "UdpProxyType";
     /**
-     * 2: The cloud proxy for the TCP (encryption) protocol, that is, the Force TCP cloud proxy mode. In this mode, the SDK always transmits data over TCP/TLS 443.
+     * 2: Cloud proxy using TCP (encrypted) protocol, i.e., Force TCP cloud proxy mode. In this mode, the SDK always transmits data via TLS 443.
      */
     ProxyType[ProxyType["TcpProxyType"] = 2] = "TcpProxyType";
     /**
-     * 3: Reserved for future use.
+     * 3: Reserved parameter, not supported yet.
      */
     ProxyType[ProxyType["LocalProxyType"] = 3] = "LocalProxyType";
     /**
-     * 4: Automatic mode. In this mode, the SDK attempts a direct connection to SD-RTN™ and automatically switches to TCP/TLS 443 if the attempt fails.
+     * 4: Auto mode. In this mode, the SDK first attempts to connect to SD-RTN™. If the connection fails, it automatically switches to TLS 443.
      */
     ProxyType[ProxyType["TcpProxyAutoFallbackType"] = 4] = "TcpProxyAutoFallbackType";
     /**
@@ -477,21 +484,21 @@ var ProxyType;
     ProxyType[ProxyType["HttpsProxyType"] = 6] = "HttpsProxyType";
 })(ProxyType = exports.ProxyType || (exports.ProxyType = {}));
 /**
- * The type of the advanced feature.
+ * Advanced feature types.
  */
 var FeatureType;
 (function (FeatureType) {
     /**
-     * 1: Virtual background.
+     * 1: Virtual background feature.
      */
     FeatureType[FeatureType["VideoVirtualBackground"] = 1] = "VideoVirtualBackground";
     /**
-     * 2: Image enhancement.
+     * 2: Beauty effect feature.
      */
     FeatureType[FeatureType["VideoBeautyEffect"] = 2] = "VideoBeautyEffect";
 })(FeatureType = exports.FeatureType || (exports.FeatureType = {}));
 /**
- * The options for leaving a channel.
+ * Options for leaving the channel.
  */
 class LeaveChannelOptions {
 }
@@ -503,22 +510,70 @@ class IVideoDeviceManager {
 }
 exports.IVideoDeviceManager = IVideoDeviceManager;
 /**
- * Configurations for the RtcEngineContext instance.
+ * Video effect node types.
+ *
+ * Since Available since v4.6.2.
+ */
+var VideoEffectNodeId;
+(function (VideoEffectNodeId) {
+    /**
+     * (1): Beauty effect node.
+     */
+    VideoEffectNodeId[VideoEffectNodeId["Beauty"] = 1] = "Beauty";
+    /**
+     * (2): Style makeup effect node.
+     */
+    VideoEffectNodeId[VideoEffectNodeId["StyleMakeup"] = 2] = "StyleMakeup";
+    /**
+     * (4): Filter effect node.
+     */
+    VideoEffectNodeId[VideoEffectNodeId["Filter"] = 4] = "Filter";
+    /**
+     * @ignore
+     */
+    VideoEffectNodeId[VideoEffectNodeId["Sticker"] = 8] = "Sticker";
+})(VideoEffectNodeId = exports.VideoEffectNodeId || (exports.VideoEffectNodeId = {}));
+/**
+ * Action types performed on video effect nodes.
+ *
+ * Since Available since v4.6.2.
+ */
+var VideoEffectAction;
+(function (VideoEffectAction) {
+    /**
+     * (1): Save the current parameters of the video effect.
+     */
+    VideoEffectAction[VideoEffectAction["Save"] = 1] = "Save";
+    /**
+     * (2): Reset the video effect to its default parameters.
+     */
+    VideoEffectAction[VideoEffectAction["Reset"] = 2] = "Reset";
+})(VideoEffectAction = exports.VideoEffectAction || (exports.VideoEffectAction = {}));
+/**
+ * Used to manage and configure video effects, such as beauty filters, style makeup, and filters.
+ *
+ * Since Available since v4.6.2.
+ */
+class IVideoEffectObject {
+}
+exports.IVideoEffectObject = IVideoEffectObject;
+/**
+ * Defines RtcEngineContext.
  */
 class RtcEngineContext {
 }
 exports.RtcEngineContext = RtcEngineContext;
 /**
- * Metadata type of the observer. We only support video metadata for now.
+ * The Metadata type of the observer. Currently supports video Metadata only.
  */
 var MetadataType;
 (function (MetadataType) {
     /**
-     * The type of metadata is unknown.
+     * -1: Unknown Metadata type.
      */
     MetadataType[MetadataType["UnknownMetadata"] = -1] = "UnknownMetadata";
     /**
-     * The type of metadata is video.
+     * 0: Metadata type is video.
      */
     MetadataType[MetadataType["VideoMetadata"] = 0] = "VideoMetadata";
 })(MetadataType = exports.MetadataType || (exports.MetadataType = {}));
@@ -547,69 +602,69 @@ class Metadata {
 }
 exports.Metadata = Metadata;
 /**
- * Reasons for the changes in CDN streaming status.
+ * @ignore
  */
 var DirectCdnStreamingReason;
 (function (DirectCdnStreamingReason) {
     /**
-     * 0: No error.
+     * @ignore
      */
     DirectCdnStreamingReason[DirectCdnStreamingReason["DirectCdnStreamingReasonOk"] = 0] = "DirectCdnStreamingReasonOk";
     /**
-     * 1: A general error; no specific reason. You can try to push the media stream again.
+     * @ignore
      */
     DirectCdnStreamingReason[DirectCdnStreamingReason["DirectCdnStreamingReasonFailed"] = 1] = "DirectCdnStreamingReasonFailed";
     /**
-     * 2: An error occurs when pushing audio streams. For example, the local audio capture device is not working properly, is occupied by another process, or does not get the permission required.
+     * @ignore
      */
     DirectCdnStreamingReason[DirectCdnStreamingReason["DirectCdnStreamingReasonAudioPublication"] = 2] = "DirectCdnStreamingReasonAudioPublication";
     /**
-     * 3: An error occurs when pushing video streams. For example, the local video capture device is not working properly, is occupied by another process, or does not get the permission required.
+     * @ignore
      */
     DirectCdnStreamingReason[DirectCdnStreamingReason["DirectCdnStreamingReasonVideoPublication"] = 3] = "DirectCdnStreamingReasonVideoPublication";
     /**
-     * 4: Fails to connect to the CDN.
+     * @ignore
      */
     DirectCdnStreamingReason[DirectCdnStreamingReason["DirectCdnStreamingReasonNetConnect"] = 4] = "DirectCdnStreamingReasonNetConnect";
     /**
-     * 5: The URL is already being used. Use a new URL for streaming.
+     * @ignore
      */
     DirectCdnStreamingReason[DirectCdnStreamingReason["DirectCdnStreamingReasonBadName"] = 5] = "DirectCdnStreamingReasonBadName";
 })(DirectCdnStreamingReason = exports.DirectCdnStreamingReason || (exports.DirectCdnStreamingReason = {}));
 /**
- * The current CDN streaming state.
+ * @ignore
  */
 var DirectCdnStreamingState;
 (function (DirectCdnStreamingState) {
     /**
-     * 0: The initial state before the CDN streaming starts.
+     * @ignore
      */
     DirectCdnStreamingState[DirectCdnStreamingState["DirectCdnStreamingStateIdle"] = 0] = "DirectCdnStreamingStateIdle";
     /**
-     * 1: Streams are being pushed to the CDN. The SDK returns this value when you call the startDirectCdnStreaming method to push streams to the CDN.
+     * @ignore
      */
     DirectCdnStreamingState[DirectCdnStreamingState["DirectCdnStreamingStateRunning"] = 1] = "DirectCdnStreamingStateRunning";
     /**
-     * 2: Stops pushing streams to the CDN. The SDK returns this value when you call the stopDirectCdnStreaming method to stop pushing streams to the CDN.
+     * @ignore
      */
     DirectCdnStreamingState[DirectCdnStreamingState["DirectCdnStreamingStateStopped"] = 2] = "DirectCdnStreamingStateStopped";
     /**
-     * 3: Fails to push streams to the CDN. You can troubleshoot the issue with the information reported by the onDirectCdnStreamingStateChanged callback, and then push streams to the CDN again.
+     * @ignore
      */
     DirectCdnStreamingState[DirectCdnStreamingState["DirectCdnStreamingStateFailed"] = 3] = "DirectCdnStreamingStateFailed";
     /**
-     * 4: Tries to reconnect the Agora server to the CDN. The SDK attempts to reconnect a maximum of 10 times; if the connection is not restored, the streaming state becomes DirectCdnStreamingStateFailed.
+     * @ignore
      */
     DirectCdnStreamingState[DirectCdnStreamingState["DirectCdnStreamingStateRecovering"] = 4] = "DirectCdnStreamingStateRecovering";
 })(DirectCdnStreamingState = exports.DirectCdnStreamingState || (exports.DirectCdnStreamingState = {}));
 /**
- * The statistics of the current CDN streaming.
+ * @ignore
  */
 class DirectCdnStreamingStats {
 }
 exports.DirectCdnStreamingStats = DirectCdnStreamingStats;
 /**
- * The media setting options for the host.
+ * @ignore
  */
 class DirectCdnStreamingMediaOptions {
 }
@@ -621,9 +676,10 @@ class ExtensionInfo {
 }
 exports.ExtensionInfo = ExtensionInfo;
 /**
- * The basic interface of the Agora SDK that implements the core functions of real-time communication.
+ * The base interface class of the RTC SDK that implements the main functions of real-time audio and video.
  *
- * IRtcEngine provides the main methods that your app can call. Before calling other APIs, you must call createAgoraRtcEngine to create an IRtcEngine object.
+ * IRtcEngine provides the main methods for the app to call.
+ * You must call createAgoraRtcEngine to create an IRtcEngine object before calling other APIs.
  */
 class IRtcEngine {
 }
@@ -643,32 +699,32 @@ var QualityReportFormatType;
     QualityReportFormatType[QualityReportFormatType["QualityReportHtml"] = 1] = "QualityReportHtml";
 })(QualityReportFormatType = exports.QualityReportFormatType || (exports.QualityReportFormatType = {}));
 /**
- * Media device states.
+ * Device state.
  */
 var MediaDeviceStateType;
 (function (MediaDeviceStateType) {
     /**
-     * 0: The device is ready for use.
+     * 0: Device is ready.
      */
     MediaDeviceStateType[MediaDeviceStateType["MediaDeviceStateIdle"] = 0] = "MediaDeviceStateIdle";
     /**
-     * 1: The device is in use.
+     * 1: Device is in use.
      */
     MediaDeviceStateType[MediaDeviceStateType["MediaDeviceStateActive"] = 1] = "MediaDeviceStateActive";
     /**
-     * 2: The device is disabled.
+     * 2: Device is disabled.
      */
     MediaDeviceStateType[MediaDeviceStateType["MediaDeviceStateDisabled"] = 2] = "MediaDeviceStateDisabled";
     /**
-     * 3: The device is plugged in.
+     * 3: Device is plugged in.
      */
     MediaDeviceStateType[MediaDeviceStateType["MediaDeviceStatePluggedIn"] = 3] = "MediaDeviceStatePluggedIn";
     /**
-     * 4: The device is not found.
+     * 4: Device not present.
      */
     MediaDeviceStateType[MediaDeviceStateType["MediaDeviceStateNotPresent"] = 4] = "MediaDeviceStateNotPresent";
     /**
-     * 8: The device is unplugged.
+     * 8: Device is unplugged.
      */
     MediaDeviceStateType[MediaDeviceStateType["MediaDeviceStateUnplugged"] = 8] = "MediaDeviceStateUnplugged";
 })(MediaDeviceStateType = exports.MediaDeviceStateType || (exports.MediaDeviceStateType = {}));
@@ -969,13 +1025,13 @@ class SDKBuildInfo {
 }
 exports.SDKBuildInfo = SDKBuildInfo;
 /**
- * The VideoDeviceInfo class that contains the ID and device name of the video devices.
+ * The VideoDeviceInfo class contains the video device ID and device name.
  */
 class VideoDeviceInfo {
 }
 exports.VideoDeviceInfo = VideoDeviceInfo;
 /**
- * The AudioDeviceInfo class that contains the ID, name and type of the audio devices.
+ * The AudioDeviceInfo class contains the audio device ID and device name.
  */
 class AudioDeviceInfo {
 }

package/js/{Private → ts/Private}/IAgoraRtcEngineEx.js

@@ -4,15 +4,15 @@ exports.IRtcEngineEx = exports.RtcConnection = void 0;
 require("./extension/IAgoraRtcEngineExExtension");
 const IAgoraRtcEngine_1 = require("./IAgoraRtcEngine");
 /**
- * Contains connection information.
+ * Class containing connection information.
  */
 class RtcConnection {
 }
 exports.RtcConnection = RtcConnection;
 /**
- * This interface class contains multi-channel methods.
+ * Interface class that provides multi-channel methods.
  *
- * Inherited from IRtcEngine.
+ * Inherits from IRtcEngine.
  */
 class IRtcEngineEx extends IAgoraRtcEngine_1.IRtcEngine {
 }