Skip to content

Commit 6cc7211

Browse files
committed
add deprecate for start and stop RhythmPlayer
1 parent 6ad0173 commit 6cc7211

File tree

3 files changed

+20
-2
lines changed

3 files changed

+20
-2
lines changed

dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,12 @@
3737
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
3838
</section>
3939
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
40+
<dl outputclass="deprecated" props="native">
41+
<dlentry outputclass="deprecated">
42+
<dt>弃用:</dt>
43+
<dd props="native">该方法自 v4.6.0 版本废弃。</dd>
44+
</dlentry>
45+
</dl>
4046
<ul>
4147
<li>开启虚拟节拍器后,SDK 会从头开始播放指定的音频文件,并根据你在 <xref keyref="AgoraRhythmPlayerConfig"/> 中设置的 <parmname>beatsPerMinute</parmname> 控制每个文件的播放时长。例如,将 <parmname>beatsPerMinute</parmname> 设为 <codeph>60</codeph>,则 SDK 会 1 秒播放 1 个节拍。如果文件时长超过了节拍时长,则 SDK 只播放节拍时长部分的音频。</li>
4248
<li>虚拟节拍器的声音默认不会发布至远端,如果你希望远端用户听到虚拟节拍器的声音,你可以在调用该方法后,将 <xref keyref="ChannelMediaOptions"/> 中的 <parmname>publishRhythmPlayerTrack</parmname> 设为 <codeph><ph keyref="true"/></codeph>。</li>
@@ -49,7 +55,7 @@
4955
<section id="timing" deliveryTarget="details">
5056
<title>调用时机</title>
5157
<p>加入频道前后均可调用。</p>
52-
</section>
58+
</section>
5359
<section id="restriction" deliveryTarget="details">
5460
<title>调用限制</title>
5561
<p>无。</p>

dita/RTC-NG/API/api_irtcengine_stoprhythmplayer.dita

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,12 @@
2727
</section>
2828
<section id="detailed_desc">
2929
<title>详情</title>
30+
<dl outputclass="deprecated" props="native">
31+
<dlentry outputclass="deprecated">
32+
<dt>弃用:</dt>
33+
<dd props="native">该方法自 v4.6.0 版本废弃。</dd>
34+
</dlentry>
35+
</dl>
3036
<p>调用 <xref keyref="startRhythmPlayer" /> 后,你可以调用该方法关闭虚拟节拍器。</p>
3137
<note type="attention" props="cpp unreal bp unity flutter cs">该方法仅适用于 Android 和 iOS。</note> </section>
3238
<section id="return_values">
@@ -37,4 +43,4 @@
3743
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
3844
</ul> </section>
3945
</refbody>
40-
</reference>
46+
</reference>

dita/RTC-NG/API/callback_irtcengineeventhandler_onrhythmplayerstatechanged.dita

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,12 @@
3737
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
3838
</section>
3939
<section id="detailed_desc">
40+
<dl outputclass="deprecated" props="native">
41+
<dlentry outputclass="deprecated">
42+
<dt>弃用:</dt>
43+
<dd props="native">该方法自 v4.6.0 版本废弃。</dd>
44+
</dlentry>
45+
</dl>
4046
<p>虚拟节拍器状态发生改变时,SDK 会触发该回调报告当前的虚拟节拍器状态。在虚拟节拍器出现故障时,该回调可以帮助你了解当前虚拟节拍的状态以及出现故障的原因,方便你排查问题。</p>
4147
<note type="attention" props="cpp unreal bp unity flutter cs">该回调仅适用于 Android 和 iOS。</note> </section>
4248
<section id="parameters">

0 commit comments

Comments
 (0)