From 88408595fdeabba2f396fdbacabc53a05a7d1183 Mon Sep 17 00:00:00 2001
From: Nero-Hu <huheng@agora.io>
Date: Tue, 26 Sep 2023 16:53:10 +0800
Subject: [PATCH] add -4 for advance features

---
 dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita | 2 ++
 .../API/api_irtcengine_isfeatureavailableondevice.dita      | 1 +
 dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita  | 6 ++++--
 dita/RTC-NG/release/release_notes.dita                      | 2 +-
 4 files changed, 8 insertions(+), 3 deletions(-)

diff --git a/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita b/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita
index 2711db61540..93542899215 100644
--- a/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita
+++ b/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita
@@ -74,6 +74,7 @@
                 <li>摄像画面中，物件较少，用户的人像为半身人像且基本无遮挡，背景色较单一且与用户着装颜色不同。</li>
                 </ul></li>
             <li>该方法依赖于虚拟背景动态库 <codeph><ph keyref="segmentation"/></codeph>，如果删除该动态库会导致无法正常开启该功能。</li>
+            <li>调用该方法时 SDK 会自动对当前设备能力进行检查，并在设备能力不足时，通过返回错误码 <codeph>-4：<ph keyref="ERR_NOT_SUPPORTED"/></codeph> 表示该设备不支持开启该功能。</li>
             </ul></note> </section>
         <section id="parameters">
             <title>参数</title>
@@ -125,6 +126,7 @@
                 <li>-1：自定义的背景图不存在。请检查 <xref keyref="VirtualBackgroundSource"/> 中 <parmname>source</parmname> 的值。</li>
                 <li>-2：自定义的背景图颜色格式出错。请检查 <xref keyref="VirtualBackgroundSource"/> 中 <parmname>color</parmname> 的值。</li>
                 <li>-3：设备不支持使用虚拟背景。</li>
+                <li>-4：设备能力不满足虚拟背景的使用要求。</li>
                 </ul></li>
             </ul> </section>
     </refbody>
diff --git a/dita/RTC-NG/API/api_irtcengine_isfeatureavailableondevice.dita b/dita/RTC-NG/API/api_irtcengine_isfeatureavailableondevice.dita
index 1326b7c43e8..01079b5bebe 100644
--- a/dita/RTC-NG/API/api_irtcengine_isfeatureavailableondevice.dita
+++ b/dita/RTC-NG/API/api_irtcengine_isfeatureavailableondevice.dita
@@ -29,6 +29,7 @@
             </dlentry>
             </dl>
             <p>查询当前设备能力是否满足虚拟背景、美颜等进阶功能的要求。</p>
+            <note type="attention">启用进阶功能时（例如调用 <xref keyref="enableVirtualBackground"/> 启用虚拟背景时）SDK 会自动对当前设备能力进行检查，并在设备能力不足时，通过返回错误码 <codeph>-4：<ph keyref="ERR_NOT_SUPPORTED"/></codeph>，表示设备不支持该功能。</note>
         </section>
         <section id="scenario">
             <title>适用场景</title>
diff --git a/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita b/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita
index 5a732f90247..e2462fb70a6 100644
--- a/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita
+++ b/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita
@@ -41,6 +41,7 @@
                     <li>请在 <xref keyref="enableVideo" /> 或 <xref keyref="startPreview2" /> 之后调用该方法。</li>
                     <li props="android">该方法仅适用于 Android 5.0 及以上版本。</li>
                     <li>该方法依赖于视频增强动态库 <codeph><ph keyref="clearvision"/></codeph>，如果删除该动态库会导致无法正常开启该功能。</li>
+                    <li>调用该方法时 SDK 会自动对当前设备能力进行检查，并在设备能力不足时，通过返回错误码 <codeph>-4: <ph keyref="ERR_NOT_SUPPORTED"/></codeph> 表示该设备不支持开启该功能。</li>
                 </ul>
             </note> </section>
         <section id="parameters">
@@ -71,8 +72,9 @@
             <ul>
             <li props="native unreal bp electron unity rn cs">0: 方法调用成功。</li>
             <li>&lt; 0: 方法调用失败。
-                <ul props="android rn unity flutter cs">
-                <li><ph keyref="ERR_NOT_SUPPORTED"/>(4)：当前设备版本低于 Android 5.0，不支持该操作。</li>
+                <ul>
+                <li><ph keyref="ERR_NOT_SUPPORTED"/><ph>(4)：当前设备能力不满足美颜的使用要求。</ph>
+                                                    <ph props="android rn unity flutter cs">(4)：当前设备能力不满足美颜的使用要求，或当前设备版本低于 Android 5.0，不支持该操作。</ph></li>
                 </ul></li>
             </ul> </section>
     </refbody>
diff --git a/dita/RTC-NG/release/release_notes.dita b/dita/RTC-NG/release/release_notes.dita
index bd7e01c186f..e512c6679a7 100644
--- a/dita/RTC-NG/release/release_notes.dita
+++ b/dita/RTC-NG/release/release_notes.dita
@@ -37,7 +37,7 @@
                     <li><ph><b>进阶功能查询</b></ph>
                         <p>该版本新增了 <codeph><apiname keyref="isFeatureAvailableOnDevice"/></codeph> 方法，用于查询设备能力是否满足虚拟背景、美颜等进阶功能的使用要求。</p>
                         <p>在使用进阶功能前，你可以根据查询结果判断当前设备是否支持这些功能，从而避免在低端设备上开启进阶功能导致性能下降或功能不可用的问题。你可以根据该方法的返回值，决定是否显示或启用相应的功能按钮，或者在设备能力不足时，为用户提示相应信息。</p>
-                        <p>此外，自该版本起，启用进阶功能时（例如调用 <codeph><apiname keyref="enableVirtualBackground"/></codeph> 启用虚拟背景时）将自动调用 <codeph><apiname keyref="isFeatureAvailableOnDevice"/></codeph> 方法，如果当前设备能力不满足进阶功能的使用要求将返回 <codeph>-4: <apiname keyref="ERR_NOT_SUPPORTED"/></codeph>，表示设备不支持该功能。</p>
+                        <p>此外，自该版本起，启用进阶功能时（例如调用 <codeph><apiname keyref="enableVirtualBackground"/></codeph> 启用虚拟背景时）SDK 会自动对当前设备能力进行检查，并在设备能力不足时，通过返回错误码 <codeph>-4: <ph keyref="ERR_NOT_SUPPORTED"/></codeph> 表示该设备不支持开启该功能。</p>
                     </li>
                 </ol>
             </body>