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

New YiCAT updates

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

@@ -46,7 +46,7 @@
             <parml>
             <plentry>
                 <pt>zones</pt>
-                <pd>Sound insulation area settings. See <apiname keyref="SpatialAudioZone"/>. When you set this parameter to <codeph><ph keyref="NULL"/></codeph>, it means clearing all sound insulation zones.<note type="attention" props="cpp unreal bp unity cs flutter electron">On the Windows platform, it is necessary to ensure that the number of members in the <parmname>zones</parmname> array is equal to the value of <parmname>zoneCount</parmname>; otherwise, it may cause a crash.</note></pd>
+                <pd>Sound insulation area settings. See <xref keyref="SpatialAudioZone"/>. When you set this parameter to <codeph><ph keyref="NULL"/></codeph>, it means clearing all sound insulation zones.<note type="attention" props="cpp unreal bp unity cs flutter electron">On the Windows platform, it is necessary to ensure that the number of members in the <parmname>zones</parmname> array is equal to the value of <parmname>zoneCount</parmname>; otherwise, it may cause a crash.</note></pd>
             </plentry>
             <plentry props="cpp framework">
                 <pt>zoneCount</pt>

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

@@ -32,7 +32,7 @@
         </section>
         <section id="detailed_desc">
             <title>Details</title>
-            <dl outputclass="deprecated" props="android hmos">
+            <dl outputclass="deprecated" props="android">
             <dlentry>
                 <dt>Deprecated:</dt>
                 <dd>If you need to push video frames in I422 format, you need to use this method; otherwise, use <xref keyref="pushVideoFrame3"/>.</dd>

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

@@ -30,20 +30,10 @@
  </section>
         <section id="detailed_desc">
             <title>Details</title>
-            <p>If you only want to observe encoded video frames (such as h.264 format) without decoding and rendering the video, Agora recommends that you implement one <xref keyref="IVideoEncodedFrameObserver"/> class through this method.</p>
-            <p id="mix">If you want to obtain the original video data of some remote users (referred to as group A) and the encoded video data of other remote users (referred to as group B), you can refer to the following steps:<ol>
-            <li>Call <xref keyref="registerVideoFrameObserver"/> to register the raw video frame observer before joining the channel.</li>
-            <li>Call <xref keyref="registerVideoEncodedFrameObserver"/> to register the encoded video frame observer before joining the channel.</li>
-            <li>After joining the channel, get the user IDs of group B users through <xref keyref="onUserJoined"/>, and then call <xref keyref="setRemoteVideoSubscriptionOptions"/> to set the <parmname>encodedFrameOnly</parmname> of this group of users to <codeph><ph keyref="true"/></codeph>.</li>
-            <li>Call <xref keyref="muteAllRemoteVideoStreams"/><codeph>(<ph keyref="false"/>)</codeph>to start receiving the video streams of all remote users. Then:<ul>
-                <li>The raw video data of group A users can be obtained through the callback in <xref keyref="IVideoFrameObserver"/>, and the SDK renders the data by default.</li>
-                <li>The encoded video data of group B users can be obtained through the callback in <xref keyref="IVideoEncodedFrameObserver"/>.</li>
-                </ul> </li>
-            </ol> </p>
+            <p>If you only want to observe encoded video frames (such as H.264 format) without decoding and rendering the video, Agora recommends that you implement one <xref keyref="IVideoEncodedFrameObserver"/> class through this method. <ph props="android cpp apple">For detailed implementation steps, please refer to <xref keyref="video-processing"/>.</ph></p>
             <note type="attention">
-            <ul>
-            <li>Call this method before joining a channel.</li>
-            </ul></note> </section>
+            <p>Call this method before joining a channel.</p>
+            </note> </section>
         <section id="parameters">
             <title>Parameters</title>
             <parml>

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

@@ -26,11 +26,10 @@
         <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
             <p>If you want to observe raw video frames (such as YUV or RGBA format), Agora recommends that you implement one <xref keyref="IVideoFrameObserver"/> class with this method.</p>
             <p>When calling this method to register a video observer, you can register callbacks in the <apiname keyref="IVideoFrameObserver"/> class as needed. After you successfully register the video frame observer, the SDK triggers the registered callbacks each time a video frame is received.</p>
