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 #3401

Merged
merged 10 commits into from
Nov 20, 2023
Merged

New YiCAT updates #3401

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
234d458
New translations
Cilla-luodan Oct 19, 2023
2d31079
New translations
Cilla-luodan Oct 25, 2023
5b0a170
New translations
Cilla-luodan Oct 26, 2023
83e4a83
New translations
Cilla-luodan Nov 9, 2023
2f43d21
New translations
Cilla-luodan Nov 17, 2023
e7031d6
New translations
Cilla-luodan Nov 17, 2023
66504ad
New translations
Cilla-luodan Nov 17, 2023
aab7757
New translations
Cilla-luodan Nov 17, 2023
936875a
New translations
Cilla-luodan Nov 20, 2023
3dfeced
New translations
Cilla-luodan Nov 20, 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
8 changes: 4 additions & 4 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,12 +1,12 @@
<?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>
Expand All @@ -26,7 +26,7 @@
</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>
20 changes: 10 additions & 10 deletions en-US/dita/RTC-NG/API/api_createagorartcengine.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_createagorartcengine">
<title><ph keyref="createAgoraRtcEngine" /></title>
<shortdesc id="short"><ph id="shortdesc" props="cpp unreal bp unity rn flutter cs">Creates one <apiname keyref="IRtcEngine" /> object. </ph><ph id="shortdescele" props="electron">Creates one <apiname keyref="IRtcEngineEx" /> object.</ph></shortdesc>
<title><ph keyref="createAgoraRtcEngine"/></title>
<shortdesc id="short"><ph id="shortdesc" props="cpp unreal bp unity rn flutter cs">Creates one <apiname keyref="IRtcEngine"/> object. </ph><ph id="shortdescele" props="electron">Creates one <apiname keyref="IRtcEngineEx"/> object.</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="createAgoraRtcEngine" />
<indexterm keyref="createAgoraRtcEngine"/>
</keywords>
</metadata>
</prolog>
Expand All @@ -33,15 +33,15 @@
</section>
<section id="detailed_desc">
<title>Details</title>
<p props="electron">Currently, the Agora RTC SDK v4.x supports creating only one <apiname keyref="IRtcEngineEx" /> object for each app.</p>
<p props="cpp unreal bp rn unity cs">Currently, the Agora RTC SDK v4.x supports creating only one <apiname keyref="IRtcEngine" /> object for each app.</p>
<p props="flutter">Currently, the Agora RTC SDK v6.x supports creating only one <apiname keyref="IRtcEngine" /> object for each app.</p>
<p props="electron">Currently, the Agora RTC SDK v4.x supports creating only one <apiname keyref="IRtcEngineEx"/> object for each app.</p>
<p props="cpp unreal bp rn unity cs">Currently, the Agora RTC SDK v4.x supports creating only one <apiname keyref="IRtcEngine"/> object for each app.</p>
<p props="flutter">Currently, the Agora RTC SDK v6.x supports creating only one <apiname keyref="IRtcEngine"/> object for each app.</p>
</section>
<section id="return_values">
<title>Returns</title>
<p props="cpp unreal bp">Pointer to the <apiname keyref="IRtcEngine" /> object.</p>
<p props="electron">One <apiname keyref="IRtcEngineEx" /> object.</p>
<p props="unity rn flutter cs">One <apiname keyref="IRtcEngine" /> object.</p>
<p props="cpp unreal bp">Pointer to the <apiname keyref="IRtcEngine"/> object.</p>
<p props="electron">One <apiname keyref="IRtcEngineEx"/> object.</p>
<p props="unity rn flutter cs">One <apiname keyref="IRtcEngine"/> object.</p>
</section>
</refbody>
</reference>
</reference>
12 changes: 6 additions & 6 deletions en-US/dita/RTC-NG/API/api_createagorartcengineex.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_createagorartcengineex">
<title><ph keyref="createAgoraRtcEngineEx" /></title>
<shortdesc id="short"><ph id="shortdesc">Creates one <apiname keyref="IRtcEngineEx" /> object.</ph></shortdesc>
<title><ph keyref="createAgoraRtcEngineEx"/></title>
<shortdesc id="short"><ph id="shortdesc">Creates one <apiname keyref="IRtcEngineEx"/> object.</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="createAgoraRtcEngineEx" />
<indexterm keyref="createAgoraRtcEngineEx"/>
</keywords>
</metadata>
</prolog>
Expand All @@ -29,12 +29,12 @@
</section>
<section id="detailed_desc">
<title>Details</title>
<p props="unity cs">Currently, the Agora RTC v4.x SDK supports creating only one <apiname keyref="IRtcEngineEx" /> object for each app.</p>
<p props="flutter">Currently, the Agora RTC v6.x SDK supports creating only one <apiname keyref="IRtcEngineEx" /> object for each app.</p>
<p props="unity cs">Currently, the Agora RTC v4.x SDK supports creating only one <apiname keyref="IRtcEngineEx"/> object for each app.</p>
<p props="flutter">Currently, the Agora RTC v6.x SDK supports creating only one <apiname keyref="IRtcEngineEx"/> object for each app.</p>
</section>
<section id="return_values">
<title>Returns</title>
<p props="electron unity rn flutter cs">One <apiname keyref="IRtcEngineEx" /> object.</p>
<p props="electron unity rn flutter cs">One <apiname keyref="IRtcEngineEx"/> object.</p>
</section>
</refbody>
</reference>
4 changes: 2 additions & 2 deletions en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getapplicationvolume.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_iaudiodevicecollection_getapplicationvolume">
<title><ph keyref="getApplicationVolume"/></title>
<shortdesc id="short"><ph id="shortdesc">Gets the volume of the application.</ph></shortdesc>
<shortdesc id="short"><ph id="shortdesc">Retrieves the volume of the app.</ph></shortdesc>
<prolog>
<metadata>
<keywords>
Expand All @@ -29,7 +29,7 @@
<parml>
<plentry>
<pt>volume</pt>
<pd>The volume of the application. The value range is [0,255].</pd>
<pd>The volume of the app. The value range is [0,255].</pd>
</plentry>
</parml> </section>
<section id="return_values">
Expand Down
2 changes: 1 addition & 1 deletion en-US/dita/RTC-NG/API/api_iaudiodevicecollection_isapplicationmute.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_iaudiodevicecollection_isapplicationmute">
<title><ph keyref="isApplicationMute"/></title>
<shortdesc id="short"><ph id="shortdesc">Gets whether the app is muted.</ph></shortdesc>
<shortdesc id="short"><ph id="shortdesc">Checks whether the app is muted.</ph></shortdesc>
<prolog>
<metadata>
<keywords>
Expand Down
2 changes: 1 addition & 1 deletion en-US/dita/RTC-NG/API/api_iaudiodevicecollection_setapplicationvolume.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_iaudiodevicecollection_setapplicationvolume">
<title><ph keyref="setApplicationVolume"/></title>
<shortdesc id="short"><ph id="shortdesc">Sets the app volume.</ph></shortdesc>
<shortdesc id="short"><ph id="shortdesc">Sets the volume of the app.</ph></shortdesc>
<prolog>
<metadata>
<keywords>
Expand Down
14 changes: 7 additions & 7 deletions en-US/dita/RTC-NG/API/api_imediaengine_addlistener.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_imediaengine_addlistener">
<title><ph keyref="addListener_IMediaEngine" /></title>
<shortdesc id="short"><ph id="shortdesc">Adds one <xref keyref="IMediaEngineEvent" /> listener.</ph></shortdesc>
<title><ph keyref="addListener_IMediaEngine"/></title>
<shortdesc id="short"><ph id="shortdesc">Adds one <xref keyref="IMediaEngineEvent"/> listener.</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="addListener_IMediaEngine" />
<indexterm keyref="addListener_IMediaEngine"/>
</keywords>
</metadata>
</prolog>
Expand All @@ -30,20 +30,20 @@
</section>
<section id="detailed_desc">
<title>Details</title>
<p>After calling this method, you can listen for the corresponding events in the <xref keyref="IMediaEngine" /> object and obtain data through <apiname keyref="IMediaEngineEvent" />. Depending on your project needs, you can add multiple listeners for the same event.</p>
<p>After calling this method, you can listen for the corresponding events in the <xref keyref="IMediaEngine"/> object and obtain data through <apiname keyref="IMediaEngineEvent"/>. Depending on your project needs, you can add multiple listeners for the same event.</p>
</section>
<section id="parameters">
<title>Parameters</title>
<parml>
<plentry id="eventType">
<pt>eventType</pt>
<pd>The name of the target event to listen for. See <apiname keyref="IMediaEngineEvent" />.</pd>
<pd>The name of the target event to listen for. See <apiname keyref="IMediaEngineEvent"/>.</pd>
</plentry>
<plentry id="listener">
<pt>listener</pt>
<pd>The callback function for <parmname>eventType</parmname>. Take adding a listener for <xref keyref="onPlaybackAudioFrameBeforeMixing" /> as an example:<codeblock outputclass="language-typescript">const onPlaybackAudioFrameBeforeMixing = (channelId: string, uid: number, audioFrame: AudioFrame) =&gt; {};
<pd>The callback function for <parmname>eventType</parmname>. Take adding a listener for <xref keyref="onPlaybackAudioFrameBeforeMixing"/> as an example:<codeblock outputclass="language-typescript">const onPlaybackAudioFrameBeforeMixing = (channelId: string, uid: number, audioFrame: AudioFrame) => {};
engine.addListener('onPlaybackAudioFrameBeforeMixing', onPlaybackAudioFrameBeforeMixing);</codeblock></pd>
</plentry>
</parml> </section>
</refbody>
</reference>
</reference>
14 changes: 7 additions & 7 deletions en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.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_imediaengine_createcustomaudiotrack">
<title><ph keyref="createCustomAudioTrack" /></title>
<title><ph keyref="createCustomAudioTrack"/></title>
<shortdesc id="short"><ph id="shortdesc">Creates a custom audio track.</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="createCustomAudioTrack" />
<indexterm keyref="createCustomAudioTrack"/>
</keywords>
</metadata>
</prolog>
Expand Down Expand Up @@ -41,20 +41,20 @@
</dl>
<p>To publish a custom audio source to multiple channels, see the following steps:<ol>
<li>Call this method to create a custom audio track and get the audio track ID.</li>
<li>In <xref keyref="ChannelMediaOptions" /> of each channel, 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>If you 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 publish the corresponding custom audio source in multiple channels.</li>
<li>In <xref keyref="ChannelMediaOptions"/> of each channel, 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>If you 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 publish the corresponding custom audio source in multiple channels.</li>
</ol></p>
</section>
<section id="parameters">
<title>Parameters</title>
<parml>
<plentry>
<pt>trackType</pt>
<pd>The type of the custom audio track. See <xref keyref="AUDIO_TRACK_TYPE" />.<note type="attention">If <apiname keyref="AUDIO_TRACK_DIRECT" /> is specified for this parameter, you must set <codeph>publishMicrophoneTrack</codeph> to <codeph><ph keyref="false" /></codeph> in <xref keyref="ChannelMediaOptions" /> when calling <xref keyref="joinChannel2" /> to join the channel; otherwise, joining the channel fails and returns the error code -2.</note></pd>
<pd>The type of the custom audio track. See <xref keyref="AUDIO_TRACK_TYPE"/>.<note type="attention">If <apiname keyref="AUDIO_TRACK_DIRECT"/> is specified for this parameter, you must set <codeph>publishMicrophoneTrack</codeph> to <codeph><ph keyref="false"/></codeph> in <xref keyref="ChannelMediaOptions"/> when calling <xref keyref="joinChannel2"/> to join the channel; otherwise, joining the channel fails and returns the error code -2.</note></pd>
</plentry>
<plentry>
<pt>config</pt>
<pd>The configuration of the custom audio track. See <xref keyref="AudioTrackConfig" />.</pd>
<pd>The configuration of the custom audio track. See <xref keyref="AudioTrackConfig"/>.</pd>
</plentry>
</parml> </section>
<section id="return_values">
Expand All @@ -64,4 +64,4 @@
<li>If the method call fails, a negative value is returned.</li>
</ul> </section>
</refbody>
</reference>
</reference>
2 changes: 1 addition & 1 deletion en-US/dita/RTC-NG/API/api_imediaengine_pullaudioframe.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
<section id="detailed_desc">
<title>Details</title>
<p>Before calling this method, you need to call <xref keyref="setExternalAudioSink"/> to notify the app to enable and set the external rendering.</p>
<p>After a successful method call, the app pulls the decoded and mixed audio data for playback.</p>
<p>After a successful call of this method, the app pulls the decoded and mixed audio data for playback.</p>
<note type="attention">
<ul>
<li>This method only supports pulling data from custom audio source. If you need to pull the data captured by the SDK, do not call this method.</li>
Expand Down
2 changes: 1 addition & 1 deletion en-US/dita/RTC-NG/API/api_imediaengine_setexternalaudiosink.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
<ul>
<li>Before using this method, you need to set <parmname>enableAudioDevice</parmname> to <codeph><ph keyref="false" /></codeph> in <xref keyref="RtcEngineConfig" />.</li>
<li>Ensure that you call this method before joining a channel.</li>
<li>Once you enable the external audio sink, the app does not retrieve any audio data from the <xref keyref="onPlaybackAudioFrame" /> callback.</li>
<li>Once you enable the external audio sink, the app will not retrieve any audio data from the <xref keyref="onPlaybackAudioFrame" /> callback.</li>
</ul> </note> </section>
<section id="parameters">
<title>Parameters</title>
Expand Down
14 changes: 7 additions & 7 deletions en-US/dita/RTC-NG/API/api_imediaplayer_addlistener.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_imediaplayer_addlistener">
<title><ph keyref="addListener_IMediaPlayer" /></title>
<shortdesc id="short"><ph id="shortdesc">Adds one <xref keyref="IMediaPlayerEvent" /> listener.</ph></shortdesc>
<title><ph keyref="addListener_IMediaPlayer"/></title>
<shortdesc id="short"><ph id="shortdesc">Adds one <xref keyref="IMediaPlayerEvent"/> listener.</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="addListener_IMediaPlayer" />
<indexterm keyref="addListener_IMediaPlayer"/>
</keywords>
</metadata>
</prolog>
Expand All @@ -29,20 +29,20 @@
</section>
<section id="detailed_desc">
<title>Details</title>
<p>After calling this method, you can listen for the corresponding events in the <xref keyref="IMediaPlayer" /> object and obtain data through <apiname keyref="IMediaPlayerEvent" />. Depending on your project needs, you can add multiple listeners for the same event.</p>
<p>After calling this method, you can listen for the corresponding events in the <xref keyref="IMediaPlayer"/> object and obtain data through <apiname keyref="IMediaPlayerEvent"/>. Depending on your project needs, you can add multiple listeners for the same event.</p>
</section>
<section id="parameters">
<title>Parameters</title>
<parml>
<plentry id="eventType">
<pt>eventType</pt>
<pd>The name of the target event to listen for. See <apiname keyref="IMediaPlayerEvent" />.</pd>
<pd>The name of the target event to listen for. See <apiname keyref="IMediaPlayerEvent"/>.</pd>
</plentry>
<plentry id="listener">
<pt>listener</pt>
<pd>The callback function for <parmname>eventType</parmname>. Take adding a listener for <xref keyref="onPlayerSourceStateChanged" /> as an example:<codeblock outputclass="language-typescript">const onPlayerSourceStateChanged = (connection: RtcConnection, elapsed: number) =&gt; {};
<pd>The callback function for <parmname>eventType</parmname>. Take adding a listener for <xref keyref="onPlayerSourceStateChanged"/> as an example:<codeblock outputclass="language-typescript">const onPlayerSourceStateChanged = (connection: RtcConnection, elapsed: number) => {};
engine.addListener('onPlayerSourceStateChanged', onPlayerSourceStateChanged);</codeblock></pd>
</plentry>
</parml> </section>
</refbody>
</reference>
</reference>
7 changes: 3 additions & 4 deletions en-US/dita/RTC-NG/API/api_imediaplayer_getstreaminfo.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,8 @@
<parml>
<plentry>
<pt>index</pt>
<pd>The index of the media stream.</pd>
<pd props="cpp unreal bp unity cs">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">This parameter must be less than the return value of <xref keyref="getStreamCount" />.</pd>
<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>
</plentry>
<plentry props="cpp unreal bp unity cs">
<pt>info</pt>
Expand All @@ -52,4 +51,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>
Loading
Loading