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.

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

1109 bugfix #3413

Merged
merged 20 commits into from
Nov 8, 2023
Merged
Show file tree
Hide file tree
Changes from 18 commits
Commits
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
6 changes: 3 additions & 3 deletions dita/RTC-NG/API/api_createagorartcengine.dita
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@
</section>
<section id="detailed_desc">
<title>详情</title>
<p props="electron">目前 RTC SDK v4.x 只支持每个 app 创建一个 <apiname keyref="IRtcEngineEx"/> 对象。</p>
<p props="cpp unreal bp rn unity cs">目前 RTC SDK v4.x 只支持每个 app 创建一个 <apiname keyref="IRtcEngine"/> 对象。</p>
<p props="flutter">目前 RTC SDK v6.x 只支持每个 app 创建一个 <apiname keyref="IRtcEngine"/> 对象。</p>
<p props="electron">目前 RTC SDK v4.x 只支持每个 App 创建一个 <apiname keyref="IRtcEngineEx"/> 对象。</p>
<p props="cpp unreal bp rn unity cs">目前 RTC SDK v4.x 只支持每个 App 创建一个 <apiname keyref="IRtcEngine"/> 对象。</p>
<p props="flutter">目前 RTC SDK v6.x 只支持每个 App 创建一个 <apiname keyref="IRtcEngine"/> 对象。</p>
</section>
<section id="return_values">
<title>返回值</title>
Expand Down
4 changes: 2 additions & 2 deletions dita/RTC-NG/API/api_createagorartcengineex.dita
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@
</section>
<section id="detailed_desc">
<title>详情</title>
<p props="unity cs">目前 RTC v4.x SDK 只支持每个 app 创建一个 <apiname keyref="IRtcEngineEx"/> 对象。</p>
<p props="flutter">目前 RTC v6.x SDK 只支持每个 app 创建一个 <apiname keyref="IRtcEngineEx"/> 对象。</p>
<p props="unity cs">目前 RTC v4.x SDK 只支持每个 App 创建一个 <apiname keyref="IRtcEngineEx"/> 对象。</p>
<p props="flutter">目前 RTC v6.x SDK 只支持每个 App 创建一个 <apiname keyref="IRtcEngineEx"/> 对象。</p>
</section>
<section id="return_values">
<title>返回值</title>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_iaudiodevicecollection_getapplicationvolume">
<title><ph keyref="getApplicationVolume"/></title>
<shortdesc id="short"><ph id="shortdesc">获取 app 的当前音量。</ph></shortdesc>
<shortdesc id="short"><ph id="shortdesc">获取 App 的当前音量。</ph></shortdesc>
<prolog>
<metadata>
<keywords>
Expand All @@ -29,7 +29,7 @@
<parml>
<plentry>
<pt>volume</pt>
<pd>app 当前的音量,取值范围为 [0,255]。</pd>
<pd>App 当前的音量,取值范围为 [0,255]。</pd>
</plentry>
</parml> </section>
<section id="return_values">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_iaudiodevicecollection_isapplicationmute">
<title><ph keyref="isApplicationMute"/></title>
<shortdesc id="short"><ph id="shortdesc">获取 app 当前的静音状态。</ph></shortdesc>
<shortdesc id="short"><ph id="shortdesc">获取 App 当前的静音状态。</ph></shortdesc>
<prolog>
<metadata>
<keywords>
Expand Down Expand Up @@ -30,10 +30,10 @@
<plentry>
<pt>mute</pt>
<pd>
<p>app 当前是否静音:
<p>App 当前是否静音:
<ul>
<li><codeph><ph keyref="true"/></codeph>: app 为静音状态。</li>
<li><codeph><ph keyref="false"/></codeph>: app 为非静音状态。</li>
<li><codeph><ph keyref="true"/></codeph>: App 为静音状态。</li>
<li><codeph><ph keyref="false"/></codeph>: App 为非静音状态。</li>
</ul></p>
</pd>
</plentry>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_iaudiodevicecollection_setapplicationmute">
<title><ph keyref="setApplicationMute"/></title>
<shortdesc id="short"><ph id="shortdesc">设置是否将 app 静音。</ph></shortdesc>
<shortdesc id="short"><ph id="shortdesc">设置是否将 App 静音。</ph></shortdesc>
<prolog>
<metadata>
<keywords>
Expand All @@ -29,10 +29,10 @@
<parml>
<plentry>
<pt>mute</pt>
<pd>是否将 app 设置为静音。
<pd>是否将 App 设置为静音。
<ul>
<li><codeph><ph keyref="true"/></codeph>: 将 app 静音。</li>
<li><codeph><ph keyref="false"/></codeph>: 将 app 解除静音。</li>
<li><codeph><ph keyref="true"/></codeph>: 将 App 静音。</li>
<li><codeph><ph keyref="false"/></codeph>: 将 App 解除静音。</li>
</ul></pd>
</plentry>
</parml> </section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_iaudiodevicecollection_setapplicationvolume">
<title><ph keyref="setApplicationVolume"/></title>
<shortdesc id="short"><ph id="shortdesc">设置 app 音量。</ph></shortdesc>
<shortdesc id="short"><ph id="shortdesc">设置 App 音量。</ph></shortdesc>
<prolog>
<metadata>
<keywords>
Expand All @@ -29,7 +29,7 @@
<parml>
<plentry>
<pt>volume</pt>
<pd>app 的音量,取值范围为 [0,255]。</pd>
<pd>App 的音量,取值范围为 [0,255]。</pd>
</plentry>
</parml> </section>
<section id="return_values">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,13 @@
<note type="note">
<p props="cpp unreal bp electron unity flutter">该方法仅适用于 Windows 和 macOS。</p>
<p>该方法适用的场景如下: </p>
<p>使用 app A 播放音乐,通过蓝牙耳机播放;同时使用 app B 进行视频会议,通过扬声器播放。
<p>使用 App A 播放音乐,通过蓝牙耳机播放;同时使用 App B 进行视频会议,通过扬声器播放。


