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

AgoraIO · Jun 18, 2024 · 4f1fef6 · 4f1fef6
2 parents 83773af + a85b43b
commit 4f1fef6
Show file tree

Hide file tree

Showing 63 changed files with 475 additions and 344 deletions.
diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita b/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita
@@ -42,7 +42,7 @@
             <note type="attention">Ensure that you call this method before joining a channel.</note>
             <p>To publish a custom audio source, see the following steps:<ol>
             <li>Call this method to create a custom audio track and get the audio track ID.</li>
-            <li>Call <xref keyref="joinChannel2"/> to join the channel. In <xref keyref="ChannelMediaOptions"/>, set <parmname>publishCustomAduioTrackId</parmname> to the audio track ID that you want to publish, and set <parmname>publishCustomAudioTrack</parmname> to <codeph><ph keyref="true"/></codeph>.</li>
+            <li>Call <xref keyref="joinChannel2"/> to join the channel. In <xref keyref="ChannelMediaOptions"/>, set <parmname>publishCustomAudioTrackId</parmname> to the audio track ID that you want to publish, and set <parmname>publishCustomAudioTrack</parmname> to <codeph><ph keyref="true"/></codeph>.</li>
             <li>Call <xref keyref="pushAudioFrame" props="cpp framework"/><xref keyref="pushAudioFrame2" props="android apple"/> and specify <parmname>trackId</parmname> as the audio track ID set in step 2. You can then publish the corresponding custom audio source in the channel.</li>
             </ol></p>
         </section>
@@ -62,7 +62,7 @@
             <title>Returns</title>
             <ul>
             <li>If the method call is successful, the audio track ID is returned as the unique identifier of the audio track.</li>
-            <li>If the method call fails, a negative value is returned.</li>
+            <li>If the method call fails, 0xffffffff is returned. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph></li>
             </ul> </section>
     </refbody>
-</reference>
+</reference>
diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita
@@ -27,7 +27,7 @@
             <note type="attention">
             <p>Before calling this method to push external audio data, perform the following steps:<ol>
                 <li>Call <xref keyref="createCustomAudioTrack"/> to create a custom audio track and get the audio track ID.</li>
-                <li>Call <xref keyref="joinChannel2"/> to join the channel. In <xref keyref="ChannelMediaOptions"/>, set <parmname>publishCustomAduioTrackId</parmname> to the audio track ID that you want to publish, and set <parmname>publishCustomAudioTrack</parmname> to <codeph><ph keyref="true"/></codeph>.</li>
+                <li>Call <xref keyref="joinChannel2"/> to join the channel. In <xref keyref="ChannelMediaOptions"/>, set <parmname>publishCustomAudioTrackId</parmname> to the audio track ID that you want to publish, and set <parmname>publishCustomAudioTrack</parmname> to <codeph><ph keyref="true"/></codeph>.</li>
             </ol></p>
             </note> </section>
         <section id="parameters">

diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_getmute.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_getmute.dita
@@ -32,7 +32,7 @@
                 <pt props="unity cs">muted</pt>
                 <pd>An output parameter. Whether the media file is muted:<ul id="ul_awl_4c2_3qb">
                     <li><codeph><ph keyref="true" /></codeph>: The media file is muted.</li>
-                    <li><codeph><ph keyref="false" /></codeph>: The media file is unmuted.</li>
+                    <li><codeph><ph keyref="false" /></codeph>: The media file is not muted.</li>
                     </ul></pd>
             </plentry>
             </parml> </section>

diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_adjustplaybacksignalvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_adjustplaybacksignalvolume.dita
@@ -29,7 +29,7 @@
         </section>
         <section id="timing" deliveryTarget="details">
             <title>Call timing</title>
-            <p>It can be called either before or after joining the channel.</p>
+            <p>This method can be called either before or after joining the channel.</p>
         </section>        
         <section id="restriction" deliveryTarget="details">
             <title>Restrictions</title>

diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_adjustrecordingsignalvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_adjustrecordingsignalvolume.dita
@@ -29,7 +29,7 @@
         </section>
         <section id="timing" deliveryTarget="details">
             <title>Call timing</title>
