- public abstract int setPlaybackAudioFrameBeforeMixingParameters(int sampleRate, int channel, int samplesPerCall);
+ public abstract int setPlaybackAudioFrameBeforeMixingParameters(
+ int sampleRate, int channel, int samplesPerCall);- (int)setPlaybackAudioFrameBeforeMixingParametersWithSampleRate:(NSInteger)sampleRate channel:(NSInteger)channel samplesPerCall:(NSInteger)samplesPerCall NS_SWIFT_NAME(setPlaybackAudioFrameBeforeMixingParametersWithSampleRate(_:channel:samplesPerCall:));virtual int setPlaybackAudioFrameBeforeMixingParameters(int sampleRate, int channel, int samplesPerCall) = 0;
diff --git a/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita b/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita
index 513e6b3eb2b..4a343b6a775 100644
--- a/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita
+++ b/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita
@@ -13,12 +13,12 @@
- public abstract int setRemoteRenderMode(int userId, int renderMode, int mirrorMode);
+ public abstract int setRemoteRenderMode(int uid, int renderMode, int mirrorMode);public abstract setRemoteRenderMode(uid: number, renderMode: number, mirrorMode: number): number;- (int)setRemoteRenderMode:(NSUInteger)uid
mode:(AgoraVideoRenderMode)mode
mirror:(AgoraVideoMirrorMode)mirror;
- virtual int setRemoteRenderMode(uid_t userId, RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode) = 0;
+ virtual int setRemoteRenderMode(uid_t uid, media::base::RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode) = 0;UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int SetRemoteRenderMode(int64 uid, ERENDER_MODE_TYPE renderMode, EVIDEO_MIRROR_MODE_TYPE mirrorMode);abstract setRemoteRenderMode(
@@ -50,8 +50,8 @@
参数
- userId
- uid
+ userId
+ uid远端用户 ID。
diff --git a/dita/RTC-NG/API/api_irtcengine_setremotevideosubscriptionoptions.dita b/dita/RTC-NG/API/api_irtcengine_setremotevideosubscriptionoptions.dita
index bafc3665171..33c3aa46988 100644
--- a/dita/RTC-NG/API/api_irtcengine_setremotevideosubscriptionoptions.dita
+++ b/dita/RTC-NG/API/api_irtcengine_setremotevideosubscriptionoptions.dita
@@ -40,7 +40,8 @@
public class ChannelMediaOptions {
public Boolean publishCameraTrack;
public Boolean publishSecondaryCameraTrack;
@@ -707,745 +707,6 @@ class ChannelMediaOptions {
Map<String, dynamic> toJson() => _$ChannelMediaOptionsToJson(this);
}
diff --git a/en-US/dita/RTC-NG/API/api_canvas_canvas.dita b/en-US/dita/RTC-NG/API/api_canvas_canvas.dita
index 0a483cbf4d7..a2305299737 100644
--- a/en-US/dita/RTC-NG/API/api_canvas_canvas.dita
+++ b/en-US/dita/RTC-NG/API/api_canvas_canvas.dita
@@ -16,7 +16,7 @@
public Canvas(Rte rte, CanvasInitialConfig config);- (instancetype _Nonnull)initWithRte:(AgoraRte* _Nonnull)rte initialConfig:(AgoraRteCanvasInitialConfig * _Nullable)config;
- Canvas(Rte *rte, CanvasInitialConfig *initial_config);
+ Canvas(Rte *rte, CanvasInitialConfig *initial_config = nullptr)
diff --git a/en-US/dita/RTC-NG/API/api_canvasconfig_getmirrormode.dita b/en-US/dita/RTC-NG/API/api_canvasconfig_getmirrormode.dita
index 56180b9fa1f..b15319727cc 100644
--- a/en-US/dita/RTC-NG/API/api_canvasconfig_getmirrormode.dita
+++ b/en-US/dita/RTC-NG/API/api_canvasconfig_getmirrormode.dita
@@ -16,7 +16,7 @@
public Constants.VideoMirrorMode getVideoMirrorMode() throws RteException ;- (AgoraRteVideoMirrorMode)videoMirrorMode:(AgoraRteError * _Nullable)error;
- VideoMirrorMode GetMirrorMode(Error *err = nullptr);
+ VideoMirrorMode GetMirrorMode(Error *err = nullptr)
diff --git a/en-US/dita/RTC-NG/API/api_createagorartcengine.dita b/en-US/dita/RTC-NG/API/api_createagorartcengine.dita
index 64545fd6e83..c79e7a09ded 100644
--- a/en-US/dita/RTC-NG/API/api_createagorartcengine.dita
+++ b/en-US/dita/RTC-NG/API/api_createagorartcengine.dita
@@ -16,7 +16,7 @@
- AGORA_API agora::rtc::IRtcEngine *AGORA_CALL createAgoraRtcEngine ()
+ AGORA_API agora::rtc::IRtcEngine* AGORA_CALL createAgoraRtcEngine();static AgoraUERtcEngine* Get();UFUNCTION(BlueprintPure, Category = "Agora|IRtcEngine")
static UAgoraBPuRtcEngine* GetAgoraRtcEngine();
diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdefaultdevice2.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdefaultdevice2.dita
index 785d5369fe2..a825f1690b3 100644
--- a/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdefaultdevice2.dita
+++ b/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdefaultdevice2.dita
@@ -2,7 +2,7 @@
- Get the system‘s default audio device and its type.
+ Gets the system‘s default audio device and its type.
diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdevice2.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdevice2.dita
index 0f8ef19ba7f..58034b6dd17 100644
--- a/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdevice2.dita
+++ b/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdevice2.dita
@@ -2,7 +2,7 @@
- Get the audio device information and device type by index.
+ Gets the audio device information and device type by index.
diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice2.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice2.dita
index 3eb29232050..cea122b9ce1 100644
--- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice2.dita
+++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice2.dita
@@ -2,7 +2,7 @@
- Get the system‘s default audio playback device and its type.
+ Gets the system‘s default audio playback device and its type.
diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdeviceinfo2.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdeviceinfo2.dita
index b6bb20e9ff6..8674e6885ec 100644
--- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdeviceinfo2.dita
+++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdeviceinfo2.dita
@@ -2,7 +2,7 @@
- Get the information and type of the audio playback device.
+ Gets the information and type of the audio playback device.
diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdeviceinfo2.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdeviceinfo2.dita
index f7ea33fdd6e..b3c3fdd235a 100644
--- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdeviceinfo2.dita
+++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdeviceinfo2.dita
@@ -2,7 +2,7 @@
- Get the information and type of the audio capturing device.
+ Gets the information and type of the audio capturing device.
diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_registerfaceinfoobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_registerfaceinfoobserver.dita
index ac80f9e15e2..ca968c11933 100644
--- a/en-US/dita/RTC-NG/API/api_imediaengine_registerfaceinfoobserver.dita
+++ b/en-US/dita/RTC-NG/API/api_imediaengine_registerfaceinfoobserver.dita
@@ -47,7 +47,9 @@
Parameters
- observer
+ observer
+ receiver
+ delegateFacial information observer, see . If you need to unregister a facial information observer, pass in .
diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita
index cdcff658f94..7a281674460 100644
--- a/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita
+++ b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita
@@ -30,7 +30,8 @@
Details
-
If you only want to observe encoded video frames (such as H.264 format) without decoding and rendering the video, Agora recommends that you implement one class through this method. For detailed implementation steps, please refer to .
+
If you only want to observe encoded video frames (such as H.264 format) without decoding and rendering the video, Agora recommends that you implement one class through this method.
+
For detailed implementation steps, please refer to .
After registering the raw video observer, you can use the obtained raw video data in various video pre-processing scenarios, such as virtual backgrounds and image enhacement by yourself. For detailed implementation steps, please refer to .
+
After registering the raw video observer, you can use the obtained raw video data in various video pre-processing scenarios, such as virtual backgrounds and image enhacement by yourself.
+
For detailed implementation steps, please refer to .
Agora provides an open source sample project on GitHub for your reference.
boolean getMute();public abstract getMute(): boolean;
- - (bool)getMute;
+ - (BOOL)getMute NS_SWIFT_NAME(getMute());virtual int getMute(bool& mute) = 0;UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer")
int GetMute(bool & muted);
diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_setplayeroption.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setplayeroption.dita
index 5f555d6ee40..b927d9acb87 100644
--- a/en-US/dita/RTC-NG/API/api_imediaplayer_setplayeroption.dita
+++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setplayeroption.dita
@@ -16,7 +16,7 @@
int setPlayerOption(String key, int value);public abstract setPlayerOption(key:string, value:number);- (int)setPlayerOption:(NSString *)key value:(NSInteger)value NS_SWIFT_NAME(setPlayerOption(_:value:));
- virtual int setPlayerOption(const char* key, int64_t value) = 0;
+ virtual int setPlayerOption(const char* key, int value) = 0;UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer")
int SetPlayerOptionWithInt(const FString & key, int value);abstract setPlayerOptionInInt(key: string, value: number): number;
diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_stop.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_stop.dita
index 930eae46b70..f09676b4949 100644
--- a/en-US/dita/RTC-NG/API/api_imediaplayer_stop.dita
+++ b/en-US/dita/RTC-NG/API/api_imediaplayer_stop.dita
@@ -16,7 +16,7 @@
int stop();
public abstract stop(): number;
- - (void)stop;
+ - (int)stop NS_SWIFT_NAME(stop());virtual int stop() = 0;UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer")
int Stop();
diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_switchsrc.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_switchsrc.dita
index e7ba3742ca4..6e4896ae73a 100644
--- a/en-US/dita/RTC-NG/API/api_imediaplayer_switchsrc.dita
+++ b/en-US/dita/RTC-NG/API/api_imediaplayer_switchsrc.dita
@@ -18,8 +18,7 @@
public abstract switchSrc(src:string, syncPts:boolean):number;- (int)switchSrc:(NSString *)src syncPts:(BOOL)sync;
- virtual int switchSrc(const char* src, bool syncPts) = 0;
-
+ virtual int switchSrc(const char* src, bool syncPts = true) = 0;UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer")
int SwitchSrc(const FString& src, bool syncPts = true);abstract switchSrc(src: string, syncPts?: boolean): number;
diff --git a/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita b/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita
index e3d90c697b1..4ac93ec42fb 100644
--- a/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita
+++ b/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita
@@ -38,7 +38,7 @@
Video captured by a camera and encoded in H.264 or H.265.
Once the recording is started, if the video resolution is changed, the SDK stops the recording; if the sampling rate and audio channel changes, the SDK continues recording and generates audio files respectively.
-
The SDK can generate a recording file only when it detects audio and video streams; when there are no audio and video streams to be recorded or the audio and video streams are interrupted for more than 5 seconds, the SDK stops the recording and triggers the (, ) callback.
+
The SDK can generate a recording file only when it detects audio and video streams; when there are no audio and video streams to be recorded or the audio and video streams are interrupted for more than 5 seconds, the SDK stops the recording and triggers the (, ) callback.
Parameters
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode.dita
index 4f7cf72f5ca..56c3c17580f 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode.dita
@@ -16,7 +16,7 @@
public abstract int enableDualStreamMode(boolean enabled);- (int)enableDualStreamMode:(BOOL)enabled;
- virtual int enableDualStreamMode(bool enabled) = 0;
+ virtual int enableDualStreamMode(bool enabled) __deprecated = 0;public abstract int EnableDualStreamMode(bool enabled);
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita
index 449c5cb9071..ac251619e2d 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita
@@ -17,7 +17,7 @@
- (int)enableDualStreamMode:(BOOL)enabled
streamConfig:(AgoraSimulcastStreamConfig* _Nonnull)streamConfig;
- virtual int enableDualStreamMode(bool enabled, const SimulcastStreamConfig& streamConfig) = 0;
+ virtual int enableDualStreamMode(bool enabled, const SimulcastStreamConfig& streamConfig) __deprecated = 0;UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int EnableDualStreamMode(bool enabled, const FSimulcastStreamConfig& streamConfig);abstract enableDualStreamMode(
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableextension.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableextension.dita
index fe8a01ad655..c64b4d86aa1 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_enableextension.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableextension.dita
@@ -83,8 +83,8 @@
- type
- sourceType
+ type
+ sourceTypeSource type of the extension. See .
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablefacedetection.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablefacedetection.dita
index d358e29e960..a473ed661c1 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_enablefacedetection.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablefacedetection.dita
@@ -48,8 +48,8 @@
Parameters
- enable
- enabled
+ enable
+ enabledWhether to enable face detection for the local user:
If the callback methods are not dispatched to the main queue, the App should dispatch the UI operations to the main queue.
-
+ Parameters
-
-
+ enabled
+
+
+
:Dispatch the callback methods to the main queue.
+
:Do not dispatch the callback methods to the main queue.
+
+
-
+ Returns
+
+
0: The method call succeeds.
+
< 0: The method call fails. See for details and suggestions.
+
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablevideoimagesource.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablevideoimagesource.dita
index fd820372d26..342ff36fb37 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_enablevideoimagesource.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablevideoimagesource.dita
@@ -49,7 +49,8 @@
Parameters
- enable
+ enable
+ enabledWhether to replace the current video feeds with custom images:
: Replace the current video feeds with custom images.
: (Default) Do not replace the current video feeds with custom images.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getcallid.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getcallid.dita
index 5ca2d1a95c7..2d3fe820932 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_getcallid.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_getcallid.dita
@@ -39,7 +39,7 @@
Parameters
-
+ callIdOutput parameter, the current call ID.
@@ -47,7 +47,7 @@
Returns
-
The current call ID.
+
The current call ID.
0: Success.
< 0: Failure. See for details and resolution suggestions.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getcameramaxzoomfactor.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getcameramaxzoomfactor.dita
index c5d324d3d51..72b32de4b25 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_getcameramaxzoomfactor.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_getcameramaxzoomfactor.dita
@@ -2,7 +2,7 @@
- Get the maximum zoom ratio supported by the camera.
+ Gets the maximum zoom ratio supported by the camera.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getcurrentmonotonictimeinms.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getcurrentmonotonictimeinms.dita
index 7d974828789..cdf68e0cf62 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_getcurrentmonotonictimeinms.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_getcurrentmonotonictimeinms.dita
@@ -45,7 +45,7 @@
Returns
-
≥0: The method call is successful, and returns the current Monotonic Time of the SDK (in milliseconds).
+
≥ 0: The method call is successful, and returns the current Monotonic Time of the SDK (in milliseconds).
< 0: Failure. See for details and resolution suggestions.
- public double getEffectsVolume();
+ public abstract double getEffectsVolume();- (int)getEffectsVolume;virtual int getEffectsVolume() = 0;
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getfaceshapeareaoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getfaceshapeareaoptions.dita
index a2c377a63b6..0df4c024fe5 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_getfaceshapeareaoptions.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_getfaceshapeareaoptions.dita
@@ -63,19 +63,35 @@
Facial enhancement areas. See .
Facial enhancement areas.
-
-1: (Default) Invalid area; facial enhancement effects do not take effect.
-
0: Head, used to achieve a smaller head effect. The adjustment range is [0,100]; the larger the value, the smaller the head becomes, with a preset value of 100.
-
1: Forehead, which adjusts the height of the hairline. The adjustment strength ranges from [-100,100], with positive values raising and negative values lowering the hairline. The greater the absolute value, the stronger the effect. The default value is 50.
-
2: Face contour, used to achieve a slimmer face effect. The adjustment range is [0,100]; the larger the value, the stronger the slimming effect, with a preset value of 10.
-
3: Face length, used to achieve a longer face effect. The adjustment range is [-100,100]; positive values elongate the face, while negative values shorten it. The larger the value, the stronger the enhancement effect, with a preset value of 0.
-
4: Face width, used to achieve a narrower face effect. The adjustment range is [0,100]; the larger the value, the stronger the narrowing effect, with a preset value of 10.
-
5: Cheekbone, used to adjust the cheekbone width. The adjustment range is [0,100]; the larger the value, the narrower the cheekbones, with a preset set value of 43.
-
6: Cheeks, used to adjust the cheeks width. The adjustment range is [0,100]; the larger the value, the narrower the cheeks, with a preset value of 50.
-
7: Chin, used to adjust the chin length. The adjustment range is [-100,100]; positive values elongate the chin, while negative values shorten it. The larger the value, the stronger the enhancement effect, with a preset value of -20.
-
8:Eyes, used to achieve a larger eye effect. The adjustment range is [0,100]; the larger the value, the larger the eye size, with a preset value of 53.
-
9: Nose length, used to achieve a longer nose effect. The adjustment range is [-100,100]; positive values elongate the nose, while negative values shorten it. The larger the value, the stronger the enhancement effect, with a preset value of -10.
-
10: Nose width, used to achieve a slimmer nose effect. The adjustment range is [-100,100]; positive values enlarge the mouth, while negative values make it smaller. The larger the value, the stronger the enhancement effect, with a preset value of 72.
-
11: Mouth, used to adjust the size of the mouth. The adjustment range is [-100,100]; positive values enlarge the mouth, while negative values make it smaller. The larger the value, the stronger the enhancement effect, with a preset value of 20.
+
(-1): (Default) Invalid area, no beauty effect applied.
+
(100): Head, used to achieve a smaller head effect. The adjustment range is [0,100]; the larger the value, the smaller the head becomes, with a preset value of 100.
+
(101): Forehead, used to adjust the hairline height. The adjustment strength ranges from [-100,100], with positive values raising and negative values lowering the hairline. The greater the absolute value, the stronger the effect. The default value is 50.
+
(102): Face contour, used to achieve a slimmer face effect. The adjustment range is [0,100]; the larger the value, the stronger the slimming effect, with a preset value of 10.
+
(103): Face length, used to achieve a longer face effect. The adjustment range is [-100,100]; positive values elongate the face, while negative values shorten it. The larger the value, the stronger the enhancement effect, with a preset value of 0.
+
(104): Face width, used to achieve a narrower face effect. The adjustment range is [0,100]; the larger the value, the stronger the narrowing effect, with a preset value of 10.
+
(105): Cheekbone, used to adjust cheekbone width. The adjustment range is [0,100]; the larger the value, the narrower the cheekbones, with a preset set value of 43.
+
(106): Cheeks, used to adjust the cheeks width. The adjustment range is [0,100]; the larger the value, the narrower the cheeks, with a preset value of 50.
+
(108): Chin, used to adjust the chin length. The adjustment range is [-100,100]; positive values elongate the chin, while negative values shorten it. The larger the value, the stronger the enhancement effect, with a preset value of -20.
+
(200):Eyes, used to achieve a larger eye effect. The adjustment range is [0,100]; the larger the value, the larger the eye size, with a preset value of 50.
+
(201): Eye distance adjustment. The range is [-100, 100], with a default value of 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.
+
(202): Eye position adjustment. The range is [-100, 100], with a default value of 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.
+
(203): Lower eyelid adjustment. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.
+
(204): Pupil size adjustment. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.
+
(205): Inner eye corner adjustment. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.
+
(206): Outer eye corner adjustment. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.
+
(300): Nose length, used to achieve a longer nose effect. The adjustment range is [-100,100]; positive values elongate the nose, while negative values shorten it. The larger the value, the stronger the enhancement effect, with a preset value of -10.
+
(301): Nose width, used to achieve a slimmer nose effect. The adjustment range is [-100,100]; positive values make the nose wider, while negative values make it narrower. The larger the value, the stronger the enhancement effect, with a preset value of 72.
+
(302): Nose wing adjustment. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.
+
(303): Nose root adjustment. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.
+
(304): Nose bridge adjustment. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.
+
(305): Nose tip adjustment. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.
+
(306): Overall nose adjustment. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.
+
(400): Mouth, used to achieve a larger mouth effect. The adjustment strength ranges from [0,100], with larger values resulting in a larger mouth. The default value is 50.
+
(401): Mouth position adjustment. The range is [-100, 100], with a default value of 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.
+
(402): Mouth smile adjustment. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.
+
(403): Lip shape adjustment. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.
+
(500): Eyebrow position adjustment. The range is [-100, 100], with a default value of 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.
+
(501): Eyebrow thickness adjustment. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.
After a remote user joins the channel, the SDK gets the UID and user account of the remote user, caches them in a mapping table object, and triggers the callback on the local client. After receiving the callback, you can call this method and passi in the UID.to get the user account of the specified user from the object.
+
After a remote user joins the channel, the SDK gets the UID and user account of the remote user, caches them in a mapping table object, and triggers the callback on the local client. After receiving the callback, you can call this method and pass in the UID to get the user account of the specified user from the object.
Call timing
@@ -55,11 +55,11 @@
-
+ channelId
-
+ localUserAccountThe user account of the local user.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getuserinfobyuseraccount.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getuserinfobyuseraccount.dita
index 07c54b927f8..93a48e57693 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_getuserinfobyuseraccount.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_getuserinfobyuseraccount.dita
@@ -14,9 +14,9 @@
-
+ channelId
-
+ localUserAccountThe user account of the local user.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_iscameracenterstagesupported.dita b/en-US/dita/RTC-NG/API/api_irtcengine_iscameracenterstagesupported.dita
index 7d99d8983db..dce8712f930 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_iscameracenterstagesupported.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_iscameracenterstagesupported.dita
@@ -2,7 +2,7 @@
- Check if the camera supports portrait center stage.
+ Checks if the camera supports portrait center stage.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel.dita b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel.dita
index e141152103c..29aaccae866 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel.dita
@@ -13,8 +13,7 @@
- public abstract int joinChannel(
- String token, String channelId, String optionalInfo, int uid);
+ public abstract int joinChannel(String token, String channelId, String optionalInfo, int uid);public abstract joinChannel(key: string, channel: string, optionalInfo: string, uid: number): number;- (int)joinChannelByToken:(NSString * _Nullable)token
channelId:(NSString * _Nonnull)channelId
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita
index 6042c627122..a1c7765ec3e 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita
@@ -75,7 +75,7 @@
token
- The token generated on your server for authentication. See .
+ The token generated on your server for authentication.
(Recommended) If your project has enabled the security mode (using APP ID and Token for authentication), this parameter is required.
If you have only enabled the testing mode (using APP ID for authentication), this parameter is optional. You will automatically exit the channel 24 hours after successfully joining in.
-
+
+
+ optionalUid
+ The user ID. This parameter is used to identify the user in the channel for real-time audio and video interaction. You need to set and manage user IDs yourself, and ensure that each user ID in the same channel is unique. This parameter is a 32-bit signed integer. The value range is from -231 to 231-1. If the user ID is not assigned (or set to 0), the SDK assigns a random user ID and `onJoinChannelSuccess` returns it in the callback. Your application must record and maintain the returned user ID, because the SDK does not do so.
+
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_preloadeffect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_preloadeffect.dita
index 82783de7513..662d48dad32 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_preloadeffect.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_preloadeffect.dita
@@ -13,8 +13,7 @@
- public int preloadEffect(int soundId, String filePath);
-
+ public abstract int preloadEffect(int soundId, String filePath);- (int)preloadEffect:(int)soundId
filePath:(NSString* _Nonnull)filePath;
@@ -59,14 +58,14 @@
filePathFile path:
-
Android: The file path, which needs to be accurate to the file name and suffix. Agora supports URL addresses, absolute paths, or file paths that start with /assets/. You might encounter permission issues if you use an absolute path to access a local file, so Agora recommends using a URI address instead. For example: content://com.android.providers.media.documents/document/audio%3A14441
-
Windows: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example: C:\music\audio.mp4.
-
iOS or macOS: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example: /var/mobile/Containers/Data/audio.mp4.
+
Android: The file path, which needs to be accurate to the file name and suffix. Agora supports URL addresses, absolute paths, or file paths that start with /assets/. You might encounter permission issues if you use an absolute path to access a local file, so Agora recommends using a URI address instead. For example: content://com.android.providers.media.documents/document/audio%3A14441
+
Windows: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example: C:\music\audio.mp4.
+
iOS or macOS: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example: /var/mobile/Containers/Data/audio.mp4.
iOS: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example: /var/mobile/Containers/Data/audio.mp4.
macOS: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example: /var/mobile/Containers/Data/audio.mp4.
-
+ startPosThe playback position (ms) of the audio effect file.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_querydevicescore.dita b/en-US/dita/RTC-NG/API/api_irtcengine_querydevicescore.dita
index 2e96411aee8..c0013eb43d5 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_querydevicescore.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_querydevicescore.dita
@@ -42,7 +42,7 @@
When the method call succeeds, it returns a value in the range of [0,100], indicating the current device's score. The larger the value, the stronger the device capability. Most devices are rated between 60 and 100. When the method call fails, the exception is thrown; and you need to catch the exception and handle it accordingly.
-
>0: The method call succeeeds, the value is the current device's score, the range is [0,100], the larger the value, the stronger the device capability. Most devices are rated between 60 and 100.
+
> 0: The method call succeeeds, the value is the current device's score, the range is [0,100], the larger the value, the stronger the device capability. Most devices are rated between 60 and 100.
After a successful method call, you can no longer use any method or callback in the SDK anymore. If you want to use the real-time communication functions again, you must call to create a new instance.
This method can be called synchronously. You need to wait for the resource of to be released before performing other operations (for example, create a new object). Therefore, Agora recommends calling this method in the child thread to avoid blocking the main thread.
-
Besides, Agora does not recommend you calling in any callback of the SDK. Otherwise, the SDK cannot release the resources until the callbacks return results, which may result in a deadlock.
+
Agora does not recommend you calling in any callback of the SDK. Otherwise, the SDK cannot release the resources until the callbacks return results, which may result in a deadlock.
(0): (Default) Automatic scenario, where the SDK chooses the appropriate audio quality according to the user role and audio route.
(3): High-quality audio scenario, where users mainly play music.
(5): Chatroom scenario, where users need to frequently switch the user role or mute and unmute the microphone.
-
(7): Real-time chorus scenario, where users have good network conditions and require ultra-low latency.
+
(7): Real-time chorus scenario, where users have good network conditions and require ultra-low latency.
+ Before using this enumeration, you need to call to see whether the audio device supports ultra-low-latency capture and playback. To experience ultra-low latency, you need to ensure that your audio device supports ultra-low latency (isLowLatencyAudioSupported = ).
+
(8): Meeting scenario that mainly involves the human voice.
(10): AI conversation scenario, which is only applicable to scenarios where the user interacts with the conversational AI agent created by .
You can call this method either before or after joining a channel. Once you call this method to restrict the operational permission of the SDK on the audio session, the restriction takes effect when the SDK needs to change the audio session.
-
This method is only available for iOS platforms.
+
This method is only available for iOS.
This method does not restrict the operational permission of the app on the audio session.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcamerastabilizationmode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcamerastabilizationmode.dita
index 94cdc796903..1cca9080864 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setcamerastabilizationmode.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcamerastabilizationmode.dita
@@ -2,7 +2,7 @@
- Set the camera stabilization mode.
+ Sets the camera stabilization mode.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita
index 62e5a556e03..13f08a0122c 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita
@@ -2,7 +2,7 @@
- Set the user role and the audience latency level in a live streaming scenario.
+ Sets the user role and the audience latency level in a live streaming scenario.
@@ -34,7 +34,8 @@
By default,the SDK sets the user role as audience. You can call this method to set the user role as host. The user role (roles) determines the users' permissions at the SDK level, including whether they can publish audio and video streams in a channel.
-
The difference between this method and is that, this method supports setting the audienceLatencyLevel. audienceLatencyLevel needs to be used together with role to determine the level of service that users can enjoy within their permissions. For example, an audience member can choose to receive remote streams with low latency or ultra-low latency. Latency of different levels differs in billing. See .
+
The difference between this method and is that, this method supports setting the audienceLatencyLevel. audienceLatencyLevel needs to be used together with role to determine the level of service that users can enjoy within their permissions. For example, an audience member can choose to receive remote streams with low latency or ultra-low latency.
+
Latency of different levels differs in billing. See .
For the default audio route in different scenarios, see .
This method is for Android and iOS only.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setfaceshapeareaoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setfaceshapeareaoptions.dita
index 09c93624b38..dcebd43c18c 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setfaceshapeareaoptions.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setfaceshapeareaoptions.dita
@@ -40,9 +40,9 @@
v4.5.0
-
If the preset beauty effects implemented in the method do not meet expectations, you can use this method to set beauty area options, individually fine-tune each part of the face, and achieve a more refined beauty effect. See .
+
If the preset beauty effects implemented in the method do not meet expectations, you can use this method to set beauty area options, individually fine-tune each part of the face, and achieve a more refined beauty effect. See .
Both this methods and can be used to set beauty effects options, the difference is that this method supports specifying the media source to apply the beauty effects.
-
+ Call timing
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setfaceshapeareaoptions2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setfaceshapeareaoptions2.dita
index 4e9da5eac1e..d3c00beb630 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setfaceshapeareaoptions2.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setfaceshapeareaoptions2.dita
@@ -2,7 +2,7 @@
- Set the options for beauty enhancement facial areas.
+ Sets the options for beauty enhancement facial areas.
@@ -30,8 +30,8 @@
v4.5.0
-
If the preset beauty effects implemented in the method do not meet expectations, you can use this method to set beauty area options, individually fine-tune each part of the face, and achieve a more refined beauty effect. See .
-
+
If the preset beauty effects implemented in the method do not meet expectations, you can use this method to set beauty area options, individually fine-tune each part of the face, and achieve a more refined beauty effect. See .
Calling this method allows for modifying various parts of the face, achieving slimming, enlarging eyes, slimming nose, and other minor cosmetic effects all at once using preset parameters, supporting fine-tuning the overall modification intensity. See .
+
Calling this method allows for modifying various parts of the face, achieving slimming, enlarging eyes, slimming nose, and other minor cosmetic effects all at once using preset parameters, supporting fine-tuning the overall modification intensity. See .
Both this methods and can be used to set beauty effects options, the difference is that this method supports specifying the media source to apply the beauty effects.
- The beauty filter is a value-added service, please refer to for billing details.
+ The beauty filter is a value-added service, please refer to for billing details.Call timing
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setfaceshapebeautyoptions2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setfaceshapebeautyoptions2.dita
index c6d9b2e9588..d8367f8eb7e 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setfaceshapebeautyoptions2.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setfaceshapebeautyoptions2.dita
@@ -30,8 +30,8 @@
v4.5.0
-
Calling this method allows for adjusting specific parts of the face, achieving effects such as slimming the face, enlarging the eyes, and slimming the nose through minor cosmetic procedures. See .
-
+
Calling this method allows for adjusting specific parts of the face, achieving effects such as slimming the face, enlarging the eyes, and slimming the nose through minor cosmetic procedures. See .
+
@@ -48,10 +48,6 @@
-
-
-
-
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita
index 5a1b4984257..7350f69e38f 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita
@@ -40,7 +40,14 @@
preset
- The preset headphone equalization effect. See .
+ The preset headphone equalization effect. See .
+ The preset headphone equalization effect:
+
+
: The headphone equalizer is disabled, and the original audio is heard.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceformant.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceformant.dita
index d71228e451e..066876661dd 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceformant.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceformant.dita
@@ -2,7 +2,7 @@
- Set the formant ratio to change the timbre of human voice.
+ Sets the formant ratio to change the timbre of human voice.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setmixedaudioframeparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setmixedaudioframeparameters.dita
index 76199cd730e..bce797f3f96 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setmixedaudioframeparameters.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setmixedaudioframeparameters.dita
@@ -2,7 +2,7 @@
- Set the format of the raw audio data after mixing for audio capture and playback.
+ Sets the format of the raw audio data after mixing for audio capture and playback.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframebeforemixingparameters1.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframebeforemixingparameters1.dita
index 0500309fdbc..464b374df81 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframebeforemixingparameters1.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframebeforemixingparameters1.dita
@@ -2,7 +2,7 @@
- Set the format of audio data in the callback.
+ Sets the format of audio data in the callback.
@@ -13,7 +13,8 @@
- public abstract int setPlaybackAudioFrameBeforeMixingParameters(int sampleRate, int channel, int samplesPerCall);
+ public abstract int setPlaybackAudioFrameBeforeMixingParameters(
+ int sampleRate, int channel, int samplesPerCall);- (int)setPlaybackAudioFrameBeforeMixingParametersWithSampleRate:(NSInteger)sampleRate channel:(NSInteger)channel samplesPerCall:(NSInteger)samplesPerCall NS_SWIFT_NAME(setPlaybackAudioFrameBeforeMixingParametersWithSampleRate(_:channel:samplesPerCall:));virtual int setPlaybackAudioFrameBeforeMixingParameters(int sampleRate, int channel, int samplesPerCall) = 0;
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode.dita
index 3a5e84acb0a..675b30a5657 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode.dita
@@ -13,7 +13,7 @@
- public abstract int setRemoteRenderMode(int userId, int renderMode);
+ public abstract int setRemoteRenderMode(int uid, int renderMode);public abstract setRemoteRenderMode(uid: number, renderMode: number, mirrorMode: number): number;- (int)setRemoteRenderMode:(NSUInteger)uid
mode:(AgoraVideoRenderMode) mode;
@@ -38,7 +38,8 @@
Parameters
- userId
+ userId
+ uidThe user ID of the remote user.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita
index 448c3459d30..ce12973b2c2 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita
@@ -13,12 +13,12 @@
- public abstract int setRemoteRenderMode(int userId, int renderMode, int mirrorMode);
+ public abstract int setRemoteRenderMode(int uid, int renderMode, int mirrorMode);public abstract setRemoteRenderMode(uid: number, renderMode: number, mirrorMode: number): number;- (int)setRemoteRenderMode:(NSUInteger)uid
mode:(AgoraVideoRenderMode)mode
mirror:(AgoraVideoMirrorMode)mirror;
- virtual int setRemoteRenderMode(uid_t userId, RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode) = 0;
+ virtual int setRemoteRenderMode(uid_t uid, media::base::RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode) = 0;UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int SetRemoteRenderMode(int64 uid, ERENDER_MODE_TYPE renderMode, EVIDEO_MIRROR_MODE_TYPE mirrorMode);abstract setRemoteRenderMode(
@@ -50,8 +50,8 @@
Parameters
- userId
- uid
+ userId
+ uidThe user ID of the remote user.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideosubscriptionoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideosubscriptionoptions.dita
index dd6c296a7ef..966530329c8 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideosubscriptionoptions.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideosubscriptionoptions.dita
@@ -39,7 +39,8 @@
If the observer is registered, the default is to subscribe to both raw data and encoded data.
If the observer is registered, the default is to subscribe only to the encoded data.
If both types of observers are registered, the default behavior follows the last registered video observer. For example, if the last registered observer is the observer, the default is to subscribe to both raw data and encoded data.
- If you want to modify the default behavior, or set different subscription options for different uids, you can call this method to set it. For detailed implementation steps, please refer to .
+ If you want to modify the default behavior, or set different subscription options for different uids, you can call this method to set it.
+
For detailed implementation steps, please refer to .
Parameters
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioblacklist.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioblacklist.dita
index 27ae1d3df3c..4b51eb19cad 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioblacklist.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioblacklist.dita
@@ -2,7 +2,7 @@
- Set the blocklist of subscriptions for audio streams.
+ Sets the blocklist of subscriptions for audio streams.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioblocklist.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioblocklist.dita
index 402d8b9a969..199a1dc9604 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioblocklist.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioblocklist.dita
@@ -2,7 +2,7 @@
- Set the blocklist of subscriptions for audio streams.
+ Sets the blocklist of subscriptions for audio streams.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoallowlist.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoallowlist.dita
index 8b52233149b..bd82cc9c440 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoallowlist.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoallowlist.dita
@@ -2,7 +2,7 @@
- Set the allowlist of subscriptions for video streams.
+ Sets the allowlist of subscriptions for video streams.
@@ -47,6 +47,7 @@
uidList
+ allowlist
The user ID list of users that you want to subscribe to.
If you want to specify the video streams of a user for subscription, add the user ID of that user in this list. If you want to remove a user from the allowlist, you need to call the method to update the user ID list; this means you only add the uid of users that you want to subscribe to in the new user ID list.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoblacklist.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoblacklist.dita
index d8e82b67096..65612a42462 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoblacklist.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoblacklist.dita
@@ -2,7 +2,7 @@
- Set the bocklist of subscriptions for video streams.
+ Sets the bocklist of subscriptions for video streams.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoblocklist.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoblocklist.dita
index 334a09a876e..ded6744ecea 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoblocklist.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoblocklist.dita
@@ -2,7 +2,7 @@
- Set the blocklist of subscriptions for video streams.
+ Sets the blocklist of subscriptions for video streams.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideowhitelist.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideowhitelist.dita
index 6ca54fe4015..2fb1d840a92 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideowhitelist.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideowhitelist.dita
@@ -2,7 +2,7 @@
- Set the allowlist of subscriptions for video streams.
+ Sets the allowlist of subscriptions for video streams.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoprofile2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoprofile2.dita
index c95392f28fd..7c36acbdb9f 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoprofile2.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoprofile2.dita
@@ -6,7 +6,7 @@
-
+
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita
index 2ace638bdce..8fad5fbdf79 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita
@@ -26,7 +26,8 @@
-
Call this method to set a preset voice beautifier effect for the local user who sends an audio stream. After setting a voice beautifier effect, all users in the channel can hear the effect. You can set different voice beautifier effects for different scenarios. The applicable scenarios for each voice-changing effect can be referred to .
+
Call this method to set a preset voice beautifier effect for the local user who sends an audio stream. After setting a voice beautifier effect, all users in the channel can hear the effect. You can set different voice beautifier effects for different scenarios.
+
The applicable scenarios for each voice-changing effect can be referred to .
After successfully getting the object, you can all this method to enable the recoridng of the local audio and video.
-
This method can record the audio captured by the local microphone and encoded in AAC format and the video captured by the local camera and encoded by the SDK. The SDK can generate a recording file only when it detects the recordable audio and video streams; when there are no audio and video streams to be recorded or the audio and video streams are interrupted for more than five seconds, the SDK stops recording and triggers the (, ) callback.
+
This method can record the audio captured by the local microphone and encoded in AAC format and the video captured by the local camera and encoded by the SDK. The SDK can generate a recording file only when it detects the recordable audio and video streams; when there are no audio and video streams to be recorded or the audio and video streams are interrupted for more than five seconds, the SDK stops recording and triggers the (, ) callback.
Call this method after joining a channel.Parameters
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita
index d2192ab82a6..abe3fb3aa11 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita
@@ -38,7 +38,7 @@
Applicable scenarios
-
In the screen sharing scenario, you need to call this method to start capturing the screen video stream. For implementation guidance of screen sharing, please refer to .
+
In the screen sharing scenario, you need to call this method to start capturing the screen video stream. For implementation guidance of screen sharing, please refer to .
In the screen sharing scenario, you need to call this method to start capturing the screen video stream. For implementation guidance of screen sharing, please refer to .
+
In the screen sharing scenario, you need to call this method to start capturing the screen video stream. For implementation guidance of screen sharing, please refer to .
Call timing
@@ -68,9 +68,12 @@
The display ID of the screen to be shared.For the Windows platform, if you need to simultaneously share two screens (main screen and secondary screen), you can set displayId to -1 when calling this method.
-
+ regionRect
- (Optional) Sets the relative location of the region to the screen. Pass in nil to share the entire screen. See . It consists of the following parameters:
+ (Optional) Sets the relative location of the region to the screen. Pass in nil to share the entire screen.
+ See .
+ It consists of the following parameters:
+
x: The horizontal offset from the top-left corner.
y: The vertical offset from the top-left corner.
width: The width of the region.
@@ -95,4 +98,4 @@
-
\ No newline at end of file
+
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita
index 081cb39f01b..9009644b4df 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita
@@ -168,7 +168,7 @@
Applicable scenarios
-
In the screen sharing scenario, you need to call this method to start capturing the screen video stream. For implementation guidance of screen sharing, please refer to .
+
In the screen sharing scenario, you need to call this method to start capturing the screen video stream. For implementation guidance of screen sharing, please refer to .
- public abstract UserInfo getUserInfoByUid(int uid, String channelId, String localUserAccount);
+ public abstract int getUserInfoByUidEx(int uid, UserInfo userInfo, RtcConnection connection);
- - (int)getUserInfoWithUserId:(NSUInteger)uid
- userInfo:(AgoraUserInfo *_Nullable* _Nullable)userInfo
- channelId:(NSString* _Nonnull)channelId
- localUserAccount:(NSString* _Nonnull)localUserAccount;
+ - (AgoraUserInfo* _Nullable)getUserInfoByUidEx:(NSUInteger)uid
+ connection:(AgoraRtcConnection * _Nonnull)connection
+ withError:(AgoraErrorCode* _Nullable)error NS_SWIFT_NAME(getUserInfo(byUidEx:connection:withError:));
@@ -37,33 +36,27 @@
uidThe user ID.
-
+ userInfoThe object that identifies the user information.
Input value: A object.
Output: A object that contains the user account and user ID of the user.
-
- channelId
-
-
-
+
+ error
+ Error code.
-
- localUserAccount
- The user account of the local user.
+
+
+
Returns
-
-
0: Success.
-
< 0: Failure.
-
-
+
A object, if the method call succeeds.
, if the method call fails.
-
\ No newline at end of file
+
diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_getuserinfobyuseraccountex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_getuserinfobyuseraccountex.dita
index a76248dedee..32a1792a8e4 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengineex_getuserinfobyuseraccountex.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengineex_getuserinfobyuseraccountex.dita
@@ -13,12 +13,11 @@
- public abstract UserInfo getUserInfoByUserAccount(String userAccount, String channelId, String localUserAccount);
+ public abstract int getUserInfoByUserAccountEx(String userAccount, UserInfo userInfo, RtcConnection connection);
- - (int)getUserInfoWithUserAccount:(NSString * _Nonnull)userAccount
- userInfo:(AgoraUserInfo *_Nullable* _Nullable)userInfo
- channelId:(NSString* _Nonnull)channelId
- localUserAccount:(NSString* _Nonnull)localUserAccount;
+ - (AgoraUserInfo* _Nullable)getUserInfoByUserAccountEx:(NSString* _Nonnull)userAccount
+ connection:(AgoraRtcConnection * _Nonnull)connection
+ withError:(AgoraErrorCode* _Nullable)error NS_SWIFT_NAME(getUserInfo(byUserAccountEx:connection:withError:));
@@ -37,15 +36,15 @@
userAccountThe user account.
-
+
-
-
-
+
+
+
-
+
diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_playeffectex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_playeffectex.dita
index e8c0284d436..5f5cd5a91cb 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengineex_playeffectex.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengineex_playeffectex.dita
@@ -2,7 +2,7 @@
- Play a specified sound effect in a channel.
+ Plays a specified sound effect in a channel.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setremoterendermodeex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setremoterendermodeex.dita
index d94d4cbf565..e4c54901c2f 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengineex_setremoterendermodeex.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setremoterendermodeex.dita
@@ -60,7 +60,8 @@
The user ID of the remote user.
- renderMode
+ renderMode
+ mode
The video display mode of the remote user. See .
The video display mode of the remote user:
@@ -69,7 +70,8 @@
- mirrorMode
+ mirrorMode
+ mirror
The mirror mode of the remote user view. See .
diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevideosubscriptionoptionsex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevideosubscriptionoptionsex.dita
index 561f198ba36..7aaddf0eead 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevideosubscriptionoptionsex.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevideosubscriptionoptionsex.dita
@@ -2,7 +2,7 @@
- Options for subscribing to remote video streams.
+ Sets options for subscribing to remote video streams.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_stoprtmpstreamex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_stoprtmpstreamex.dita
index c64174bc9da..b639883ef82 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengineex_stoprtmpstreamex.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengineex_stoprtmpstreamex.dita
@@ -40,6 +40,10 @@
+
+
+
+
- public abstract boolean onPlaybackAudioFrame(int type, int samplesPerChannel, int bytesPerSample,
- int channels, int samplesPerSec, ByteBuffer buffer, long renderTimeMs, int avsync_type);
-
+ public abstract boolean onPlaybackAudioFrame(String channelId, int type, int samplesPerChannel,
+ int bytesPerSample, int channels, int samplesPerSec, ByteBuffer buffer, long renderTimeMs,
+ int avsync_type);onPlaybackAudioFrame?: (channelId: string, type: number, samplesPerChannel: number, bytesPerSample: number, channels: number, samplesPerSec: number, buffer: ArrayBuffer, renderTimeMs: number, avsync_type: number) => boolean;- (BOOL)onPlaybackAudioFrame:(AgoraAudioFrame* _Nonnull)frame;virtual bool onPlaybackAudioFrame(const char* channelId, AudioFrame& audioFrame) = 0;
diff --git a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerplaybackstats.dita b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerplaybackstats.dita
index 2c3e115e291..e8e5fabbea8 100644
--- a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerplaybackstats.dita
+++ b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerplaybackstats.dita
@@ -2,7 +2,7 @@
- The statistics of the media file being played.
+ Reports the statistics of the media file being played.
diff --git a/en-US/dita/RTC-NG/API/callback_imediarecorderobserver_onrecorderstatechanged.dita b/en-US/dita/RTC-NG/API/callback_imediarecorderobserver_onrecorderstatechanged.dita
index e2828c08668..cd1e72abed1 100644
--- a/en-US/dita/RTC-NG/API/callback_imediarecorderobserver_onrecorderstatechanged.dita
+++ b/en-US/dita/RTC-NG/API/callback_imediarecorderobserver_onrecorderstatechanged.dita
@@ -67,10 +67,10 @@
The reason for the state change. See .The reason for the state change.
(0): No error.
-
(1): The SDK fails to write the recorded data to a file.
-
(2): The SDK does not detect any audio and video streams, or audio and video streams are interrupted for more than five seconds during recording.
-
(3): The recording duration exceeds the upper limit.
-
(4): The configurations of recording change.
+
(1): The SDK fails to write the recorded data to a file.
+
(2): The SDK does not detect any audio and video streams, or audio and video streams are interrupted for more than five seconds during recording.
+
(3): The recording duration exceeds the upper limit.
- uid
+ uidremoteUid
- userId
+ userIdThe user ID of the remote user sending the video stream.
diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onproxyconnected.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onproxyconnected.dita
index 51aedb5eb79..d339f11249f 100644
--- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onproxyconnected.dita
+++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onproxyconnected.dita
@@ -51,6 +51,10 @@
+
+
+
+ channelThe channel name.
diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostatechanged.dita
index cfad3c71aba..b8af2bbd641 100644
--- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostatechanged.dita
+++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostatechanged.dita
@@ -84,7 +84,7 @@
reasonThe reason of the remote audio state change. See .
- Remote audio state reasons.
+ The reason of the remote audio state change.
(0): The SDK reports this reason when the audio state changes.
The reason for the remote video state change. See .
-
Remote audio state reasons:
+
The reason for the remote video state change:
(0): Internal reasons.
(1): Network congestion.
(2): Network recovery.
diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrenewtokenresult.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrenewtokenresult.dita
index 9d45cfbe130..b04e76ca938 100644
--- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrenewtokenresult.dita
+++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrenewtokenresult.dita
@@ -2,7 +2,7 @@
- Callback for call result.
+ Callback for call result.
diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrhythmplayerstatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrhythmplayerstatechanged.dita
index a976f6f22c4..9381c23104e 100644
--- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrhythmplayerstatechanged.dita
+++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrhythmplayerstatechanged.dita
@@ -63,7 +63,7 @@
- errorCode
+ reasonFor the error codes and error messages related to virtual metronome errors, see .Error codes and error messages for virtual metronome errors.
(0): The beat files are played normally without errors.
public class AdvancedAudioOptions {
- public enum AgoraAudioProcessChannels {
+ public enum AudioProcessingChannelsEnum {
AGORA_AUDIO_MONO_PROCESSING(1),
AGORA_AUDIO_STEREO_PROCESSING(2);
private int value;
- private AgoraAudioProcessChannels(int v) {
+ private AudioProcessingChannelsEnum(int v) {
value = v;
}
public int getValue() {
return this.value;
}
}
- public AgoraAudioProcessChannels audioProcessingChannels;
+ public AudioProcessingChannelsEnum audioProcessingChannels;
- public AdvancedAudioOptions(AgoraAudioProcessChannels channels) {
+ public AdvancedAudioOptions(AudioProcessingChannelsEnum channels) {
audioProcessingChannels = channels;
}
public AdvancedAudioOptions() {
- audioProcessingChannels = AgoraAudioProcessChannels.AGORA_AUDIO_MONO_PROCESSING;
+ audioProcessingChannels = AudioProcessingChannelsEnum.AGORA_AUDIO_MONO_PROCESSING;
}
}
@@ -33,8 +33,10 @@
@property(assign, nonatomic) AgoraAudioProcessChannels audioProcessingChannels;
@end
struct AdvancedAudioOptions {
- AUDIO_PROCESSING_CHANNELS audioProcessingChannels;
- AdvancedAudioOptions(): audioProcessingChannels(AUDIO_PROCESSING_MONO) {}
+ Optional<int> audioProcessingChannels;
+
+ AdvancedAudioOptions() {}
+ ~AdvancedAudioOptions() {}
};USTRUCT(BlueprintType)
struct FAdvancedAudioOptions
@@ -87,11 +89,17 @@ public:
audioProcessingChannels
- The number of channels for audio preprocessing. See .
+ The number of channels for audio preprocessing. See .The number of channels for audio preprocessing.
(1): (Default) Mono.
(2): Stereo.
+ The number of channels for audio preprocessing:
+
+
1: Mono.
+
2: Stereo.
+
+
diff --git a/en-US/dita/RTC-NG/API/class_agorartcmediaplayervideoframedelegate.dita b/en-US/dita/RTC-NG/API/class_agorartcmediaplayervideoframedelegate.dita
new file mode 100644
index 00000000000..ba3d912ea95
--- /dev/null
+++ b/en-US/dita/RTC-NG/API/class_agorartcmediaplayervideoframedelegate.dita
@@ -0,0 +1,11 @@
+
+
+
+
+ The observer for the video played by the media player.
+
+
+
You can call to register or unregister the video observer of the media player. After successful registration, you can get detailed information about the video frame through the callbacks under .
+
+
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/class_audioencodedframeobserverconfig.dita b/en-US/dita/RTC-NG/API/class_audioencodedframeobserverconfig.dita
index 94f523b440d..e37d28b2e15 100644
--- a/en-US/dita/RTC-NG/API/class_audioencodedframeobserverconfig.dita
+++ b/en-US/dita/RTC-NG/API/class_audioencodedframeobserverconfig.dita
@@ -87,8 +87,8 @@ struct FAudioEncodedFrameObserverConfig
postionType
-
Audio profile. See .
-
Audio profile:
+
Audio observer position. See .
+
Audio observer position:
(1): Only encode the audio of the local user.
(2): Only encode the audio of all remote users.
(3): Records the mixed audio of the local and all remote users.
- avsyncTypeavsync_type
+ avsyncTypeavSyncTypeavsync_typeReserved for future use.
diff --git a/en-US/dita/RTC-NG/API/class_audiotrackconfig.dita b/en-US/dita/RTC-NG/API/class_audiotrackconfig.dita
index f2e2d55deb3..d09db45131f 100644
--- a/en-US/dita/RTC-NG/API/class_audiotrackconfig.dita
+++ b/en-US/dita/RTC-NG/API/class_audiotrackconfig.dita
@@ -89,7 +89,7 @@ struct FAudioTrackConfig
enableAudioProcessingWhether to enable audio processing module:
-
Enable the audio processing module to apply the Automatic Echo Cancellation (AEC), Automatic Noise Suppression (ANS), and Automatic Gain Control (AGC) effects.
+
: Enable the audio processing module to apply the Automatic Echo Cancellation (AEC), Automatic Noise Suppression (ANS), and Automatic Gain Control (AGC) effects.
: (Default) Do not enable the audio processing module.
This parameter only takes effect on in custom audio capturing.
diff --git a/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita b/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita
index 271a1008927..7b327c3f81f 100644
--- a/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita
+++ b/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita
@@ -10,7 +10,7 @@
public enum CAMERA_DIRECTION {
CAMERA_REAR(0),
CAMERA_FRONT(1),
- CAMERA_EXTRA(2);
+ CAMERA_EXTRAL(2);
private int value;
diff --git a/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita b/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita
index 7b50d201dcb..425b4be321c 100644
--- a/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita
+++ b/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita
@@ -5,7 +5,7 @@
The channel media options.
-
+
public class ChannelMediaOptions {
public Boolean publishCameraTrack;
public Boolean publishSecondaryCameraTrack;
@@ -707,745 +707,6 @@ class ChannelMediaOptions {
Map<String, dynamic> toJson() => _$ChannelMediaOptionsToJson(this);
}
Agora supports publishing multiple audio streams and one video stream at the same time and in the same . For example, publishMicrophoneTrack, publishCustomAudioTrack, and publishMediaPlayerAudioTrack can be set as at the same time, but only one of publishCameraTrack, publishScreenCaptureVideo, publishScreenTrack, publishCustomVideoTrack, or publishEncodedVideoTrack can be set as .Agora recommends that you set member parameter values yourself according to your business scenario, otherwise the SDK will automatically assign values to member parameters.
@@ -1683,7 +944,7 @@ public:
token
-
(Optional) The token generated on your server for authentication. See .
+
(Optional) The token generated on your server for authentication.
This parameter takes effect only when calling or .
@@ -1735,39 +996,22 @@ public:
: Dsiable multiple transmisssion path.
-
-
Available since v4.6.0.
-
Permissions and system requirements: Android: Android 7.0 or higher (API level 24 or higher), and the ACCESS_NETWORK_STATE and CHANGE_NETWORK_STATE permissions are required. iOS: iOS 12.0 or later. macOS: 10.14 or later. Windows: Windows Vista or higher.
-
-
+
Permissions and system requirements: Android: Android 7.0 or higher (API level 24 or higher), and the ACCESS_NETWORK_STATE and CHANGE_NETWORK_STATE permissions are required. iOS: iOS 12.0 or later. macOS: 10.14 or later. Windows: Windows Vista or higher.
uplinkMultipathMode
- Uplink transmission mode. See .
-
-
Available since v4.6.0.
-
When using this parameter, make sure that enableMultipath is set to .
-
+ Uplink transmission mode. See .When using this parameter, make sure that enableMultipath is set to .
downlinkMultipathMode
- Downlink transmission mode. See .
-
-
Available since v4.6.0.
-
When using this parameter, make sure that enableMultipath is set to .
-
-
+ Downlink transmission mode. See .When using this parameter, make sure that enableMultipath is set to .preferMultipathType
- Preferred type of transmission path. See .
-
-
Available since v4.6.0.
-
When using this parameter, make sure that enableMultipath is set to , and is set to dynamic.
-
+ Preferred type of transmission path. See .When using this parameter, make sure that enableMultipath is set to .
diff --git a/en-US/dita/RTC-NG/API/class_codeccapinfo.dita b/en-US/dita/RTC-NG/API/class_codeccapinfo.dita
index 49f20159254..7d2f8778037 100644
--- a/en-US/dita/RTC-NG/API/class_codeccapinfo.dita
+++ b/en-US/dita/RTC-NG/API/class_codeccapinfo.dita
@@ -136,7 +136,8 @@ class CodecCapInfo {
- codecLevels
+ codecLevels
+ codecCapLevelsCodec capability of the SDK. See .
diff --git a/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita b/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita
index 097469cf022..60921b3215b 100644
--- a/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita
+++ b/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita
@@ -206,7 +206,7 @@ class ContentInspectConfig {
- moduleCount
+ moduleCountThe number of functional modules, that is,the number of configured instances, must be the same as the number of instances configured in modules. The maximum number is 32.
diff --git a/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita b/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita
index 74782174a89..bf480b10bc4 100644
--- a/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita
+++ b/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita
@@ -2,7 +2,7 @@
- A structure used to configure the frequency of video screenshot and upload.
+ class, a structure used to configure the frequency of video screenshot and upload.
diff --git a/en-US/dita/RTC-NG/API/class_externalvideoframe.dita b/en-US/dita/RTC-NG/API/class_externalvideoframe.dita
index 385cb2208a5..fa35a5cc0bd 100644
--- a/en-US/dita/RTC-NG/API/class_externalvideoframe.dita
+++ b/en-US/dita/RTC-NG/API/class_externalvideoframe.dita
@@ -454,8 +454,8 @@ class ExternalVideoFrame {
d3d11Texture2dThis parameter only applies to video data in Windows Texture format. It represents a pointer to an object of type ID3D11Texture2D, which is used by a video frame.
-
- alphaBuffer
+
+ alphaBufferalphaBuf
The alpha channel data output by using portrait segmentation algorithm. This data matches the size of the video frame, with each pixel value ranging from [0,255], where 0 represents the background and 255 represents the foreground (portrait).
@@ -463,9 +463,9 @@ class ExternalVideoFrame {
In custom video rendering scenarios, ensure that both the video frame and alphaBuffer are of the Full Range type; other types may cause abnormal alpha data rendering.
-
+ fillAlphaBuffer
- fillAlphaData
+ fillAlphaDataThis parameter only applies to video data in BGRA or RGBA format. Whether to extract the alpha channel data from the video frame and automatically fill it into alphaBuffer:
:Extract and fill the alpha channel data.
: (Default) Do not extract and fill the Alpha channel data.
@@ -512,8 +512,9 @@ class ExternalVideoFrame {
Raw data related parameter. The clockwise rotation of the video frame. You can set the rotation angle as 0, 90, 180, or 270. The default value is 0.
- timestamp
+ timestamptime
+ timeStampTimestamp (ms) of the incoming video frame. An incorrect timestamp results in frame loss or unsynchronized audio and video.
diff --git a/en-US/dita/RTC-NG/API/class_livetranscoding.dita b/en-US/dita/RTC-NG/API/class_livetranscoding.dita
index 6db658b06b6..24e33429354 100644
--- a/en-US/dita/RTC-NG/API/class_livetranscoding.dita
+++ b/en-US/dita/RTC-NG/API/class_livetranscoding.dita
@@ -775,7 +775,7 @@ public:
- videoFrameRate
+ videoFramerate
Frame rate (fps) of the output video stream set for Media Push. The default value is 15. The value range is (0,30].
The Agora server adjusts any value over 30 to 30.
@@ -906,7 +906,7 @@ public:
The number of audio channels for Media Push. Agora recommends choosing 1 (mono), or 2 (stereo) audio channels. Special players are required if you choose 3, 4, or 5.
-
1: (Default) Mono
+
1: (Default) Mono.
2: Stereo.
3: Three audio channels.
4: Four audio channels.
diff --git a/en-US/dita/RTC-NG/API/class_localaudiomixerconfiguration.dita b/en-US/dita/RTC-NG/API/class_localaudiomixerconfiguration.dita
index 70491d5be21..18f298f06d5 100644
--- a/en-US/dita/RTC-NG/API/class_localaudiomixerconfiguration.dita
+++ b/en-US/dita/RTC-NG/API/class_localaudiomixerconfiguration.dita
@@ -2,7 +2,7 @@
- The configurations for mixing the lcoal audio.
+ The configurations for mixing the local audio.
(0): (Default) Promotes video quality during low-light enhancement. It processes the brightness, details, and noise of the video image. The performance consumption is moderate, the processing speed is moderate, and the overall video quality is optimal.
(1): Promotes performance during low-light enhancement. It processes the brightness and details of the video image. The processing speed is faster.
(0): (Default) Automatic mode. The SDK automatically enables or disables the low-light enhancement feature according to the ambient light to compensate for the lighting level or prevent overexposure, as necessary.
(1): Manual mode. Users need to enable or disable the low-light enhancement feature manually.
diff --git a/en-US/dita/RTC-NG/API/class_mediasource.dita b/en-US/dita/RTC-NG/API/class_mediasource.dita
index 729c33c15cc..ac862e96356 100644
--- a/en-US/dita/RTC-NG/API/class_mediasource.dita
+++ b/en-US/dita/RTC-NG/API/class_mediasource.dita
@@ -238,7 +238,7 @@ public:
enableCacheWhether to cache the media file when it is being played:
-
:Enables caching.
+
: Enables caching.
: (Default) Disables caching.
diff --git a/en-US/dita/RTC-NG/API/class_playerstreaminfo.dita b/en-US/dita/RTC-NG/API/class_playerstreaminfo.dita
index 022d3b4c653..e98a58127c0 100644
--- a/en-US/dita/RTC-NG/API/class_playerstreaminfo.dita
+++ b/en-US/dita/RTC-NG/API/class_playerstreaminfo.dita
@@ -316,7 +316,7 @@ public:
This parameter only takes effect for video streams, and indicates the video frame rate (fps).
- videoBitrate
+ videoBitRateThis parameter only takes effect for video streams, and indicates the video bitrate (bps).
diff --git a/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita b/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita
index 2b317a253aa..9ff07ad61cc 100644
--- a/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita
+++ b/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita
@@ -41,7 +41,6 @@
@property (strong, nonatomic) AgoraLogConfig * _Nullable logConfig;
@property (assign, nonatomic) BOOL domainLimit;
@property (assign, nonatomic) BOOL autoRegisterAgoraExtensions;
-@property (copy, nonatomic) NSArray<id<AgoraMediaFilterExtensionDelegate>>* _Nullable mediaFilterExtensions;
@property (weak, nonatomic) id<AgoraMediaFilterEventDelegate> _Nullable eventDelegate;
@end
struct RtcEngineContext {
@@ -295,10 +294,6 @@ class RtcEngineContext {
eventDelegateThe instance.
-
- mediaFilterExtensions
- The instance.
- mDomainLimitdomainLimit
diff --git a/en-US/dita/RTC-NG/API/class_rtcstats.dita b/en-US/dita/RTC-NG/API/class_rtcstats.dita
index afaace6ee53..772d62c9bf7 100644
--- a/en-US/dita/RTC-NG/API/class_rtcstats.dita
+++ b/en-US/dita/RTC-NG/API/class_rtcstats.dita
@@ -103,8 +103,8 @@
@property(assign, nonatomic) double memoryTotalUsageRatio;
@property(assign, nonatomic) NSInteger memoryAppUsageInKbytes;
@property(assign, nonatomic) NSInteger connectTimeMs;
-@property(assign, nonatomic) NSUInteger txKBitRate;
-@property(assign, nonatomic) NSUInteger rxKBitRate;
+@property(assign, nonatomic) NSUInteger txKBitrate;
+@property(assign, nonatomic) NSUInteger rxKBitrate;
@property(assign, nonatomic) NSInteger txPacketLossRate;
@property(assign, nonatomic) NSInteger rxPacketLossRate;
@end
@@ -653,27 +653,33 @@ public:
The total number of video bytes received, represented by an aggregate value.
- txKBitRate
+ txKBitRate
+ txKBitrateThe actual bitrate (Kbps) while sending the local video stream.
- rxKBitRate
+ rxKBitRate
+ rxKBitrateThe receiving bitrate (Kbps).
- rxAudioKBitRate
+ rxAudioKBitRate
+ rxAudioKBitrateThe bitrate (Kbps) of receiving the audio.
- txAudioKBitRate
+ txAudioKBitRate
+ txAudioKBitrateThe bitrate (Kbps) of sending the audio packet.
- rxVideoKBitRate
+ rxVideoKBitRate
+ rxVideoKBitrateThe bitrate (Kbps) of receiving the video.
- txVideoKBitRate
+ txVideoKBitRate
+ txVideoKBitrateThe bitrate (Kbps) of sending the video.
diff --git a/en-US/dita/RTC-NG/API/class_screenvideoparameters.dita b/en-US/dita/RTC-NG/API/class_screenvideoparameters.dita
index ebefd864bfa..2d90288dc69 100644
--- a/en-US/dita/RTC-NG/API/class_screenvideoparameters.dita
+++ b/en-US/dita/RTC-NG/API/class_screenvideoparameters.dita
@@ -227,7 +227,7 @@ public:
- frameRate
+ framerateframeRateThe video encoding frame rate (fps). The default value is 15.
diff --git a/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita b/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita
index 892d4e4070c..66e4286a0c8 100644
--- a/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita
+++ b/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita
@@ -35,7 +35,7 @@
}
}
__attribute__((visibility("default"))) @interface AgoraSimulcastStreamConfig: NSObject
- @property (assign, nonatomic) int bitrate;
+ @property (assign, nonatomic) int kBitrate;
@property (assign, nonatomic) int framerate;
@property (assign, nonatomic) CGSize dimensions;
@end
@@ -118,12 +118,12 @@ public:
The video dimension. See . The default value is 50% of the high-quality video stream.
- bitrate
- kBitrate
+ bitrate
+ kBitrateVideo bitrate (Kbps). The default value is -1. This parameter does not need to be set. The SDK automatically matches the most suitable bitrate based on the video resolution and frame rate you set.
- frameRate
+ framerateThe frame rate (fps) of the local video. The default value is 5.
diff --git a/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita b/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita
index 8b3aa2f5c0a..e790c8de83e 100644
--- a/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita
+++ b/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita
@@ -73,7 +73,7 @@ struct FUserAudioSpectrumInfo {
The user ID of the remote user.
- AudioSpectrumInfo
+ audioSpectrumInfoaudioSpectrumDataspectrumData
diff --git a/en-US/dita/RTC-NG/API/class_videodenoiseroptions.dita b/en-US/dita/RTC-NG/API/class_videodenoiseroptions.dita
index f8374c3504a..668c7c85a6e 100644
--- a/en-US/dita/RTC-NG/API/class_videodenoiseroptions.dita
+++ b/en-US/dita/RTC-NG/API/class_videodenoiseroptions.dita
@@ -110,7 +110,8 @@ public:
- level
+ level
+ denoiserLevelVideo noise reduction level. See .
(0): (Default) Promotes video quality during low-light enhancement. It processes the brightness, details, and noise of the video image. The performance consumption is moderate, the processing speed is moderate, and the overall video quality is optimal.
(1): Promotes reducing performance consumption during video noise reduction. It prioritizes reducing performance consumption over video noise reduction quality. The performance consumption is lower, and the video noise reduction speed is faster. To avoid a noticeable shadowing effect (shadows trailing behind moving objects) in the processed video, Agora recommends that you use this setting when the camera is fixed.
- degradationPreference
+ degradationPreference
+ degradationPreferVideo degradation preference under limited bandwidth. See .When this parameter is set to (1) or (2), orientationMode needs to be set to (0) at the same time, otherwise the setting will not take effect.
@@ -629,7 +631,8 @@ public:
By default, the video is not mirrored.
- advanceOptions
+ advanceOptions
+ advancedVideoOptionsAdvanced options for video encoding. See .
diff --git a/en-US/dita/RTC-NG/API/class_videoframe.dita b/en-US/dita/RTC-NG/API/class_videoframe.dita
index eb075247102..d2cbeaf16fa 100644
--- a/en-US/dita/RTC-NG/API/class_videoframe.dita
+++ b/en-US/dita/RTC-NG/API/class_videoframe.dita
@@ -839,7 +839,8 @@ class VideoFrame {
The timestamp (ns) of a video frame.
- avsync_type
+ avsync_type
+ avSyncTypeavsyncTypeReserved for future use.
@@ -875,10 +876,10 @@ class VideoFrame {
colorSpace
- By default, the color space properties of video frames will apply the Full Range and BT.709 standard configurations. You can configure the settings according your needs for custom video capturing and rendering. See .
- By default, the color space properties of video frames will apply the Full Range and BT.709 standard configurations. You can configure the settings according your needs for custom video capturing and rendering. See . The methods associated with this parameter are as follows:
+ By default, the color space properties of video frames will apply the Full Range and BT.709 standard configurations. You can configure the settings according your needs for custom video capturing and rendering. See .
+ By default, the color space properties of video frames will apply the Full Range and BT.709 standard configurations. You can configure the settings according your needs for custom video capturing and rendering. See .The methods associated with this parameter are as follows:
getColorSpace: Get the color space attribute of the video frame.
setColorSpace:Set the color space attribute of the video frame.
diff --git a/en-US/dita/RTC-NG/API/class_videolayoutinfo.dita b/en-US/dita/RTC-NG/API/class_videolayoutinfo.dita
index 1f49f5e5a31..468d1c7aae9 100644
--- a/en-US/dita/RTC-NG/API/class_videolayoutinfo.dita
+++ b/en-US/dita/RTC-NG/API/class_videolayoutinfo.dita
@@ -50,7 +50,7 @@
The number of layout information in the mixed video stream.
- layoutlist
+ layoutListThe detailed layout information of a mixed video stream. See .
diff --git a/en-US/dita/RTC-NG/API/enum_audioencodingtype.dita b/en-US/dita/RTC-NG/API/enum_audioencodingtype.dita
index a834c885958..6301ec8f190 100644
--- a/en-US/dita/RTC-NG/API/enum_audioencodingtype.dita
+++ b/en-US/dita/RTC-NG/API/enum_audioencodingtype.dita
@@ -9,47 +9,47 @@
- AAC encoding format, 16000 Hz sampling rate, bass quality. A file with an audio duration of 10 minutes is approximately 1.2 MB after encoding.
+ 0x010101: AAC encoding format, 16000 Hz sampling rate, bass quality. A file with an audio duration of 10 minutes is approximately 1.2 MB after encoding.
- AAC encoding format, 16000 Hz sampling rate, medium sound quality. A file with an audio duration of 10 minutes is approximately 2 MB after encoding.
+ 0x010102: AAC encoding format, 16000 Hz sampling rate, medium sound quality. A file with an audio duration of 10 minutes is approximately 2 MB after encoding.
- AAC encoding format, 32000 Hz sampling rate, bass quality. A file with an audio duration of 10 minutes is approximately 1.2 MB after encoding.
+ 0x010201: AAC encoding format, 32000 Hz sampling rate, bass quality. A file with an audio duration of 10 minutes is approximately 1.2 MB after encoding.
- AAC encoding format, 32000 Hz sampling rate, medium sound quality. A file with an audio duration of 10 minutes is approximately 2 MB after encoding.
+ 0x010202: AAC encoding format, 32000 Hz sampling rate, medium sound quality. A file with an audio duration of 10 minutes is approximately 2 MB after encoding.
- AAC encoding format, 32000 Hz sampling rate, high sound quality. A file with an audio duration of 10 minutes is approximately 3.5 MB after encoding.
+ 0x010203: AAC encoding format, 32000 Hz sampling rate, high sound quality. A file with an audio duration of 10 minutes is approximately 3.5 MB after encoding.
- AAC encoding format, 48000 Hz sampling rate, medium sound quality. A file with an audio duration of 10 minutes is approximately 2 MB after encoding.
+ 0x010302: AAC encoding format, 48000 Hz sampling rate, medium sound quality. A file with an audio duration of 10 minutes is approximately 2 MB after encoding.
- AAC encoding format, 48000 Hz sampling rate, high sound quality. A file with an audio duration of 10 minutes is approximately 3.5 MB after encoding.
+ 0x010303: AAC encoding format, 48000 Hz sampling rate, high sound quality. A file with an audio duration of 10 minutes is approximately 3.5 MB after encoding.
- OPUS encoding format, 16000 Hz sampling rate, bass quality. A file with an audio duration of 10 minutes is approximately 2 MB after encoding.
+ 0x020101: OPUS encoding format, 16000 Hz sampling rate, bass quality. A file with an audio duration of 10 minutes is approximately 2 MB after encoding.
- OPUS encoding format, 16000 Hz sampling rate, medium sound quality. A file with an audio duration of 10 minutes is approximately 2 MB after encoding.
+ 0x020102: OPUS encoding format, 16000 Hz sampling rate, medium sound quality. A file with an audio duration of 10 minutes is approximately 2 MB after encoding.
- OPUS encoding format, 48000 Hz sampling rate, medium sound quality. A file with an audio duration of 10 minutes is approximately 2 MB after encoding.
+ 0x020302: OPUS encoding format, 48000 Hz sampling rate, medium sound quality. A file with an audio duration of 10 minutes is approximately 2 MB after encoding.
- OPUS encoding format, 48000 Hz sampling rate, high sound quality. A file with an audio duration of 10 minutes is approximately 3.5 MB after encoding.
+ 0x020303: OPUS encoding format, 48000 Hz sampling rate, high sound quality. A file with an audio duration of 10 minutes is approximately 3.5 MB after encoding.
diff --git a/en-US/dita/RTC-NG/API/enum_audioequalizationbandfrequency.dita b/en-US/dita/RTC-NG/API/enum_audioequalizationbandfrequency.dita
index 1e93c528435..0f11a928704 100644
--- a/en-US/dita/RTC-NG/API/enum_audioequalizationbandfrequency.dita
+++ b/en-US/dita/RTC-NG/API/enum_audioequalizationbandfrequency.dita
@@ -9,43 +9,43 @@
- 0: 31 Hz
+ 0: 31 Hz.
- 1: 62 Hz
+ 1: 62 Hz.
- 2: 125 Hz
+ 2: 125 Hz.
- 3: 250 Hz
+ 3: 250 Hz.
- 4: 500 Hz
+ 4: 500 Hz.
- 5: 1 kHz
+ 5: 1 kHz.
- 6: 2 kHz
+ 6: 2 kHz.
- 7: 4 kHz
+ 7: 4 kHz.
- 8: 8 kHz
+ 8: 8 kHz.
- 9: 16 kHz
+ 9: 16 kHz.
diff --git a/en-US/dita/RTC-NG/API/enum_audiosessionoperationrestriction.dita b/en-US/dita/RTC-NG/API/enum_audiosessionoperationrestriction.dita
index c2aafe9ffd6..c9122734f0f 100644
--- a/en-US/dita/RTC-NG/API/enum_audiosessionoperationrestriction.dita
+++ b/en-US/dita/RTC-NG/API/enum_audiosessionoperationrestriction.dita
@@ -9,23 +9,23 @@
- No restriction, the SDK can change the audio session.
+ 0: No restriction, the SDK can change the audio session.
- The SDK cannot change the audio session category.
+ 1: The SDK cannot change the audio session category.
- The SDK cannot change the audio session category, mode, or categoryOptions.
+ 2: The SDK cannot change the audio session category, mode, or categoryOptions.
- The SDK keeps the audio session active when the user leaves the channel, for example, to play an audio file in the background.
+ 4: The SDK keeps the audio session active when the user leaves the channel, for example, to play an audio file in the background.
- Completely restricts the operation permissions of the SDK on the audio session; the SDK cannot change the audio session.
+ 128: Completely restricts the operation permissions of the SDK on the audio session; the SDK cannot change the audio session.
diff --git a/en-US/dita/RTC-NG/API/enum_channelprofiletype.dita b/en-US/dita/RTC-NG/API/enum_channelprofiletype.dita
index 036714e1f75..1b7f83b1f74 100644
--- a/en-US/dita/RTC-NG/API/enum_channelprofiletype.dita
+++ b/en-US/dita/RTC-NG/API/enum_channelprofiletype.dita
@@ -13,11 +13,11 @@
- 1: Live streaming. Live streaming. Use this profile when there are more than two users in the channel.
+ 1: Live streaming. Use this profile when there are more than two users in the channel.
- 2: Gaming. This profile is deprecated.
+ 2: Gaming.
diff --git a/en-US/dita/RTC-NG/API/enum_connectionchangedreasontype.dita b/en-US/dita/RTC-NG/API/enum_connectionchangedreasontype.dita
index bfe30d66401..604251312db 100644
--- a/en-US/dita/RTC-NG/API/enum_connectionchangedreasontype.dita
+++ b/en-US/dita/RTC-NG/API/enum_connectionchangedreasontype.dita
@@ -54,7 +54,7 @@
- (9): The token currently being used has expired. You need to generate a new token on your server and rejoin the channel with the new token.
+ 9: The token currently being used has expired. You need to generate a new token on your server and rejoin the channel with the new token.
@@ -75,7 +75,7 @@
- (13): Client IP address changed. If you receive this code multiple times, You need to prompt the user to switch networks and try joining the channel again.
+ 13: Client IP address changed. If you receive this code multiple times, You need to prompt the user to switch networks and try joining the channel again.
diff --git a/en-US/dita/RTC-NG/API/enum_degradationpreference.dita b/en-US/dita/RTC-NG/API/enum_degradationpreference.dita
index ef2bdfe08bd..c990d779d67 100644
--- a/en-US/dita/RTC-NG/API/enum_degradationpreference.dita
+++ b/en-US/dita/RTC-NG/API/enum_degradationpreference.dita
@@ -9,7 +9,7 @@
- 0: (Default) Automatic mode. The SDK will automatically select , or based on the video scenario you set, in order to achieve the best overall quality of experience (QoE).
+ -1: (Default) Automatic mode. The SDK will automatically select , or based on the video scenario you set, in order to achieve the best overall quality of experience (QoE).
diff --git a/en-US/dita/RTC-NG/API/enum_faceshapearea.dita b/en-US/dita/RTC-NG/API/enum_faceshapearea.dita
index 0440dd73cf9..060edbce232 100644
--- a/en-US/dita/RTC-NG/API/enum_faceshapearea.dita
+++ b/en-US/dita/RTC-NG/API/enum_faceshapearea.dita
@@ -55,7 +55,7 @@
- (107): Adjustment of the mandible. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.v.4.6.0.
+ (107): Adjustment of the mandible. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.(107): Adjustment of the mandible. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.
@@ -70,31 +70,31 @@
- (201): Eye distance adjustment. The range is [-100, 100], with a default value of 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.v.4.6.0.
+ (201): Eye distance adjustment. The range is [-100, 100], with a default value of 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.
- (202): Eye position adjustment. The range is [-100, 100], with a default value of 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.v.4.6.0.
+ (202): Eye position adjustment. The range is [-100, 100], with a default value of 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.(202): Eye position adjustment. The range is [-100, 100], with a default value of 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.
- (203): Lower eyelid adjustment.(203): Lower eyelid adjustment. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.v.4.6.0.
+ (203): Lower eyelid adjustment.(203): Lower eyelid adjustment. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.(203): Lower eyelid adjustment. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.
- (204): Pupil size adjustment. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.v.4.6.0.
+ (204): Pupil size adjustment. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.(204): Pupil size adjustment. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.
- (205): Inner eye corner adjustment. The range is [-100, 100], with a default value of 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.v.4.6.0.
+ (205): Inner eye corner adjustment. The range is [-100, 100], with a default value of 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.(205): Inner eye corner adjustment. The range is [-100, 100], with a default value of 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.
- (206): Outer eye corner adjustment. The range is [-100, 100], with a default value of 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.v.4.6.0.
+ (206): Outer eye corner adjustment. The range is [-100, 100], with a default value of 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.(206): Outer eye corner adjustment. The range is [-100, 100], with a default value of 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.
@@ -103,56 +103,56 @@
- (301): Nose width, used to achieve a slimmer nose effect. The range is [0, 100], with a default value of 0. The larger the value, the more noticiable the effect of narrowing the nose.v.4.6.0.
+ (301): Nose width, used to achieve a slimmer nose effect. The range is [0, 100], with a default value of 0. The larger the value, the more noticiable the effect of narrowing the nose.(301): Nose width, used to achieve a slimmer nose effect. The range is [0, 100], with a default value of 0. The larger the value, the more noticiable the effect of narrowing the nose.
- (302): Nose wing adjustment. The value range is 0 to 100, and the default value is 10. The larger the value, the more noticeable the adjustment.v.4.6.0.
+ (302): Nose wing adjustment. The value range is 0 to 100, and the default value is 10. The larger the value, the more noticeable the adjustment.(302): Nose wing adjustment. The value range is 0 to 100, and the default value is 10. The larger the value, the more noticeable the adjustment.
- (303): Nose root adjustment. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.v.4.6.0.
+ (303): Nose root adjustment. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.(303): Nose root adjustment. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.
- (304): Nose bridge adjustment. The value range is 0 to 100, and the default value is 50. The larger the value, the more noticeable the adjustment.v.4.6.0.
+ (304): Nose bridge adjustment. The value range is 0 to 100, and the default value is 50. The larger the value, the more noticeable the adjustment.(304): Nose bridge adjustment. The value range is 0 to 100, and the default value is 50. The larger the value, the more noticeable the adjustment.
- (305): Nose tip adjustment. The value range is 0 to 100, and the default value is 50. The larger the value, the more noticeable the adjustment.v.4.6.0.
+ (305): Nose tip adjustment. The value range is 0 to 100, and the default value is 50. The larger the value, the more noticeable the adjustment.(305): Nose tip adjustment. The value range is 0 to 100, and the default value is 50. The larger the value, the more noticeable the adjustment.
- (306): Overall nose adjustment. The range is [-100, 100], with a default value of 50. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.v.4.6.0.
+ (306): Overall nose adjustment. The range is [-100, 100], with a default value of 50. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.(306): Overall nose adjustment. The range is [-100, 100], with a default value of 50. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.
- (400): Mouth, used to achieve a larger mouth effect. The range is [-100, 100], with a default value of 20. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.v.4.6.0.
+ (400): Mouth, used to achieve a larger mouth effect. The range is [-100, 100], with a default value of 20. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.(400): Mouth, used to achieve a larger mouth effect. The range is [-100, 100], with a default value of 20. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.
- (401): Mouth position adjustment. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.v.4.6.0.
+ (401): Mouth position adjustment. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.
- (402): Mouth smile adjustment. The value range is [0,1], and the default value is 0. The larger the value, the more noticeable the adjustment.v.4.6.0.
+ (402): Mouth smile adjustment. The value range is [0,1], and the default value is 0. The larger the value, the more noticeable the adjustment.(402): Mouth smile adjustment. The value range is [0,1], and the default value is 0. The larger the value, the more noticeable the adjustment.
- (403): Lip shape adjustment. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.v.4.6.0.
+ (403): Lip shape adjustment. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.(403): Lip shape adjustment. The range is [0, 100], with a default value of 0. The larger the value, the more noticeable the adjustment.
- (500): Eyebrow position adjustment. The range is [-100, 100], with a default value of 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.v.4.6.0.
+ (500): Eyebrow position adjustment. The range is [-100, 100], with a default value of 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.
diff --git a/en-US/dita/RTC-NG/API/enum_faceshapebeautystyle.dita b/en-US/dita/RTC-NG/API/enum_faceshapebeautystyle.dita
index 24704bbbe9d..44bbc188635 100644
--- a/en-US/dita/RTC-NG/API/enum_faceshapebeautystyle.dita
+++ b/en-US/dita/RTC-NG/API/enum_faceshapebeautystyle.dita
@@ -25,8 +25,8 @@
- (2): The natural style beauty effect only makes minimal adjustments to facial features.
- (2): The natural style beauty effect.
+ 2: The natural style beauty effect only makes minimal adjustments to facial features.
+ 2: The natural style beauty effect.
diff --git a/en-US/dita/RTC-NG/API/enum_framerate.dita b/en-US/dita/RTC-NG/API/enum_framerate.dita
index 6acaa51ad92..793e23c8ca7 100644
--- a/en-US/dita/RTC-NG/API/enum_framerate.dita
+++ b/en-US/dita/RTC-NG/API/enum_framerate.dita
@@ -9,32 +9,32 @@
- 1: 1 fps
+ 1: 1 fps.
- 7: 7 fps
+ 7: 7 fps.
- 10: 10 fps
+ 10: 10 fps.
- 15: 15 fps
+ 15: 15 fps.
- 24: 24 fps
+ 24: 24 fps.
- 30: 30 fps
+ 30: 30 fps.
-
60: 60 fps
+
60: 60 fps.
For Windows and macOS only.
diff --git a/en-US/dita/RTC-NG/API/enum_mediarecorderstreamtype.dita b/en-US/dita/RTC-NG/API/enum_mediarecorderstreamtype.dita
index 8caee344a60..01bdf1e1113 100644
--- a/en-US/dita/RTC-NG/API/enum_mediarecorderstreamtype.dita
+++ b/en-US/dita/RTC-NG/API/enum_mediarecorderstreamtype.dita
@@ -7,17 +7,25 @@
Enumerator
-
+
- Only audio.
+ 1: Only audio.
-
+
+
+ 1: Only audio.
+
+
- Only video.
+ 2: Only video.
+
+
+
+ 2: Only video.
- (Default) Audio and video.
+ 3: (Default) Audio and video.
diff --git a/en-US/dita/RTC-NG/API/enum_mediastreamtype.dita b/en-US/dita/RTC-NG/API/enum_mediastreamtype.dita
index 3fa462e1771..c828e352983 100644
--- a/en-US/dita/RTC-NG/API/enum_mediastreamtype.dita
+++ b/en-US/dita/RTC-NG/API/enum_mediastreamtype.dita
@@ -13,12 +13,10 @@
- 1: The video stream.
- 2: The audio stream.
diff --git a/en-US/dita/RTC-NG/API/enum_metadatatype.dita b/en-US/dita/RTC-NG/API/enum_metadatatype.dita
index 5b87a170292..8b078ff85f0 100644
--- a/en-US/dita/RTC-NG/API/enum_metadatatype.dita
+++ b/en-US/dita/RTC-NG/API/enum_metadatatype.dita
@@ -9,11 +9,11 @@
- The type of metadata is unknown.
+ -1: The type of metadata is unknown.
- The type of metadata is video.
+ 0: The type of metadata is video.
diff --git a/en-US/dita/RTC-NG/API/enum_recordererrorcode.dita b/en-US/dita/RTC-NG/API/enum_recordererrorcode.dita
index 90b5379892a..7a94873a9d2 100644
--- a/en-US/dita/RTC-NG/API/enum_recordererrorcode.dita
+++ b/en-US/dita/RTC-NG/API/enum_recordererrorcode.dita
@@ -12,19 +12,19 @@
0: No error.
-
+ 1: The SDK fails to write the recorded data to a file.
-
+ 2: The SDK does not detect any audio and video streams, or audio and video streams are interrupted for more than five seconds during recording.
-
+ 3: The recording duration exceeds the upper limit.
-
+ 4: The recording configuration changes.
diff --git a/en-US/dita/RTC-NG/API/enum_recorderreasoncode.dita b/en-US/dita/RTC-NG/API/enum_recorderreasoncode.dita
index c67d996b53f..d993c6d17fd 100644
--- a/en-US/dita/RTC-NG/API/enum_recorderreasoncode.dita
+++ b/en-US/dita/RTC-NG/API/enum_recorderreasoncode.dita
@@ -12,19 +12,19 @@
0: No error.
-
+ 1: The SDK fails to write the recorded data to a file.
-
+ 2: The SDK does not detect any audio and video streams, or audio and video streams are interrupted for more than five seconds during recording.
-
+ 3: The recording duration exceeds the upper limit.
-
+ 4: The recording configuration changes.
diff --git a/en-US/dita/RTC-NG/API/enum_renewtokenerrorcode.dita b/en-US/dita/RTC-NG/API/enum_renewtokenerrorcode.dita
index 1a6ca12fced..a24266189b3 100644
--- a/en-US/dita/RTC-NG/API/enum_renewtokenerrorcode.dita
+++ b/en-US/dita/RTC-NG/API/enum_renewtokenerrorcode.dita
@@ -2,7 +2,7 @@
- Represents the error codes after calling .
+ Represents the error codes after calling .
@@ -21,24 +21,24 @@
- (1): Token update failed due to an unknown server error. It is recommended to check the parameters used to generate the Token, regenerate the Token, and retry .
- (1): Token update failed. It is recommended to generate a new Token and retry .
+ (1): Token update failed due to an unknown server error. It is recommended to check the parameters used to generate the Token, regenerate the Token, and retry .
+ (1): Token update failed. It is recommended to generate a new Token and retry .
- (2): Token update failed because the provided Token has expired. It is recommended to generate a new Token with a longer expiration time and retry .
+ (2): Token update failed because the provided Token has expired. It is recommended to generate a new Token with a longer expiration time and retry .
- (3): Token update failed because the provided Token is invalid. Common reasons include: the project has enabled App Certificate in the Agora Console but did not use a Token when joining the channel; the specified in joinChannel is inconsistent with the used when generating the Token; the channel name specified in joinChannel is inconsistent with the one used when generating the Token. It is recommended to check the Token generation process, generate a new Token, and retry .
+ (3): Token update failed because the provided Token is invalid. Common reasons include: the project has enabled App Certificate in the Agora Console but did not use a Token when joining the channel; the uid specified in joinChannel is inconsistent with the uid used when generating the Token; the channel name specified in joinChannel is inconsistent with the one used when generating the Token. It is recommended to check the Token generation process, generate a new Token, and retry .
- (4): Token update failed because the channel name in the Token does not match the current channel. It is recommended to check the channel name, generate a new Token, and retry .
+ (4): Token update failed because the channel name in the Token does not match the current channel. It is recommended to check the channel name, generate a new Token, and retry .
- (5): Token update failed because the App ID in the Token does not match the current App ID. It is recommended to check the App ID, generate a new Token, and retry .
+ (5): Token update failed because the App ID in the Token does not match the current App ID. It is recommended to check the App ID, generate a new Token, and retry .
diff --git a/en-US/dita/RTC-NG/API/enum_rhythmplayerreason.dita b/en-US/dita/RTC-NG/API/enum_rhythmplayerreason.dita
index 9e69269396d..57bc5a0ecc3 100644
--- a/en-US/dita/RTC-NG/API/enum_rhythmplayerreason.dita
+++ b/en-US/dita/RTC-NG/API/enum_rhythmplayerreason.dita
@@ -9,7 +9,7 @@
- (0): The beat files are played normally without errors.
+ 0: The beat files are played normally without errors.
@@ -25,7 +25,7 @@
- (803): The duration of the beat file exceeds the limit. The maximum duration is 1.2 seconds.
+ 803: The duration of the beat file exceeds the limit. The maximum duration is 1.2 seconds.
diff --git a/en-US/dita/RTC-NG/API/enum_rhythmplayerstatetype.dita b/en-US/dita/RTC-NG/API/enum_rhythmplayerstatetype.dita
index 05ea8a3974e..d25c8b55ead 100644
--- a/en-US/dita/RTC-NG/API/enum_rhythmplayerstatetype.dita
+++ b/en-US/dita/RTC-NG/API/enum_rhythmplayerstatetype.dita
@@ -9,7 +9,7 @@
- (810): The virtual metronome is not enabled or disabled already.
+ 810: The virtual metronome is not enabled or disabled already.
diff --git a/en-US/dita/RTC-NG/API/enum_screencapturesourcetype.dita b/en-US/dita/RTC-NG/API/enum_screencapturesourcetype.dita
index e7a2486bfb8..e80d8b43554 100644
--- a/en-US/dita/RTC-NG/API/enum_screencapturesourcetype.dita
+++ b/en-US/dita/RTC-NG/API/enum_screencapturesourcetype.dita
@@ -21,7 +21,7 @@
- 2: Reserved parameter
+ 2: Reserved parameter.
diff --git a/en-US/dita/RTC-NG/API/enum_streamlayerindex.dita b/en-US/dita/RTC-NG/API/enum_streamlayerindex.dita
index 0579ef5204b..e4c223e8496 100644
--- a/en-US/dita/RTC-NG/API/enum_streamlayerindex.dita
+++ b/en-US/dita/RTC-NG/API/enum_streamlayerindex.dita
@@ -11,48 +11,43 @@
- (0): Video stream layer_1, with lower resolution and bitrate than .
- (0): Video stream layer_1, with lower resolution and bitrate than .
+ 0: Video stream layer_1, with lower resolution and bitrate than .
+ 0: Video stream layer_1, with lower resolution and bitrate than .
- (1): Video stream layer_2, with lower resolution and bitrate than .
- (1): Video stream layer_2, with lower resolution and bitrate than .
+ 1: Video stream layer_2, with lower resolution and bitrate than .
+ 1: Video stream layer_2, with lower resolution and bitrate than .
- (2): Video stream layer_3, with lower resolution and bitrate than .
- (2): Video stream layer_3, with lower resolution and bitrate than .
- (2):Video stream layer_3, with lower resolution and bitrate than 。
+ 2: Video stream layer_3, with lower resolution and bitrate than .
+ 2: Video stream layer_3, with lower resolution and bitrate than .
- (3): Video stream layer_4, with lower resolution and bitrate than .
- (3): Video stream layer_4, with lower resolution and bitrate than .
- (3): Video stream layer_4, with lower resolution and bitrate than .
+ 3: Video stream layer_4, with lower resolution and bitrate than .
+ 3: Video stream layer_4, with lower resolution and bitrate than .
- (4): Video stream layer_5, with lower resolution and bitrate than .
- (4): Video stream layer_5, with lower resolution and bitrate than .
- (4): Video stream layer_5, with lower resolution and bitrate than .
+ 4: Video stream layer_5, with lower resolution and bitrate than .
+ 4: Video stream layer_5, with lower resolution and bitrate than .
- (5): Video stream layer_6, with lower resolution and bitrate than .
- (5): Video stream layer_6, with lower resolution and bitrate than .
- (5): Video stream layer_6, with lower resolution and bitrate than .
+ 5: Video stream layer_6, with lower resolution and bitrate than .
+ 5: Video stream layer_6, with lower resolution and bitrate than .
- (6): Low-quality video stream, with the lowest resolution and bitrate.
- (6): Low-quality video stream, with the lowest resolution and bitrate.
- (6): Low-quality video stream, with the lowest resolution and bitrate.
+ 6: Low-quality video stream, with the lowest resolution and bitrate.
+ 6: Low-quality video stream, with the lowest resolution and bitrate.
- (7): Maximum number of video stream layers.
- (7): Maximum number of video stream layers.
+ 7: Maximum number of video stream layers.
+ 7: Maximum number of video stream layers.
diff --git a/en-US/dita/RTC-NG/API/enum_videoframeposition.dita b/en-US/dita/RTC-NG/API/enum_videoframeposition.dita
new file mode 100644
index 00000000000..ee465b952e7
--- /dev/null
+++ b/en-US/dita/RTC-NG/API/enum_videoframeposition.dita
@@ -0,0 +1,27 @@
+
+
+
+
+ The frame position of the video observer.
+
+
+ Enumerator
+ To understand specific locations of different video observation points on the video link, see .
+
+
+
+ 1: The location of the locally collected video data after preprocessing corresponds to the callback. The observed video here has the effect of video pre-processing, which can be verified by enabling image enhancement, virtual background, or watermark.
+
+
+
+ 2: The pre-renderer position, which corresponds to the video data in the callback.
+
+
+
+ 4: The pre-encoder position, which corresponds to the video data in the callback. The observed video here has the effects of video pre-processing and encoding pre-processing.
+
To verify the pre-processing effects of the video, you can enable image enhancement, virtual background, or watermark.
+
To verify the pre-encoding processing effect, you can set a lower frame rate (for example, 5 fps).
+
+
+
+
diff --git a/en-US/dita/RTC-NG/API/enum_videomoduleposition.dita b/en-US/dita/RTC-NG/API/enum_videomoduleposition.dita
index 9972e3293bd..595cd9058e3 100644
--- a/en-US/dita/RTC-NG/API/enum_videomoduleposition.dita
+++ b/en-US/dita/RTC-NG/API/enum_videomoduleposition.dita
@@ -6,7 +6,7 @@
Enumerator
- To understand specific locations of different video observation points on the video link, see .
+ To understand specific locations of different video observation points on the video link, see .
diff --git a/en-US/dita/RTC-NG/API/enum_watermarkfitmode.dita b/en-US/dita/RTC-NG/API/enum_watermarkfitmode.dita
index 10b54271884..5a8426c4406 100644
--- a/en-US/dita/RTC-NG/API/enum_watermarkfitmode.dita
+++ b/en-US/dita/RTC-NG/API/enum_watermarkfitmode.dita
@@ -9,11 +9,11 @@
- Use the positionInLandscapeMode and positionInPortraitMode values you set in . The settings in are invalid.
+ 0: Use the positionInLandscapeMode and positionInPortraitMode values you set in . The settings in are invalid.
- Use the value you set in . The settings in positionInLandscapeMode and positionInPortraitMode in are invalid.
+ 1: Use the value you set in . The settings in positionInLandscapeMode and positionInPortraitMode in are invalid.
diff --git a/en-US/dita/RTC-NG/API/rtc_api_data_type.dita b/en-US/dita/RTC-NG/API/rtc_api_data_type.dita
index da9af25d875..ba3c9da4eaf 100644
--- a/en-US/dita/RTC-NG/API/rtc_api_data_type.dita
+++ b/en-US/dita/RTC-NG/API/rtc_api_data_type.dita
@@ -2,7 +2,7 @@
- This page lists all the definitions of and the enums for .
+ 本页列出 所有 和 Enum 的定义。
@@ -1304,7 +1304,7 @@
-
+
@@ -1361,7 +1361,7 @@
-
+
@@ -1473,12 +1473,9 @@
-
-
-
@@ -1504,7 +1501,6 @@
-
@@ -1700,6 +1696,7 @@
+
@@ -1849,6 +1846,7 @@
+
diff --git a/en-US/dita/RTC-NG/API/rtc_api_data_type_unreal.dita b/en-US/dita/RTC-NG/API/rtc_api_data_type_unreal.dita
index 00c5f77424b..3df97a7d0c9 100644
--- a/en-US/dita/RTC-NG/API/rtc_api_data_type_unreal.dita
+++ b/en-US/dita/RTC-NG/API/rtc_api_data_type_unreal.dita
@@ -2,7 +2,7 @@
- This page lists all the definitions of and the enums for .
+ 本页列出 所有 和 Enum 的定义。
diff --git a/en-US/dita/RTC-NG/API/rtc_api_overview.dita b/en-US/dita/RTC-NG/API/rtc_api_overview.dita
index 8f445bd0bbc..b9d5153dd0f 100644
--- a/en-US/dita/RTC-NG/API/rtc_api_overview.dita
+++ b/en-US/dita/RTC-NG/API/rtc_api_overview.dita
@@ -1,15 +1,15 @@
-
- API Overview
- Agora provides ensured quality of experience (QoE) for worldwide Internet-based voice and video communications through SD-RTN™.
+
+ API 概览
+ 声网通过全球部署的 SD-RTN™,提供可以灵活搭配的 API 组合,实现质量可靠的实时音视频通信。
- Initialization related
+ 初始化相关
- Method / Callback
- Description
+ 方法/回调
+ 描述
@@ -21,7 +21,7 @@
- Creates and initializes . Initializes .
+ 创建并初始化 。初始化 。
@@ -58,11 +58,11 @@
- Channel related
+ 频道相关
- Method / Callback
- Description
+ 方法/回调
+ 描述
@@ -191,11 +191,11 @@
- Publish and subscription
+ 发布和订阅
- Method / Callback
- Description
+ 方法/回调
+ 描述
@@ -261,11 +261,11 @@
-
+
-
+
@@ -344,11 +344,11 @@
- Audio basic functions
+ 音频基础功能
- Method / Callback
- Description
+ 方法/回调
+ 描述
@@ -441,11 +441,11 @@
- Audio capture
+ 音频采集
- Method / Callback
- Description
+ 方法/回调
+ 描述
@@ -486,11 +486,11 @@
- Audio pre-processing and post-processing
+ 音频前处理和后处理
- Method / Callback
- Description
+ 方法/回调
+ 描述
@@ -623,11 +623,11 @@
- Raw audio data
+ 原始音频数据
- Method / Callback
- Description
+ 方法/回调
+ 描述
@@ -704,11 +704,11 @@
- Encoded audio data
+ 已编码音频数据
- Method / Callback
- Description
+ 方法/回调
+ 描述
@@ -733,11 +733,11 @@
- Custom audio capture and renderer
+ 自定义音频采集和渲染
- Method / Callback
- Description
+ 方法/回调
+ 描述
@@ -806,11 +806,11 @@
- Audio spectrum
+ 音频频谱
- Method / Callback
- Description
+ 方法/回调
+ 描述
@@ -839,11 +839,11 @@
- Video basic functions
+ 视频基础功能
- Method / Callback
- Description
+ 方法/回调
+ 描述
@@ -932,11 +932,11 @@
- Video capture
+ 视频采集
- Method / Callback
- Description
+ 方法/回调
+ 描述
@@ -952,60 +952,60 @@
- (For iOS only)
+ (仅适用于 iOS)
- Screen Sharing
+ 屏幕共享
- Method / Callback
- Description
+ 方法/回调
+ 描述
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Android and iOS only)
+ (仅适用于 Android 和 iOS)
- (For Android only)
+ (仅适用于 Android)
- (For Android and iOS only)
+ (仅适用于 Android 和 iOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Android and iOS only)
+ (仅适用于 Android 和 iOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
@@ -1013,19 +1013,19 @@
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
@@ -1038,11 +1038,11 @@
- Video pre-processing and post-processing
+ 视频前处理和后处理
- Method / Callback
- Description
+ 方法/回调
+ 描述
@@ -1266,7 +1266,7 @@
- (For iOS and macOS only) (For macOS only) (For iOS only)
+ (仅适用于 iOS 和 macOS)(仅适用于 macOS)(仅适用于 iOS)
@@ -1278,7 +1278,7 @@
- (For iOS and macOS only) (For macOS only) (For iOS only)
+ (仅适用于 iOS 和 macOS)(仅适用于 macOS)(仅适用于 iOS)
@@ -1335,11 +1335,11 @@
- Video rendering
+ 视频渲染
- Method / Callback
- Description
+ 方法/回调
+ 描述
@@ -1420,11 +1420,11 @@
- Raw video data
+ 原始视频数据
- Method / Callback
- Description
+ 方法/回调
+ 描述
@@ -1473,11 +1473,11 @@
- Encoded video data
+ 已编码视频数据
- Method / Callback
- Description
+ 方法/回调
+ 描述
@@ -1494,11 +1494,11 @@
- Custom Video Source and Renderer
+ 自定义视频采集和渲染
- Method / Callback
- Description
+ 方法/回调
+ 描述
@@ -1514,7 +1514,7 @@
- (For Android only)
+ (仅适用于 Android)
@@ -1539,11 +1539,11 @@
- Music file playback
+ 音乐文件播放
- Method / Callback
- Description
+ 方法/回调
+ 描述
@@ -1632,11 +1632,11 @@
- Audio effect file playback
+ 音效文件播放
- Method / Callback
- Description
+ 方法/回调
+ 描述
@@ -1753,11 +1753,11 @@
- Virtual metronome
+ 虚拟节拍器
- Method / Callback
- Description
+ 方法/回调
+ 描述
@@ -1778,13 +1778,13 @@
- Media player
-
For more methods about the media player, see Built-in Media Player.
- Method / Callback
- Description
+ 方法/回调
+ 描述
@@ -2372,11 +2372,11 @@
- General device management
+ 通用设备管理
- Method / Callback
- Description
+ 方法/回调
+ 描述
@@ -2452,19 +2452,19 @@
- Video Device Management
+ 视频设备管理
- Method / Callback
- Description
+ 方法/回调
+ 描述
- (For iOS only)
+ (仅适用于 iOS)
- (For Android and iOS only)
+ (仅适用于 Android 和 iOS)
@@ -2476,79 +2476,79 @@
- (For Android and iOS only)
+ (仅适用于 Android 和 iOS)
- (For Android and iOS only)
+ (仅适用于 Android 和 iOS)
- (For Android and iOS only)
+ (仅适用于 Android 和 iOS)
- (For Android and iOS only)
+ (仅适用于 Android 和 iOS)
- (For Android and iOS only)
+ (仅适用于 Android 和 iOS)
- (For Android and iOS only)
+ (仅适用于 Android 和 iOS)
- (For Android and iOS only)
+ (仅适用于 Android 和 iOS)
- (For Android and iOS only)
+ (仅适用于 Android 和 iOS)
- (For Android and iOS only)
+ (仅适用于 Android 和 iOS)
- (For Android and iOS only)
+ (仅适用于 Android 和 iOS)
- (For Android and iOS only)
+ (仅适用于 Android 和 iOS)
- (For Android and iOS only)
+ (仅适用于 Android 和 iOS)
- (For Android and iOS only)
+ (仅适用于 Android 和 iOS)
- (For iOS only)
+ (仅适用于 iOS)
- (For Android and iOS only)
+ (仅适用于 Android 和 iOS)
- (For iOS only)
+ (仅适用于 iOS)
- (For Android and iOS only)
+ (仅适用于 Android 和 iOS)
- (For Android and iOS only)
+ (仅适用于 Android 和 iOS)
- (For Android and iOS only)
+ (仅适用于 Andorid 和 iOS)
@@ -2556,11 +2556,11 @@
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
@@ -2572,11 +2572,11 @@
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
@@ -2584,23 +2584,23 @@
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows only)
+ (仅适用于 Windows)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
@@ -2612,16 +2612,16 @@
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- Audio Device Management
+ 音频设备管理
- Method / Callback
- Description
+ 方法/回调
+ 描述
@@ -2641,191 +2641,191 @@
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows only)
+ (仅适用于 Windows)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For macOS only)
+ (仅适用于 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For macOS only)
+ (仅适用于 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For macOS only)
+ (仅适用于 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows only)
+ (仅适用于 Windows)
- (For Windows only)
+ (仅适用于 Windows)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For macOS only)
+ (仅适用于 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows only)
+ (仅适用于 Windows)
- (For Windows only)
+ (仅适用于 Windows)
- (For Windows only)
+ (仅适用于 Windows)
- (For Windows only)
+ (仅适用于 Windows)
- (For Windows only)
+ (仅适用于 Windows)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows only)
+ (仅适用于 Windows)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For macOS only)
+ (仅适用于 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For macOS only)
+ (仅适用于 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Windows and macOS only)
+ (仅适用于 Windows 和 macOS)
- (For Android only)
+ (仅适用于 Android)
- Extension
+ 插件相关
- Method / Callback
- Description
+ 方法/回调
+ 描述
@@ -2878,11 +2878,11 @@
- Network and others
+ 网络及其他
- Method / Callback
- Description
+ 方法/回调
+ 描述
diff --git a/en-US/dita/RTC-NG/API/rtc_api_sunset.dita b/en-US/dita/RTC-NG/API/rtc_api_sunset.dita
index c0f1bf07720..410be6db3c7 100644
--- a/en-US/dita/RTC-NG/API/rtc_api_sunset.dita
+++ b/en-US/dita/RTC-NG/API/rtc_api_sunset.dita
@@ -1,11 +1,11 @@
-
- API Sunset Notice
- This page introduces the deprecated and deleted APIs in the SDK.
+
+ API 下架说明
+ 本页介绍 SDK 中已废弃和删除的 API。
- Deprecated APIs
-
The deprecated APIs are expected to be officially deleted in approximately one year. Agora recommends that you promptly replace them with the recommended APIs to avoid any impact on your online services.
+ 已废弃 API
+
废弃后的 API 预计会在 1 年左右正式下架。声网建议你尽快使用推荐的 API 进行替换,以免影响线上业务。
@@ -19,58 +19,58 @@
API
- Description
- Alternative API
- Deprecated version
+ 描述
+ 替代 API
+ 废弃版本
- Use Media Push instead.
+ 请改用服务端旁路推流功能。v4.6.0
- Use Media Push instead.
+ 请改用服务端旁路推流功能。v4.6.0
- Use Media Push instead.
+ 请改用服务端旁路推流功能。v4.6.0
- Use Media Push instead.
+ 请改用服务端旁路推流功能。v4.6.0
- Use Media Push instead.
+ 请改用服务端旁路推流功能。v4.6.0
- Use Media Push instead.
+ 请改用服务端旁路推流功能。v4.6.0
- Use Media Push instead.
+ 请改用服务端旁路推流功能。v4.6.0
- Use Media Push instead.
+ 请改用服务端旁路推流功能。v4.6.0
@@ -94,7 +94,7 @@
- Use instead.
+ 请改用 v4.6.0
@@ -190,7 +190,7 @@
- or
+ 或 v4.0.0
@@ -208,25 +208,25 @@
- Use the contextconfig parameter in .
+ 使用 中的 contextconfig 参数v4.0.0
- Use the contextconfig parameter in .
+ 使用 中的 contextconfig 参数v4.0.0
- Use the contextconfig parameter in .
+ 使用 中的 contextconfig 参数v4.0.0
- Use the contextconfig parameter in .
+ 使用 中的 contextconfig 参数v4.0.0
@@ -238,7 +238,7 @@
- or
+ 或 v4.0.0
@@ -371,70 +371,70 @@
API
- Description
- Alternative API
- Deprecated version
+ 描述
+ 替代 API
+ 废弃版本
- Use Media Push instead.
+ 请改用服务端旁路推流功能。v4.6.0
- Use Media Push instead.
+ 请改用服务端旁路推流功能。v4.6.0
- Use Media Push instead.
+ 请改用服务端旁路推流功能。v4.6.0
- Use Media Push instead.
+ 请改用服务端旁路推流功能。v4.6.0
- Use Media Push instead.
+ 请改用服务端旁路推流功能。v4.6.0
- Use Media Push instead.
+ 请改用服务端旁路推流功能。v4.6.0
- Use Media Push instead.
+ 请改用服务端旁路推流功能。v4.6.0
- Use Media Push instead.
+ 请改用服务端旁路推流功能。v4.6.0
- Use Media Push instead.
+ 请改用服务端旁路推流功能。v4.6.0
- Use instead.
+ 请改用 v4.6.0
@@ -524,7 +524,7 @@
- or
+ 或 v4.0.0
@@ -542,25 +542,25 @@
- Use the contextconfig parameter in .
+ 使用 中的 contextconfig 参数v4.0.0
- Use the contextconfig parameter in .
+ 使用 中的 contextconfig 参数v4.0.0
- Use the contextconfig parameter in .
+ 使用 中的 contextconfig 参数v4.0.0
- Use the contextconfig parameter in .
+ 使用 中的 contextconfig 参数v4.0.0
@@ -572,7 +572,7 @@
- or
+ 或 v4.0.0
@@ -695,8 +695,8 @@
- Deleted APIs
-
The APIs have been deleted from the SDK. Use the recommended alternative APIs to implement the related functionality.
+ 已删除 API
+
API 已在 SDK 中删除。请使用推荐的替代 API 实现相关功能。
@@ -707,156 +707,154 @@
API
- Description
- Alternative API
- Deleted version
+ 描述
+ 替代 API
+ 删除版本setLocalPublishFallbackOption
- Sets the fallback option for the published video stream based on the network conditions.
+ 设置弱网条件下发布的音视频流回退选项。-v4.6.0onLocalPublishFallbackToAudioOnlydidLocalPublishFallbackToAudioOnly
- Occurs when the published media stream falls back to an audio-only stream.
+ 本地发布流已回退为音频流回调。-v4.6.0onDownlinkNetworkInfoUpdateddownlinkNetworkInfoUpdate
- Occurs when the downlink network information changes.
+ 下行网络信息变化回调。-v4.6.0
- receivedFrameRate is deleted in AgoraRtcRemoteVideoStats
- The frame rate (Kbps) received since the last count.
+ AgoraRtcRemoteVideoStats 删除 receivedFrameRate
+ (上次统计后)接收到的帧率 (fps)。-v4.6.0enableWirelessAccelerate
- Enables or disable Wi-Fi acceleration.
+ 开启或关闭 Wi-Fi 加速功能。-v4.6.0onWlAccStats
- Report on Wi-Fi acceleration effect.
+ 报告 Wi-Fi 加速效果。-v4.6.0onWlAccMessagewlAccMessage
- Report on Wi-Fi acceleration effect.
+ 报告 Wi-Fi 加速消息。-v4.6.0WLACC_MESSAGE_REASONAgoraWlAccReason
- Wi-Fi acceleration message.
+ Wi-Fi 加速消息原因。-v4.6.0WLACC_SUGGEST_ACTIONAgoraWlAccAction
- Wi-Fi acceleration recommended operation.
+ Wi-Fi 加速建议操作。-v4.6.0WlAccStatsAgoraWlAccStats
- Wi-Fi acceleration statistics.
+ Wi-Fi 加速统计信息。-v4.6.0setVideoProfilesetVideoProfile:profile:swapWidthAndHeight:
- Sets the video encoder configuration.
+ 设置视频编码配置。v4.4.0setRemoteRenderMode(userId, renderMode)setRemoteRenderMode:uid:mode:
- Sets the video display mode of a specified remote user.
+ 设置远端视图显示模式。v4.4.0CreateRendererView
- Creates a RendererView.
- The Android native method .
+ 创建 RendererView。
+ Android 原生的 方法v4.4.0
- CreateTextureView
-
- Creates a TextureView.
- The Android native method .
+ CreateTextureView
+ 创建 TextureView。
+ Android 原生的 。v4.4.0openWithCustomSourceopenWithCustomSourceAtStartPos
- Opens the custom media resource file.
+ 打开自定义媒体资源文件。v4.4.0
- setVideoQualityParameters
-
- Sets the preferences for high-quality video. (LIVE_BROADCASTING only).
- Use the degradationPreference parameter in
+ setVideoQualityParameters
+ 设置视频优化选项(仅适用于直播)。
+ 使用 类中的 degradationPreference 参数v4.4.0startEchoTest()startEchoTest
- Starts an audio call test.
+ 开始语音通话回路测试。v4.4.0startEchoTest(intervalInSeconds)startEchoTestWithInterval
- Starts an audio call test.
+ 开始语音通话回路测试。v4.4.0setEncryptionMode
- Sets the built-in encryption mode.
+ 启用内置的加密方案。v4.4.0
- setEncryptionSecret
- Enables built-in encryption with an encryption password before users join a channel.
+ setEncryptionSecret
+ 启用内置加密,并设置数据加密密码。v4.4.0onExtensionEventonEvent
- The event callback of the extension.
+ 插件事件回调。v4.4.0onExtensionStartedonStarted
- Occurs when the extension is enabled.
+ 插件启用回调。v4.4.0onExtensionStoppedonStopped
- Occurs when the extension is disabled.
+ 插件禁用回调。v4.4.0onExtensionErroronError
- Occurs when the extension runs incorrectly.
+ 插件出错回调。v4.4.0
diff --git a/en-US/dita/RTC-NG/API/rtc_interface_class.dita b/en-US/dita/RTC-NG/API/rtc_interface_class.dita
index 3328dabf765..70d0b0889a2 100644
--- a/en-US/dita/RTC-NG/API/rtc_interface_class.dita
+++ b/en-US/dita/RTC-NG/API/rtc_interface_class.dita
@@ -2,7 +2,7 @@
-This page lists all interface classes on the platform and the APIs they contain.
+本页列出 所有的接口类以及其中包含的 API。
diff --git a/en-US/dita/RTC-NG/API/rtc_lite_api.dita b/en-US/dita/RTC-NG/API/rtc_lite_api.dita
index 75c0d65346c..6967f74af79 100644
--- a/en-US/dita/RTC-NG/API/rtc_lite_api.dita
+++ b/en-US/dita/RTC-NG/API/rtc_lite_api.dita
@@ -1,10 +1,10 @@
-Lite SDK API List
-This page lists the APIs supported by Lite SDK.
+Lite SDK API 列表
+本页列出 Lite SDK 支持的 API 列表。
- If you cannot find the API you are looking for on this page, it means the Lite SDK does not support this API, and calling it returns error code -2.
+ 如果在本页中无法查询到你要使用的 API,则代表 Lite SDK 不支持该 API,调用该 API 时会返回错误码 -2。
@@ -109,12 +109,14 @@
-
In , the following screen capture-related parameter settings are invalid:
+
在 中,以下跟屏幕采集相关的参数设置无效:
+
publishScreenCaptureVideo
publishScreenCaptureAudio
-
In , the following screen capture-related parameter settings are invalid:
+
在 中,以下跟屏幕采集相关的参数设置无效:
+
publishScreenCaptureVideo
publishScreenCaptureAudio
@@ -162,7 +164,7 @@
-
In , the encodingType parameter in config only supports the OPUS format for audio encoding.
+
在 中,config 中的 encodingType 仅支持 OPUS 编码格式。
@@ -320,7 +322,8 @@
-
In , the following screen capture-related parameter settings are invalid:
+
在 中,以下跟屏幕采集相关的参数设置无效:
+
publishScreenCaptureVideo
publishScreenCaptureAudio
@@ -376,7 +379,8 @@
-
In , the following screen capture-related parameter settings are invalid:
+
在 中,以下跟屏幕采集相关的参数设置无效:
+
publishScreenCaptureVideo
publishScreenCaptureAudio
@@ -485,7 +489,7 @@
- The APIs in this group only support processing audio media files and di not support processing video media files.
+ 媒体播放器中的 API 仅支持处理音频媒体文件、不支持处理视频媒体文件。
@@ -550,7 +554,7 @@
- In the video data returned by the , , and callbacks, the alphabuffer is .
+ 通过 、 和 回调返回的视频数据中,alphabuffer 为 。
diff --git a/en-US/dita/RTC-NG/API/toc_audio.dita b/en-US/dita/RTC-NG/API/toc_audio.dita
new file mode 100644
index 00000000000..342b7b24c4d
--- /dev/null
+++ b/en-US/dita/RTC-NG/API/toc_audio.dita
@@ -0,0 +1,7 @@
+
+
+
+ 音频相关
+
+
+
diff --git a/en-US/dita/RTC-NG/API/toc_audio_basic.dita b/en-US/dita/RTC-NG/API/toc_audio_basic.dita
new file mode 100644
index 00000000000..24b0ebe9a8b
--- /dev/null
+++ b/en-US/dita/RTC-NG/API/toc_audio_basic.dita
@@ -0,0 +1,7 @@
+
+
+
+ 音频基础功能
+
+
+
diff --git a/en-US/dita/RTC-NG/API/toc_audio_capture.dita b/en-US/dita/RTC-NG/API/toc_audio_capture.dita
new file mode 100644
index 00000000000..5e497713abe
--- /dev/null
+++ b/en-US/dita/RTC-NG/API/toc_audio_capture.dita
@@ -0,0 +1,7 @@
+
+
+
+ 音频采集
+
+
+
diff --git a/en-US/dita/RTC-NG/API/toc_audio_custom_capturenrendering.dita b/en-US/dita/RTC-NG/API/toc_audio_custom_capturenrendering.dita
new file mode 100644
index 00000000000..e5c4f997f7a
--- /dev/null
+++ b/en-US/dita/RTC-NG/API/toc_audio_custom_capturenrendering.dita
@@ -0,0 +1,7 @@
+
+
+
+ 自定义音频采集和渲染
+
+
+
diff --git a/en-US/dita/RTC-NG/API/toc_audio_device.dita b/en-US/dita/RTC-NG/API/toc_audio_device.dita
new file mode 100644
index 00000000000..8c5b003b2db
--- /dev/null
+++ b/en-US/dita/RTC-NG/API/toc_audio_device.dita
@@ -0,0 +1,8 @@
+
+
+
+ 音频设备管理
+ 介绍跟音频设备管理相关的方法和回调。
+
+
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/toc_audio_device_management.dita b/en-US/dita/RTC-NG/API/toc_audio_device_management.dita
index 85e296b987f..d458c559cbd 100644
--- a/en-US/dita/RTC-NG/API/toc_audio_device_management.dita
+++ b/en-US/dita/RTC-NG/API/toc_audio_device_management.dita
@@ -1,7 +1,7 @@
- Audio Device Management
- Introduces methods and callbacks related to audio device management.
+ 音频设备管理
+ 介绍跟音频设备管理相关的方法和回调。
diff --git a/en-US/dita/RTC-NG/API/toc_audio_effect.dita b/en-US/dita/RTC-NG/API/toc_audio_effect.dita
index e20e93d6a5a..df143184498 100644
--- a/en-US/dita/RTC-NG/API/toc_audio_effect.dita
+++ b/en-US/dita/RTC-NG/API/toc_audio_effect.dita
@@ -1,7 +1,7 @@
- Audio Effect Processing
- Introduces methods and callbacks related to audio effect processing.
+ 人声音效
+
diff --git a/en-US/dita/RTC-NG/API/toc_audio_effect_file.dita b/en-US/dita/RTC-NG/API/toc_audio_effect_file.dita
new file mode 100644
index 00000000000..99cb9a61507
--- /dev/null
+++ b/en-US/dita/RTC-NG/API/toc_audio_effect_file.dita
@@ -0,0 +1,7 @@
+
+
+
+ 音效文件播放
+
+
+
diff --git a/en-US/dita/RTC-NG/API/toc_audio_encoded.dita b/en-US/dita/RTC-NG/API/toc_audio_encoded.dita
new file mode 100644
index 00000000000..215d613666b
--- /dev/null
+++ b/en-US/dita/RTC-NG/API/toc_audio_encoded.dita
@@ -0,0 +1,7 @@
+
+
+
+ 已编码音频数据
+
+
+
diff --git a/en-US/dita/RTC-NG/API/toc_audio_mixing.dita b/en-US/dita/RTC-NG/API/toc_audio_mixing.dita
new file mode 100644
index 00000000000..8dbfe1341fb
--- /dev/null
+++ b/en-US/dita/RTC-NG/API/toc_audio_mixing.dita
@@ -0,0 +1,7 @@
+
+
+
+ 音乐文件播放
+
+
+
diff --git a/en-US/dita/RTC-NG/API/toc_audio_observer.dita b/en-US/dita/RTC-NG/API/toc_audio_observer.dita
index c1254896b63..aea75ea1853 100644
--- a/en-US/dita/RTC-NG/API/toc_audio_observer.dita
+++ b/en-US/dita/RTC-NG/API/toc_audio_observer.dita
@@ -1,7 +1,7 @@
- Audio Frame Observer
- Introduces methods and callbacks related to audio frame observers.
+ 音频观测器
+ 介绍跟音频观测器相关的方法和回调。
diff --git a/en-US/dita/RTC-NG/API/toc_audio_prenpost.dita b/en-US/dita/RTC-NG/API/toc_audio_prenpost.dita
new file mode 100644
index 00000000000..0237ad586d5
--- /dev/null
+++ b/en-US/dita/RTC-NG/API/toc_audio_prenpost.dita
@@ -0,0 +1,7 @@
+
+
+
+ 音频前处理和后处理
+
+
+
diff --git a/en-US/dita/RTC-NG/API/toc_audio_process.dita b/en-US/dita/RTC-NG/API/toc_audio_process.dita
index 25c5ba0bdd2..3f4dc4666db 100644
--- a/en-US/dita/RTC-NG/API/toc_audio_process.dita
+++ b/en-US/dita/RTC-NG/API/toc_audio_process.dita
@@ -1,7 +1,7 @@
- Audio Processing
- Introduces methods and callbacks related to audio processing.
+ 音频处理
+ 介绍跟音频处理相关的方法和回调。
diff --git a/en-US/dita/RTC-NG/API/toc_audio_raw.dita b/en-US/dita/RTC-NG/API/toc_audio_raw.dita
new file mode 100644
index 00000000000..8affc047b74
--- /dev/null
+++ b/en-US/dita/RTC-NG/API/toc_audio_raw.dita
@@ -0,0 +1,7 @@
+
+
+
+ 原始音频数据
+
+
+
diff --git a/en-US/dita/RTC-NG/API/toc_audio_route.dita b/en-US/dita/RTC-NG/API/toc_audio_route.dita
new file mode 100644
index 00000000000..9a090bfffa8
--- /dev/null
+++ b/en-US/dita/RTC-NG/API/toc_audio_route.dita
@@ -0,0 +1,7 @@
+
+
+
+ 音频路由
+
+
+
diff --git a/en-US/dita/RTC-NG/API/toc_audio_spectrum.dita b/en-US/dita/RTC-NG/API/toc_audio_spectrum.dita
new file mode 100644
index 00000000000..e33d7b6f5bb
--- /dev/null
+++ b/en-US/dita/RTC-NG/API/toc_audio_spectrum.dita
@@ -0,0 +1,7 @@
+
+
+
+ 音频频谱
+
+
+
diff --git a/en-US/dita/RTC-NG/API/toc_camera_capture.dita b/en-US/dita/RTC-NG/API/toc_camera_capture.dita
new file mode 100644
index 00000000000..75a04e00e02
--- /dev/null
+++ b/en-US/dita/RTC-NG/API/toc_camera_capture.dita
@@ -0,0 +1,7 @@
+
+
+
+ 摄像头采集
+
+
+
diff --git a/en-US/dita/RTC-NG/API/toc_cdn_streaming.dita b/en-US/dita/RTC-NG/API/toc_cdn_streaming.dita
new file mode 100644
index 00000000000..c94d664a28f
--- /dev/null
+++ b/en-US/dita/RTC-NG/API/toc_cdn_streaming.dita
@@ -0,0 +1,7 @@
+
+
+
+ 直推 CDN
+
+
+
diff --git a/en-US/dita/RTC-NG/API/toc_center_stage.dita b/en-US/dita/RTC-NG/API/toc_center_stage.dita
new file mode 100644
index 00000000000..b1916e80b67
--- /dev/null
+++ b/en-US/dita/RTC-NG/API/toc_center_stage.dita
@@ -0,0 +1,7 @@
+
+
+
+ 人像锁定
+
+
+
diff --git a/en-US/dita/RTC-NG/API/toc_channel.dita b/en-US/dita/RTC-NG/API/toc_channel.dita
new file mode 100644
index 00000000000..8ae6b853a59
--- /dev/null
+++ b/en-US/dita/RTC-NG/API/toc_channel.dita
@@ -0,0 +1,7 @@
+
+
+
+ 频道相关
+
+
+
diff --git a/en-US/dita/RTC-NG/API/toc_channel_media_relay.dita b/en-US/dita/RTC-NG/API/toc_channel_media_relay.dita
new file mode 100644
index 00000000000..ab2ca813371
--- /dev/null
+++ b/en-US/dita/RTC-NG/API/toc_channel_media_relay.dita
@@ -0,0 +1,7 @@
+
+
+
+ 跨频道媒体流转发
+
+
+
diff --git a/en-US/dita/RTC-NG/API/toc_cloud_media_relay.dita b/en-US/dita/RTC-NG/API/toc_cloud_media_relay.dita
new file mode 100644
index 00000000000..01951f965cd
--- /dev/null
+++ b/en-US/dita/RTC-NG/API/toc_cloud_media_relay.dita
@@ -0,0 +1,7 @@
+
+
+
+ 媒体流云分发
+
+
+
diff --git a/en-US/dita/RTC-NG/API/toc_common_device.dita b/en-US/dita/RTC-NG/API/toc_common_device.dita
new file mode 100644
index 00000000000..a4033da2060
--- /dev/null
+++ b/en-US/dita/RTC-NG/API/toc_common_device.dita
@@ -0,0 +1,7 @@
+
+
+
+ 通用设备管理
+
+
+
diff --git a/en-US/dita/RTC-NG/API/toc_core_method.dita b/en-US/dita/RTC-NG/API/toc_core_method.dita
index 79458b8ec81..b616bc7afd1 100644
--- a/en-US/dita/RTC-NG/API/toc_core_method.dita
+++ b/en-US/dita/RTC-NG/API/toc_core_method.dita
@@ -1,7 +1,7 @@
- Core Methods and Callbacks
- Introduces the core methods and corresponding callbacks in the RTC SDK.
+ 核心方法和回调
+ 介绍 RTC SDK 中的核心方法以及对应的回调。
diff --git a/en-US/dita/RTC-NG/API/toc_datastream.dita b/en-US/dita/RTC-NG/API/toc_datastream.dita
new file mode 100644
index 00000000000..66cce9add4a
--- /dev/null
+++ b/en-US/dita/RTC-NG/API/toc_datastream.dita
@@ -0,0 +1,7 @@
+
+
+
+ 数据流 Datastream
+
+
+
diff --git a/en-US/dita/RTC-NG/API/toc_device_management.dita b/en-US/dita/RTC-NG/API/toc_device_management.dita
new file mode 100644
index 00000000000..096c579b963
--- /dev/null
+++ b/en-US/dita/RTC-NG/API/toc_device_management.dita
@@ -0,0 +1,7 @@
+
+
+
+ 设备管理
+
+
+
diff --git a/en-US/dita/RTC-NG/API/toc_drm.dita b/en-US/dita/RTC-NG/API/toc_drm.dita
index 0ee86731edb..76a44e4cd65 100644
--- a/en-US/dita/RTC-NG/API/toc_drm.dita
+++ b/en-US/dita/RTC-NG/API/toc_drm.dita
@@ -1,8 +1,8 @@
- DRM-protected music
- 介绍版权音乐的相关方法和回调。
+ 版权音乐
+
diff --git a/en-US/dita/RTC-NG/API/toc_dual_stream.dita b/en-US/dita/RTC-NG/API/toc_dual_stream.dita
new file mode 100644
index 00000000000..1bdcf86ea15
--- /dev/null
+++ b/en-US/dita/RTC-NG/API/toc_dual_stream.dita
@@ -0,0 +1,7 @@
+
+
+
+ 视频双流
+
+
+
diff --git a/en-US/dita/RTC-NG/API/toc_extension.dita b/en-US/dita/RTC-NG/API/toc_extension.dita
new file mode 100644
index 00000000000..224c7cd62f0
--- /dev/null
+++ b/en-US/dita/RTC-NG/API/toc_extension.dita
@@ -0,0 +1,7 @@
+
+
+
+ 插件
+
+
+
diff --git a/en-US/dita/RTC-NG/API/toc_face_detection.dita b/en-US/dita/RTC-NG/API/toc_face_detection.dita
new file mode 100644
index 00000000000..e203f4c881c
--- /dev/null
+++ b/en-US/dita/RTC-NG/API/toc_face_detection.dita
@@ -0,0 +1,7 @@
+
+
+
+ 人脸检测
+
+
+
diff --git a/en-US/dita/RTC-NG/API/toc_image_source.dita b/en-US/dita/RTC-NG/API/toc_image_source.dita
new file mode 100644
index 00000000000..ca8cc1d8546
--- /dev/null
+++ b/en-US/dita/RTC-NG/API/toc_image_source.dita
@@ -0,0 +1,7 @@
+
+
+
+ 垫片推流
+
+
+
diff --git a/en-US/dita/RTC-NG/API/toc_initialize.dita b/en-US/dita/RTC-NG/API/toc_initialize.dita
new file mode 100644
index 00000000000..6d406119282
--- /dev/null
+++ b/en-US/dita/RTC-NG/API/toc_initialize.dita
@@ -0,0 +1,7 @@
+
+
+
+ 初始化相关
+
+
+
diff --git a/en-US/dita/RTC-NG/API/toc_local_recording.dita b/en-US/dita/RTC-NG/API/toc_local_recording.dita
index 078a39feb09..1c5298904e4 100644
--- a/en-US/dita/RTC-NG/API/toc_local_recording.dita
+++ b/en-US/dita/RTC-NG/API/toc_local_recording.dita
@@ -1,7 +1,7 @@
- Audio and video recording
- Introduces the methods and callbacks used when recording audio and video streams.
+ 音视频流录制
+ 介绍音视频流录制时使用的方法和回调。
diff --git a/en-US/dita/RTC-NG/API/toc_local_transcoder.dita b/en-US/dita/RTC-NG/API/toc_local_transcoder.dita
new file mode 100644
index 00000000000..b2a9140f7c8
--- /dev/null
+++ b/en-US/dita/RTC-NG/API/toc_local_transcoder.dita
@@ -0,0 +1,7 @@
+
+
+
+ 本地合图
+
+
+
diff --git a/en-US/dita/RTC-NG/API/toc_media_push.dita b/en-US/dita/RTC-NG/API/toc_media_push.dita
new file mode 100644
index 00000000000..4a6127bc99c
--- /dev/null
+++ b/en-US/dita/RTC-NG/API/toc_media_push.dita
@@ -0,0 +1,7 @@
+
+
+
+ 旁路推流
+
+
+
diff --git a/en-US/dita/RTC-NG/API/toc_mediaplayer.dita b/en-US/dita/RTC-NG/API/toc_mediaplayer.dita
index 185ddb86d22..952f3af4462 100644
--- a/en-US/dita/RTC-NG/API/toc_mediaplayer.dita
+++ b/en-US/dita/RTC-NG/API/toc_mediaplayer.dita
@@ -1,11 +1,11 @@
- Built-in Media Player
- Introduces the methods and callbacks related to the built-in media player.
+ 内置媒体播放器
+ 介绍内置媒体播放器相关的方法和回调。
-
-
You can play local or online media resources by calling APIs related to the media player, or play media resources to remote users in the Agora channel.
+
+
你可以通过调用媒体播放器相关的 API 播放本地或在线媒体资源,或将媒体资源分享给频道内的远端用户观看或收听。
(5): Chatroom scenario, where users need to frequently switch the user role or mute and unmute the microphone.
(6): High-quality audio scenario, where users mainly play music.
(7): Real-time chorus scenario, where users have good network conditions and require extremely low latency.
-
+ Before using this enumeration, you need to call to see whether the audio device supports ultra-low-latency capture and playback. To experience ultra-low latency, you need to ensure that your audio device supports ultra-low latency (isLowLatencyAudioSupported = ).
+
The audio scenario. See . Under different audio scenarios, the device uses different volume types.
The following table shows the SDK behaviors under different parameter settings:
+
+
+
syncWithAudio
+
ordered
+
SDK behaviors
+
+
+
+
false
+
false
+
The SDK triggers the onStreamMessage callback immediately after the receiver receives a data packet.
+
+
+
true
+
false
+
If the data packet delay is within the audio delay, the SDK triggers the onStreamMessage callback when the synchronized audio packet is played out. If the data packet delay exceeds the audio delay, the SDK triggers the onStreamMessage callback as soon as the data packet is received.
+
+
+
false
+
true
+
If the delay of a data packet is less than five seconds, the SDK corrects the order of the data packet. If the delay of a data packet exceeds five seconds, the SDK discards the data packet.
+
+
+
true
+
true
+
If the delay of the data packet is within the range of the audio delay, the SDK corrects the order of the data packet. If the delay of a data packet exceeds the audio delay, the SDK discards this data packet.
+
+
+
+
+ Attributes
+
+
+
+
+
syncWithAudio
+
+
Whether to synchronize the data packet with the published audio packet.
+
true: Synchronize the data packet with the audio packet. This setting is suitable for special scenarios such as lyrics synchronization.
+
false: Do not synchronize the data packet with the audio packet. This setting is suitable for scenarios where data packets need to arrive at the receiving end immediately.
+
When you set the data packet to synchronize with the audio, then if the data packet delay is within the audio delay, the SDK triggers the onStreamMessage callback when the synchronized audio packet is played out.
+
+
+
+
ordered
+
+
Whether the SDK guarantees that the receiver receives the data in the sent order.
+
true: Guarantee that the receiver receives the data in the sent order.
+
false: Do not guarantee that the receiver receives the data in the sent order.
+
Do not set this parameter as true if you need the receiver to receive the data packet immediately.
+
+
+
+
+
\ No newline at end of file
diff --git a/scripts/update-comment/api_comment_updater/tests/run_cpp_regression.py b/scripts/update-comment/api_comment_updater/tests/run_cpp_regression.py
new file mode 100644
index 00000000000..b135fd23a5e
--- /dev/null
+++ b/scripts/update-comment/api_comment_updater/tests/run_cpp_regression.py
@@ -0,0 +1,32 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+C++回归测试运行脚本
+简化版本,用于快速运行回归测试
+"""
+
+import sys
+from pathlib import Path
+
+# 添加项目根目录到Python路径
+project_root = Path(__file__).parent.parent
+sys.path.insert(0, str(project_root))
+
+from tests.cpp_regression_test import CppRegressionTest
+
+def main():
+ """运行C++回归测试"""
+ print("🚀 启动C++回归测试")
+
+ test = CppRegressionTest()
+ success = test.run_full_test()
+
+ if success:
+ print("\n🎉 所有测试通过!")
+ return 0
+ else:
+ print("\n💥 测试失败!")
+ return 1
+
+if __name__ == "__main__":
+ sys.exit(main())
diff --git a/scripts/update-comment/api_comment_updater/tests/src/test.h b/scripts/update-comment/api_comment_updater/tests/src/test.h
new file mode 100644
index 00000000000..7514e20aa31
--- /dev/null
+++ b/scripts/update-comment/api_comment_updater/tests/src/test.h
@@ -0,0 +1,106 @@
+//
+// Agora SDK
+//
+#pragma once // NOLINT(build/header_guard)
+
+namespace agora {
+namespace rtc {
+
+class IRtcEngine : public agora::base::IEngineBase {
+ public:
+
+};
+
+
+/**
+ * @brief Options for handling audio and video stream fallback when network conditions are weak.
+ */
+enum STREAM_FALLBACK_OPTIONS {
+ /**
+ * 0: No fallback processing is performed on audio and video streams, the quality of the audio and
+ * video streams cannot be guaranteed.
+ */
+ STREAM_FALLBACK_OPTION_DISABLED = 0,
+ /**
+ * 1: Only receive low-quality (low resolution, low bitrate) video stream.
+ */
+ STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW = 1,
+ /**
+ * 2: When the network conditions are weak, try to receive the low-quality video stream first. If
+ * the video cannot be displayed due to extremely weak network environment, then fall back to
+ * receiving audio-only stream.
+ */
+ STREAM_FALLBACK_OPTION_AUDIO_ONLY = 2,
+ /** 3~8: If the receiver SDK uses RtcEngineParameters::setRemoteSubscribeFallbackOption,it will receive
+ one of the streams from agora::rtc::VIDEO_STREAM_LAYER_1 to agora::rtc::VIDEO_STREAM_LAYER_6
+ if the related layer exists when the network condition is poor. The lower bound of fallback depends on
+ the STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_X. */
+ STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_1 = 3,
+ STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_2 = 4,
+ STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_3 = 5,
+ STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_4 = 6,
+ STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_5 = 7,
+ STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_6 = 8,
+};
+
+
+/**
+ * The video noise reduction options.
+ *
+ * @since v4.0.0
+ */
+struct VideoDenoiserOptions {
+ /**
+ * @brief Video noise reduction mode.
+ */
+ enum VIDEO_DENOISER_MODE {
+ /**
+ * 0: (Default) Automatic mode. The SDK automatically enables or disables the video noise reduction
+ * feature according to the ambient light.
+ */
+ VIDEO_DENOISER_AUTO = 0,
+ /**
+ * 1: Manual mode. Users need to enable or disable the video noise reduction feature manually.
+ */
+ VIDEO_DENOISER_MANUAL = 1,
+ };
+ /**
+ * The video noise reduction level.
+ */
+ enum VIDEO_DENOISER_LEVEL {
+ /**
+ * 0: (Default) Promotes video quality during video noise reduction. `HIGH_QUALITY` balances
+ * performance consumption and video noise reduction quality. The performance consumption is
+ * moderate, the video noise reduction speed is moderate, and the overall video quality is
+ * optimal.
+ */
+ VIDEO_DENOISER_LEVEL_HIGH_QUALITY = 0,
+ /**
+ * Promotes reducing performance consumption during video noise reduction. `FAST` prioritizes
+ * reducing performance consumption over video noise reduction quality. The performance
+ * consumption is lower, and the video noise reduction speed is faster. To avoid a noticeable
+ * shadowing effect (shadows trailing behind moving objects) in the processed video, Agora
+ * recommends that you use `FAST` when the camera is fixed.
+ */
+ VIDEO_DENOISER_LEVEL_FAST = 1,
+ };
+ /** The video noise reduction mode. See #VIDEO_DENOISER_MODE.
+ */
+ VIDEO_DENOISER_MODE mode;
+
+ /** The video noise reduction level. See #VIDEO_DENOISER_LEVEL.
+ */
+ VIDEO_DENOISER_LEVEL level;
+
+ VideoDenoiserOptions(VIDEO_DENOISER_MODE denoiserMode, VIDEO_DENOISER_LEVEL denoiserLevel)
+ : mode(denoiserMode), level(denoiserLevel) {}
+
+ VideoDenoiserOptions() : mode(VIDEO_DENOISER_AUTO), level(VIDEO_DENOISER_LEVEL_HIGH_QUALITY) {}
+};
+
+} // namespace commons
+} // namespace agora
+
+
+
+#undef OPTIONAL_LOG_LEVEL_SPECIFIER
\ No newline at end of file
diff --git a/scripts/update-comment/api_comment_updater/tests/src/test.java b/scripts/update-comment/api_comment_updater/tests/src/test.java
new file mode 100644
index 00000000000..3759776b7ea
--- /dev/null
+++ b/scripts/update-comment/api_comment_updater/tests/src/test.java
@@ -0,0 +1,141 @@
+package io.agora.rtc2;
+
+public abstract class RtcEngine {
+ protected static RtcEngineImpl mInstance = null;
+ /**
+ * Checks whether the speakerphone is enabled.
+ *
+ * @return
+ * - true: The speakerphone is enabled, and the audio plays from the speakerphone.
+ * - false: The speakerphone is not enabled, and the audio plays from devices other than the
+ * speakerphone. For example, the headset or earpiece.
+ */
+ public abstract boolean isSpeakerphoneEnabled();
+}
+
+/**
+ * Sets the image enhancement options.
+ */
+public class BeautyOptions {
+ /**
+ * 0: low contrast for lightening.
+ */
+ public static final int LIGHTENING_CONTRAST_LOW = 0;
+
+ /**
+ * 1: normal contrast for lightening.
+ */
+ public static final int LIGHTENING_CONTRAST_NORMAL = 1;
+
+ /**
+ * 2: high contrast for lightening.
+ */
+ public static final int LIGHTENING_CONTRAST_HIGH = 2;
+
+ /**
+ * The lightening contrast level, used with {@link
+ * io.agora.rtc2.video.BeautyOptions#lighteningLevel lighteningLevel}:
+ */
+ public int lighteningContrastLevel;
+
+ /**
+ * The brightness level. The value ranges between 0.0 (original) and 1.0. The default value is
+ * 0.6.
+ */
+ public float lighteningLevel;
+
+ /**
+ * The smoothness level. The value ranges between 0.0 (original) and 1.0. The default value is
+ * 0.5. This parameter is usually used to remove blemishes.
+ */
+ public float smoothnessLevel;
+
+ /**
+ * The redness level. The value ranges between 0.0 (original) and 1.0. The default value is 0.1.
+ * This parameter adjusts the red saturation level.
+ */
+ public float rednessLevel;
+
+ /**
+ * The smoothness level. The value ranges between 0.0 (original) and 1.0. The default value is
+ * 0.3.
+ */
+ public float sharpnessLevel;
+
+ /**
+ * The image enhancement options.
+ *
+ * @param contrastLevel The contrast level, used with the {@link
+ * io.agora.rtc2.video.BeautyOptions#lighteningLevel lighteningLevel} parameter:
+ *
+ * @param lightening The brightness level. The value ranges from 0.0 (original) to 1.0. The
+ * default value is 0.7.
+ * @param smoothness The sharpness level. The value ranges from 0.0 (original) to 1.0. The
+ * default value is 0.5. This parameter is usually used to remove blemishes.
+ * @param redness The redness level. The value ranges from 0.0 (original) to 1.0. The default
+ * value is 0.1. This parameter adjusts the red saturation level.
+ */
+ public BeautyOptions(
+ int contrastLevel, float lightening, float smoothness, float redness, float sharpness) {
+ this.lighteningContrastLevel = contrastLevel;
+ this.lighteningLevel = lightening;
+ this.smoothnessLevel = smoothness;
+ this.rednessLevel = redness;
+ this.sharpnessLevel = sharpness;
+ }
+
+ public BeautyOptions() {
+ this.lighteningContrastLevel = LIGHTENING_CONTRAST_NORMAL;
+ this.lighteningLevel = 0.6f;
+ this.smoothnessLevel = 0.5f;
+ this.rednessLevel = 0.1f;
+ this.sharpnessLevel = 0.3f;
+ }
+}
+
+public class Constants {
+
+ /**
+ * The audio mixing dual-mono output mode.
+ */
+ public enum AudioMixingDualMonoMode {
+ /*
+ * 0: Original mode
+ */
+ AUDIO_MIXING_DUAL_MONO_AUTO(0),
+ /*
+ * 1: Left channel mode
+ */
+ AUDIO_MIXING_DUAL_MONO_L(1),
+ /*
+ * 2: Right channel mode
+ */
+ AUDIO_MIXING_DUAL_MONO_R(2),
+ /*
+ * 3: Mixed channel mode
+ */
+ AUDIO_MIXING_DUAL_MONO_MIX(3);
+
+ private int value;
+ private AudioMixingDualMonoMode(int v) {
+ value = v;
+ }
+
+ public static int getValue(AudioMixingDualMonoMode type) {
+ return type.value;
+ }
+ }
+}
\ No newline at end of file
diff --git a/scripts/update-comment/api_comment_updater/tests/src_copy/test copy.h b/scripts/update-comment/api_comment_updater/tests/src_copy/test copy.h
new file mode 100644
index 00000000000..e681e61a7b4
--- /dev/null
+++ b/scripts/update-comment/api_comment_updater/tests/src_copy/test copy.h
@@ -0,0 +1,96 @@
+//
+// Agora SDK
+//
+#pragma once // NOLINT(build/header_guard)
+
+namespace agora {
+namespace rtc {
+
+class IRtcEngine : public agora::base::IEngineBase {
+ public:
+
+};
+
+
+enum STREAM_FALLBACK_OPTIONS {
+ /** 0: No fallback operation to a lower resolution stream when the network
+ condition is poor. Fallback to Scalable Video Coding (e.g. SVC)
+ is still possible, but the resolution remains in high stream.
+ The stream quality cannot be guaranteed. */
+ STREAM_FALLBACK_OPTION_DISABLED = 0,
+ /** 1: (Default) Under poor network conditions, the receiver SDK will receive
+ agora::rtc::VIDEO_STREAM_LOW. You can only set this option in
+ RtcEngineParameters::setRemoteSubscribeFallbackOption. */
+ STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW = 1,
+ /** 2: Under poor network conditions, the SDK may receive agora::rtc::VIDEO_STREAM_LOW first,
+ then agora::rtc::VIDEO_STREAM_LAYER_1 to agora::rtc::VIDEO_STREAM_LAYER_6 if the related layer exists.
+ If the network still does not allow displaying the video, the SDK will receive audio only. */
+ STREAM_FALLBACK_OPTION_AUDIO_ONLY = 2,
+ /** 3~8: If the receiver SDK uses RtcEngineParameters::setRemoteSubscribeFallbackOption,it will receive
+ one of the streams from agora::rtc::VIDEO_STREAM_LAYER_1 to agora::rtc::VIDEO_STREAM_LAYER_6
+ if the related layer exists when the network condition is poor. The lower bound of fallback depends on
+ the STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_X. */
+ STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_1 = 3,
+ STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_2 = 4,
+ STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_3 = 5,
+ STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_4 = 6,
+ STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_5 = 7,
+ STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_6 = 8,
+};
+
+
+/**
+ * The video noise reduction options.
+ *
+ * @since v4.0.0
+ */
+struct VideoDenoiserOptions {
+ /** The video noise reduction mode.
+ */
+ enum VIDEO_DENOISER_MODE {
+ /** 0: (Default) Automatic mode. The SDK automatically enables or disables the video noise
+ reduction feature according to the ambient light. */
+ VIDEO_DENOISER_AUTO = 0,
+ /** Manual mode. Users need to enable or disable the video noise reduction feature manually. */
+ VIDEO_DENOISER_MANUAL = 1,
+ };
+ /**
+ * The video noise reduction level.
+ */
+ enum VIDEO_DENOISER_LEVEL {
+ /**
+ * 0: (Default) Promotes video quality during video noise reduction. `HIGH_QUALITY` balances
+ * performance consumption and video noise reduction quality. The performance consumption is
+ * moderate, the video noise reduction speed is moderate, and the overall video quality is
+ * optimal.
+ */
+ VIDEO_DENOISER_LEVEL_HIGH_QUALITY = 0,
+ /**
+ * Promotes reducing performance consumption during video noise reduction. `FAST` prioritizes
+ * reducing performance consumption over video noise reduction quality. The performance
+ * consumption is lower, and the video noise reduction speed is faster. To avoid a noticeable
+ * shadowing effect (shadows trailing behind moving objects) in the processed video, Agora
+ * recommends that you use `FAST` when the camera is fixed.
+ */
+ VIDEO_DENOISER_LEVEL_FAST = 1,
+ };
+ /** The video noise reduction mode. See #VIDEO_DENOISER_MODE.
+ */
+ VIDEO_DENOISER_MODE mode;
+
+ /** The video noise reduction level. See #VIDEO_DENOISER_LEVEL.
+ */
+ VIDEO_DENOISER_LEVEL level;
+
+ VideoDenoiserOptions(VIDEO_DENOISER_MODE denoiserMode, VIDEO_DENOISER_LEVEL denoiserLevel)
+ : mode(denoiserMode), level(denoiserLevel) {}
+
+ VideoDenoiserOptions() : mode(VIDEO_DENOISER_AUTO), level(VIDEO_DENOISER_LEVEL_HIGH_QUALITY) {}
+};
+
+} // namespace commons
+} // namespace agora
+
+
+
+#undef OPTIONAL_LOG_LEVEL_SPECIFIER
\ No newline at end of file
diff --git a/scripts/update-comment/api_comment_updater/tests/src_copy/test copy.java b/scripts/update-comment/api_comment_updater/tests/src_copy/test copy.java
new file mode 100644
index 00000000000..3759776b7ea
--- /dev/null
+++ b/scripts/update-comment/api_comment_updater/tests/src_copy/test copy.java
@@ -0,0 +1,141 @@
+package io.agora.rtc2;
+
+public abstract class RtcEngine {
+ protected static RtcEngineImpl mInstance = null;
+ /**
+ * Checks whether the speakerphone is enabled.
+ *
+ * @return
+ * - true: The speakerphone is enabled, and the audio plays from the speakerphone.
+ * - false: The speakerphone is not enabled, and the audio plays from devices other than the
+ * speakerphone. For example, the headset or earpiece.
+ */
+ public abstract boolean isSpeakerphoneEnabled();
+}
+
+/**
+ * Sets the image enhancement options.
+ */
+public class BeautyOptions {
+ /**
+ * 0: low contrast for lightening.
+ */
+ public static final int LIGHTENING_CONTRAST_LOW = 0;
+
+ /**
+ * 1: normal contrast for lightening.
+ */
+ public static final int LIGHTENING_CONTRAST_NORMAL = 1;
+
+ /**
+ * 2: high contrast for lightening.
+ */
+ public static final int LIGHTENING_CONTRAST_HIGH = 2;
+
+ /**
+ * The lightening contrast level, used with {@link
+ * io.agora.rtc2.video.BeautyOptions#lighteningLevel lighteningLevel}:
+ */
+ public int lighteningContrastLevel;
+
+ /**
+ * The brightness level. The value ranges between 0.0 (original) and 1.0. The default value is
+ * 0.6.
+ */
+ public float lighteningLevel;
+
+ /**
+ * The smoothness level. The value ranges between 0.0 (original) and 1.0. The default value is
+ * 0.5. This parameter is usually used to remove blemishes.
+ */
+ public float smoothnessLevel;
+
+ /**
+ * The redness level. The value ranges between 0.0 (original) and 1.0. The default value is 0.1.
+ * This parameter adjusts the red saturation level.
+ */
+ public float rednessLevel;
+
+ /**
+ * The smoothness level. The value ranges between 0.0 (original) and 1.0. The default value is
+ * 0.3.
+ */
+ public float sharpnessLevel;
+
+ /**
+ * The image enhancement options.
+ *
+ * @param contrastLevel The contrast level, used with the {@link
+ * io.agora.rtc2.video.BeautyOptions#lighteningLevel lighteningLevel} parameter:
+ *