add unreal and bp and delete section

AgoraIO · Jun 17, 2024 · f7cc276 · f7cc276
1 parent ad223c6
commit f7cc276
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 25 deletions.
diff --git a/dita/RTC-NG/API/api_irtcengine_leavechannel2.dita b/dita/RTC-NG/API/api_irtcengine_leavechannel2.dita
@@ -31,10 +31,6 @@
                 <p props="flutter electron rn bp">成功加入频道后，必须调用本方法结束通话，否则无法开始下一次通话。如果你已调用 <xref keyref="joinChannelEx"/> 加入多个频道，调用本方法后会同时离开所有已加入的频道。</p>
                 <note type="attention">该方法是异步操作，调用返回时并没有真正退出频道。</note>
         </section>
-        <section id="scenario" deliveryTarget="details" props="hide">
-            <title>适用场景</title>
-            <p/>
-        </section>
         <section id="timing" deliveryTarget="details">
             <title>调用时机</title>
             <p>该方法需要在加入频道后调用。</p>

diff --git a/dita/RTC-NG/API/api_irtcengine_registerlocaluseraccount.dita b/dita/RTC-NG/API/api_irtcengine_registerlocaluseraccount.dita
@@ -28,11 +28,11 @@
             <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
             <p>该方法为本地用户注册一个 User Account。注册成功后，该 User Account 即可标识该本地用户的身份，用户可以使用它加入频道。</p>
             <p>该方法为可选。如果你希望用户使用 User Account 加入频道，可参考下列任意一种方式实现：
-            <ul props="electron flutter rn">
+            <ul props="electron flutter rn bp">
             <li>先调用 <apiname keyref="registerLocalUserAccount" /> 方法注册 Account，再调用 <xref keyref="joinChannelWithUserAccount2"/> 方法加入频道，可以缩短进入频道的时间。</li>
             <li>直接调用 <apiname keyref="joinChannelWithUserAccount2" /> 方法加入频道。</li>
             </ul>
-            <ul props="native unity cs">
+            <ul props="native unity cs unreal">
                 <li>先调用 <apiname keyref="registerLocalUserAccount" /> 方法注册 Account，再调用 <xref keyref="joinChannelWithUserAccount1"/> 或 <xref keyref="joinChannelWithUserAccount2"/> 方法加入频道，可以缩短进入频道的时间。</li>
                 <li>直接调用 <xref keyref="joinChannelWithUserAccount1"/> 或 <apiname keyref="joinChannelWithUserAccount2" /> 方法加入频道。</li>
             </ul>

diff --git a/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita b/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita
@@ -35,12 +35,12 @@
         </section>
             <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
                 <p>调用该方法后，SDK 会终止音视频互动、离开当前频道，并会释放会话相关的所有资源。</p>
-                <p props="native unity cs">调用 <xref keyref="joinChannelEx"/> 成功加入频道后，必须调用本方法或 <xref keyref="leaveChannelEx"/> 结束通话，否则无法开始下一次通话。</p>
-                <p props="flutter electron rn flutter">调用 <xref keyref="joinChannelEx"/> 成功加入频道后，必须调用本方法结束通话，否则无法开始下一次通话。</p>
+                <p props="native unity cs unreal">调用 <xref keyref="joinChannelEx"/> 成功加入频道后，必须调用本方法或 <xref keyref="leaveChannelEx"/> 结束通话，否则无法开始下一次通话。</p>
+                <p props="flutter electron rn flutter bp">调用 <xref keyref="joinChannelEx"/> 成功加入频道后，必须调用本方法结束通话，否则无法开始下一次通话。</p>
             <note type="attention">
                 <ul>
                     <li>该方法是异步操作，调用返回时并没有真正退出频道。</li>
-                    <li props="native unity cs">如果你调用了 <xref keyref="leaveChannel"/> 或 <xref keyref="leaveChannel2"/> 后，会同时离开 <xref keyref="joinChannel1"/> 或 <xref keyref="joinChannel2"/> 及 <xref keyref="joinChannelEx"/> 加入的频道。</li>
+                    <li props="native unity cs unreal">如果你调用了 <xref keyref="leaveChannel"/> 或 <xref keyref="leaveChannel2"/> 后，会同时离开 <xref keyref="joinChannel1"/> 或 <xref keyref="joinChannel2"/> 及 <xref keyref="joinChannelEx"/> 加入的频道。</li>
                     <li props="flutter electron rn bp">如果你调用了 <xref keyref="leaveChannel2"/> 后，会同时离开 <xref keyref="joinChannel2"/> 及 <xref keyref="joinChannelEx"/> 加入的频道。</li>
                 </ul></note>
             </section>

diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita
@@ -37,15 +37,14 @@ NS_SWIFT_NAME(rtcEngine(_:didClientRoleChanged:newRole:newRoleOptions:));</codeb
       ClientRoleOptions newRoleOptions)? onClientRoleChanged;</codeblock>
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
-        <section id="scenario" deliveryTarget="details" props="hide">
-            <title>适用场景</title>
-            <p/>
-        </section>
         <section id="timing" deliveryTarget="details">
             <title>触发时机</title>
-            <p>在以下任意一种情况时，会触发此回调：<ul>
+            <p props="native cs unity unreal">在以下任意一种情况时，会触发此回调：<ul>
                 <li>在<b>加入频道后</b>调用 <xref keyref="setClientRole1"/> 或 <xref keyref="setClientRole2"/> 设置用户角色或观众端延时级别。</li>
                 <li>在<b>加入频道前</b>调用 <xref keyref="setClientRole1"/> 或 <xref keyref="setClientRole2"/> 并将用户角色设为 <parmname>AUDIENCE</parmname>。</li></ul></p>
+            <p props="flutter rn electron bp">在以下任意一种情况时，会触发此回调：<ul>
+                    <li>在<b>加入频道后</b>调用 <xref keyref="setClientRole2"/> 设置用户角色或观众端延时级别。</li>
+                    <li>在<b>加入频道前</b>调用 <xref keyref="setClientRole2"/> 并将用户角色设为 <parmname>AUDIENCE</parmname>。</li></ul></p>
         </section>
         <section id="restriction" deliveryTarget="details">
             <title>使用限制</title>

diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechangefailed.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechangefailed.dita
@@ -40,14 +40,10 @@
         <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
             <p>当用户角色切换失败时，你可以通过此回调得知切换失败的原因和当前的用户角色。</p>
         </section>
-            <section id="scenario" deliveryTarget="details" props="hide">
-                <title>适用场景</title>
-                <p/>
-            </section>
             <section id="timing" deliveryTarget="details">
                 <title>触发时机</title>
-                <p props="native unity cs">本地用户加入频道后调用 <xref keyref="setClientRole1"/> 或 <xref keyref="setClientRole2" /> 设置用户角色失败时，SDK 会触发该回调。</p>
-                <p props="flutter rn electron">本地用户加入频道后调用 <xref keyref="setClientRole2" /> 设置用户角色失败时，SDK 会触发该回调。</p>
+                <p props="native unity cs unreal">本地用户加入频道后调用 <xref keyref="setClientRole1"/> 或 <xref keyref="setClientRole2" /> 设置用户角色失败时，SDK 会触发该回调。</p>
+                <p props="flutter rn electron bp">本地用户加入频道后调用 <xref keyref="setClientRole2" /> 设置用户角色失败时，SDK 会触发该回调。</p>
             </section>
             <section id="restriction" deliveryTarget="details">
                 <title>使用限制</title>

diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onleavechannel.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onleavechannel.dita
@@ -29,13 +29,9 @@
         <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
             <p>你可以通过该回调获取此次通话的总通话时长、SDK 收发数据的流量等信息。</p>
         </section>
-        <section id="scenario" deliveryTarget="details" props="hide">
-            <title>适用场景</title>
-            <p/>
-        </section>
         <section id="timing" deliveryTarget="details">
             <title>触发时机</title>
-            <p props="native unity cs">当你成功调用 <xref keyref="leaveChannel"/>、<xref keyref="leaveChannel2"/>、<xref keyref="leaveChannelEx"/> 或 <xref keyref="leaveChannelEx2"/> 离开频道后，SDK 会触发该回调。</p>
+            <p props="native unity cs unreal">当你成功调用 <xref keyref="leaveChannel"/>、<xref keyref="leaveChannel2"/>、<xref keyref="leaveChannelEx"/> 或 <xref keyref="leaveChannelEx2"/> 离开频道后，SDK 会触发该回调。</p>
             <p props="flutter rn electron bp">当你成功调用 <xref keyref="leaveChannel2"/> 或 <xref keyref="leaveChannelEx2"/> 离开频道后，SDK 会触发该回调。</p>
         </section>
         <section id="restriction" deliveryTarget="details">