Skip to content

Commit

Permalink
add note for electron; review edits
Browse files Browse the repository at this point in the history
  • Loading branch information
Nero-Hu committed Nov 30, 2023
1 parent c480f3d commit a279589
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 1 deletion.
1 change: 1 addition & 0 deletions dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
<li props="unity cs">如果你想要在原生窗口上渲染图像,请调用此方法;如果你仅需在 Unity 项目内渲染图像,可直接通过 <xref keyref="AgoraVideoSurface"/> 类来实现。</li>
<li>该方法在加入频道前后都能调用。</li>
<li props="native unreal bp unity rn flutter cs">如果你希望在通话中更新本地用户视图的渲染或镜像模式,请使用 <xref keyref="setLocalRenderMode2" /> 方法。</li>
<li props="electron">如果想要停止渲染视图,需要将 <parmname>view</parmname> 设为 <ph keyref="NULL" /> 后调用该方法,以停止渲染并清理渲染缓存。</li>
</ul> </note> </section>
<section id="parameters">
<title>参数</title>
Expand Down
1 change: 1 addition & 0 deletions dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
<li props="unity cs">如果你想要在原生窗口上渲染图像,请调用此方法;如果你仅需在 Unity 项目内渲染图像,可直接通过 <xref keyref="AgoraVideoSurface"/> 类来实现。</li>
<li props="native unreal bp unity rn flutter cs">如果你希望在通话中更新远端用户视图的渲染或镜像模式,请使用 <xref keyref="setRemoteRenderMode2"/> 方法。</li>
<li>如果你使用了录制服务,录制服务会作为一个哑客户端加入频道,因此也会触发 <xref keyref="onUserJoined"/> 回调。由于录制服务不会发送视频流,App 无需为它绑定视图。如果 App 无法识别哑客户端,可以在收到 <xref keyref="onFirstRemoteVideoDecoded"/> 回调时再绑定远端用户视图。</li>
<li props="electron">如果想要停止渲染视图,需要将 <parmname>view</parmname> 设为 <ph keyref="NULL" /> 后调用该方法,以停止渲染并清理渲染缓存。</li>
</ul> </note> </section>
<section id="parameters">
<title>参数</title>
Expand Down
2 changes: 1 addition & 1 deletion dita/RTC-NG/API/api_irtcengine_startlastmileprobetest.dita
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
<li><xref keyref="onLastmileProbeResult" />,视网络情况约 30 秒内返回。该回调通过具体数据反馈上下行网络质量,更加客观。</li>
</ul>
</p>
<p>该方法主要用于用户加入频道前,可以调用该方法判断和预测目前的上行网络质量是否足够好。</p>
<p>该方法需要在加入频道前调用,用于判断和预测目前的上行网络质量是否足够好。</p>
<note type="attention">
<ul>
<li>调用该方法后,在收到 <apiname keyref="onLastmileQuality" /> 和 <apiname keyref="onLastmileProbeResult" /> 回调之前请不要调用其他方法,否则可能会由于 API 操作过于频繁导致此方法无法执行。</li>
Expand Down

0 comments on commit a279589

Please sign in to comment.