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.

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

Merged
merged 25 commits into from
May 21, 2024
Merged
Show file tree
Hide file tree
Changes from 16 commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
<p>After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all remote users, including all subsequent users.</p>
<note>
<ul>
<li>Call this method after <xref keyref="joinChannel2"/>.</li>
<li>Call this method after the <xref keyref="joinChannel1"/> or <xref keyref="joinChannel2"/> method.</li>
<li>When using the spatial audio effect, if you need to set whether to stop subscribing to the audio streams of all remote users, Agora recommends calling this method instead of the <xref keyref="muteAllRemoteAudioStreams"/> method in <xref keyref="IRtcEngine"/>.</li>
<li>After calling this method, you need to call <xref keyref="updateSelfPosition"/> and <xref keyref="updateRemotePosition"/> to update the spatial location of the local user and the remote user; otherwise, the settings in this method do not take effect.</li>
</ul></note> </section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
<note type="note">
<ul>
<li>This method does not affect any ongoing audio recording, because it does not disable the audio capture device.</li>
<li>Call this method after <xref keyref="joinChannel2"/>.</li>
<li>Call this method after the <xref keyref="joinChannel1"/> or <xref keyref="joinChannel2"/> method.</li>
<li>When using the spatial audio effect, if you need to set whether to stop subscribing to the audio stream of a specified user, Agora recommends calling this method instead of the <xref keyref="muteLocalAudioStream"/> method in <xref keyref="IRtcEngine"/>.</li>
<li>A successful call of this method triggers the <xref keyref="onUserMuteAudio"/> and <xref keyref="onRemoteAudioStateChanged"/> callbacks on the remote client.</li>
</ul></note> </section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<p>
<note>
<ul>
<li>Call this method after <xref keyref="joinChannel2"/>.</li>
<li>Call this method after the <xref keyref="joinChannel1"/> or <xref keyref="joinChannel2"/> method.</li>
<li>When using the spatial audio effect, if you need to set whether to stop subscribing to the audio stream of a specified user, Agora recommends calling this method instead of the <xref keyref="muteRemoteAudioStream"/> method in <xref keyref="IRtcEngine"/>.</li>
</ul>
</note>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<section id="detailed_desc">
<title>Details</title>
<p>After successfully calling this method, the SDK calculates the spatial audio parameters based on the relative position of the local and remote user.</p>
<note type="note">Call this method after <xref keyref="joinChannel2" />.</note> </section>
<note type="note">Call this method after the <xref keyref="joinChannel1"/> or <xref keyref="joinChannel2"/> method.</note> </section>
<section id="parameters">
<title>Parameters</title>
<parml>
Expand Down
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_imediaengine_registerfaceinfoobserver">
<title><ph keyref="registerFaceInfoObserver" /></title>
<shortdesc id="short"><ph id="shortdesc">Registers a facial information observer.</ph></shortdesc>
<shortdesc id="short"><ph id="shortdesc"><ph props="native">Registers or unregisters a facial information observer. </ph><ph props="electron rn flutter unity">Registers a facial information observer.</ph></ph></shortdesc>
<prolog>
<metadata>
<keywords>
Expand Down Expand Up @@ -47,7 +47,7 @@
<parml>
<plentry>
<pt>observer</pt>
<pd>Facial information observer, see <xref keyref="IFaceInfoObserver"/>.</pd>
<pd><ph>Facial information observer, see <xref keyref="IFaceInfoObserver"/>. </ph><ph props="native">If you need to unregisters a facial information observer, pass in <ph keyref="NULL" />.</ph></pd>
Nero-Hu marked this conversation as resolved.
Show resolved Hide resolved
</plentry>
</parml> </section>
<section id="return_values">
Expand Down
1 change: 1 addition & 0 deletions en-US/dita/RTC-NG/API/api_imediaplayer_open.dita
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
<title>Details</title>
<p props="hide">On the Android platform, if you need to open a file in URI format, use <xref keyref="open2" />.</p>
<p id="uri" props="android">This method supports playing URI files starting with <codeph>content://</codeph>.</p>
<p id="format" props="native">For supported formats of Agora media player, see <xref keyref="media-player"/>.</p>
<p props="hide">If you want to choose the CDN route for playing the media resource, you can call the <xref keyref="openWithAgoraCDNSrc" /> method. Agora changes the CDN route through the self-developed scheduling center to improve the viewing user experience. If you do not need to choose the CDN route for playing the media resource, you can call the <xref keyref="open" /> method.</p>
<note type="attention" id="note">
<p props="native unreal bp unity electron flutter cs">This method is called asynchronously.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
<title>Details</title>
<p>This method supports opening media files of different sources, including a custom media source, and allows you to configure the playback scenarios.</p>
<p conkeyref="open/uri" props="android"/>
<p conkeyref="open/format" props="native"/>
</section>
<section id="parameters">
<title>Parameters</title>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
<li>Video captured by a camera and encoded in H.264 or H.265.</li>
</ul></p>
<p>Once the recording is started, if the video resolution is changed, the SDK stops the recording; if the sampling rate and audio channel changes, the SDK continues recording and generates audio files respectively.</p>
<p>The SDK can generate a recording file only when it detects audio and video streams; when there are no audio and video streams to be recorded or the audio and video streams are interrupted for more than 5 seconds, the SDK stops the recording and triggers the <codeph><apiname keyref="onRecorderStateChanged"/>(<apiname keyref="RECORDER_STATE_ERROR"/>, <apiname keyref="RECORDER_ERROR_NO_STREAM"/>)</codeph> callback.</p>
<p>The SDK can generate a recording file only when it detects audio and video streams; when there are no audio and video streams to be recorded or the audio and video streams are interrupted for more than 5 seconds, the SDK stops the recording and triggers the <apiname keyref="onRecorderStateChanged"/>(<codeph><ph keyref="RECORDER_STATE_ERROR"/>,<ph keyref="RECORDER_ERROR_NO_STREAM"/></codeph> ) callback.</p>

