Release/rtc ng/4.2.3

dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita

@@ -40,6 +40,10 @@
             <p id="desc1"> <ph props="android ios mac">调用 <xref keyref="setExternalVideoSource"/> 方法，设置 <parmname>enabled</parmname> 参数为 <codeph><ph keyref="true"/></codeph>、<parmname>encodedFrame</parmname> 参数为 <codeph><ph keyref="false"/></codeph> 后，你可以调用本方法将未编码的外部视频帧推送到 SDK。</ph> <ph props="unity cpp unreal bp flutter rn electron cs">调用 <xref keyref="createCustomVideoTrack"/> 方法获得视频轨道 ID，在每个频道的 <xref keyref="ChannelMediaOptions"/> 中，将 <parmname>customVideoTrackId</parmname> 参数设置为你想要发布的视频轨道 ID，并将 <parmname>publishCustomVideoTrack</parmname> 设置为 <codeph><ph keyref="true"/></codeph>后，你可以调用本方法将未编码的外部视频帧推送到 SDK。</ph></p>
             <p props="android">调用该方法或 <xref keyref="pushVideoFrame2"/> 均能将视频帧数据传递给SDK。区别为 <apiname keyref="pushVideoFrame"/> 方法不支持 texture 格式的视频数据。</p>
         </section>
+        <section props="cpp">
+            <title>适用场景</title>
+            <p>SDK 自 v4.2.3 起支持 ID3D11Texture2D 类型的视频格式，该类型在游戏场景下应用较为广泛。当你需要将该类型的视频帧推送的 SDK 时，需要调用该方法，并设置 <parmname>frame</parmname> 中的 <parmname>format</parmname> 为 <codeph>VIDEO_TEXTURE_ID3D11TEXTURE2D</codeph>、设置 <parmname>d3d11_texture_2d</parmname> 和 <parmname>texture_slice_index</parmname> 成员，将视频帧的格式设置为 ID3D11Texture2D。</p>
+        </section>
         <section id="parameters">
             <title>参数</title>
             <parml>

dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita

@@ -2,7 +2,7 @@
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
 <reference id="api_irtcengine_enablecontentinspect">
     <title><ph keyref="enableContentInspect"/></title>
-    <shortdesc id="short"><ph id="shortdesc"><ph>开启/关闭视频截图上传。</ph><ph props="hide">开启/关闭视频内容审核。</ph></ph></shortdesc>
+    <shortdesc id="short"><ph id="shortdesc">开启/关闭视频截图上传。</ph></shortdesc>
     <prolog>
         <metadata>
             <keywords>
@@ -32,28 +32,26 @@
         <section id="detailed_desc">
             <title>详情</title>
             <p>开启视频截图上传后，SDK 会根据你在 <xref keyref="ContentInspectConfig"/> 中设置的模块类型和频率对本地用户发送的视频进行截图和上传。截图完成后，声网服务器会以 HTTPS 请求的形式，向你的服务器发送回调通知，并将所有截图发送至你指定的第三方云存储。</p>
-            <p props="hide">开启视频内容审核后，SDK 会根据你在 <xref keyref="ContentInspectConfig"/> 中设置的内容审核模块类型和频率对本地用户发送的视频进行截图、审核和上传。审核完成后，声网内容审核服务器会以 HTTPS 请求的形式，向你的服务器发送审核结果，并将指定类型的截图发送至你指定的第三方云存储。</p>
-            <note>
-            <ul>
-            <li><ph>调用该方法前，请确保已<xref keyref="ticket-link"/>开通视频截图上传服务。</ph><ph props="hide">调用该方法前，请确保已<xref keyref="ticket-link"/>开通视频内容审核服务。详见 <xref keyref="enable-content-inspect"/>。</ph></li>
-            <li>该方法依赖于视频截图上传动态库 <codeph><ph keyref="moderation"/></codeph>，如果删除该动态库会导致无法正常开启该功能。</li>
-            </ul></note> </section>
+            <note>调用该方法前，请确保已<xref keyref="ticket-link"/>开通视频截图上传服务。</note> 
+        </section>
         <section id="parameters">
             <title>参数</title>
             <parml>
