Merge pull request #3608 from AgoraIO/translation/4.x-api-ref

New YiCAT updates

en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_removeremoteposition.dita

@@ -27,7 +27,7 @@
         <section id="detailed_desc">
             <title>Details</title>
             <p>After successfully calling this method, the local user no longer hears the specified remote user.</p>
-            <p>After leaving the channel, to avoid wasting resources, you can also call this method to delete the spatial position of the specified remote user.</p>
+            <p>After leaving the channel, to avoid wasting computing resources, call this method to delete the spatial position information of the specified remote user. Otherwise, the user's spatial position information will be saved continuously. When the number of remote users exceeds the number of audio streams that can be received as set in <xref keyref="setMaxAudioRecvCount"/>, the system automatically unsubscribes from the audio stream of the user who is furthest away based on relative distance.</p>
         </section>
         <section id="parameters">
             <title>Parameters</title>

en-US/dita/RTC-NG/API/api_irtcengine_addvideowatermark.dita

@@ -33,7 +33,7 @@
                 <dd>This method is deprecated. Use <xref keyref="addVideoWatermark2" /> instead.</dd>
             </dlentry>
             </dl>
-            <p>This method adds a PNG watermark image to the local video stream in a live streaming session. Once the watermark image is added, all the users in the channel (CDN audience included) and the video capturing device can see and capture it. If you only want to add a watermark to the CDN live streaming, see descriptions in <xref keyref="setLiveTranscoding" />.</p>
+            <p>This method adds a PNG watermark image to the local video stream in a live streaming session. Once the watermark image is added, all the users in the channel (CDN audience included) and the video capturing device can see and capture it. If you only want to add a watermark to the CDN live streaming, see descriptions in <xref keyref="startRtmpStreamWithTranscoding" />.</p>
             <note type="attention">
             <ul>
             <li>The URL descriptions are different for the local video and CDN live streaming: In a local video stream, URL refers to the absolute path of the added watermark image file in the local video stream. In a CDN live stream, URL refers to the URL address of the added watermark image in the CDN live streaming.</li>

en-US/dita/RTC-NG/API/api_irtcengine_addvideowatermark2.dita

@@ -42,7 +42,7 @@
             <note type="attention">
             <ul>
             <li>Ensure that calling this method after <xref keyref="enableVideo"/>.</li>
-            <li>If you only want to add a watermark to the media push, you can call this method or the <xref keyref="setLiveTranscoding"/> method.</li>
+            <li>If you only want to add a watermark to the media push, you can call this method or the <xref keyref="startRtmpStreamWithTranscoding"/> method.</li>
             <li>This method supports adding a watermark image in the PNG file format only. Supported pixel formats of the PNG image are RGBA, RGB, Palette, Gray, and Alpha_gray.</li>
             <li>If the dimensions of the PNG image differ from your settings in this method, the image will be cropped or zoomed to conform to your settings.</li>
             <li>If you have enabled the mirror mode for the local video, the watermark on the local video is also mirrored. To avoid mirroring the watermark, Agora recommends that you do not use the mirror and watermark functions for the local video at the same time. You can implement the watermark function in your application layer.</li>

en-US/dita/RTC-NG/API/api_irtcengine_muteallremoteaudiostreams.dita

@@ -24,15 +24,20 @@
             <codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; muteAllRemoteAudioStreams(bool mute);</codeblock>
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
-        <section id="detailed_desc">
-            <title>Details</title>
+        <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
             <p id="desc">After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all remote users, including all subsequent users.</p>
             <note type="attention" id="note">
-            <ul>
-            <li>Call this method after joining a channel.</li>
-            <li>If you do not want to subscribe the audio streams of remote users before joining a channel, you can set <parmname>autoSubscribeAudio</parmname> as <codeph><ph keyref="false"/></codeph> when calling <xref keyref="joinChannel2"/>.</li>
-            <li props="hide"><ph>See recommended settings in <xref keyref="guide-set-subscribing-state">Set the Subscribing State</xref>.</ph></li>
-            </ul> </note> </section>
+            <p>By default, the SDK subscribes to the audio streams of all remote users when joining a channel. To modify this behavior, you can set <parmname>autoSubscribeAudio</parmname> to <codeph><ph keyref="false"/></codeph> when calling <xref keyref="joinChannel2"/> to join the channel, which will cancel the subscription to the audio streams of all users upon joining the channel.</p>
+            </note>
+        </section>
+        <section id="timing" deliveryTarget="details">
+            <title>Call timing</title>
+            <p>Call this method after joining a channel.</p>
+        </section>        
+        <section id="restriction" deliveryTarget="details">
+            <title>Restrictions</title>
+            <p>If you call this method and then call <xref keyref="enableAudio"/> or <xref keyref="disableAudio"/>, the latest call will prevail.</p>
+        </section>
         <section id="parameters">
             <title>Parameters</title>
             <parml>

