diff --git a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setmaxaudiorecvcount.dita b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setmaxaudiorecvcount.dita index 0eb20bb4de4..ae53623fff4 100644 --- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setmaxaudiorecvcount.dita +++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setmaxaudiorecvcount.dita @@ -28,7 +28,7 @@
Details

If the number of receivable streams exceeds the set value, the local user receives the maxCount streams that are closest to the local user.

- 因为服务端空间音效不发布，所以不能体现 enterRoom。You can call this method either before or after , with the following differences:
    + 因为服务端空间音频不发布，所以不能体现 enterRoom。You can call this method either before or after , with the following differences:
    • If you call this method before , this method takes effect when entering the room.
    • If you call this method after , this method takes effect immediately and changes the current maximum number of received streams of the local user.
diff --git a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita index 5fdaa530b6f..6edf5bc8809 100644 --- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita +++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita @@ -32,11 +32,18 @@ {required int playerId, required RemoteVoicePositionInfo positionInfo});

-
- Details +

After a successful update, the local user can hear the change in the spatial position of the media player.

-
+
+ Call timing +

This method can be called either before or after joining the channel.

+
+
+ Restrictions +

None.

+
+
Parameters diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_adjustplayoutvolume.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_adjustplayoutvolume.dita index 5603a1bfb13..f1c93eea3a8 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_adjustplayoutvolume.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_adjustplayoutvolume.dita @@ -25,7 +25,16 @@ Future<void> adjustPlayoutVolume(int volume);

-
+
+
+ Call timing +

This method can be called either before or after joining the channel.

+
+
+ Restrictions +

None.

+
+
Parameters diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_adjustpublishsignalvolume.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_adjustpublishsignalvolume.dita index 206df9d6812..5a186d2b161 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_adjustpublishsignalvolume.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_adjustpublishsignalvolume.dita @@ -25,11 +25,18 @@ Future<void> adjustPublishSignalVolume(int volume);

-
- Details +

After connected to the Agora server, you can call this method to adjust the volume of the media file heard by the remote user.

-
+
+ Call timing +

This method can be called either before or after joining the channel.

+
+
+ Restrictions +

None.

+
+
Parameters diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_getstreaminfo.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_getstreaminfo.dita index 7de0cb4d344..057f61bd2c2 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_getstreaminfo.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_getstreaminfo.dita @@ -25,10 +25,16 @@ Future<PlayerStreamInfo> getStreamInfo(int index);

-
- Details - Call this method after calling .
-
+
+
+ Call timing +

Call this method after calling .

+
+
+ Restrictions +

None.

+
+
Parameters diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_mute.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_mute.dita index 799c02c4e11..300e99453c5 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_mute.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_mute.dita @@ -25,7 +25,16 @@ Future<void> mute(bool muted);

-
+
+
+ Call timing +

You can call this method either before or after joining a channel.

+
+
+ Restrictions +

None.

+
+
Parameters diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_open.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_open.dita index d9e88ce38a3..a101154ea58 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_open.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_open.dita @@ -27,17 +27,27 @@ Future<void> open({required String url, required int startPos});

-
- Details +

On the Android platform, if you need to open a file in URI format, use .

This method supports playing URI files starting with content://.

For supported formats of Agora media player, see .

If you want to choose the CDN route for playing the media resource, you can call the 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 method.

This method is called asynchronously.

-

If you need to play a media file, make sure you receive the callback reporting before calling the method to play the file.
-
+
+ Call timing +

This method can be called either before or after joining the channel.

+
+
+ Restrictions +

None.

+
+ +
Parameters diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_pause.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_pause.dita index c9ad60f1352..77f451f49f3 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_pause.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_pause.dita @@ -27,6 +27,16 @@ Future<void> pause();

+
+ +
+ Call timing +

You can call this method either before or after joining a channel.

+
+
+ Restrictions +

None.

+
<ph keyref="return-section-title"/>

When the method call succeeds, there is no return value; when fails, the exception is thrown. You need to catch the exception and handle it accordingly. See for details and resolution suggestions.

diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_play.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_play.dita index e3a018e2ec5..aad566ba837 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_play.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_play.dita @@ -25,9 +25,15 @@ Future<void> play();

-
- Details -

After calling or , you can call this method to play the media file.

+
+
+ Call timing +
  • Call this method after calling or opening a media file and receiving a callback reporting the status as .
    • +
  • Call the method after calling .
+
+
+ Restrictions +

None.

<ph keyref="return-section-title"/> diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_registerplayersourceobserver.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_registerplayersourceobserver.dita index 26e2443c36f..bb24ef9a2d4 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_registerplayersourceobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_registerplayersourceobserver.dita @@ -30,7 +30,16 @@ void registerPlayerSourceObserver(MediaPlayerSourceObserver observer);

-
+
+
+ Call timing +

This method can be called either before or after joining the channel.

+
+
+ Restrictions +

None.

+
+
Parameters diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_seek.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_seek.dita index 93b68241b41..d1e4ff2afaa 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_seek.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_seek.dita @@ -27,15 +27,24 @@ Future<void> seek(int newPos);

-
- Details +
+
    +
  • If you call after the playback has completed (upon receiving callback reporting playback status as or ), the SDK will play the media file from the specified position. At this point, you will receive callback reporting playback status as .
    • +
  • If you call while the playback is paused, upon successful call of this method, the SDK will seek to the specified position. To resume playback, call or .
    • +
+
+ Call timing +

You can call this method either before or after joining a channel.

+
+
+ Restrictions +

None.

+
+ -
+
Parameters diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_setloopcount.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setloopcount.dita index b2779ddbda7..f281bf20dfa 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setloopcount.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setloopcount.dita @@ -37,7 +37,11 @@ loopCount - The number of times the audio effect loops: + The number of times the audio effect loops:
    +
  • ≥0: Number of times for playing. For example, setting it to 0 means no loop playback, playing only once; setting it to 1 means loop playback once, playing a total of twice.
    • +
  • -1: Play the audio file in an infinite loop.
    • +
+
diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_setplayeroption.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setplayeroption.dita index 4a34c4b78a7..9b99b105d13 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setplayeroption.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setplayeroption.dita @@ -2,7 +2,7 @@ <ph keyref="setPlayerOption"/> - Set media player options for providing technical previews or special customization features. + Sets media player options. @@ -23,13 +23,24 @@ Future<void> setPlayerOptionInInt({required String key, required int value});

-
- Details -

The media player supports setting options through key and value. In general, you don't need to know about the option settings. You can use the default option settings of the media player.

+
+

The media player supports setting options through key and value.

The difference between this method and is that the value parameter of this method is of type Int, while the value of is of type String. These two methods cannot be used together.

- Ensure that you call this method before or .
-
- Parameters +
+
+ Applicable scenarios +

Scenarios that require technical previews or special customization features. In general, you do not need to call this method; you can simply use the default options provided by the media player.

+
+
+ Call timing +

Call this method before the or method.

+
+
+ Restrictions +

None.

+
+
+ Parameters key diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_setplayeroption2.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setplayeroption2.dita index 5cc4c180315..bc79bde8251 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setplayeroption2.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setplayeroption2.dita @@ -2,7 +2,7 @@ <ph keyref="setPlayerOption2"/> - Set media player options for providing technical previews or special customization features. + Sets media player options. @@ -24,13 +24,17 @@ {required String key, required String value});

