Skip to content

Commit

Permalink
modifications based on review
Browse files Browse the repository at this point in the history
  • Loading branch information
Suri539 committed May 10, 2024
1 parent 14e07e7 commit 534766b
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 8 deletions.
8 changes: 4 additions & 4 deletions dita/RTC-NG/API/api_irtcengine_preloadchannel.dita
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,14 @@
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>由于 SDK 预加载频道需要一定的时间,因此声网推荐你在确认频道名、用户信息后、加入频道前,尽早调用该方法。</p>
<p>为了提升预加载频道的用户体验,声网推荐你在确认频道名、用户信息后、加入频道前,尽早调用该方法。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p><ul><li id="note1">调用该方法时,请确保用户角色设为观众、音频应用场景设为非合唱场景(<apiname keyref="AUDIO_SCENARIO_CHORUS"/>),否则预加载不生效。</li>
<ul><li id="note1">调用该方法时,请确保用户角色设为观众、音频应用场景设为非合唱场景(<apiname keyref="AUDIO_SCENARIO_CHORUS"/>),否则预加载不生效。</li>
<li>请确保预加载频道时传入的频道名、用户 ID、Token 和后续加入频道时传入的值相同,否则预加载不生效。</li>
<li id="note2">目前一个 <xref keyref="IRtcEngine"/> 实例最多支持预加载 20 个频道,如超出限制,仅最新预加载的 20 频道个生效。</li>
</ul></p>
<li id="note2">目前一个 <xref keyref="IRtcEngine"/> 实例最多支持预加载 20 个频道,如超出限制,仅最新预加载的 20 个频道生效。</li>
</ul>
</section>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
Expand Down
9 changes: 6 additions & 3 deletions dita/RTC-NG/API/api_irtcengine_renewtoken.dita
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,12 @@
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; renewToken(String token);</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<p>该方法用于更新 Token。Token 会在一定时间后失效,此时 SDK 将无法和服务器建立连接。</p>
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>在以下任意一种情况下,声网推荐你在你的服务端重新生成 Token,然后调用该方法传入新的 Token,否则 Token 过期后,SDK 将无法和服务器建立连接
<p>在以下任意一种情况下,声网推荐你在你的服务端重新生成 Token,然后调用该方法传入新的 Token:
<ul><li>收到 <xref keyref="onTokenPrivilegeWillExpire"/> 回调报告 Token 即将过期时;</li>
<li>收到 <xref keyref="onRequestToken"/> 回调报告 Token 已过期;</li>
<li>收到 <xref keyref="onConnectionStateChanged"/> 回调报告 <apiname keyref="CONNECTION_CHANGED_TOKEN_EXPIRED"/>(9) 时;</li>
Expand All @@ -38,10 +41,10 @@
</section>
<section id="related" deliveryTarget="details">
<title>相关回调</title>
<p><ul><li><xref keyref="onTokenPrivilegeWillExpire"/></li>
<ul><li><xref keyref="onTokenPrivilegeWillExpire"/></li>
<li><xref keyref="onRequestToken"/></li>
<li><xref keyref="onConnectionStateChanged"/></li>
</ul></p>
</ul>
</section>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<title>使用限制</title>
<p>无。</p>
</section>
<section id="parameters" deliveryTarget="details">
<section id="parameters" deliveryTarget="details" props="apple unity electron rn flutter cs">
<title> <ph keyref="callback-section-title" /> </title>
<parml>
<plentry conkeyref="onJoinChannelSuccess/engine" props="ios mac">
Expand Down

0 comments on commit 534766b

Please sign in to comment.