Merge branch 'master' into release/rtc-ng/4.2.3

dita/RTC-NG/config/keys-rtc-ng-links-android.ditamap

@@ -26,7 +26,7 @@
                 </keywords>
             </topicmeta>
         </keydef>
-        <keydef keys="guide-token" href="https://doc.shengwang.cn/doc/rtc/android/basic-features/token-authentication" scope="external" scope="external" format="html">
+        <keydef keys="guide-token" href="https://doc.shengwang.cn/doc/rtc/android/basic-features/token-authentication" scope="external" format="html">
             <topicmeta>
                 <keywords>
                     <keyword>使用 Token 鉴权</keyword>

dita/RTC-NG/release/release_notes.dita

@@ -95,8 +95,8 @@
                         <li><codeph><apiname keyref="LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_HIDDEN"/></codeph></li>
                         <li><codeph><apiname keyref="LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_MINIMIZED"/></codeph></li>
                         </ul></li>
-                    <li  props="cpp unity flutter electron"><codeph><apiname keyref="ExternalVideoFrame"/></codeph> 中新增 <codeph>d3d11_texture_2d</codeph> 和 <codeph>texture_slice_index</codeph> 成员</li> (Windows)
-                    <li  props="cpp unity flutter electron"><codeph><apiname keyref="VIDEO_PIXEL_FORMAT"/></codeph> 中新增 <codeph><apiname keyref="VIDEO_TEXTURE_ID3D11TEXTURE2D"/></codeph> 枚举</li> (Windows)
+                    <li  props="cpp unity flutter electron"><codeph><apiname keyref="ExternalVideoFrame"/></codeph> 中新增 <codeph>d3d11_texture_2d</codeph> 和 <codeph>texture_slice_index</codeph> 成员(Windows)</li> 
+                    <li  props="cpp unity flutter electron"><codeph><apiname keyref="VIDEO_PIXEL_FORMAT"/></codeph> 中新增 <codeph><apiname keyref="VIDEO_TEXTURE_ID3D11TEXTURE2D"/></codeph> 枚举 (Windows)</li> 
                     <li><codeph><apiname keyref="enableContentInspectEx"/></codeph></li>
                     <li props="cpp apple rn unity flutter"><codeph><apiname keyref="CONTENT_INSPECT_TYPE"/></codeph> 新增 <codeph><apiname keyref="CONTENT_INSPECT_IMAGE_MODERATION"/></codeph> </li>
                     <li props="android"><codeph><apiname keyref="ContentInspectModule"/></codeph> 中的 <codeph>type</codeph> 新增 <codeph><apiname keyref="CONTENT_INSPECT_IMAGE_MODERATION"/></codeph> </li>

en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita

@@ -34,7 +34,7 @@
                 <pt props="ios mac">delegate</pt>
                 <pt props="unity cs">audioFrameObserver</pt>
                 <pd>
-                    <p>The <ph> observer instance. See <xref keyref="IAudioFrameObserver" /></ph>. <ph props="android mac ios unity cpp unreal bp cs">Set the value as <ph keyref="NULL" /> to release the instance. </ph><ph>Agora recommends calling this method after receiving <xref keyref="onLeaveChannel" /> to release the audio observer object.</ph></p>
+                    <p>The  observer instance. <ph>See <xref keyref="IAudioFrameObserver" /></ph>. <ph props="android mac ios unity cpp unreal bp cs">Set the value as <ph keyref="NULL" /> to release the instance. </ph><ph>Agora recommends calling this method after receiving <xref keyref="onLeaveChannel" /> to release the audio observer object.</ph></p>
                 </pd>
             </plentry>
             <plentry props="unity cs">

en-US/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita

@@ -43,7 +43,7 @@
                 <pt props="android cpp unreal bp electron rn flutter">observer</pt>
                 <pt props="ios mac">delegate</pt>
                 <pt props="unity cs">videoFrameObserver</pt>