-            <p>It can be called either before or after joining the channel.</p>
+            <p>This method can be called either before or after joining the channel.</p>
         </section>        
         <section id="restriction" deliveryTarget="details">
             <title>Restrictions</title>

diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_createcustomvideotrack.dita b/en-US/dita/RTC-NG/API/api_irtcengine_createcustomvideotrack.dita
@@ -36,7 +36,7 @@
             <title>Returns</title>
             <ul>
             <li>If the method call is successful, the video track ID is returned as the unique identifier of the video track.</li>
-            <li>If the method call fails, a negative value is returned. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph></li>
+            <li>If the method call fails, 0xffffffff is returned. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph></li>
             </ul> </section>
     </refbody>
-</reference>
+</reference>
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream.dita b/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream.dita
@@ -24,34 +24,36 @@
             <codeblock props="flutter" outputclass="language-dart" />
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
-        <section id="detailed_desc">
-            <title>Details</title>
-            <p id="desc">Each user can create up to five data streams during the lifecycle of <xref keyref="IRtcEngine" />. The data stream will be destroyed when leaving the channel, and the data stream needs to be recreated if needed.</p>
-            <note type="attention" id="note">
-            <ul>
-            <li>Call this method after joining a channel.</li>
-            <li>Agora does not support setting <parmname>reliable</parmname> as <codeph><ph keyref="true" /></codeph> and <parmname>ordered</parmname> as <codeph><ph keyref="false"/></codeph>.</li>
-            </ul> </note> </section>
-        <section id="parameters">
+        <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
+            <p id="desc">You can call this method to create a data stream and improve the reliability and ordering of data transmission.</p>
+        </section>
+        <section id="timing" deliveryTarget="details" conkeyref="createDataStream2/timing"/> 
+        <section id="restriction" deliveryTarget="details" conkeyref="createDataStream2/restriction"/>
+        <section id="related" deliveryTarget="details">
+            <title>Related callbacks</title>
+            <p>After setting <parmname>reliable</parmname> to <codeph><ph keyref="true" /></codeph>, if the recipient does not receive the data within five seconds, the SDK triggers the <xref keyref="onStreamMessageError" /> callback and returns an error code.</p>
+        </section>
+        <section id="parameters" deliveryTarget="details">
             <title>Parameters</title>
             <parml>
-            <plentry props="cpp unreal bp ios mac unity cs" conkeyref="createDataStream2/streamId">
+            <plentry props="cpp unreal ios mac unity cs" conkeyref="createDataStream2/streamId">
                 <pt />
                 <pd />
             </plentry>
-            <plentry>
+            <plentry id="reliable">
                 <pt>reliable</pt>
                 <pd>
-                    <p>Whether or not the data stream is reliable:<ul>
-                    <li><codeph><ph keyref="true" /></codeph>: The recipients receive the data from the sender within five seconds. If the recipient does not receive the data within five seconds, the SDK triggers the <xref keyref="onStreamMessageError" /> callback and returns an error code.</li>
+                    <p>Sets whether the recipients are guaranteed to receive the data stream within five seconds:<ul>
+                    <li><codeph><ph keyref="true" /></codeph>: The recipients receive the data from the sender within five seconds. If the recipient does not receive the data within five seconds, the SDK triggers the <apiname keyref="onStreamMessageError" /> callback and returns an error code.</li>
                     <li><codeph><ph keyref="false" /></codeph>: There is no guarantee that the recipients receive the data stream within five seconds and no error message is reported for any delay or missing data stream.</li>
                     </ul></p>
+                    <note type="attention">Please ensure that <parmname>reliable</parmname> and <parmname>ordered</parmname> are either both set to<codeph><ph keyref="true"/></codeph> or both set to <codeph><ph keyref="false"/></codeph>.</note>
                 </pd>
             </plentry>
             <plentry id="ordered">
                 <pt>ordered</pt>
                 <pd>
