agora-electron-sdk 4.4.0-dev.1 → 4.4.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 
 
+# [4.4.0](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.3.2...v4.4.0) (2024-08-29)
+
+
+### Features
+
+* support 4.4.0 ([#1197](https://github.com/AgoraIO-Extensions/Electron-SDK/issues/1197)) ([490192f](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/490192ff7c2a6120ff56838191b8788b1a5599f1))
+
 ## [4.3.2](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.3.1...v4.3.2) (2024-06-06)
 
 

package/js/AgoraSdk.js

@@ -51,7 +51,7 @@ exports.createAgoraRtcEngine = createAgoraRtcEngine;
 /**
  * Gets one IMediaPlayerCacheManager instance.
  *
- * When you successfully call this method, the SDK returns a media player cache manager instance. The cache manager is a singleton pattern. Therefore, multiple calls to this method returns the same instance. Make sure the IRtcEngine is initialized before you call this method.
+ * Before calling any APIs in the IMediaPlayerCacheManager class, you need to call this method to get a cache manager instance of a media player.
  *
  * @returns
  * The IMediaPlayerCacheManager instance.

package/js/Private/AgoraBase.js

@@ -239,7 +239,7 @@ 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.
+     *  The user is already in the channel. Agora recommends that you use the onConnectionStateChanged callback to see whether the user is 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";
@@ -1525,7 +1525,7 @@ var AudioScenarioType;
      */
     AudioScenarioType[AudioScenarioType["AudioScenarioGameStreaming"] = 3] = "AudioScenarioGameStreaming";
     /**
-     * 5: Chatroom scenario, where users need to frequently switch the user role or mute and unmute the microphone. For example, education scenarios. In this scenario, audience members receive a pop-up window to request permission of using microphones.
+     * 5: Chatroom scenario, where users need to frequently switch the user role or mute and unmute the microphone. For example, education scenarios.
      */
     AudioScenarioType[AudioScenarioType["AudioScenarioChatroom"] = 5] = "AudioScenarioChatroom";
     /**
@@ -1597,7 +1597,7 @@ var VideoApplicationScenarioType;
      */
     VideoApplicationScenarioType[VideoApplicationScenarioType["ApplicationScenarioGeneral"] = 0] = "ApplicationScenarioGeneral";
     /**
-     * If set to ApplicationScenarioMeeting (1), the SDK automatically enables the following strategies:
+     * ApplicationScenarioMeeting (1) is suitable for meeting scenarios. 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.
@@ -1614,7 +1614,7 @@ var VideoApplicationScenarioType;
      */
     VideoApplicationScenarioType[VideoApplicationScenarioType["ApplicationScenarioMeeting"] = 1] = "ApplicationScenarioMeeting";
     /**
-     * @ignore
+     * ApplicationScenario1v1 (2) is suitable for 1v1 video call scenarios. To meet the requirements for low latency and high-quality video in this scenario, the SDK optimizes its strategies, improving performance in terms of video quality, first frame rendering, latency on mid-to-low-end devices, and smoothness under weak network conditions. 2: 1v1 video call scenario.
      */
     VideoApplicationScenarioType[VideoApplicationScenarioType["ApplicationScenario1v1"] = 2] = "ApplicationScenario1v1";
 })(VideoApplicationScenarioType = exports.VideoApplicationScenarioType || (exports.VideoApplicationScenarioType = {}));
