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

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

@@ -3,40 +3,40 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MediaSource = exports.PlayerUpdatedInfo = exports.PlayerPlaybackStats = exports.CacheStatistics = exports.MediaPlayerMetadataType = exports.SrcInfo = exports.PlayerStreamInfo = exports.PlayerPreloadEvent = exports.MediaPlayerEvent = exports.MediaStreamType = exports.MediaPlayerReason = exports.MediaPlayerState = void 0;
 require("./extension/AgoraMediaPlayerTypesExtension");
 /**
- * The playback state.
+ * Player states.
  */
 var MediaPlayerState;
 (function (MediaPlayerState) {
     /**
-     * 0: The default state. The media player returns this state code before you open the media resource or after you stop the playback.
+     * 0: Default state. The player returns this state before opening a media file and after playback ends.
      */
     MediaPlayerState[MediaPlayerState["PlayerStateIdle"] = 0] = "PlayerStateIdle";
     /**
-     * 1: Opening the media resource.
+     * 1: Opening media file.
      */
     MediaPlayerState[MediaPlayerState["PlayerStateOpening"] = 1] = "PlayerStateOpening";
     /**
-     * 2: Opens the media resource successfully.
+     * 2: Media file opened successfully.
      */
     MediaPlayerState[MediaPlayerState["PlayerStateOpenCompleted"] = 2] = "PlayerStateOpenCompleted";
     /**
-     * 3: The media resource is playing.
+     * 3: Playing.
      */
     MediaPlayerState[MediaPlayerState["PlayerStatePlaying"] = 3] = "PlayerStatePlaying";
     /**
-     * 4: Pauses the playback.
+     * 4: Paused.
      */
     MediaPlayerState[MediaPlayerState["PlayerStatePaused"] = 4] = "PlayerStatePaused";
     /**
-     * 5: The playback is complete.
+     * 5: Playback completed.
      */
     MediaPlayerState[MediaPlayerState["PlayerStatePlaybackCompleted"] = 5] = "PlayerStatePlaybackCompleted";
     /**
-     * 6: The loop is complete.
+     * 6: Loop playback ended.
      */
     MediaPlayerState[MediaPlayerState["PlayerStatePlaybackAllLoopsCompleted"] = 6] = "PlayerStatePlaybackAllLoopsCompleted";
     /**
-     * 7: The playback stops.
+     * 7: Playback stopped.
      */
     MediaPlayerState[MediaPlayerState["PlayerStateStopped"] = 7] = "PlayerStateStopped";
     /**
@@ -68,12 +68,12 @@ var MediaPlayerState;
      */
     MediaPlayerState[MediaPlayerState["PlayerStateSetTrackInternal"] = 56] = "PlayerStateSetTrackInternal";
     /**
-     * 100: The media player fails to play the media resource.
+     * 100: Playback failed.
      */
     MediaPlayerState[MediaPlayerState["PlayerStateFailed"] = 100] = "PlayerStateFailed";
 })(MediaPlayerState = exports.MediaPlayerState || (exports.MediaPlayerState = {}));
 /**
- * Reasons for the changes in the media player status.
+ * Reason for player state change.
  */
 var MediaPlayerReason;
 (function (MediaPlayerReason) {
@@ -94,19 +94,19 @@ var MediaPlayerReason;
      */
     MediaPlayerReason[MediaPlayerReason["PlayerReasonNoResource"] = -3] = "PlayerReasonNoResource";
     /**
-     * -4: Invalid media resource.
+     * -4: Invalid resource.
      */
     MediaPlayerReason[MediaPlayerReason["PlayerReasonInvalidMediaSource"] = -4] = "PlayerReasonInvalidMediaSource";
     /**
-     * -5: The media stream type is unknown.
+     * -5: Unknown media stream type.
      */
     MediaPlayerReason[MediaPlayerReason["PlayerReasonUnknownStreamType"] = -5] = "PlayerReasonUnknownStreamType";
     /**
-     * -6: The object is not initialized.
+     * -6: Object not initialized.
      */
     MediaPlayerReason[MediaPlayerReason["PlayerReasonObjNotInitialized"] = -6] = "PlayerReasonObjNotInitialized";
     /**
-     * -7: The codec is not supported.
+     * -7: Codec not supported by decoder.
      */
     MediaPlayerReason[MediaPlayerReason["PlayerReasonCodecNotSupported"] = -7] = "PlayerReasonCodecNotSupported";
     /**
@@ -114,27 +114,27 @@ var MediaPlayerReason;
      */
     MediaPlayerReason[MediaPlayerReason["PlayerReasonVideoRenderFailed"] = -8] = "PlayerReasonVideoRenderFailed";
     /**
-     * -9: An error with the internal state of the player occurs.
+     * -9: Internal player state error.
      */
     MediaPlayerReason[MediaPlayerReason["PlayerReasonInvalidState"] = -9] = "PlayerReasonInvalidState";
     /**
-     * -10: The URL of the media resource cannot be found.
+     * -10: URL not found.
      */
     MediaPlayerReason[MediaPlayerReason["PlayerReasonUrlNotFound"] = -10] = "PlayerReasonUrlNotFound";
     /**
-     * -11: Invalid connection between the player and the Agora Server.
+     * -11: Invalid connection between player and Agora server.
      */
     MediaPlayerReason[MediaPlayerReason["PlayerReasonInvalidConnectionState"] = -11] = "PlayerReasonInvalidConnectionState";
     /**
-     * -12: The playback buffer is insufficient.
+     * -12: Insufficient data in playback buffer.
      */
     MediaPlayerReason[MediaPlayerReason["PlayerReasonSrcBufferUnderflow"] = -12] = "PlayerReasonSrcBufferUnderflow";
     /**
-     * -13: The playback is interrupted.
+     * -13: Playback interrupted abnormally and ended.
      */
     MediaPlayerReason[MediaPlayerReason["PlayerReasonInterrupted"] = -13] = "PlayerReasonInterrupted";
     /**
-     * -14: The SDK does not support the method being called.
+     * -14: API call not supported by the SDK.
      */
     MediaPlayerReason[MediaPlayerReason["PlayerReasonNotSupported"] = -14] = "PlayerReasonNotSupported";
     /**
@@ -146,91 +146,91 @@ var MediaPlayerReason;
      */
     MediaPlayerReason[MediaPlayerReason["PlayerReasonIpExpired"] = -16] = "PlayerReasonIpExpired";
     /**
-     * -17: An unknown error.
+     * -17: Unknown error.
      */
     MediaPlayerReason[MediaPlayerReason["PlayerReasonUnknown"] = -17] = "PlayerReasonUnknown";
 })(MediaPlayerReason = exports.MediaPlayerReason || (exports.MediaPlayerReason = {}));
 /**
- * The type of the media stream.
+ * Media stream types.
  */
 var MediaStreamType;
 (function (MediaStreamType) {
     /**
-     * 0: The type is unknown.
+     * 0: Unknown type.
      */
     MediaStreamType[MediaStreamType["StreamTypeUnknown"] = 0] = "StreamTypeUnknown";
     /**
-     * 1: The video stream.
+     * 1: Video stream.
      */
     MediaStreamType[MediaStreamType["StreamTypeVideo"] = 1] = "StreamTypeVideo";
     /**
-     * 2: The audio stream.
+     * 2: Audio stream.
      */
     MediaStreamType[MediaStreamType["StreamTypeAudio"] = 2] = "StreamTypeAudio";
     /**
-     * 3: The subtitle stream.
+     * 3: Subtitle stream.
      */
     MediaStreamType[MediaStreamType["StreamTypeSubtitle"] = 3] = "StreamTypeSubtitle";
 })(MediaStreamType = exports.MediaStreamType || (exports.MediaStreamType = {}));
 /**
- * Media player events.
+ * Player events.
  */
 var MediaPlayerEvent;
 (function (MediaPlayerEvent) {
     /**
-     * 0: The player begins to seek to a new playback position.
+     * 0: Start seeking.
      */
     MediaPlayerEvent[MediaPlayerEvent["PlayerEventSeekBegin"] = 0] = "PlayerEventSeekBegin";
     /**
-     * 1: The player finishes seeking to a new playback position.
+     * 1: Seek completed.
      */
     MediaPlayerEvent[MediaPlayerEvent["PlayerEventSeekComplete"] = 1] = "PlayerEventSeekComplete";
     /**
-     * 2: An error occurs when seeking to a new playback position.
+     * 2: Seek error.
      */
     MediaPlayerEvent[MediaPlayerEvent["PlayerEventSeekError"] = 2] = "PlayerEventSeekError";
     /**
-     * 5: The audio track used by the player has been changed.
+     * 5: Current audio track changed.
      */
     MediaPlayerEvent[MediaPlayerEvent["PlayerEventAudioTrackChanged"] = 5] = "PlayerEventAudioTrackChanged";
     /**
-     * 6: The currently buffered data is not enough to support playback.
+     * 6: The current buffered data is insufficient for playback.
      */
     MediaPlayerEvent[MediaPlayerEvent["PlayerEventBufferLow"] = 6] = "PlayerEventBufferLow";
     /**
-     * 7: The currently buffered data is just enough to support playback.
+     * 7: The current buffered data is just enough for playback.
      */
     MediaPlayerEvent[MediaPlayerEvent["PlayerEventBufferRecover"] = 7] = "PlayerEventBufferRecover";
     /**
-     * 8: The audio or video playback freezes.
+     * 8: Audio or video stuttering occurred.
      */
     MediaPlayerEvent[MediaPlayerEvent["PlayerEventFreezeStart"] = 8] = "PlayerEventFreezeStart";
     /**
-     * 9: The audio or video playback resumes without freezing.
+     * 9: Audio and video stuttering stopped.
      */
     MediaPlayerEvent[MediaPlayerEvent["PlayerEventFreezeStop"] = 9] = "PlayerEventFreezeStop";
     /**
-     * 10: The player starts switching the media resource.
+     * 10: Start switching media resource.
      */
     MediaPlayerEvent[MediaPlayerEvent["PlayerEventSwitchBegin"] = 10] = "PlayerEventSwitchBegin";
     /**
-     * 11: Media resource switching is complete.
+     * 11: Media resource switch completed.
      */
     MediaPlayerEvent[MediaPlayerEvent["PlayerEventSwitchComplete"] = 11] = "PlayerEventSwitchComplete";
     /**
-     * 12: Media resource switching error.
+     * 12: Media resource switch error.
      */
     MediaPlayerEvent[MediaPlayerEvent["PlayerEventSwitchError"] = 12] = "PlayerEventSwitchError";
     /**
-     * 13: The first video frame is rendered.
+     * 13: First video frame rendered.
      */
     MediaPlayerEvent[MediaPlayerEvent["PlayerEventFirstDisplayed"] = 13] = "PlayerEventFirstDisplayed";
     /**
-     * 14: The cached media files reach the limit in number.
+     * 14: Reached the maximum number of cacheable files.
      */
     MediaPlayerEvent[MediaPlayerEvent["PlayerEventReachCacheFileMaxCount"] = 14] = "PlayerEventReachCacheFileMaxCount";
     /**
-     * 15: The cached media files reach the limit in aggregate storage space.
+     * 15: Reached the maximum size of cacheable files.
      */
     MediaPlayerEvent[MediaPlayerEvent["PlayerEventReachCacheFileMaxSize"] = 15] = "PlayerEventReachCacheFileMaxSize";
     /**
@@ -245,59 +245,63 @@ var MediaPlayerEvent;
      * @ignore
      */
     MediaPlayerEvent[MediaPlayerEvent["PlayerEventTryOpenFailed"] = 18] = "PlayerEventTryOpenFailed";
+    /**
+     * @ignore
+     */
+    MediaPlayerEvent[MediaPlayerEvent["PlayerEventHttpRedirect"] = 19] = "PlayerEventHttpRedirect";
 })(MediaPlayerEvent = exports.MediaPlayerEvent || (exports.MediaPlayerEvent = {}));
 /**
- * Events that occur when media resources are preloaded.
+ * Events that occur during media resource preloading.
  */
 var PlayerPreloadEvent;
 (function (PlayerPreloadEvent) {
     /**
-     * 0: Starts preloading media resources.
+     * 0: Begin preloading media resource.
      */
     PlayerPreloadEvent[PlayerPreloadEvent["PlayerPreloadEventBegin"] = 0] = "PlayerPreloadEventBegin";
     /**
-     * 1: Preloading media resources is complete.
+     * 1: Media resource preloading completed.
      */
     PlayerPreloadEvent[PlayerPreloadEvent["PlayerPreloadEventComplete"] = 1] = "PlayerPreloadEventComplete";
     /**
-     * 2: An error occurs when preloading media resources.
+     * 2: Error occurred during media resource preloading.
      */
     PlayerPreloadEvent[PlayerPreloadEvent["PlayerPreloadEventError"] = 2] = "PlayerPreloadEventError";
 })(PlayerPreloadEvent = exports.PlayerPreloadEvent || (exports.PlayerPreloadEvent = {}));
 /**
- * The detailed information of the media stream.
+ * All information about the player media stream.
  */
 class PlayerStreamInfo {
 }
 exports.PlayerStreamInfo = PlayerStreamInfo;
 /**
- * Information about the video bitrate of the media resource being played.
+ * Video bitrate information during media playback.
  */
 class SrcInfo {
 }
 exports.SrcInfo = SrcInfo;
 /**
- * The type of media metadata.
+ * Media metadata types.
  */
 var MediaPlayerMetadataType;
 (function (MediaPlayerMetadataType) {
     /**
-     * 0: The type is unknown.
+     * 0: Unknown type.
      */
     MediaPlayerMetadataType[MediaPlayerMetadataType["PlayerMetadataTypeUnknown"] = 0] = "PlayerMetadataTypeUnknown";
     /**
-     * 1: The type is SEI.
+     * 1: SEI (Supplemental Enhancement Information) type.
      */
     MediaPlayerMetadataType[MediaPlayerMetadataType["PlayerMetadataTypeSei"] = 1] = "PlayerMetadataTypeSei";
 })(MediaPlayerMetadataType = exports.MediaPlayerMetadataType || (exports.MediaPlayerMetadataType = {}));
 /**
- * Statistics about the media files being cached.
+ * Statistics of cached files.
  */
 class CacheStatistics {
 }
 exports.CacheStatistics = CacheStatistics;
 /**
- * The information of the media file being played.
+ * Information about the currently playing media resource.
  */
 class PlayerPlaybackStats {
 }