-
- Details +

The difference between this method and is that the value parameter of this method is of type String, while the value of is of type String. These two methods cannot be used together.

-
-
-
+
+
+
+
+ Restrictions +

None.

+
+
<ph keyref="return-section-title"/>

When the method call succeeds, there is no return value; when fails, the exception is thrown. You need to catch the exception and handle it accordingly. See for details and resolution suggestions.

diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_setview.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setview.dita index 45f7b8bd28e..9c7ebcdf393 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setview.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setview.dita @@ -30,9 +30,17 @@
In Flutter, you don't need to call this method. Use instead to render local and remote views.
-
- Parameters - +
+ Call timing +

You can call this method either before or after joining a channel.

+
+
+ Restrictions +

None.

+
+
+ <ph props="native flutter unreal bp electron rn">Parameters</ph> + videoView view diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_stop.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_stop.dita index 1e88b692805..0257a757cb3 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_stop.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_stop.dita @@ -26,6 +26,17 @@ Future<void> stop();

+
+

After calling this method to stop playback, if you want to play again, you need to call or to open the media resource.

+
+
+ Call timing +

Call this method after .

+
+
+ Restrictions +

None.

+
<ph keyref="return-section-title"/>

When the method call succeeds, there is no return value; when fails, the exception is thrown. You need to catch the exception and handle it accordingly. See for details and resolution suggestions.

diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingplayoutvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingplayoutvolume.dita index 89a27884908..ff564306256 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingplayoutvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingplayoutvolume.dita @@ -25,10 +25,17 @@ Future<void> adjustAudioMixingPlayoutVolume(int volume);

-
- Details - Call this method after calling and receiving the () callback.
-
+
+
+
+ Call timing +

You need to call this method after calling and receiving the () callback.

+
+
+ Restrictions +

None.

+
+
Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingpublishvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingpublishvolume.dita index c0404584144..3454fe9381b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingpublishvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingpublishvolume.dita @@ -25,13 +25,18 @@ Future<void> adjustAudioMixingPublishVolume(int volume);

-
- Details +

This method adjusts the volume of audio mixing for publishing (sending to other users).

- +
+
+ Call timing

Call this method after calling and receiving the () callback.

-
-
+
+
+ Restrictions +

None.

+
+
Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingvolume.dita index f119b6b2c12..13e069e4145 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingvolume.dita @@ -25,15 +25,19 @@ Future<void> adjustAudioMixingVolume(int volume);

-
- Details +

This method adjusts the audio mixing volume on both the local client and remote clients.

- -
    -
  • Call this method after .
    • -
  • This method does not affect the playback volume you set through the method.
    • -
-
+ This method does not affect the volume of the audio file set in the method. +
+
+ Call timing +

Call this method after .

+
+
+ Restrictions +

None.

+
+
Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_adjustuserplaybacksignalvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_adjustuserplaybacksignalvolume.dita index 6e449d3e20b..d6d8598d8b8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustuserplaybacksignalvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustuserplaybacksignalvolume.dita @@ -27,7 +27,7 @@

-

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.

+

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.

Call timing diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita b/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita index 5c438a61c2c..c235c42c743 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita @@ -25,12 +25,26 @@ Future<void> configRhythmPlayer(AgoraRhythmPlayerConfig config);

-
- Details -

After calling , you can call this method to reconfigure the virtual metronome.

+
+
    +
  • After calling , you can call this method to reconfigure the virtual metronome.
    • +
  • After enabling the virtual metronome, the SDK plays the specified audio effect file from the beginning, and controls the playback duration of each file according to beatsPerMinute you set in . For example, if you set beatsPerMinute as 60, the SDK plays one beat every second. If the file duration exceeds the beat duration, the SDK only plays the audio within the beat duration.
    • +
  • By default, the sound of the virtual metronome is published in the channel. If you want the sound to be heard by the remote users, you can set publishRhythmPlayerTrack in as .
    • +
+
+
+ Call timing +

This method can be called either before or after joining the channel.

+
+
+ Restrictions +

None.

+
+ -
+
+
Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita index c8dbef8a922..b9ec140627a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita @@ -31,7 +31,7 @@
Call timing -

Call this method after joining a channel.

+

You can call this method either before or after joining a channel.

Restrictions diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_createmediaplayer.dita b/en-US/dita/RTC-NG/API/api_irtcengine_createmediaplayer.dita index 5ab86e2cd72..c1aa6fbc28a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_createmediaplayer.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_createmediaplayer.dita @@ -27,7 +27,7 @@

-

Before calling any APIs in the class, you need to call this method to create an instance of the media player.

+

Before calling any APIs in the class, you need to call this method to create an instance of the media player. If you need to create multiple instances, you can call this method multiple times.

Call timing diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablevideoimagesource.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablevideoimagesource.dita index 8c764d5b484..d4ba07fa9f9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablevideoimagesource.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablevideoimagesource.dita @@ -33,13 +33,19 @@ {required bool enable, required ImageTrackOptions options});

-
- Details - Agora recommends that you call this method after joining a channel. +

When publishing video streams, you can call this method to replace the current video feeds with custom images.

Once you enable this function, you can select images to replace the video feeds through the parameter. If you disable this function, the remote users see the video feeds that you publish.

-
+
+ Call timing +

Call this method after joining a channel.

+
+
+ Restrictions +

None.

+
+
Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getaudiomixingduration.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getaudiomixingduration.dita index e7b5c05cc6d..a7faed131c4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getaudiomixingduration.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getaudiomixingduration.dita @@ -25,13 +25,18 @@ Future<int> getAudioMixingDuration();

-
- Details +

Retrieves the total duration (ms) of the audio.

- -

You need to call this method after calling and receiving the () callback.

-
-
+
+
+ Call timing +

Call this method after and receiving the () callback.

+
+
+ Restrictions +

None.

+
+
Returns
  • ≥ 0: The audio mixing duration, if this method call succeeds.
    • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getaudiomixingplayoutvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getaudiomixingplayoutvolume.dita index fae185d0a22..9981ca0e14a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getaudiomixingplayoutvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getaudiomixingplayoutvolume.dita @@ -25,13 +25,18 @@ Future<int> getAudioMixingPlayoutVolume();

-
- Details -

This method helps troubleshoot audio volume‑related issues.

- -

You need to call this method after calling and receiving the () callback.

-
-
+
+

You can call this method to get the local playback volume of the mixed audio file, which helps in troubleshooting volume‑related issues.

+
+
+ Call timing +

Call this method after and receiving the () callback.

+
+
+ Restrictions +

None.

+
+
Returns
  • ≥ 0: The audio mixing volume, if this method call succeeds. The value range is [0,100].
    • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getcurrentmonotonictimeinms.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getcurrentmonotonictimeinms.dita index 10389e2ba9c..5c7a6fede5e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getcurrentmonotonictimeinms.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getcurrentmonotonictimeinms.dita @@ -24,8 +24,7 @@ abstract getCurrentMonotonicTimeInMs(): number; Future<int> getCurrentMonotonicTimeInMs();

-
- Details +
Since
@@ -35,10 +34,18 @@

Monotonic Time refers to a monotonically increasing time series whose value increases over time. The unit is milliseconds.

