Merge pull request #3535 from AgoraIO/translation/4.x-api-ref

Cilla-luodan · web-flow · commit 91a240a20e08 · 2024-02-29T14:34:21.000+08:00
New YiCAT updates
diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_selectmultiaudiotrack.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_selectmultiaudiotrack.dita
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
-<reference id="api_Imediaplayer_selectmultiaudiotrack">
+<reference id="api_imediaplayer_selectmultiaudiotrack">
     <title><ph keyref="selectMultiAudioTrack"/></title>
     <shortdesc id="short"><ph id="shortdesc">Selects the audio tracks that you want to play on your local device and publish to the channel respectively.</ph></shortdesc>
     <prolog>
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableextension.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableextension.dita
@@ -71,13 +71,11 @@
                     </ul></p>
                 </pd>
             </plentry>
-            <plentry id="source" props="cpp unreal bp unity rn electron flutter cs">
-                    <pt>type</pt>
-                    <pd>Type of media source. See <xref keyref="MEDIA_SOURCE_TYPE" />.<note type="attention">In this method, this parameter supports only the following two settings:<ul>
-                        <li>The default value is <apiname keyref="UNKNOWN_MEDIA_SOURCE" />.</li>
-                        <li>If you want to use the second camera to capture video, set this parameter to <apiname keyref="SECONDARY_CAMERA_SOURCE" />.</li>
-                        </ul></note></pd>
-                </plentry>
+            <plentry id="source">
+                <pt props="cpp apple unreal bp unity rn electron flutter cs">type</pt>
+                <pt props="android">sourceType</pt>
+                <pd>Source type of the extension. See <xref keyref="MEDIA_SOURCE_TYPE" />.</pd>
+            </plentry>
             </parml> </section>
         <section id="return_values">
             <title><ph keyref="return-section-title"/></title>
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registerextension.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registerextension.dita
@@ -48,7 +48,14 @@
             </dlentry>
             </dl>
             <p>After the extension is loaded, you can call this method to register the extension.</p>
-            <p props="cpp unreal bp electron unity flutter">This method applies to Windows only.</p>
+            <note type="attention">
+                <ul>
+                <li props="android">Before calling this method, you need to call <xref keyref="addExtension"/> to load the extension first.</li>
+                <li props="apple">Before calling this method, you need to link the extension dynamic library (.xcframework) to your project in Xcode.</li>
+                <li props="cpp framework">Before calling this method, you need to call <xref keyref="loadExtensionProvider"/> to load the extension first.</li>
+                <li>For extensions external to the SDK (such as Extensions Marketplace extensions and SDK extensions), you need to call this method before calling <xref keyref="setExtensionProperty"/>.</li> 
+                </ul>              
+            </note>
         </section>
         <section id="parameters">
             <title>Parameters</title>
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setainsmode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setainsmode.dita
@@ -44,7 +44,7 @@
         </section>
         <section id="scenario">
             <title>Applicable scenarios</title>
-            <p>In scenarios such as co-hosting, online education and video meeting, this function can detect and reduce background noises to improve experience.</p>
+            <p>In scenarios such as co-streaming, online education and video meeting, this function can detect and reduce background noises to improve experience.</p>
         </section>
         <section id="parameters">
             <title>Parameters</title>
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita
@@ -2,7 +2,7 @@
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
 <reference id="api_irtcengine_setlocalaccesspoint">
     <title><ph keyref="setLocalAccessPoint" /></title>
-    <shortdesc id="short"><ph id="shortdesc">Configure the connection with the native access module of the Agora network private media server.</ph></shortdesc>
+    <shortdesc id="short"><ph id="shortdesc">Configures the connection with the access module of the Agora network private media server.</ph></shortdesc>
     <prolog>
         <metadata>
             <keywords>
@@ -26,7 +26,7 @@
         </section>
         <section id="detailed_desc">
             <title>Details</title>
