Skip to content

Commit

Permalink
Merge pull request #3680 from AgoraIO/API-5/6
Browse files Browse the repository at this point in the history 
api 们
  • Loading branch information
@Suri539
Suri539 authored Jul 9, 2024
2 parents 252416b + b66a4c9 commit d739ddf
Show file tree
Hide file tree
Showing 12 changed files with 162 additions and 146 deletions.
13 changes: 10 additions & 3 deletions dita/RTC-NG/API/api_irtcengine_pauseaudiomixing.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,16 @@
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; pauseAudioMixing();</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>详情</title>
<p>请在加入频道后调用该方法。</p>
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<p>当你调用 <xref keyref="startAudioMixing2"/> 方法播放音乐文件后，如需暂停播放，请调用该方法。如果你需要停止播放，请调用 <xref keyref="stopAudioMixing"/>。</p>
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>该方法需要在加入频道后调用。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="return_values">
<title><ph keyref="return-section-title"/></title>
Expand Down
13 changes: 10 additions & 3 deletions dita/RTC-NG/API/api_irtcengine_resumeaudiomixing.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,16 @@
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; resumeAudioMixing();</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>详情</title>
<p>该方法恢复混音，继续播放音乐文件。请在频道内调用该方法。</p>
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<p>当你调用 <xref keyref="pauseAudioMixing"/> 暂停播放音乐文件后，如需恢复播放，请调用该方法。</p>
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>该方法需要在加入频道后调用。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="return_values">
<title><ph keyref="return-section-title"/></title>
Expand Down
46 changes: 26 additions & 20 deletions dita/RTC-NG/API/api_irtcengine_setainsmode.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,33 +25,39 @@
<codeblock props="flutter" outputclass="language-dart">Future&lt;void> setAINSMode(
{required bool enabled, required AudioAinsMode mode});</codeblock> </p>
</section>
<section id="detailed_desc">
<title>详情</title>
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<dl outputclass="since">
<dlentry props="native">
<dt>自从</dt>
<dd>v4.2.0</dd>
</dlentry>
<dlentry props="native">
<dt>自从</dt>
<dd>v4.2.0</dd>
</dlentry>
</dl>
<p>你可以调用开方法来开启 AI 降噪功能。该功能可以在保证语音质量的前提下，智能化检测并降低周围环境中多种稳态与非稳态噪声，使人声更加清晰。
稳态噪声指在任何时间点上都具有相同频率的噪声，常见的稳态噪声有：
<ul><li>电视机噪声</li>
<li>空调噪声</li>
<li>工厂机器噪声等</li></ul>
非稳态噪声是指随时间而快速变化的噪声，常见的非稳态噪声有：
<ul><li>雷声</li>
<li>爆炸声</li>
<li>破裂声等</li></ul></p>
<note>
<ul><li props="native">该方法依赖于 AI 降噪动态库 <codeph><ph keyref="noisesuppression"/></codeph>，如果删除该动态库会导致无法正常开启该功能。</li>
<li props="hide">该方法依赖于 AI 降噪动态库，如果删除该动态库会导致无法正常开启该功能。AI 降噪动态库名称见<xref keyref="extensions"/>。</li>
<li props="cpp android flutter unity bp unreal rn">目前暂不推荐在 Android 6.0 及以下版本的设备上开启该功能。</li></ul></note>
稳态噪声指在任何时间点上都具有相同频率的噪声，常见的稳态噪声有：
<ul><li>电视机噪声</li>
<li>空调噪声</li>
<li>工厂机器噪声等</li></ul>
非稳态噪声是指随时间而快速变化的噪声，常见的非稳态噪声有：
<ul><li>雷声</li>
<li>爆炸声</li>
<li>破裂声等</li></ul>
</p>
</section>
<section id="scenario">
<section id="scenario" deliveryTarget="details">
<title>适用场景</title>
<p>在语音连麦、在线教育、在线会议等场景中，如果周围环境比较嘈杂，AI 降噪功能可以在保证语音质量的前提下，识别并降低周围的稳态噪声和非稳态噪声，提高语音质量和体验。</p>
</section>
<section id="parameters">
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>该方法在加入频道前后均可调用。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<ul><li props="native">该方法依赖于 AI 降噪动态库 <codeph><ph keyref="noisesuppression"/></codeph>，如果删除该动态库会导致无法正常开启该功能。</li>
<li props="unity flutter rn">该方法依赖于 AI 降噪动态库，如果删除该动态库会导致无法正常开启该功能。AI 降噪动态库名称见<xref keyref="reduce-app-size"/>。</li>
<li props="cpp android flutter unity bp unreal rn">目前暂不推荐在 Android 6.0 及以下版本的设备上开启该功能。</li></ul>
</section>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry>
Expand Down
17 changes: 12 additions & 5 deletions dita/RTC-NG/API/api_irtcengine_setaudiomixingpitch.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,18 @@
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; setAudioMixingPitch(int pitch);</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>详情</title>
<p>本地人声和播放的音乐文件混音时，调用该方法可以仅调节音乐文件的音调。</p>
<note type="attention">你需要在调用 <apiname keyref="startAudioMixing2" /> 并收到 <apiname keyref="onAudioMixingStateChanged" /><codeph>(<ph keyref="AUDIO_MIXING_STATE_PLAYING" />)</codeph> 回调后调用该方法。</note> </section>
<section id="parameters">
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<p>本地人声和播放的音乐文件混音时，调用该方法可以仅调节音乐文件的音调。</p>
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>你需要在调用 <apiname keyref="startAudioMixing2" /> 并收到 <apiname keyref="onAudioMixingStateChanged" /><codeph>(<ph keyref="AUDIO_MIXING_STATE_PLAYING" />)</codeph> 回调后调用该方法。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry id="pitch">
Expand Down
87 changes: 29 additions & 58 deletions dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,69 +34,40 @@
int startPos = 0});</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>详情</title>
<dl outputclass="deprecated" props="native unreal bp">
<dlentry>
<dt>弃用：</dt>
<dd>请改用 <xref keyref="startAudioMixing2" />。</dd>
</dlentry>
</dl>
<p id="audiomixing_detailed">该方法支持将本地或在线音乐文件和麦克风采集的音频进行混音或替换。成功播放音乐文件后，本地会触发 <xref keyref="onAudioMixingStateChanged" /> (<apiname keyref="AUDIO_MIXING_STATE_PLAYING" />) 回调。播放结束后，本地会触发 <apiname keyref="onAudioMixingStateChanged" /> (<apiname keyref="AUDIO_MIXING_STATE_STOPPED" />) 回调。</p>
<p id="uri" props="android hmos">该方法支持播放以 <codeph>content://</codeph> 开头的 URI 文件。</p>
<note type="attention" id="audiomixing_note">
<ul>
<li>该方法在加入频道前后均可调用。如需多次调用 <apiname keyref="startAudioMixing" />，请确保调用间隔大于 500 ms。</li>
<li>如果本地音乐文件不存在、文件格式不支持或无法访问在线音乐文件 URL，则 SDK 会报告警告码 701。</li>
<li props="android cpp unreal bp unity flutter rn" id="principle">在 Android 平台上调用该方法时，请注意如下事项：
<ul>
<li>请确保使用 Android 4.2 或以上设备，且 API Level 不低于 16。</li>
<li>如果播放的是在线音乐文件，建议不要使用重定向地址。重定向地址在某些机型上可能无法打开。</li>
<li>如果在模拟器上调用该方法，则请确保音乐文件在 <codeph>/sdcard/</codeph> 目录下，且格式为 MP3。</li>
</ul></li>
</ul> </note> </section>
<section id="parameters">
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<dl outputclass="deprecated" props="native unreal bp">
<dlentry>
<dt>弃用：</dt>
<dd>请改用 <xref keyref="startAudioMixing2" />。</dd>
</dlentry>
</dl>
<p props="cpp apple framework">该方法支持播放的音频文件格式见 <xref keyref="audio-format">RTC SDK 支持播放哪些格式的音频文件</xref>。如果本地音乐文件不存在、文件格式不支持或无法访问在线音乐文件 URL，则 SDK 会报告警告码 701。</p>
<p id="uri" props="android hmos">该方法支持播放以 <codeph>content://</codeph> 开头的 URI 文件。支持的音频格式详见 <xref keyref="audio-format">RTC SDK 支持播放哪些格式的音频文件</xref>。如果本地音乐文件不存在、文件格式不支持或无法访问在线音乐文件 URL，则 SDK 会报告警告码 701。</p>
</section>
<section id="timing" deliveryTarget="details" conkeyref="startAudioMixing2/timing">
</section>
<section id="restriction" deliveryTarget="details" conkeyref="startAudioMixing2/restriction">
</section>
<section id="related" deliveryTarget="details" conkeyref="startAudioMixing2/related">
</section>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry conkeyref="playEffect2/filepath" props="unity cs">
<pt />
<pd />
</plentry>
<plentry props="native unreal bp" conkeyref="playEffect3/filepath">
<pt>filePath</pt>
<pd>
<p/>
</pd>
</plentry>
<plentry id="loopback">
<pt>loopback</pt>
<pd>
<p>是否只在本地播放音乐文件：

