Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release/rtc ng/4.2.3 #3364

Merged
merged 14 commits into from
Sep 27, 2023
Merged
21 changes: 2 additions & 19 deletions dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,7 @@
<p>请在 <xref keyref="enableVideo"/> 或 <xref keyref="startPreview2"/> 之后调用该方法。</p>
<note type="attention">
<ul>
<li>该功能对设备性能要求较高,建议你在搭载如下芯片的设备上使用:


<li>该功能对设备性能要求较高,调用该方法时 SDK 会自动对当前设备能力进行检查。建议你在搭载如下芯片的设备上使用:
<ul>
<li props="android unity cpp unreal bp rn flutter cs">骁龙 700 系列 750G 及以上</li>
<li props="android unity cpp unreal bp rn flutter cs">骁龙 800 系列 835 及以上</li>
Expand All @@ -56,8 +54,6 @@
<li props="android unity cpp unreal bp rn flutter cs">麒麟 900 系列 980 及以上</li>
<li props="mac cpp unreal bp unity electron cs">CPU 为 i5 及更好的设备</li>
<li props="ios cpp unreal bp unity rn flutter cs">搭载 A9 及以上芯片的如下设备:


<ul>
<li>iPhone 6S 及以上</li>
<li>iPad Air 第三代及以上</li>
Expand All @@ -67,8 +63,6 @@
</ul></li>
</ul></li>
<li>建议你在满足如下条件的场景中使用该功能:


<ul>
<li>使用高清摄像设备、摄像环境光照均匀。</li>
<li>摄像画面中,物件较少,用户的人像为半身人像且基本无遮挡,背景色较单一且与用户着装颜色不同。</li>
Expand All @@ -83,8 +77,6 @@
<pt props="cpp unreal bp android unity flutter rn electron cs">enabled</pt>
<pt props="ios mac">enable</pt>
<pd>是否开启虚拟背景:


<ul>
<li><codeph><ph keyref="true"/></codeph>: 开启虚拟背景。</li>
<li><codeph><ph keyref="false"/></codeph>: 关闭虚拟背景。</li>
Expand All @@ -103,11 +95,7 @@
<plentry 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>
Expand All @@ -120,13 +108,8 @@
<ul>
<li props="native unreal bp electron unity rn cs">0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。