<note type="attention">
<ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
<dd>This method is deprecated. Use <xref keyref="addVideoWatermark2" /> instead.</dd>
</dlentry>
</dl>
<p>This method adds a PNG watermark image to the local video stream in a live streaming session. Once the watermark image is added, all the users in the channel (CDN audience included) and the video capturing device can see and capture it. If you only want to add a watermark to the CDN live streaming, see descriptions in <xref keyref="startRtmpStreamWithTranscoding" />.</p>
<p>This method adds a PNG watermark image to the local video stream in a live streaming session. Once the watermark image is added, all the users in the channel (CDN audience included) and the video capturing device can see and capture it. If you only want to add a watermark to the CDN live streaming, see <xref keyref="startRtmpStreamWithTranscoding" />.</p>
<note type="attention">
<ul>
<li>The URL descriptions are different for the local video and CDN live streaming: In a local video stream, URL refers to the absolute path of the added watermark image file in the local video stream. In a CDN live stream, URL refers to the URL address of the added watermark image in the CDN live streaming.</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,26 @@
<codeblock props="android" outputclass="language-java">public abstract int adjustPlaybackSignalVolume(int volume);</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)adjustPlaybackSignalVolume:(NSInteger)volume;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int adjustPlaybackSignalVolume(int volume) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|RtcEngineProxy&quot;)
int AdjustPlaybackSignalVolume(int volume);</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|RtcEngineProxy&quot;)
int AdjustPlaybackSignalVolume(int volume);</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract adjustPlaybackSignalVolume(volume: number): number;</codeblock>
<codeblock props="unity cs" outputclass="language-csharp">public abstract int AdjustPlaybackSignalVolume(int volume);</codeblock>
<codeblock props="rn" outputclass="language-typescript">abstract adjustPlaybackSignalVolume(volume: number): number;</codeblock>
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; adjustPlaybackSignalVolume(int volume);</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>Details</title>
<note type="attention">
<ul>
<li>This method adjusts the playback volume that is the mixed volume of all remote users.</li>
<li>You can call this method either before or after joining a channel.</li>
</ul> </note> </section>
<section id="parameters">
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<p>This method is used to adjust the signal volume of all remote users mixed and played locally. If you need to adjust the signal volume of a specified remote user played locally, it is recommended that you call <xref keyref="adjustUserPlaybackSignalVolume"/> instead.</p>
</section>
<section id="timing" deliveryTarget="details">
<title>Call timing</title>
<p>It 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="parameters" deliveryTarget="details">
<title>Parameters</title>
<parml>
<plentry conkeyref="adjustRecordingSignalVolume/volume">
Expand All @@ -46,5 +50,5 @@
<li>0: Success.</li>
<li> &lt; 0: Failure. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph></li>
</ul> </section>
</refbody>
</refbody>
</reference>
Original file line number Diff line number Diff line change
Expand Up @@ -16,27 +16,33 @@
<codeblock props="android" outputclass="language-java">public abstract int adjustRecordingSignalVolume(int volume);</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)adjustRecordingSignalVolume:(NSInteger)volume;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int adjustRecordingSignalVolume(int volume) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|RtcEngineProxy&quot;)
int AdjustRecordingSignalVolume(int volume);</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|RtcEngineProxy&quot;)
int AdjustRecordingSignalVolume(int volume);</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract adjustRecordingSignalVolume(volume: number): number;</codeblock>
<codeblock props="unity cs" outputclass="language-csharp">public abstract int AdjustRecordingSignalVolume(int volume);</codeblock>
<codeblock props="rn" outputclass="language-typescript">abstract adjustRecordingSignalVolume(volume: number): number;</codeblock>
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; adjustRecordingSignalVolume(int volume);</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>Details</title>
<note type="attention">
<p>You can call this method either before or after joining a channel.</p>
</note> </section>
<section id="parameters">
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<p>If you only need to mute the audio signal, Agora recommends that you use <xref keyref="muteRecordingSignal"/> instead.</p>
</section>
<section id="timing" deliveryTarget="details">
<title>Call timing</title>
<p>It 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="parameters" deliveryTarget="details">
<title>Parameters</title>
<parml>
<plentry id="volume">
<pt>volume</pt>
<pd>
<p>The volume of the user. The value range is [0,400].<ul>
<li>0: Mute.<note type="note">If you only need to mute the audio signal, Agora recommends that you use <xref keyref="muteRecordingSignal"/> instead.</note></li>
<li>0: Mute.</li>
<li>100: (Default) The original volume.</li>
<li>400: Four times the original volume (amplifying the audio signals by four times).</li>
</ul></p>
Expand All @@ -50,5 +56,5 @@
<li>0: Success.</li>
<li>&lt; 0: Failure. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph></li>
</ul> </section>
</refbody>
</refbody>
</reference>
Original file line number Diff line number Diff line change
Expand Up @@ -16,31 +16,34 @@
<codeblock props="android" outputclass="language-java">public abstract int adjustUserPlaybackSignalVolume(int uid, int volume);</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)adjustUserPlaybackSignalVolume:(NSUInteger)uid volume:(int)volume;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int adjustUserPlaybackSignalVolume(unsigned int uid, int volume) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|RtcEngineProxy&quot;)
int AdjustUserPlaybackSignalVolume(int uid, int volume);</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|RtcEngineProxy&quot;)
int AdjustUserPlaybackSignalVolume(int uid, int volume);</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract adjustUserPlaybackSignalVolume(uid: number, volume: number): number;</codeblock>
<codeblock props="unity cs" outputclass="language-csharp">public abstract int AdjustUserPlaybackSignalVolume(uint uid, int volume);</codeblock>
<codeblock props="rn" outputclass="language-typescript">abstract adjustUserPlaybackSignalVolume(uid: number, volume: number): number;</codeblock>
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; adjustUserPlaybackSignalVolume(
{required int uid, required int volume});</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>Details</title>
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<p>You can call this method to adjust the playback volume of a specified remote user. To adjust the playback volume of different remote users, call the method as many times, once for each remote user.</p>
<note type="attention">
<ul>
<li>Call this method after joining a channel.</li>
<li>The playback volume here refers to the mixed volume of a specified remote user.</li>
</ul> </note> </section>
<section id="parameters">
</section>
<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>None.</p>
</section>
<section id="parameters" deliveryTarget="details">
<title>Parameters</title>
<parml>
<plentry id="uid">
<pt>uid</pt>
<pd>The user ID of the remote user.</pd>
</plentry>
<plentry id="volume" conkeyref="adjustAudioMixingVolume/volume">
<plentry conkeyref="adjustRecordingSignalVolume/volume">
<pt />
<pd />
</plentry>
Expand All @@ -52,5 +55,5 @@
<li>0: Success.</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>
</refbody>
</reference>
9 changes: 2 additions & 7 deletions en-US/dita/RTC-NG/API/api_irtcengine_complain.dita
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,9 @@
<ul props="native unreal bp electron unity 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>-1: A general error occurs (no specified reason).</li>
<li>-2: The parameter is invalid.</li>
<li>- 3: The SDK is not ready. Possible reasons include the following:<ul>
<li>The initialization of <xref keyref="IRtcEngine" /> fails. Reinitialize the <apiname keyref="IRtcEngine" />.</li>
<li>No user has joined the channel when the method is called. Please check your code logic.</li>
<li>The user has not left the channel when the <xref keyref="rate" /> or <xref keyref="complain" /> method is called. Please check your code logic.</li>
<li>The audio module is disabled. The program is not complete.</li>
</ul></li>
</ul></li>
<li>-7: The method is called before <xref keyref="IRtcEngine"/> is initialized.</li></ul></li>
</ul> </section>
</refbody>
</reference>
Loading
Loading