@@ -309,7 +313,7 @@ class PlayerUpdatedInfo {
 }
 exports.PlayerUpdatedInfo = PlayerUpdatedInfo;
 /**
- * Information related to the media file to be played and the playback scenario configurations.
+ * Information and playback settings of the media file to be played.
  */
 class MediaSource {
 }

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

@@ -3,28 +3,28 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.LogConfig = exports.LogFilterType = exports.LogLevel = void 0;
 require("./extension/IAgoraLogExtension");
 /**
- * The output log level of the SDK.
+ * Log output level.
  */
 var LogLevel;
 (function (LogLevel) {
     /**
-     * 0: Do not output any log information.
+     * 0: Do not output any logs.
      */
     LogLevel[LogLevel["LogLevelNone"] = 0] = "LogLevelNone";
     /**
-     * 0x0001: (Default) Output FATAL, ERROR, WARN, and INFO level log information. We recommend setting your log filter to this level.
+     * 0x0001: (Default) Outputs logs of FATAL, ERROR, WARN, and INFO levels. It is recommended to set the log level to this level.
      */
     LogLevel[LogLevel["LogLevelInfo"] = 1] = "LogLevelInfo";
     /**
-     * 0x0002: Output FATAL, ERROR, and WARN level log information.
+     * 0x0002: Outputs only logs of FATAL, ERROR, and WARN levels.
      */
     LogLevel[LogLevel["LogLevelWarn"] = 2] = "LogLevelWarn";
     /**
-     * 0x0004: Output FATAL and ERROR level log information.
+     * 0x0004: Outputs only logs of FATAL and ERROR levels.
      */
     LogLevel[LogLevel["LogLevelError"] = 4] = "LogLevelError";
     /**
-     * 0x0008: Output FATAL level log information.
+     * 0x0008: Outputs only logs of FATAL level.
      */
     LogLevel[LogLevel["LogLevelFatal"] = 8] = "LogLevelFatal";
     /**
@@ -37,7 +37,7 @@ var LogLevel;
     LogLevel[LogLevel["LogLevelDebug"] = 32] = "LogLevelDebug";
 })(LogLevel = exports.LogLevel || (exports.LogLevel = {}));
 /**
- * The output log level of the SDK.
+ * Log filter level.
  */
 var LogFilterType;
 (function (LogFilterType) {
@@ -46,23 +46,23 @@ var LogFilterType;
      */
     LogFilterType[LogFilterType["LogFilterOff"] = 0] = "LogFilterOff";
     /**
-     * 0x080f: Output all log information. Set your log filter to this level if you want to get the most complete log file.
+     * 0x080f: Outputs all API log information. Set the log level to this value to get the most complete logs.
      */
     LogFilterType[LogFilterType["LogFilterDebug"] = 2063] = "LogFilterDebug";
     /**
-     * 0x000f: Output LogFilterCritical, LogFilterError, LogFilterWarn, and LogFilterInfo level log information. We recommend setting your log filter to this level.
+     * 0x000f: Outputs logs at LogFilterCritical, LogFilterError, LogFilterWarn, and LogFilterInfo levels. It is recommended to set the log level to this value.
      */
     LogFilterType[LogFilterType["LogFilterInfo"] = 15] = "LogFilterInfo";
     /**
-     * 0x000e: Output LogFilterCritical, LogFilterError, and LogFilterWarn level log information.
+     * 0x000e: Outputs logs at LogFilterCritical, LogFilterError, and LogFilterWarn levels.
      */
     LogFilterType[LogFilterType["LogFilterWarn"] = 14] = "LogFilterWarn";
     /**
-     * 0x000c: Output LogFilterCritical and LogFilterError level log information.
+     * 0x000c: Outputs logs at LogFilterCritical and LogFilterError levels.
      */
     LogFilterType[LogFilterType["LogFilterError"] = 12] = "LogFilterError";
     /**
-     * 0x0008: Output LogFilterCritical level log information.
+     * 0x0008: Outputs logs at LogFilterCritical level.
      */
     LogFilterType[LogFilterType["LogFilterCritical"] = 8] = "LogFilterCritical";
     /**
@@ -71,7 +71,7 @@ var LogFilterType;
     LogFilterType[LogFilterType["LogFilterMask"] = 2063] = "LogFilterMask";
 })(LogFilterType = exports.LogFilterType || (exports.LogFilterType = {}));
 /**
- * Configuration of Agora SDK log files.
+ * Configuration for SDK log files.
  */
 class LogConfig {
 }

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

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.IMediaEngine = exports.AudioMixingDualMonoMode = void 0;
 require("./extension/IAgoraMediaEngineExtension");
 /**
- * The channel mode.
+ * Channel mode.
  */
 var AudioMixingDualMonoMode;
 (function (AudioMixingDualMonoMode) {
@@ -12,15 +12,15 @@ var AudioMixingDualMonoMode;
      */
     AudioMixingDualMonoMode[AudioMixingDualMonoMode["AudioMixingDualMonoAuto"] = 0] = "AudioMixingDualMonoAuto";
     /**
-     * 1: Left channel mode. This mode replaces the audio of the right channel with the audio of the left channel, which means the user can only hear the audio of the left channel.
+     * 1: Left channel mode. This mode replaces the right channel audio with the left channel audio, so the user hears only the left channel.
      */
     AudioMixingDualMonoMode[AudioMixingDualMonoMode["AudioMixingDualMonoL"] = 1] = "AudioMixingDualMonoL";
     /**
-     * 2: Right channel mode. This mode replaces the audio of the left channel with the audio of the right channel, which means the user can only hear the audio of the right channel.
+     * 2: Right channel mode. This mode replaces the left channel audio with the right channel audio, so the user hears only the right channel.
      */
     AudioMixingDualMonoMode[AudioMixingDualMonoMode["AudioMixingDualMonoR"] = 2] = "AudioMixingDualMonoR";
     /**
-     * 3: Mixed channel mode. This mode mixes the audio of the left channel and the right channel, which means the user can hear the audio of the left channel and the right channel at the same time.
+     * 3: Mixed mode. This mode overlays the left and right channel data, so the user hears both the left and right channels simultaneously.
      */
     AudioMixingDualMonoMode[AudioMixingDualMonoMode["AudioMixingDualMonoMix"] = 3] = "AudioMixingDualMonoMix";
 })(AudioMixingDualMonoMode = exports.AudioMixingDualMonoMode || (exports.AudioMixingDualMonoMode = {}));

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

@@ -3,13 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.IMediaPlayerCacheManager = exports.IMediaPlayer = void 0;
 require("./extension/IAgoraMediaPlayerExtension");
 /**
- * This class provides media player functions and supports multiple instances.
+ * Class that provides media player functionality and supports multiple instances.
  */
 class IMediaPlayer {
 }
 exports.IMediaPlayer = IMediaPlayer;
 /**
- * This class provides methods to manage cached media files.
+ * This class provides methods to manage cached media files in the media player.
  */
 class IMediaPlayerCacheManager {
 }

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

@@ -120,7 +120,7 @@ class MvProperty {
 }
 exports.MvProperty = MvProperty;
 /**
- * The climax parts of the music.
+ * @ignore
  */
 class ClimaxSegment {
 }

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

@@ -3,59 +3,59 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AgoraRhythmPlayerConfig = exports.RhythmPlayerReason = exports.RhythmPlayerStateType = void 0;
 require("./extension/IAgoraRhythmPlayerExtension");
 /**
- * Virtual metronome state.
+ * State of the virtual metronome.
  */
 var RhythmPlayerStateType;
 (function (RhythmPlayerStateType) {
     /**
-     * (810): The virtual metronome is not enabled or disabled already.
+     * 810: The virtual metronome is not started or has been stopped.
      */
     RhythmPlayerStateType[RhythmPlayerStateType["RhythmPlayerStateIdle"] = 810] = "RhythmPlayerStateIdle";
     /**
-     * 811: Opening the beat files.
+     * 811: Opening the beat audio file.
      */
     RhythmPlayerStateType[RhythmPlayerStateType["RhythmPlayerStateOpening"] = 811] = "RhythmPlayerStateOpening";
     /**
-     * 812: Decoding the beat files.
+     * 812: Decoding the beat audio file.
      */
     RhythmPlayerStateType[RhythmPlayerStateType["RhythmPlayerStateDecoding"] = 812] = "RhythmPlayerStateDecoding";
     /**
-     * 813: The beat files are playing.
+     * 813: Playing the beat audio file.
      */
     RhythmPlayerStateType[RhythmPlayerStateType["RhythmPlayerStatePlaying"] = 813] = "RhythmPlayerStatePlaying";
     /**
-     * 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.
+     * 814: Failed to start the virtual metronome. You can troubleshoot the issue using the reported error code errorCode, or try restarting the virtual metronome.
      */
     RhythmPlayerStateType[RhythmPlayerStateType["RhythmPlayerStateFailed"] = 814] = "RhythmPlayerStateFailed";
 })(RhythmPlayerStateType = exports.RhythmPlayerStateType || (exports.RhythmPlayerStateType = {}));
 /**
- * Virtual Metronome error message.
+ * Virtual metronome error information.
  */
 var RhythmPlayerReason;
 (function (RhythmPlayerReason) {
     /**
-     * (0): The beat files are played normally without errors.
+     * 0: The beat audio file plays normally without error.
      */
     RhythmPlayerReason[RhythmPlayerReason["RhythmPlayerReasonOk"] = 0] = "RhythmPlayerReasonOk";
     /**
-     * 1: A general error; no specific reason.
+     * 1: General error with no specific cause.
      */
     RhythmPlayerReason[RhythmPlayerReason["RhythmPlayerReasonFailed"] = 1] = "RhythmPlayerReasonFailed";
     /**
-     * 801: There is an error when opening the beat files.
+     * 801: Failed to open the beat audio file.
      */
     RhythmPlayerReason[RhythmPlayerReason["RhythmPlayerReasonCanNotOpen"] = 801] = "RhythmPlayerReasonCanNotOpen";
     /**
-     * 802: There is an error when playing the beat files.
+     * 802: Failed to play the beat audio file.
      */
     RhythmPlayerReason[RhythmPlayerReason["RhythmPlayerReasonCanNotPlay"] = 802] = "RhythmPlayerReasonCanNotPlay";
     /**
-     * (803): The duration of the beat file exceeds the limit. The maximum duration is 1.2 seconds.
+     * 803: The duration of the beat audio file exceeds the limit. The maximum duration is 1.2 seconds.
      */
     RhythmPlayerReason[RhythmPlayerReason["RhythmPlayerReasonFileOverDurationLimit"] = 803] = "RhythmPlayerReasonFileOverDurationLimit";
 })(RhythmPlayerReason = exports.RhythmPlayerReason || (exports.RhythmPlayerReason = {}));
 /**
- * The metronome configuration.
+ * Virtual metronome configuration.
  */
 class AgoraRhythmPlayerConfig {
 }