Release/rtc ng/4.5.2

dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita

@@ -48,6 +48,7 @@
             <p>请在 <xref keyref="enableVideo"/> 或 <xref keyref="startPreview2"/> 之后调用该方法。</p>
             <note type="attention" id="hardware_req">
             <ul>
+            <li>使用视频作为虚拟背景会导致内存占用持续增加，可能会导致 App 出现闪退等问题，因此在使用时请尽量降低视频的分辨率和帧率。</li>
             <li>该功能对设备性能要求较高，调用该方法时 SDK 会自动对当前设备能力进行检查。建议你在搭载如下芯片的设备上使用：
                 <ul>
                 <li props="android unity cpp unreal bp rn flutter cs">骁龙 700 系列 750G 及以上</li>

dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita

@@ -75,13 +75,11 @@
                 <pd>
                     <p props="ios mac cpp unreal bp unity flutter rn electron cs">远端用户视图的镜像模式，详见 <xref keyref="VIDEO_MIRROR_MODE_TYPE" />。</p>
                     <p props="android hmos">远端用户视图的镜像模式。
-
-
-
-
-                    <ul conkeyref="setLocalRenderMode2/videomirrormodetype">
-                    <li />
-                    </ul> </p>
+<ul>
+                    <li><ph keyref="VIDEO_MIRROR_MODE_AUTO" /> (0)：SDK 决定镜像模式。默认关闭远端用户的镜像模式。</li>
+                    <li><ph keyref="VIDEO_MIRROR_MODE_ENABLED" /> (1)：开启远端用户视图的镜像模式。</li>
+                    <li><ph keyref="VIDEO_MIRROR_MODE_DISABLED" /> (2)：关闭远端用户视图的镜像模式。</li>
+                    </ul></p>
                     <note conkeyref="setLocalRenderMode2/mirror" props="unreal bp"/>
                 </pd>
             </plentry>

dita/RTC-NG/API/api_irtcengine_setvideoscenario.dita

@@ -77,7 +77,8 @@
                         </li>
                     </ul>
                 </p>
-                <p id="1v1"><apiname keyref="APPLICATION_SCENARIO_1V1"/> (2) 适用于<xref keyref="one-to-one-live"/>场景。针对该场景低延迟、高画质的体验要求，SDK 进行了策略调优，提升了画质、首帧出图、中低端机延迟及弱网流畅度等性能表现。</p>
+                <p id="1v1"><apiname keyref="APPLICATION_SCENARIO_1V1"/> (2) 适用于<xref keyref="one-to-one-live"/>场景。针对该场景低延迟、高画质的体验要求，SDK 进行了策略调优，提升了画质、首帧出图、中低端机延迟及弱网流畅度等性能表现。
+                <note type="attention">该枚举值仅适用于主播 vs 主播场景。</note></p>
                 <p id="liveshow"><apiname keyref="APPLICATION_SCENARIO_LIVESHOW"/> (3) 适用于<xref keyref="showroom"/>场景。针对该场景对首帧出图时间和画质清晰度的高要求，SDK 进行了策略调优，例如，默认开启音视频帧加速渲染来提升首帧出图体验，无需再额外调用 <xref keyref="enableInstantMediaRendering"/>，同时会默认开启 B 帧来确保较高的图像质量、提高传输效率。此外，也增强了在弱网环境和低端设备上的画质和流畅度表现。</p>
                 </pd>
             </plentry>

dita/RTC-NG/API/api_player_getposition.dita

