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

package/ts/Private/IAgoraMediaPlayerSource.ts

@@ -11,16 +11,16 @@ import {
 } from './AgoraMediaPlayerTypes';
 
 /**
- * Provides callbacks for media players.
+ * Provides callbacks for the media player.
  */
 export interface IMediaPlayerSourceObserver {
   /**
-   * Reports the changes of playback state.
+   * Reports changes in the player state.
    *
-   * When the state of the media player changes, the SDK triggers this callback to report the current playback state.
+   * When the player state changes, the SDK triggers this callback to report the new playback state.
    *
-   * @param state The playback state. See MediaPlayerState.
-   * @param reason The reason for the changes in the media player status. See MediaPlayerReason.
+   * @param state The new playback state. See MediaPlayerState.
+   * @param reason The reason for the player state change. See MediaPlayerReason.
    */
   onPlayerSourceStateChanged?(
     state: MediaPlayerState,
@@ -28,22 +28,22 @@ export interface IMediaPlayerSourceObserver {
   ): void;
 
   /**
-   * Reports the playback progress of the media file.
+   * Reports the current playback progress of the media resource.
    *
-   * When playing media files, the SDK triggers this callback every two second to report current playback progress.
+   * When playing a media file, the SDK automatically triggers this callback every second to report the current playback progress.
    *
-   * @param positionMs The playback position (ms) of media files.
-   * @param timeStampMs The NTP timestamp (ms) of the current playback progress.
+   * @param positionMs The current playback progress in ms.
+   * @param timestampMs The NTP timestamp of the current playback progress in ms.
    */
   onPositionChanged?(positionMs: number, timestampMs: number): void;
 
   /**
-   * Reports the player events.
+   * Reports events from the media player.
    *
-   * After calling the seek method, the SDK triggers the callback to report the results of the seek operation.
+   * After calling seek to seek playback, the SDK triggers this callback to report the result of the seek operation.
    *
-   * @param eventCode The player event. See MediaPlayerEvent.
-   * @param elapsedTime The time (ms) when the event occurs.
+   * @param eventCode Media player event. See MediaPlayerEvent.
+   * @param elapsedTime The time (ms) when the event occurred.
    * @param message Information about the event.
    */
   onPlayerEvent?(
@@ -53,31 +53,31 @@ export interface IMediaPlayerSourceObserver {
   ): void;
 
   /**
-   * Occurs when the media metadata is received.
+   * Reports retrieved media metadata.
    *
-   * The callback occurs when the player receives the media metadata and reports the detailed information of the media metadata.
+   * After parsing the media metadata, the SDK triggers this callback to report the data type and content of the metadata.
    *
-   * @param data The detailed data of the media metadata.
-   * @param length The data length (bytes).
+   * @param data The actual data in a user-defined format.
+   * @param length The length of the data in bytes.
    */
   onMetaData?(data: Uint8Array, length: number): void;
 
   /**
-   * Reports the playback duration that the buffered data can support.
+   * Reports the playable duration of the current buffer.
    *
-   * When playing online media resources, the SDK triggers this callback every two seconds to report the playback duration that the currently buffered data can support.
-   *  When the playback duration supported by the buffered data is less than the threshold (0 by default), the SDK returns PlayerEventBufferLow (6).
-   *  When the playback duration supported by the buffered data is greater than the threshold (0 by default), the SDK returns PlayerEventBufferRecover (7).
+   * While playing online media resources, the SDK triggers this callback every second to report the duration that the current buffered data can support for playback.
+   *  If the buffered duration is less than the threshold (default is 0), it returns PlayerEventBufferLow (6).
+   *  If the buffered duration is greater than the threshold (default is 0), it returns PlayerEventBufferRecover (7).
    *
-   * @param playCachedBuffer The playback duration (ms) that the buffered data can support.
+   * @param playCachedBuffer The duration (ms) that the current buffered data can support for playback.
    */
   onPlayBufferUpdated?(playCachedBuffer: number): void;
 
   /**
-   * Reports the events of preloaded media resources.
+   * Reports events related to preloading media resources.
    *
-   * @param src The URL of the media resource.
-   * @param event Events that occur when media resources are preloaded. See PlayerPreloadEvent.
+   * @param src The path of the media resource.
+   * @param event The event that occurs during media resource preloading. See PlayerPreloadEvent.
    */
   onPreloadEvent?(src: string, event: PlayerPreloadEvent): void;
 
@@ -92,46 +92,46 @@ export interface IMediaPlayerSourceObserver {
   onAgoraCDNTokenWillExpire?(): void;
 
   /**
-   * Occurs when the video bitrate of the media resource changes.
+   * Callback for video bitrate change of media resource.
    *
-   * @param from Information about the video bitrate of the media resource being played. See SrcInfo.
-   * @param to Information about the changed video bitrate of media resource being played. See SrcInfo.
+   * @param from Information about the video bitrate of the media resource before the change. See SrcInfo.
+   * @param to Information about the video bitrate of the media resource after the change. See SrcInfo.
    */
   onPlayerSrcInfoChanged?(from: SrcInfo, to: SrcInfo): void;
 
   /**
-   * Occurs when information related to the media player changes.
+   * Callback when media player-related information changes.
    *
-   * When the information about the media player changes, the SDK triggers this callback. You can use this callback for troubleshooting.
+   * When media player-related information changes, the SDK triggers this callback. You can use it for troubleshooting and diagnostics.
    *
-   * @param info Information related to the media player. See PlayerUpdatedInfo.
+   * @param info Media player-related information. See PlayerUpdatedInfo.
    */
   onPlayerInfoUpdated?(info: PlayerUpdatedInfo): void;
 
   /**
-   * Reports the statistics of the media file being cached.
+   * Reports information about the media resources currently in cache.
    *
-   * After you call the openWithMediaSource method and set enableCache as true, the SDK triggers this callback once per second to report the statistics of the media file being cached.
+   * After calling the openWithMediaSource method and setting the enableCache member to true, the SDK triggers this callback once per second after the media file is opened to report statistics of the cached media files.
    *
-   * @param stats The statistics of the media file being cached. See CacheStatistics.
+   * @param stats Information about the media resources in cache. See CacheStatistics.
    */
   onPlayerCacheStats?(stats: CacheStatistics): void;
 
   /**
-   * The statistics of the media file being played.
+   * Reports information about the currently playing media resource.
    *
-   * The SDK triggers this callback once per second to report the statistics of the media file being played.
+   * After the media resource starts playing, the SDK triggers this callback once per second to report information about the media resource.
    *
-   * @param stats The statistics of the media file. See PlayerPlaybackStats.
+   * @param stats Information about the media resource. See PlayerPlaybackStats.
    */
   onPlayerPlaybackStats?(stats: PlayerPlaybackStats): void;
 
   /**
-   * Reports the volume of the media player.
+   * Audio volume indication callback from the media player.
    *
-   * The SDK triggers this callback every 200 milliseconds to report the current volume of the media player.
+   * The SDK triggers this callback every 200 ms to report the current volume of the media player.
    *
-   * @param volume The volume of the media player. The value ranges from 0 to 255.
+   * @param volume The current volume of the player, ranging from [0, 255].
    */
   onAudioVolumeIndication?(volume: number): void;
 }

package/ts/Private/IAgoraMusicContentCenter.ts

@@ -151,15 +151,15 @@ export class MvProperty {
 }
 
 /**
- * The climax parts of the music.
+ * @ignore
  */
 export class ClimaxSegment {
   /**
-   * The time (ms) when the climax part begins.
+   * @ignore
    */
   startTimeMs?: number;
   /**
-   * The time (ms) when the climax part ends.
+   * @ignore
    */
   endTimeMs?: number;
 }

package/ts/Private/IAgoraRhythmPlayer.ts

@@ -1,67 +1,67 @@
 import './extension/IAgoraRhythmPlayerExtension';
 
 /**
- * Virtual metronome state.
+ * State of the virtual metronome.
  */
 export enum RhythmPlayerStateType {
   /**
-   * (810): The virtual metronome is not enabled or disabled already.
+   * 810: The virtual metronome is not started or has been stopped.
    */
   RhythmPlayerStateIdle = 810,
   /**
-   * 811: Opening the beat files.
+   * 811: Opening the beat audio file.
    */
   RhythmPlayerStateOpening = 811,
   /**
-   * 812: Decoding the beat files.
+   * 812: Decoding the beat audio file.
    */
   RhythmPlayerStateDecoding = 812,
   /**
-   * 813: The beat files are playing.
+   * 813: Playing the beat audio file.
    */
   RhythmPlayerStatePlaying = 813,
   /**
-   * 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.
    */
   RhythmPlayerStateFailed = 814,
 }
 
 /**
- * Virtual Metronome error message.
+ * Virtual metronome error information.
  */
 export enum RhythmPlayerReason {
   /**
-   * (0): The beat files are played normally without errors.
+   * 0: The beat audio file plays normally without error.
    */
   RhythmPlayerReasonOk = 0,
   /**
-   * 1: A general error; no specific reason.
+   * 1: General error with no specific cause.
    */
   RhythmPlayerReasonFailed = 1,
   /**
-   * 801: There is an error when opening the beat files.
+   * 801: Failed to open the beat audio file.
    */
   RhythmPlayerReasonCanNotOpen = 801,
   /**
-   * 802: There is an error when playing the beat files.
+   * 802: Failed to play the beat audio file.
    */
   RhythmPlayerReasonCanNotPlay = 802,
   /**
-   * (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.
    */
   RhythmPlayerReasonFileOverDurationLimit = 803,
 }
 
 /**
- * The metronome configuration.
+ * Virtual metronome configuration.
  */
 export class AgoraRhythmPlayerConfig {
   /**
-   * The number of beats per measure, which ranges from 1 to 9. The default value is 4, which means that each measure contains one downbeat and three upbeats.
+   * Number of beats per measure, range [1,9]. Default is 4, meaning 1 strong beat and 3 weak beats per measure.
    */
   beatsPerMeasure?: number;
   /**
-   * The beat speed (beats/minute), which ranges from 60 to 360. The default value is 60, which means that the metronome plays 60 beats in one minute.
+   * Tempo (beats per minute), range [60,360]. Default is 60, meaning 60 beats per minute.
    */
   beatsPerMinute?: number;
 }