@@ -1867,23 +1867,23 @@ var LocalVideoStreamReason;
      */
     LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonScreenCaptureWindowNotSupported"] = 20] = "LocalVideoStreamReasonScreenCaptureWindowNotSupported";
     /**
-     * @ignore
+     * 21: (Windows only) The screen has not captured any data available for window sharing.
      */
     LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonScreenCaptureFailure"] = 21] = "LocalVideoStreamReasonScreenCaptureFailure";
     /**
-     * @ignore
+     * 22: No permission for screen capture.
      */
     LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonScreenCaptureNoPermission"] = 22] = "LocalVideoStreamReasonScreenCaptureNoPermission";
     /**
-     * @ignore
+     * 24: (Windows only) An unexpected error occurred during screen sharing (possibly due to window blocking failure), resulting in decreased performance, but the screen sharing process itself was not affected.
      */
     LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonScreenCaptureAutoFallback"] = 24] = "LocalVideoStreamReasonScreenCaptureAutoFallback";
     /**
-     * @ignore
+     * 25: (Windows only) The window for the current screen capture is hidden and not visible on the current screen.
      */
     LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonScreenCaptureWindowHidden"] = 25] = "LocalVideoStreamReasonScreenCaptureWindowHidden";
     /**
-     * @ignore
+     * 26: (Windows only) The window for screen capture has been restored from hidden state.
      */
     LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonScreenCaptureWindowRecoverFromHidden"] = 26] = "LocalVideoStreamReasonScreenCaptureWindowRecoverFromHidden";
     /**
@@ -1891,15 +1891,15 @@ var LocalVideoStreamReason;
      */
     LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonScreenCaptureWindowRecoverFromMinimized"] = 27] = "LocalVideoStreamReasonScreenCaptureWindowRecoverFromMinimized";
     /**
-     * @ignore
+     * 28: (Windows only) Screen capture has been paused. Common scenarios reporting this error code: The current screen may have been switched to a secure desktop, such as a UAC dialog box or Winlogon desktop.
      */
     LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonScreenCapturePaused"] = 28] = "LocalVideoStreamReasonScreenCapturePaused";
     /**
-     * @ignore
+     * 29: (Windows only) Screen capture has resumed from paused state.
      */
     LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonScreenCaptureResumed"] = 29] = "LocalVideoStreamReasonScreenCaptureResumed";
     /**
-     * @ignore
+     * 30: The displayer used for screen capture is disconnected.
      */
     LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonScreenCaptureDisplayDisconnected"] = 30] = "LocalVideoStreamReasonScreenCaptureDisplayDisconnected";
 })(LocalVideoStreamReason = exports.LocalVideoStreamReason || (exports.LocalVideoStreamReason = {}));
@@ -2601,7 +2601,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 exceeds the 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";
     /**
@@ -2609,11 +2609,11 @@ var ClientRoleChangeFailedReason;
      */
     ClientRoleChangeFailedReason[ClientRoleChangeFailedReason["ClientRoleChangeFailedNotAuthorized"] = 2] = "ClientRoleChangeFailedNotAuthorized";
     /**
-     * 3: The request is timed out. Agora recommends you prompt the user to check the network connection and try to switch their user role again.
+     * 3: The request is timed out. Agora recommends you prompt the user to check the network connection and try to switch their user role again. Deprecated: This enumerator is deprecated since v4.4.0 and is not recommended for use.
      */
     ClientRoleChangeFailedReason[ClientRoleChangeFailedReason["ClientRoleChangeFailedRequestTimeOut"] = 3] = "ClientRoleChangeFailedRequestTimeOut";
     /**
-     * 4: The SDK connection fails. You can use reason reported in the onConnectionStateChanged callback to troubleshoot the failure.
+     * 4: The SDK is disconnected from the Agora edge server. You can troubleshoot the failure through the reason reported by onConnectionStateChanged. Deprecated: This enumerator is deprecated since v4.4.0 and is not recommended for use.
      */
     ClientRoleChangeFailedReason[ClientRoleChangeFailedReason["ClientRoleChangeFailedConnectionFailed"] = 4] = "ClientRoleChangeFailedConnectionFailed";
 })(ClientRoleChangeFailedReason = exports.ClientRoleChangeFailedReason || (exports.ClientRoleChangeFailedReason = {}));