-                    <p>Whether or not the recipients receive the data stream in the sent order: <ul>
+                    <p>Sets whether the recipients receive the data stream in the sent order:<ul>
                     <li><codeph><ph keyref="true" /></codeph>: The recipients receive the data in the sent order.</li>
                     <li><codeph><ph keyref="false" /></codeph>: The recipients do not receive the data in the sent order.</li>
                     </ul></p>

diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita
@@ -25,12 +25,18 @@
             <codeblock props="flutter" outputclass="language-dart">Future&lt;int&gt; createDataStream(DataStreamConfig config);</codeblock>
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
-        <section id="detailed_desc">
-            <title>Details</title>
-            <p id="desc">Creates a data stream. Each user can create up to five data streams in a single channel.</p>
-            <p id="diff" props="native unreal unity cs">Compared with <xref keyref="createDataStream1" />, this method does not support data reliability. If a data packet is not received five seconds after it was sent, the SDK directly discards the data.</p>
+        <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>
         </section>
-        <section id="parameters">
+        <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>Each user can create up to five data streams during the lifecycle of <xref keyref="IRtcEngine" />. The data stream will be destroyed when leaving the channel, and the data stream needs to be recreated if needed.</p>
+        </section>
+        <section id="parameters" deliveryTarget="details">
             <title>Parameters</title>
             <parml>
             <plentry props="cpp unreal bp ios mac unity cs" id="streamId">
@@ -43,11 +49,11 @@
             </plentry>
             </parml> </section>
         <section id="return_values">
-            <title>Returns</title>
+            <title><ph keyref="return-section-title"/></title>
             <ul>
             <li props="cpp unreal bp ios mac unity cs">0: The data stream is successfully created.</li>
             <li props="android electron flutter rn">ID of the created data stream, if the method call succeeds.</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>
+            </ul></section>
+        </refbody>
+</reference>
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_disableaudio.dita b/en-US/dita/RTC-NG/API/api_irtcengine_disableaudio.dita
@@ -29,7 +29,7 @@
         </section>
         <section id="timing" deliveryTarget="details">
             <title>Call timing</title>
-            <p>It can be called either before or after joining the channel. It is still valid after one leaves channel.</p>
+            <p>This method can be called either before or after joining the channel. It is still valid after one leaves channel.</p>
         </section>        
         <section id="restriction" deliveryTarget="details">
             <title>Restrictions</title>

diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableaudio.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableaudio.dita
@@ -29,7 +29,7 @@
         </section>
         <section id="timing" deliveryTarget="details">
             <title>Call timing</title>
-            <p>It can be called either before or after joining the channel. It is still valid after one leaves channel.</p>
+            <p>This method can be called either before or after joining the channel. It is still valid after one leaves channel.</p>
         </section>        
         <section id="restriction" deliveryTarget="details">
             <title>Restrictions</title>

diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableaudiovolumeindication.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableaudiovolumeindication.dita
@@ -40,7 +40,7 @@
         </section>
         <section id="timing" deliveryTarget="details">
             <title>Call timing</title>
-            <p>It can be called either before or after joining the channel.</p>
+            <p>This method can be called either before or after joining the channel.</p>
         </section>        
         <section id="restriction" deliveryTarget="details">
             <title>Restrictions</title>

diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring.dita
@@ -22,38 +22,30 @@
            <codeblock props="flutter" outputclass="language-dart"/> 
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
-        <section id="detailed_desc">
-            <title>Details</title>
-            <dl outputclass="since"  props="cpp unreal bp mac">
+        <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
+            <dl outputclass="since"  props="mac">
                 <dlentry>
                     <dt>Since</dt>
                     <dd>v4.0.1</dd>
                 </dlentry>
             </dl>
-            <p>This method enables or disables in-ear monitoring.</p>
-            <note type="attention">
-            <ul>
-            <li props="unity cs">This method is for Android and iOS only.</li>
-            <li>Users must use earphones (wired or Bluetooth) to hear the in-ear monitoring effect.</li>
-            <li>You can call this method either before or after joining a channel.</li>
-            </ul> </note> </section>
-        <section id="parameters">
+            <p conkeyref="enableInEarMonitoring2/desc"/>
+        </section>
+        <section id="timing" deliveryTarget="details" conkeyref="enableInEarMonitoring2/timing"/>
+        <section id="restriction" deliveryTarget="details" conkeyref="enableInEarMonitoring2/restriction"/>
+        <section id="parameters" deliveryTarget="details">
             <title>Parameters</title>
             <parml>