-            <p conkeyref="registerVideoEncodedFrameObserver/mix"/>
         </section>
         <section id="scenario" deliveryTarget="details">
             <title>Applicable scenarios</title>
-            <p>After registering the raw video observer, you can use the obtained raw video data in various video pre-processing scenarios, such as virtual backgrounds and image enhacement by yourself.</p>
+            <p>After registering the raw video observer, you can use the obtained raw video data in various video pre-processing scenarios, such as virtual backgrounds and image enhacement by yourself. <ph props="android cpp apple">For detailed implementation steps, please refer to <xref keyref="video-processing"/>.</ph></p>
             <p props="android ios">Agora provides an open source sample project <xref keyref="beautyapi-link"/> on GitHub for your reference.</p>
         </section>
         <section id="timing" deliveryTarget="details">

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

@@ -41,7 +41,8 @@
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
-            <p>After calling this method to enable an external video source, you can call <xref keyref="pushVideoFrame"/> to push external video data to the SDK.</p>
+            <p props="android cpp apple framework">After calling this method to enable an external video source, you can call <xref keyref="pushVideoFrame"/> to push external video data to the SDK.</p>
+            <p props="hmos">After calling this method to enable an external video source, you can call <xref keyref="pushVideoFrame3"/> to push external video data to the SDK.</p>
         </section>
         <section id="timing" deliveryTarget="details">
             <title>Call timing</title>

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

@@ -40,7 +40,7 @@
             <li>&lt; 0: Failure. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph></li>
             </ul>
             <p props="electron rn flutter">The total duration (ms) of the media file.</p>
-        <ul props="apple android">
+        <ul props="apple android hmos">
             <li>If the method call succeeds, the SDK returns the total duration(ms) of the media file.</li>
             <li>&lt; 0: Failure. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph></li>
         </ul></section>

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

@@ -43,7 +43,7 @@
             <li>0: Success.</li>
             <li>&lt; 0: Failure. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph></li>
             </ul>
-        <ul props="electron rn flutter ios mac android">
+        <ul props="electron rn flutter ios mac android hmos">
             <li><codeph><ph keyref="true" /></codeph>: Reports whether the media resource is muted.</li>
             <li><codeph><ph keyref="false" /></codeph>: Reports whether the media resource is muted.</li></ul></section>
     </refbody>

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

@@ -42,7 +42,7 @@
             <li>0: Success.</li>
             <li>&lt; 0: Failure. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph></li>
             </ul>
-            <p props="android apple electron rn flutter">The local playback volume, which ranges from 0 to 100.<ul>
+            <p props="android hmos apple electron rn flutter">The local playback volume, which ranges from 0 to 100.<ul>
             <li>0: Mute.</li>
             <li>100: (Default) The original volume.</li>
             </ul></p> </section>

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

@@ -39,7 +39,7 @@
             <li>0: Success.</li>
             <li>&lt; 0: Failure. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph></li>
             </ul>
-            <ul props="android ios mac rn electron flutter">
+            <ul props="android hmos ios mac rn electron flutter">
             <li>≥ 0: The remote playback volume.</li>
             <li>&lt; 0: Failure. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph></li>
             </ul> </section>

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

@@ -40,7 +40,7 @@
             <plentry>
                 <pt>index</pt>
                 <pd props="cpp unreal bp unity cs">The index of the media stream. This parameter needs to be less than the <parmname>count</parmname> parameter of <xref keyref="getStreamCount" />.</pd>
-                <pd props="android ios mac rn electron flutter">The index of the media stream. This parameter must be less than the return value of <xref keyref="getStreamCount" />.</pd>
+                <pd props="android hmos ios mac rn electron flutter">The index of the media stream. This parameter must be less than the return value of <xref keyref="getStreamCount" />.</pd>
             </plentry>
             <plentry props="cpp unreal bp unity cs">
                 <pt>info</pt>

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

@@ -51,7 +51,7 @@
         <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. 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 props="android cpp unreal rn electron">
+            <ul props="android hmos cpp unreal rn electron">
             <li>0: Success.</li>
             <li>&lt; 0: Failure. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph></li>
             </ul>

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

