upgrade new docs

Agora-C_Sharp-RTC-SDK/Code/Rtc/IAudioDeviceManager.cs

@@ -369,12 +369,27 @@ public abstract class IAudioDeviceManager
         public abstract int GetPlaybackDeviceMute(ref bool mute);
 
         ///
-        /// @ignore
+        /// <summary>
+        /// Sets the mute status of the audio capture device.
+        /// </summary>
+        ///
+        /// <param name="mute"> Whether to mute the audio recording device: true : Mute the audio capture device. false : Unmute the audio capture device. </param>
+        ///
+        /// <returns>
+        /// 0: Success.
+        /// &lt; 0: Failure.
+        /// </returns>
         ///
         public abstract int SetRecordingDeviceMute(bool mute);
 
         ///
-        /// @ignore
+        /// <summary>
+        /// Gets whether the audio capture device is muted.
+        /// </summary>
+        ///
+        /// <returns>
+        /// true : The microphone is muted. false : The microphone is unmuted.
+        /// </returns>
         ///
         public abstract int GetRecordingDeviceMute(ref bool mute);
 

Agora-C_Sharp-RTC-SDK/Code/Rtc/IAudioSpectrumObserver.cs

@@ -33,7 +33,7 @@ public virtual bool OnLocalAudioSpectrum(AudioSpectrumData data)
         /// After successfully calling RegisterAudioSpectrumObserver to implement the OnRemoteAudioSpectrum callback in the IAudioSpectrumObserver and calling EnableAudioSpectrumMonitor to enable audio spectrum monitoring, the SDK will trigger the callback as the time interval you set to report the received remote audio data spectrum.
         /// </summary>
         ///
-        /// <param name="spectrums"> The audio spectrum information of the remote user, see UserAudioSpectrumInfo. The number of arrays is the number of remote users monitored by the SDK. If the array is null, it means that no audio spectrum of remote users is detected. </param>
+        /// <param name="spectrums"> The audio spectrum information of the remote user. See UserAudioSpectrumInfo. The number of arrays is the number of remote users monitored by the SDK. If the array is null, it means that no audio spectrum of remote users is detected. </param>
         ///
         /// <param name="spectrumNumber"> The number of remote users. </param>
         ///

Agora-C_Sharp-RTC-SDK/Code/Rtc/IFaceInfoObserver.cs

@@ -23,7 +23,9 @@ public abstract class IFaceInfoObserver
         /// pitch: Head pitch angle. A positve value means looking down, while a negative value means looking up.
         /// yaw: Head yaw angle. A positve value means turning left, while a negative value means turning right.
         /// roll: Head roll angle. A positve value means tilting to the right, while a negative value means tilting to the left.