-            <plentry>
+            <plentry id="enabled">
                 <pt>enabled</pt>
                 <pd>设置是否开启<ph>视频截图上传</ph><ph props="hide">视频内容审核</ph>：                                                  
 
 
                     <ul>
-                    <li><codeph><ph keyref="true"/></codeph>：<ph>开启视频截图上传</ph>。<ph props="hide">开启视频内容审核。</ph></li>
-                    <li><codeph><ph keyref="false"/></codeph>：<ph>关闭视频截图上传</ph>。<ph props="hide">关闭视频内容审核。</ph></li>
+                    <li><codeph><ph keyref="true"/></codeph>：开启视频截图上传</li>
+                    <li><codeph><ph keyref="false"/></codeph>：关闭视频截图上传</li>
                     </ul></pd>
             </plentry>
-            <plentry>
+            <plentry id="config">
                 <pt>config</pt>
-                <pd><ph>视频截图上传配置。</ph><ph props="hide">视频内容审核配置。</ph><ph>详见 <xref keyref="ContentInspectConfig"/>。</ph></pd>
+                <pd><ph>视频截图上传配置。详见 <xref keyref="ContentInspectConfig"/>。</ph>
+                    <note>视频审核模块选择声网自研插件截图上传（<ph keyref="CONTENT_INSPECT_SUPERVISE"/>）时需集成视频截图上传动态库 <codeph><ph keyref="moderation"/></codeph>，如果删除该动态库会导致无法正常开启视频截图上传功能。</note>
+                </pd>
             </plentry>
             </parml> </section>
         <section id="return_values">

dita/RTC-NG/API/api_irtcengine_isfeatureavailableondevice.dita

@@ -0,0 +1,60 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
+<reference id="api_irtcengine_isfeatureavailableondevice">
+    <title><ph keyref="isFeatureAvailableOnDevice"/></title>
+    <shortdesc id="short"><ph id="shortdesc">查询设备是否支持指定进阶功能。</ph></shortdesc>
+    <prolog>
+        <metadata>
+            <keywords>
+                <indexterm keyref="isFeatureAvailableOnDevice"/>
+            </keywords>
+        </metadata>
+    </prolog>
+    <refbody>
+        <section id="prototype">
+            <p outputclass="codeblock">
+            <codeblock props="android" outputclass="language-java">public abstract boolean isFeatureAvailableOnDevice(int type);</codeblock>
+            <codeblock props="ios mac" outputclass="language-objectivec">- (BOOL)isFeatureAvailableOnDevice:(AgoraFeatureType)type;</codeblock>
+            <codeblock props="cpp unreal bp" outputclass="language-cpp">virtual bool isFeatureAvailableOnDevice(FeatureType type) = 0;</codeblock>
+            <codeblock props="electron" outputclass="language-typescript"/>
+            <codeblock props="unity cs" outputclass="language-csharp"/>
+            <codeblock props="rn" outputclass="language-typescript">abstract isFeatureAvailableOnDevice(type: FeatureType): boolean;</codeblock>
+            <codeblock props="flutter" outputclass="language-dart">Future&lt;bool&gt; isFeatureAvailableOnDevice(FeatureType type);</codeblock> </p>
+        </section>
+        <section id="detailed_desc">
+            <title>详情</title>
+            <dl outputclass="since">
+            <dlentry props="native">
+                <dt>自从</dt>
+                <dd>v4.2.3</dd>
+            </dlentry>
+            </dl>
+            <p>查询当前设备能力是否满足虚拟背景、美颜等进阶功能的要求。</p>
+        </section>
+        <section id="scenario">
+            <title>适用场景</title>
+            <p>在使用进阶音视频功能前，你可以根据查询结果判断当前设备是否支持这些功能，从而避免在低端设备上开启进阶功能导致性能下降或功能不可用的问题。你可以根据该方法的返回值，决定是否显示或启用相应的功能按钮，或者在设备能力不足时，为用户提示相应信息。。</p>
+        </section>
+        <section id="parameters">
+            <title>参数</title>
+            <parml>
+            <plentry>
+                <pt>type</pt>
+                <pd props="cpp apple framework">进阶功能类型，详见 <xref keyref="FeatureType"/>。</pd>
+                <pd props="android">
+                    <p>进阶功能类型：
+                    <ul>
+                    <li><ph keyref="VIDEO_VIRTUAL_BACKGROUND" /> (1)：虚拟背景功能。</li>
+                    <li><ph keyref="VIDEO_BEAUTY_EFFECT" /> (2)：美颜功能。</li>
+                    </ul></p>
+                </pd>
+            </plentry>
+            </parml> </section>
+        <section id="return_values">
+            <title>返回值</title>
+            <ul>
+            <li><codeph><ph keyref="true" /></codeph>: 设备支持指定进阶功能。</li>
+            <li><codeph><ph keyref="false" /></codeph>: 设备不支持指定进阶功能。</li>
+            </ul> </section>
+    </refbody>
+</reference>