<ul>
<li>-1:自定义的背景图不存在。请检查 <xref keyref="VirtualBackgroundSource"/> 中 <parmname>source</parmname> 的值。</li>
<li>-2:自定义的背景图颜色格式出错。请检查 <xref keyref="VirtualBackgroundSource"/> 中 <parmname>color</parmname> 的值。</li>
<li>-3:设备不支持使用虚拟背景。</li>
<li>-4:设备能力不满足虚拟背景的使用要求。</li>
<li>-4:设备能力不满足虚拟背景的使用要求,建议更换性能更高的设备。</li>
</ul></li>
</ul> </section>
</refbody>
Expand Down
5 changes: 2 additions & 3 deletions dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +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>
<li>该功能对设备性能要求较高,调用该方法时 SDK 会自动对当前设备能力进行检查。</li>
</ul>
</note> </section>
<section id="parameters">
Expand Down Expand Up @@ -73,8 +73,7 @@
<li props="native unreal bp electron unity rn cs">0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。
<ul>
<li><ph keyref="ERR_NOT_SUPPORTED"/><ph>(4):当前设备能力不满足美颜的使用要求。</ph>
<ph props="android rn unity flutter cs">(4):当前设备能力不满足美颜的使用要求,或当前设备版本低于 Android 5.0,不支持该操作。</ph></li>
<li><ph>-4:当前设备能力不满足美颜的使用要求,建议更换性能更高的设备。</ph><ph props="android rn unity flutter cs">或当前设备版本低于 Android 5.0,不支持该操作,请更换设备或升级操作系统。</ph></ph>
Nero-Hu marked this conversation as resolved.
Show resolved Hide resolved
</ul></li>
</ul> </section>
</refbody>
Expand Down
2 changes: 1 addition & 1 deletion dita/RTC-NG/release/release_notes.dita
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
<li><ph><b>进阶功能查询</b></ph>
<p>该版本新增了 <codeph><apiname keyref="isFeatureAvailableOnDevice"/></codeph> 方法,用于查询设备能力是否满足虚拟背景、美颜等进阶功能的使用要求。</p>
<p>在使用进阶功能前,你可以根据查询结果判断当前设备是否支持这些功能,从而避免在低端设备上开启进阶功能导致性能下降或功能不可用的问题。你可以根据该方法的返回值,决定是否显示或启用相应的功能按钮,或者在设备能力不足时,为用户提示相应信息。</p>
<p>此外,自该版本起,启用进阶功能时(例如调用 <codeph><apiname keyref="enableVirtualBackground"/></codeph> 启用虚拟背景时)SDK 会自动对当前设备能力进行检查,并在设备能力不足时,通过返回错误码 <codeph>-4: <ph keyref="ERR_NOT_SUPPORTED"/></codeph> 表示该设备不支持开启该功能。</p>
<p>此外,自该版本起,调用 <codeph><apiname keyref="enableVirtualBackground"/></codeph> 和 <codeph><apiname keyref="setBeautyEffectOptions"/></codeph> 时,SDK 会自动对当前设备能力进行检查,并在设备能力不足时,通过返回错误码 <codeph>-4: <ph keyref="ERR_NOT_SUPPORTED"/></codeph> 表示该设备不支持开启该功能。</p>
</li>
</ol>
</body>
Expand Down
3 changes: 2 additions & 1 deletion dita/templates-cn/RTC/API.dita
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java"/>
<codeblock props="ios mac" outputclass="language-objectivec"/>
<codeblock props="cpp unreal bp" outputclass="language-cpp"/>
<codeblock props="cpp unreal" outputclass="language-cpp"/>
<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"/>
Expand Down
3 changes: 2 additions & 1 deletion dita/templates-cn/RTC/Callback.dita
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java"/>
<codeblock props="ios mac" outputclass="language-objectivec"/>
<codeblock props="cpp unreal bp" outputclass="language-cpp"/>
<codeblock props="cpp unreal" outputclass="language-cpp"/>
<codeblock props="bp" outputclass="language-cpp"/>
<codeblock props="cs" outputclass="language-csharp"/>
<codeblock props="electron" outputclass="language-typescript"/>
<codeblock props="unity cs" outputclass="language-csharp"/>
Expand Down
3 changes: 2 additions & 1 deletion dita/templates-cn/RTC/Class.dita
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java"/>
<codeblock props="ios mac" outputclass="language-objectivec"/>
<codeblock props="cpp unreal bp" outputclass="language-cpp"/>
<codeblock props="cpp unreal" outputclass="language-cpp"/>
<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"/>
Expand Down
25 changes: 7 additions & 18 deletions en-US/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita
Original file line number Diff line number Diff line change
Expand Up @@ -13,24 +13,13 @@
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public abstract int setBeautyEffectOptions(boolean enabled, BeautyOptions options);</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)setBeautyEffectOptions:(BOOL)enable options:(AgoraBeautyOptions* _Nullable)options;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int setBeautyEffectOptions(bool enabled, BeautyOptions options) = 0;</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract setBeautyEffectOptions(
enabled: boolean,
options: BeautyOptions,
type?: MediaSourceType
): number;</codeblock>
<codeblock props="unity cs" outputclass="language-csharp">public abstract int SetBeautyEffectOptions(bool enabled, BeautyOptions options, MEDIA_SOURCE_TYPE type = MEDIA_SOURCE_TYPE.PRIMARY_CAMERA_SOURCE);</codeblock>
<codeblock props="rn" outputclass="language-typescript">abstract setBeautyEffectOptions(
enabled: boolean,
options: BeautyOptions,
type?: MediaSourceType
): number;</codeblock>
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; setBeautyEffectOptions(
{required bool enabled,
required BeautyOptions options,
MediaSourceType type = MediaSourceType.primaryCameraSource});</codeblock>
<codeblock props="android" outputclass="language-java">public abstract int setVideoQualityParameters(boolean preferFrameRateOverImageQuality);</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)setVideoQualityParameters:(BOOL)preferFrameRateOverImageQuality;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int setVideoQualityParameters(bool preferFrameRateOverImageQuality) = 0;</codeblock>
<codeblock props="electron" outputclass="language-typescript" />
<codeblock props="unity cs" outputclass="language-csharp">public abstract int SetVideoQualityParameters(bool preferFrameRateOverImageQuality);</codeblock>
<codeblock props="rn" outputclass="language-typescript" />
<codeblock props="flutter" outputclass="language-dart" />
<codeblock props="reserve" outputclass="language-cpp" /></p>
</section>
<section id="detailed_desc">
Expand Down