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

New YiCAT updates
AgoraIO · Sep 25, 2023 · d7ae1a4 · d7ae1a4
2 parents baead5c + 0b5d2ba
commit d7ae1a4
Show file tree

Hide file tree

Showing 503 changed files with 7,262 additions and 6,296 deletions.
diff --git a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita
@@ -1,32 +1,32 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
-<reference id="api_channelmediarelayconfiguration_getdestchannelmediainfo">
-    <title><ph keyref="getDestChannelMediaInfos" /></title>
+<reference id="api_channelmediarelayconfiguration_getdestchannelmediainfos">
+    <title><ph keyref="getDestChannelMediaInfos"/></title>
     <shortdesc id="short"><ph id="shortdesc">Gets the information of the target channel.</ph></shortdesc>
     <prolog>
         <metadata>
             <keywords>
-                <indexterm keyref="getDestChannelMediaInfos" />
+                <indexterm keyref="getDestChannelMediaInfos"/>
             </keywords>
         </metadata>
     </prolog>
     <refbody>
         <section id="prototype">
             <p outputclass="codeblock">
-            <codeblock props="android" outputclass="language-java">public Map&lt;String, ChannelMediaInfo&gt; getDestChannelMediaInfos() {
+            <codeblock props="android" outputclass="language-java">public Map&lt;String, ChannelMediaInfo> getDestChannelMediaInfos() {
   return destInfos;
 }</codeblock>
-            <codeblock props="ios mac" outputclass="language-objectivec" />
-            <codeblock props="cpp unreal bp" outputclass="language-cpp" />
-            <codeblock props="electron" outputclass="language-typescript" />
-            <codeblock props="unity cs" outputclass="language-csharp" />
-            <codeblock props="rn" outputclass="language-typescript" />
-           <codeblock props="flutter" outputclass="language-dart" /> 
-            <codeblock props="reserve" outputclass="language-cpp" /></p>
+            <codeblock props="ios mac" outputclass="language-objectivec"/>
+            <codeblock props="cpp unreal bp" outputclass="language-cpp"/>
+            <codeblock props="electron" outputclass="language-typescript"/>
+            <codeblock props="unity cs" outputclass="language-csharp"/>
+            <codeblock props="rn" outputclass="language-typescript"/>
+           <codeblock props="flutter" outputclass="language-dart"/> 
+            <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="return_values">
             <title>Returns</title>
-            <p>The information of the target channel. See <xref keyref="ChannelMediaInfo" />.</p>
+            <p>The information of the target channel. See <xref keyref="ChannelMediaInfo"/>.</p>
         </section>
     </refbody>
-</reference>
+</reference>
diff --git a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_removedestchannelinfo.dita b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_removedestchannelinfo.dita
@@ -1,12 +1,12 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
 <reference id="api_channelmediarelayconfiguration_removedestchannelinfo">
-    <title><ph keyref="removeDestChannelInfo" /></title>
+    <title><ph keyref="removeDestChannelInfo"/></title>
     <shortdesc id="short"><ph id="shortdesc">Deletes the information of target channel.</ph></shortdesc>
     <prolog>
         <metadata>
             <keywords>
-                <indexterm keyref="removeDestChannelInfo" />
+                <indexterm keyref="removeDestChannelInfo"/>
             </keywords>
         </metadata>
     </prolog>
@@ -17,12 +17,12 @@
   destInfos.remove(channelName);
 }</codeblock>
             <codeblock props="ios mac" outputclass="language-objectivec">- (BOOL)removeDestinationInfoForChannelName:(NSString *_Nonnull)channelName;</codeblock>
-            <codeblock props="cpp unreal bp" outputclass="language-cpp" />
-            <codeblock props="electron" outputclass="language-typescript" />
-            <codeblock props="unity cs" outputclass="language-csharp" />
-            <codeblock props="rn" outputclass="language-typescript" />
-           <codeblock props="flutter" outputclass="language-dart" /> 
-            <codeblock props="reserve" outputclass="language-cpp" /></p>
+            <codeblock props="cpp unreal bp" outputclass="language-cpp"/>
+            <codeblock props="electron" outputclass="language-typescript"/>
+            <codeblock props="unity cs" outputclass="language-csharp"/>
+            <codeblock props="rn" outputclass="language-typescript"/>
+           <codeblock props="flutter" outputclass="language-dart"/> 
+            <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="parameters">
             <title>Parameters</title>
@@ -34,9 +34,9 @@
             </parml> </section>
         <section id="return_values" props="ios mac">
             <ul>
-            <li><codeph><ph keyref="true" /></codeph>: Success.</li>
-            <li><codeph><ph keyref="false" /></codeph>: Failure.</li>
+            <li><codeph><ph keyref="true"/></codeph>: Success.</li>
+            <li><codeph><ph keyref="false"/></codeph>: Failure. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph></li>
             </ul>
         </section>
     </refbody>
