Merge branch '4.4.0-bugfix-0926' of github.com:AgoraIO/agora_doc_sour…

…ce into 4.4.0-bugfix-0926
AgoraIO · Sep 27, 2024 · 7c2aa59 · 7c2aa59
2 parents 359bb4d + 64eed95
commit 7c2aa59
Show file tree

Hide file tree

Showing 12 changed files with 20 additions and 22 deletions.
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"/> 的 <xref keyref="MusicContentCenterConfiguration"/> 来设置。</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,10 @@
             <codeblock props="flutter" outputclass="language-dart">Future&lt;int> getInternalSongCode(
       {required int songCode, required String jsonOption});</codeblock> </p>
         </section>
-        <section id="detailed_desc">
+        <section id="detailed_desc" props="native">
             <title>详情</title>
             <dl outputclass="since">
-            <dlentry props="android apple cpp">
+            <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
@@ -39,7 +39,7 @@
             <parml>
             <plentry>
                 <pt>mediaRecorder</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_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/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="electron flutter rn">当你调用 <xref keyref="preload2"/> 方法预加载音乐资源后，SDK 会触发该回调。</p>
+            <p props="android ios cpp unity bp unreal hmos">当你调用 <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="native cs unity unreal">在以下任意一种情况时，会触发此回调：<ul>

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/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/RTC_NG_API_Android.ditamap b/dita/RTC-NG/RTC_NG_API_Android.ditamap
@@ -481,7 +481,6 @@
                     <topicref keyref="resume" toc="no"/>
                     <topicref keyref="seek" toc="no"/>
                     <topicref keyref="stop" toc="no"/>
-                    <topicref keyref="stop_IMusicPlayer" toc="no"/>
                     <topicref keyref="onSeek" toc="no"/>
                 </topicref>
                 <topicref href="API/toc_mediaplayer_info.dita" chunk="to-content">
@@ -553,6 +552,7 @@
                 <topicref keyref="searchMusic" toc="no"/>
                 <topicref keyref="searchMusic2" toc="no"/>
                 <topicref keyref="setPlayMode" toc="no"/>
+                <topicref keyref="stop_IMusicPlayer" toc="no"/>
                 <topicref keyref="unregisterEventHandler_IMusicContentCenter" toc="no"/>
                 <topicref keyref="open_IMusicPlayer" toc="no"/>
                 <topicref keyref="open2_IMusicPlayer" toc="no"/>

diff --git a/dita/RTC-NG/RTC_NG_API_Harmony.ditamap b/dita/RTC-NG/RTC_NG_API_Harmony.ditamap
@@ -481,7 +481,6 @@
                     <topicref keyref="resume" toc="no"/>
                     <topicref keyref="seek" toc="no"/>
                     <topicref keyref="stop" toc="no"/>
-                    <topicref keyref="stop_IMusicPlayer" toc="no"/>
                     <topicref keyref="onSeek" toc="no" props="reserve"/>
                 </topicref>
                 <topicref href="API/toc_mediaplayer_info.dita" chunk="to-content" props="reserve">
@@ -550,6 +549,7 @@
                 <topicref keyref="renewToken_IMusicContentCenter" toc="no"/>
                 <topicref keyref="searchMusic" toc="no"/>
                 <topicref keyref="searchMusic2" toc="no"/>
+                <topicref keyref="stop_IMusicPlayer" toc="no"/>
                 <topicref keyref="unregisterEventHandler_IMusicContentCenter" toc="no"/>
                 <topicref keyref="open_IMusicPlayer" toc="no"/>
                 <topicref keyref="open2_IMusicPlayer" toc="no"/>

diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap
@@ -763,7 +763,7 @@
             <keydef keys="stop" href="../API/api_imediaplayer_stop.dita">
                 <topicmeta>
                     <keywords>
-                        <keyword>stop</keyword>
+                        <keyword>stop [1/2]</keyword>
                     </keywords>
                 </topicmeta>
             </keydef>
@@ -3434,7 +3434,7 @@
             <keydef keys="stop_IMusicPlayer" href="../API/api_imusicplayer_stop.dita">
                 <topicmeta>
                     <keywords>
-                        <keyword>stop</keyword>
+                        <keyword>stop [2/2]</keyword>
                     </keywords>
                 </topicmeta>
             </keydef>