Merge branch 'master' of github.com:AgoraIO/agora_doc_source

AgoraIO · Nov 25, 2024 · 8df70b4 · 8df70b4
2 parents 097ec40 + b5c5c1c
commit 8df70b4
Show file tree

Hide file tree

Showing 23 changed files with 91 additions and 44 deletions.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setexternalmediaprojection.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setexternalmediaprojection.dita
@@ -30,7 +30,7 @@
                 <dd>v4.5.0</dd>
             </dlentry>
             </dl>
-             <note type="attention" props="cpp">This method is for Android only.</note> 
+             <note type="attention" props="cpp unreal unity rn flutter">This method is for Android only.</note>
             <p>After successfully calling this method, the external <codeph>MediaProjection</codeph> you set will replace the <codeph>MediaProjection</codeph> requested by the SDK to capture the screen video stream.</p>
             <p>When the screen sharing is stopped or <xref keyref="IRtcEngine"/> is destroyed, the SDK will automatically release the MediaProjection.</p>
         </section>
@@ -44,7 +44,7 @@
         <section id="timing" deliveryTarget="details">
             <title>Call timing</title>
             <p>Call this method after <xref keyref="startScreenCapture"/>.</p>
-        </section>        
+        </section>
         <section id="restriction" deliveryTarget="details">
             <title>Restrictions</title>
             <p>Before calling this method, you must first apply for <codeph>MediaProjection</codeph> permission.</p>

diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setfiltereffectoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setfiltereffectoptions.dita
@@ -48,7 +48,7 @@
         <section id="timing" deliveryTarget="details">
             <title>Call timing</title>
             <p>Call this method after calling <xref keyref="enableVideo" />.</p>
-        </section>        
+        </section>
         <section id="restriction" deliveryTarget="details">
             <title>Restrictions</title>
                 <ul>

diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendertargetfps.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendertargetfps.dita
@@ -48,7 +48,7 @@ targetFps:(int)targetFps;</codeblock>
         <section id="timing" deliveryTarget="details">
             <title>Call timing</title>
             <p>You can call this method either before or after joining a channel.</p>
-        </section>        
+        </section>
         <section id="restriction" deliveryTarget="details">
             <title>Restrictions</title>
             <p>None.</p>

diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita
@@ -48,15 +48,15 @@
         <section id="timing" deliveryTarget="details">
             <title>Call timing</title>
             <p>Call this method after calling <xref keyref="enableVideo"/>.</p>
-        </section>        
+        </section>
         <section id="restriction" deliveryTarget="details">
             <title>Restrictions</title>
             <ul>
                 <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>Dark light enhancement has certain requirements for equipment performance. The low-light enhancement feature has certain performance requirements on devices. If your device overheats after you enable low-light enhancement, Agora recommends modifying the low-light enhancement options to a less performance-consuming level or disabling low-light enhancement entirely.</li>
                 <li>If you want to prioritize image quality (<ph keyref="LOW_LIGHT_ENHANCE_LEVEL_HIGH_QUALITY"/>) when using the low-light enhancement function, you need to first call <xref keyref="setVideoDenoiserOptions"/> to achieve video noise reduction, the specific corresponding relationship is as follows:<ul>
-                        <li>When low light enhancement is set to automatic mode (<ph keyref="LOW_LIGHT_ENHANCE_AUTO"/>), video noise reduction needs to be set to prioritize image quality (<ph keyref="VIDEO_DENOISER_LEVEL_HIGH_QUALITY" />) and automatic mode (<ph keyref="VIDEO_DENOISER_AUTO" />).</li>    
-                        <li>When low-light enhancement is set to manual mode (<ph keyref="LOW_LIGHT_ENHANCE_MANUAL"/>), video noise reduction needs to be set to prioritize image quality (<ph keyref="VIDEO_DENOISER_LEVEL_HIGH_QUALITY" />) and manual mode (<ph keyref="VIDEO_DENOISER_MANUAL" />).</li>    
+                        <li>When low light enhancement is set to automatic mode (<ph keyref="LOW_LIGHT_ENHANCE_AUTO"/>), video noise reduction needs to be set to prioritize image quality (<ph keyref="VIDEO_DENOISER_LEVEL_HIGH_QUALITY" />) and automatic mode (<ph keyref="VIDEO_DENOISER_AUTO" />).</li>
+                        <li>When low-light enhancement is set to manual mode (<ph keyref="LOW_LIGHT_ENHANCE_MANUAL"/>), video noise reduction needs to be set to prioritize image quality (<ph keyref="VIDEO_DENOISER_LEVEL_HIGH_QUALITY" />) and manual mode (<ph keyref="VIDEO_DENOISER_MANUAL" />).</li>
                     </ul>
                 </li>
             </ul>

diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions2.dita
@@ -43,10 +43,6 @@
                 <pt/>
                 <pd/>
             </plentry>
-            <plentry props="cpp unreal bp rn unity electron flutter cs" id="type">
-                <pt>type</pt>
-                <pd>The type of the video source. See <xref keyref="MEDIA_SOURCE_TYPE"/>.</pd>
-            </plentry>
             <plentry conkeyref="enableVirtualBackground2/sourcetype">
                 <pt/>
                 <pd/>

diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendertargetfps.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendertargetfps.dita
@@ -40,7 +40,7 @@
         <section id="timing" deliveryTarget="details">
             <title>Call timing</title>
             <p>You can call this method either before or after joining a channel.</p>
-        </section>        
+        </section>
         <section id="restriction" deliveryTarget="details">
             <title>Restrictions</title>
             <p>None.</p>

diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita
@@ -55,7 +55,7 @@
         <section id="timing" deliveryTarget="details">
             <title>Call timing</title>
             <p>Call this method after calling <xref keyref="enableVideo"/>.</p>
-        </section>        
+        </section>
         <section id="restriction" deliveryTarget="details">
             <title>Restrictions</title>
             <ul>

diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions2.dita
@@ -44,10 +44,6 @@
                 <pt/>
                 <pd/>
             </plentry>
-            <plentry props="cpp unreal bp rn unity electron flutter cs" conkeyref="setVideoDenoiserOptions/type">
-                <pt/>
-                <pd/>
-            </plentry>
             <plentry conkeyref="enableVirtualBackground2/sourcetype">
                 <pt/>
                 <pd/>

diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startlocalaudiomixer.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startlocalaudiomixer.dita
@@ -47,7 +47,7 @@
         <section id="timing" deliveryTarget="details">
             <title>Call timing</title>
             <p>You can call this method either before or after joining a channel.</p>
-        </section>        
+        </section>
         <section id="restriction" deliveryTarget="details">
             <title>Restrictions</title>
             <p>To ensure audio quality, it is recommended that the number of audio streams to be mixed does not exceed 10.</p>

diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stoplocalaudiomixer.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stoplocalaudiomixer.dita
@@ -36,7 +36,7 @@
         <section id="timing" deliveryTarget="details">
             <title>Call timing</title>
             <p>Call this method after <apiname keyref="startLocalAudioMixer"/>.</p>
-        </section>        
+        </section>
         <section id="restriction" deliveryTarget="details">
             <title>Restrictions</title>
             <p>None.</p>

diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_takesnapshot2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_takesnapshot2.dita
@@ -32,10 +32,10 @@
         <section id="timing" deliveryTarget="details">
             <title>Call timing</title>
             <p>Call this method after joining a channel.</p>
-        </section>        
+        </section>
         <section id="restriction" deliveryTarget="details">
             <title>Restrictions</title>
-            <ul>            
+            <ul>
                 <li id="desc2" props="native unreal bp unity electron flutter cs">The method is asynchronous, and the SDK has not taken the snapshot when the method call returns.</li>
                 <li props="rn">The SDK has not taken the snapshot when the method call returns.</li>
                 <li>When used for local video snapshots, this method takes a snapshot for the video streams specified in <xref keyref="ChannelMediaOptions"/>.</li>

diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatelocalaudiomixerconfiguration.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatelocalaudiomixerconfiguration.dita
@@ -41,7 +41,7 @@
         <section id="timing" deliveryTarget="details">
             <title>Call timing</title>
             <p>Call this method after <apiname keyref="startLocalAudioMixer"/>.</p>
-        </section>        
+        </section>
         <section id="restriction" deliveryTarget="details" conkeyref="startLocalAudioMixer/restriction">
             <title>Restrictions</title>
         </section>

diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_takesnapshotex2.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_takesnapshotex2.dita
@@ -40,7 +40,7 @@
         <section id="timing" deliveryTarget="details">
             <title>Call timing</title>
             <p>Call this method after <xref keyref="joinChannelEx"/>.</p>
-        </section>        
+        </section>
         <section id="restriction" deliveryTarget="details"  conkeyref="takeSnapshot/restriction"/>
         <section id="related" deliveryTarget="details" conkeyref="takeSnapshot/related"/>
         <section id="parameters" deliveryTarget="details">

diff --git a/en-US/dita/RTC-NG/API/class_audiotrackconfig.dita b/en-US/dita/RTC-NG/API/class_audiotrackconfig.dita
@@ -86,7 +86,7 @@ struct FAudioTrackConfig
             </ul>
         </pd>
       </plentry>
-      <plentry>
+      <plentry props="cpp apple android unreal unity cs flutter rn electron">
         <pt>enableAudioProcessing</pt>
         <pd>Whether to enable audio processing module:<ul>
                 <li><codeph><ph keyref="true"/></codeph>Enable the audio processing module to apply the Automatic Echo Cancellation (AEC), Automatic Noise Suppression (ANS), and Automatic Gain Control (AGC) effects.</li>

diff --git a/en-US/dita/RTC-NG/API/class_externalvideoframe.dita b/en-US/dita/RTC-NG/API/class_externalvideoframe.dita
@@ -516,7 +516,7 @@ class ExternalVideoFrame {
                 <pt props="ios mac">time</pt>
                 <pd>Timestamp (ms) of the incoming video frame. An incorrect timestamp results in frame loss or unsynchronized audio and video.</pd>
             </plentry>
-            <plentry props="apple cpp" conkeyref="VideoFrame/colorspace">
+            <plentry conkeyref="VideoFrame/colorspace" props="cpp apple unreal unity cs flutter rn electron">
                 <pt/>
                 <pd/>
             </plentry>

diff --git a/en-US/dita/RTC-NG/API/class_filtereffectoptions.dita b/en-US/dita/RTC-NG/API/class_filtereffectoptions.dita
@@ -77,4 +77,4 @@ LUT_3D_SIZE 32
             </plentry>
             </parml> </section>
     </refbody>
-</reference>
+</reference>
diff --git a/en-US/dita/RTC-NG/API/class_localaudiomixerconfiguration.dita b/en-US/dita/RTC-NG/API/class_localaudiomixerconfiguration.dita
@@ -97,7 +97,7 @@ public:
         <section id="parameters">
             <title><text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/></title>
             <parml>
-            <plentry props="cpp">
+            <plentry props="cpp unreal electron unity cs rn flutter">
                     <pt>streamCount</pt>
                     <pd>The number of the audio streams that are mixed locally.</pd>
                 </plentry>

diff --git a/en-US/dita/RTC-NG/API/class_snapshotconfig.dita b/en-US/dita/RTC-NG/API/class_snapshotconfig.dita
@@ -78,4 +78,4 @@ public:
             </plentry>
             </parml> </section>
     </refbody>
-</reference>
+</reference>
diff --git a/en-US/dita/RTC-NG/API/class_videodenoiseroptions.dita b/en-US/dita/RTC-NG/API/class_videodenoiseroptions.dita
@@ -127,4 +127,4 @@ public:
             </plentry>
             </parml> </section>
     </refbody>
-</reference>
+</reference>
diff --git a/en-US/dita/RTC-NG/API/class_videoframe.dita b/en-US/dita/RTC-NG/API/class_videoframe.dita
@@ -873,7 +873,7 @@ class VideoFrame {
           <pt>pixelBuffer</pt>
           <pd>Fills the data to CVPixelBuffer.</pd>
         </plentry>
-        <plentry id="colorspace">
+        <plentry id="colorspace" props="cpp ios mac android unreal unity cs flutter rn electron">
             <pt>colorSpace</pt>
             <pd props="ios mac cpp cs unity flutter electron rn unreal bp">By default, the color space properties of video frames will apply the Full Range and BT.709 standard configurations. You can configure the settings according your needs for custom video capturing and rendering. See <xref
             keyref="videocolorspace-link"/>.</pd>