-            <p>After successfully deploying the Agora private media server and integrating Agora Native SDK v4.0.0 on the intranet terminal, you can call this method to specify the Local Access Point and assign the Native access module to the SDK.</p>
+            <p>After successfully deploying the Agora private media server and integrating the RTC SDK on the intranet terminal, you can call this method to specify the Local Access Point and assign the access module to the SDK.</p>
             <note type="attention">
             <ul>
             <li>This method takes effect only after the Agora hybrid cloud solution is deployed. You can contact <xref keyref="mailto-link" /> to get to know more about the Agora hybrid cloud solution.</li>
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita
@@ -57,9 +57,9 @@
             <plentry id="enable">
                 <pt props="android cpp unreal bp electron unity rn flutter cs">enabled</pt>
                 <pt props="ios mac">enable</pt>
-                <pd>Whether to enable low-light enhancement function:<ul>
-                    <li><codeph><ph keyref="true" /></codeph>: Enable low-light enhancement function.</li>
-                    <li><codeph><ph keyref="false" /></codeph>: (Default) Disable low-light enhancement function.</li>
+                <pd>Whether to enable low-light enhancement:<ul>
+                    <li><codeph><ph keyref="true" /></codeph>: Enable low-light enhancement.</li>
+                    <li><codeph><ph keyref="false" /></codeph>: (Default) Disable low-light enhancement.</li>
                     </ul></pd>
             </plentry>
             <plentry id="options">
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita
@@ -29,7 +29,7 @@
         </section>
         <section id="detailed_desc">
             <title>Details</title>
-            <p id="apisequence" props="android ios cpp unreal bp unity flutter cs">There are two ways to start screen sharing, you can choose one according to your needs:<ul>
+            <p id="apisequence" props="android ios cpp unreal bp unity flutter cs">There are two options for enabling screen sharing. You can choose the one that best suits your specific scenario:<ul>
             <li>Call this method before joining a channel, then call <xref keyref="joinChannel2"/> to join channel and set <parmname>publishScreenCaptureVideo</parmname> to <codeph><ph keyref="true"/></codeph> to start screen sharing.</li>
             <li>Call this method after joining a channel, then call <xref keyref="updateChannelMediaOptions"/> and set <parmname>publishScreenCaptureVideo</parmname> to <codeph><ph keyref="true"/></codeph> to start screen sharing.</li>
             </ul></p>
@@ -42,9 +42,7 @@
             <li props="cpp unreal bp ios unity rn flutter cs">If you are using the custom audio source instead of the SDK to capture audio, Agora recommends you add the keep-alive processing logic to your application to avoid screen sharing stopping when the application goes to the background.</li>
             <li props="cpp unreal bp ios unity rn flutter cs">This feature requires high-performance device, and Agora recommends that you use it on iPhone X and later models.</li>
             <li props="cpp unreal bp ios unity rn flutter cs">This method relies on the iOS screen sharing dynamic library <codeph>AgoraReplayKitExtension.xcframework</codeph>. If the dynamic library is deleted, screen sharing cannot be enabled normally.</li>
