Merge branch 'master' of github.com:AgoraIO/agora_doc_source

dita/RTC-NG/API/api_imusiccontentcenter_release.dita

@@ -2,7 +2,7 @@
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
 <reference id="api_imusiccontentcenter_release">
     <title><ph keyref="release_IMusicContentCenter"/></title>
-    <shortdesc id="shortdesc"><ph props="android cpp unreal bp electron rn flutter">释放音乐内容中心所占用的所有资源。</ph><ph props="apple">销毁 <xref keyref="IMusicContentCenter"/> 实例。</ph></shortdesc>
+    <shortdesc id="short"><ph id="shortdesc">释放音乐内容中心所占用的所有资源。</ph></shortdesc>
     <prolog>
         <metadata>
             <keywords>

dita/RTC-NG/API/api_irtcengine_addpublishstreamurl.dita

@@ -66,7 +66,7 @@
             <ul>
             <li props="native unreal bp electron unity rn cs">0: 方法调用成功。</li>
             <li>
-                    &lt; 0: 方法调用失败。
+                    &lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph>
 
                 <ul>
                 <li>-2: 参数无效，一般是 URL 为空或是长度为 0 的字符串。</li>

dita/RTC-NG/API/api_irtcengine_enableaudiospectrummonitor.dita

@@ -45,7 +45,7 @@
             <p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
             <ul id="ul_ipv_rxy_hqb">
             <li props="native unreal bp electron unity rn cs">0: 方法调用成功。</li>
-            <li>&lt; 0: 方法调用失败。
+            <li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph>
                 <ul id="ul_ixs_txy_hqb">
                 <li>-2: 参数设置错误。</li>
                 </ul></li>

dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita

@@ -42,8 +42,6 @@
             <plentry id="enabled">
                 <pt>enabled</pt>
                 <pd>设置是否开启<ph>视频截图上传</ph><ph props="hide">视频内容审核</ph>：                                                  
-
-
                     <ul>
                     <li><codeph><ph keyref="true"/></codeph>：开启视频截图上传</li>
                     <li><codeph><ph keyref="false"/></codeph>：关闭视频截图上传</li>
@@ -52,7 +50,7 @@
             <plentry id="config">
                 <pt>config</pt>
                 <pd><ph>视频截图上传配置。详见 <xref keyref="ContentInspectConfig"/>。</ph>
-                    <note>视频审核模块选择声网自研插件截图上传（<ph keyref="CONTENT_INSPECT_SUPERVISION"/>）时需集成视频截图上传动态库 <codeph><ph keyref="moderation"/></codeph>，如果删除该动态库会导致无法正常开启视频截图上传功能。</note>
+                    <note>视频审核模块选择声网自研插件截图上传（<apiname keyref="CONTENT_INSPECT_SUPERVISION"/>）时需集成视频截图上传动态库 <codeph><ph keyref="moderation"/></codeph>，如果删除该动态库会导致无法正常开启视频截图上传功能。</note>
                 </pd>
             </plentry>
             </parml> </section>

dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita

@@ -108,7 +108,7 @@
             <p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
             <ul>
             <li props="native unreal bp electron unity rn cs">0: 方法调用成功。</li>
-            <li>&lt; 0: 方法调用失败。
+            <li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph>
                 <ul>
                 <li>-4：设备能力不满足虚拟背景的使用要求，建议更换性能更高的设备。</li>
                 </ul></li>

dita/RTC-NG/API/api_irtcengine_joinchannel2.dita

@@ -103,7 +103,7 @@
             <p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
             <ul>
             <li props="native unreal bp unity rn electron cs">0：方法调用成功。</li>
-            <li>&lt; 0：方法调用失败。
+            <li>&lt; 0：方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph>
 
 
 

dita/RTC-NG/API/api_irtcengine_preloadchannel.dita

@@ -83,7 +83,7 @@
             <p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
             <ul>
             <li props="native unreal bp unity rn electron cs">0：方法调用成功。</li>
-            <li>&lt; 0：方法调用失败。
+            <li>&lt; 0：方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph>
                 <ul>
                 <li>-7：<apiname keyref="IRtcEngine" /> 对象尚未初始化。你需要在调用该方法前成功初始化 <apiname keyref="IRtcEngine" /> 对象。</li>
                 <li>-102：频道名无效。你需要填入有效的频道名，重新加入频道。</li>

dita/RTC-NG/API/api_irtcengine_preloadchannel2.dita

@@ -72,7 +72,7 @@
             <p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
             <ul>
             <li props="native unreal bp unity rn electron cs">0：方法调用成功。</li>