@@ -38,7 +38,7 @@
             <parml>
             <plentry>
                 <pt>mode</pt>
-                <pd><ph>The channel mode. </ph><ph props="cpp unreal bp mac ios unity flutter rn electron cs">See <xref keyref="AUDIO_DUAL_MONO_MODE" />.</ph><ul props="android hmos">
+                <pd><ph>The channel mode. </ph><ph props="hmos cpp unreal bp mac ios unity flutter rn electron cs">See <xref keyref="AUDIO_DUAL_MONO_MODE" />.</ph><ul props="android">
                     <li><ph keyref="AUDIO_DUAL_MONO_STEREO" />(0): Original mode.</li>
                     <li><ph keyref="AUDIO_DUAL_MONO_L" />(1): Left channel mode. This mode replaces the audio of the right channel with the audio of the left channel, which means the user can only hear the audio of the left channel.</li>
                     <li><ph keyref="AUDIO_DUAL_MONO_R" />(2): Right channel mode. This mode replaces the audio of the left channel with the audio of the right channel, which means the user can only hear the audio of the right channel.</li>

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

@@ -31,10 +31,14 @@
         <section id="parameters">
             <title>Parameters</title>
             <parml>
-            <plentry conkeyref="setAudioMixingPitch/pitch">
+            <plentry conkeyref="setAudioMixingPitch/pitch" props="android cpp apple framework">
                 <pt />
                 <pd />
             </plentry>
+            <plentry id="pitch" props="hmos">
+                <pt>pitch</pt>
+                <pd>Sets the pitch of the local music file by the chromatic scale. The default value is 0, which means keeping the original pitch. The value ranges from -12 to 12, and the pitch value between consecutive values is a chromatic value. The greater the absolute value of this parameter, the higher or lower the pitch of the local music file.</pd>
+            </plentry>
             </parml> </section>
         <section id="return_values">
             <title><ph keyref="return-section-title"/></title>
@@ -44,4 +48,4 @@
             <li>&lt; 0: Failure. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph></li>
             </ul> </section>
     </refbody>
-</reference>
+</reference>

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

@@ -32,7 +32,7 @@
             <parml>
             <plentry>
                 <pt props="cpp unreal bp unity flutter rn electron cs">renderMode</pt>
-                <pt props="android ios mac">mode</pt>
+                <pt props="android hmos ios mac">mode</pt>
                 <pd>
                     <p props="ios mac cpp unreal bp unity flutter rn electron cs">Sets the render mode of the view. See <xref keyref="RENDER_MODE_TYPE" />.</p>
                     <p props="android hmos">Sets the render mode of the view:<ul conkeyref="setLocalRenderMode2/rendermodetype">

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

@@ -1,12 +1,12 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
 <reference id="api_imediarecorder_enablemainqueuedispatch">
-    <title><ph keyref="enableMainQueueDispatch" /></title>
+    <title><ph keyref="enableMainQueueDispatch_IMediaRecorder"/></title>
     <shortdesc id="short"><ph id="shortdesc">Enables/Disables dispatching delegate methods to the main queue.</ph></shortdesc>
     <prolog>
         <metadata>
             <keywords>
-                <indexterm keyref="enableMainQueueDispatch" />
+                <indexterm keyref="enableMainQueueDispatch_IMediaRecorder"/>
             </keywords>
         </metadata>
     </prolog>
@@ -25,7 +25,7 @@
         </section>
         <section id="detailed_desc">
             <title>Details</title>
-            <p>If disabled, the app should dispatch UI operations to the main queue.</p>
+            <p id="desc">If disabled, the app should dispatch UI operations to the main queue.</p>
         </section>
         <section id="parameters">
             <title>Parameters</title>
@@ -34,8 +34,8 @@
                 <pt>enabled</pt>
                 <pd>
                     <ul>
-                        <li><codeph><ph keyref="true" /></codeph>: Dispatch delegate methods to the main queue.</li>
-                        <li><codeph><ph keyref="false" /></codeph>: Do not dispatch delegate methods to the main queue.</li>
+                        <li><codeph><ph keyref="true"/></codeph>: Dispatch delegate methods to the main queue.</li>
+                        <li><codeph><ph keyref="false"/></codeph>: Do not dispatch delegate methods to the main queue.</li>
                     </ul>
                 </pd>
             </plentry>