-            <li props="cpp unreal bp android unity rn flutter cs">On the Android platform, make sure the user has granted the app screen capture permission.</li>
-            <li props="cpp unreal bp android">Make sure that the Android API level is not earlier than 21, otherwise, the SDK reports error codes <codeph><apiname keyref="ERR_SCREEN_CAPTURE_PERMISSION_DENIED"/>(16)</codeph> and <codeph><apiname keyref="ERR_SCREEN_CAPTURE_SYSTEM_NOT_SUPPORTED"/>(2)</codeph>.</li>
-            <li props="cpp unreal bp android">To capture system audio during screen sharing, ensure that the Android API level is not earlier than 29 as well; otherwise, the SDK reports the error code <codeph><apiname keyref="ERR_SCREEN_CAPTURE_SYSTEM_AUDIO_NOT_SUPPORTED"/>(3)</codeph>.</li>
+            <li props="cpp unreal bp android unity rn flutter cs">On the Android platform, if the user has not granted the app screen capture permission, the SDK reports the <xref keyref="onPermissionError"/><codeph>(2)</codeph> callback.</li>
             <li props="cpp unreal bp android unity rn flutter cs">On Android 9 and later, to avoid the application being killed by the system after going to the background, Agora recommends you add the foreground service <codeph>android.permission.FOREGROUND_SERVICE</codeph> to the <codeph>/app/Manifests/AndroidManifest.xml</codeph> file.</li>
             <li props="cpp unreal bp android unity rn flutter cs">Due to performance limitations, screen sharing is not supported on Android TV.</li>
             <li props="cpp unreal bp android unity rn flutter cs">Due to system limitations, if you are using Huawei phones, do not adjust the video encoding resolution of the screen sharing stream during the screen sharing, or you could experience crashes.</li>
@@ -66,8 +64,10 @@
             <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 props="cpp unreal bp android ios unity rn cs">
             <li>0: Success.</li>
-            <li>&lt; 0: Failure.<ul>
-                <li>-2: The parameter is null.</li>
+            <li>&lt; 0: Failure. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph><ul>
+                <li props="ios cpp framework">-2 (iOS platform): Empty parameter.</li>
+                <li props="android cpp framework">-2 (Android platform): The system version is too low. Ensure that the Android API level is not lower than 21.</li>
+                <li props="android cpp framework">-3 (Android platform): Unable to capture system audio. Ensure that the Android API level is not lower than 29.</li>
                 </ul></li>
             </ul> </section>
     </refbody>
diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelaystatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelaystatechanged.dita
@@ -63,13 +63,13 @@ channelMediaRelayStateDidChange:(AgoraChannelMediaRelayState)state
                     <p props="android bp">The error code of the channel media relay.<ul>
                     <li><ph keyref="RELAY_OK" />(0): Everything is normal.</li>
                     <li><ph keyref="RELAY_ERROR_SERVER_ERROR_RESPONSE" />(1): An error occurs in the server response.</li>
-                    <li><ph keyref="RELAY_ERROR_SERVER_NO_RESPONSE" />(2): No server response. This error may be caused by poor network connections. If this error occurs when initiating a cross-channel media relay, you can try again later; if this error occurs during the cross-channel media relay, you can call <xref keyref="leaveChannel2" /> to leave the channel. This error can also occur if your project has not enabled co-host token authentication. You can <xref keyref="ticket-link" /> to enable the service for cohosting across channels before starting a channel media relay.</li>
+                    <li><ph keyref="RELAY_ERROR_SERVER_NO_RESPONSE" />(2): No server response. This error may be caused by poor network connections. If this error occurs when initiating a channel media relay, you can try again later; if this error occurs during channel media relay, you can call <xref keyref="leaveChannel2" /> to leave the channel. This error can also occur if the channel media relay service is not enabled in the project. You can contact <xref keyref="ticket-link" /> to enable the service.</li>
                     <li><ph keyref="RELAY_ERROR_NO_RESOURCE_AVAILABLE" />(3): The SDK fails to access the service, probably due to limited resources of the server.</li>
                     <li><ph keyref="RELAY_ERROR_FAILED_JOIN_SRC" />4: The server fails to send the relay request.</li>
                     <li><ph keyref="RELAY_ERROR_FAILED_JOIN_DEST" />5: The server fails to accept the relay request.</li>
                     <li><ph keyref="RELAY_ERROR_FAILED_PACKET_RECEIVED_FROM_SRC" />6: The server fails to receive the media stream.</li>
                     <li><ph keyref="RELAY_ERROR_FAILED_PACKET_SENT_TO_DEST" />7: The server fails to send the media stream.</li>
