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

Author: pmmgithub

dita/RTC-NG/API/api_channelmediarelayconfiguration_setdestchannelinfo.dita

@@ -42,14 +42,14 @@
                     <p>目标频道信息 <apiname keyref="ChannelMediaInfo"/>，包含如下成员：                    
                     <ul>
                     <li> <parmname>channelName</parmname> ：目标频道的频道名。</li>
-                    <li>
-                        <parmname>uid</parmname>：标识目标频道中的转发媒体流的 UID。取值范围为 0 到（2 <sup>32</sup>-1），请确保与目标频道中的所有 UID 不同。默认值为 0，表示 SDK 随机分配一个 UID。</li>
                     <li>
                         <parmname>token</parmname>：能加入目标频道的 <parmname>token</parmname>。由你在 <parmname>destInfos</parmname> 中设置的 <parmname>channelName</parmname> 和 <parmname>uid</parmname> 生成。
                         <ul>
                         <li>如未启用 App Certificate，可直接将该参数设为默认值 <codeph><ph keyref="NULL"/></codeph>，表示 SDK 填充 App ID。</li>
                         <li>如已启用 App Certificate，则务必填入使用 <parmname>channelName</parmname> 和 <parmname>uid</parmname> 生成的 <parmname>token</parmname>。</li>
-                        </ul> </li>
+                        </ul> <note type="attention"><p>由于目标频道中任意频道的 token 过期会导致所有跨频道推流停止，因此建议你将目标频道的 token 设置为相同的过期时长。</p></note></li>
+                    <li>
+                        <parmname>uid</parmname>：标识目标频道中的转发媒体流的 UID。取值范围为 0 到（2 <sup>32</sup>-1），请确保与目标频道中的所有 UID 不同。默认值为 0，表示 SDK 随机分配一个 UID。</li>
                     </ul> </p>
                 </pd>
             </plentry>
@@ -61,4 +61,4 @@
             </ul>
         </section>
     </refbody>
-</reference>
+</reference>

dita/RTC-NG/API/api_channelmediarelayconfiguration_setsrcchannelinfo.dita

@@ -35,12 +35,12 @@
 
                     <ul>
                     <li><parmname>channelName</parmname>：源频道名。默认值为 <codeph><ph keyref="NULL"/></codeph>，表示 SDK 填充当前的频道名。</li>
-                    <li><parmname>uid</parmname>：标识源频道中的转发媒体流的 UID。默认值为 0，表示 SDK 随机分配一个 <parmname>uid</parmname>。请确保设为 0。</li>
                     <li><parmname>token</parmname>：能加入源频道的 <parmname>token</parmname>。由你在 <parmname>srcInfo</parmname> 中设置的 <parmname>channelName</parmname> 和 <parmname>uid</parmname> 生成。                       
                         <ul>
                         <li>如未启用 App Certificate，可直接将该参数设为默认值 <codeph><ph keyref="NULL"/></codeph>，表示 SDK 填充 App ID。</li>
                         <li>如已启用 App Certificate，则务必填入使用 <parmname>channelName</parmname> 和 <parmname>uid</parmname> 生成的 <parmname>token</parmname>，且其中的 <parmname>uid</parmname> 必须为 0。</li>
                         </ul> </li>
+                    <li><parmname>uid</parmname>：标识源频道中的转发媒体流的 UID。默认值为 0，请勿修改。</li>
                     </ul></p>
                 </pd>
             </plentry>

dita/RTC-NG/API/api_irtcengine_sendmetadata.dita

@@ -35,7 +35,7 @@
                 <pt>metadata</pt>
                 <pd>媒体附属信息。详见 <xref keyref="Metadata" />。</pd>
             </plentry>
-            <plentry props="electron rn" conkeyref="VideoCanvas/sourcetype">
+            <plentry props="electron flutter" conkeyref="VideoCanvas/sourcetype">
                 <pt />
                 <pd />
             </plentry>

dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita

@@ -65,9 +65,9 @@
                     <note type="attention" props="unity">该参数仅对 SDK 自渲染生效，如果你想要设置视图镜像，可以将 GameObject 的 scaleX 设为 <codeph>-1</codeph> 或 <codeph>+1</codeph>。</note></p>
                     <p props="android">本地视图的镜像模式。
                     <ul id="videomirrormodetype">