@@ -44,8 +44,8 @@
             <title>Returns</title>
             <ul>
             <li>0: Success.</li>
-            <li>&lt; 0: Failure.</li>
+            <li>&lt; 0: Failure. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph></li>
             </ul>
         </section>
     </refbody>
-</reference>
+</reference>

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

@@ -1,12 +1,12 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
 <reference id="api_imediarecorder_removealllisteners">
-    <title><ph keyref="removeAllListeners_IMediaRecorder" /></title>
+    <title><ph keyref="removeAllListeners_IMediaRecorder"/></title>
     <shortdesc id="short"><ph id="shortdesc">Removes all listeners for the specified event.</ph></shortdesc>
     <prolog>
         <metadata>
             <keywords>
-                <indexterm keyref="removeAllListeners_IMediaRecorder" />
+                <indexterm keyref="removeAllListeners_IMediaRecorder"/>
             </keywords>
         </metadata>
     </prolog>
@@ -30,9 +30,9 @@
             <title>Parameters</title>
             <parml>
             <plentry conkeyref="addListener_IMediaRecorder/eventType">
-                <pt />
-                <pd />
+                <pt/>
+                <pd/>
             </plentry>
             </parml> </section>
     </refbody>
-</reference>
+</reference>

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

@@ -39,7 +39,7 @@
             <title>Parameters</title>
             <parml>
             <plentry>
-                <pt props="cpp android framework">callback</pt>
+                <pt props="cpp android hmos framework">callback</pt>
                 <pt props="apple">delegate</pt>
                 <pd>The callbacks for recording audio and video streams. See <xref keyref="IMediaRecorderObserver"/>.</pd>
             </plentry>

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

@@ -26,7 +26,7 @@
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
-            <p>If you only need to mute the audio signal, Agora recommends that you use <xref keyref="muteRecordingSignal"/> instead.</p>
+            <p props="android cpp apple framework">If you only need to mute the audio signal, Agora recommends that you use <xref keyref="muteRecordingSignal"/> instead.</p>
         </section>
         <section id="timing" deliveryTarget="details">
             <title>Call timing</title>
@@ -58,4 +58,4 @@
             <li>&lt; 0: Failure. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph></li>
             </ul> </section>
         </refbody>
-</reference>
+</reference>

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

@@ -30,7 +30,7 @@
             <p>To publish a custom video source, see the following steps:<ol>
             <li>Call this method to create a video track and get the video track ID.</li>
             <li>Call <xref keyref="joinChannel2"/> to join the channel. In <xref keyref="ChannelMediaOptions"/>, set <parmname>customVideoTrackId</parmname> to the video track ID that you want to publish, and set <parmname>publishCustomVideoTrack</parmname> to <codeph><ph keyref="true"/></codeph>.</li>
-            <li>Call <xref keyref="pushVideoFrame" props="apple cpp framework"/><xref keyref="pushVideoFrame3" props="android"/> and specify <parmname>videoTrackId</parmname> as the video track ID set in step 2. You can then publish the corresponding custom video source in the channel.</li>
+            <li>Call <xref keyref="pushVideoFrame" props="apple cpp framework"/><xref keyref="pushVideoFrame3" props="android hmos"/> and specify <parmname>videoTrackId</parmname> as the video track ID set in step 2. You can then publish the corresponding custom video source in the channel.</li>
             </ol></p>
         </section>
         <section id="return_values">

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

@@ -27,7 +27,7 @@
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
-            <p props="native unreal unity cs">Compared to <xref keyref="createDataStream1" />, this method does not guarantee the reliability of data transmission. If a data packet is not received five seconds after it was sent, the SDK directly discards the data.</p>
+            <p props="android cpp apple unreal unity cs">Compared to <xref keyref="createDataStream1" />, this method does not guarantee the reliability of data transmission. If a data packet is not received five seconds after it was sent, the SDK directly discards the data.</p>
         </section>
         <section id="timing" deliveryTarget="details">
             <title>Call timing</title>