Merge branch 'release/rtc-ng/4.2.3' of https://github.com/AgoraIO/ago…

…ra_doc_source into release/rtc-ng/4.2.3
AgoraIO · Sep 27, 2023 · 9f30dbb · 9f30dbb
2 parents a9477a1 + 7a367bb
commit 9f30dbb
Show file tree

Hide file tree

Showing 22 changed files with 25 additions and 23 deletions.
diff --git a/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita b/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita
@@ -68,6 +68,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>

diff --git 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/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita
@@ -31,7 +31,7 @@
         </section>
         <section id="detailed_desc">
             <title>Details</title>
-            <p>When video screenshot and upload function is enabled, the SDK takes screenshots and upload videos sent by local users based on the type and frequency of the module you set in <xref keyref="ContentInspectConfig" />. After video screenshot and upload, the Agora server sends the callback notification to your app server in HTTPS requests and sends all screenshots to the third-party cloud storage service.</p>
+            <p>When video screenshot and upload function is enabled, the SDK takes screenshots and uploads videos sent by local users based on the type and frequency of the module you set in <xref keyref="ContentInspectConfig" />. After video screenshot and upload, the Agora server sends the callback notification to your app server in HTTPS requests and sends all screenshots to the third-party cloud storage service.</p>
             <note>Before calling this method, ensure that you have contacted <xref keyref="ticket-link" /> to activate the video screenshot upload service.</note> 
         </section>
         <section id="parameters">

diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita
@@ -44,11 +44,11 @@
             <parml>
             <plentry>
                 <pt>thumbSize</pt>
-                <pd><ph>The target size of the screen or window thumbnail (the width and height are in pixels). </ph><ph props="cpp unreal bp">See <xref keyref="SIZE-link" /></ph>. <ph>The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and thumbSize is 100 × 100, the actual size of the <parmname>thumbnail</parmname> is 100 × 75. If the target size is larger than the original size, the thumbnail is the original image and the SDK does not scale it.</ph></pd>
+                <pd><ph>The target size of the screen or window thumbnail (the width and height are in pixels). </ph><ph props="cpp unreal bp">See <xref keyref="SIZE-link" />. </ph><ph>The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and thumbSize is 100 × 100, the actual size of the <parmname>thumbnail</parmname> is 100 × 75. If the target size is larger than the original size, the thumbnail is the original image and the SDK does not scale it.</ph></pd>
             </plentry>
             <plentry>
                 <pt>iconSize</pt>
-                <pd><ph>The target size of the icon corresponding to the application program (the width and height are in pixels). </ph><ph props="cpp unreal bp">See <xref keyref="SIZE-link" /></ph>. <ph>The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and <parmname>iconSize</parmname> is 100 × 100, the actual size of the icon is 100 × 75. If the target size is larger than the original size, the icon is the original image and the SDK does not scale it.</ph></pd>
+                <pd><ph>The target size of the icon corresponding to the application program (the width and height are in pixels). </ph><ph props="cpp unreal bp">See <xref keyref="SIZE-link" />. </ph><ph>The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and <parmname>iconSize</parmname> is 100 × 100, the actual size of the icon is 100 × 75. If the target size is larger than the original size, the icon is the original image and the SDK does not scale it.</ph></pd>
             </plentry>
             <plentry>
                 <pt>includeScreen</pt>

diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_isfeatureavailableondevice.dita b/en-US/dita/RTC-NG/API/api_irtcengine_isfeatureavailableondevice.dita
@@ -39,11 +39,11 @@
             <parml>
             <plentry>
                 <pt>type</pt>
-                <pd props="cpp apple framework">The specific of the advanced feature, see <xref keyref="FeatureType" />.</pd>
+                <pd props="cpp apple framework">The type of the advanced feature, see <xref keyref="FeatureType" />.</pd>
                 <pd props="android">
-                    <p>The specific the advanced feature.<ul>
+                    <p>The type of the advanced feature.<ul>
                     <li><ph keyref="VIDEO_VIRTUAL_BACKGROUND" />(1): Virutual background.</li>
-                    <li><ph keyref="VIDEO_BEAUTY_EFFECT" />(2): Image enchancement.</li>
+                    <li><ph keyref="VIDEO_BEAUTY_EFFECT" />(2): Image enhancement.</li>
                     </ul></p>
                 </pd>
             </plentry>

diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita
@@ -46,7 +46,7 @@
             <plentry id="metadatatype">
                 <pt>type</pt>
                 <pd>
