Merge branch 'master' into harmony-ga

AgoraIO · Sep 29, 2024 · 609d583 · 609d583
2 parents 12b9f7e + c381d9b
commit 609d583
Show file tree

Hide file tree

Showing 34 changed files with 206 additions and 96 deletions.
diff --git a/dita/RTC-NG/API/api_ibasespatialaudioengine_setzones.dita b/dita/RTC-NG/API/api_ibasespatialaudioengine_setzones.dita
@@ -46,7 +46,7 @@
             <parml>
             <plentry>
                 <pt>zones</pt>
-                <pd>隔声区域的设置。详见 <apiname keyref="SpatialAudioZone"/>。当你将该参数设置为 <codeph><ph keyref="NULL"/></codeph> 时，表示清除所有隔声区域。
+                <pd>隔声区域的设置。详见 <xref keyref="SpatialAudioZone"/>。当你将该参数设置为 <codeph><ph keyref="NULL"/></codeph> 时，表示清除所有隔声区域。
                     <note type="attention" props="cpp unreal bp unity cs flutter electron">在 Windows 平台上，需确保 <parmname>zones</parmname> 数组中的成员个数与 <parmname>zoneCount</parmname> 的值相等，否则会导致崩溃。</note></pd>
             </plentry>
             <plentry props="cpp framework">

diff --git a/dita/RTC-NG/API/api_imusiccontentcenter_getcaches.dita b/dita/RTC-NG/API/api_imusiccontentcenter_getcaches.dita
@@ -30,7 +30,7 @@
                 <dd>v4.2.0</dd>
             </dlentry>
             </dl>
-            <p>调用该方法前，你需要预先分配一定大小的内存空间用来存储缓存音乐资源的信息。</p>
+            <p>调用该方法前，你需要预先分配一定大小的内存空间用来存储缓存音乐资源的信息。如果你需要设置可缓存的音乐资源数量，可通过 <xref keyref="initialize_IMusicContentCenter"/> 的 <parmname props="framework android cpp">configuration</parmname><parmname props="apple">config</parmname> 来设置。</p>
             <p>当你不再需要使用已缓存的音乐资源时，你需要及时释放内存以防止内存泄漏。</p>
         </section>
         <section id="parameters" props="cpp unreal bp unity cs flutter">

diff --git a/dita/RTC-NG/API/api_imusiccontentcenter_getinternalsongcode.dita b/dita/RTC-NG/API/api_imusiccontentcenter_getinternalsongcode.dita
@@ -23,10 +23,9 @@
             <codeblock props="flutter" outputclass="language-dart">Future&lt;int> getInternalSongCode(
       {required int songCode, required String jsonOption});</codeblock> </p>
         </section>
-        <section id="detailed_desc">
-            <title>详情</title>
-            <dl outputclass="since">
-            <dlentry props="android apple cpp">
+        <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
+            <dl outputclass="since" props="native">
+            <dlentry>
                 <dt>自从</dt>
                 <dd>v4.2.2</dd>
             </dlentry>

diff --git a/dita/RTC-NG/API/api_imusicontentcenter_preload.dita b/dita/RTC-NG/API/api_imusicontentcenter_preload.dita
@@ -33,7 +33,7 @@
             </dl>
             <p id="desc1">你可以调用该方法预先加载需要播放的音乐资源。成功调用该方法后，SDK 会触发 <xref keyref="onPreLoadEvent_IMusicContentCenterEventHandler"/> 回调报告预加载音乐资源的事件。</p>
             <p id="desc2">在调用该方法来预加载音乐资源之前，你需要调用 <xref keyref="getMusicCollectionByMusicChartId"/> 或 <xref keyref="searchMusic"/> 方法来获取你需要播放的音乐资源，并通过由此触发的 <xref keyref="onMusicCollectionResult"/> 回调获取音乐资源的编号（<parmname>songCode</parmname>）。</p>
-            <note type="attention" id="note">如需销毁 <xref keyref="IRtcEngine"/> 对象，请在收到 <xref keyref="onPreloadEvent"/> 回调后，再调用 <xref keyref="release"/> 方法。</note>
+            <note type="attention" id="note">如需销毁 <xref keyref="IRtcEngine"/> 对象，请在收到 <xref keyref="onPreLoadEvent_IMusicContentCenterEventHandler"/> 回调后，再调用 <xref keyref="release"/> 方法。</note>
         </section>
         <section id="parameters">
             <title>参数</title>