-                    <li><ph keyref="RELAY_ERROR_SERVER_CONNECTION_LOST" />(8): The SDK disconnects from the server due to poor network connections. You can call the <xref keyref="leaveChannel2" /> method to leave the channel.</li>
+                    <li><ph keyref="RELAY_ERROR_SERVER_CONNECTION_LOST" />(8): The SDK disconnects from the server due to poor network connections. You can call <xref keyref="leaveChannel2" /> to leave the channel.</li>
                     <li><ph keyref="RELAY_ERROR_INTERNAL_ERROR" />(9): An internal error occurs in the server.</li>
                     <li><ph keyref="RELAY_ERROR_SRC_TOKEN_EXPIRED" />(10): The token of the source channel has expired.</li>
                     <li><ph keyref="RELAY_ERROR_DEST_TOKEN_EXPIRED" />(11): The token of the destination channel has expired.</li>
diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onextensionerror.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onextensionerror.dita
@@ -45,7 +45,7 @@
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="detailed_desc">
-            <p>When calling <xref keyref="enableExtension" /><codeph>(<ph keyref="true" />)</codeph> fails or the extension runs in error, the extension triggers this callback and reports the error code and reason.</p>
+            <p>In case of extension enabling failure or runtime errors, the extension triggers this callback and reports the error code along with the reasons.</p>
         </section>
         <section id="parameters">
             <title>Parameters</title>
diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onextensionstarted.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onextensionstarted.dita
@@ -29,7 +29,7 @@
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="detailed_desc">
-            <p>After a successful call of <xref keyref="enableExtension" /><codeph>(<ph keyref="true" />)</codeph>, the extension triggers this callback.</p>
+            <p>The extension triggers this callback after it is successfully enabled.</p>
         </section>
         <section id="parameters">
             <title>Parameters</title>
diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onextensionstopped.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onextensionstopped.dita
@@ -29,7 +29,7 @@
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="detailed_desc">
-            <p>After a successful call of <xref keyref="enableExtension" /><codeph>(<ph keyref="false" />)</codeph>, this callback is triggered.</p>
+            <p>The extension triggers this callback after it is successfully destroyed.</p>
         </section>
         <section id="parameters">
             <title>Parameters</title>