-</reference>
+</reference>
diff --git a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_setdestchannelinfo.dita b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_setdestchannelinfo.dita
@@ -1,12 +1,12 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
 <reference id="api_channelmediarelayconfiguration_setdestchannelinfo">
-    <title><ph keyref="setDestChannelInfo" /></title>
+    <title><ph keyref="setDestChannelInfo"/></title>
     <shortdesc id="short"><ph id="shortdesc">Sets the information of the target channel.</ph></shortdesc>
     <prolog>
         <metadata>
             <keywords>
-                <indexterm keyref="setDestChannelInfo" />
+                <indexterm keyref="setDestChannelInfo"/>
             </keywords>
         </metadata>
     </prolog>
@@ -18,12 +18,12 @@
   }</codeblock>
             <codeblock props="ios mac" outputclass="language-objectivec">- (BOOL)setDestinationInfo:(AgoraChannelMediaRelayInfo *_Nonnull)destinationInfo forChannelName:(NSString *_Nonnull)channelName;
 </codeblock>
-            <codeblock props="cpp unreal bp" outputclass="language-cpp" />
-            <codeblock props="electron" outputclass="language-typescript" />
-            <codeblock props="unity cs" outputclass="language-csharp" />
-            <codeblock props="rn" outputclass="language-typescript" />
-           <codeblock props="flutter" outputclass="language-dart" /> 
-            <codeblock props="reserve" outputclass="language-cpp" /></p>
+            <codeblock props="cpp unreal bp" outputclass="language-cpp"/>
+            <codeblock props="electron" outputclass="language-typescript"/>
+            <codeblock props="unity cs" outputclass="language-csharp"/>
+            <codeblock props="rn" outputclass="language-typescript"/>
+           <codeblock props="flutter" outputclass="language-dart"/> 
+            <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="parameters">
             <title>Parameters</title>
@@ -36,10 +36,10 @@
                 <pt props="android">destInfo</pt>
                 <pt props="ios mac">destinationInfo</pt>
                 <pd>
-                    <p>The information of the target channel. See <apiname keyref="ChannelMediaInfo" />. It contains the following members:<ul>
+                    <p>The information of the target channel. See <apiname keyref="ChannelMediaInfo"/>. It contains the following members:<ul>
                     <li><parmname>channelName</parmname>: The name of the target channel.</li>
                     <li><parmname>token</parmname>: The <parmname>token</parmname> for joining the target channel. This token is generated with the <parmname>channelName</parmname> and <parmname>uid</parmname> you set in <parmname>destInfos</parmname>.<ul>
-                        <li>If you have not enabled the App Certificate, set this parameter as the default value <codeph><ph keyref="NULL" /></codeph>, which means the SDK applies the App ID.</li>
+                        <li>If you have not enabled the App Certificate, set this parameter as the default value <codeph><ph keyref="NULL"/></codeph>, which means the SDK applies the App ID.</li>
                         <li>If you have enabled the App Certificate, you must use the <parmname>token</parmname> generated with the <parmname>channelName</parmname> and <parmname>uid</parmname>.</li>
                         </ul> <note type="attention"><p>If the token of any target channel expires, the whole media relay stops; hence Agora recommends that you specify the same expiration time for the tokens of all the target channels.</p></note></li>
                     <li><parmname>uid</parmname>: The unique user ID to identify the relay stream in the target channel. The value ranges from 0 to (2 <sup>32</sup>-1). To avoid user ID conflicts, this user ID must be different from any other user ID in the target channel. The default value is 0, which means the SDK generates a random user ID.</li>
@@ -49,8 +49,8 @@
             </parml> </section>
         <section id="return_values" props="ios mac">
             <ul>
-            <li><codeph><ph keyref="true" /></codeph>: Success.</li>
-            <li><codeph><ph keyref="false" /></codeph>: Failure.</li>
+            <li><codeph><ph keyref="true"/></codeph>: Success.</li>
+            <li><codeph><ph keyref="false"/></codeph>: Failure. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph></li>
             </ul>
         </section>
     </refbody>

diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdevice.dita
@@ -20,7 +20,7 @@
             <codeblock props="unity cs" outputclass="language-csharp">public abstract string GetDevice();</codeblock>
             <codeblock props="rn" outputclass="language-typescript" />
             <codeblock props="flutter" outputclass="language-dart">Future&lt;String&gt; getDevice();</codeblock>
-            <codeblock props="reserve" outputclass="language-cpp" /></p>
+            <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="parameters" props="cpp unreal bp">
             <title>Parameters</title>
@@ -42,7 +42,7 @@
             <title>Returns</title>
             <ul props="cpp unreal bp">
             <li>0: Success.</li>
-            <li>&lt; 0: Failure.</li>
+            <li>&lt; 0: Failure. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph></li>
             </ul>
             <p props="unity flutter electron rn cs">Retrieves the volume of the audio recording device.</p>
         </section>

diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_setdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_setdevice.dita
@@ -20,7 +20,7 @@
             <codeblock props="unity cs" outputclass="language-csharp">public abstract int SetDevice(string deviceIdUTF8);</codeblock>
             <codeblock props="rn" outputclass="language-typescript" />
             <codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; setDevice(String deviceIdUTF8);</codeblock>
-            <codeblock props="reserve" outputclass="language-cpp" /></p>
+            <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="detailed_desc">
             <title>Details</title>
@@ -35,11 +35,11 @@
             </plentry>
             </parml> </section>
         <section id="return_values">
-            <title><ph keyref="return-section-title" /></title>
-            <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.</p>
+            <title><ph keyref="return-section-title"/></title>
+            <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.</li>
+            <li>&lt; 0: Failure. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph></li>
             </ul> </section>
     </refbody>
-</reference>
+</reference>
diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_enumerateplaybackdevices.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_enumerateplaybackdevices.dita
@@ -20,7 +20,7 @@
             <codeblock props="unity cs" outputclass="language-csharp">public abstract DeviceInfo[] EnumeratePlaybackDevices();</codeblock>
             <codeblock props="rn" outputclass="language-typescript">abstract enumeratePlaybackDevices(): AudioDeviceInfo[];</codeblock>
             <codeblock props="flutter" outputclass="language-dart">List&lt;AudioDeviceInfo&gt; enumeratePlaybackDevices();</codeblock>
-            <codeblock props="reserve" outputclass="language-cpp" /></p>
+            <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="detailed_desc">
             <title>Details</title>

diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_followsystemloopbackdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_followsystemloopbackdevice.dita
@@ -1,26 +1,26 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
 <reference id="api_iaudiodevicemanager_followsystemloopbackdevice">
-    <title><ph keyref="followSystemLoopbackDevice" /></title>
+    <title><ph keyref="followSystemLoopbackDevice"/></title>
     <shortdesc id="short"><ph id="shortdesc">Sets whether the loopback device follows the system default playback device.</ph></shortdesc>
     <prolog>
         <metadata>
             <keywords>
-                <indexterm keyref="followSystemLoopbackDevice" />
+                <indexterm keyref="followSystemLoopbackDevice"/>
             </keywords>
         </metadata>
     </prolog>
     <refbody>
         <section id="prototype">
             <p outputclass="codeblock">
-            <codeblock props="android" outputclass="language-java" />
-            <codeblock props="ios mac" outputclass="language-objectivec" />
+            <codeblock props="android" outputclass="language-java"/>
+            <codeblock props="ios mac" outputclass="language-objectivec"/>
             <codeblock props="cpp unreal bp" outputclass="language-cpp">virtual int followSystemLoopbackDevice(bool enable) = 0;</codeblock>
             <codeblock props="electron" outputclass="language-typescript">abstract followSystemLoopbackDevice(enable: boolean): number;</codeblock>
             <codeblock props="unity cs" outputclass="language-csharp">public abstract int FollowSystemLoopbackDevice(bool enable);</codeblock>
-            <codeblock props="rn" outputclass="language-typescript" />
-            <codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; followSystemLoopbackDevice(bool enable);</codeblock>
-            <codeblock props="reserve" outputclass="language-cpp" /></p>
+            <codeblock props="rn" outputclass="language-typescript"/>
+            <codeblock props="flutter" outputclass="language-dart">Future&lt;void> followSystemLoopbackDevice(bool enable);</codeblock>
+            <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="detailed_desc">
             <title>Details</title>
@@ -38,17 +38,17 @@
             <plentry>
                 <pt>enable</pt>
                 <pd>Whether to follow the system default audio playback device:<ul id="ul_l4n_jf3_5sb">
-                    <li><codeph><ph keyref="true" /></codeph>: Follow the system default audio playback device. When the default playback device of the system is changed, the SDK immediately switches to the loopback device.</li>
-                    <li><codeph><ph keyref="false" /></codeph>: Do not follow the system default audio playback device. The SDK switches the audio loopback device to the system default audio playback device only when the current audio playback device is disconnected.</li>
+                    <li><codeph><ph keyref="true"/></codeph>: Follow the system default audio playback device. When the default playback device of the system is changed, the SDK immediately switches to the loopback device.</li>
+                    <li><codeph><ph keyref="false"/></codeph>: Do not follow the system default audio playback device. The SDK switches the audio loopback device to the system default audio playback device only when the current audio playback device is disconnected.</li>
                     </ul></pd>
             </plentry>
             </parml> </section>
         <section id="return_values">
-            <title><ph keyref="return-section-title" /></title>
-            <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.</p>
+            <title><ph keyref="return-section-title"/></title>
+            <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 unity electron cs">0: Success.</li>
-            <li>&lt; 0: Failure.</li>
+            <li>&lt; 0: Failure. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph></li>
             </ul> </section>
     </refbody>
-</reference>
+</reference>