Skip to content

Commit acb5636

Browse files
Cilla-luodanSuri539Nero-Hu
authored
New YiCAT updates (#3910)
* New translations * New translations * New translations * New translations * New translations * New translations * New translations * New translations * New translations * New translations * New translations * New translations * New translations * New translations * New translations * New translations * New translations * New translations * New translations * New translations * New translations * 4.5.1 framework (#3907) * update unity&unreal keysmap * add bp&unreal props * Update release_notes.dita * Update keys-rtc-ng-api-flutter.ditamap * Electron/RN: add keys * Update keys-rtc-ng-api-blueprint.ditamap * RN/Electron: add ai keys CN * Update keys-rtc-ng-links.ditamap --------- Co-authored-by: Nero-Hu <[email protected]> * New translations * New translations * New translations * New translations * New translations * delete rte api * Update api_imediaengine_pushvideoframe.dita --------- Co-authored-by: Suri539 <[email protected]> Co-authored-by: Nero-Hu <[email protected]> Co-authored-by: Suri539 <[email protected]>
1 parent 03c5733 commit acb5636

19 files changed

+80
-354
lines changed

en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
</dlentry>
4040
</dl>
4141
<p id="desc1">To publish a custom video source, see the following steps:<ol>
42-
<li>Call <xref keyref="createCustomVideoTrack"/> to create a video track and get the video track ID.</li>
42+
<li>Call <xref keyref="createCustomVideoTrack"/> to create a video track and get the video track ID.<note type="note">If you only need to push one custom video source to the channel, you can directly call the <xref keyref="setExternalVideoSource"/> method and the SDK will automatically create a video track with the <parmname>videoTrackId</parmname> set to 0.</note></li>
4343
<li>Call <xref keyref="joinChannel2"/> to join the channel. In <xref keyref="ChannelMediaOptions"/>, set <parmname>customVideoTrackId</parmname> to the video track ID that you want to publish, and set <parmname>publishCustomVideoTrack</parmname> to <codeph><ph keyref="true"/></codeph>.</li>
4444
<li>Call this method and specify <parmname>videoTrackId</parmname> as the video track ID set in step 2. You can then publish the corresponding custom video source in the channel.</li></ol></p>
4545
<note type="danger" id="desc2">After calling this method, even if you stop pushing external video frames to the SDK, the custom video stream will still be counted as the video duration usage and incur charges. Agora recommends that you take appropriate measures based on the actual situation to avoid such video billing.<ul>
@@ -63,8 +63,8 @@
6363
</plentry>
6464
<plentry id="videotrackid">
6565
<pt>videoTrackId</pt>
66-
<pd>The video track ID returned by calling the <apiname keyref="createCustomVideoTrack"/> method. The default value is 0.</pd>
67-
</plentry>
66+
<pd>The video track ID returned by calling the <apiname keyref="createCustomVideoTrack"/> method.<note type="note">If you only need to push one custom video source, set <parmname>videoTrackId</parmname> to 0.</note></pd>
67+
</plentry>
6868
</parml>
6969
</section>
7070
<section id="return_values">

en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@
4848
<p>Call this method after calling <xref keyref="enableVideo"/> or <xref keyref="startPreview2"/>.</p>
4949
<note type="attention" id="hardware_req">
5050
<ul>
51+
<li>Using a video as a your virtual background will lead to continuous increase in memory usage, which may cause issues such as app crashes. Therefore,it is recommended to reduce the resolution and frame rate of the video when using it.</li>
5152
<li>This feature has high requirements on device performance. When calling this method, the SDK automatically checks the capabilities of the current device. Agora recommends you use virtual background on devices with the following processors:<ul>
5253
<li props="android unity cpp unreal bp rn flutter cs">Snapdragon 700 series 750G and later</li>
5354
<li props="android unity cpp unreal bp rn flutter cs">Snapdragon 800 series 835 and later</li>

en-US/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
<note type="attention">
4646
<ul>
4747
<li>This method needs to be called after <xref keyref="createDataStream2" /> and joining the channel.</li>
48-
<li>In live streaming scenarios, this method only applies to hosts.</li>
48+
<li>This method applies to broadcasters only.</li>
4949
</ul></note> </section>
5050
<section id="parameters">
5151
<title>Parameters</title>

en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,11 @@
6969
<pt props="ios mac">mirror</pt>
7070
<pd>
7171
<p props="ios mac cpp unreal bp unity flutter rn electron cs">The mirror mode of the remote user view. See <xref keyref="VIDEO_MIRROR_MODE_TYPE" />.</p>
72-
<p props="android hmos">The mirror mode of the remote user view.<ul conkeyref="setLocalRenderMode2/videomirrormodetype">
73-
<li />
74-
</ul> </p>
72+
<p props="android hmos">The mirror mode of the remote user view.<ul>
73+
<li><ph keyref="VIDEO_MIRROR_MODE_AUTO" />(0): The SDK determines whether to enable the mirror mode. The SDK disables mirror mode by default.</li>
74+
<li><ph keyref="VIDEO_MIRROR_MODE_ENABLED" />(1): Enables the mirror mode for remote user's view.</li>
75+
<li><ph keyref="VIDEO_MIRROR_MODE_DISABLED" />(2): Disables the mirror mode for remote user's view.</li>
76+
</ul></p>
7577
<note conkeyref="setLocalRenderMode2/mirror" props="unreal bp"/>
7678
</pd>
7779
</plentry>

en-US/dita/RTC-NG/API/api_irtcengine_setvideoscenario.dita

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@
7272
</li>
7373
</ul>
7474
</p>
75-
<p id="1v1"><apiname keyref="APPLICATION_SCENARIO_1V1"/>(2) This is applicable to the <xref keyref="one-to-one-live"/> scenario. To meet the requirements for low latency and high-quality video in this scenario, the SDK optimizes its strategies, improving performance in terms of video quality, first frame rendering, latency on mid-to-low-end devices, and smoothness under weak network conditions.</p>
75+
<p id="1v1"><apiname keyref="APPLICATION_SCENARIO_1V1"/>(2) This is applicable to the <xref keyref="one-to-one-live"/> scenario. To meet the requirements for low latency and high-quality video in this scenario, the SDK optimizes its strategies, improving performance in terms of video quality, first frame rendering, latency on mid-to-low-end devices, and smoothness under weak network conditions.<note type="attention">This enumeration value is only applicable to the broadcaster vs. broadcaster scenario.</note></p>
7676
<p id="liveshow"><apiname keyref="APPLICATION_SCENARIO_LIVESHOW"/>(3) This is applicable to the <xref keyref="showroom"/> scenario. In this scenario, fast video rendering and high image quality are crucial. The SDK implements several performance optimizations, including automatically enabling accelerated audio and video frame rendering to minimize first-frame latency (no need to call <xref keyref="enableInstantMediaRendering"/>), and B-frame encoding to achieve better image quality and bandwidth efficiency. The SDK also provides enhanced video quality and smooth playback, even in poor network conditions or on lower-end devices.</p>
7777
</pd>
7878
</plentry>

en-US/dita/RTC-NG/API/api_irtcengineex_sendstreammessageex.dita

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,6 @@
4444
<li props="android apple cpp unity flutter">If you need a more comprehensive solution for low-latency, high-concurrency, and scalable real-time messaging and status synchronization, it is recommended to use <xref keyref="rtm2"/>.</li>
4545
<li>Call this method after <xref keyref="joinChannelEx"/>.</li>
4646
<li>Ensure that you call <apiname keyref="createDataStreamEx2" /> to create a data channel before calling this method.</li>
47-
<li>This method applies only to the COMMUNICATION profile or to the hosts in the LIVE_BROADCASTING profile. If an audience in the LIVE_BROADCASTING profile calls this method, the audience may be switched to a host.</li>
4847
</ul></note> </section>
4948
<section id="parameters">
5049
<title>Parameters</title>

en-US/dita/RTC-NG/API/api_player_muteaudio.dita

Lines changed: 0 additions & 73 deletions
This file was deleted.

en-US/dita/RTC-NG/API/api_player_mutevideo.dita

Lines changed: 0 additions & 73 deletions
This file was deleted.

en-US/dita/RTC-NG/API/api_player_openwithurl.dita

Lines changed: 0 additions & 70 deletions
This file was deleted.

0 commit comments

Comments
 (0)