Skip to content

Commit

Permalink
Merge branch '4.4.0-bugfix-0926' of github.com:AgoraIO/agora_doc_sour…
Browse files Browse the repository at this point in the history 
…ce into 4.4.0-bugfix-0926
  • Loading branch information
@Suri539
Suri539 committed Sep 27, 2024
2 parents e44f94d + f917d7b commit ee2cc9d
Show file tree
Hide file tree
Showing 9 changed files with 157 additions and 7 deletions.
2 changes: 1 addition & 1 deletion dita/RTC-NG/API/api_irtcengineex_leavechannelex.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down
4 changes: 2 additions & 2 deletions dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@
<note type="attention">
<ul>
<li>该方法是异步操作，调用返回时并没有真正退出频道。</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>
<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>
<section id="scenario" deliveryTarget="details" conkeyref="leaveChannelEx/scenario">
Expand Down
4 changes: 2 additions & 2 deletions dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onpreloadevent.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@
<dd>v4.1.0</dd>
</dlentry>
</dl>
<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>
<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>
Expand Down
154 changes: 152 additions & 2 deletions dita/RTC-NG/API/rtc_api_sunset.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<title>已废弃 API</title>
<p>废弃后的 API 预计会在 1 年左右正式下架。声网建议你尽快使用推荐的 API 进行替换，以免影响线上业务。</p>
<!--如果预见到表格内的内容会超宽，则在 table 外侧套一个 div，用于限定 section 内的表格宽度-->
<div>
<div>
<table frame="all" rowsep="1" colsep="1" props="cn">
<!--CN 表格-->
<!--由于 table 中的 row 不能分级打 props，所以 cn 和 en 需要分两个表格维护：仅发 cn/en 的 API 只需要在对应表格中增加；cn 和 en 都发的 API 需要在两个表格中都加。-->
Expand Down Expand Up @@ -103,6 +103,18 @@
<entry><xref keyref="createDataStreamEx2"/></entry>
<entry>v4.0.0</entry>
</row>
<row props="android">
<entry><xref keyref="pushVideoFrame"/></entry>
<entry><ph conkeyref="pushVideoFrame/shortdesc"/></entry>
<entry><xref keyref="pushVideoFrame3"/></entry>
<entry>v4.0.0</entry>
</row>
<row props="android">
<entry><xref keyref="pushVideoFrame2"/></entry>
<entry><ph conkeyref="pushVideoFrame2/shortdesc"/></entry>
<entry><xref keyref="pushVideoFrame4"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="setLocalVideoMirrorMode"/></entry>
<entry><ph conkeyref="setLocalVideoMirrorMode/shortdesc"/></entry>
Expand All @@ -127,6 +139,12 @@
<entry>使用 <xref keyref="initialize"/> 中的 <parmname props="cpp">context</parmname><parmname props="android apple">config</parmname> 参数</entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="setLogFilter"/></entry>
<entry><ph conkeyref="setLogFilter/shortdesc"/></entry>
<entry>使用 <xref keyref="initialize"/> 中的 <parmname props="cpp">context</parmname><parmname props="android apple">config</parmname> 参数</entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="setLogFile"/></entry>
<entry><ph conkeyref="setLogFile/shortdesc"/></entry>
Expand All @@ -151,6 +169,12 @@
<entry><xref keyref="setAudioProfile2"/> 或 <xref keyref="setAudioScenario"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="startAudioMixing"/></entry>
<entry><ph conkeyref="startAudioMixing/shortdesc"/></entry>
<entry><xref keyref="startAudioMixing2" /></entry>
<entry>v4.0.0</entry>
</row>
<row props="android ios cpp">
<entry><xref keyref="preload"/></entry>
<entry><ph conkeyref="preload/shortdesc"/></entry>
Expand Down Expand Up @@ -199,6 +223,48 @@
<entry>-</entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="onAudioMixingFinished"/></entry>
<entry><ph conkeyref="onAudioMixingFinished/shortdesc"/></entry>
<entry><xref keyref="onAudioMixingStateChanged"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="onAudioQuality"/></entry>
<entry><ph conkeyref="onAudioQuality/shortdesc"/></entry>
<entry><xref keyref="onRemoteAudioStats"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="onConnectionBanned"/></entry>
<entry><ph conkeyref="onConnectionBanned/shortdesc"/></entry>
<entry><xref keyref="onConnectionStateChanged"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="onConnectionInterrupted"/></entry>
<entry><ph conkeyref="onConnectionInterrupted/shortdesc"/></entry>
<entry><xref keyref="onConnectionStateChanged"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="onFirstRemoteAudioFrame"/></entry>
<entry><ph conkeyref="onFirstRemoteAudioFrame/shortdesc"/></entry>
<entry><xref keyref="onRemoteAudioStateChanged"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="onFirstRemoteAudioDecoded"/></entry>
<entry><ph conkeyref="onFirstRemoteAudioDecoded/shortdesc"/></entry>
<entry><xref keyref="onRemoteAudioStateChanged"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="onRemoteAudioTransportStats"/></entry>
<entry><ph conkeyref="onRemoteAudioTransportStats/shortdesc"/></entry>
<entry><xref keyref="onRemoteAudioStats"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="onRemoteVideoTransportStats"/></entry>
<entry><ph conkeyref="onRemoteVideoTransportStats/shortdesc"/></entry>
Expand All @@ -211,6 +277,12 @@
<entry><xref keyref="onRemoteVideoStateChanged"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="onVideoStopped"/></entry>
<entry><ph conkeyref="onVideoStopped/shortdesc"/></entry>
<entry><xref keyref="onLocalVideoStateChanged"/></entry>
<entry>v4.0.0</entry>
</row>
</tbody>
</tgroup>
</table>
Expand Down Expand Up @@ -305,6 +377,18 @@
<entry><xref keyref="createDataStreamEx2"/></entry>
<entry>v4.0.0</entry>
</row>
<row props="android">
<entry><xref keyref="pushVideoFrame"/></entry>
<entry><ph conkeyref="pushVideoFrame/shortdesc"/></entry>
<entry><xref keyref="pushVideoFrame3"/></entry>
<entry>v4.0.0</entry>
</row>
<row props="android">
<entry><xref keyref="pushVideoFrame2"/></entry>
<entry><ph conkeyref="pushVideoFrame2/shortdesc"/></entry>
<entry><xref keyref="pushVideoFrame4"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="setLocalVideoMirrorMode"/></entry>
<entry><ph conkeyref="setLocalVideoMirrorMode/shortdesc"/></entry>
Expand All @@ -329,6 +413,12 @@
<entry>使用 <xref keyref="initialize"/> 中的 <parmname props="cpp">context</parmname><parmname props="android apple">config</parmname> 参数</entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="setLogFilter"/></entry>
<entry><ph conkeyref="setLogFilter/shortdesc"/></entry>
<entry>使用 <xref keyref="initialize"/> 中的 <parmname props="cpp">context</parmname><parmname props="android apple">config</parmname> 参数</entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="setLogFile"/></entry>
<entry><ph conkeyref="setLogFile/shortdesc"/></entry>
Expand All @@ -353,6 +443,18 @@
<entry><xref keyref="setAudioProfile2"/> 或 <xref keyref="setAudioScenario"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="startAudioMixing"/></entry>
<entry><ph conkeyref="startAudioMixing/shortdesc"/></entry>
<entry><xref keyref="startAudioMixing2" /></entry>
<entry>v4.0.0</entry>
</row>
<row props="android ios cpp">
<entry><xref keyref="preload"/></entry>
<entry><ph conkeyref="preload/shortdesc"/></entry>
<entry><xref keyref="preload2"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="addVideoWatermark1"/></entry>
<entry><ph conkeyref="addVideoWatermark1/shortdesc"/></entry>
Expand Down Expand Up @@ -395,18 +497,66 @@
<entry>-</entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="onAudioMixingFinished"/></entry>
<entry><ph conkeyref="onAudioMixingFinished/shortdesc"/></entry>
<entry><xref keyref="onAudioMixingStateChanged"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="onAudioQuality"/></entry>
<entry><ph conkeyref="onAudioQuality/shortdesc"/></entry>
<entry><xref keyref="onRemoteAudioStats"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="onConnectionBanned"/></entry>
<entry><ph conkeyref="onConnectionBanned/shortdesc"/></entry>
<entry><xref keyref="onConnectionStateChanged"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="onConnectionInterrupted"/></entry>
<entry><ph conkeyref="onConnectionInterrupted/shortdesc"/></entry>
<entry><xref keyref="onConnectionStateChanged"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="onFirstRemoteAudioFrame"/></entry>
<entry><ph conkeyref="onFirstRemoteAudioFrame/shortdesc"/></entry>
<entry><xref keyref="onRemoteAudioStateChanged"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="onFirstRemoteAudioDecoded"/></entry>
<entry><ph conkeyref="onFirstRemoteAudioDecoded/shortdesc"/></entry>
<entry><xref keyref="onRemoteAudioStateChanged"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="onRemoteAudioTransportStats"/></entry>
<entry><ph conkeyref="onRemoteAudioTransportStats/shortdesc"/></entry>
<entry><xref keyref="onRemoteAudioStats"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="onRemoteVideoTransportStats"/></entry>
<entry><ph conkeyref="onRemoteVideoTransportStats/shortdesc"/></entry>
<entry><xref keyref="onRemoteVideoStats"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<row>
<entry><xref keyref="onUserEnableLocalVideo"/></entry>
<entry><ph conkeyref="onUserEnableLocalVideo/shortdesc"/></entry>
<entry><xref keyref="onRemoteVideoStateChanged"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="onVideoStopped"/></entry>
<entry><ph conkeyref="onVideoStopped/shortdesc"/></entry>
<entry><xref keyref="onLocalVideoStateChanged"/></entry>
<entry>v4.0.0</entry>
</row>
</tbody>
</tgroup>
</table>
Expand Down
0 ...irtcengine_setlocalvoicereverbpreset.dita → ...irtcengine_setlocalvoicereverbpreset.dita
View file
File renamed without changes.
0 ...venthandler_onchannelmediarelayevent.dita → ...venthandler_onchannelmediarelayevent.dita
View file
File renamed without changes.
0 ...eeventhandler_onfirstlocalaudioframe.dita → ...eeventhandler_onfirstlocalaudioframe.dita
View file
File renamed without changes.
0 ...engineeventhandler_onstreampublished.dita → ...engineeventhandler_onstreampublished.dita
View file
File renamed without changes.
0 ...gineeventhandler_onstreamunpublished.dita → ...gineeventhandler_onstreamunpublished.dita
View file
File renamed without changes.

0 comments on commit ee2cc9d

Please sign in to comment.