<ul>
<li>如果设置声卡采集设备为蓝牙耳机,则 SDK 会将 app A 中的音乐发布到远端。</li>
<li>如果设置声卡采集设备设置为扬声器,则 SDK 不会将 app A 中的音乐发布到远端。</li>
<li>如果设置声卡采集设备为蓝牙耳机后,又改用有线耳机播放 app A 中的音乐,则需要重新调用该方法,设置声卡采集设备为有线耳机,则 SDK 会继续将 app A 中的音乐发布到远端。</li>
<li>如果设置声卡采集设备为蓝牙耳机,则 SDK 会将 App A 中的音乐发布到远端。</li>
<li>如果设置声卡采集设备设置为扬声器,则 SDK 不会将 App A 中的音乐发布到远端。</li>
<li>如果设置声卡采集设备为蓝牙耳机后,又改用有线耳机播放 App A 中的音乐,则需要重新调用该方法,设置声卡采集设备为有线耳机,则 SDK 会继续将 App A 中的音乐发布到远端。</li>
</ul></p>
</note> </section>
<section id="parameters">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
<li props="cpp unreal bp">你需要在 <xref keyref="queryInterface"/><codeph>(<ph keyref="AGORA_IID_LOCAL_SPATIAL_AUDIO"/>)</codeph> 后调用该方法。 </li>
<li props="android">你需要在 <xref keyref="create_ILocalSpatialAudioEngine"/> 后调用该方法。</li>
<li>在调用 <apiname keyref="ILocalSpatialAudioEngine"/> 类的其他方法前,你需要先调用该方法初始化 <apiname keyref="ILocalSpatialAudioEngine"/>。</li>
<li>SDK 只支持每个 app 创建一个 <apiname keyref="ILocalSpatialAudioEngine"/> 实例。</li>
<li>SDK 只支持每个 App 创建一个 <apiname keyref="ILocalSpatialAudioEngine"/> 实例。</li>
</ul> </note> </section>
<section id="parameters" props="native unreal bp">
<title>参数</title>
Expand Down
10 changes: 5 additions & 5 deletions dita/RTC-NG/API/api_imediaengine_pullaudioframe.dita
Original file line number Diff line number Diff line change
Expand Up @@ -25,19 +25,19 @@
</section>
<section id="detailed_desc">
<title>详情</title>
<p>使用该方法前,你需要调用 <xref keyref="setExternalAudioSink"/> 通知 app 开启并设置外部渲染。</p>
<p>调用该方法后,app 会采取主动拉取的方式获取远端已解码和混音后的音频数据,用于音频播放。</p>
<p>使用该方法前,你需要调用 <xref keyref="setExternalAudioSink"/> 通知 App 开启并设置外部渲染。</p>
<p>调用该方法后,App 会采取主动拉取的方式获取远端已解码和混音后的音频数据,用于音频播放。</p>
<note type="attention">
<ul>
<li>该方法仅支持拉取自采集的数据。如果你需要拉取 SDK 采集的数据,请不要调用该方法。</li>
<li>该方法需要在加入频道后调用。</li>
<li>开启外部音频渲染后,app 将无法从 <xref keyref="onPlaybackAudioFrame"/> 回调中获得数据。</li>
<li>开启外部音频渲染后,App 将无法从 <xref keyref="onPlaybackAudioFrame"/> 回调中获得数据。</li>
<li>该方法和 <apiname keyref="onPlaybackAudioFrame"/> 回调相比,区别在于:


<ul>
<li>SDK 通过 <apiname keyref="onPlaybackAudioFrame"/> 回调将音频数据传输给 app。如果 app 处理延时,可能会导致音频播放抖动。</li>
<li>调用该方法后 app 会主动拉取音频数据。通过设置音频数据,SDK 可以调整缓存,帮助 app 处理延时,从而有效避免音频播放抖动。</li>
<li>SDK 通过 <apiname keyref="onPlaybackAudioFrame"/> 回调将音频数据传输给 App。如果 App 处理延时,可能会导致音频播放抖动。</li>
<li>调用该方法后 App 会主动拉取音频数据。通过设置音频数据,SDK 可以调整缓存,帮助 App 处理延时,从而有效避免音频播放抖动。</li>
</ul></li>
</ul> </note> </section>
<section id="parameters" props="native unreal bp unity flutter cs">
Expand Down
2 changes: 1 addition & 1 deletion dita/RTC-NG/API/api_imediaengine_setexternalaudiosink.dita
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
<ul>
<li>使用该方法前,你需要在 <xref keyref="RtcEngineConfig" /> 中设置 <parmname>enableAudioDevice</parmname> 为 <codeph><ph keyref="false" /></codeph>。</li>
<li>该方法需要在加入频道前调用。</li>
<li>开启外部音频渲染后,app 会无法从 <xref keyref="onPlaybackAudioFrame" /> 回调中获得数据。</li>
<li>开启外部音频渲染后,App 会无法从 <xref keyref="onPlaybackAudioFrame" /> 回调中获得数据。</li>
</ul> </note> </section>
<section id="parameters">
<title>参数</title>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
</section>
<section id="detailed_desc">
<title>详情</title>
<p id="desc">如果不分发回调方法到主队列,app 应将 UI 操作分发到主队列。</p>
<p id="desc">如果不分发回调方法到主队列,App 应将 UI 操作分发到主队列。</p>
</section>
<section id="parameters">
<title>参数</title>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
</section>
<section id="detailed_desc">
<title>详情</title>
<p>该方法用于设置音视频录制的回调,以便在录制过程中向 app 通知音视频流的录制状态和信息。</p>
<p>该方法用于设置音视频录制的回调,以便在录制过程中向 App 通知音视频流的录制状态和信息。</p>
<p>调用该方法前请确保:
<ul>
<li>已创建并初始化 <xref keyref="IRtcEngine"/> 对象。</li>
Expand Down
4 changes: 2 additions & 2 deletions dita/RTC-NG/API/api_irtcengine_addhandler.dita
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@
</section>
<section id="detailed_desc">
<title>详情</title>
<p><xref keyref="IRtcEngineEventHandler"/> 接口类用于 SDK 向 app 发送回调事件通知,app 通过继承该接口类的方法获取 SDK 的事件通知。
接口类的所有方法都有缺省(空)实现,app 可以根据需要只继承关心的事件。在回调方法中,app 不应该做耗时或者调用可能会引起阻塞的 API(如 <ph keyref="sendStreamMessage"/>),
<p><xref keyref="IRtcEngineEventHandler"/> 接口类用于 SDK 向 App 发送回调事件通知,App 通过继承该接口类的方法获取 SDK 的事件通知。
接口类的所有方法都有缺省(空)实现,App 可以根据需要只继承关心的事件。在回调方法中,App 不应该做耗时或者调用可能会引起阻塞的 API(如 <ph keyref="sendStreamMessage"/>),
否则可能影响 SDK 的运行。</p>
</section>
<section id="parameters">
Expand Down
4 changes: 2 additions & 2 deletions dita/RTC-NG/API/api_irtcengine_create.dita
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
<ul id="ul_uy4_mtq_4qb">
<li>请确保在调用其他 API 前先调用该方法创建并初始化 <apiname keyref="IRtcEngine"/>。</li>
<li>调用该方法和 <xref keyref="initialize"/> 均能创建 <apiname keyref="IRtcEngine"/> 实例。该方法与 <apiname keyref="initialize"/> 的区别在于,<apiname keyref="initialize"/> 支持在创建 <apiname keyref="IRtcEngine"/> 实例时进行更多配置,如指定访问区域、设置日志文件等。</li>
<li>SDK 只支持每个 app 创建一个 <apiname keyref="IRtcEngine"/> 实例。</li>
<li>SDK 只支持每个 App 创建一个 <apiname keyref="IRtcEngine"/> 实例。</li>
</ul> </note> </section>
<section id="parameters">
<title>参数</title>
Expand Down Expand Up @@ -62,7 +62,7 @@
<li>-1: 一般性的错误(未明确归类)。</li>
<li>-2: 设置了无效的参数。</li>
<li>-7: SDK 初始化失败。</li>
<li>-22: 资源申请失败。当 app 占用资源过多,或系统资源耗尽时,SDK 分配资源失败,会返回该错误。</li>
<li>-22: 资源申请失败。当 App 占用资源过多,或系统资源耗尽时,SDK 分配资源失败,会返回该错误。</li>
<li>-101: App ID 无效。</li>
</ul></li>
</ul> </section>
Expand Down
2 changes: 1 addition & 1 deletion dita/RTC-NG/API/api_irtcengine_createrendererview.dita
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
<dd>此方法已废弃。请使用 Android 原生的 <xref keyref="SurfaceView-link"/>。</dd>
</dlentry>
</dl>
<p>该方法创建视频 RendererView,返回 SurfaceView 的类型。 View 的操作和布局由 app 管理,SDK 在 app 提供的 View 上进行渲染。 显示视频视图必须调用该方法,而不是直接调用 SurfaceView。</p>
<p>该方法创建视频 RendererView,返回 SurfaceView 的类型。 View 的操作和布局由 App 管理,SDK 在 App 提供的 View 上进行渲染。 显示视频视图必须调用该方法,而不是直接调用 SurfaceView。</p>
<p>如果你需要使用 SurfaceView,请调用本方法;如果你需要使用 TextureView,请调用 <xref keyref="CreateTextureView"/> 方法。