en-US/dita/RTC-NG/API/api_irtcengine_muteallremotevideostreams.dita

@@ -24,13 +24,20 @@
             <codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; muteAllRemoteVideoStreams(bool mute);</codeblock>
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
-        <section id="detailed_desc">
-            <title>Details</title>
+        <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
             <p id="desc">After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all remote users, including all subsequent users.</p>
-            <note type="attention" id="note"><ul>
-                <li>Call this method after joining a channel.</li>
-                <li>If you do not want to subscribe the video streams of remote users before joining a channel, you can call <xref keyref="joinChannel2"/> and set <parmname>autoSubscribeVideo</parmname> as <codeph><ph keyref="false"/></codeph>.</li>
-            </ul></note>
+            <note type="attention" id="note">
+                <p>By default, the SDK subscribes to the video streams of all remote users when joining a channel. To modify this behavior, you can set <parmname>autoSubscribeVideo</parmname> to<codeph><ph keyref="false"/></codeph> when calling <xref keyref="joinChannel2"/> to join the channel, which will cancel the subscription to the video streams of all users upon joining the channel.</p>
+            </note>
+        </section>
+        <section id="timing" deliveryTarget="details">
+            <title>Call timing</title>
+            <p>Call this method after joining a channel.</p>
+            <note type="attention">If you call <apiname keyref="muteAllRemoteVideoStreams"/>(<codeph><ph keyref="true"/></codeph>) after leaving the channel, you will not subscribe to any user's video stream the next time you join the channel.</note>
+        </section>        
+        <section id="restriction" deliveryTarget="details">
+            <title>Restrictions</title>
+            <p>If you call this method and then call <xref keyref="enableVideo"/> or <xref keyref="disableVideo"/>, the latest call will prevail.</p>
         </section>
         <section id="parameters">
             <title>Parameters</title>

en-US/dita/RTC-NG/API/api_irtcengine_mutelocalaudiostream.dita

@@ -24,10 +24,21 @@
             <codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; muteLocalAudioStream(bool mute);</codeblock>
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
-        <section id="detailed_desc">
-            <title>Details</title>
-            <note type="attention">This method does not affect any ongoing audio recording, because it does not disable the audio capture device.</note> 
-            <p>A successful call of this method triggers the <xref keyref="onUserMuteAudio"/> and <xref keyref="onRemoteAudioStateChanged"/> callbacks on the remote client.</p></section>
+        <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
+            <p>This method is used to control whether to publish the locally captured audio stream. If you call this method to stop publishing locally captured audio streams, the audio capturing device will still work and won't be affected.</p>
+        </section>
+        <section id="timing" deliveryTarget="details">
+            <title>Call timing</title>
+            <p>It can be called either before or after joining the channel.</p>
+        </section>        
+        <section id="restriction" deliveryTarget="details">
+            <title>Restrictions</title>
+            <p>None.</p>
+        </section>
+        <section id="related" deliveryTarget="details">
+            <title>Related callbacks</title>
+            <p>After successfully calling this method, the local end triggers callback <xref keyref="onAudioPublishStateChanged"/>; the remote end triggers <xref keyref="onUserMuteAudio"/> and <xref keyref="onRemoteAudioStateChanged"/> callbacks.</p>
+        </section>
         <section id="parameters">
             <title>Parameters</title>
             <parml>

en-US/dita/RTC-NG/API/api_irtcengine_mutelocalvideostream.dita

@@ -24,14 +24,22 @@
             <codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; muteLocalVideoStream(bool mute);</codeblock>
             <codeblock props="reserve" outputclass="language-cpp"/></p>
         </section>
-        <section id="detailed_desc">
-            <title>Details</title>
-            <p>A successful call of this method triggers the <xref keyref="onUserMuteVideo"/> callback on the remote client.</p>
-            <note type="attention">
-            <ul id="ul_ogk_hwc_f4b">
-            <li>This method executes faster than the <xref keyref="enableLocalVideo"/>(<codeph><ph keyref="false"/></codeph>) method, which controls the sending of the local video stream.</li>
-            <li>This method does not affect any ongoing video recording, because it does not disable the camera.</li>
-            </ul> </note> </section>
+        <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
+            <p>This method is used to control whether to publish the locally captured video stream. If you call this method to stop publishing locally captured video streams, the video capturing device will still work and won't be affected.</p>
+            <p>Compared to <xref keyref="enableLocalVideo"/>(<codeph><ph keyref="false"/></codeph>), which can also cancel the publishing of local video stream by turning off the local video stream capture, this method responds faster.</p>
+            </section>
+        <section id="timing" deliveryTarget="details">
+            <title>Call timing</title>
+            <p>It can be called either before or after joining the channel.</p>
+        </section>        
+        <section id="restriction" deliveryTarget="details">
+            <title>Restrictions</title>
+            <p>None.</p>
+        </section>
+        <section id="related" deliveryTarget="details">
+            <title>Related callbacks</title>
+            <p>After successfully calling this method, the local end triggers callback <xref keyref="onVideoPublishStateChanged"/>; the remote end triggers <xref keyref="onUserMuteVideo"/> and <xref keyref="onRemoteVideoStateChanged"/> callbacks.</p>
+        </section>
         <section id="parameters">
             <title>Parameters</title>
             <parml>