-                    <p>The metadata type. The SDK currently only supports <apiname keyref="VIDEO_METADATA" />. <ph props="ios mac cpp unreal bp unity rn electron cs">See <xref keyref="METADATA_TYPE" /></ph>.</p>
+                    <p>The metadata type. The SDK currently only supports <apiname keyref="VIDEO_METADATA" />. <ph props="ios mac cpp unreal bp unity rn electron cs">See <xref keyref="METADATA_TYPE" />.</ph></p>
                 </pd>
             </plentry>
             </parml> </section>

diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoprofile.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoprofile.dita
@@ -39,7 +39,7 @@
             <plentry>
                 <pt>profile</pt>
                 <pd>
-                    <p>Video profile. <ph props="ios mac cpp unreal bp unity cs">See <xref keyref="VIDEO_PROFILE_TYPE" /></ph>.</p>
+                    <p>Video profile. <ph props="ios mac cpp unreal bp unity cs">See <xref keyref="VIDEO_PROFILE_TYPE" />.</ph></p>
                 </pd>
             </plentry>
             <plentry>

diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita
@@ -57,7 +57,7 @@
             </plentry>
             <plentry props="cpp unreal bp unity flutter electron cs">
                 <pt>regionRect</pt>
-                <pd><ph>(Optional) Sets the relative location of the region to the screen. Pass in <codeph>nil</codeph> to share the entire screen. </ph><ph props="cpp unreal bp unity flutter cs">See <xref keyref="Rectangle" /></ph>. <ph props="mac">It consists of the following parameters:</ph><ul props="mac">
+                <pd><ph>(Optional) Sets the relative location of the region to the screen. Pass in <codeph>nil</codeph> to share the entire screen. </ph><ph props="cpp unreal bp unity flutter cs">See <xref keyref="Rectangle" />. </ph><ph props="mac">It consists of the following parameters:</ph><ul props="mac">
                     <li>x: The horizontal offset from the top-left corner.</li>
                     <li>y: The vertical offset from the top-left corner.</li>
                     <li>width: The width of the region.</li>

diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita
@@ -28,7 +28,7 @@
             <plentry>
                 <pt props="mac cpp unreal bp">rect</pt>
                 <pt props="unity cs">regionRect</pt>
-                <pd>The relative location of the region to the screen or window. If you do not set this parameter, the SDK shares the whole screen. <ph props="cpp unreal bp">See <xref keyref="Rect" /></ph>. If the specified region overruns the screen or window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen or window.</pd>
+                <pd>The relative location of the region to the screen or window. If you do not set this parameter, the SDK shares the whole screen. <ph props="cpp unreal bp">See <xref keyref="Rect" />. </ph>If the specified region overruns the screen or window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen or window.</pd>
             </plentry>
             </parml> </section>
         <section id="return_values">

diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_enablecontentinspectex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_enablecontentinspectex.dita
@@ -36,7 +36,7 @@
                 <dd>v4.2.3</dd>
             </dlentry>
             </dl>
-            <p>This method can take screenshots for multiple video streams and upload them. When video screenshot and upload function is enabled, the SDK takes screenshots and upload videos sent by local users based on the type and frequency of the module you set in <xref keyref="ContentInspectConfig" />. After video screenshot and upload, the Agora server sends the callback notification to your app server in HTTPS requests and sends all screenshots to the third-party cloud storage service.</p>
+            <p>This method can take screenshots for multiple video streams and upload them. When video screenshot and upload function is enabled, the SDK takes screenshots and uploads videos sent by local users based on the type and frequency of the module you set in <xref keyref="ContentInspectConfig" />. After video screenshot and upload, the Agora server sends the callback notification to your app server in HTTPS requests and sends all screenshots to the third-party cloud storage service.</p>
             <note>Before calling this method, ensure that you have contacted <xref keyref="ticket-link" /> to activate the video screenshot upload service.</note>
         </section>
         <section id="parameters">

diff --git a/en-US/dita/RTC-NG/API/callback_iaudiopcmframesink_onframe.dita b/en-US/dita/RTC-NG/API/callback_iaudiopcmframesink_onframe.dita
@@ -35,7 +35,7 @@
             <plentry>
                 <pt props="android cpp unreal bp electron unity cs rn flutter">frame</pt>
                 <pt props="apple">audioFrame</pt>