<note type="attention">请在主线程调用该方法。</note></p>
Expand Down
2 changes: 1 addition & 1 deletion dita/RTC-NG/API/api_irtcengine_createtextureview.dita
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
<dd>此方法已废弃。请使用 Android 原生的 <xref keyref="TextureView-link"/>。</dd>
</dlentry>
</dl>
<p>该方法创建 TextureView,适用于需要对视频画面进行缩放、旋转和平移的场景,如屏幕共享。View 的操作和布局由 app 管理,SDK 仅在 app 提供的 View 上进行渲染。</p>
<p>该方法创建 TextureView,适用于需要对视频画面进行缩放、旋转和平移的场景,如屏幕共享。View 的操作和布局由 App 管理,SDK 仅在 App 提供的 View 上进行渲染。</p>
<p>如果你需要使用 TextureView,请调用本方法;如果你需要使用 SurfaceView,请调用 <xref keyref="CreateRendererView"/> 方法。

<note type="attention">请在主线程调用该方法。</note></p>
Expand Down
2 changes: 1 addition & 1 deletion dita/RTC-NG/API/api_irtcengine_delegate.dita
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
</section>
<section id="detailed_desc">
<title>详情</title>
<p>SDK 通过 <xref keyref="IRtcEngineEventHandler"/> 类向 app 报告 SDK 运行时的各种事件。该类中定义的所有方法都是可选的实现方法。</p>
<p>SDK 通过 <xref keyref="IRtcEngineEventHandler"/> 类向 App 报告 SDK 运行时的各种事件。该类中定义的所有方法都是可选的实现方法。</p>
</section>
</refbody>
</reference>
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
</section>
<section id="detailed_desc">
<title>详情</title>
<p>该方法允许 SDK 定期向 app 报告本地发流用户和瞬时音量最高的远端用户(最多 3 位)的音量相关信息。启用该方法后,只要频道内有发流用户,SDK 会在加入频道后按设置的时间间隔触发 <xref keyref="onAudioVolumeIndication" /> 回调。</p>
<p>该方法允许 SDK 定期向 App 报告本地发流用户和瞬时音量最高的远端用户(最多 3 位)的音量相关信息。启用该方法后,只要频道内有发流用户,SDK 会在加入频道后按设置的时间间隔触发 <xref keyref="onAudioVolumeIndication" /> 回调。</p>
<note type="attention">该方法在加入频道前后都能调用。</note> </section>
<section id="parameters">
<title>参数</title>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
<note type="note">
<ul id="ul_w5c_nzq_tsb">
<li>Wi-Fi 加速功能默认关闭。必须与集成加速插件的路由器配合使用才能生效,详见<xref keyref="faq-wifi-routers">哪些 Wi-Fi 路由器可支持加速功能</xref>。如果 Wi-Fi 路由器不支持加速功能,系统性能不会受损。</li>
<li>加速功能生效后,路由器的 app 会显示加速效果和被加速 app 的名称。如果你不想在路由器的 app 中展示被加速 app 的名称,请调用 <codeph>enableWirelessAccelerate(false)</codeph> 关闭加速功能。</li>
<li>加速功能生效后,路由器的 App 会显示加速效果和被加速 App 的名称。如果你不想在路由器的 App 中展示被加速 App 的名称,请调用 <codeph>enableWirelessAccelerate(false)</codeph> 关闭加速功能。</li>
<li>声网提供的 Wi-Fi 加速功能除应用于音视频流,还可以应用于其他第三方业务流,如私有信令、课件、RTMP 协议等。如有需要,请联系 [email protected]。</li>
</ul> </note> </section>
<section id="parameters">
Expand Down
Loading
Loading