en-US/dita/RTC-NG/API/api_irtcengine_muteremoteaudiostream.dita

@@ -25,13 +25,20 @@
             <codeblock props="flutter" outputclass="language-dart">Future&lt;void> muteRemoteAudioStream({required int uid, required bool mute});</codeblock>
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
-        <section id="detailed_desc">
-            <title>Details</title>
-            <note type="attention">
-            <ul>
-            <li>Call this method after joining a channel.</li>
-            <li props="hide">See recommended settings in Set the Subscribing State.</li>
-            </ul> </note> </section>
+        <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
+        </section>
+        <section id="timing" deliveryTarget="details">
+            <title>Call timing</title>
+            <p>Call this method after joining a channel.</p>
+        </section>        
+        <section id="restriction" deliveryTarget="details">
+            <title>Restrictions</title>
+            <p>None.</p>
+        </section>
+        <section id="related" deliveryTarget="details">
+            <title>Related callbacks</title>
+            <p>After a successful method call, the SDK triggers the <xref keyref="onAudioSubscribeStateChanged"/> callback.</p>
+        </section>
         <section id="parameters">
             <title>Parameters</title>
             <parml>

en-US/dita/RTC-NG/API/api_irtcengine_muteremotevideostream.dita

@@ -25,13 +25,20 @@
             <codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; muteRemoteVideoStream({required int uid, required bool mute});</codeblock>
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
-        <section id="detailed_desc">
-            <title>Details</title>
-            <note type="attention">
-            <ul>
-            <li>Call this method after joining a channel.</li>
-            <li props="hide">See recommended settings in Set the Subscribing State.</li>
-            </ul> </note> </section>
+        <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
+        </section>
+        <section id="timing" deliveryTarget="details">
+            <title>Call timing</title>
+            <p>Call this method after joining a channel.</p>
+        </section>        
+        <section id="restriction" deliveryTarget="details">
+            <title>Restrictions</title>
+            <p>None.</p>
+        </section>
+        <section id="related" deliveryTarget="details">
+            <title>Related callbacks</title>
+            <p>After a successful method call, the SDK triggers the <xref keyref="onVideoSubscribeStateChanged"/> callback.</p>
+        </section>
         <section id="parameters">
             <title>Parameters</title>
             <parml>

en-US/dita/RTC-NG/API/api_irtcengine_querycamerafocallengthcapability.dita

@@ -35,6 +35,7 @@
             </dlentry>
             </dl>
             <p>If you want to enable the wide-angle or ultra-wide-angle mode for camera capture, it is recommended to start by calling this method to check whether the device supports the required focal length capability. Then, adjust the camera's focal length configuration based on the query result by calling <xref keyref="setCameraCapturerConfiguration"/>, ensuring the best camera capture performance.</p>
+            <note type="attention" props="android">For the specific implementation of querying camera focal length capabilities through this method, refer to the provided <xref keyref="focallength-link"/>.</note>
             <note type="attention" props="cpp unreal bp flutter unity">This method is for Android and iOS only.</note> </section>
         <section id="parameters" props="cpp unity">
             <title>Parameters</title>

en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita

@@ -2,7 +2,7 @@
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
 <reference id="api_irtcengine_querycodeccapability">
     <title><ph keyref="queryCodecCapability"/></title>
-    <shortdesc id="short"><ph id="shortdesc">Queries the current device's supported video codec capabilities.</ph></shortdesc>
+    <shortdesc id="short"><ph id="shortdesc">Queries the video codec capabilities of the SDK.</ph></shortdesc>
     <prolog>
         <metadata>
             <keywords>
@@ -40,10 +40,10 @@
             <plentry props="cpp unreal bp unity cs">
                 <pt>codecInfo</pt>
                 <pd>
-                        <p>Input and output parameter. An array representing the video codec capabilities of the device. See <xref keyref="CodecCapInfo"/>.</p>
+                        <p>Input and output parameter. An array representing the video codec capabilities of the SDK. See <xref keyref="CodecCapInfo"/>.</p>
                         <ul>
                             <li>Input value: One <apiname keyref="CodecCapInfo"/>defined by the user when executing this method, representing the video codec capability to be queried.</li>
-                            <li>Output value: The <apiname keyref="CodecCapInfo"/>after the method is executed, representing the actual video codec capabilities supported by the device.</li>
+                            <li>Output value: The <apiname keyref="CodecCapInfo"/> after the method is executed, representing the actual video codec capabilities of the SDK.</li>
                         </ul>
                     </pd>
             </plentry>