Skip to content

Commit

Permalink
New translations
Browse files Browse the repository at this point in the history
  • Loading branch information
Cilla-luodan committed Sep 28, 2023
1 parent 1f7f0dd commit d6102ea
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 18 deletions.
34 changes: 17 additions & 17 deletions en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_irtcengine_enablevirtualbackground">
<title><ph keyref="enableVirtualBackground" /></title>
<title><ph keyref="enableVirtualBackground"/></title>
<shortdesc id="short"><ph id="shortdesc">Enables/Disables the virtual background.</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="enableVirtualBackground" />
<indexterm keyref="enableVirtualBackground"/>
</keywords>
</metadata>
</prolog>
Expand All @@ -32,20 +32,20 @@
segproperty: SegmentationProperty,
type?: MediaSourceType
): number;</codeblock>
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; enableVirtualBackground(
<codeblock props="flutter" outputclass="language-dart">Future&lt;void> enableVirtualBackground(
{required bool enabled,
required VirtualBackgroundSource backgroundSource,
required SegmentationProperty segproperty,
MediaSourceType type = MediaSourceType.primaryCameraSource});</codeblock>
<codeblock props="reserve" outputclass="language-cpp" /></p>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>Details</title>
<p>The virtual background feature enables the local user to replace their original background with a static image, dynamic video, blurred background, or portrait-background segmentation to achieve picture-in-picture effect. Once the virtual background feature is enabled, all users in the channel can see the custom background.</p>
<p>Call this method before calling <xref keyref="enableVideo" /> or <xref keyref="startPreview2" />.</p>
<p>Call this method before calling <xref keyref="enableVideo"/> or <xref keyref="startPreview2"/>.</p>
<note type="attention">
<ul>
<li>This feature has high requirements on device performance. When calling this method, the SDK will automatically check the capabilities of the current device. Agora recommends you use virtual background on devices with the following processors:<ul>
<li>This feature has high requirements on device performance. When calling this method, the SDK automatically checks the capabilities of the current device. Agora recommends you use virtual background on devices with the following processors:<ul>
<li props="android unity cpp unreal bp rn flutter cs">Snapdragon 700 series 750G and later</li>
<li props="android unity cpp unreal bp rn flutter cs">Snapdragon 800 series 835 and later</li>
<li props="android unity cpp unreal bp rn flutter cs">Dimensity 700 series 720 and later</li>
Expand All @@ -64,7 +64,7 @@
<li>A high-definition camera device is used, and the environment is uniformly lit.</li>
<li>There are few objects in the captured video. Portraits are half-length and unobstructed. Ensure that the background is a solid color that is different from the color of the user's clothing.</li>
</ul></li>
<li>This method relies on the virtual background dynamic library <codeph><ph keyref="segmentation" /></codeph>. If the dynamic library is deleted, the function cannot be enabled normally.</li>
<li>This method relies on the virtual background dynamic library <codeph><ph keyref="segmentation"/></codeph>. If the dynamic library is deleted, the function cannot be enabled normally.</li>
</ul></note> </section>
<section id="parameters">
<title>Parameters</title>
Expand All @@ -73,36 +73,36 @@
<pt props="cpp unreal bp android unity flutter rn electron cs">enabled</pt>
<pt props="ios mac">enable</pt>
<pd>Whether to enable virtual background:<ul>
<li><codeph><ph keyref="true" /></codeph>: Enable virtual background.</li>
<li><codeph><ph keyref="false" /></codeph>: Disable virtual background.</li>
<li><codeph><ph keyref="true"/></codeph>: Enable virtual background.</li>
<li><codeph><ph keyref="false"/></codeph>: Disable virtual background.</li>
</ul></pd>
</plentry>
<plentry>
<pt props="cpp unreal bp android unity flutter rn electron cs">backgroundSource</pt>
<pt props="mac ios">backData</pt>
<pd>The custom background. See <xref keyref="VirtualBackgroundSource" />. To adapt the resolution of the custom background image to that of the video captured by the SDK, the SDK scales and crops the custom background image while ensuring that the content of the custom background image is not distorted.</pd>
<pd>The custom background. See <xref keyref="VirtualBackgroundSource"/>. To adapt the resolution of the custom background image to that of the video captured by the SDK, the SDK scales and crops the custom background image while ensuring that the content of the custom background image is not distorted.</pd>
</plentry>
<plentry>
<pt props="android cpp unreal bp unity electron rn flutter cs">segproperty</pt>
<pt props="ios mac">segData</pt>
<pd>Processing properties for background images. See <xref keyref="SegmentationProperty" />.</pd>
<pd>Processing properties for background images. See <xref keyref="SegmentationProperty"/>.</pd>
</plentry>
<plentry props="cpp unreal bp unity rn electron flutter cs">
<pt>type</pt>
<pd>The type of the video source. See <xref keyref="MEDIA_SOURCE_TYPE" />.<note type="attention">In this method, this parameter supports only the following two settings:<ul>
<li>The default value is <apiname keyref="PRIMARY_CAMERA_SOURCE" />.</li>
<li>If you want to use the second camera to capture video, set this parameter to <apiname keyref="SECONDARY_CAMERA_SOURCE" />.</li>
<pd>The type of the video source. See <xref keyref="MEDIA_SOURCE_TYPE"/>.<note type="attention">In this method, this parameter supports only the following two settings:<ul>
<li>The default value is <apiname keyref="PRIMARY_CAMERA_SOURCE"/>.</li>
<li>If you want to use the second camera to capture video, set this parameter to <apiname keyref="SECONDARY_CAMERA_SOURCE"/>.</li>
</ul></note></pd>
</plentry>
</parml> </section>
<section id="return_values">
<title><ph keyref="return-section-title" /></title>
<p props="flutter">When the method call succeeds, there is no return value; when fails, the <xref keyref="AgoraRtcException" /> exception is thrown; and you need to catch the exception and handle it accordingly. <ph props="cn">See <xref keyref="error-code-link" /> for details and resolution suggestions.</ph></p>
<title><ph keyref="return-section-title"/></title>
<p props="flutter">When the method call succeeds, there is no return value; when fails, the <xref keyref="AgoraRtcException"/> exception is thrown; and you need to catch the exception and handle it accordingly. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph></p>
<ul>
<li props="native unreal bp electron unity rn cs">0: Success.</li>
<li>&lt; 0: Failure.<ul>
<li>-4: The device capabilities do not meet the requirements for the virtual background feature. Agora recommends you try it on devices with higher performance.</li>
</ul></li>
</ul> </section>
</refbody>
</reference>
</reference>
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
<li>Call this method before calling <xref keyref="enableVideo" /> or <xref keyref="startPreview2" />.</li>
<li props="android">This method only applies to Android 5.0 or later.</li>
<li>This method relies on the image enhancement dynamic library <codeph><ph keyref="clearvision"/></codeph>. If the dynamic library is deleted, the function cannot be enabled normally.</li>
<li>This feature has high requirements on device performance. When calling this method, the SDK will automatically check the capabilities of the current device.</li>
<li>This feature has high requirements on device performance. When calling this method, the SDK automatically checks the capabilities of the current device.</li>
</ul>
</note> </section>
<section id="parameters">
Expand Down

0 comments on commit d6102ea

Please sign in to comment.