@@ -2703,7 +2703,7 @@ var NetworkType;
 var VideoViewSetupMode;
 (function (VideoViewSetupMode) {
     /**
-     * 0: (Default) Replaces a view.
+     * 0: (Default) Clear all added views and replace with a new view.
      */
     VideoViewSetupMode[VideoViewSetupMode["VideoViewSetupReplace"] = 0] = "VideoViewSetupReplace";
     /**
@@ -2913,7 +2913,7 @@ exports.ColorEnhanceOptions = ColorEnhanceOptions;
 var BackgroundSourceType;
 (function (BackgroundSourceType) {
     /**
-     * 0: Process the background as alpha information without replacement, only separating the portrait and the background. After setting this value, you can call startLocalVideoTranscoder to implement the picture-in-picture effect.
+     * 0: Process the background as alpha data without replacement, only separating the portrait and the background. After setting this value, you can call startLocalVideoTranscoder to implement the picture-in-picture effect.
      */
     BackgroundSourceType[BackgroundSourceType["BackgroundNone"] = 0] = "BackgroundNone";
     /**
@@ -3248,48 +3248,48 @@ var HeadphoneEqualizerPreset;
     HeadphoneEqualizerPreset[HeadphoneEqualizerPreset["HeadphoneEqualizerInear"] = 67108866] = "HeadphoneEqualizerInear";
 })(HeadphoneEqualizerPreset = exports.HeadphoneEqualizerPreset || (exports.HeadphoneEqualizerPreset = {}));
 /**
- * @ignore
+ * Voice AI tuner sound types.
  */
 var VoiceAiTunerType;
 (function (VoiceAiTunerType) {
     /**
-     * @ignore
+     * 0: Mature male voice. A deep and magnetic male voice.
      */
     VoiceAiTunerType[VoiceAiTunerType["VoiceAiTunerMatureMale"] = 0] = "VoiceAiTunerMatureMale";
     /**
-     * @ignore
+     * 1: Fresh male voice. A fresh and slightly sweet male voice.
      */
     VoiceAiTunerType[VoiceAiTunerType["VoiceAiTunerFreshMale"] = 1] = "VoiceAiTunerFreshMale";
     /**
-     * @ignore
+     * 2: Elegant female voice. A deep and charming female voice.
      */
     VoiceAiTunerType[VoiceAiTunerType["VoiceAiTunerElegantFemale"] = 2] = "VoiceAiTunerElegantFemale";
     /**
-     * @ignore
+     * 3: Sweet female voice. A high-pitched and cute female voice.
      */
     VoiceAiTunerType[VoiceAiTunerType["VoiceAiTunerSweetFemale"] = 3] = "VoiceAiTunerSweetFemale";
     /**
-     * @ignore
+     * 4: Warm male singing. A warm and melodious male voice.
      */
     VoiceAiTunerType[VoiceAiTunerType["VoiceAiTunerWarmMaleSinging"] = 4] = "VoiceAiTunerWarmMaleSinging";
     /**
-     * @ignore
+     * 5: Gentle female singing. A soft and delicate female voice.
      */
     VoiceAiTunerType[VoiceAiTunerType["VoiceAiTunerGentleFemaleSinging"] = 5] = "VoiceAiTunerGentleFemaleSinging";
     /**
-     * @ignore
+     * 6: Husky male singing. A unique husky male voice.
      */
     VoiceAiTunerType[VoiceAiTunerType["VoiceAiTunerHuskyMaleSinging"] = 6] = "VoiceAiTunerHuskyMaleSinging";
     /**
-     * @ignore
+     * 7: Warm elegant female singing. A warm and mature female voice.
      */
     VoiceAiTunerType[VoiceAiTunerType["VoiceAiTunerWarmElegantFemaleSinging"] = 7] = "VoiceAiTunerWarmElegantFemaleSinging";
     /**
-     * @ignore
+     * 8: Powerful male singing. A strong and powerful male voice.
      */
     VoiceAiTunerType[VoiceAiTunerType["VoiceAiTunerPowerfulMaleSinging"] = 8] = "VoiceAiTunerPowerfulMaleSinging";
     /**
-     * @ignore
+     * 9: Dreamy female singing. A dreamy and soft female voice.
      */
     VoiceAiTunerType[VoiceAiTunerType["VoiceAiTunerDreamyFemaleSinging"] = 9] = "VoiceAiTunerDreamyFemaleSinging";
 })(VoiceAiTunerType = exports.VoiceAiTunerType || (exports.VoiceAiTunerType = {}));

package/js/Private/AgoraMediaBase.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RecorderInfo = exports.MediaRecorderConfiguration = exports.RecorderReasonCode = exports.RecorderState = exports.MediaRecorderStreamType = exports.MediaRecorderContainerFormat = exports.ExternalVideoSourceType = exports.VideoFrameProcessMode = exports.UserAudioSpectrumInfo = exports.AudioSpectrumData = exports.AudioParams = exports.AudioFramePosition = exports.AudioFrame = exports.AudioFrameType = exports.VideoModulePosition = exports.MediaPlayerSourceType = exports.VideoFrame = exports.ExternalVideoFrame = exports.VideoBufferType = exports.EglContextType = exports.Hdr10MetadataInfo = exports.ColorSpace = exports.TransferID = exports.MatrixID = exports.RangeID = exports.PrimaryID = exports.IVideoFrameMetaInfo = exports.MetaInfoKey = exports.CameraVideoSourceType = exports.RenderModeType = exports.VideoPixelFormat = exports.AudioDualMonoMode = exports.AudioPcmFrame = exports.AudioEncodedFrameInfo = exports.PacketOptions = exports.ContentInspectConfig = exports.ContentInspectModule = exports.ContentInspectType = exports.ContentInspectResult = exports.MediaSourceType = exports.RawAudioFrameOpModeType = exports.AudioParameters = exports.BytesPerSample = exports.AudioRoute = exports.VideoSourceType = exports.ExtensionContext = void 0;
+exports.RecorderInfo = exports.MediaRecorderConfiguration = exports.RecorderReasonCode = exports.RecorderState = exports.MediaRecorderStreamType = exports.MediaRecorderContainerFormat = exports.ExternalVideoSourceType = exports.VideoFrameProcessMode = exports.UserAudioSpectrumInfo = exports.AudioSpectrumData = exports.AudioParams = exports.AudioFramePosition = exports.AudioFrame = exports.AudioFrameType = exports.VideoModulePosition = exports.MediaPlayerSourceType = exports.VideoFrame = exports.ExternalVideoFrame = exports.VideoBufferType = exports.EglContextType = exports.AlphaStitchMode = exports.Hdr10MetadataInfo = exports.ColorSpace = exports.TransferID = exports.MatrixID = exports.RangeID = exports.PrimaryID = exports.IVideoFrameMetaInfo = exports.MetaInfoKey = exports.CameraVideoSourceType = exports.RenderModeType = exports.VideoPixelFormat = exports.AudioDualMonoMode = exports.AudioPcmFrame = exports.AudioEncodedFrameInfo = exports.PacketOptions = exports.ContentInspectConfig = exports.ContentInspectModule = exports.ContentInspectType = exports.ContentInspectResult = exports.MediaSourceType = exports.RawAudioFrameOpModeType = exports.AudioParameters = exports.BytesPerSample = exports.AudioRoute = exports.VideoSourceType = exports.ExtensionContext = void 0;
 require("./extension/AgoraMediaBaseExtension");
 /**
- * @ignore
+ * The context information of the extension.
  */
 class ExtensionContext {
 }
@@ -281,13 +281,13 @@ var ContentInspectType;
     ContentInspectType[ContentInspectType["ContentInspectImageModeration"] = 3] = "ContentInspectImageModeration";
 })(ContentInspectType = exports.ContentInspectType || (exports.ContentInspectType = {}));
 /**
- * A ContentInspectModule structure used to configure the frequency of video screenshot and upload.
+ * ContentInspectModule A structure used to configure the frequency of video screenshot and upload.
  */
 class ContentInspectModule {
 }
 exports.ContentInspectModule = ContentInspectModule;
 /**
- * Configuration of video screenshot and upload.
+ * Screenshot and upload configuration.
  */
 class ContentInspectConfig {
 }