<ul>
<li><codeph><ph keyref="true" /></codeph>: 只在本地播放音乐文件，只有本地用户能听到音乐。</li>
<li><codeph><ph keyref="false" /></codeph>: 将本地播放的音乐文件发布至远端，本地用户和远端用户都能听到音乐。</li>
</ul></p>
</pd>
<plentry props="native unreal bp unity cs" conkeyref="playEffect3/filepath">
<pt/>
<pd/>
</plentry>
<plentry id="cycle">
<pt>cycle</pt>
<pd>
<p>音乐文件的播放次数。

<ul>
<li>≥ 0: 播放次数。例如，0 表示不播放；1 表示播放 1 次。</li>
<li>-1: 无限循环播放。</li>
</ul></p>
</pd>
<plentry conkeyref="startAudioMixing2/loopback">
<pt/>
<pd/>
</plentry>
<plentry conkeyref="startAudioMixing2/cycle">
<pt/>
<pd/>
</plentry>
</parml> </section>
<section id="return_values">
<title><ph keyref="return-section-title"/></title>
<p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
<ul props="native unreal bp unity rn electron cs">
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul> </section>
<section id="return_values" conkeyref="startAudioMixing2/return_values">
</section>
</refbody>
</reference>
Loading

0 comments on commit d739ddf

Please sign in to comment.