-                <pd><ph>The audio frame information. </ph><ph props="android apple">See <ph keyref="AudioFrame"/></ph>. <ph props="cpp unreal bp unity cs electron rn flutter">See <ph keyref="AudioPcmFrame"/></ph>.</pd>
+                <pd><ph>The audio frame information. </ph><ph props="android apple">See <ph keyref="AudioFrame"/>. </ph><ph props="cpp unreal bp unity cs electron rn flutter">See <ph keyref="AudioPcmFrame"/>.</ph></pd>
             </plentry>
             <plentry props="ios mac">
                 <pt>playerKit</pt>

diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionstatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionstatechanged.dita
@@ -53,7 +53,7 @@
             <plentry id="state">
                 <pt>state</pt>
                 <pd>
-                    <p id="connectionstate">The current connection state. <ph props="ios mac cpp unreal bp unity flutter electron rn cs">See <xref keyref="CONNECTION_STATE_TYPE" /></ph>.</p>
+                    <p id="connectionstate">The current connection state. <ph props="ios mac cpp unreal bp unity flutter electron rn cs">See <xref keyref="CONNECTION_STATE_TYPE" />.</ph></p>
                     <ul props="android">
                     <li><ph keyref="CONNECTION_STATE_DISCONNECTED" />(1): The SDK is disconnected from Agora's edge server.</li>
                     <li><ph keyref="CONNECTION_STATE_CONNECTING" />(2): The SDK is connecting to Agora's edge server.</li>

diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideotranscodererror.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideotranscodererror.dita
@@ -54,7 +54,7 @@
             <plentry>
                 <pt props="android cpp framework">error</pt>
                 <pt props="apple">errorCode</pt>
-                <pd>The reason for local video mixing error. <ph props="apple cpp framework">See <xref keyref="VIDEO_TRANSCODER_ERROR"/></ph>.</pd>
+                <pd>The reason for local video mixing error. <ph props="apple cpp framework">See <xref keyref="VIDEO_TRANSCODER_ERROR"/>.</ph></pd>
                 <pd props="android">The reason for local video mixing error:<ul>
                         <li>1: The selected video source has not started video capture. You need to create a video track for it and start video capture.</li>
                         <li>2: The video source type is invalid. You need to re-specify the supported video source type.</li>

diff --git a/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita b/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita
@@ -213,7 +213,7 @@
       <plentry props="android ios cpp unreal bp unity rn flutter cs">
         <pt>cameraDirection</pt>
         <pd>
-          <note type="attention" props="cpp unreal bp unity rn flutter">This parameter applies to Android and iOS only.</note><ph>The camera direction. </ph><ph props="ios cpp unreal bp unity android rn flutter cs">See <xref keyref="CAMERA_DIRECTION" /></ph>.</pd>
+          <note type="attention" props="cpp unreal bp unity rn flutter">This parameter applies to Android and iOS only.</note><ph>The camera direction. </ph><ph props="ios cpp unreal bp unity android rn flutter cs">See <xref keyref="CAMERA_DIRECTION" />.</ph></pd>
       </plentry>
       <plentry props="cpp unreal bp android unity electron rn flutter cs">
         <pt props="cpp unreal bp unity electron rn flutter cs">format</pt>

diff --git a/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita b/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita
@@ -373,7 +373,7 @@
             </plentry>
             <plentry>
                 <pt>streamType</pt>
-                <pd><ph>The type of video streams. </ph><ph props="apple cpp unreal bp unity electron flutter rn cs">See <xref keyref="VIDEO_STREAM_TYPE" /></ph>.</pd>
+                <pd><ph>The type of video streams. </ph><ph props="apple cpp unreal bp unity electron flutter rn cs">See <xref keyref="VIDEO_STREAM_TYPE" />.</ph></pd>
                 <pd props="android">
                     <ul>
                       <li><ph keyref="VIDEO_STREAM_HIGH" />(0): High-quality stream, that is, a high-resolution and high-bitrate video stream.</li>

diff --git a/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita b/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita
@@ -278,7 +278,7 @@
             <plentry>
                 <pt>quality</pt>
                 <pd>
-                    <p>The quality of the audio stream sent by the user. <ph props="ios mac cpp unreal bp electron rn unity flutter cs">See <xref keyref="QUALITY_TYPE" /></ph>.</p>
+                    <p>The quality of the audio stream sent by the user. <ph props="ios mac cpp unreal bp electron rn unity flutter cs">See <xref keyref="QUALITY_TYPE" />.</ph></p>
                     <p props="android">
                     <ul id="qualitytype">
                     <li><ph keyref="QUALITY_UNKNOWN" />(0): The quality is unknown.</li>

diff --git a/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita b/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita
@@ -171,7 +171,7 @@
             </plentry>
             <plentry>
                 <pt>position</pt>