diff --git a/dita/RTC-NG/API/api_irtcengine_destroymediarecorder.dita b/dita/RTC-NG/API/api_irtcengine_destroymediarecorder.dita
@@ -40,7 +40,7 @@
             <plentry>
                 <pt props="android cpp apple framework">mediaRecorder</pt>
                 <pt props="hmos">recorder</pt>
-                <pd>待销毁的音视频录制对象。</pd>
+                <pd>待销毁的 <xref keyref="IMediaRecorder" /> 对象。</pd>
             </plentry>
             </parml> </section>
         <section id="return_values" conkeyref="setMediaRecorderObserver/return_values"> </section>

diff --git a/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita b/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita
@@ -41,7 +41,10 @@
         </section>        
         <section id="restriction" deliveryTarget="details">
             <title>调用限制</title>
-            <p>调用该方法前，请确保已<xref keyref="ticket-link"/>开通本地截图上传服务。</p>
+            <ul>
+                <li>调用该方法前，请确保已<xref keyref="ticket-link"/>开通本地截图上传服务。</li>
+                <li>视频审核模块选择声网自研插件截图上传（<apiname keyref="CONTENT_INSPECT_SUPERVISION"/>）时需集成本地截图上传动态库 <codeph><ph keyref="moderation"/></codeph>，如果删除该动态库会导致无法正常开启本地截图上传功能。</li>
+            </ul>
         </section>
         <section id="parameters" deliveryTarget="details">
             <title>参数</title>
@@ -56,9 +59,7 @@
             </plentry>
             <plentry id="config">
                 <pt>config</pt>
-                <pd><ph>本地截图上传配置。详见 <xref keyref="ContentInspectConfig"/>。</ph>
-                    <note>视频审核模块选择声网自研插件截图上传（<apiname keyref="CONTENT_INSPECT_SUPERVISION"/>）时需集成本地截图上传动态库 <codeph><ph keyref="moderation"/></codeph>，如果删除该动态库会导致无法正常开启本地截图上传功能。</note>
-                </pd>
+                <pd>本地截图上传配置。详见 <xref keyref="ContentInspectConfig"/>。</pd>
             </plentry>
             </parml> </section>
         <section id="return_values">

diff --git a/dita/RTC-NG/API/api_irtcengine_renewtoken.dita b/dita/RTC-NG/API/api_irtcengine_renewtoken.dita
@@ -40,13 +40,6 @@
             <title>调用限制</title>
             <p>无。</p>
         </section>
-        <section id="related" deliveryTarget="details">
-            <title>相关回调</title>
-            <ul><li><xref keyref="onTokenPrivilegeWillExpire"/></li>
-                 <li><xref keyref="onRequestToken"/></li>
-                <li><xref keyref="onConnectionStateChanged"/></li>
-                </ul>
-        </section>
         <section id="parameters" deliveryTarget="details">
             <title>参数</title>
             <parml>

diff --git a/dita/RTC-NG/API/api_irtcengine_statechanged.dita b/dita/RTC-NG/API/api_irtcengine_statechanged.dita
@@ -50,7 +50,6 @@
                     <p>设备状态：
                     <ul>
                     <li>0：设备就绪。</li>
-                    <li>1：设备正在使用。</li>
                     <li props="hide">3：设备已插入。</li>
                     <li>8：设备被拔出。</li>
                     </ul></p>

diff --git a/dita/RTC-NG/API/api_irtcengineex_leavechannelex.dita b/dita/RTC-NG/API/api_irtcengineex_leavechannelex.dita
@@ -33,7 +33,7 @@
             <note type="attention">
                 <ul>
                     <li>该方法是异步操作，调用返回时并没有真正退出频道。</li>
-                    <li>如果你调用了 <xref keyref="leaveChannel"/> 或 <xref keyref="leaveChannel2"/> 后，会同时离开 <xref keyref="joinChannel1"/> 或 <xref keyref="joinChannel2"/> 及 <xref keyref="joinChannelEx"/> 加入的频道。</li>
+                    <li>如果你调用了 <xref keyref="leaveChannel"/> 或 <xref keyref="leaveChannel2"/> ，会同时离开 <xref keyref="joinChannel1"/> 或 <xref keyref="joinChannel2"/> 及 <xref keyref="joinChannelEx"/> 加入的频道。</li>
                 </ul></note>
         </section>
         <section id="scenario" deliveryTarget="details">