-        /// timestamp: String. The timestamp of the output result, in milliseconds. Here is an example of JSON: { "faces":[{ "blendshapes":{ "eyeBlinkLeft":0.9, "eyeLookDownLeft":0.0, "eyeLookInLeft":0.0, "eyeLookOutLeft":0.0, "eyeLookUpLeft":0.0, "eyeSquintLeft":0.0, "eyeWideLeft":0.0, "eyeBlinkRight":0.0, "eyeLookDownRight":0.0, "eyeLookInRight":0.0, "eyeLookOutRight":0.0, "eyeLookUpRight":0.0, "eyeSquintRight":0.0, "eyeWideRight":0.0, "jawForward":0.0, "jawLeft":0.0, "jawRight":0.0, "jawOpen":0.0, "mouthClose":0.0, "mouthFunnel":0.0, "mouthPucker":0.0, "mouthLeft":0.0, "mouthRight":0.0, "mouthSmileLeft":0.0, "mouthSmileRight":0.0, "mouthFrownLeft":0.0, "mouthFrownRight":0.0, "mouthDimpleLeft":0.0, "mouthDimpleRight":0.0, "mouthStretchLeft":0.0, "mouthStretchRight":0.0, "mouthRollLower":0.0, "mouthRollUpper":0.0, "mouthShrugLower":0.0, "mouthShrugUpper":0.0, "mouthPressLeft":0.0, "mouthPressRight":0.0, "mouthLowerDownLeft":0.0, "mouthLowerDownRight":0.0, "mouthUpperUpLeft":0.0, "mouthUpperUpRight":0.0, "browDownLeft":0.0, "browDownRight":0.0, "browInnerUp":0.0, "browOuterUpLeft":0.0, "browOuterUpRight":0.0, "cheekPuff":0.0, "cheekSquintLeft":0.0, "cheekSquintRight":0.0, "noseSneerLeft":0.0, "noseSneerRight":0.0, "tongueOut":0.0 }, "rotation":{"pitch":30.0, "yaw":25.5, "roll":-15.5}, }], "timestamp":"654879876546" }
+        /// timestamp: String. The timestamp of the output result, in milliseconds. Here is an example of JSON:
+        /// { "faces":[{ "blendshapes":{ "eyeBlinkLeft":0.9, "eyeLookDownLeft":0.0, "eyeLookInLeft":0.0, "eyeLookOutLeft":0.0, "eyeLookUpLeft":0.0, "eyeSquintLeft":0.0, "eyeWideLeft":0.0, "eyeBlinkRight":0.0, "eyeLookDownRight":0.0, "eyeLookInRight":0.0, "eyeLookOutRight":0.0, "eyeLookUpRight":0.0, "eyeSquintRight":0.0, "eyeWideRight":0.0, "jawForward":0.0, "jawLeft":0.0, "jawRight":0.0, "jawOpen":0.0, "mouthClose":0.0, "mouthFunnel":0.0, "mouthPucker":0.0, "mouthLeft":0.0, "mouthRight":0.0, "mouthSmileLeft":0.0, "mouthSmileRight":0.0, "mouthFrownLeft":0.0, "mouthFrownRight":0.0, "mouthDimpleLeft":0.0, "mouthDimpleRight":0.0, "mouthStretchLeft":0.0, "mouthStretchRight":0.0, "mouthRollLower":0.0, "mouthRollUpper":0.0, "mouthShrugLower":0.0, "mouthShrugUpper":0.0, "mouthPressLeft":0.0, "mouthPressRight":0.0, "mouthLowerDownLeft":0.0, "mouthLowerDownRight":0.0, "mouthUpperUpLeft":0.0, "mouthUpperUpRight":0.0, "browDownLeft":0.0, "browDownRight":0.0, "browInnerUp":0.0, "browOuterUpLeft":0.0, "browOuterUpRight":0.0, "cheekPuff":0.0, "cheekSquintLeft":0.0, "cheekSquintRight":0.0, "noseSneerLeft":0.0, "noseSneerRight":0.0, "tongueOut":0.0 }, "rotation":{"pitch":30.0, "yaw":25.5, "roll":-15.5},
+        /// }], "timestamp":"654879876546" }
         /// </param>
         ///
         /// <returns>

Agora-C_Sharp-RTC-SDK/Code/Rtc/IMediaPlayer.cs

@@ -237,8 +237,8 @@ public abstract class IMediaPlayer
         /// </summary>
         ///
         /// <param name="speed">
-        /// The playback speed. Agora recommends that you limit this value to a range between 50 and 400, which is defined as follows:
-        /// 50: Half the original speed.
+        /// The playback speed. Agora recommends that you set this to a value between 30 and 400, defined as follows:
+        /// 30: 0.3 times the original speed.
         /// 100: The original speed.
         /// 400: 4 times the original speed.
         /// </param>
@@ -601,7 +601,7 @@ public abstract class IMediaPlayer
         /// 
         /// You can call this method to switch the media resource to be played according to the current network status. For example:
         /// When the network is poor, the media resource to be played is switched to a media resource address with a lower bitrate.