In custom video capture and custom audio capture scenarios, in order to ensure audio and video synchronization, Agora recommends that you call this method to obtain the current Monotonic Time of the SDK, and then pass this value into the timestamp parameter in the captured video frame () and audio frame ().

+
+ Call timing +

This method can be called either before or after joining the channel.

+
+
+ Restrictions +

None.

+
Returns
    -
  • ≥0: The method call is successful, and returns the current Monotonic Time of the SDK (in milliseconds).
    • +
  • ≥0: The method call is successful, and returns the current Monotonic Time of the SDK (in milliseconds).
  • < 0: Failure. See for details and resolution suggestions.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_iscamerazoomsupported.dita b/en-US/dita/RTC-NG/API/api_irtcengine_iscamerazoomsupported.dita index f3f3195d737..8e7d34afefa 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_iscamerazoomsupported.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_iscamerazoomsupported.dita @@ -25,13 +25,17 @@ Future<bool> isCameraZoomSupported();

-
- Details - -
    -
  • This method is for Android and iOS only.
    • -
  • -
+
+ This method is for Android and iOS only. +
+
+ Call timing +

This method must be called after the SDK triggers the callback and returns the local video state as (2).

+
+
+ Restrictions +

None.

+
Returns
    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_isspeakerphoneenabled.dita b/en-US/dita/RTC-NG/API/api_irtcengine_isspeakerphoneenabled.dita index a35c181c803..751254ed65d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_isspeakerphoneenabled.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_isspeakerphoneenabled.dita @@ -25,12 +25,17 @@ Future<bool> isSpeakerphoneEnabled();

-
- -
    -
  • This method is for Android and iOS only.
    • -
  • You can call this method either before or after joining a channel.
    • -
+
+ This method is for Android and iOS only. +
+
+ Call timing +

You can call this method either before or after joining a channel.

+
+
+ Restrictions +

None.

+
Returns
    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel.dita b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel.dita index 70769ca80f6..95b7b61e1ec 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel.dita @@ -43,14 +43,16 @@ required int uid});

-
- Details -

-

-

-

  • Once a user joins the channel, the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billing calculation. To stop subscribing to a specified stream or all remote streams, call the corresponding mute methods.
    • -
  • If you choose the Testing Mode (using an App ID for authentication) for your project and call this method to join a channel, you will automatically exit the channel after 24 hours.
-
+
+

By default, the user subscribes to the audio and video streams of all the other users in the channel, giving rise to usage and billings. To stop subscribing to a specified stream or all remote streams, call the corresponding mute methods.

+
+
+
+
+
+ +
Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita index f505eeac932..150adb65c1b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita @@ -46,27 +46,40 @@ required ChannelMediaOptions options});

-
- Details -

This method enables users to join a channel. Users in the same channel can talk to each other, and multiple users in the same channel can start a group chat. Users with different App IDs cannot call each other.

-

A successful call of this method triggers the following callbacks:

    -
  • The local client: The and callbacks.
    • -
  • The remote client: , if the user joining the channel is in the Communication profile or is a host in the Live-broadcasting profile.
    • -

-

When the connection between the client and Agora's server is interrupted due to poor network conditions, the SDK tries reconnecting to the server. When the local client successfully rejoins the channel, the SDK triggers the callback on the local client.

-

Compared to , this method adds the options parameter to configure whether to automatically subscribe to all remote audio and video streams in the channel when the user joins the channel. By default, the user subscribes to the audio and video streams of all the other users in the channel, giving rise to usage and billings. To unsubscribe, set the options parameter or call the mute methods accordingly.

- -
    -
  • This method allows users to join only one channel at a time.
    • -
  • Ensure that the app ID you use to generate the token is the same app ID that you pass in the method; otherwise, you may fail to join the channel by token.
    • -
  • If you choose the Testing Mode (using an App ID for authentication) for your project and call this method to join a channel, you will automatically exit the channel after 24 hours.
    • -
-
+
+

Compared to , this method has the options parameter which is used to set media options, such as whether to publish audio and video streams within a channel, or whether to automatically subscribe to the audio and video streams of all remote users when joining a channel. By default, the user subscribes to the audio and video streams of all the other users in the channel, giving rise to usage and billings. To stop subscribing to other streams, set the options parameter or call the corresponding mute methods.

+

This method supports setting the media options when joining a channel, such as whether to publish audio and video streams within the channel. or whether to automatically subscribe to the audio and video streams of all remote users when joining a channel. By default, the user subscribes to the audio and video streams of all the other users in the channel, giving rise to usage and billings. To stop subscribing to other streams, set the options parameter or call the corresponding mute methods.

+
+
+ Call timing +

Call this method after .

+
+
+ Restrictions +
    +
  • This method only supports users joining one channel at a time.
    • +
  • Users with different App IDs cannot call each other.
    • +
  • Before joining a channel, ensure that the App ID you use to generate a token is the same as that you pass in the method; otherwise, you may fail to join the channel with the token.
    • +