-                <pd><ph>The position of a window relative to the entire screen space (including all shareable screens). </ph><ph props="cpp unreal bp unity electron flutter">See <xref keyref="Rectangle" /></ph>. <ph props="mac">See <xref keyref="rect-link" /></ph>.</pd>
+                <pd><ph>The position of a window relative to the entire screen space (including all shareable screens). </ph><ph props="cpp unreal bp unity electron flutter">See <xref keyref="Rectangle" />. </ph><ph props="mac">See <xref keyref="rect-link" />.</ph></pd>
             </plentry>
             <plentry props="cpp unreal bp flutter rn electron">
                 <pt>minimizeWindow</pt>

diff --git a/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita b/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita
@@ -77,7 +77,7 @@
             <parml>
             <plentry>
                 <pt>dimensions</pt>
-                <pd><ph>The video dimension. </ph><ph props="android cpp unreal bp unity electron rn flutter cs">See <xref keyref="VideoDimensions" /></ph>. <ph>The default value is 160 × 120.</ph></pd>
+                <pd><ph>The video dimension. </ph><ph props="android cpp unreal bp unity electron rn flutter cs">See <xref keyref="VideoDimensions" />. </ph><ph>The default value is 160 × 120.</ph></pd>
             </plentry>
             <plentry>
                 <pt props="android apple">bitrate</pt>

diff --git a/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita b/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita
@@ -67,7 +67,7 @@
                 <pt props="ios mac">audioSpectrumData</pt>
                 <pt props="cpp unreal bp unity electron flutter cs">spectrumData</pt>
                 <pd>
-                    <p>Audio spectrum information of the remote user. <ph props="android cpp unreal bp unity electron flutter cs">See <xref keyref="AudioSpectrumData" /></ph>.</p>
+                    <p>Audio spectrum information of the remote user. <ph props="android cpp unreal bp unity electron flutter cs">See <xref keyref="AudioSpectrumData" />.</ph></p>
                 </pd>
             </plentry>
             </parml> </section>

diff --git a/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita b/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita
@@ -474,7 +474,7 @@
             <plentry>
                 <pt>bitrate</pt>
                 <pd>
-                    <p><ph>The encoding bitrate (Kbps) of the video. </ph><ph props="unity cs">See <xref keyref="BITRATE" /></ph>.</p>
+                    <p><ph>The encoding bitrate (Kbps) of the video. </ph><ph props="unity cs">See <xref keyref="BITRATE" />.</ph></p>
                     <ul props="native unreal bp flutter">
                     <li><option keyref="STANDARD_BITRATE" />(0): (Recommended) Standard bitrate mode. In this mode, the bitrates of the live broadcasting profile is higher than that of the communication profile. See <xref keyref="video-profile-table" />.</li>
                     <li><option keyref="COMPATIBLE_BITRATE" />(-1): Adaptive bitrate mode. In this mode, the bitrates of the live broadcasting profile equals that of the communication profile. If this mode is selected, the video frame rate of live broadcasting scenarios may be lower than the set value.</li>

diff --git a/en-US/dita/RTC-NG/API/enum_bitrate.dita b/en-US/dita/RTC-NG/API/enum_bitrate.dita
@@ -9,7 +9,7 @@
             <parml>
             <plentry>
                 <pt><ph keyref="STANDARD_BITRATE"/></pt>
-                <pd><ph>0: (Recommended) Standard bitrate mode. In this mode, the bitrates of the live broadcasting profile is higher than that of the communication profile. </ph><ph props="native unreal bp">See <xref keyref="video-profile"/></ph>.</pd>
+                <pd><ph>0: (Recommended) Standard bitrate mode. In this mode, the bitrates of the live broadcasting profile is higher than that of the communication profile. </ph><ph props="native unreal bp">See <xref keyref="video-profile"/>.</ph></pd>
             </plentry>
             <plentry>
                 <pt><ph keyref="COMPATIBLE_BITRATE"/></pt>

diff --git a/en-US/dita/RTC-NG/API/enum_featuretype.dita b/en-US/dita/RTC-NG/API/enum_featuretype.dita
@@ -2,7 +2,7 @@
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
 <reference id="enum_featuretype">
     <title><ph keyref="FeatureType"/></title>
-    <shortdesc id="short"><ph id="shortdesc">The name of the advanced feature.</ph></shortdesc>
+    <shortdesc id="short"><ph id="shortdesc">The type of the advanced feature.</ph></shortdesc>
     <refbody>
         <section id="detailed_desc">
             <dl outputclass="since">