-                    <li><ph keyref="VIDEO_MIRROR_MODE_AUTO" /> (0)：默认的镜像模式（SDK 决定镜像模式）。如果你使用前置摄像头，默认启动本地视图镜像模式；如果你启用后置摄像头，默认关闭本地视图镜像模式。</li>
-                    <li><ph keyref="VIDEO_MIRROR_MODE_ENABLED" /> (1)：开启镜像模式。</li>
-                    <li><ph keyref="VIDEO_MIRROR_MODE_DISABLED" /> (2)：关闭镜像模式。</li>
+                    <li><ph keyref="VIDEO_MIRROR_MODE_AUTO" /> (0)：SDK 决定镜像模式。如果你使用前置摄像头，默认启动本地视图镜像模式；如果你启用后置摄像头，默认关闭本地视图镜像模式。</li>
+                    <li><ph keyref="VIDEO_MIRROR_MODE_ENABLED" /> (1)：开启本地视图的镜像模式。</li>
+                    <li><ph keyref="VIDEO_MIRROR_MODE_DISABLED" /> (2)：关闭本地视图的镜像模式。</li>
                     </ul> </p>
                     <note type="attention">如果你使用前置摄像头，默认启动本地用户视图镜像模式；如果你使用后置摄像头，默认关闭本地视图镜像模式。</note> </pd>
             </plentry>

dita/RTC-NG/API/api_irtcengine_setremotevideosubscriptionoptions.dita

@@ -14,8 +14,8 @@
         <section id="prototype">
             <p outputclass="codeblock">
             <codeblock props="android" outputclass="language-java">public abstract int setRemoteVideoSubscriptionOptions(int uid, VideoSubscriptionOptions options);</codeblock>
-            <codeblock props="ios mac" outputclass="language-objectivec">- (int)setRemoteVideo:(NSUInteger)uid
-    SubscriptionOptions:(AgoraVideoSubscriptionOptions* _Nonnull)options NS_SWIFT_NAME(setRemoteVideo(_:SubscriptionOptions:));</codeblock>
+            <codeblock props="ios mac" outputclass="language-objectivec">- (int)setRemoteVideoSubscriptionOptions:(NSUInteger)uid
+                                 options:(AgoraVideoSubscriptionOptions* _Nonnull)options NS_SWIFT_NAME(setRemoteVideoSubscriptionOptions(_:options:));</codeblock>
             <codeblock props="cpp" outputclass="language-cpp">virtual int setRemoteVideoSubscriptionOptions(uid_t uid, const VideoSubscriptionOptions &amp;options) = 0;</codeblock>
             <codeblock props="cs" outputclass="language-csharp"/>
             <codeblock props="electron" outputclass="language-typescript">abstract setRemoteVideoSubscriptionOptions(
@@ -29,7 +29,7 @@
   ): number;</codeblock>
             <codeblock props="flutter" outputclass="language-dart">Future&lt;void> setRemoteVideoSubscriptionOptions(
       {required int uid, required VideoSubscriptionOptions options});</codeblock>
-            <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
+            <codeblock props="reserve" outputclass="language-cpp"/></p>
         </section>
         <section id="detailed_desc">
             <title>详情</title>
@@ -42,6 +42,7 @@
             <li>如果你先调用该方法设置了 <parmname>options</parmname> 参数、然后再注册 <apiname keyref="IVideoFrameObserver"/> 或 <apiname keyref="IVideoEncodedFrameObserver"/> 对象，则需要再次调用该方法并按照以上两项描述设置 <parmname>options</parmname> 参数，以获得预期的效果。</li>
             </ul> </p>
             <note>声网推荐你按照以下步骤调用该方法：
+            
             <ol>
             <li>调用 <xref keyref="joinChannel2"/> 加入频道时设置 <parmname>autoSubscribeVideo</parmname> 为 <codeph><ph keyref="false"/></codeph>。</li>
             <li>在收到 <xref keyref="onUserJoined"/> 回调后调用该方法，设置对指定远端用户视频流的订阅选项。</li>

dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita

@@ -64,7 +64,7 @@
                 <pt>loopback</pt>
                 <pd>
                     <p>是否只在本地播放音乐文件：
-                           
+
                     <ul>
                     <li><codeph><ph keyref="true" /></codeph>: 只在本地播放音乐文件，只有本地用户能听到音乐。</li>
                     <li><codeph><ph keyref="false" /></codeph>: 将本地播放的音乐文件发布至远端，本地用户和远端用户都能听到音乐。</li>
@@ -92,8 +92,19 @@
         <section id="return_values" props="native unity electron rn">
             <title>返回值</title>
             <ul>