dita/RTC-NG/API/api_irtcengineex_enablecontentinspectex.dita

@@ -0,0 +1,67 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
+<reference id="api_irtcengineex_enablecontentinspectex">
+    <title><ph keyref="enableContentInspectEx"/></title>
+    <shortdesc id="short"><ph id="shortdesc">开启/关闭视频截图上传。</ph></shortdesc>
+    <prolog>
+        <metadata>
+            <keywords>
+                <indexterm keyref="enableContentInspectEx"/>
+            </keywords>
+        </metadata>
+    </prolog>
+    <refbody>
+        <section id="prototype">
+            <p outputclass="codeblock">
+            <codeblock props="android" outputclass="language-java">public abstract int enableContentInspectEx(
+      boolean enabled, ContentInspectConfig config, RtcConnection connection);</codeblock>
+            <codeblock props="ios mac" outputclass="language-objectivec">- (int)enableContentInspectEx:(BOOL)enabled config:(AgoraContentInspectConfig* _Nonnull)config connection:(AgoraRtcConnection * _Nonnull)connection NS_SWIFT_NAME(enableContentInspectEx(_:config:connection:));</codeblock>
+            <codeblock props="cpp unreal bp" outputclass="language-cpp">virtual int enableContentInspectEx(bool enabled, const media::ContentInspectConfig &amp;config, const RtcConnection&amp; connection) = 0;</codeblock>
+            <codeblock props="electron" outputclass="language-typescript"/>
+            <codeblock props="unity cs" outputclass="language-csharp"/>
+            <codeblock props="rn" outputclass="language-typescript">abstract enableContentInspectEx(
+    enabled: boolean,
+    config: ContentInspectConfig,
+    connection: RtcConnection
+  ): number;</codeblock>
+            <codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; enableContentInspectEx(
+    {required bool enabled,
+    required ContentInspectConfig config,
+    required RtcConnection connection});</codeblock> </p>
+        </section>
+        <section id="detailed_desc">
+            <title>详情</title>
+            <dl outputclass="since">
+            <dlentry props="native">
+                <dt>自从</dt>
+                <dd>v4.2.3</dd>
+            </dlentry>
+            </dl>
+            <p>该方法可以对多条视频流截图并上传。开启视频截图上传后，SDK 会根据你在 <xref keyref="ContentInspectConfig"/> 中设置的模块类型和频率对本地用户发送的视频进行截图和上传。截图完成后，声网服务器会以 HTTPS 请求的形式，向你的服务器发送回调通知，并将所有截图发送至你指定的第三方云存储。</p>
+            <note>调用该方法前，请确保已<xref keyref="ticket-link"/>开通视频截图上传服务。</note>
+        </section>
+        <section id="parameters">
+            <title>参数</title>
+            <parml>
+            <plentry conkeyref="enableContentInspect/enabled">
+                <pt/>
+                <pd/>
+            </plentry>
+            <plentry conkeyref="enableContentInspect/config">
+                <pt/>
+                <pd/>
+            </plentry>
+            <plentry conkeyref="joinChannelEx/connection">
+                <pt/>
+                <pd/>
+            </plentry>
+            </parml> </section>
+        <section id="return_values">
+            <title><ph keyref="return-section-title"/></title>
+            <p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
+            <ul>
+            <li props="native unreal bp unity rn electron cs">0: 方法调用成功。</li>
+            <li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
+            </ul></section>
+        </refbody>
+</reference>

dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostatechanged.dita

@@ -68,13 +68,13 @@
                 <pd props="ios mac cpp unreal bp unity electron rn flutter cs">本地音频出错原因。详见 <xref keyref="LOCAL_AUDIO_STREAM_ERROR" />。</pd>
                 <pd props="android">本地音频出错原因。
                 <ul>
-                    <li><ph keyref="LOCAL_AUDIO_STREAM_ERROR_OK" /> 0: 本地音频状态正常。</li>
-                    <li><ph keyref="LOCAL_AUDIO_STREAM_ERROR_FAILURE" /> 1: 本地音频出错原因不明确。建议提示用户尝试重新加入频道。</li>
-                    <li><ph keyref="LOCAL_AUDIO_STREAM_ERROR_DEVICE_NO_PERMISSION" /> 2: 没有权限启动本地音频采集设备。请提示用户开启权限。</li>
-                    <li><ph keyref="LOCAL_AUDIO_STREAM_ERROR_DEVICE_BUSY" /> 3: 本地音频采集设备已经在使用中。请提示用户检查麦克风是否被其他应用占用。麦克风空闲约 5 秒后本地音频采集会自动恢复，你也可以在麦克风空闲后尝试重新加入频道。</li>
-                    <li><ph keyref="LOCAL_AUDIO_STREAM_ERROR_RECORD_FAILURE" /> 4: 本地音频采集失败。</li>
-                    <li><ph keyref="LOCAL_AUDIO_STREAM_ERROR_ENCODE_FAILURE" /> 5: 本地音频编码失败。</li>
-                    <li><ph keyref="LOCAL_AUDIO_STREAM_ERROR_INTERRUPTED" /> 8: 本地音频采集被系统来电、Siri、闹钟中断。如需恢复本地音频采集，请用户中止电话、Siri、闹钟。</li>
+                    <li><ph keyref="LOCAL_AUDIO_STREAM_ERROR_OK" /> (0): 本地音频状态正常。</li>
+                    <li><ph keyref="LOCAL_AUDIO_STREAM_ERROR_FAILURE" /> (1): 本地音频出错原因不明确。建议提示用户尝试重新加入频道。</li>
+                    <li><ph keyref="LOCAL_AUDIO_STREAM_ERROR_DEVICE_NO_PERMISSION" /> (2): 没有权限启动本地音频采集设备。请提示用户开启权限。</li>
+                    <li><ph keyref="LOCAL_AUDIO_STREAM_ERROR_DEVICE_BUSY" /> (3): 本地音频采集设备已经在使用中。请提示用户检查麦克风是否被其他应用占用。麦克风空闲约 5 秒后本地音频采集会自动恢复，你也可以在麦克风空闲后尝试重新加入频道。</li>
+                    <li><ph keyref="LOCAL_AUDIO_STREAM_ERROR_RECORD_FAILURE" /> (4): 本地音频采集失败。</li>
+                    <li><ph keyref="LOCAL_AUDIO_STREAM_ERROR_ENCODE_FAILURE" /> (5): 本地音频编码失败。</li>
+                    <li><ph keyref="LOCAL_AUDIO_STREAM_ERROR_INTERRUPTED" /> (8): 本地音频采集被系统来电、Siri、闹钟中断。如需恢复本地音频采集，请用户中止电话、Siri、闹钟。</li>
                 </ul></pd>
             </plentry>
             </parml> </section>

dita/RTC-NG/API/class_audiorecordingconfiguration.dita

@@ -176,7 +176,7 @@
             <parml>
             <plentry id="filepath">
                 <pt>filePath</pt>
-                <pd>录音文件在本地保存的绝对路径，需精确到文件名及格式。例如：<codeph><ph keyref="filePath-example" /></codeph>。
+                <pd>录音文件在本地保存的绝对路径，需精确到文件名及格式。例如：<codeph><ph keyref="recordingPath-example" /></codeph>。