+
+ +
Parameters token - The token generated on your server for authentication. See .If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel. See . + The token generated on your server for authentication. See . +
    +
  • (Recommended) If your project has enabled the security mode (using APP ID and Token for authentication), this parameter is required.
    • +
  • If you have only enabled the testing mode (using APP ID for authentication), this parameter is optional. You will automatically exit the channel 24 hours after successfully joining in.
    • +
  • If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel. See .
 channelId @@ -103,7 +116,7 @@
  • -2: The parameter is invalid. For example, the token is invalid, the uid parameter is not set to an integer, or the value of a member in is invalid. You need to pass in a valid parameter and join the channel again.
  • -3: Fails to initialize the object. You need to reinitialize the object.
  • -7: The object has not been initialized. You need to initialize the object before calling this method.
    • -
  • -8: The internal state of the object is wrong. The typical cause is that you call this method to join the channel without calling to stop the test after calling to start a call loop test. You need to call before calling this method.
    • +
  • -8: The internal state of the object is wrong. The typical cause is that after calling to start a call loop test, you call this method to join the channel without calling to stop the test. You need to call before calling this method.
  • -17: The request to join the channel is rejected. The typical cause is that the user is already in the channel. Agora recommends that you use the callback to see whether the user is in the channel. Do not call this method to join the channel unless you receive the (1) state.
  • -102: The channel name is invalid. You need to pass in a valid channel name in channelId to rejoin the channel.
  • -121: The user ID is invalid. You need to pass in a valid user ID in uid to rejoin the channel.
    • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount.dita b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount.dita index 404e286af74..3fff8599902 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount.dita @@ -43,16 +43,17 @@ ChannelMediaOptions? options});

    -
    - Details -

    This method allows a user to join the channel with the user account and a token. After the user successfully joins the channel, the SDK triggers the following callbacks:

      -
    • The local client: , and callbacks.
      • -
    • The remote client: and callbacks, if the user joining the channel is in the communication profile or is a host in the live streaming profile.
      • -

    -

    Once a user joins the channel, the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billing calculation. To stop subscribing to a specified stream or all remote streams, call the corresponding mute methods.

    -
    • To ensure smooth communication, use the same parameter type to identify the user. For example, if a user joins the channel with a user ID, then ensure all the other users use the user ID too. The same applies to the user account. If a user joins the channel with the Agora Web SDK, ensure that the ID of the user is set to the same parameter type.
      • -
    • If you choose the Testing Mode (using an App ID for authentication) for your project and call this method to join a channel, you will automatically exit the channel after 24 hours.
    -
    +
    +

    +

    Once a user joins the channel, the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billings. To stop subscribing to a specified stream or all remote streams, call the corresponding mute methods.

    + +
    +
    +
    +
    + +
    Parameters @@ -76,17 +77,6 @@
    -
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown. You need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    -
      -
    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
        -
      • -2: The parameter is invalid.
        • -
      • -3: The initialization of the SDK fails. You can try to initialize the SDK again.
        • -
      • -5: The request is rejected.
        • -
      • -17: The request to join the channel is rejected. Since the SDK only supports users to join one channel at a time; this error code will be returned when the user who has joined the channel calls the join channel method in the class again with a valid channel name.
        • -
      • -
    +
    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount2.dita index 058b9db7d9f..860dcaf0fe7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount2.dita @@ -2,7 +2,7 @@ <ph keyref="joinChannelWithUserAccount2" /> - Joins the channel with a user account, and configures whether to automatically subscribe to audio or video streams after joining the channel. + Join a channel using a user account and token, and set the media options. @@ -47,16 +47,24 @@ required String userAccount, ChannelMediaOptions? options});

    -
    - Details -

    This method allows a user to join the channel with the user account. After the user successfully joins the channel, the SDK triggers the following callbacks:

      -
    • The local client: , and callbacks.
      • -
    • The remote client: The callback, if the user is in the COMMUNICATION profile, and the callback if the user is a host in the LIVE_BROADCASTING profile.
      • -

    -

    Once a user joins the channel, the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billing calculation. To stop subscribing to a specified stream or all remote streams, call the corresponding mute methods.

    -

    Compared to , this method adds the options parameter to configure whether to automatically subscribe to all remote audio and video streams in the channel when the user joins the channel. By default, the user subscribes to the audio and video streams of all the other users in the channel, giving rise to usage and billings. To unsubscribe, set the options parameter or call the mute methods accordingly.

    -
    -
    +
    +

    Before calling this method, if you have not called to register a user account, when you call this method to join a channel, the SDK automatically creates a user account for you. Calling the method to register a user account, and then calling this method to join a channel can shorten the time it takes to enter the channel.

    +

    Once a user joins the channel, the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billings. To stop subscribing to a specified stream or all remote streams, call the corresponding mute methods.

    +

    Compared to , this method has the options parameter which is used to set media options, such as whether to publish audio and video streams within a channel. By default, the user subscribes to the audio and video streams of all the other users in the channel, giving rise to usage and billings. To stop subscribing to other streams, set the options parameter or call the corresponding mute methods.

    + To ensure smooth communication, use the same parameter type to identify the user. For example, if a user joins the channel with a UID, then ensure all the other users use the UID too. The same applies to the user account. If a user joins the channel with the Agora Web SDK, ensure that the ID of the user is set to the same parameter type. +
    +
    +
    +
    +
    + +
    Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccountex.dita b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccountex.dita index 600bf6f42f9..2fd687dd6cb 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccountex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccountex.dita @@ -2,7 +2,7 @@ <ph keyref="joinChannelWithUserAccountEx" /> - Joins the channel with a user account, and configures whether to automatically subscribe to audio or video streams after joining the channel. + Join a channel using a user account and token, and set the media options. @@ -48,17 +48,17 @@ required ChannelMediaOptions options});

    -
    - Details -

    -

    This method allows a user to join the channel with the user account. After the user successfully joins the channel, the SDK triggers the following callbacks:

      -
    • The local client: , and callbacks.
      • -
    • The remote client: The callback, if the user is in the COMMUNICATION profile, and the callback if the user is a host in the LIVE_BROADCASTING profile.
      • -

    -

    -

    Once a user joins the channel, the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billing calculation. To stop subscribing to a specified stream or all remote streams, call the corresponding mute methods.

    - - To ensure smooth communication, use the same parameter type to identify the user. For example, if a user joins the channel with a user ID, then ensure all the other users use the user ID too. The same applies to the user account. If a user joins the channel with the Agora Web SDK, ensure that the ID of the user is set to the same parameter type.
    +
    +

    Before calling this method, if you have not called to register a user account, when you call this method to join a channel, the SDK automatically creates a user account for you. Calling the method to register a user account, and then calling this method to join a channel can shorten the time it takes to enter the channel.

    +

    Once a user joins the channel, the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billings. If you want to stop subscribing to the media stream of other users, you can set the optionsmediaOptions parameter or call the corresponding mute method.

    + To ensure smooth communication, use the same parameter type to identify the user. For example, if a user joins the channel with a UID, then ensure all the other users use the UID too. The same applies to the user account. If a user joins the channel with the Agora Web SDK, ensure that the ID of the user is set to the same parameter type. +
    +
    +
    +
    +
    +
    Parameters @@ -90,12 +90,7 @@
    -
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown. You need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    -
      -
    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • -
    +
    +
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registerlocaluseraccount.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registerlocaluseraccount.dita index 376482cd838..f32d9e5e20e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registerlocaluseraccount.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registerlocaluseraccount.dita @@ -40,7 +40,7 @@
    • Ensure that the userAccount is unique in the channel.
      • -
    • To ensure smooth communication, use the same parameter type to identify the user. For example, if a user joins the channel with a user ID, then ensure all the other users use the user ID too. The same applies to the user account. If a user joins the channel with the Agora Web SDK, ensure that the ID of the user is set to the same parameter type.
      • +
    • To ensure smooth communication, use the same parameter type to identify the user. For example, if a user joins the channel with a UID, then ensure all the other users use the UID too. The same applies to the user account. If a user joins the channel with the Agora Web SDK, ensure that the ID of the user is set to the same parameter type.
    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita b/en-US/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita index 14fc4ba2f4e..6496bd2d773 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita @@ -44,7 +44,7 @@

    A successful method call triggers the callback on the remote client, from which the remote user gets the stream message. A failed method call triggers the callback on the remote client.

      -
    • Ensure that you call to create a data channel before calling this method.
      • +
    • This method needs to be called after and joining the channel.
    • In live streaming scenarios, this method only applies to hosts.
    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectpreset.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectpreset.dita index ac3bad3ff33..66bfbd9884c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectpreset.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectpreset.dita @@ -25,14 +25,18 @@ Future<void> setAudioEffectPreset(AudioEffectPreset preset);

    -
    - Details +

    Call this method to set an SDK preset audio effect for the local user who sends an audio stream. This audio effect does not change the gender characteristics of the original voice. After setting an audio effect, all users in the channel can hear the effect.

    You can set different audio effects for different scenarios. See .

    +
    +
    + Call timing +

    This method can be called either before or after joining the channel.

    - +

    +
    + Restrictions
      -
    • You can call this method either before or after joining a channel.
    • If you call and set enumerators except for or , do not call ; otherwise, is overridden.
    • After calling , Agora does not recommend you to call the following methods, otherwise the effect set by will be overwritten:
        @@ -44,8 +48,9 @@
    • This method relies on the voice beautifier dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
      • -
    -
    + +
    +
    Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita index 8f7fd02bf4d..569b5702a13 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita @@ -25,16 +25,25 @@ Future<void> setAudioMixingDualMonoMode(AudioMixingDualMonoMode mode);

    -
    - Details -

    In a stereo music file, the left and right channels can store different audio data. According to your needs, you can set the channel mode to original mode, left channel mode, right channel mode, or mixed channel mode. For example, in the KTV scenario, the left channel of the music file stores the musical accompaniment, and the right channel stores the singing voice. If you only need to listen to the accompaniment, call this method to set the channel mode of the music file to left channel mode; if you need to listen to the accompaniment and the singing voice at the same time, call this method to set the channel mode to mixed channel mode.

    - -
      -
    • You need to call this method after calling and receiving the () callback.
      • -
    • This method only applies to stereo audio files.
      • -
    -
    - Parameters +
    +

    In a stereo music file, the left and right channels can store different audio data. According to your needs, you can set the channel mode to original mode, left channel mode, right channel mode, or mixed channel mode.

    +
    +
    + Applicable scenarios +

    For example, in the KTV scenario, the left channel of the music file stores the musical accompaniment, and the right channel stores the original singer's vocals. You can set according to actual needs:

      +
    • If you only want to hear the accompaniment, use this method to set the audio file's channel mode to left channel mode.
      • +
    • If you need to hear both the accompaniment and the original vocals simultaneously, call this method to set the channel mode to mixed mode.

    +
    +
    + Call timing +

    Call this method after and receiving the () callback.

    +
    +
    + Restrictions +

    This method only applies to stereo audio files.

    +
    +
    + Parameters mode diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingposition.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingposition.dita index 49ff0111fae..f07006c774f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingposition.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingposition.dita @@ -25,12 +25,19 @@ Future<void> setAudioMixingPosition(int pos);

    -
    - Details +

    Call this method to set the playback position of the music file to a different starting position (the default plays from the beginning).

    - You need to call this method after calling and receiving the () callback.
    -
    - Parameters +
    +
    + Call timing +

    Call this method after and receiving the () callback.

    +
    +
    + Restrictions +

    None.

    +
    +
    + Parameters pos diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraautofocusfacemodeenabled.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraautofocusfacemodeenabled.dita index ffbd32b2706..2608f174e4d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraautofocusfacemodeenabled.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraautofocusfacemodeenabled.dita @@ -25,21 +25,22 @@ Future<void> setCameraAutoFocusFaceModeEnabled(bool enabled);

    -
    - Details -

    The SDK disables face autofocus by default. To set face autofocus, call this method.

    -

    The SDK enables face autofocus by default. To set face autofocus, call this method.

    -

    By default, the SDK disables face autofocus on Android and enables face autofocus on iOS. To set face autofocus, call this method.

    - -
      -
    • This method is for Android and iOS only.
      • -
    • -
    -
    +
    +

    The SDK disables face autofocus by default. To enable face autofocus, call this method.

    +

    The SDK enables face autofocus by default. To disable face autofocus, call this method.

    +

    By default, the SDK disables face autofocus on Android and enables face autofocus on iOS. To set face autofocus, call this method.

    + This method is for Android and iOS only. +
    +
    +
    + Restrictions +

    None.

    +
    +
    Parameters - enabled + enabled enable

    Whether to enable face autofocus:

      diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcameracapturerconfiguration.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcameracapturerconfiguration.dita index 91ab14f0511..8174b6261ba 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameracapturerconfiguration.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameracapturerconfiguration.dita @@ -30,21 +30,23 @@ CameraCapturerConfiguration config);

    -
    - Details - -
      -
    • This method is for Android and iOS only.
      • -
    • Call this method before enabling local camera capture, such as before calling and .
      • -
    • To adjust the camera focal length configuration, It is recommended to call first to check the device's focal length capabilities, and then configure based on the query results.
      • -
    • Due to limitations on some Android devices, even if you set the focal length type according to the results returned in , the settings may not take effect.
      • -
    -
    +
    +
    + Call timing +

    Call this method before enabling local camera capture, such as before calling and .

    +
    +
    + <ph>Restrictions</ph> +

    To adjust the camera focal length configuration, It is recommended to call first to check the device's focal length capabilities, and then configure based on the query results.

    +

    Due to limitations on some Android devices, even if you set the focal length type according to the results returned in , the settings may not take effect.

    +

    None.

    +
    +
    Parameters - + config - The camera capture configuration. See .In this method, you do not need to set the deviceId parameter. + The camera capture configuration. See .In this method, you do not need to set the deviceId parameter.
    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita index 416552cffba..d70414d9afa 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita @@ -30,14 +30,8 @@ Future<void> setDefaultAudioRouteToSpeakerphone(bool defaultToSpeaker);

    -
    - Details - -
      -
    • This method is for Android and iOS only.
      • -
    • Call this method before joining a channel. If you need to change the audio route after joining a channel, call .
      • -
    -     +
    + This method is for Android and iOS only.

    Most mobile phones have two audio routes: an earpiece at the top, and a speakerphone at the bottom. The earpiece plays at a lower volume, and the speakerphone at a higher volume. When setting the default audio route, you determine whether audio playback comes through the earpiece or speakerphone when no external audio device is connected.

    In different scenarios, the default audio routing of the system is also different. See the following:

    • Voice call: Earpiece.
      • @@ -45,11 +39,23 @@
    • Video call: Speakerphone.
    • Video broadcast: Speakerphone.

    -

    You can call this method to change the default audio route. After a successful method call, the SDK triggers the callback.

    +

    You can call this method to change the default audio route.

    -

    The system audio route changes when an external audio device, such as a headphone or a Bluetooth audio device, is connected. See Audio Route for detailed change principles.

    +

    After calling this method to set the default audio route, the actual audio route of the system will change with the connection of external audio devices (wired headphones or Bluetooth headphones). See .
    -
    +
    + Call timing +

    Call this method before joining a channel. If you need to change the audio route after joining a channel, call .

    +
    +
    + Restrictions +

    None.

    +
    + +
    Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_seteffectsvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_seteffectsvolume.dita index 4bea3e40137..279a8a50d7b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_seteffectsvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_seteffectsvolume.dita @@ -27,10 +27,16 @@ Future<void> setEffectsVolume(int volume);

    -
    - Details - Call this method after .
    -
    +
    +
    + Call timing +

    Call this method after .

    +
    +
    + Restrictions +

    None.

    +
    +
    Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita index 3eb6a801d0d..f83a8b05c73 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita @@ -23,18 +23,30 @@ public abstract int SetEnableSpeakerphone(bool speakerOn); abstract setEnableSpeakerphone(speakerOn: boolean): number; Future<void> setEnableSpeakerphone(bool speakerOn);

    -
    - Details -

    If the default audio route of the SDK or the setting in cannot meet your requirements, you can call to switch the current audio route. After a successful method call, the SDK triggers the callback.

    -

    For the default audio route in different scenarios, see Audio Route.

    -

    This method only sets the audio route in the current channel and does not influence the default audio route. If the user leaves the current channel and joins another channel, the default audio route is used.

    - +
    +

    For the default audio route in different scenarios, see .

    + This method is for Android and iOS only. +
    +
    + Applicable scenarios +

    If the default audio route of the SDK or the setting in cannot meet your requirements, you can call this method to switch the current audio route.

    +
    +
    + Call timing +

    Call this method after joining a channel.

    +
    +
    + Restrictions
      -
    • This method is for Android and iOS only.
      • -
    • Call this method after joining a channel.
      • -
    • If the user uses an external audio playback device such as a Bluetooth or wired headset, this method does not take effect, and the SDK plays audio through the external device. When the user uses multiple external devices, the SDK plays audio through the last connected device.
      • -
    -
    +
  • This method only sets the audio route in the current channel and does not influence the default audio route. If the user leaves the current channel and joins another channel, the default audio route is used.
    • +
  • If the user uses an external audio playback device such as a Bluetooth or wired headset, this method does not take effect, and the SDK plays audio through the external device. When the user uses multiple external devices, the SDK plays audio through the last connected device.
    • + +
    + +
    Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita index 1dd7d04c89b..3d704315db8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita @@ -39,8 +39,9 @@

    After initializing the local video view, you can call this method to update its rendering and mirror modes. It affects only the video view that the local user sees and does not impact the publishing of the local video.

    - <ph props="native unreal bp electron rn flutter">Call timing</ph> -
    • Ensure that you have called the method to initialize the local video view before calling this method.
      • + Call timing +
        +
      • Ensure that you have called the method to initialize the local video view before calling this method.
      • During a call, you can call this method as many times as necessary to update the display mode of the local video view.
    @@ -73,13 +74,15 @@ mirrorMode mirror -

    The mirror mode of the local video view. See .This parameter is only effective when rendering custom videos. If you want to mirror the video view, set the scaleX of the GameObject attached to the video view as -1 or +1.

    +

    The mirror mode of the local video view. See .This parameter does not take effect. To achieve a mirror display effect, configure the mirror settings in Unreal Engine. + This parameter is only effective when rendering custom videos. If you want to mirror the video view, set the scaleX of the GameObject attached to the video view as -1 or +1.

    For the local user:

    • (0): The SDK determines whether to enable the mirror mode. If you use a front camera, the SDK enables the mirror mode by default; if you use a rear camera, the SDK disables the mirror mode by default.
    • (1): Enable the mirroring mode of the local view.
    • (2): Disable the mirroring mode of the local view.

    - If you use a front camera, the SDK enables the mirror mode by default; if you use a rear camera, the SDK disables the mirror mode by default.     + If you use a front camera, the SDK enables the mirror mode by default; if you use a rear camera, the SDK disables the mirror mode by default. +
    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvideomirrormode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvideomirrormode.dita index b8942213597..0033f438bb9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvideomirrormode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvideomirrormode.dita @@ -48,6 +48,7 @@

    +
    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceequalization.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceequalization.dita index d4aae8c973d..2f246978623 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceequalization.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceequalization.dita @@ -35,10 +35,16 @@ required int bandGain});

    -
    - Details - You can call this method either before or after joining a channel.
    -
    +
    +
    + Call timing +

    This method can be called either before or after joining the channel.

    +
    +
    + Restrictions +

    None.

    +
    +
    Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceformant.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceformant.dita index 4e7ebee500f..f3e29e1f026 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceformant.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceformant.dita @@ -25,18 +25,28 @@ abstract setLocalVoiceFormant(formantRatio: number): number; Future<void> setLocalVoiceFormant(double formantRatio);

    -
    - Details +
    Since
    v4.2.0
    -

    Formant ratio affects the timbre of voice. The smaller the value, the deeper the sound will be, and the larger, the sharper.

    -

    You can call this method to set the formant ratio of local audio to change the timbre of human voice. After you set the formant ratio, all users in the channel can hear the changed voice. If you want to change the timbre and pitch of voice at the same time, Agora recommends using this method together with .You can call this method either before or after joining a channel.

    +

    Formant ratio affects the timbre of voice. The smaller the value, the deeper the sound will be, and the larger, the sharper. After you set the formant ratio, all users in the channel can hear the changed voice. If you want to change the timbre and pitch of voice at the same time, Agora recommends using this method together with .

    -
    +
    + Applicable scenarios +

    You can call this method to set the formant ratio of local audio to change the timbre of human voice.

    +
    +
    + Call timing +

    This method can be called either before or after joining the channel.

    +
    +
    + Restrictions +

    None.

    +
    +
    Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicepitch.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicepitch.dita index 93760711e45..2c227222d0a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicepitch.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicepitch.dita @@ -25,10 +25,16 @@ Future<void> setLocalVoicePitch(double pitch);

    -
    - Details - You can call this method either before or after joining a channel.
    -
    +
    +
    + Call timing +

    This method can be called either before or after joining the channel.

    +
    +
    + Restrictions +

    None.

    +
    +
    Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlogfile.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlogfile.dita index c6f042b361c..c1c07a0a5a7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlogfile.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlogfile.dita @@ -25,20 +25,25 @@ Future<void> setLogFile(String filePath);

    -
    - Details +
    Deprecated:
    -
    This method is deprecated. Use the logConfigmLogConfig parameter in to set the log file path.
    +
    This method is deprecated. Set the log file path by configuring the contextconfig parameter when calling .
    -

    Specifies an SDK output log file. The log file records all log data for the SDK’s operation. Ensure that the directory for the log file exists and is writable.

    - -

    Ensure that you call immediately after calling the method, or the output log may not be complete.

    -
    -
    - Parameters +

    Specifies an SDK output log file. The log file records all log data for the SDK’s operation.

    +
    +
    + Call timing +

    This method needs to be called immediately after , otherwise the output log may be incomplete.

    +
    +
    + Restrictions +

    Ensure that the directory for the log file exists and is writable.

    +
    +
    + Parameters filePath diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setloglevel.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setloglevel.dita index 50641208777..33e81f5c085 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setloglevel.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setloglevel.dita @@ -26,22 +26,21 @@ Future<void> setLogLevel(LogLevel level);

    -
    - Details +
    Deprecated:
    -
    This method is deprecated. Use instead to set the log output level.
    +
    This method is deprecated. Set the log file level by configuring the contextconfig parameter when calling .

    Choose a level to see the logs preceding that level.

    -
    +
    Parameters level - The log level: . + The log level. See .
    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita index 947baa2f84c..04cb200a12c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita @@ -72,6 +72,7 @@

    The mirror mode of the remote user view.

    +
    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideostreamtype.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideostreamtype.dita index dc580adcf78..0d4e0d001a0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideostreamtype.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideostreamtype.dita @@ -41,12 +41,13 @@
    This method is deprecated as of v4.4.0. Use instead.
    -

    The SDK defaults to enabling low-quality video stream adaptive mode () on the sending end, which means the sender does not actively send low-quality video stream. The receiver with the role of the host can initiate a low-quality video stream request by calling this method, and upon receiving the request, the sending end automatically starts sending the low-quality video stream.

    +

    Depending on the default behavior of the sender and the specific settings when calling , the scenarios for the receiver calling this method are as follows:

      +
    • The SDK enables low-quality video stream adaptive mode () on the sender side by default, meaning only the high-quality video stream is transmitted. Only the receiver with the role of the host can call this method to initiate a low-quality video stream request. Once the sender receives the request, it starts automatically sending the low-quality video stream. At this point, all users in the channel can call this method to switch to low-quality video stream subscription mode.
      • +
    • If the sender calls and sets mode to (never send low-quality video stream), then calling this method will have no effect.
      • +
    • If the sender calls and sets mode to (always send low-quality video stream), both the host and audience receivers can call this method to switch to low-quality video stream subscription mode.

    The SDK will dynamically adjust the size of the corresponding video stream based on the size of the video window to save bandwidth and computing resources. The default aspect ratio of the low-quality video stream is the same as that of the high-quality video stream. According to the current aspect ratio of the high-quality video stream, the system will automatically allocate the resolution, frame rate, and bitrate of the low-quality video stream.

    • You can call this method either before or after joining a channel.
      • -
    • If the publisher has already called and set mode to (never send low-quality video stream), calling this method will not take effect, you should call again on the sending end and adjust the settings.
      • -
    • Calling this method on the receiving end of the audience role will not take effect.
    • If you call both this method and , the setting of this method takes effect.
    Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setrouteincommunicationmode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setrouteincommunicationmode.dita index b0333878f70..67318b922ff 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setrouteincommunicationmode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setrouteincommunicationmode.dita @@ -22,19 +22,29 @@ abstract setRouteInCommunicationMode(route: number): number; Future<void> setRouteInCommunicationMode(int route);

    -
    - Details +
    Since
    v4.2.2
    -

    This method is used to switch the audio route from Bluetooth headphones to earpiece, wired headphones or speakers in communication audio mode (). After the method is called successfully, the SDK will trigger the callback to report the modified route.

    - Using this method and the method at the same time may cause conflicts. Agora recommends that you use the method alone. -
    • This method is for Android only.
    • Using this method and the method at the same time may cause conflicts. Agora recommends that you use the method alone.
     +

    This method is used to switch the audio route from Bluetooth headphones to earpiece, wired headphones or speakers in communication audio mode ().

    + This method is for Android only.
    -
    +
    + Call timing +

    This method can be called either before or after joining the channel.

    +
    +
    + Restrictions +

    Using this method and the method at the same time may cause conflicts. Agora recommends that you use the method alone.

    +
    + +
    Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita index 13882574a6e..149caf58901 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita @@ -37,7 +37,7 @@
  • In Flutter, you don't need to call this method. Use instead to render local and remote views.
  • If you need to implement native window rendering, use this method; if you only need to render video images in your Unity project, use the methods in the class instead.
  • To update the rendering or mirror mode of the remote video view during a call, use the method.
    • -
  • If you use the Agora recording function, the recording client joins the channel as a placeholder client, triggering the callback. Do not bind the placeholder client to the app view because the placeholder client does not send any video streams. If your app does not recognize the placeholder client, bind the remote user to the view when the SDK triggers the callback.
    • +
  • When using the recording service, the app does not need to bind a view, as it does not send a video stream. If your app does not recognize the recording service, bind the remote user to the view when the SDK triggers the callback.
  • If you want to stop rendering the view, set view to and then call this method again to stop rendering and clear the rendering cache.
    • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoscenario.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoscenario.dita index 8a4d78ca988..42dd2127e8c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoscenario.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoscenario.dita @@ -40,7 +40,7 @@ scenarioType - The type of video application scenario. See .

    (1) is suitable for meeting scenarios. If set to (1), the SDK automatically enables the following strategies:

      + The type of video application scenario. See .

      (1) is suitable for meeting scenarios. The SDK automatically enables the following strategies:

      • In meeting scenarios where low-quality video streams are required to have a high bitrate, the SDK automatically enables multiple technologies used to deal with network congestions, to enhance the performance of the low-quality streams and to ensure the smooth reception by subscribers.
      • The SDK monitors the number of subscribers to the high-quality video stream in real time and dynamically adjusts its configuration based on the number of subscribers.
        • If nobody subscribers to the high-quality stream, the SDK automatically reduces its bitrate and frame rate to save upstream bandwidth.
          • @@ -72,7 +72,7 @@

        -

        (2) is suitable for 1v1 video call scenarios. If set to (2), the SDK optimizes performance to achieve low latency and high video quality, enhancing image quality, first frame rendering, latency on mid-to-low-end devices, and smoothness under poor network conditions.

        +

        (2) is suitable for 1v1 video call scenarios. 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.

        diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita index 60de4578621..48b6958973e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita @@ -31,16 +31,15 @@
        Call timing

        This method can be called either before or after joining the channel.

        +

        To achieve better vocal effects, it is recommended that you call the following APIs before calling this method:

          +
        • Call to set the audio scenario to high-quality audio scenario, namely (3).
          • +
        • Call to set the profile parameter to (4) or (5).
          • +
        +

        Restrictions
          -

        • To achieve better vocal effects, it is recommended that you call the following APIs before calling this method:

            -
          • Call to set the audio scenario to high-quality audio scenario, namely (3).
            • -
          • Call to set the profile parameter to (4) or (5).
            • -
          -

          -
        • Do not set the profile parameter in to (1) or (6), or the method does not take effect.
        • This method has the best effect on human voice processing, and Agora does not recommend calling this method to process audio data containing music.
        • After calling , Agora does not recommend calling the following methods, otherwise the effect set by will be overwritten:
            diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvoiceconversionpreset.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvoiceconversionpreset.dita index 546fa19be07..bf7b4dabe76 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvoiceconversionpreset.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvoiceconversionpreset.dita @@ -25,14 +25,18 @@ Future<void> setVoiceConversionPreset(VoiceConversionPreset preset);

        -
        - Details -

        Call this method to set a preset voice beautifier effect for the local user who sends an audio stream. After setting an audio effect, all users in the channel can hear the effect. You can set different voice beautifier effects for different scenarios.

        +
        +

        Call this method to set a preset voice changing effect for the local user who publishes an audio stream in a channel. After setting the voice changing effect, all users in the channel can hear the effect. You can set different voice changing effects for the user depending on different scenarios.

        The applicable scenarios for each voice-changing effect can be referred to .

        +
        +
        + Call timing +

        This method can be called either before or after joining the channel.

        - +

        +
        + Restrictions
          -
        • You can call this method either before or after joining a channel.
        • This method has the best effect on human voice processing, and Agora does not recommend calling this method to process audio data containing music.
        • After calling , Agora does not recommend you to call the following methods, otherwise the effect set by will be overwritten:
            @@ -46,8 +50,9 @@
        • This method relies on the voice beautifier dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
          • -
        -
        +
      +
    +
    Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvolumeofeffect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvolumeofeffect.dita index ae6410647fb..e018f76f7f8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvolumeofeffect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvolumeofeffect.dita @@ -2,7 +2,7 @@ <ph keyref="setVolumeOfEffect" /> - Sets the volume of a specified audio effect. + Gets the volume of a specified audio effect file. @@ -28,7 +28,16 @@ Future<void> setVolumeOfEffect({required int soundId, required int volume});

    -
    +
    +
    + Call timing +

    Call this method after .

    +
    +
    + Restrictions +

    None.

    +
    +
    Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita index 9fae19fc112..8f554cdb2a1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita @@ -36,18 +36,29 @@ required AgoraRhythmPlayerConfig config});

    -
    - Details +
    +
      +
    • After enabling the virtual metronome, the SDK plays the specified audio effect file from the beginning, and controls the playback duration of each file according to beatsPerMinute you set in . For example, if you set beatsPerMinute as 60, the SDK plays one beat every second. If the file duration exceeds the beat duration, the SDK only plays the audio within the beat duration.
      • +
    • By default, the sound of the virtual metronome is published in the channel. If you want the sound to be heard by the remote users, you can set publishRhythmPlayerTrack in as .
      • +
    +
    +
    + Applicable scenarios

    In music education, physical education and other scenarios, teachers usually need to use a metronome so that students can practice with the correct beat. The meter is composed of a downbeat and upbeats. The first beat of each measure is called a downbeat, and the rest are called upbeats.

    -

    In this method, you need to set the file path of the upbeat and downbeat, the number of beats per measure, the beat speed, and whether to send the sound of the metronome to remote users.

    +
    +
    + Call timing +

    This method can be called either before or after joining the channel.

    +
    +
    + Restrictions +

    None.

    +
    + -
    +
    +
    Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita index 529e9249c9b..a9be65824d0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita @@ -33,7 +33,7 @@
  • This method is for Android and iOS only.
  • The billing for the screen sharing stream is based on the dimensions in :
    • When you do not pass in a value, Agora bills you at 1280 × 720.
      • -
    • When you pass in a value, Agora bills you at that value. For billing examples, see .
    • +
  • When you pass in a value, Agora bills you at that value.
    • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_switchcamera.dita b/en-US/dita/RTC-NG/API/api_irtcengine_switchcamera.dita index 7a240c2a368..fec12fdd33e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_switchcamera.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_switchcamera.dita @@ -25,15 +25,18 @@ Future<void> switchCamera();

    -
    - Details -

    You can call this method to dynamically switch cameras based on the actual camera availability during the app's runtime, without having to restart the video stream or reconfigure the video source.

    - -
    • This method is for Android and iOS only.
      • -
    • This method must be called after the camera is successfully enabled, that is, after the SDK triggers the callback and returns the local video state as (1).
      • -
    • This method only switches the camera for the video stream captured by the first camera, that is, the video source set to (0) when calling .
      • -
    • This method and are both used to switch cameras. The difference is that switches to a specific camera by specifying the camera ID, while this method switches the direction of the camera (front or rear).
      • -
    +
    +

    You can call this method to dynamically switch cameras based on the actual camera availability during the app's runtime, without having to restart the video stream or reconfigure the video source.

    +

    This method and are both used to switch cameras. The difference is that switches to a specific camera by specifying the camera ID, while this method switches the direction of the camera (front or rear).

    + This method is for Android and iOS only. +
    +
    + Call timing +

    This method must be called after the camera is successfully enabled, that is, after the SDK triggers the callback and returns the local video state as (1).

    +
    +
    + Restrictions +

    This method only switches the camera for the video stream captured by the first camera, that is, the video source set to (0) when calling .

    <ph keyref="return-section-title"/> diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_switchcamera2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_switchcamera2.dita index 87c92be9901..2122252e8c4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_switchcamera2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_switchcamera2.dita @@ -24,23 +24,20 @@

    -
    - Details +
    Since
    v4.3.1
    -

    - -

      -
    • -
    • -
    • This method and both are used to switch cameras. The difference is that switches the camera direction (front or rear), while this method switches to a specific camera by specifying the camera ID.
      • -
    +

    +

    This method and both are used to switch cameras. The difference is that switches the camera direction (front or rear), while this method switches to a specific camera by specifying the camera ID.

    + This method is for Android and iOS only.
    -
    +
    +
    +
    Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita b/en-US/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita index 94b77508099..3103bd7f50b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita @@ -25,18 +25,27 @@ Future<void> takeSnapshot({required int uid, required String filePath});

    -
    - Details -

    This method takes a snapshot of a video stream from the specified user, generates a JPG image, and saves it to the specified path.

    -

    The method is asynchronous, and the SDK has not taken the snapshot when the method call returns. After a successful method call, the SDK triggers the callback to report whether the snapshot is successfully taken, as well as the details for that snapshot.

    -

    The SDK has not taken the snapshot when the method call returns. After a successful method call, the SDK triggers the callback to report whether the snapshot is successfully taken, as well as the details for that snapshot.

    - -
      -
    • Call this method after joining a channel.
      • -
    • When used for local video snapshots, this method takes a snapshot for the video streams specified in .
      • -
    • If the user's video has been preprocessed, for example, watermarked or beautified, the resulting snapshot includes the pre-processing effect.
      • -
    -
    +
    +

    This method takes a snapshot of a video stream from the specified user, generates a JPG image, and saves it to the specified path.

    +
    +
    + Call timing +

    Call this method after joining a channel.

    +
    +
    + Restrictions +
      +
    • The method is asynchronous, and the SDK has not taken the snapshot when the method call returns.
      • +
    • The SDK has not taken the snapshot when the method call returns.
      • +
    • When used for local video snapshots, this method takes a snapshot for the video streams specified in .
      • +
    • If the user's video has been preprocessed, for example, watermarked or beautified, the resulting snapshot includes the pre-processing effect.
      • +
    +
    + +
    Parameters @@ -51,7 +60,9 @@
  • iOS: /App Sandbox/Library/Caches/example.jpg
  • macOS: ～/Library/Logs/example.jpg
  • Android: /storage/emulated/0/Android/data/<package name>/files/example.jpg
    • - Ensure that the path you specify exists and is writable.

    + +

    + Ensure that the path you specify exists and is writable.
    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_unloadeffect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_unloadeffect.dita index db66b123f1b..3a843c5bf3c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_unloadeffect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_unloadeffect.dita @@ -27,7 +27,18 @@ Future<void> unloadEffect(int soundId);

    -
    +
    +

    After loading the audio effect file into memory using , if you need to release the audio effect file, call this method.

    +
    +
    + Call timing +

    You can call this method either before or after joining a channel.

    +
    +
    + Restrictions +

    None.

    +
    +
    Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_adjustuserplaybacksignalvolumeex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_adjustuserplaybacksignalvolumeex.dita index f0c70117f09..9152301db22 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_adjustuserplaybacksignalvolumeex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_adjustuserplaybacksignalvolumeex.dita @@ -39,21 +39,24 @@ required RtcConnection connection});

    -
    - Details +
    Since
    v4.1.0
    -

    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.

    - -
      -
    • Call this method after joining a channel.
      • -
    • The playback volume here refers to the mixed volume of a specified remote user.
      • -
    -
    +

    +

    +
    + Call timing +

    Call this method after .

    +
    +
    + Restrictions +

    None.

    +
    +
    Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita index 9c431f6627c..906d15dad60 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita @@ -40,7 +40,7 @@
    Call timing

    Call this method after .

    -
    +
    Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_enableaudiovolumeindicationex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_enableaudiovolumeindicationex.dita index 859589fe66e..4f3a00eae42 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_enableaudiovolumeindicationex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_enableaudiovolumeindicationex.dita @@ -43,11 +43,17 @@ required RtcConnection connection});

    -
    - Details -

    This method enables the SDK to regularly report the volume information to the app of the local user who sends a stream and remote users (three users at most) whose instantaneous volumes are the highest. Once you call this method and users send streams in the channel, the SDK triggers the callback at the time interval set in this method.

    +
    +
    + Call timing +

    Call this method after .

    +
    +
    + Restrictions +

    None.

    -
    +