-                <pd>The <ph> observer instance. See <xref keyref="IVideoFrameObserver" /></ph>. <ph props="android cpp unreal bp ios mac unity cs">To release the instance, set the value as <ph keyref="NULL" />.</ph></pd>
+                <pd>The  observer instance. <ph>See <xref keyref="IVideoFrameObserver" /></ph>. <ph props="android cpp unreal bp ios mac unity cs">To release the instance, set the value as <ph keyref="NULL" />.</ph></pd>
             </plentry>
             <plentry props="unity cs">
                 <pt>mode</pt>

en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita

@@ -45,7 +45,7 @@
             <p>Call this method before calling <xref keyref="enableVideo" /> or <xref keyref="startPreview2" />.</p>
             <note type="attention">
             <ul>
-            <li>This feature requires high performance devices. Agora recommends that you implement it on devices equipped with the following chips:<ul>
+            <li>This feature has high requirements on device performance. When calling this method, the SDK automatically checks the capabilities of the current device. Agora recommends you use virtual background on devices with the following processors:<ul>
                 <li props="android unity cpp unreal bp rn flutter cs">Snapdragon 700 series 750G and later</li>
                 <li props="android unity cpp unreal bp rn flutter cs">Snapdragon 800 series 835 and later</li>
                 <li props="android unity cpp unreal bp rn flutter cs">Dimensity 700 series 720 and later</li>
@@ -101,9 +101,7 @@
             <ul>
             <li props="native unreal bp electron unity rn cs">0: Success.</li>
             <li>&lt; 0: Failure.<ul>
-                <li>-1: The custom background image does not exist. Check the value of <parmname>source</parmname> in <xref keyref="VirtualBackgroundSource" />.</li>
-                <li>-2: The color format of the custom background image is invalid. Check the value of <parmname>color</parmname> in <xref keyref="VirtualBackgroundSource" />.</li>
-                <li>-3: The device does not support virtual background.</li>
+                <li>-4: The device capabilities do not meet the requirements for the virtual background feature. Agora recommends you try it on devices with higher performance.</li>
                 </ul></li>
             </ul> </section>
     </refbody>

en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita

@@ -48,7 +48,7 @@
             </plentry>
             <plentry>
                 <pt>iconSize</pt>
-                <pd><ph>The target size of the icon corresponding to the application program (the width and height are in pixels). </ph><ph props="cpp unreal bp">See <xref keyref="SIZE-link" />. </ph><ph>The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and <parmname>iconSize</parmname> is 100 × 100, the actual size of the icon is 100 × 75. If the target size is larger than the original size, the icon is the original image and the SDK does not scale it.</ph></pd>
+                <pd><ph>The target size of the icon corresponding to the application program (the width and height are in pixels). </ph><ph props="cpp unreal bp">See <xref keyref="SIZE-link" />. </ph><ph>The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and iconSize is 100 × 100, the actual size of the<parmname> icon</parmname> is 100 × 75. If the target size is larger than the original size, the icon is the original image and the SDK does not scale it.</ph></pd>
             </plentry>
             <plentry>
                 <pt>includeScreen</pt>

en-US/dita/RTC-NG/API/api_irtcengine_muteallremoteaudiostreams.dita

@@ -29,7 +29,8 @@
             <ul>
             <li>Call this method after joining a channel.</li>
             <li>If you do not want to subscribe the audio streams of remote users before joining a channel, you can set <parmname>autoSubscribeAudio</parmname> as <codeph><ph keyref="false" /></codeph> when calling <xref keyref="joinChannel2" />.</li>
-            <li props="ios android cpp unreal bp"><ph>See recommended settings in <xref keyref="guide-set-subscribing-state">Set the Subscribing State</xref>.</ph></li>
+            <li props="hide"><ph>See recommended settings in <xref keyref="guide-set-subscribing-state">Set the Subscribing State</xref>.</ph></li>
+
             </ul> </note> </section>
         <section id="parameters">
             <title>Parameters</title>

en-US/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita

@@ -40,7 +40,8 @@
                 <ul>
                     <li>Call this method before calling <xref keyref="enableVideo" /> or <xref keyref="startPreview2" />.</li>
                     <li props="android">This method only applies to Android 5.0 or later.</li>
