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

Merged
merged 16 commits into from
Oct 25, 2024
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
<parml>
<plentry>
<pt>zones</pt>
<pd>Sound insulation area settings. See <apiname keyref="SpatialAudioZone"/>. When you set this parameter to <codeph><ph keyref="NULL"/></codeph>, it means clearing all sound insulation zones.<note type="attention" props="cpp unreal bp unity cs flutter electron">On the Windows platform, it is necessary to ensure that the number of members in the <parmname>zones</parmname> array is equal to the value of <parmname>zoneCount</parmname>; otherwise, it may cause a crash.</note></pd>
<pd>Sound insulation area settings. See <xref keyref="SpatialAudioZone"/>. When you set this parameter to <codeph><ph keyref="NULL"/></codeph>, it means clearing all sound insulation zones.<note type="attention" props="cpp unreal bp unity cs flutter electron">On the Windows platform, it is necessary to ensure that the number of members in the <parmname>zones</parmname> array is equal to the value of <parmname>zoneCount</parmname>; otherwise, it may cause a crash.</note></pd>
</plentry>
<plentry props="cpp framework">
<pt>zoneCount</pt>
Expand Down
2 changes: 1 addition & 1 deletion en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
</section>
<section id="detailed_desc">
<title>Details</title>
<dl outputclass="deprecated" props="android hmos">
<dl outputclass="deprecated" props="android">
<dlentry>
<dt>Deprecated:</dt>
<dd>If you need to push video frames in I422 format, you need to use this method; otherwise, use <xref keyref="pushVideoFrame3"/>.</dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public abstract int registerAudioFrameObserver(IAudioFrameObserver observer);</codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract registerAudioFrameObserver(observer:IAudioFrameObserver):number;</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (BOOL)setAudioFrameDelegate:(id&lt;AgoraAudioFrameDelegate&gt; _Nullable)delegate;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int registerAudioFrameObserver(IAudioFrameObserver* observer) = 0;</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract registerAudioFrameObserver(observer: IAudioFrameObserver): number;</codeblock>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,20 +30,10 @@
</section>
<section id="detailed_desc">
<title>Details</title>
<p>If you only want to observe encoded video frames (such as h.264 format) without decoding and rendering the video, Agora recommends that you implement one <xref keyref="IVideoEncodedFrameObserver"/> class through this method.</p>
<p id="mix">If you want to obtain the original video data of some remote users (referred to as group A) and the encoded video data of other remote users (referred to as group B), you can refer to the following steps:<ol>
<li>Call <xref keyref="registerVideoFrameObserver"/> to register the raw video frame observer before joining the channel.</li>
<li>Call <xref keyref="registerVideoEncodedFrameObserver"/> to register the encoded video frame observer before joining the channel.</li>
<li>After joining the channel, get the user IDs of group B users through <xref keyref="onUserJoined"/>, and then call <xref keyref="setRemoteVideoSubscriptionOptions"/> to set the <parmname>encodedFrameOnly</parmname> of this group of users to <codeph><ph keyref="true"/></codeph>.</li>
<li>Call <xref keyref="muteAllRemoteVideoStreams"/><codeph>(<ph keyref="false"/>)</codeph>to start receiving the video streams of all remote users. Then:<ul>
<li>The raw video data of group A users can be obtained through the callback in <xref keyref="IVideoFrameObserver"/>, and the SDK renders the data by default.</li>
<li>The encoded video data of group B users can be obtained through the callback in <xref keyref="IVideoEncodedFrameObserver"/>.</li>
</ul> </li>
</ol> </p>
<p>If you only want to observe encoded video frames (such as H.264 format) without decoding and rendering the video, Agora recommends that you implement one <xref keyref="IVideoEncodedFrameObserver"/> class through this method. <ph props="android cpp apple">For detailed implementation steps, please refer to <xref keyref="video-processing"/>.</ph></p>
<note type="attention">
<ul>
<li>Call this method before joining a channel.</li>
</ul></note> </section>
<p>Call this method before joining a channel.</p>
</note> </section>
<section id="parameters">
<title>Parameters</title>
<parml>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public abstract int registerVideoFrameObserver(IVideoFrameObserver observer);</codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract registerVideoFrameObserver(observer:IVideoFrameObserver):number;</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (BOOL)setVideoFrameDelegate:(id&lt;AgoraVideoFrameDelegate&gt; _Nullable)delegate;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int registerVideoFrameObserver(IVideoFrameObserver* observer) = 0;</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract registerVideoFrameObserver(observer: IVideoFrameObserver): number;</codeblock>
Expand All @@ -26,11 +26,10 @@
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<p>If you want to observe raw video frames (such as YUV or RGBA format), Agora recommends that you implement one <xref keyref="IVideoFrameObserver"/> class with this method.</p>
<p>When calling this method to register a video observer, you can register callbacks in the <apiname keyref="IVideoFrameObserver"/> class as needed. After you successfully register the video frame observer, the SDK triggers the registered callbacks each time a video frame is received.</p>
<p conkeyref="registerVideoEncodedFrameObserver/mix"/>
</section>
<section id="scenario" deliveryTarget="details">
<title>Applicable scenarios</title>
<p>After registering the raw video observer, you can use the obtained raw video data in various video pre-processing scenarios, such as virtual backgrounds and image enhacement by yourself.</p>
<p>After registering the raw video observer, you can use the obtained raw video data in various video pre-processing scenarios, such as virtual backgrounds and image enhacement by yourself. <ph props="android cpp apple">For detailed implementation steps, please refer to <xref keyref="video-processing"/>.</ph></p>
<p props="android ios">Agora provides an open source sample project <xref keyref="beautyapi-link"/> on GitHub for your reference.</p>
</section>
<section id="timing" deliveryTarget="details">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<p>After calling this method to enable an external video source, you can call <xref keyref="pushVideoFrame"/> to push external video data to the SDK.</p>
<p props="android cpp apple framework">After calling this method to enable an external video source, you can call <xref keyref="pushVideoFrame"/> to push external video data to the SDK.</p>
<p props="hmos">After calling this method to enable an external video source, you can call <xref keyref="pushVideoFrame3"/> to push external video data to the SDK.</p>
</section>
<section id="timing" deliveryTarget="details">
<title>Call timing</title>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">int adjustPlayoutVolume(int volume);</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract adjustPlayoutVolume(vol: number): number;</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)adjustPlayoutVolume:(int)volume;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int adjustPlayoutVolume(int volume) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">int adjustPublishSignalVolume(int volume);</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract adjustPublishSignalVolume(volume:number):number;</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)adjustPublishSignalVolume:(int)volume;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int adjustPublishSignalVolume(int volume) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
Expand Down
4 changes: 2 additions & 2 deletions en-US/dita/RTC-NG/API/api_imediaplayer_getduration.dita
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">long getDuration();</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract getDuration():number;</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (NSInteger)getDuration;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getDuration(int64_t&amp; duration) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
Expand All @@ -40,7 +40,7 @@
<li>&lt; 0: Failure. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph></li>
</ul>
<p props="electron rn flutter">The total duration (ms) of the media file.</p>
<ul props="apple android">
<ul props="apple android hmos">
<li>If the method call succeeds, the SDK returns the total duration(ms) of the media file.</li>
<li>&lt; 0: Failure. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph></li>
</ul></section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">int getMediaPlayerId();</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract getMediaPlayerId():number;</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)getMediaPlayerId;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getMediaPlayerId() const = 0; </codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
Expand Down
4 changes: 2 additions & 2 deletions en-US/dita/RTC-NG/API/api_imediaplayer_getmute.dita
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">boolean getMute();</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract getMute(): boolean;</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (bool)getMute;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getMute(bool&amp; mute) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
Expand Down Expand Up @@ -43,7 +43,7 @@
<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>
<ul props="electron rn flutter ios mac android">
<ul props="electron rn flutter ios mac android hmos">
<li><codeph><ph keyref="true" /></codeph>: Reports whether the media resource is muted.</li>
<li><codeph><ph keyref="false" /></codeph>: Reports whether the media resource is muted.</li></ul></section>
</refbody>
Expand Down
4 changes: 2 additions & 2 deletions en-US/dita/RTC-NG/API/api_imediaplayer_getplayoutvolume.dita
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">int getPlayoutVolume();</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract getPlayoutVolume():number</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)getPlayoutVolume;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getPlayoutVolume(int&amp; volume) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
Expand Down Expand Up @@ -42,7 +42,7 @@
<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>
<p props="android apple electron rn flutter">The local playback volume, which ranges from 0 to 100.<ul>
<p props="android hmos apple electron rn flutter">The local playback volume, which ranges from 0 to 100.<ul>
<li>0: Mute.</li>
<li>100: (Default) The original volume.</li>
</ul></p> </section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">long getPlayPosition();</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract getPlayPosition():number;</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (NSInteger)getPosition;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getPlayPosition(int64_t&amp; pos) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
Expand Down
2 changes: 1 addition & 1 deletion en-US/dita/RTC-NG/API/api_imediaplayer_getplaysrc.dita
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">String getPlaySrc();</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract getPlaySrc():string;</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (NSString *)getPlaySrc;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual const char* getPlaySrc() = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">int getPublishSignalVolume();</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract getPublishSignalVolume():number;</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)getPublishSignalVolume;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getPublishSignalVolume(int&amp; volume) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
Expand All @@ -39,7 +39,7 @@
<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>
<ul props="android ios mac rn electron flutter">
<ul props="android hmos ios mac rn electron flutter">
<li>≥ 0: The remote playback volume.</li>
<li>&lt; 0: Failure. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph></li>
</ul> </section>
Expand Down
2 changes: 1 addition & 1 deletion en-US/dita/RTC-NG/API/api_imediaplayer_getstate.dita
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">Constants.MediaPlayerState getState();</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract getState():Constants.MediaPlayerState;</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (AgoraMediaPlayerState)getPlayerState;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual media::base::MEDIA_PLAYER_STATE getState() = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
Expand Down
2 changes: 1 addition & 1 deletion en-US/dita/RTC-NG/API/api_imediaplayer_getstreamcount.dita
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">int getStreamCount();</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract getStreamCount():number;</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (NSInteger)getStreamCount;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getStreamCount(int64_t&amp; count) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
Expand Down
Loading
Loading