@@ -0,0 +1,79 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
+<reference id="api_player_getposition">
+    <title><ph keyref="GetPosition"/></title>
+    <shortdesc id="short"><ph id="shortdesc">获取当前的播放位置。</ph></shortdesc>
+    <prolog>
+        <metadata>
+            <keywords>
+                <indexterm keyref="GetPosition"/>
+            </keywords>
+        </metadata>
+    </prolog>
+    <refbody>
+        <section id="prototype">
+            <p outputclass="codeblock">
+            <codeblock props="android" outputclass="language-java">public long getPosition() throws RteException</codeblock>
+            <codeblock props="hmos" outputclass="language-arkts"/>
+            <codeblock props="ios mac" outputclass="language-objectivec">- (uint64_t)getPosition:(AgoraRteError * _Nullable)error;</codeblock>
+            <codeblock props="cpp unreal" outputclass="language-cpp">uint64_t GetPosition(Error *err = nullptr)</codeblock>
+            <codeblock props="bp" outputclass="language-cpp"/>
+            <codeblock props="electron" outputclass="language-typescript"/>
+            <codeblock props="unity cs" outputclass="language-csharp"/>
+            <codeblock props="rn" outputclass="language-typescript"/>
+            <codeblock props="flutter" outputclass="language-dart"/> </p>
+        </section>
+        <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
+            <dl outputclass="since">
+            <dlentry props="native">
+                <dt>自从：</dt>
+                <dd props="native">自 v4.5.1 版本新增。</dd>
+                </dlentry>
+            </dl>
+            <p>该方法用于获取当前播放的时间位置，单位为毫秒。</p>
+            </section>
+        <section id="restriction" deliveryTarget="details">
+            <title>调用限制</title>
+            <p>无。</p>
+        </section>
+        <section id="parameters" deliveryTarget="details" props="apple cpp">
+            <title>参数</title>
+            <parml>
+            <plentry props="apple cpp">
+                <pt props="apple">error</pt>
+                <pt props="cpp">err</pt>
+                <pd props="apple">输出参数，表示错误信息。可能返回以下值：
+                    <ul>
+                        <li><ph keyref="kRteOk"/>：调用成功。</li>
+                        <li><ph keyref="kRteErrorInvalidOperation"/>：<ul>
+                            <li>对应的内部 <codeph>AgoraRtePlayer</codeph> 对象已被销毁或无效。</li>
+                            <li>打开的是 RTE URL，不支持调用 <xref keyref="GetPosition"/>。详见 <xref keyref="Error"/>。</li>
+                            </ul>
+                        </li>
+                        </ul>
+                    </pd>
+                <pd props="cpp">状态或错误信息，详见 <xref keyref="Error"/>。
+可能的错误码包括：
+                    <ul>
+                        <li><ph keyref="kRteOk"/>：调用成功。</li>
+                        <li><ph keyref="kRteErrorInvalidOperation"/>：<ul>
+                            <li>对应的内部 <xref keyref="Player_Player"/> 对象已被销毁或无效。</li>
+                            <li>打开的是 RTE URL，不支持调用 <xref keyref="GetPosition"/>。</li>
+                            </ul>
+                        </li>
+                        </ul>
+                    </pd>
+                </plentry>
+            </parml> </section>
+        <section id="return_values" props="bp cs electron flutter native rn unity unreal">
+            <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="bp cs electron rn unity unreal">
+                <li>0: 方法调用成功。</li>
+                <li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
+                </ul>
+        <p props="apple cpp">方法调用成功，返回当前的播放位置，单位为毫秒。</p>
+        <p props="android">方法调用成功，返回当前播放位置，单位为毫秒。</p>
+    </section>
+        </refbody>
+</reference>

dita/RTC-NG/API/api_player_muteaudio.dita

@@ -2,7 +2,7 @@
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
 <reference id="api_player_muteaudio">
     <title><ph keyref="MuteAudio"/></title>
-    <shortdesc id="short"><ph id="shortdesc">订阅或取消订阅主播的音频流。</ph></shortdesc>
+    <shortdesc id="short"><ph id="shortdesc">接收或停止接收音频流。</ph></shortdesc>
     <prolog>
         <metadata>
             <keywords>
@@ -30,7 +30,6 @@
                 <dd>v4.5.0</dd>
             </dlentry>
             </dl>
-            <p>观众端可以调用该方法来设置是否订阅主播的音频流。</p>
         </section>
         <section id="timing" deliveryTarget="details">
             <title>调用时机</title>
@@ -49,9 +48,9 @@
             <parml>
             <plentry>
                 <pt>mute</pt>
-                <pd>是否订阅主播的音频流：
-                <ul><li><codeph><ph keyref="true"/></codeph>：不订阅主播的音频流。</li>
-                <li><codeph><ph keyref="false"/></codeph>：订阅主播的音频流。</li></ul></pd>
+                <pd>是否接收音频流：
+                <ul><li><codeph><ph keyref="true"/></codeph>：不接收音频流。</li>
+                <li><codeph><ph keyref="false"/></codeph>：接收音频流。</li></ul></pd>
             </plentry>
             <plentry props="cpp apple" conkeyref="SetConfigs_Rte/err">
                 <pt></pt>

dita/RTC-NG/API/api_player_mutevideo.dita

@@ -2,7 +2,7 @@
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
 <reference id="api_player_mutevideo">
     <title><ph keyref="MuteVideo"/></title>
-    <shortdesc id="short"><ph id="shortdesc">订阅或取消订阅主播的视频流。</ph></shortdesc>
+    <shortdesc id="short"><ph id="shortdesc">接收或停止接收视频流。</ph></shortdesc>
     <prolog>
         <metadata>
             <keywords>
@@ -30,7 +30,6 @@
                 <dd>v4.5.0</dd>
             </dlentry>
             </dl>
-            <p>观众端可以调用该方法来设置是否订阅主播的视频流。</p>
         </section>
         <section id="timing" deliveryTarget="details" conkeyref="MuteAudio/timing">
             <title>调用时机</title>
@@ -49,9 +48,9 @@
             <parml>
             <plentry>
                 <pt>mute</pt>
-                <pd>是否订阅主播的视频流：
-                <ul><li><codeph><ph keyref="true"/></codeph>：不订阅主播的视频流。</li>
-                <li><codeph><ph keyref="false"/></codeph>：订阅主播的视频流。</li></ul></pd>
+                <pd>是否接收视频流：
+                <ul><li><codeph><ph keyref="true"/></codeph>：不接收视频流。</li>
+                <li><codeph><ph keyref="false"/></codeph>：接收视频流。</li></ul></pd>
             </plentry>
             <plentry props="apple cpp" conkeyref="SetConfigs_Rte/err">
                 <pt></pt>