-                    <li>This method relies on the video enhancement dynamic library <codeph><ph keyref="clearvision" /></codeph>. If the dynamic library is deleted, the function cannot be enabled normally.</li>
+                    <li>This method relies on the image enhancement dynamic library <codeph><ph keyref="clearvision" /></codeph>. If the dynamic library is deleted, the function cannot be enabled normally.</li>
+                    <li>This feature has high requirements on device performance. When calling this method, the SDK automatically checks the capabilities of the current device.</li>
                 </ul>
             </note> </section>
         <section id="parameters">
@@ -68,9 +69,15 @@
             <p props="flutter">When the method call succeeds, there is no return value; when fails, the <xref keyref="AgoraRtcException" /> exception is thrown; and you need to catch the exception and handle it accordingly. <ph props="cn">See <xref keyref="error-code-link" /> for details and resolution suggestions.</ph></p>
             <ul>
             <li props="native unreal bp electron unity rn cs">0: Success.</li>
-            <li>&lt; 0: Failure.<ul props="android rn unity flutter cs">
-                <li><ph keyref="ERR_NOT_SUPPORTED" />(4): The current device version is below Android 5.0, and this operation is not supported.</li>
-                </ul></li>
-            </ul> </section>
+            <li>&lt; 0: Failure.<ul>
+                    <li>-4: The current device does not support this feature. Possible reasons include:<ul>
+                            <li>The current device capabilities do not meet the requirements for image enhancement. Agora recommends you replace it with a high-performance device.</li>
+                            <li props="android rn unity flutter cs">The current device version is lower than Android 5.0 and does not support this feature. Agora recommends you replace the device or upgrade the operating system.</li>
+                        </ul>
+                    </li>
+                </ul>
+            </li>
+            </ul>
+        </section>
     </refbody>
 </reference>

en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita

@@ -48,7 +48,7 @@
                     <li>When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).</li>
                     <li>When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using <apiname keyref="setExtensionProperty" />.</li>
                 </ul></li>
-            <li>This method relies on the video enhancement dynamic library <codeph><ph keyref="clearvision" /></codeph>. If the dynamic library is deleted, the function cannot be enabled normally.</li>
+            <li>This method relies on the image enhancement dynamic library <codeph><ph keyref="clearvision" /></codeph>. If the dynamic library is deleted, the function cannot be enabled normally.</li>
             </ul> </note> </section>
         <section id="parameters">
             <title>Parameters</title>

en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita

@@ -48,7 +48,7 @@
                 <li>When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).</li>
                 <li>When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using <apiname keyref="setExtensionProperty" />.</li>
                 </ul></li>
-            <li>This method relies on the video enhancement dynamic library <codeph><ph keyref="clearvision" /></codeph>. If the dynamic library is deleted, the function cannot be enabled normally.</li>
+            <li>This method relies on the image enhancement dynamic library <codeph><ph keyref="clearvision" /></codeph>. If the dynamic library is deleted, the function cannot be enabled normally.</li>
             </ul> </note> </section>
         <section id="parameters">
             <title>Parameters</title>

en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita

@@ -48,7 +48,7 @@
                 <li>When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).</li>
                 <li>When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using <apiname keyref="setExtensionProperty" />.</li>
                 </ul></li>
-            <li>This method relies on the video enhancement dynamic library <codeph><ph keyref="clearvision" /></codeph>. If the dynamic library is deleted, the function cannot be enabled normally.</li>
+            <li>This method relies on the image enhancement dynamic library <codeph><ph keyref="clearvision" /></codeph>. If the dynamic library is deleted, the function cannot be enabled normally.</li>
             </ul> </note> </section>
         <section id="parameters">
             <title>Parameters</title>

en-US/dita/RTC-NG/API/api_irtcengineex_muteallremoteaudiostreamsex.dita

@@ -37,7 +37,7 @@
             <ul>
             <li>Call this method after joining a channel.</li>
             <li>If you do not want to subscribe the audio streams of remote users before joining a channel, you can set <parmname>autoSubscribeAudio</parmname> as <codeph><ph keyref="false" /></codeph> when calling <xref keyref="joinChannel2" />.</li>