diff --git a/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onpreloadevent.dita b/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onpreloadevent.dita
@@ -51,12 +51,13 @@
                 <dd>v4.1.0</dd>
             </dlentry>
             </dl>
-            <p>当你调用 <xref keyref="preload"/> 方法预加载音乐资源后，SDK 会触发该回调。</p>
+            <p props="hmos electron flutter rn">当你调用 <xref keyref="preload2"/> 方法预加载音乐资源后，SDK 会触发该回调。</p>
+            <p props="android ios cpp unity bp unreal">当你调用 <xref keyref="preload"/> 或 <xref keyref="preload2"/> 方法预加载音乐资源后，SDK 会触发该回调。</p>
         </section>
         <section id="parameters">
             <title>参数</title>
             <parml>
-            <plentry props="android ios cpp flutter unity rn" conkeyref="onMusicChartsResult/id">
+            <plentry props="android ios cpp flutter unity rn unreal" conkeyref="onMusicChartsResult/id">
                 <pt></pt>
                 <pd></pd>
             </plentry>

diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita
@@ -39,6 +39,8 @@ NS_SWIFT_NAME(rtcEngine(_:didClientRoleChanged:newRole:newRoleOptions:));</codeb
       ClientRoleOptions newRoleOptions)? onClientRoleChanged;</codeblock>
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
+        <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
+        </section>
         <section id="timing" deliveryTarget="details">
             <title>触发时机</title>
             <p props="android cpp apple cs unity unreal">在以下任意一种情况时，会触发此回调：<ul>

diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocaluserregistered.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocaluserregistered.dita
@@ -25,8 +25,7 @@
             <codeblock props="electron" outputclass="language-typescript">  onLocalUserRegistered?(uid: number, userAccount: string): void;</codeblock>
             <codeblock props="unity cs" outputclass="language-csharp">public virtual void OnLocalUserRegistered(uint uid, string userAccount) {}</codeblock>
             <codeblock props="rn" outputclass="language-typescript">  onLocalUserRegistered?(uid: number, userAccount: string): void;</codeblock>
-            <codeblock props="flutter" outputclass="language-dart">final void Function(bool isFallbackOrRecover)?
-      onLocalPublishFallbackToAudioOnly;</codeblock>
+            <codeblock props="flutter" outputclass="language-dart">final void Function(int uid, String userAccount)? onLocalUserRegistered;</codeblock>
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="detailed_desc">

diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onrejoinchannelsuccess.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onrejoinchannelsuccess.dita
@@ -31,6 +31,8 @@
       onRejoinChannelSuccess;</codeblock>
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
+        <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
+        </section>
         <section id="timing" deliveryTarget="details">
             <title>触发时机</title>
             <p id="desc">有时候由于网络原因，客户端可能会和服务器失去连接，SDK 会进行自动重连，自动重连成功后触发此回调方法。</p>

diff --git a/dita/RTC-NG/API/callback_ivideoframeobserver_oncapturevideoframe.dita b/dita/RTC-NG/API/callback_ivideoframeobserver_oncapturevideoframe.dita
@@ -61,7 +61,7 @@
             <parml>
                 <plentry>
                     <pt>sourceType</pt>
-                    <pd>视频源类型，可能的视频源包括：摄像头、屏幕或媒体播放器。详见 <xref keyref="VIDEO_SOURCE_TYPE"/> 。</pd>
+                    <pd>视频源类型，可能的视频源包括：摄像头、屏幕或媒体播放器。详见 <xref keyref="VIDEO_SOURCE_TYPE"/>。</pd>
                 </plentry>
             <plentry id="videoframe">
                 <pt>videoFrame</pt>

diff --git a/dita/RTC-NG/API/class_lastmileproberesult.dita b/dita/RTC-NG/API/class_lastmileproberesult.dita
@@ -144,13 +144,13 @@ public:
                 <pt>state</pt>
                 <pd>
                     <p props="ios mac cpp unreal bp unity electron rn flutter cs">Last mile 质量探测结果的状态。详见: <xref keyref="LASTMILE_PROBE_RESULT_STATE" /> 。</p>
