Skip to content

New YiCAT updates #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jinyuagora wants to merge 16 commits into
base: master
Choose a base branch
from
Open

New YiCAT updates #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
16b2416
New translations api_irtcengine_getextensionproperty2.dita(EN-US)
jinyuagora Nov 23, 2022
17eb366
New translations api_irtcengine_setaudioscenario.dita(EN-US)
jinyuagora Nov 23, 2022
bc8a19b
New translations class_localvideostats.dita(EN-US)
jinyuagora Nov 23, 2022
dffa998
New translations class_videocanvas.dita(EN-US)
jinyuagora Nov 23, 2022
e993907
New translations api_irtcengineex_resumeallchannelmediarelayex.dita(E…
jinyuagora Nov 23, 2022
9073be4
New translations api_irtcengineex_setdualstreammodeex.dita(EN-US)
jinyuagora Nov 23, 2022
7d2908c
New translations class_channelmediaoptions.dita(EN-US)
jinyuagora Nov 23, 2022
9ee21bf
New translations api_irtcengine_setearmonitoringaudioframeparameters.…
jinyuagora Nov 23, 2022
e27e9e9
New translations api_irtcengine_createdatastream.dita(EN-US)
jinyuagora Nov 23, 2022
6827d49
New translations api_irtcengine_enableinearmonitoring.dita(EN-US)
jinyuagora Nov 23, 2022
fab5d5f
New translations api_irtcengine_enableinearmonitoring2.dita(EN-US)
jinyuagora Nov 23, 2022
0e623af
New translations api_irtcengine_enableinearmonitoring.dita(EN-US)
jinyuagora Nov 23, 2022
974cdcd
New translations api_irtcengine_enableinearmonitoring2.dita(EN-US)
jinyuagora Nov 23, 2022
035c666
New translations class_screencaptureparameters.dita(EN-US)
jinyuagora Nov 23, 2022
644a078
New translations rtc_api_overview_ng.dita(EN-US)
jinyuagora Nov 23, 2022
980ac03
New translations rtc_api_overview_ng.dita(EN-US)
jinyuagora Nov 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions en-US/dita/RTC-NG/API/api_irtcengine_createdatastream.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@
<codeblock props="unity" outputclass="language-csharp">public abstract int CreateDataStream(ref int streamId, bool reliable, bool ordered);</codeblock>
<codeblock props="rn" outputclass="language-typescript" />
<codeblock props="flutter" outputclass="language-dart">Future&lt;int&gt; createDataStream(DataStreamConfig config);</codeblock>
<codeblock props="unreal" outputclass="language-cpp" /></p>
<codeblock props="unreal" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<p id="desc">Each user can create up to five data streams during the lifecycle of <xref keyref="IRtcEngine" />.</p>
<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="true" /></codeph>.</li>
<li>Agora does not support setting<parmname>reliable</parmname> as <codeph><ph keyref="true" /></codeph> and <parmname>ordered</parmname> as <codeph><ph keyref="true" /></codeph>.</li>
</ul> </note> </section>
<section id="parameters">
<title>Parameters</title>
Expand All @@ -50,7 +50,7 @@
<plentry id="ordered">
<pt>ordered</pt>
<pd>
<p>Whether or not the recipients receive the data stream in the sent order:<ul>
<p>Whether or not 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>
Expand Down
26 changes: 13 additions & 13 deletions en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_irtcengine_enableinearmonitoring">
<title><ph keyref="enableInEarMonitoring" /></title>
<title><ph keyref="enableInEarMonitoring"/></title>
<shortdesc id="short"><ph id="shortdesc">Enables in-ear monitoring.</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="enableInEarMonitoring" />
<indexterm keyref="enableInEarMonitoring"/>
</keywords>
</metadata>
</prolog>
Expand All @@ -15,15 +15,15 @@
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public abstract int enableInEarMonitoring(boolean enabled);</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)enableInEarMonitoring:(BOOL)enabled;</codeblock>
<codeblock props="cpp" outputclass="language-cpp" />
<codeblock props="electron" outputclass="language-typescript" />
<codeblock props="cpp" outputclass="language-cpp"/>
<codeblock props="electron" outputclass="language-typescript"/>
<codeblock props="unity" outputclass="language-csharp">public abstract int EnableInEarMonitoring(bool enabled);</codeblock>
<codeblock props="rn" outputclass="language-typescript" />
<codeblock props="flutter" outputclass="language-dart" />
<codeblock props="unreal" outputclass="language-cpp" /></p>
<codeblock props="rn" outputclass="language-typescript"/>
<codeblock props="flutter" outputclass="language-dart"/>
<codeblock props="unreal" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<dl outputclass="since" props="cpp mac">
<dl outputclass="since" props="cpp mac">
<dlentry>
<dt>Since</dt>
<dd>v4.0.1</dd>
Expand All @@ -33,17 +33,17 @@
<note type="attention">
<ul>
<li props="unity">This method applies to Android and iOS only.</li>
<li>Users must use wired earphones to hear their own voices.</li>
<li>Users must use headphones (both wired and 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">
<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>
<pd>Enables or disables 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>
</parml> </section>
Expand All @@ -54,4 +54,4 @@
<li>&lt; 0: Failure.</li>
</ul> </section>
</refbody>
</reference>
</reference>
24 changes: 12 additions & 12 deletions en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_irtcengine_enableinearmonitoring2">
<title><ph keyref="enableInEarMonitoring2" /></title>
<title><ph keyref="enableInEarMonitoring2"/></title>
<shortdesc id="short"><ph id="shortdesc">Enables in-ear monitoring.</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="enableInEarMonitoring2" />
<indexterm keyref="enableInEarMonitoring2"/>
</keywords>
</metadata>
</prolog>
Expand All @@ -25,16 +25,16 @@
enabled: boolean,
includeAudioFilters: EarMonitoringFilterType
): number;</codeblock>
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; enableInEarMonitoring(
<codeblock props="flutter" outputclass="language-dart">Future&lt;void> enableInEarMonitoring(
{required bool enabled,
required EarMonitoringFilterType includeAudioFilters});</codeblock>
<codeblock props="unreal" outputclass="language-cpp" /></p>
<codeblock props="unreal" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<p>This method enables or disables in-ear monitoring.</p>
<note type="attention">
<ul>
<li>Users must use wired earphones to hear their own voices.</li>
<li>Users must use headphones (both wired and 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">
Expand All @@ -43,17 +43,17 @@
<plentry>
<pt>enabled</pt>
<pd>Enables or disables 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>
<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>
<plentry>
<pt>includeAudioFilters</pt>
<pd props="ios mac cpp electron unity rn flutter">The audio filter of in-ear monitoring: See <xref keyref="EAR_MONITORING_FILTER_TYPE" />.</pd>
<pd props="ios mac cpp electron unity rn flutter">The audio filter of in-ear monitoring: See <xref keyref="EAR_MONITORING_FILTER_TYPE"/>.</pd>
<pd props="android">The audio filter of in-ear monitoring:<ul id="ul_nwv_hcy_4qb">
<li><ph keyref="EAR_MONITORING_FILTER_NONE" />(1 &lt;&lt; 0): Do not add an audio filter to the in-ear monitor.</li>
<li><ph keyref="EAR_MONITORING_FILTER_BUILT_IN_AUDIO_FILTERS" />(1 &lt;&lt; 1): Add an audio filter to the in-ear monitor. If you implement functions such as voice beautifier and audio effect, users can hear the voice after adding these effects.</li>
<li><ph keyref="EAR_MONITORING_FILTER_NOISE_SUPPRESSION" />(1 &lt;&lt; 2): Enable noise suppression to the in-ear monitor.<p>You can use the bitwise OR operator (|) to specify multiple audio filters.<note type="attention">If you set the <parmname>enabled</parmname> parameter to <codeph><ph keyref="false" /></codeph>, you do not need to set the <parmname>includeAudioFilters</parmname> parameter.</note></p>
<li><ph keyref="EAR_MONITORING_FILTER_NONE"/>(1 &lt;&lt; 0): Do not add an audio filter to the in-ear monitor.</li>
<li><ph keyref="EAR_MONITORING_FILTER_BUILT_IN_AUDIO_FILTERS"/>(1 &lt;&lt; 1): Add an audio filter to the in-ear monitor. If you implement functions such as voice beautifier and audio effect, users can hear the voice after adding these effects.</li>
<li><ph keyref="EAR_MONITORING_FILTER_NOISE_SUPPRESSION"/>(1 &lt;&lt; 2): Enable noise suppression to the in-ear monitor.<p>You can use the bitwise or operator (|) to specify multiple audio filters.<note type="attention">If you set the <parmname>enabled</parmname> parameter to<codeph><ph keyref="false"/></codeph>, you do not need to set the <parmname>includeAudioFilters</parmname> parameter.</note></p>
</li>
</ul></pd>
</plentry>
Expand All @@ -65,4 +65,4 @@
<li>&lt; 0: Failure.</li>
</ul> </section>
</refbody>
</reference>
</reference>
14 changes: 7 additions & 7 deletions en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty2.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_irtcengine_getextensionproperty2">
<title><ph keyref="getExtensionProperty2" /></title>
<title><ph keyref="getExtensionProperty2"/></title>
<shortdesc id="short"><ph id="shortdesc">Gets detailed information on the extensions.</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="getExtensionProperty2" />
<indexterm keyref="getExtensionProperty2"/>
</keywords>
</metadata>
</prolog>
Expand All @@ -25,7 +25,7 @@
const char* provider, const char* extension,
const char* key, char* value, int buf_len, agora::media::MEDIA_SOURCE_TYPE type = agora::media::UNKNOWN_MEDIA_SOURCE) = 0;
</codeblock>
<codeblock props="cs" outputclass="language-csharp" />
<codeblock props="cs" outputclass="language-csharp"/>
<codeblock props="electron" outputclass="language-typescript">abstract getExtensionProperty(
provider: string,
extension: string,
Expand All @@ -41,16 +41,16 @@
bufLen: number,
type?: MediaSourceType
): string;</codeblock>
<codeblock props="flutter" outputclass="language-dart">Future&lt;String&gt; getExtensionProperty(
<codeblock props="flutter" outputclass="language-dart">Future&lt;String> getExtensionProperty(
{required String provider,
required String extension,
required String key,
required int bufLen,
MediaSourceType type = MediaSourceType.unknownMediaSource});</codeblock>
<codeblock props="unreal" outputclass="language-cpp" /></p>
<codeblock props="unreal" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<p />
<p/>
</section>
<section id="parameters">
<title>Parameters</title>
Expand Down Expand Up @@ -96,4 +96,4 @@
<li>An empty string, if the method call fails.</li>
</ul> </section>
</refbody>
</reference>
</reference>
16 changes: 8 additions & 8 deletions en-US/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<codeblock props="unity" outputclass="language-csharp">public abstract int SetAudioScenario(AUDIO_SCENARIO_TYPE scenario);</codeblock>
<codeblock props="rn" outputclass="language-typescript">abstract setAudioScenario(scenario: AudioScenarioType): number;</codeblock>
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; setAudioScenario(AudioScenarioType scenario);</codeblock>
<codeblock props="unreal" outputclass="language-cpp" /></p>
<codeblock props="unreal" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<note>You can call this method either before or after joining a channel.</note> </section>
Expand All @@ -30,15 +30,15 @@
<parml>
<plentry props="cpp mac ios framework">
<pt>scenario</pt>
<pd>The audio scenarios. See <xref keyref="AUDIO_SCENARIO_TYPE" />. Under different audio scenarios, the device uses different volume types.</pd>
<pd>The audio scenarios. See <xref keyref="AUDIO_SCENARIO_TYPE"/>. Under different audio scenarios, the device uses different volume types.</pd>
</plentry>
<plentry props="android">
<pt>scenario</pt>
<pd>The audio scenarios:<ul><li><ph keyref="AUDIO_SCENARIO_DEFAULT" />(0): (Default) Automatic scenario, where the SDK chooses the appropriate audio quality according to the user role and audio route.</li>
<li><ph keyref="AUDIO_SCENARIO_GAME_STREAMING" />(3): High-quality audio scenario, where users mainly play music.</li>
<li><ph keyref="AUDIO_SCENARIO_CHATROOM" />(5): Chatroom scenario, where users need to frequently switch the user role or mute and unmute the microphone. In this scenario, audience members receive a pop-up window to request permission of using microphones.</li>
<li><ph keyref="AUDIO_SCENARIO_CHORUS" />(7): Real-time chorus scenario, where users have good network conditions and require extremely low latency.<note>Before using this enumeration, you need to call to see<xref keyref="getAudioDeviceInfo" /> whether the audio device supports ultra-low-latency capture and playback. To experience ultra-low latency, you need to ensure that your audio device supports ultra-low latency (<parmname>isLowLatencyAudioSupported</parmname> = <codeph><ph keyref="true" /></codeph>).</note></li>
<li><ph keyref="AUDIO_SCENARIO_MEETING" />(8): Meeting scenario that mainly involves the human voice.</li></ul>
<pd>The audio scenarios:<ul><li><ph keyref="AUDIO_SCENARIO_DEFAULT"/>(0): (Default) Automatic scenario, where the SDK chooses the appropriate audio quality according to the user role and audio route.</li>
<li><ph keyref="AUDIO_SCENARIO_GAME_STREAMING"/>(3): High-quality audio scenario, where users mainly play music.</li>
<li><ph keyref="AUDIO_SCENARIO_CHATROOM"/>(5): Chatroom scenario, where users need to frequently switch the user role or mute and unmute the microphone. In this scenario, audience members receive a pop-up window to request permission of using microphones.</li>
<li><ph keyref="AUDIO_SCENARIO_CHORUS"/>(7): Real-time chorus scenario, where users have good network conditions and require extremely low latency.<note>Before using this enumeration, you need to call to see<xref keyref="getAudioDeviceInfo"/> whether the audio device supports ultra-low-latency capture and playback. To experience ultra-low latency, you need to ensure that your audio device supports ultra-low latency (<parmname>isLowLatencyAudioSupported</parmname> = <codeph><ph keyref="true"/></codeph>).</note></li>
<li><ph keyref="AUDIO_SCENARIO_MEETING"/>(8): Meeting scenario that mainly involves the human voice.</li></ul>
</pd>
</plentry>
</parml> </section>
Expand All @@ -49,4 +49,4 @@
<li>&lt; 0: Failure.</li>
</ul> </section>
</refbody>
</reference>
</reference>
Loading