-            <li props="ios android cpp unreal bp"><ph>See recommended settings in <xref keyref="guide-set-subscribing-state">Set the Subscribing State</xref>.</ph></li>
+            <li props="hide"><ph>See recommended settings in <xref keyref="guide-set-subscribing-state">Set the Subscribing State</xref>.</ph></li>
             </ul> </note> </section>
         <section id="parameters">
             <title>Parameters</title>

en-US/dita/RTC-NG/API/class_channelmediaoptions.dita

@@ -688,7 +688,7 @@ class ChannelMediaOptions {
             <plentry>
                 <pt>token</pt>
                 <pd>
-                    <p>(Optional) The token generated on your server for authentication. See <xref keyref="guide-token" props="native unreal bp">Authenticate Your Users with Token</xref>.</p>
+                    <p>(Optional) The token generated on your server for authentication. See <xref keyref="guide-token" />.</p>
                     <note type="caution">
                     <ul>
                     <li>This parameter takes effect only when calling <xref keyref="updateChannelMediaOptions" /> or <xref keyref="updateChannelMediaOptionsEx" />.</li>

en-US/dita/RTC-NG/API/class_livetranscoding.dita

@@ -595,7 +595,7 @@
         <pt>videoBitrate</pt>
         <pd>
           <p>Bitrate of the output video stream for Media Push in Kbps. The default value is 400 Kbps.</p>
-          <p props="native unreal bp">Set this member according to the <xref keyref="video-profile-table">Video profile</xref> table. If you set a bitrate beyond the proper range, the SDK automatically adapts it to a value within the range.</p>
+          <p>Set this member according to the <xref keyref="video-profile-table" /> table. If you set a bitrate beyond the proper range, the SDK automatically adapts it to a value within the range.</p>
         </pd>
       </plentry>
       <plentry>

en-US/dita/RTC-NG/API/enum_audioprocessingchannels.dita

@@ -12,8 +12,8 @@
             </ol></p>
             <note type="attention">
             <ul>
-            <li>The stereo setting only takes effect when the SDK uses the media volume. <ph props="android ios">See <xref keyref="volume-type"/>. </ph><ph props="cpp unreal bp unity">See <xref keyref="volume-type-android"/>and <xref keyref="volume-type-ios"/>.</ph></li>
-            <li props="cpp unreal bp ios rn unity">On iOS, stereo audio requires high device performance. Stereo audio is only supported on the following devices using iOS 14.0 and later:<ul>
+            <li>The stereo setting only takes effect when the SDK uses the media volume. <ph props="android ios">See <xref keyref="volume-type"/>. </ph><ph props="cpp unreal bp unity flutter rn">See <xref keyref="volume-type-android"/>and <xref keyref="volume-type-ios"/>.</ph></li>
+            <li props="cpp unreal bp ios rn unity flutter">On iOS, stereo audio requires high device performance. Stereo audio is only supported on the following devices using iOS 14.0 and later:<ul>
                 <li>iPhone XS</li>
                 <li>iPhone XS Max</li>
                 <li>iPhone XR</li>

en-US/dita/RTC-NG/API/rtc_api_overview.dita

@@ -904,10 +904,6 @@
                 <stentry><xref keyref="startScreenCaptureByWindowId"/></stentry>
                 <stentry><ph conkeyref="startScreenCaptureByWindowId/shortdesc"/><ph props="cpp unreal bp electron flutter unity"> (For Windows and macOS only)</ph></stentry>
             </strow>
-            <strow props="cpp unreal bp unity flutter electron cs">
-                <stentry><xref keyref="startScreenCaptureByScreenRect"/></stentry>
-                <stentry><ph conkeyref="startScreenCaptureByScreenRect/shortdesc"/><ph props="cpp unreal bp unity flutter electron"> (For Windows only)</ph></stentry>
-            </strow>
             <strow props="cpp unreal bp mac electron flutter unity cs">
                 <stentry><xref keyref="startScreenCaptureByDisplayId"/></stentry>
                 <stentry><ph conkeyref="startScreenCaptureByDisplayId/shortdesc"/><ph props="cpp unreal bp unity electron flutter"> (For Windows and macOS only)</ph></stentry>