Skip to content

Commit a85b43b

Browse files
Cilla-luodanCilla-luodan
authored
Merge pull request #3637 from AgoraIO/translation/4.x-api-ref
New YiCAT updates
2 parents f7cc276 + dfedbaa commit a85b43b

File tree

63 files changed

+475
-344
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+475
-344
lines changed

‎en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
<note type="attention">Ensure that you call this method before joining a channel.</note>
4343
<p>To publish a custom audio source, see the following steps:<ol>
4444
<li>Call this method to create a custom audio track and get the audio track ID.</li>
45-
<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>
45+
<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>
4646
<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>
4747
</ol></p>
4848
</section>
@@ -62,7 +62,7 @@
6262
<title>Returns</title>
6363
<ul>
6464
<li>If the method call is successful, the audio track ID is returned as the unique identifier of the audio track.</li>
65-
<li>If the method call fails, a negative value is returned.</li>
65+
<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>
6666
</ul> </section>
6767
</refbody>
68-
</reference>
68+
</reference>

‎en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
<note type="attention">
2828
<p>Before calling this method to push external audio data, perform the following steps:<ol>
2929
<li>Call <xref keyref="createCustomAudioTrack"/> to create a custom audio track and get the audio track ID.</li>
30-
<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>
30+
<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>
3131
</ol></p>
3232
</note> </section>
3333
<section id="parameters">

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
<pt props="unity cs">muted</pt>
3333
<pd>An output parameter. Whether the media file is muted:<ul id="ul_awl_4c2_3qb">
3434
<li><codeph><ph keyref="true" /></codeph>: The media file is muted.</li>
35-
<li><codeph><ph keyref="false" /></codeph>: The media file is unmuted.</li>
35+
<li><codeph><ph keyref="false" /></codeph>: The media file is not muted.</li>
3636
</ul></pd>
3737
</plentry>
3838
</parml> </section>

‎en-US/dita/RTC-NG/API/api_irtcengine_adjustplaybacksignalvolume.dita‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
</section>
3030
<section id="timing" deliveryTarget="details">
3131
<title>Call timing</title>
32-
<p>It can be called either before or after joining the channel.</p>
32+
<p>This method can be called either before or after joining the channel.</p>
3333
</section>
3434
<section id="restriction" deliveryTarget="details">
3535
<title>Restrictions</title>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
</section>
3030
<section id="timing" deliveryTarget="details">
3131
<title>Call timing</title>
32-
<p>It can be called either before or after joining the channel.</p>
32+
<p>This method can be called either before or after joining the channel.</p>
3333
</section>
3434
<section id="restriction" deliveryTarget="details">
3535
<title>Restrictions</title>

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
<title>Returns</title>
3737
<ul>
3838
<li>If the method call is successful, the video track ID is returned as the unique identifier of the video track.</li>
39-
<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>
39+
<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>
4040
</ul> </section>
4141
</refbody>
42-
</reference>
42+
</reference>