-            <li>&lt; 0：方法调用失败。
+            <li>&lt; 0：方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph>
                 <ul>
                 <li>-2：传入的参数无效。例如，User Account 为空。你需要填入有效的参数，重新加入频道。</li>
                 <li>-7：<apiname keyref="IRtcEngine" /> 对象尚未初始化。你需要在调用该方法前成功初始化 <apiname keyref="IRtcEngine" /> 对象。</li>

dita/RTC-NG/API/api_irtcengine_renewtoken.dita

@@ -44,7 +44,7 @@
             <p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
             <ul>
             <li props="native unreal bp electron unity rn electron cs">0: 方法调用成功。</li>
-            <li>&lt; 0: 方法调用失败。
+            <li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph>
 
                 <ul>
                 <li>-2：传入的参数无效。例如，使用了不合法的 Token。你需要填入有效的参数。</li>

dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita

@@ -73,7 +73,7 @@
             <p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
             <ul>
             <li props="native unreal bp electron unity rn cs">0: 方法调用成功。</li>
-            <li>&lt; 0: 方法调用失败。
+            <li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph>
                 <ul>
                     <li>-4：当前设备不支持该功能，可能的原因有：
                         <ul>

dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita

@@ -71,7 +71,7 @@
             <p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
             <ul>
             <li props="native unreal bp electron unity rn cs">0(ERR_OK) 方法调用成功。</li>
-            <li>&lt; 0 方法调用失败。
+            <li>&lt; 0 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph>
                 <ul>
                 <li>-2: 参数无效。</li>
                 <li>-7: SDK 尚未初始化。</li>

dita/RTC-NG/API/api_irtcengine_setclientrole.dita

@@ -60,7 +60,7 @@
             <title>返回值</title>
             <ul>
             <li>0: 方法调用成功。</li>
-            <li>&lt; 0: 方法调用失败。
+            <li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph>
 
                 <ul>
                 <li>-1: 一般性的错误（未明确归类）。</li>

dita/RTC-NG/API/api_irtcengine_setcloudproxy.dita

@@ -60,7 +60,7 @@
             <p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
             <ul>
             <li props="native unreal bp electron unity rn cs">0: 方法调用成功。</li>
-            <li> &lt; 0: 方法调用失败。
+            <li> &lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph>
 
                 <ul>
                 <li>-2: 传入的参数无效。</li>

dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita

@@ -43,7 +43,7 @@
             <p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
    <ul>
        <li props="native unreal bp electron unity rn cs">0: 方法调用成功。</li>
-       <li>&lt; 0: 方法调用失败。
+       <li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph>
         <ul conkeyref="startScreenCaptureByDisplayId/err"><li /></ul>
        </li>
    </ul>

dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita

@@ -65,7 +65,7 @@
             <p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
             <ul>
             <li props="native unreal bp electron unity cs rn">0：方法调用成功。</li>
-            <li>&lt; 0：方法调用失败。
+            <li>&lt; 0：方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph>
                 <ul>
                 <li>-1: 一般性的错误（未明确归类）。</li>
                 <li>-2: 参数无效。</li>

dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithtranscoding.dita

@@ -62,7 +62,7 @@
             <p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
             <ul>
             <li props="native unreal bp unity electron rn cs">0: 方法调用成功。</li>
-            <li>&lt; 0: 方法调用失败。
+            <li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph>
                 <ul>
                 <li>-2：url 为空或为长度为 0 的字符串。</li>
                 <li>-7：调用该方法前，未初始化 SDK。</li>

dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita

@@ -80,7 +80,7 @@
             <p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
             <ul>
             <li props="native unreal bp electron unity rn cs">0: 方法调用成功。</li>
-            <li>&lt; 0: 方法调用失败。
+            <li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph>
 
                 <ul id="err">
                     <li>-2：传入的参数无效。</li>

dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita

@@ -71,7 +71,7 @@
             <p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
             <ul>
             <li props="native unreal bp electron unity rn cs">0: 方法调用成功。</li>
-            <li>&lt; 0: 方法调用失败。
+            <li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph>
                 <ul conkeyref="startScreenCaptureByDisplayId/err"><li /></ul>
             </li>
             </ul> </section>

dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita

@@ -208,7 +208,7 @@
             <p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
             <ul>
             <li props="native unreal bp electron unity rn cs">0: 方法调用成功。</li>
-            <li>&lt; 0: 方法调用失败。
+            <li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph>
             <ul conkeyref="startScreenCaptureByDisplayId/err"><li /></ul></li>
             </ul> </section>
     </refbody>