-            <plentry>
-                <pt>enabled</pt>
-                <pd>Enables in-ear monitoring.<ul>
-                    <li><codeph><ph keyref="true"/></codeph>: Enables in-ear monitoring.</li>
-                    <li><codeph><ph keyref="false"/></codeph>: (Default) Disables in-ear monitoring.</li>
-                    </ul> </pd>
+            <plentry conkeyref="enableInEarMonitoring2/enabled">
+                <pt/>
+                <pd/>
             </plentry>
             </parml> </section>
-        <section id="return_values" props="android ios mac electron unity rn cs">
-            <title>Returns</title>
+        <section id="return_values">
+            <title><ph keyref="return-section-title"/></title>
             <ul>
-            <li>0: Success.</li>
-            <li>&lt; 0: Failure. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph><ul><li>- 8: Make sure the current audio routing is Bluetooth or headset.</li></ul>
-            </li>
-            </ul> </section>
-    </refbody>
-</reference>
+                <li>0: Success.</li>
+                <li>&lt; 0: Failure. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph><ul><li>- 8: Make sure the current audio routing is Bluetooth or headset.</li></ul></li></ul>
+            </section>
+        </refbody>
+</reference>
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita
@@ -32,18 +32,21 @@
       required EarMonitoringFilterType includeAudioFilters});</codeblock>
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
-        <section id="detailed_desc">
-            <title>Details</title>
-            <p>This method enables or disables in-ear monitoring.</p>
-            <note type="attention">
-            <ul>
-            <li>Users must use earphones (wired or Bluetooth) to hear the in-ear monitoring effect.</li>
-            <li>You can call this method either before or after joining a channel.</li>
-            </ul></note> </section>
+        <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
+            <p id="desc">This method enables or disables in-ear monitoring.</p>
+        </section>
+        <section id="timing" deliveryTarget="details">
+            <title>Call timing</title>
+            <p>This method can be called either before or after joining the channel.</p>
+        </section>        
+        <section id="restriction" deliveryTarget="details">
+            <title>Restrictions</title>
+            <p>Users must use earphones (wired or Bluetooth) to hear the in-ear monitoring effect.</p>
+        </section>
         <section id="parameters">
             <title>Parameters</title>
             <parml>
-            <plentry>
+            <plentry id="enabled">
                 <pt>enabled</pt>
                 <pd>Enables or disables in-ear monitoring.<ul>
                     <li><codeph><ph keyref="true"/></codeph>: Enables in-ear monitoring.</li>
@@ -66,10 +69,10 @@
         <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 id="ul_uns_l2y_hqb">
-            <li props="native unreal bp unity electron rn cs">0: Success.</li>
+            <ul props="native unreal bp unity electron rn cs">
+            <li>0: Success.</li>
             <li>&lt; 0: Failure. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph><ul><li>- 8: Make sure the current audio routing is Bluetooth or headset.</li></ul>
             </li>
             </ul> </section>
-    </refbody>
-</reference>
+        </refbody>
+</reference>
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getconnectionstate.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getconnectionstate.dita
@@ -24,13 +24,17 @@
             <codeblock props="flutter" outputclass="language-dart">Future&lt;ConnectionStateType&gt; getConnectionState();</codeblock>
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
-        <section id="detailed_desc">
-            <title>Details</title>
-            <p>You can call this method either before or after joining a channel.</p>
+        <section id="timing" deliveryTarget="details">
+            <title>Call timing</title>
+            <p>This method 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="return_values">
-            <title>Returns</title>
+            <title><ph keyref="return-section-title"/></title>
             <p conkeyref="onConnectionStateChanged/connectionstate" />
-        </section>
-    </refbody>
+            </section>
+        </refbody>
 </reference>