‎en-US/dita/RTC-NG/API/api_irtcengine_createdatastream.dita‎

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -24,34 +24,36 @@
2424
<codeblock props="flutter" outputclass="language-dart" />
2525
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
2626
</section>
27-
<section id="detailed_desc">
28-
<title>Details</title>
29-
<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>
30-
<note type="attention" id="note">
31-
<ul>
32-
<li>Call this method after joining a channel.</li>
33-
<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>
34-
</ul> </note> </section>
35-
<section id="parameters">
27+
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
28+
<p id="desc">You can call this method to create a data stream and improve the reliability and ordering of data transmission.</p>
29+
</section>
30+
<section id="timing" deliveryTarget="details" conkeyref="createDataStream2/timing"/>
31+
<section id="restriction" deliveryTarget="details" conkeyref="createDataStream2/restriction"/>
32+
<section id="related" deliveryTarget="details">
33+
<title>Related callbacks</title>
34+
<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>
35+
</section>
36+
<section id="parameters" deliveryTarget="details">
3637
<title>Parameters</title>
3738
<parml>
38-
<plentry props="cpp unreal bp ios mac unity cs" conkeyref="createDataStream2/streamId">
39+
<plentry props="cpp unreal ios mac unity cs" conkeyref="createDataStream2/streamId">
3940
<pt />
4041
<pd />
4142
</plentry>
42-
<plentry>
43+
<plentry id="reliable">
4344
<pt>reliable</pt>
4445
<pd>
45-
<p>Whether or not the data stream is reliable:<ul>
46-
<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>
46+
<p>Sets whether the recipients are guaranteed to receive the data stream within five seconds:<ul>
47+
<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>
4748
<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>
4849
</ul></p>
50+
<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>
4951
</pd>
5052
</plentry>
5153
<plentry id="ordered">
5254
<pt>ordered</pt>
5355
<pd>
54-
<p>Whether or not the recipients receive the data stream in the sent order: <ul>
56+
<p>Sets whether the recipients receive the data stream in the sent order:<ul>
5557
<li><codeph><ph keyref="true" /></codeph>: The recipients receive the data in the sent order.</li>
5658
<li><codeph><ph keyref="false" /></codeph>: The recipients do not receive the data in the sent order.</li>
5759
</ul></p>

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

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,18 @@
2525
<codeblock props="flutter" outputclass="language-dart">Future&lt;int&gt; createDataStream(DataStreamConfig config);</codeblock>
2626
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
2727
</section>
28-
<section id="detailed_desc">
29-
<title>Details</title>
30-
<p id="desc">Creates a data stream. Each user can create up to five data streams in a single channel.</p>
31-
<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>
28+
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
29+
<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>
3230
</section>
33-
<section id="parameters">
31+
<section id="timing" deliveryTarget="details">
32+
<title>Call timing</title>
33+
<p>Call this method after joining a channel.</p>
34+
</section>
35+
<section id="restriction" deliveryTarget="details">
36+
<title>Restrictions</title>
37+
<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>
38+
</section>
39+
<section id="parameters" deliveryTarget="details">
3440
<title>Parameters</title>
3541
<parml>
3642
<plentry props="cpp unreal bp ios mac unity cs" id="streamId">
@@ -43,11 +49,11 @@
4349
</plentry>
4450
</parml> </section>
4551
<section id="return_values">
46-
<title>Returns</title>
52+
<title><ph keyref="return-section-title"/></title>
4753
<ul>
4854
<li props="cpp unreal bp ios mac unity cs">0: The data stream is successfully created.</li>
4955
<li props="android electron flutter rn">ID of the created data stream, if the method call succeeds.</li>
5056
<li>&lt; 0: Failure. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph></li>
51-
</ul> </section>
52-
</refbody>
53-
</reference>
57+
</ul></section>
58+
</refbody>
59+
</reference>

‎en-US/dita/RTC-NG/API/api_irtcengine_disableaudio.dita‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
</section>
3030
<section id="timing" deliveryTarget="details">
3131
<title>Call timing</title>
32-
<p>It can be called either before or after joining the channel. It is still valid after one leaves channel.</p>
32+
<p>This method can be called either before or after joining the channel. It is still valid after one leaves channel.</p>
3333
</section>
3434
<section id="restriction" deliveryTarget="details">
3535
<title>Restrictions</title>

‎en-US/dita/RTC-NG/API/api_irtcengine_enableaudio.dita‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
</section>
3030
<section id="timing" deliveryTarget="details">
3131
<title>Call timing</title>
32-
<p>It can be called either before or after joining the channel. It is still valid after one leaves channel.</p>
32+
<p>This method can be called either before or after joining the channel. It is still valid after one leaves channel.</p>
3333
</section>
3434
<section id="restriction" deliveryTarget="details">
3535
<title>Restrictions</title>

0 commit comments

Comments
 (0)