fix type/sourcetype

AgoraIO · Oct 28, 2024 · e17b93b · e17b93b
1 parent b1183ed
commit e17b93b
Show file tree

Hide file tree

Showing 7 changed files with 20 additions and 28 deletions.
diff --git a/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita b/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita
@@ -94,14 +94,9 @@
                 <pt props="ios mac">segData</pt>
                 <pd>背景图像的处理属性。详见 <xref keyref="SegmentationProperty"/>。</pd>
             </plentry>
-            <plentry id="type" props="cpp unreal bp unity rn electron flutter cs">
-                <pt>type</pt>
-                <pd>视频源类型。详见 <xref keyref="MEDIA_SOURCE_TYPE"/>。
-                    <note type="attention">在该方法中，该参数仅支持以下两种设置：
-                    <ul>
-                    <li>默认值为 <apiname keyref="PRIMARY_CAMERA_SOURCE"/>。</li>
-                    <li>如果要使用第二个摄像头采集视频，将该参数设置为 <apiname keyref="SECONDARY_CAMERA_SOURCE"/>。</li>
-                    </ul></note></pd>
+            <plentry conkeyref="setLowlightEnhanceOptions/type" props="cpp unreal bp rn unity electron flutter cs">
+                <pt/>
+                <pd/>
             </plentry>
             </parml> </section>
         <section id="return_values">

diff --git a/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground2.dita b/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground2.dita
@@ -54,7 +54,12 @@
             </plentry>
             <plentry id="sourcetype">
                 <pt props="android apple">sourceType</pt>
-                <pd>应用效果的媒体源。详见 <xref keyref="MEDIA_SOURCE_TYPE" />。</pd>
+                <pd>效果应用的媒体源类型。详见 <xref keyref="MEDIA_SOURCE_TYPE" />。
+                    <note type="attention">在该方法中，该参数仅支持以下两种设置：
+                    <ul>
+                    <li>默认值为 <apiname keyref="PRIMARY_CAMERA_SOURCE"/>。</li>
+                    <li>如果要使用自定义采集的视频，将该参数设置为 <apiname keyref="CUSTOM_VIDEO_SOURCE"/>。</li>
+                    </ul></note></pd>
             </plentry>
             </parml> </section>
         <section id="return_values">

diff --git a/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita b/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita
@@ -68,9 +68,9 @@
                 <pt>options</pt>
                 <pd>美颜选项，详细定义见 <xref keyref="BeautyOptions" />。</pd>
             </plentry>
-            <plentry props="unity rn electron flutter cs" conkeyref="enableExtension/source">
-                <pt />
-                <pd />
+            <plentry conkeyref="setLowlightEnhanceOptions/type" props="cpp unreal bp rn unity electron flutter cs">
+                <pt/>
+                <pd/>
             </plentry>
             </parml> </section>
         <section id="return_values">

diff --git a/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita b/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita
@@ -46,11 +46,6 @@
             <ul>
             <li>请在 <xref keyref="enableVideo" /> 后调用该方法。</li>
             <li>色彩增强对设备性能有一定要求。开启色彩增强后，如果设备出现严重发烫等问题，建议你将色彩增强等级修改为消耗性能较少的等级或关闭色彩增强功能。</li>
-            <li>该方法和 <xref keyref="setExtensionProperty" /> 均可开启色彩增强功能：
-                <ul>
-                    <li>当你使用 SDK 采集视频时，建议使用该方法（该方法只可对 SDK 采集的视频起作用）。</li>
-                    <li>当你使用外部的视频源实现自定义视频采集，或者将外部视频源发送给 SDK 时，建议使用 <apiname keyref="setExtensionProperty" /> 方法。</li>
-                </ul></li>
             <li>该方法依赖于视频增强动态库 <codeph><ph keyref="clearvision"/></codeph>，如果删除该动态库会导致无法正常开启该功能。</li>
             </ul> </note> </section>
         <section id="parameters">

diff --git a/dita/RTC-NG/API/api_irtcengine_setfiltereffectoptions.dita b/dita/RTC-NG/API/api_irtcengine_setfiltereffectoptions.dita
@@ -66,10 +66,9 @@
                 <pt props="cpp unreal bp unity rn electron flutter cs">type</pt>
                 <pt props="android apple">sourceType</pt>
                 <pd>效果应用的媒体源类型。详见 <xref keyref="MEDIA_SOURCE_TYPE" />。
-                    <note type="attention">在该方法中，该参数仅支持以下三种设置：
+                    <note type="attention">在该方法中，该参数仅支持以下两种设置：
                     <ul>
                     <li>默认值为 <apiname keyref="PRIMARY_CAMERA_SOURCE"/>。</li>
-                    <li>如果要使用第二个摄像头采集视频，将该参数设置为 <apiname keyref="SECONDARY_CAMERA_SOURCE"/>。</li>
                     <li>如果要使用自定义采集的视频，将该参数设置为 <apiname keyref="CUSTOM_VIDEO_SOURCE"/>。</li>
                     </ul></note></pd>
             </plentry>

diff --git a/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita b/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita
@@ -40,13 +40,7 @@
         </section>
         <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
             <p>你可以调用该方法开启暗光增强功能并设置暗光增强的效果。</p>
-            <note type="attention" id="req">
-            <p>该方法和 <xref keyref="setExtensionProperty"/> 均可开启视频降噪功能：
-                <ul>
-                    <li>当你使用 SDK 采集视频时，建议使用该方法（该方法只可对 SDK 采集的视频起作用）。</li>
-                    <li>当你使用外部的视频源实现自定义视频采集，或者将外部视频源发送给 SDK 时，建议使用 <apiname keyref="setExtensionProperty"/> 方法。</li>
-                </ul>
-            </p> </note> </section>
+        </section>
         <section id="scenario" deliveryTarget="details">
             <title>适用场景</title>
             <p>暗光增强功能可以在光线亮度偏低（如背光、阴天、暗场景）和亮度不均匀的环境下自适应调整视频画面的亮度值，恢复或凸显图像的细节信息，最终提升视频图像的整体视觉效果。</p>
@@ -86,7 +80,12 @@
             </plentry>
                 <plentry props="cpp unreal bp rn unity electron flutter cs" id="type">
                     <pt>type</pt>
-                    <pd>媒体源类型，详见 <xref keyref="MEDIA_SOURCE_TYPE"/>。</pd>
+                    <pd>效果应用的媒体源类型。详见 <xref keyref="MEDIA_SOURCE_TYPE" />。
+                    <note type="attention">在该方法中，该参数仅支持以下两种设置：
+                    <ul>
+                    <li>默认值为 <apiname keyref="PRIMARY_CAMERA_SOURCE"/>。</li>
+                    <li>如果要使用自定义采集的视频，将该参数设置为 <apiname keyref="CUSTOM_VIDEO_SOURCE"/>。</li>
+                    </ul></note></pd>
                 </plentry>
             </parml> </section>
         <section id="return_values">

diff --git a/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions2.dita b/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions2.dita
@@ -27,7 +27,6 @@
         </section>
         <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
             <p>该方法和 <xref keyref="setLowlightEnhanceOptions"/> 均可用于设置暗光增强功能，区别在于该方法支持在设置暗光增强功能时指定应用暗光增强的媒体源。</p>
-            <note type="attention" conkeyref="setLowlightEnhanceOptions/req"/>
         </section>
         <section id="scenario" deliveryTarget="details" conkeyref="setVideoDenoiserOptions/scenario"/>
         <section id="timing" deliveryTarget="details" conkeyref="setVideoDenoiserOptions/timing"/>