Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Hh api batch4 #3712

Merged
merged 3 commits into from
Aug 1, 2024
Merged

Hh api batch4 #3712

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
658db25
add batch4
Nero-Hu Jul 19, 2024
770bd25
add batch5
Nero-Hu Jul 19, 2024
bec2144
peer review fixes
Nero-Hu Aug 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion dita/RTC-NG/API/api_imediaplayer_adjustplayoutvolume.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,16 @@
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; adjustPlayoutVolume(int volume);</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="parameters">
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title"/>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>加入频道前后均可调用。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry>
Expand Down
13 changes: 10 additions & 3 deletions dita/RTC-NG/API/api_imediaplayer_adjustpublishsignalvolume.dita
View file
Open in desktop
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; adjustPublishSignalVolume(int volume);</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>详情</title>
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<p>连接到声网服务器后，你可以调用该方法，调节远端用户听到的媒体文件的音量。</p>
</section>
<section id="parameters">
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>加入频道前后均可调用。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry>
Expand Down
18 changes: 14 additions & 4 deletions dita/RTC-NG/API/api_imediaplayer_open.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,27 @@
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; open({required String url, required int startPos});</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>详情</title>
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<p props="hide">在 Android 平台上，如果你需要打开 URI 格式的文件，请使用 <xref keyref="open2" />。</p>
<p id="uri" props="android hmos">该方法支持打开以 <codeph>content://</codeph> 开头的 URI 文件。</p>
<p id="format" props="native"><ph props="cn">媒体播放器支持的格式详见<xref keyref="media-player"/>。</ph></p>
<p props="hide">如果用户需要自定义播放线路，你可以调用 <xref keyref="openWithAgoraCDNSrc" />。声网会通过自研调度中心支持调度线路，提升观看用户体验。如果用户不需要自定义播放线路，你可以调用 <xref keyref="open" />。</p>
<note type="attention" id="note">
<p props="native unreal bp unity electron flutter cs">该方法为异步调用。</p>
<p id="open">如需播放媒体文件，请在收到 <xref keyref="onPlayerSourceStateChanged" /> 回调报告播放状态为 <apiname keyref="PLAYER_STATE_OPEN_COMPLETED" /> 后再调用 <xref keyref="play" /> 方法播放媒体文件。</p>
</note> </section>
<section id="parameters">
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>加入频道前后均可调用。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="related" deliveryTarget="details">
<title>相关回调</title>
<p id="open">调用该方法后会触发 <xref keyref="onPlayerSourceStateChanged" /> 回调。在收到报告播放状态为 <apiname keyref="PLAYER_STATE_OPEN_COMPLETED" /> 后，你可以调用 <xref keyref="play" /> 方法播放媒体文件。</p>
</section>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry>
Expand Down
17 changes: 14 additions & 3 deletions dita/RTC-NG/API/api_imediaplayer_open2.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,22 @@
<codeblock props="rn" outputclass="language-typescript" />
<codeblock props="flutter" outputclass="language-dart" /> </p>
</section>
<section id="detailed_desc">
<title>详情</title>
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<note type="attention" conkeyref="open/note" />
Nero-Hu marked this conversation as resolved.
Show resolved Hide resolved
</section>
<section id="parameters">
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>加入频道前后均可调用。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="related" deliveryTarget="details">
<title>相关回调</title>
<p conkeyref="open/open"/>
</section>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry id="uri">
Expand Down
17 changes: 11 additions & 6 deletions dita/RTC-NG/API/api_irtcengine_adjustaudiomixingplayoutvolume.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,17 @@
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; adjustAudioMixingPlayoutVolume(int volume);</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>详情</title>
<note type="attention">
你需要在调用 <xref 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">
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>你需要在调用 <xref 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>
Expand Down
18 changes: 11 additions & 7 deletions dita/RTC-NG/API/api_irtcengine_adjustaudiomixingpublishvolume.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,18 @@
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; adjustAudioMixingPublishVolume(int volume);</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>详情</title>
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<p>该方法调节混音音乐文件在远端的播放音量大小。</p>
<note type="attention">
<p>你需要在调用 <xref keyref="startAudioMixing2" props="native unreal bp flutter unity rn electron" /> 并收到 <apiname keyref="onAudioMixingStateChanged" /><codeph>(<ph keyref="AUDIO_MIXING_STATE_PLAYING" />)</codeph> 回调后调用该方法。
</p>
</note> </section>
<section id="parameters">
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>你需要在调用 <xref keyref="startAudioMixing2" props="native unreal bp flutter unity rn electron" /> 并收到 <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>
Expand Down
20 changes: 12 additions & 8 deletions dita/RTC-NG/API/api_irtcengine_adjustaudiomixingvolume.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,19 @@
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; adjustAudioMixingVolume(int volume);</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>详情</title>
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<p>该方法调节混音音乐文件在本端和远端的播放音量大小。</p>
<note type="attention">
<ul>
<li>该方法需要在 <xref keyref="startAudioMixing2"/> 后调用。</li>
<li props="native unreal bp">调用该方法不影响调用 <xref keyref="playEffect3"/> 播放音效文件的音量。</li>
</ul> </note> </section>
<section id="parameters">
<note type="note" props="native unreal bp">调调用该方法不会影响 <xref keyref="playEffect3"/> 方法中设置的音效文件播放音量。</note>
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>该方法需要在 <xref keyref="startAudioMixing2"/> 后调用。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry id="volume">
Expand Down
14 changes: 10 additions & 4 deletions dita/RTC-NG/API/api_irtcengine_enablevideoimagesource.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,19 @@
{required bool enable, required ImageTrackOptions options});</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>详情</title>
<note type="attention">建议你在加入频道后调用该方法。</note>
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<p>在发布视频流时，你可以调用该方法使用自定义图片来替代当前发布的视频流画面进行推流。</p>
<p>开启该功能后，你可以通过 <xref keyref="ImageTrackOptions" /> 参数自定义垫片图片；在你关闭垫片功能之后，远端用户看到的依旧是当前你发布的视频流画面。</p>
</section>
<section id="parameters">
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>建议在加入频道后调用该方法。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry>
Expand Down
17 changes: 11 additions & 6 deletions dita/RTC-NG/API/api_irtcengine_setaudioeffectpreset.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,18 @@
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; setAudioEffectPreset(AudioEffectPreset preset);</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>详情</title>
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<p>调用该方法可以为本地发流用户设置 SDK 预设的人声音效，且不会改变原声的性别特征。设置音效后，频道内所有用户都能听到该效果。</p>
<p props="cn"><ph props="native">根据不同的场景，你可以为用户设置不同的音效，各音效的适用场景可参考<xref keyref="voice-changer-link"/>。</ph></p>
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>加入频道前后均可调用。</p>
<p conkeyref="setVoiceBeautifierPreset/recommend"/>
<note type="attention">
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<ul>
<li>该方法在加入频道前后都能调用。</li>
<li conkeyref="setVoiceBeautifierPreset/profile-note"/>
<li>如果调用 <apiname keyref="setAudioEffectPreset" /> 并设置除 <apiname keyref="ROOM_ACOUSTICS_3D_VOICE" /> 或 <apiname keyref="PITCH_CORRECTION" /> 外的枚举，请勿再调用 <xref keyref="setAudioEffectParameters" />，否则 <apiname keyref="setAudioEffectPreset" /> 设置的效果会被覆盖。</li>
<li>调用 <apiname keyref="setAudioEffectPreset" /> 后，不建议调用以下方法，否则 <apiname keyref="setAudioEffectPreset" /> 设置的效果会被覆盖：
Expand All @@ -45,8 +49,9 @@
<li><xref keyref="setVoiceConversionPreset" /></li>
</ul> </li>
<li>该方法依赖于美声动态库 <codeph><ph keyref="audiobeauty"/></codeph>，如果删除该动态库会导致无法正常开启该功能。</li>
</ul> </note> </section>
<section id="parameters">
</ul>
</section>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry>
Expand Down
14 changes: 10 additions & 4 deletions dita/RTC-NG/API/api_irtcengine_setlocalvoiceequalization.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,16 @@
required int bandGain});</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>详情</title>
<note type="attention">该方法在加入频道前后都能调用。</note> </section>
<section id="parameters">
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title"/>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>加入频道前后均可调用。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry>
Expand Down
21 changes: 15 additions & 6 deletions dita/RTC-NG/API/api_irtcengine_setlocalvoiceformant.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,19 +25,28 @@
<codeblock props="rn" outputclass="language-typescript">abstract setLocalVoiceFormant(formantRatio: number): number;</codeblock>
<codeblock props="flutter" outputclass="language-dart">Future&lt;void> setLocalVoiceFormant(double formantRatio);</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>
</dl>
<p>共振峰比率是影响声音音色的一个参数，共振峰比率取值越小声音会更低沉，取值越大声音会更尖锐。</p>
<p>在语音直播、语聊房、K 歌房等场景中，你可以调用该方法设置本地语音的共振峰比率参数从而改变音色效果。设置共振峰比率后，频道内所有用户都能听到该效果。如果你想要在调整音色的同时改变音调，声网推荐你搭配 <xref keyref="setLocalVoicePitch"/> 一起使用。
<note type="attention">该方法在加入频道前后均可调用。</note></p>
<p>共振峰比率是影响声音音色的一个参数，共振峰比率取值越小声音会更低沉，取值越大声音会更尖锐。设置共振峰比率后，频道内所有用户都能听到该效果。如果你想要在调整音色的同时改变音调，声网推荐你搭配 <xref keyref="setLocalVoicePitch"/> 一起使用。
</section>
<section id="parameters">
<section id="scenario" deliveryTarget="details">
<title>适用场景</title>
<p>在语音直播、语聊房、K 歌房等场景中，你可以调用该方法设置本地语音的共振峰比率参数从而改变音色效果。</p>
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>加入频道前后均可调用。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry>
Expand Down
14 changes: 10 additions & 4 deletions dita/RTC-NG/API/api_irtcengine_setlocalvoicepitch.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,16 @@
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; setLocalVoicePitch(double pitch);</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>详情</title>
<note type="attention">该方法在加入频道前后都能调用。</note> </section>
<section id="parameters">
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title"/>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>加入频道前后均可调用。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry>
Expand Down
Loading
Loading