dita/RTC-NG/API/api_irtcengine_stopechotest.dita

@@ -30,7 +30,7 @@
             <ul>
             <li props="native unreal bp electron unity rn cs">0: 方法调用成功。</li>
             <li>
-                    &lt; 0: 方法调用失败。
+                    &lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph>
 
 
                 <ul>

dita/RTC-NG/API/api_irtcengine_stopscreencapture.dita

@@ -27,6 +27,10 @@
             <codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; stopScreenCapture();</codeblock>
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
+        <section id="detailed_desc">
+            <title>详情</title>
+            <p>在调用 <xref keyref="startScreenCaptureByWindowId"/> 或 <xref keyref="startScreenCaptureByDisplayId"/> 开始屏幕采集后，调用该方法停止屏幕采集。</p>
+        </section>
         <section id="return_values">
             <title><ph keyref="return-section-title"/></title>
             <p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>

dita/RTC-NG/API/api_irtcengine_stopscreencapture2.dita

@@ -35,8 +35,8 @@
             <p>调用 <xref keyref="startScreenCapture2"/> 开始一路或多路屏幕采集后，你可以通过调用该方法并设置 <parmname>sourceType</parmname> 停止指定屏幕采集。</p>
             <note type="attention"><ul>
             <li props="cpp unreal bp flutter unity">该方法仅适用于 macOS 和 Windows 平台。</li>
-            <li props="cpp unreal bp flutter unity">如果你调用 <xref keyref="startScreenCapture"/>、<xref keyref="startScreenCaptureByWindowId"/> 和 <xref keyref="startScreenCaptureByDisplayId"/> 开始屏幕采集，声网建议你使用 <xref keyref="stopScreenCapture"/> 停止采集，不要与该方法混用。</li>
-            <li props="mac electron cs">如果你调用 <xref keyref="startScreenCaptureByWindowId"/> 和 <xref keyref="startScreenCaptureByDisplayId"/> 开始屏幕采集，声网建议你使用 <xref keyref="stopScreenCapture"/> 停止采集，不要与该方法混用。</li></ul></note>
+            <li props="cpp unreal bp flutter unity">如果你调用 <xref keyref="startScreenCapture"/>、<xref keyref="startScreenCaptureByWindowId"/> 或 <xref keyref="startScreenCaptureByDisplayId"/> 开始屏幕采集，声网建议你使用 <xref keyref="stopScreenCapture"/> 停止采集，不要与该方法混用。</li>
+            <li props="mac electron cs">如果你调用 <xref keyref="startScreenCaptureByWindowId"/> 或 <xref keyref="startScreenCaptureByDisplayId"/> 开始屏幕采集，声网建议你使用 <xref keyref="stopScreenCapture"/> 停止采集，不要与该方法混用。</li></ul></note>
         </section>
         <section id="parameters">
             <title>参数</title>

dita/RTC-NG/API/api_irtcengine_updatechannelmediaoptions.dita

@@ -38,7 +38,7 @@
             <p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
             <ul id="ul_uns_l2y_hqb">
             <li props="native unreal bp electron unity rn cs">0: 方法调用成功。</li>
-            <li>&lt; 0: 方法调用失败。
+            <li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph>
 
 
 

dita/RTC-NG/API/api_irtcengine_updatepreloadchanneltoken.dita

@@ -48,9 +48,11 @@
             <p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
             <ul>
                 <li props="native unreal bp electron unity cs rn">0: 方法调用成功。</li>
-                <li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
-                <li>-2：传入的参数无效。例如，使用了不合法的 Token。你需要填入有效的参数，重新加入频道。</li>
-                <li>-7：<apiname keyref="IRtcEngine" /> 对象尚未初始化。你需要在调用该方法前成功初始化 <apiname keyref="IRtcEngine" /> 对象。</li>
-                </ul> </section>
+               <li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph>
+                   <ul>
+                       <li>-2：传入的参数无效。例如，使用了不合法的 Token。你需要填入有效的参数，重新加入频道。</li>
+                       <li>-7：<apiname keyref="IRtcEngine" /> 对象尚未初始化。你需要在调用该方法前成功初始化 <apiname keyref="IRtcEngine" /> 对象。</li>
+                   </ul></li>
+            </ul></section>
         </refbody>
 </reference>

dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita

@@ -52,7 +52,7 @@
             <p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
             <ul>
             <li props="native unreal bp electron unity rn cs">0: 方法调用成功。</li>
-            <li>&lt; 0: 方法调用失败。
+            <li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph>
                 <ul conkeyref="startScreenCaptureByDisplayId/err">
                 <li />
                 </ul> </li>