-                    <p props="android hmos">Last-mile 质量探测结果的状态，有如下几种：
+                    <p props="android hmos">Last mile 质量探测结果的状态，有如下几种：
 
 
                     <ul>
-                    <li><ph keyref="LASTMILE_PROBE_RESULT_COMPLETE" /> (1)：表示本次 Last-mile 质量探测是完整的。</li>
-                    <li><ph keyref="LASTMILE_PROBE_RESULT_INCOMPLETE_NO_BWE" /> (2)：表示本次 Last-mile 质量探测未进行带宽预测，因此结果不完整。一个可能的原因是测试资源暂时受限。</li>
-                    <li><ph keyref="LASTMILE_PROBE_RESULT_UNAVAILABLE" /> (3)：未进行 Last-mile 质量探测。一个可能的原因是网络连接中断。</li>
+                    <li><ph keyref="LASTMILE_PROBE_RESULT_COMPLETE" /> (1)：表示本次 Last mile 质量探测是完整的。</li>
+                    <li><ph keyref="LASTMILE_PROBE_RESULT_INCOMPLETE_NO_BWE" /> (2)：表示本次 Last mile 质量探测未进行带宽预测，因此结果不完整。一个可能的原因是测试资源暂时受限。</li>
+                    <li><ph keyref="LASTMILE_PROBE_RESULT_UNAVAILABLE" /> (3)：未进行 Last mile 质量探测。一个可能的原因是网络连接中断。</li>
                     </ul> </p>
                 </pd>
             </plentry>

diff --git a/dita/RTC-NG/API/class_videosubscriptionoptions.dita b/dita/RTC-NG/API/class_videosubscriptionoptions.dita
@@ -119,13 +119,7 @@ public:
             <plentry>
                 <pt props="android hmos">streamType</pt>
                 <pt props="ios mac cpp framework">type</pt>
-                <pd props="ios mac cpp framework">订阅的视频流类型，默认值为 <ph keyref="VIDEO_STREAM_HIGH"/>，即订阅视频大流。详见 <xref keyref="VIDEO_STREAM_TYPE"/>。</pd>
-                <pd props="android hmos">订阅的视频流类型：
-                  <ul>
-                    <li><ph keyref="VIDEO_STREAM_HIGH"/> (0): （默认）视频大流，即高分辨率、高码率视频流。</li>
-                    <li><ph keyref="VIDEO_STREAM_LOW"/> (1): 视频小流，即低分辨率、低码率视频流。</li>
-                  </ul>
-                </pd>
+                <pd>订阅的视频流类型，默认值为 <ph keyref="VIDEO_STREAM_HIGH"/>，即订阅视频大流。详见 <xref keyref="VIDEO_STREAM_TYPE"/>。</pd>
             </plentry>
             <plentry>
                 <pt>encodedFrameOnly</pt>

diff --git a/dita/RTC-NG/API/enum_videocodectype.dita b/dita/RTC-NG/API/enum_videocodectype.dita
@@ -25,20 +25,15 @@
             </plentry>
             <plentry props="android cpp apple framework">
                 <pt><ph keyref="VIDEO_CODEC_GENERIC"/></pt>
-                <pd>
-                    <p>6：Generic。</p>
-                    <p>本类型主要用于传输视频裸数据(比如用户已加密的视频帧)，该类型视频帧以回调的形式返回给用户，需要用户自行解码与渲染。</p>
-                </pd>
+                <pd>6：Generic。本类型主要用于传输视频裸数据(比如用户已加密的视频帧)，该类型视频帧以回调的形式返回给用户，需要用户自行解码与渲染。</pd>
             </plentry>
             <plentry props="hide">
                 <pt><ph keyref="VIDEO_CODEC_AV1"/></pt>
                 <pd>12：AV1。</pd>
             </plentry>
             <plentry props="android cpp apple framework">
                 <pt><ph keyref="VIDEO_CODEC_GENERIC_JPEG"/></pt>
-                <pd>20：Generic JPEG。
-                    <p>本类型所需的算力较小，可用于算力有限的 IoT 设备。</p>
-                </pd>
+                <pd>20：Generic JPEG。本类型所需的算力较小，可用于算力有限的 IoT 设备。</pd>
             </plentry>
             <plentry props="hide">
                 <pt><ph keyref="VIDEO_CODEC_VP9"/></pt>