-        /// When the network is good, the media resource to be played is switched to a media resource address with a higher bitrate. After calling this method, if you receive the PLAYER_EVENT_SWITCH_COMPLETE event in the OnPlayerEvent callback, the switch is successful; If you receive the PLAYER_EVENT_SWITCH_ERROR event in the OnPlayerEvent callback, the switch fails.
+        /// When the network is good, the media resource to be played is switched to a media resource address with a higher bitrate. After calling this method, if you receive the OnPlayerEvent callback report the PLAYER_EVENT_SWITCH_COMPLETE event, the switching is successful. If the switching fails, the SDK will automatically retry 3 times. If it still fails, you will receive the OnPlayerEvent callback reporting the PLAYER_EVENT_SWITCH_ERROR event indicating an error occurred during media resource switching.
         /// Ensure that you call this method after Open.
         /// To ensure normal playback, pay attention to the following when calling this method:
         /// Do not call this method when playback is paused.
@@ -611,7 +611,7 @@ public abstract class IMediaPlayer
         ///
         /// <param name="src"> The URL of the media resource. </param>
         ///
-        /// <param name="syncPts"> Whether to synchronize the playback position (ms) before and after the switch: true : Synchronize the playback position before and after the switch. false : (Default) Do not synchronize the playback position before and after the switch. Make sure to set this parameter as false if you need to play live streams, or the switch fails. If you need to play on-demand streams, you can set the value of this parameter according to your scenarios. </param>
+        /// <param name="syncPts"> Whether to synchronize the playback position (ms) before and after the switch: true : Synchronize the playback position before and after the switch. false : (Default) Do not synchronize the playback position before and after the switch. </param>
         ///
         /// <returns>
         /// 0: Success.
@@ -624,7 +624,9 @@ public abstract class IMediaPlayer
         /// <summary>
         /// Preloads a media resource.
         /// 
-        /// You can call this method to preload a media resource into the playlist. If you need to preload multiple media resources, you can call this method multiple times. If the preload is successful and you want to play the media resource, call PlayPreloadedSrc; if you want to clear the playlist, call Stop. Agora does not support preloading duplicate media resources to the playlist. However, you can preload the media resources that are being played to the playlist again.
+        /// You can call this method to preload a media resource into the playlist. If you need to preload multiple media resources, you can call this method multiple times. If the preload is successful and you want to play the media resource, call PlayPreloadedSrc; if you want to clear the playlist, call Stop.
+        /// Before calling this method, ensure that you have called Open or OpenWithMediaSource to open the media resource successfully.
+        /// Agora does not support preloading duplicate media resources to the playlist. However, you can preload the media resources that are being played to the playlist again.
         /// </summary>
         ///
         /// <param name="src"> The URL of the media resource. </param>

Agora-C_Sharp-RTC-SDK/Code/Rtc/IMediaPlayerSourceObserver.cs

@@ -48,7 +48,7 @@ public virtual void OnPositionChanged(long positionMs, long timestampMs)
         /// After calling the Seek method, the SDK triggers the callback to report the results of the seek operation.
         /// </summary>
         ///
-        /// <param name="eventCode"> The player events. See MEDIA_PLAYER_EVENT. </param>
+        /// <param name="eventCode"> The player event. See MEDIA_PLAYER_EVENT. </param>
         ///
         /// <param name="elapsedTime"> The time (ms) when the event occurs. </param>
         ///
@@ -78,8 +78,8 @@ public virtual void OnMetaData(byte[] data, int length)
         /// Reports the playback duration that the buffered data can support.
         /// 
         /// 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 PLAYER_EVENT_BUFFER_LOW.
-        /// When the playback duration supported by the buffered data is greater than the threshold (0 by default), the SDK returns PLAYER_EVENT_BUFFER_RECOVER.
+        /// When the playback duration supported by the buffered data is less than the threshold (0 by default), the SDK returns PLAYER_EVENT_BUFFER_LOW (6).
+        /// When the playback duration supported by the buffered data is greater than the threshold (0 by default), the SDK returns PLAYER_EVENT_BUFFER_RECOVER (7).
         /// </summary>
         ///
         /// <param name="playCachedBuffer"> The playback duration (ms) that the buffered data can support. </param>