dita/RTC-NG/API/api_player_openwithurl.dita

@@ -39,7 +39,7 @@
         </section>
         <section id="restriction" deliveryTarget="details">
             <title>调用限制</title>
-            <p>该方法目前仅支持打开以 <codeph>rte://</codeph> 开头的 URL。</p>
+            <p>该方法目前仅支持打开以 <codeph>rte://</codeph> 开头的 URL、CDN URL 和本地媒体文件。//TODO</p>
         </section>
         <section id="related" deliveryTarget="details">
                 <title>相关回调</title>
@@ -55,7 +55,7 @@
              <plentry>
                  <pt props="cpp">start_time</pt>
                  <pt props="android apple">startTime</pt>
-                 <pd>预留参数。</pd>
+                 <pd>起始播放位置，单位为毫秒。</pd>
              </plentry>
              <plentry props="cpp apple">
                  <pt>cb</pt>

dita/RTC-NG/API/api_player_seek.dita

@@ -0,0 +1,84 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
+<reference id="api_player_seek">
+    <title><ph keyref="Seek"/></title>
+    <shortdesc id="short"><ph id="shortdesc">跳转播放位置。</ph></shortdesc>
+    <prolog>
+        <metadata>
+            <keywords>
+                <indexterm keyref="Seek"/>
+            </keywords>
+        </metadata>
+    </prolog>
+    <refbody>
+        <section id="prototype">
+            <p outputclass="codeblock">
+            <codeblock props="android" outputclass="language-java">public void seek(long newTime) throws RteException</codeblock>
+            <codeblock props="hmos" outputclass="language-arkts"/>
+            <codeblock props="ios mac" outputclass="language-objectivec">- (BOOL)seek:(uint64_t)newTime error:(AgoraRteError * _Nullable)error;</codeblock>
+            <codeblock props="cpp unreal" outputclass="language-cpp">bool Seek(uint64_t new_time, Error *err = nullptr)</codeblock>
+            <codeblock props="bp" outputclass="language-cpp"/>
+            <codeblock props="electron" outputclass="language-typescript"/>
+            <codeblock props="unity cs" outputclass="language-csharp"/>
+            <codeblock props="rn" outputclass="language-typescript"/>
+            <codeblock props="flutter" outputclass="language-dart"/> </p>
+        </section>
+        <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
+            <dl outputclass="since">
+            <dlentry props="native">
+                <dt>自从：</dt>
+                <dd props="native">自 v4.5.1 版本新增。</dd>
+                </dlentry>
+            </dl>
+            <p></p>
+            </section>
+        <section id="restriction" deliveryTarget="details">
+            <title>调用限制</title>
+            <p>无。</p>
+        </section>
+        <section id="parameters" deliveryTarget="details" props="native">
+            <title>参数</title>
+            <parml>
+            <plentry props="native">
+                <pt props="cpp">new_time</pt>
+                <pt props="android apple">newTime</pt>
+                <pd props="android">要跳转到的播放位置，单位为毫秒。</pd>
+                <pd props="apple">你希望跳转到的播放位置。</pd>
+                <pd props="cpp">要跳转到的新播放位置。</pd>
+                </plentry>
+            <plentry props="apple cpp">
+                <pt props="cpp">err</pt>
+                <pt props="apple">error</pt>
+                <pd props="apple">输出参数，用于返回跳转失败时的错误信息。详见 <xref keyref="Error"/>。</pd>
+                <pd props="cpp">输出参数，表示错误码：
+                    <ul>
+                        <li><ph keyref="kRteOk"/>：成功。</li>
+                        <li><ph keyref="kRteErrorInvalidOperation"/>：<ul>
+                            <li>对应的内部 <xref keyref="Player_Player"/> 对象已被销毁或无效。</li>
+                            <li>打开的 URL 是 RTE URL，不支持跳转播放位置。详见 <xref keyref="Error"/>。</li>
+                            </ul>
+                        </li>
+                        </ul>
+                    </pd>
+                </plentry>
+            </parml> </section>
+        <section id="return_values" props="bp cs electron flutter rn unity unreal">
+            <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="bp cs electron rn unity unreal">
+                <li>0: 方法调用成功。</li>
+                <li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
+                </ul>
+        <p props="cpp"><ul>
+                        <li><codeph><ph keyref="true"/></codeph>：跳转成功。</li>
+                        <li><codeph><ph keyref="false"/></codeph>：跳转失败。</li>
+                        </ul>
+                    </p>
+        <p props="apple"><ul>
+                        <li><codeph><ph keyref="true"/></codeph>：跳转成功。</li>
+                        <li><codeph><ph keyref="false"/></codeph>：跳转失败。你可以通过 <xref keyref="Error"/> 参数查看具体错误信息。</li>
+                        </ul>
+                    </p>
+    </section>
+        </refbody>
+</reference>