Skip to content

Commit

Permalink
resolve comments
Browse files Browse the repository at this point in the history
  • Loading branch information
jinyuagora committed May 9, 2024
1 parent effe0ec commit 6f86a97
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 25 deletions.
4 changes: 2 additions & 2 deletions dita/RTC-NG/API/api_irtcengine_disableaudio.dita
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<p>调用该方法设置音频模块为禁用状态(默认开启)。</p>
<p>音频模块默认开启,你可以调用该方法关闭音频模块。</p>
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>在频道内和频道外均可调用。离开频道后仍然有效。</p>
<p>加入频道前后均可调用。离开频道后仍然有效。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
Expand Down
6 changes: 3 additions & 3 deletions dita/RTC-NG/API/api_irtcengine_enableaudio.dita
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public abstract int enableAudio();</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)enableAudio NS_SWIFT_NAME(enableAudio());</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)enableAudio;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int enableAudio() = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|RtcEngineProxy&quot;)
int EnableAudio();</codeblock>
Expand All @@ -25,11 +25,11 @@
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<p id="desc">音频模块默认为开启状态。</p>
<p id="desc">音频模块默认开启。如果你调用 <xref keyref="disableAudio"/> 关闭了音频模块,可调用该方法重新开启。</p>
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>在频道内和频道外均可调用。在离开频道后仍然有效。</p>
<p>加入频道前后均可调用。离开频道后仍然有效。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
Expand Down
11 changes: 6 additions & 5 deletions dita/RTC-NG/API/api_irtcengine_enablelocalaudio.dita
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,11 @@
</section>
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<p>当用户加入频道时,音频功能默认是开启的。该方法可以关闭或重新开启本地音频功能,即停止或重新开始本地音频采集。</p>
<p>该方法与 <xref keyref="muteLocalAudioStream" /> 的区别在于:
<ul>
<li><apiname keyref="enableLocalAudio" />: 开启或关闭本地音频采集及处理。使用 <apiname keyref="enableLocalAudio" /> 关闭或开启本地采集后,本地听远端播放会有短暂中断。</li>
<li><apiname keyref="muteLocalAudioStream" />: 停止或继续发送本地音频流,不影响音频的采集状态。</li>
</ul></p>
</section>
<section id="scenario" deliveryTarget="details">
<title>适用场景</title>
Expand All @@ -37,11 +42,7 @@
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>该方法与 <xref keyref="muteLocalAudioStream" /> 的区别在于:
<ul>
<li><apiname keyref="enableLocalAudio" />: 开启或关闭本地音频采集及处理。使用 <apiname keyref="enableLocalAudio" /> 关闭或开启本地采集后,本地听远端播放会有短暂中断。</li>
<li><apiname keyref="muteLocalAudioStream" />: 停止或继续发送本地音频流,不影响音频的采集状态。</li>
</ul></p>
<p>无。</p>
</section>
<section id="related" deliveryTarget="details">
<title>相关回调</title>
Expand Down
16 changes: 8 additions & 8 deletions dita/RTC-NG/API/api_irtcengine_setaudioprofile.dita
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,15 @@
</section>
<section id="scenario" deliveryTarget="details">
<title>适用场景</title>
<p>该方法适用于各种音频场景,你可以按需选择。例如,在音乐教学等高音质需求的场景中,建议将 <parmname>profile</parmname> 设置为 <codeph><ph keyref="AUDIO_PROFILE_MUSIC_HIGH_QUALITY" />(4)</codeph>,<parmname>scenario</parmname> 设置为 <codeph><ph keyref="AUDIO_SCENARIO_GAME_STREAMING" />(3)</codeph>。</p>
<p>该方法适用于各种音频场景,你可以按需选择。例如,在音乐教学等高音质需求的场景中,建议将 <parmname>profile</parmname> 设置为 <codeph><ph keyref="AUDIO_PROFILE_MUSIC_HIGH_QUALITY" /></codeph>(4),<parmname>scenario</parmname> 设置为 <codeph><ph keyref="AUDIO_SCENARIO_GAME_STREAMING" /></codeph>(3)。</p>
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>该方法在加入频道前后均可调用。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p props="ios cpp unreal bp flutter unity rn">由于 iOS 系统限制,部分音频路由在通话音量模式下无法识别。因此,如需使用外接声卡,建议将音频应用场景设置为高音质场景 <codeph><ph keyref="AUDIO_SCENARIO_GAME_STREAMING" />(3)</codeph>。在这种场景下,SDK 会切换到媒体音量规避该问题。</p>
<p props="ios cpp unreal bp flutter unity rn">由于 iOS 系统限制,部分音频路由在通话音量模式下无法识别。因此,如需使用外接声卡,建议将音频应用场景设置为高音质场景 <codeph><ph keyref="AUDIO_SCENARIO_GAME_STREAMING" /></codeph>(3)。在这种场景下,SDK 会切换到媒体音量规避该问题。</p>
<p props="android mac electron cs">无。</p>
</section>
<section id="parameters" deliveryTarget="details">
Expand All @@ -61,15 +61,15 @@
<pd>
<p id="profile"><ph>音频编码属性,包含采样率、码率、编码模式和声道数。</ph><ph props="apple cpp framework">详见 <xref keyref="AUDIO_PROFILE_TYPE" />。</ph>
<ul props="android">
<li><codeph><ph keyref="AUDIO_PROFILE_DEFAULT" />(0)</codeph>:默认值。
<li><codeph><ph keyref="AUDIO_PROFILE_DEFAULT" /></codeph>(0):默认值。
<ul conkeyref="AUDIO_PROFILE_TYPE/default-profile">
<li />
</ul></li>
<li><codeph><ph keyref="AUDIO_PROFILE_SPEECH_STANDARD" />(1)</codeph>:指定 32 kHz 采样率,语音编码,单声道,编码码率最大值为 18 Kbps。</li>
<li><codeph><ph keyref="AUDIO_PROFILE_MUSIC_STANDARD" />(2)</codeph>:指定 48 kHz 采样率,音乐编码,单声道,编码码率最大值为 64 Kbps。</li>
<li><codeph><ph keyref="AUDIO_PROFILE_MUSIC_STANDARD_STEREO" />(3)</codeph>:指定 48 kHz 采样率,音乐编码,双声道,编码码率最大值为 80 Kbps。</li>
<li><codeph><ph keyref="AUDIO_PROFILE_MUSIC_HIGH_QUALITY" />(4)</codeph>:指定 48 kHz 采样率,音乐编码,单声道,编码码率最大值为 96 Kbps。</li>
<li><codeph><ph keyref="AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO" />(5)</codeph>:指定 48 kHz 采样率,音乐编码,双声道,编码码率最大值为 128 Kbps。</li>
<li><codeph><ph keyref="AUDIO_PROFILE_SPEECH_STANDARD" /></codeph>(1):指定 32 kHz 采样率,语音编码,单声道,编码码率最大值为 18 Kbps。</li>
<li><codeph><ph keyref="AUDIO_PROFILE_MUSIC_STANDARD" /></codeph>(2):指定 48 kHz 采样率,音乐编码,单声道,编码码率最大值为 64 Kbps。</li>
<li><codeph><ph keyref="AUDIO_PROFILE_MUSIC_STANDARD_STEREO" /></codeph>(3):指定 48 kHz 采样率,音乐编码,双声道,编码码率最大值为 80 Kbps。</li>
<li><codeph><ph keyref="AUDIO_PROFILE_MUSIC_HIGH_QUALITY" /></codeph>(4):指定 48 kHz 采样率,音乐编码,单声道,编码码率最大值为 96 Kbps。</li>
<li><codeph><ph keyref="AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO" /></codeph>(5):指定 48 kHz 采样率,音乐编码,双声道,编码码率最大值为 128 Kbps。</li>
</ul></p>
</pd>
</plentry>
Expand Down
2 changes: 1 addition & 1 deletion dita/RTC-NG/API/api_irtcengine_setaudioprofile2.dita
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
</section>
<section id="scenario" deliveryTarget="details">
<title>适用场景</title>
<p>该方法适用于各种音频场景,你可以按需选择。例如,在音乐教学等高音质需求的场景中,建议将 <codeph>profile</codeph> 设置为 <codeph><ph keyref="AUDIO_PROFILE_MUSIC_HIGH_QUALITY" />(4)</codeph>。</p>
<p>该方法适用于各种音频场景,你可以按需选择。例如,在音乐教学等高音质需求的场景中,建议将 <codeph>profile</codeph> 设置为 <codeph><ph keyref="AUDIO_PROFILE_MUSIC_HIGH_QUALITY" /></codeph>(4)。</p>
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
Expand Down
12 changes: 6 additions & 6 deletions dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
</section>
<section id="scenario" deliveryTarget="details">
<title>适用场景</title>
<p>该方法适用于各种音频场景,你可以按需选择。例如,在音乐教学等高音质需求的场景中,建议将 <parmname>scenario</parmname> 设置为 <codeph><ph keyref="AUDIO_SCENARIO_GAME_STREAMING" />(3)</codeph>。</p>
<p>该方法适用于各种音频场景,你可以按需选择。例如,在音乐教学等高音质需求的场景中,建议将 <parmname>scenario</parmname> 设置为 <codeph><ph keyref="AUDIO_SCENARIO_GAME_STREAMING" /></codeph>(3)。</p>
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
Expand All @@ -44,12 +44,12 @@
<pd id="scenario-ng"><ph>音频场景。不同的音频场景下,设备的音量类型是不同的。</ph>
<ph props="ios mac cpp framework">详见 <xref keyref="AUDIO_SCENARIO_TYPE" /> 。</ph>
<ul props="android">
<li><codeph><ph keyref="AUDIO_SCENARIO_DEFAULT" />(0)</codeph>:(默认)自动场景,根据用户角色和音频路由自动匹配合适的音质。</li>
<li><codeph><ph keyref="AUDIO_SCENARIO_GAME_STREAMING" />(3)</codeph>: 高音质场景,适用于音乐为主的场景。</li>
<li><codeph><ph keyref="AUDIO_SCENARIO_CHATROOM" />(5)</codeph>: 聊天室场景,适用于用户需要频繁上下麦的场景。该场景下,观众会收到申请麦克风权限的弹窗提示。</li>
<li><codeph><ph keyref="AUDIO_SCENARIO_CHORUS" />(7)</codeph>: 合唱场景。适用于网络条件良好,要求极低延时的实时合唱场景。
<li><codeph><ph keyref="AUDIO_SCENARIO_DEFAULT" /></codeph>(0):(默认)自动场景,根据用户角色和音频路由自动匹配合适的音质。</li>
<li><codeph><ph keyref="AUDIO_SCENARIO_GAME_STREAMING" /></codeph>(3): 高音质场景,适用于音乐为主的场景。</li>
<li><codeph><ph keyref="AUDIO_SCENARIO_CHATROOM" /></codeph>(5): 聊天室场景,适用于用户需要频繁上下麦的场景。该场景下,观众会收到申请麦克风权限的弹窗提示。</li>
<li><codeph><ph keyref="AUDIO_SCENARIO_CHORUS" /></codeph>(7): 合唱场景。适用于网络条件良好,要求极低延时的实时合唱场景。
<note conkeyref="AUDIO_SCENARIO_TYPE/chorus" /></li>
<li><codeph><ph keyref="AUDIO_SCENARIO_MEETING" />(8)</codeph>: 会议场景,适用于人声为主的多人会议。</li>
<li><codeph><ph keyref="AUDIO_SCENARIO_MEETING" /></codeph>(8): 会议场景,适用于人声为主的多人会议。</li>
</ul>
</pd>
</plentry></parml></section>
Expand Down

0 comments on commit 6f86a97

Please sign in to comment.