Skip to content
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

New YiCAT updates #3373

Merged
merged 5 commits into from
Sep 28, 2023
+1,422 −1,422
Merged

New YiCAT updates #3373

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
26638bb
New translations
Cilla-luodan Sep 28, 2023
fdaab3f
New translations
Cilla-luodan Sep 28, 2023
1314d9f
New translations
Cilla-luodan Sep 28, 2023
2c4ed90
New translations
Cilla-luodan Sep 28, 2023
2fd2601
Merge branch 'master' into translation/4.x-api-ref
Cilla-luodan Sep 28, 2023
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
24 changes: 12 additions & 12 deletions en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,32 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_channelmediarelayconfiguration_getdestchannelmediainfos">
<title><ph keyref="getDestChannelMediaInfos" /></title>
<title><ph keyref="getDestChannelMediaInfos"/></title>
<shortdesc id="short"><ph id="shortdesc">Gets the information of the target channel.</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="getDestChannelMediaInfos" />
<indexterm keyref="getDestChannelMediaInfos"/>
</keywords>
</metadata>
</prolog>
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public Map&lt;String, ChannelMediaInfo&gt; getDestChannelMediaInfos() {
<codeblock props="android" outputclass="language-java">public Map&lt;String, ChannelMediaInfo> getDestChannelMediaInfos() {
return destInfos;
}</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec" />
<codeblock props="cpp unreal" outputclass="language-cpp" />
<codeblock props="electron" outputclass="language-typescript" />
<codeblock props="unity cs" outputclass="language-csharp" />
<codeblock props="rn" outputclass="language-typescript" />
<codeblock props="flutter" outputclass="language-dart" />
<codeblock props="reserve" outputclass="language-cpp" /></p>
<codeblock props="ios mac" outputclass="language-objectivec"/>
<codeblock props="cpp unreal" outputclass="language-cpp"/>
<codeblock props="electron" outputclass="language-typescript"/>
<codeblock props="unity cs" outputclass="language-csharp"/>
<codeblock props="rn" outputclass="language-typescript"/>
<codeblock props="flutter" outputclass="language-dart"/>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="return_values">
<title>Returns</title>
<p>The information of the target channel. See <xref keyref="ChannelMediaInfo" />.</p>
<p>The information of the target channel. See <xref keyref="ChannelMediaInfo"/>.</p>
</section>
</refbody>
</reference>
</reference>
22 changes: 11 additions & 11 deletions en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_iaudiodevicemanager_getplaybackdefaultdevice">
<title><ph keyref="getPlaybackDefaultDevice" /></title>
<title><ph keyref="getPlaybackDefaultDevice"/></title>
<shortdesc id="short"><ph id="shortdesc">Gets the default audio playback device.</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="getPlaybackDefaultDevice" />
<indexterm keyref="getPlaybackDefaultDevice"/>
</keywords>
</metadata>
</prolog>
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java" />
<codeblock props="ios mac" outputclass="language-objectivec" />
<codeblock props="cpp unreal" outputclass="language-cpp" />
<codeblock props="android" outputclass="language-java"/>
<codeblock props="ios mac" outputclass="language-objectivec"/>
<codeblock props="cpp unreal" outputclass="language-cpp"/>
<codeblock props="electron" outputclass="language-typescript">abstract getPlaybackDefaultDevice(): AudioDeviceInfo;</codeblock>
<codeblock props="unity cs" outputclass="language-csharp">public abstract int GetPlaybackDefaultDevice(ref string deviceId, ref string deviceName);</codeblock>
<codeblock props="rn" outputclass="language-typescript" />
<codeblock props="flutter" outputclass="language-dart">Future&lt;AudioDeviceInfo&gt; getPlaybackDefaultDevice();</codeblock>
<codeblock props="reserve" outputclass="language-cpp" /></p>
<codeblock props="rn" outputclass="language-typescript"/>
<codeblock props="flutter" outputclass="language-dart">Future&lt;AudioDeviceInfo> getPlaybackDefaultDevice();</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>Details</title>
Expand All @@ -40,11 +40,11 @@
</section>
<section id="return_values">
<title>Returns</title>
<p props="flutter electron">The details about the default audio playback device. See <xref keyref="AudioDeviceInfo" />.</p>
<p props="flutter electron">The details about the default audio playback device. See <xref keyref="AudioDeviceInfo"/>.</p>
<ul props="unity cs">
<li>0: Success.</li>
<li>&lt; 0: Failure. <ph props="cn">See <xref keyref="error-code-link" /> for details and resolution suggestions.</ph></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>
22 changes: 11 additions & 11 deletions en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdefaultdevice.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_iaudiodevicemanager_getrecordingdefaultdevice">
<title><ph keyref="getRecordingDefaultDevice" /></title>
<title><ph keyref="getRecordingDefaultDevice"/></title>
<shortdesc id="short"><ph id="shortdesc">Gets the default audio capture device.</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="getRecordingDefaultDevice" />
<indexterm keyref="getRecordingDefaultDevice"/>
</keywords>
</metadata>
</prolog>
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java" />
<codeblock props="ios mac" outputclass="language-objectivec" />
<codeblock props="cpp unreal" outputclass="language-cpp" />
<codeblock props="android" outputclass="language-java"/>
<codeblock props="ios mac" outputclass="language-objectivec"/>
<codeblock props="cpp unreal" outputclass="language-cpp"/>
<codeblock props="electron" outputclass="language-typescript">abstract getRecordingDefaultDevice(): AudioDeviceInfo;</codeblock>
<codeblock props="unity cs" outputclass="language-csharp">public abstract int GetRecordingDefaultDevice(ref string deviceId, ref string deviceName);</codeblock>
<codeblock props="rn" outputclass="language-typescript" />
<codeblock props="flutter" outputclass="language-dart">Future&lt;AudioDeviceInfo&gt; getRecordingDefaultDevice();</codeblock>
<codeblock props="reserve" outputclass="language-cpp" /></p>
<codeblock props="rn" outputclass="language-typescript"/>
<codeblock props="flutter" outputclass="language-dart">Future&lt;AudioDeviceInfo> getRecordingDefaultDevice();</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>Details</title>
Expand All @@ -40,11 +40,11 @@
</section>
<section id="return_values">
<title>Returns</title>
<p props="flutter electron">The details about the default audio capture device. See <xref keyref="AudioDeviceInfo" />.</p>
<p props="flutter electron">The details about the default audio capture device. See <xref keyref="AudioDeviceInfo"/>.</p>
<ul props="unity cs">
<li>0: Success.</li>
<li>&lt; 0: Failure. <ph props="cn">See <xref keyref="error-code-link" /> for details and resolution suggestions.</ph></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>
14 changes: 7 additions & 7 deletions en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@
playerId: number,
positionInfo: RemoteVoicePositionInfo
): number;</codeblock>
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; updatePlayerPositionInfo(
<codeblock props="flutter" outputclass="language-dart">Future&lt;void> updatePlayerPositionInfo(
{required int playerId, required RemoteVoicePositionInfo positionInfo});</codeblock>
<codeblock props="reserve" outputclass="language-cpp" /></p>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>Details</title>
Expand All @@ -42,15 +42,15 @@
</plentry>
<plentry props="native unreal bp rn unity electron flutter cs">
<pt>positionInfo</pt>
<pd>The spatial position of the media player. See <xref keyref="RemoteVoicePositionInfo" />.</pd>
<pd>The spatial position of the media player. See <xref keyref="RemoteVoicePositionInfo"/>.</pd>
</plentry>
</parml> </section>
<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; and 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>
<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; and 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>
<li props="native unreal bp electron unity rn cs">0: Success.</li>
<li>&lt; 0: Failure. <ph props="cn">See <xref keyref="error-code-link" /> for details and resolution suggestions.</ph></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>
28 changes: 14 additions & 14 deletions en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_initialize.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_ilocalspatialaudioengine_initialize">
<title><ph keyref="initialize_ILocalSpatialAudioEngine" /></title>
<shortdesc id="short"><ph id="shortdesc">Initializes <xref keyref="ILocalSpatialAudioEngine" />.</ph></shortdesc>
<title><ph keyref="initialize_ILocalSpatialAudioEngine"/></title>
<shortdesc id="short"><ph id="shortdesc">Initializes <xref keyref="ILocalSpatialAudioEngine"/>.</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="initialize_ILocalSpatialAudioEngine" />
<indexterm keyref="initialize_ILocalSpatialAudioEngine"/>
</keywords>
</metadata>
</prolog>
Expand All @@ -19,32 +19,32 @@
<codeblock props="electron" outputclass="language-typescript">abstract initialize(): number;</codeblock>
<codeblock props="unity cs" outputclass="language-csharp">public abstract int Initialize();</codeblock>
<codeblock props="rn" outputclass="language-typescript">abstract initialize(): number;</codeblock>
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; initialize();</codeblock>
<codeblock props="reserve" outputclass="language-cpp" /></p>
<codeblock props="flutter" outputclass="language-dart">Future&lt;void> initialize();</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>Details</title>
<note type="note">
<ul>
<li props="cpp unreal bp">Call this method after calling <xref keyref="queryInterface" /><codeph>(<ph keyref="AGORA_IID_LOCAL_SPATIAL_AUDIO" />)</codeph>.</li>
<li props="android">Call this method after calling <xref keyref="create_ILocalSpatialAudioEngine" />.</li>
<li>Before calling other methods of the <apiname keyref="ILocalSpatialAudioEngine" /> class, you need to call this method to initialize <apiname keyref="ILocalSpatialAudioEngine" />.</li>
<li>The SDK supports creating only one <apiname keyref="ILocalSpatialAudioEngine" /> instance for an app.</li>
<li props="cpp unreal bp">Call this method after calling <xref keyref="queryInterface"/><codeph>(<ph keyref="AGORA_IID_LOCAL_SPATIAL_AUDIO"/>)</codeph>.</li>
<li props="android">Call this method after calling <xref keyref="create_ILocalSpatialAudioEngine"/>.</li>
<li>Before calling other methods of the <apiname keyref="ILocalSpatialAudioEngine"/> class, you need to call this method to initialize <apiname keyref="ILocalSpatialAudioEngine"/>.</li>
<li>The SDK supports creating only one <apiname keyref="ILocalSpatialAudioEngine"/> instance for an app.</li>
</ul> </note> </section>
<section id="parameters" props="native unreal bp">
<title>Parameters</title>
<parml>
<plentry>
<pt>config</pt>
<pd>The configuration of <apiname keyref="ILocalSpatialAudioEngine" />. See <xref keyref="LocalSpatialAudioConfig" />.</pd>
<pd>The configuration of <apiname keyref="ILocalSpatialAudioEngine"/>. See <xref keyref="LocalSpatialAudioConfig"/>.</pd>
</plentry>
</parml> </section>
<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; and 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>
<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; and 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>
<li props="native unreal bp electron unity rn cs">0: Success.</li>
<li>&lt; 0: Failure. <ph props="cn">See <xref keyref="error-code-link" /> for details and resolution suggestions.</ph></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>
12 changes: 6 additions & 6 deletions en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@
uid: number,
posInfo: RemoteVoicePositionInfo
): number;</codeblock>
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; updateRemotePosition(
<codeblock props="flutter" outputclass="language-dart">Future&lt;void> updateRemotePosition(
{required int uid, required RemoteVoicePositionInfo posInfo});</codeblock>
<codeblock props="reserve" outputclass="language-cpp" /></p>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>Details</title>
Expand All @@ -46,11 +46,11 @@
</plentry>
</parml> </section>
<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; and 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>
<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; and 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>
<li props="native unreal bp electron unity rn cs">0: Success.</li>
<li>&lt; 0: Failure. <ph props="cn">See <xref keyref="error-code-link" /> for details and resolution suggestions.</ph></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>
Loading