diff --git a/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita b/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita
@@ -812,7 +812,7 @@ class ChannelMediaOptions {
                     </ul>
                     <note type="attention">
                     <ul>
-                    <li>This parameter only applies to scenarios involving cohosting across channels. The cohosts need to call the <xref keyref="joinChannelEx"/> method to join the other host's channel as an audience member, and set <parmname>isInteractiveAudience</parmname> to <codeph><ph keyref="true"/></codeph>.</li>
+                    <li>This parameter only applies to co-streaming scenarios. The cohosts need to call the <xref keyref="joinChannelEx"/> method to join the other host's channel as an audience member, and set <parmname>isInteractiveAudience</parmname> to <codeph><ph keyref="true"/></codeph>.</li>
                     <li>This parameter takes effect only when the user role is <apiname keyref="CLIENT_ROLE_AUDIENCE"/>.</li>
                     </ul> </note> </pd>
             </plentry>
diff --git a/en-US/dita/RTC-NG/API/class_spatialaudioparams.dita b/en-US/dita/RTC-NG/API/class_spatialaudioparams.dita
@@ -258,7 +258,7 @@ struct FSpatialAudioParams
           </ul>
           <note type="caution">
           <ul>
-          <li>This parameter is suitable for scenarios where the sound source is moving at high speed (for example, racing games). It is not recommended for common audio and video interactive scenarios (for example, voice chat, cohosting, or online KTV).</li>
+          <li>This parameter is suitable for scenarios where the sound source is moving at high speed (for example, racing games). It is not recommended for common audio and video interactive scenarios (for example, voice chat, co-streaming, or online KTV).</li>
           <li>When this parameter is enabled, Agora recommends that you set a regular period (such as 30 ms), and then call the <xref keyref="updatePlayerPositionInfo"/>, <xref keyref="updateSelfPosition"/>, and <xref keyref="updateRemotePosition"/> methods to continuously update the relative distance between the sound source and the receiver. The following factors can cause the Doppler effect to be unpredictable or the sound to be jittery: the period of updating the distance is too long, the updating period is irregular, or the distance information is lost due to network packet loss or delay.</li>
           </ul> </note></pd>
       </plentry>
diff --git a/en-US/dita/RTC-NG/API/class_watermarkoptions.dita b/en-US/dita/RTC-NG/API/class_watermarkoptions.dita
@@ -154,7 +154,7 @@ class WatermarkOptions {
             <parml>
             <plentry>
                 <pt>visibleInPreview</pt>
-                <pd>Is the watermark visible in the local preview view?<ul>
+                <pd>Whether the watermark is visible in the local preview view:<ul>
                     <li><codeph><ph keyref="true"/></codeph>: (Default) The watermark is visible in the local preview view.</li>
                     <li><codeph><ph keyref="false"/></codeph>: The watermark is not visible in the local preview view.</li>
                     </ul>
diff --git a/en-US/dita/RTC-NG/API/enum_channelmediarelayerror.dita b/en-US/dita/RTC-NG/API/enum_channelmediarelayerror.dita
@@ -19,8 +19,8 @@
                     <pt><ph keyref="RELAY_ERROR_SERVER_NO_RESPONSE"/></pt>
                     <pd>
                          <p>2: No server response.</p>
-                         <p>You can call <xref keyref="leaveChannel" props="native unity"/> <xref keyref="leaveChannel2" props="rn electron flutter"/> to leave the channel.</p>
-                         <p>This error can also occur if your project has not enabled co-host token authentication. You can <xref keyref="ticket-link"/> to enable the service for cohosting across channels before starting a channel media relay.</p>
+                         <p>This error may be caused by poor network connections. If this error occurs when initiating a channel media relay, you can try again later; if this error occurs during channel media relay, you can call <xref keyref="leaveChannel2" /> to leave the channel.</p>
+                         <p>This error can also occur if the channel media relay service is not enabled in the project. You can contact <xref keyref="ticket-link"/> to enable the service.</p>
                     </pd>
                </plentry>
                <plentry>
@@ -45,7 +45,7 @@
                </plentry>
                <plentry>
                     <pt><ph keyref="RELAY_ERROR_SERVER_CONNECTION_LOST"/></pt>
-                    <pd>8: The SDK disconnects from the server due to poor network connections. You can call <xref keyref="leaveChannel" props="native unity"/> <xref keyref="leaveChannel2" props="rn electron flutter"/> to leave the channel.</pd>
+                    <pd>8: The SDK disconnects from the server due to poor network connections. You can call <xref keyref="leaveChannel2"/> to leave the channel.</pd>
                </plentry>
                <plentry>
                     <pt><ph keyref="RELAY_ERROR_INTERNAL_ERROR"/></pt>
diff --git a/en-US/dita/RTC-NG/API/rtc_api_overview.dita b/en-US/dita/RTC-NG/API/rtc_api_overview.dita
@@ -2542,9 +2542,9 @@
                     <stentry><xref keyref="getExtensionProperty2"/></stentry>
                     <stentry><ph conkeyref="getExtensionProperty2/shortdesc"/></stentry>
                 </strow>
-                <strow props="cpp unreal bp unity electron flutter cs">
+                <strow>
                     <stentry><xref keyref="registerExtension"/></stentry>
-                    <stentry><ph conkeyref="registerExtension/shortdesc"/><ph props="cpp unreal bp unity electron flutter"> (For Windows only)</ph></stentry>
+                    <stentry><ph conkeyref="registerExtension/shortdesc"/></stentry>
                 </strow>
                 <strow>
                     <stentry><xref keyref="onExtensionEvent"/></stentry>