-            <li>0: 方法调用成功</li>
-            <li>&lt; 0: 方法调用失败</li>
-            </ul> </section>
+            <li>0: 方法调用成功。</li>
+            <li>&lt; 0: 方法调用失败：
+            <ul>
+                <li>-1: 一般性的错误（未明确归类）。</li>
+                <li>-2: 设置了无效的参数。</li>
+                <li>-3：SDK 尚未准备好：<ul>
+                    <li>请检查是否已开启音频模块。</li>
+                    <li>请检查程序集完整性。</li>
+                    <li><xref keyref="IRtcEngine"/> 初始化失败。请重新初始化 <apiname keyref="IRtcEngine" />。</li>
+                </ul></li>
+                </ul>
+            </li>
+            </ul>
+        </section>
     </refbody>
-</reference>
+</reference>

dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita

@@ -20,17 +20,12 @@
             <codeblock props="electron" outputclass="language-typescript"/>
             <codeblock props="unity" outputclass="language-csharp">public abstract int StartAudioRecording(string filePath, AUDIO_RECORDING_QUALITY_TYPE quality);</codeblock>
             <codeblock props="rn" outputclass="language-typescript"/>
-           <codeblock props="flutter" outputclass="language-dart"/> 
+           <codeblock props="flutter" outputclass="language-dart"/>
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="detailed_desc">
             <title>详情</title>
-            <dl outputclass="deprecated">
-            <dlentry>
-                <dt>弃用：</dt>
-                <dd>该方法已废弃，其默认录音采样率为 32 kHz，不可修改。请改用新的 <xref keyref="startAudioRecording3"/> 方法。</dd>
-            </dlentry>
-            </dl>
+            <note type="attention">调用该方法时，默认的录音采样率为 32 kHz，不可修改。</note>
             <p>SDK 支持通话过程中在客户端进行录音。该方法录制频道内所有用户的音频，并生成一个包含所有用户声音的录音文件，录音文件格式可以为:
 
 

dita/RTC-NG/API/api_irtcengine_startaudiorecording2.dita

@@ -2,7 +2,7 @@
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
 <reference id="api_irtcengine_startaudiorecording2">
     <title><ph keyref="startAudioRecording2"/></title>
-    <shortdesc id="short"><ph id="shortdesc">开始客户端录音。</ph></shortdesc>
+    <shortdesc id="short"><ph id="shortdesc">开始客户端录音并设置录音采样率。</ph></shortdesc>
     <prolog>
         <metadata>
             <keywords>
@@ -21,17 +21,11 @@
             <codeblock props="electron" outputclass="language-typescript"/>
             <codeblock props="unity" outputclass="language-csharp">public abstract int StartAudioRecording(string filePath, int sampleRate, AUDIO_RECORDING_QUALITY_TYPE quality);</codeblock>
             <codeblock props="rn" outputclass="language-typescript"/>
-           <codeblock props="flutter" outputclass="language-dart"/> 
+           <codeblock props="flutter" outputclass="language-dart"/>
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="detailed_desc">
             <title>详情</title>
-            <dl outputclass="deprecated">
-            <dlentry>
-                <dt>弃用：</dt>
-                <dd>请改用 <xref keyref="startAudioRecording3"/>。</dd>
-            </dlentry>
-            </dl>
             <p>SDK 支持通话过程中在客户端进行录音。调用该方法后，你可以录制频道内所有用户的音频，并得到一个包含所有用户声音的录音文件。录音文件格式可以为:
 
 

dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita

@@ -2,7 +2,7 @@
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
 <reference id="api_irtcengine_startaudiorecording3">
     <title><ph keyref="startAudioRecording3" /></title>
-    <shortdesc id="short"><ph id="shortdesc">开始客户端录音。</ph></shortdesc>
+    <shortdesc id="short"><ph id="shortdesc">开始客户端录音并进行录音配置。</ph></shortdesc>
     <prolog>
         <metadata>
             <keywords>

dita/RTC-NG/API/api_irtcengineex_enableloopbackrecordingex.dita

@@ -42,6 +42,7 @@
             <ul>
             <li props="cpp unity electron flutter">该方法仅适用于 macOS 和 Windows 平台。</li>
             <li>macOS 系统默认声卡不支持采集功能，如果你需要使用该功能，请启用一个虚拟声卡，并将 <parmname>deviceName</parmname> 设为该虚拟声卡的设备名。声网推荐你使用声网自研的虚拟声卡 AgoraALD 进行采集。</li>
+            <li>该方法目前仅支持一路声卡采集。</li>
         </ul></note></section>
         <section id="parameters">
             <title>参数</title>