@@ -674,6 +674,32 @@ exports.ColorSpace = ColorSpace;
 class Hdr10MetadataInfo {
 }
 exports.Hdr10MetadataInfo = Hdr10MetadataInfo;
+/**
+ * @ignore
+ */
+var AlphaStitchMode;
+(function (AlphaStitchMode) {
+    /**
+     * @ignore
+     */
+    AlphaStitchMode[AlphaStitchMode["NoAlphaStitch"] = 0] = "NoAlphaStitch";
+    /**
+     * @ignore
+     */
+    AlphaStitchMode[AlphaStitchMode["AlphaStitchUp"] = 1] = "AlphaStitchUp";
+    /**
+     * @ignore
+     */
+    AlphaStitchMode[AlphaStitchMode["AlphaStitchBelow"] = 2] = "AlphaStitchBelow";
+    /**
+     * @ignore
+     */
+    AlphaStitchMode[AlphaStitchMode["AlphaStitchLeft"] = 3] = "AlphaStitchLeft";
+    /**
+     * @ignore
+     */
+    AlphaStitchMode[AlphaStitchMode["AlphaStitchRight"] = 4] = "AlphaStitchRight";
+})(AlphaStitchMode = exports.AlphaStitchMode || (exports.AlphaStitchMode = {}));
 /**
  * @ignore
  */

package/js/Private/IAgoraLog.js

@@ -31,6 +31,10 @@ var LogLevel;
      * @ignore
      */
     LogLevel[LogLevel["LogLevelApiCall"] = 16] = "LogLevelApiCall";
+    /**
+     * @ignore
+     */
+    LogLevel[LogLevel["LogLevelDebug"] = 32] = "LogLevelDebug";
 })(LogLevel = exports.LogLevel || (exports.LogLevel = {}));
 /**
  * The output log level of the SDK.

package/js/Private/IAgoraRhythmPlayer.js

@@ -3,54 +3,54 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AgoraRhythmPlayerConfig = exports.RhythmPlayerReason = exports.RhythmPlayerStateType = void 0;
 require("./extension/IAgoraRhythmPlayerExtension");
 /**
- * @ignore
+ * Virtual metronome state.
  */
 var RhythmPlayerStateType;
 (function (RhythmPlayerStateType) {
     /**
-     * @ignore
+     * (810): The virtual metronome is not enabled or disabled already.
      */
     RhythmPlayerStateType[RhythmPlayerStateType["RhythmPlayerStateIdle"] = 810] = "RhythmPlayerStateIdle";
     /**
-     * @ignore
+     * 811: Opening the beat files.
      */
     RhythmPlayerStateType[RhythmPlayerStateType["RhythmPlayerStateOpening"] = 811] = "RhythmPlayerStateOpening";
     /**
-     * @ignore
+     * 812: Decoding the beat files.
      */
     RhythmPlayerStateType[RhythmPlayerStateType["RhythmPlayerStateDecoding"] = 812] = "RhythmPlayerStateDecoding";
     /**
-     * @ignore
+     * 813: The beat files are playing.
      */
     RhythmPlayerStateType[RhythmPlayerStateType["RhythmPlayerStatePlaying"] = 813] = "RhythmPlayerStatePlaying";
     /**
-     * @ignore
+     * 814: Failed to start virtual metronome. You can use the reported errorCode to troubleshoot the cause of the error, or you can try to start the virtual metronome again.
      */
     RhythmPlayerStateType[RhythmPlayerStateType["RhythmPlayerStateFailed"] = 814] = "RhythmPlayerStateFailed";
 })(RhythmPlayerStateType = exports.RhythmPlayerStateType || (exports.RhythmPlayerStateType = {}));
 /**
- * @ignore
+ * Virtual Metronome error message.
  */
 var RhythmPlayerReason;
 (function (RhythmPlayerReason) {
     /**
-     * @ignore
+     * (0): The beat files are played normally without errors.
      */
     RhythmPlayerReason[RhythmPlayerReason["RhythmPlayerReasonOk"] = 0] = "RhythmPlayerReasonOk";
     /**
-     * @ignore
+     * 1: A general error; no specific reason.
      */
     RhythmPlayerReason[RhythmPlayerReason["RhythmPlayerReasonFailed"] = 1] = "RhythmPlayerReasonFailed";
     /**
-     * @ignore
+     * 801: There is an error when opening the beat files.
      */
     RhythmPlayerReason[RhythmPlayerReason["RhythmPlayerReasonCanNotOpen"] = 801] = "RhythmPlayerReasonCanNotOpen";
     /**
-     * @ignore
+     * 802: There is an error when playing the beat files.
      */
     RhythmPlayerReason[RhythmPlayerReason["RhythmPlayerReasonCanNotPlay"] = 802] = "RhythmPlayerReasonCanNotPlay";
     /**
-     * @ignore
+     * (803): The duration of the beat file exceeds the limit. The maximum duration is 1.2 seconds.
      */
     RhythmPlayerReason[RhythmPlayerReason["RhythmPlayerReasonFileOverDurationLimit"] = 803] = "RhythmPlayerReasonFileOverDurationLimit";
 })(RhythmPlayerReason = exports.RhythmPlayerReason || (exports.RhythmPlayerReason = {}));