diff --git a/dita/RTC-NG/API/api_ibasespatialaudioengine_muteallremoteaudiostreams.dita b/dita/RTC-NG/API/api_ibasespatialaudioengine_muteallremoteaudiostreams.dita index 08ec90db02e..aa62bae224f 100644 --- a/dita/RTC-NG/API/api_ibasespatialaudioengine_muteallremoteaudiostreams.dita +++ b/dita/RTC-NG/API/api_ibasespatialaudioengine_muteallremoteaudiostreams.dita @@ -31,7 +31,7 @@
diff --git a/dita/RTC-NG/API/api_ibasespatialaudioengine_mutelocalaudiostream.dita b/dita/RTC-NG/API/api_ibasespatialaudioengine_mutelocalaudiostream.dita index 6e3ddc05062..2862dbb71e9 100644 --- a/dita/RTC-NG/API/api_ibasespatialaudioengine_mutelocalaudiostream.dita +++ b/dita/RTC-NG/API/api_ibasespatialaudioengine_mutelocalaudiostream.dita @@ -31,7 +31,7 @@
diff --git a/dita/RTC-NG/API/api_ibasespatialaudioengine_muteremoteaudiostream.dita b/dita/RTC-NG/API/api_ibasespatialaudioengine_muteremoteaudiostream.dita index e464a5afe7f..17124d7cfb6 100644 --- a/dita/RTC-NG/API/api_ibasespatialaudioengine_muteremoteaudiostream.dita +++ b/dita/RTC-NG/API/api_ibasespatialaudioengine_muteremoteaudiostream.dita @@ -36,7 +36,7 @@

diff --git a/dita/RTC-NG/API/api_ibasespatialaudioengine_release.dita b/dita/RTC-NG/API/api_ibasespatialaudioengine_release.dita index 6b4521958a1..f9d0dcfc8bd 100644 --- a/dita/RTC-NG/API/api_ibasespatialaudioengine_release.dita +++ b/dita/RTC-NG/API/api_ibasespatialaudioengine_release.dita @@ -26,7 +26,7 @@
详情 -

该方法释放 下的所有资源。当用户不需要使用空间音效时，你可以调用该方法将资源释放出来用于其他操作。

+

该方法释放 下的所有资源。当用户不需要使用空间音频时，你可以调用该方法将资源释放出来用于其他操作。

调用该方法后，你将无法再使用 下的任何 API。 diff --git a/dita/RTC-NG/API/api_ibasespatialaudioengine_setdistanceunit.dita b/dita/RTC-NG/API/api_ibasespatialaudioengine_setdistanceunit.dita index 9e09b203223..d3d2f148a72 100644 --- a/dita/RTC-NG/API/api_ibasespatialaudioengine_setdistanceunit.dita +++ b/dita/RTC-NG/API/api_ibasespatialaudioengine_setdistanceunit.dita @@ -27,7 +27,7 @@

详情 -

游戏引擎里的距离单位是游戏引擎自定义的，而声网空间音效算法的距离单位为米。默认情况下，SDK 会将每单位的游戏引擎距离换算为一米。你可以调用该方法，将游戏引擎里的单位距离换算为指定的米数。

+

游戏引擎里的距离单位是游戏引擎自定义的，而声网空间音频算法的距离单位为米。默认情况下，SDK 会将每单位的游戏引擎距离换算为一米。你可以调用该方法，将游戏引擎里的单位距离换算为指定的米数。

建议在 前调用该方法。
参数 diff --git a/dita/RTC-NG/API/api_ibasespatialaudioengine_setmaxaudiorecvcount.dita b/dita/RTC-NG/API/api_ibasespatialaudioengine_setmaxaudiorecvcount.dita index 49cf59776fa..7ddc9087dfe 100644 --- a/dita/RTC-NG/API/api_ibasespatialaudioengine_setmaxaudiorecvcount.dita +++ b/dita/RTC-NG/API/api_ibasespatialaudioengine_setmaxaudiorecvcount.dita @@ -28,7 +28,7 @@
详情

如果在音频接收范围内可接收的音频流数超过设置的值，则本地用户会接收音源距离较近的 maxCount 路音频。

- 因为服务端空间音效不发布，所以不能体现 enterRoom。该方法在 前后均可调用，区别如下： + 因为服务端空间音频不发布，所以不能体现 enterRoom。该方法在 前后均可调用，区别如下：
  • 如果在 之前调用，该方法会在进入房间时生效。
  • 如果在 之后调用，该方法立即生效，即改变当前音频接收范围内最多可接收的音频流数。
    • diff --git a/dita/RTC-NG/API/api_ibasespatialaudioengine_updateselfposition.dita b/dita/RTC-NG/API/api_ibasespatialaudioengine_updateselfposition.dita index f56ef653d16..41ef948e8fd 100644 --- a/dita/RTC-NG/API/api_ibasespatialaudioengine_updateselfposition.dita +++ b/dita/RTC-NG/API/api_ibasespatialaudioengine_updateselfposition.dita @@ -44,15 +44,15 @@ 详情

    在不同类下调用该方法时，作用不同：

      -
    • 在 类下调用该方法时，SDK 会向声网空间音效服务器更新本地用户的空间位置。声网空间音效服务器会根据本地和远端用户的世界坐标和音频接收范围计算用户的空间音效参数。
      • -
    • 在 类下，该方法需要和 搭配使用。SDK 会根据该方法和 设置的参数计算本地和远端用户之间的相对位置，从而计算用户的空间音效参数。
      • +
    • 在 类下调用该方法时，SDK 会向声网空间音频服务器更新本地用户的空间位置。声网空间音频服务器会根据本地和远端用户的世界坐标和音频接收范围计算用户的空间音频参数。
      • +
    • 在 类下，该方法需要和 搭配使用。SDK 会根据该方法和 设置的参数计算本地和远端用户之间的相对位置，从而计算用户的空间音频参数。

    • 该方法需要在 后调用。
    • 如果在 类下调用该方法，需注意：
        -
      • 多次调用该方法时，建议调用时间间隔为 [120,7000) 毫秒，否则 SDK 和声网空间音效服务器会失去同步。
        • +
      • 多次调用该方法时，建议调用时间间隔为 [120,7000) 毫秒，否则 SDK 和声网空间音频服务器会失去同步。
      • 如果本次更新的空间位置和上次位置间的距离小于 0.2 米或各方向旋转角度小于 15 度，则 SDK 不会更新本次空间位置。
    diff --git a/dita/RTC-NG/API/api_ilocalspatialaudioengine_release.dita b/dita/RTC-NG/API/api_ilocalspatialaudioengine_release.dita index 6c90868a14d..13706d6e7c2 100644 --- a/dita/RTC-NG/API/api_ilocalspatialaudioengine_release.dita +++ b/dita/RTC-NG/API/api_ilocalspatialaudioengine_release.dita @@ -29,8 +29,8 @@
详情 -

该方法释放 下的所有资源。当用户不需要使用空间音效时，你可以调用该方法将资源释放出来用于其他操作。

-

调用该方法后，你将无法再使用 下的任何 API。如需再次使用空间音效，你需要等 执行结束后再调用 创建一个新的 。 +

该方法释放 下的所有资源。当用户不需要使用空间音频时，你可以调用该方法将资源释放出来用于其他操作。

+

调用该方法后，你将无法再使用 下的任何 API。如需再次使用空间音频，你需要等 执行结束后再调用 创建一个新的 。 该方法需要在 的 方法前调用。

diff --git a/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita b/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita index c1d6afe778d..25877b459e9 100644 --- a/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita +++ b/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita @@ -34,7 +34,7 @@
详情 -

成功调用该方法后，SDK 会根据本地和远端用户的相对位置计算空间音效参数。

+

成功调用该方法后，SDK 会根据本地和远端用户的相对位置计算空间音频参数。

该方法需要在 或 后调用。
参数 diff --git a/dita/RTC-NG/API/api_imediaplayer_play.dita b/dita/RTC-NG/API/api_imediaplayer_play.dita index 4c62017e493..48cc5aeced3 100644 --- a/dita/RTC-NG/API/api_imediaplayer_play.dita +++ b/dita/RTC-NG/API/api_imediaplayer_play.dita @@ -27,7 +27,8 @@
详情 -

调用 或 后，你可以调用该方法播放媒体文件。

+

调用 或 后，你可以调用该方法播放媒体文件。

+ 调用 打开媒体文件后，你需要在收到 回调报告状态为 后再调用 来播放。
<ph keyref="return-section-title"/> diff --git a/dita/RTC-NG/API/api_imediaplayer_seek.dita b/dita/RTC-NG/API/api_imediaplayer_seek.dita index 093ea70455c..3292d4447e0 100644 --- a/dita/RTC-NG/API/api_imediaplayer_seek.dita +++ b/dita/RTC-NG/API/api_imediaplayer_seek.dita @@ -30,11 +30,10 @@
详情

成功调用该方法后，你会收到 回调，报告当前播放器发生的事件，如定位开始、定位成功或定位失败。

-

如果你想定位播放，请进行如下操作：

    -
  • 调用该方法定位。
    • -
  • 定位完成后，调用 方法播放。
    • -

+
  • 如果你在播放已经完成后（收到 回调报告播放状态为 或 ）再调用 ，方法调用成功后，SDK 会从你指定的位置开始自动播放，此时你会收到 回调报告播放状态为 。
    • +
  • 如果你在播放暂停的情况下调用 ，调用成功后 SDK 会定位到你指定位置，如需播放，请调用 或 。
    • +
    参数 diff --git a/dita/RTC-NG/API/api_imediaplayer_setloopcount.dita b/dita/RTC-NG/API/api_imediaplayer_setloopcount.dita index a23e11b310e..9f53cc3f609 100644 --- a/dita/RTC-NG/API/api_imediaplayer_setloopcount.dita +++ b/dita/RTC-NG/API/api_imediaplayer_setloopcount.dita @@ -37,7 +37,12 @@ loopCount - 循环播放的次数。 + 循环播放的次数。 +
      +
    • ≥0：循环次数。例如，设为 0 表示不循环播放，一共播放一次；设为 1 表示循环播放一次，一共播放 2 次。
      • +
    • -1：无限循环播放。
      • +
    +
    diff --git a/dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita b/dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita index 14584fb0e8c..5cb8a8b06f3 100644 --- a/dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita +++ b/dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita @@ -2,7 +2,7 @@ <ph keyref="setSpatialAudioParams" /> - 开启或关闭媒体播放器的空间音效。 + 开启或关闭媒体播放器的空间音频。 @@ -27,8 +27,8 @@
    详情 -

    成功设置媒体播放器的空间音效参数后，SDK 会开启媒体播放器的空间音效，即本地用户听媒体资源会有空间感。

    -

    如果需关闭媒体播放器的空间音效，你需要将 params 参数设为空。

    +

    成功设置媒体播放器的空间音频参数后，SDK 会开启媒体播放器的空间音频，即本地用户听媒体资源会有空间感。

    +

    如果需关闭媒体播放器的空间音频，你需要将 params 参数设为空。

    参数 @@ -36,7 +36,7 @@ params spatial_audio_params - 媒体播放器的空间音效参数。详见 。 + 媒体播放器的空间音频参数。详见 。
    diff --git a/dita/RTC-NG/API/api_imediaplayer_stop.dita b/dita/RTC-NG/API/api_imediaplayer_stop.dita index 15cc6221c8d..8503270533c 100644 --- a/dita/RTC-NG/API/api_imediaplayer_stop.dita +++ b/dita/RTC-NG/API/api_imediaplayer_stop.dita @@ -26,6 +26,9 @@ Future<void> stop();

    +
    +

    调用该方法停止播放后，如需重新播放，需要调用 或 再次打开媒体资源。

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

    方法成功调用时，无返回值；方法调用失败时，会抛出 异常，你需要捕获异常并进行处理。详见了解详情和解决建议。

    diff --git a/dita/RTC-NG/API/api_irtcengine_adjustuserplaybacksignalvolume.dita b/dita/RTC-NG/API/api_irtcengine_adjustuserplaybacksignalvolume.dita index 1f4c4635288..70fc80e1bb7 100644 --- a/dita/RTC-NG/API/api_irtcengine_adjustuserplaybacksignalvolume.dita +++ b/dita/RTC-NG/API/api_irtcengine_adjustuserplaybacksignalvolume.dita @@ -27,7 +27,7 @@

    -

    你可以在通话中调用该方法调节指定远端用户在本地播放的音量。如需调节多个用户在本地播放的音量，则需多次调用该方法。

    +

    你可以在通话中调用该方法调节指定远端用户在本地播放的音量。如需调节多个用户在本地播放的音量，则需多次调用该方法。

    调用时机 diff --git a/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita b/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita index 21273c06c71..413b1fc1497 100644 --- a/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita +++ b/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita @@ -25,12 +25,26 @@ Future<void> configRhythmPlayer(AgoraRhythmPlayerConfig config);

    -
    - 详情 -

    调用 后，你可以调用该方法重新配置虚拟节拍器。

    +
    +
      +
    • 调用 后，你可以调用该方法重新配置虚拟节拍器。
      • +
    • 开启虚拟节拍器后，SDK 会从头开始播放指定的音频文件，并根据你在 中设置的 beatsPerMinute 控制每个文件的播放时长。例如，将 beatsPerMinute 设为 60，则 SDK 会 1 秒播放 1 个节拍。如果文件时长超过了节拍时长，则 SDK 只播放节拍时长部分的音频。
      • +
    • 虚拟节拍器的声音默认不会发布至远端，如果你希望远端用户听到虚拟节拍器的声音，你可以在调用该方法后，将 中的 publishRhythmPlayerTrack 设为 。
      • +
    +
    +
    + 调用时机 +

    加入频道前后均可调用。

    +
    +
    + 调用限制 +

    无。

    +
    + -
    +
    +
    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita b/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita index 30ab5159623..865f05e89b5 100644 --- a/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita +++ b/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita @@ -31,7 +31,7 @@
    调用时机 -

    该方法需要在加入频道后调用。

    +

    该方法在加入频道前后均可调用。

    调用限制 diff --git a/dita/RTC-NG/API/api_irtcengine_createmediaplayer.dita b/dita/RTC-NG/API/api_irtcengine_createmediaplayer.dita index c4f611bafd8..02a77b82f5c 100644 --- a/dita/RTC-NG/API/api_irtcengine_createmediaplayer.dita +++ b/dita/RTC-NG/API/api_irtcengine_createmediaplayer.dita @@ -27,7 +27,7 @@

    -

    在调用 类下的其他 API 前，你需要先调用该方法创建一个媒体播放器实例。

    +

    在调用 类下的其他 API 前，你需要先调用该方法创建一个媒体播放器实例。如果你需要创建多个实例，可以多次调用该方法。

    调用时机 diff --git a/dita/RTC-NG/API/api_irtcengine_enablespatialaudio.dita b/dita/RTC-NG/API/api_irtcengine_enablespatialaudio.dita index 50a095390b4..d87253f5bea 100644 --- a/dita/RTC-NG/API/api_irtcengine_enablespatialaudio.dita +++ b/dita/RTC-NG/API/api_irtcengine_enablespatialaudio.dita @@ -2,7 +2,7 @@ <ph keyref="enableSpatialAudio" /> - 开启或关闭空间音效。 + 开启或关闭空间音频。 @@ -27,11 +27,11 @@
    详情 -

    开启空间音效后，你可以调用 设置远端用户的空间音效参数。

    +

    开启空间音频后，你可以调用 设置远端用户的空间音频参数。

    • 该方法在加入频道前后均可调用。
      • -
    • 该方法依赖于空间音效动态库 ，如果删除该动态库会导致无法正常开启该功能。
      • +
    • 该方法依赖于空间音频动态库 ，如果删除该动态库会导致无法正常开启该功能。
    @@ -39,11 +39,11 @@ enabled - 是否开启空间音效： + 是否开启空间音频：
      -
    • : 开启空间音效。
      • -
    • : 关闭空间音效。
      • +
    • : 开启空间音频。
      • +
    • : 关闭空间音频。
    diff --git a/dita/RTC-NG/API/api_irtcengine_getcurrentmonotonictimeinms.dita b/dita/RTC-NG/API/api_irtcengine_getcurrentmonotonictimeinms.dita index 3bde9edb654..38b773cc099 100644 --- a/dita/RTC-NG/API/api_irtcengine_getcurrentmonotonictimeinms.dita +++ b/dita/RTC-NG/API/api_irtcengine_getcurrentmonotonictimeinms.dita @@ -17,15 +17,14 @@ public abstract getCurrentMonotonicTimeInMs(): number; - (int64_t)getCurrentMonotonicTimeInMs NS_SWIFT_NAME(getCurrentMonotonicTimeInMs()); virtual int64_t getCurrentMonotonicTimeInMs() = 0; - UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") - int64 GetCurrentMonotonicTimeInMs(); + UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") + int64 GetCurrentMonotonicTimeInMs(); abstract getCurrentMonotonicTimeInMs(): number; public abstract long GetCurrentMonotonicTimeInMs(); abstract getCurrentMonotonicTimeInMs(): number; Future<int> getCurrentMonotonicTimeInMs();

    -
    - 详情 +
    自从
    @@ -35,10 +34,18 @@

    Monotonic Time 是指一个单调递增的时间序列，它的值会随着时间的推移而增加。单位为毫秒。

    在自定义视频采集、自定义音频采集场景中，为确保音视频同步，声网建议你调用该方法获取 SDK 当前的 Monotonic Time 后，将该值传入采集的视频帧（）、音频帧（）的时间戳参数。

    +
    + 调用时机 +

    加入频道前后均可调用。

    +
    +
    + 调用限制 +

    无。

    +
    返回值
      -
    • ≥0: 方法调用成功，返回 SDK 当前的 Monotonic Time（毫秒）。
      • +
    • ≥ 0: 方法调用成功，返回 SDK 当前的 Monotonic Time（毫秒）。
    • < 0: 方法调用失败。详见了解详情和解决建议。
    diff --git a/dita/RTC-NG/API/api_irtcengine_iscamerazoomsupported.dita b/dita/RTC-NG/API/api_irtcengine_iscamerazoomsupported.dita index 3c84714e1d5..8fa8808e4c9 100644 --- a/dita/RTC-NG/API/api_irtcengine_iscamerazoomsupported.dita +++ b/dita/RTC-NG/API/api_irtcengine_iscamerazoomsupported.dita @@ -17,7 +17,7 @@ - (BOOL)isCameraZoomSupported; virtual bool isCameraZoomSupported() = 0; - UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") + UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") bool IsCameraZoomSupported(); abstract isCameraZoomSupported(): boolean; public abstract bool IsCameraZoomSupported(); @@ -25,13 +25,17 @@ Future<bool> isCameraZoomSupported();

    -
    - 详情 - -
      -
    • 该方法仅适用于 Android 和 iOS。
      • -
    • -
    +
    + 该方法仅适用于 Android 和 iOS。 +
    +
    + 调用时机 +

    该方法必须在 SDK 触发 回调，返回本地视频状态为 (2) 之后调用。

    +
    +
    + 调用限制 +

    无。

    +
    返回值
      diff --git a/dita/RTC-NG/API/api_irtcengine_joinchannel.dita b/dita/RTC-NG/API/api_irtcengine_joinchannel.dita index a5aa364c0fd..417472b06e7 100644 --- a/dita/RTC-NG/API/api_irtcengine_joinchannel.dita +++ b/dita/RTC-NG/API/api_irtcengine_joinchannel.dita @@ -43,14 +43,16 @@ required int uid});

    -
    - 详情 -

    -

    -

    -

    • 用户成功加入频道后，默认订阅频道内所有其他用户的音频流和视频流，因此产生用量并影响计费。如果想取消订阅，可以通过调用相应的 mute 方法实现。
      • -
    • 如果你的项目仅开启调试模式（即选择 APP ID 为鉴权机制），成功加入频道 24 小时后会自动退出该频道。
    -
    +
    +

    加入频道后，默认情况下用户订阅频道内所有其他用户的音频流和视频流，因此会产生用量并影响计费。如果想取消订阅，可以通过相应的 mute 方法实现。

    +
    +
    +
    +
    +
    + +
    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita b/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita index c3fbf0fbaf6..aad3183bce1 100644 --- a/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita +++ b/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita @@ -46,29 +46,42 @@ required ChannelMediaOptions options});

    -
    - 详情 -

    该方法让用户加入通话频道，在同一个频道内的用户可以互相通话，多个用户加入同一个频道，可以群聊。 使用不同 App ID 的 App 不能互通。

    -

    成功调用该方法加入频道后会触发以下回调： -

      -
    • 本地会触发 和 回调。
      • -
    • 通信场景下的用户和直播场景下的主播加入频道后，远端会触发 回调。
      • -

    -

    在网络状况不理想的情况下，客户端可能会与声网服务器失去连接；SDK 会自动尝试重连，重连成功后，本地会触发 回调。

    -

    相比 ，该方法增加了 options 参数，用于配置用户加入频道时是否自动订阅频道内所有远端音视频流。默认情况下，用户订阅频道内所有其他用户的音频流和视频流，因此会产生用量并影响计费。如果想取消订阅，可以通过设置 options 参数或相应的 mute 方法实现。

    - -
      -
    • 该方法允许用户一次加入仅一个频道。
      • -
    • 请务必确保用于生成 Token 的 App ID 和 方法初始化引擎时用的是同一个 App ID，否则使用 Token 加入频道失败。
      • -
    • 如果你的项目仅开启调试模式（即选择 APP ID 为鉴权机制），成功加入频道 24 小时后会自动退出该频道。
      • -
    -
    +
    +

    相比 ，该方法增加了 options 参数，用于设置媒体选项，如是否在频道内发布音视频流等。用户加入频道时是否自动订阅频道内所有远端音视频流。默认情况下，用户订阅频道内所有其他用户的音频流和视频流，因此会产生用量并影响计费。如果想取消订阅，可以通过设置 options 参数或相应的 mute 方法实现。

    +

    该方法可以在加入频道时设置媒体选项，如是否在频道内发布音视频流等。用户加入频道时是否自动订阅频道内所有远端音视频流。默认情况下，用户订阅频道内所有其他用户的音频流和视频流，因此会产生用量并影响计费。如果想取消订阅，可以通过设置 options 参数或相应的 mute 方法实现。

    +
    +
    + 调用时机 +

    该方法需要在 之后再调用。

    +
    +
    + 调用限制 +
      +
    • 该方法仅支持用户一次加入一个频道。
      • +
    • 使用不同 App ID 的 App 不能互通。
      • +
    • 加入频道前，请确保用于生成 Token 的 App ID 和调用 方法初始化引擎时使用的是同一个 App ID，否则使用 Token 加入频道会失败。
      • +
    +
    + +
    参数 token 在服务端生成的用于鉴权的动态密钥。详见。 - 如果你需要同时加入多个频道或在频道间频繁切换，声网推荐你使用通配 Token 以避免每加入一个新的频道都需向服务端申请一个新的 Token，详见 。 + +
      +
    • （推荐）如果你的项目开启了安全模式，即选择 APP ID + Token 为鉴权机制，则该参数为必填。
      • +
    • 如果你的项目仅开启调试模式，即选择 APP ID 为鉴权机制，则无需填入 Token 即可加入频道。成功加入频道 24 小时后会自动退出该频道。
      • +
    • 如果你需要同时加入多个频道或在频道间频繁切换，声网推荐你使用通配 Token 以避免每加入一个新的频道都需向服务端申请一个新的 Token，详见 。
         channelId @@ -113,7 +126,7 @@
  • -2：传入的参数无效。例如，使用了不合法的 Token，uid 参数未设置为整型，或 成员值不合法。你需要填入有效的参数，重新加入频道。
  • -3： 对象初始化失败。你需要重新初始化 对象。
  • -7： 对象尚未初始化。你需要在调用该方法前成功初始化 对象。
    • -
  • -8： 对象内部状态错误。可能的原因是：调用 开始通话回路测试后，未调用 停止测试就调用该方法加入频道。你需要在该方法前调用 。
    • +
  • -8： 对象内部状态错误。可能的原因是：调用 开始通话回路测试后，未调用 停止测试就调用该方法加入频道。你需要在该方法前调用 。
  • -17：加入频道被拒绝。可能的原因是用户已经在频道中。建议通过 回调判断用户是否在频道中。除收到 (1) 状态外，不要再次调用该方法加入频道。
  • -102：频道名无效。你需要在 channelId 中填入有效的频道名，重新加入频道。
  • -121：用户 ID 无效。你需要在 uid 中填入有效的用户 ID，重新加入频道。
    • diff --git a/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount.dita b/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount.dita index 3af62ddfc81..b1efe201509 100644 --- a/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount.dita +++ b/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount.dita @@ -43,17 +43,17 @@ ChannelMediaOptions? options});

    -
    - 详情 -

    该方法允许本地用户使用 User Account 和 Token 加入频道。成功加入频道后，会触发以下回调： -

      -
    • 本地：、 和 回调。
      • -
    • 通信场景下的用户和直播场景下的主播加入频道后，远端会依次触发 和 回调。
      • -

    +
    +

    用户成功加入频道后，默认订阅频道内所有其他用户的音频流和视频流，因此产生用量并影响计费。如果想取消订阅，可以通过调用相应的 mute 方法实现。

    -
    • 为保证通信质量，请确保频道内使用同一类型的数据标识用户身份。即同一频道内需要统一使用 UID 或 User Account。如果有用户通过 Web SDK 加入频道，请确保 Web 加入的用户也是同样类型。
      • -
    • 如果你的项目仅开启调试模式（即选择 APP ID 为鉴权机制），成功加入频道 24 小时后会自动退出该频道。
    -
    + +
    +
    +
    +
    + +
    参数 @@ -77,18 +77,6 @@
    -
    - <ph keyref="return-section-title"/> -

    方法成功调用时，无返回值；方法调用失败时，会抛出 异常，你需要捕获异常并进行处理。详见了解详情和解决建议。

    -
      -
    • 0: 方法调用成功。
      • -
    • < 0: 方法调用失败。详见了解详情和解决建议。 -
        -
      • -2: 参数无效。
        • -
      • -3: SDK 初始化失败，请尝试重新初始化 SDK。
        • -
      • -5: 调用被拒绝。
        • -
      • -17: 加入频道被拒绝。由于 SDK 仅支持用户同一时间加入一个 频道，当已经加入 频道的用户使用有效的频道名再次调用 类中的加入频道方法时，会返回此错误码。
        • -
      • -
    +
    diff --git a/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount2.dita b/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount2.dita index a26cad72a6a..c266a54c93d 100644 --- a/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount2.dita +++ b/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount2.dita @@ -2,7 +2,7 @@ <ph keyref="joinChannelWithUserAccount2" /> - 使用 User Account 和 Token 加入频道，并设置是否自动订阅音频或视频流。 + 使用 User Account 和 Token 加入频道，并设置频道媒体选项。 @@ -47,17 +47,25 @@ required String userAccount, ChannelMediaOptions? options});

    -
    - 详情 -

    该方法允许本地用户使用 User Account 加入频道。成功加入频道后，会触发以下回调： -

      -
    • 本地：、 和 回调。
      • -
    • 远端：通信场景下的用户和直播场景下的主播加入频道后，远端会分别触发 和 回调。
      • -

    -

    用户成功加入频道后，默认订阅频道内所有其他用户的音频流和视频流，因此产生用量并影响计费。如果想取消订阅，可以通过调用相应的 mute 方法实现。

    -

    相比 ，该方法加了 options 参数，用于配置用户加入频道时是否自动订阅频道内所有远端音视频流。默认情况下，用户订阅频道内所有其他用户的音频流和视频流，因此会产生用量并影响计费。如果想取消订阅，可以通过设置 options 参数或相应的 mute 方法实现。

    -
    -
    +
    +

    调用该方法前，如果你未调用 注册一个 User Account，调用该方法加入频道时，SDK 会自动为你创建一个 User Account。先调用 方法注册 Account，再调用此方法加入频道，可以缩短进入频道的时间。

    +

    用户成功加入频道后，默认订阅频道内所有其他用户的音频流和视频流，因此产生用量并影响计费。如果想取消订阅，可以通过调用相应的 mute 方法实现。

    +

    相比 ，该方法增加了 options 参数，用于在加入频道时设置媒体选项，如是否在频道内发布音视频流等。默认情况下，用户订阅频道内所有其他用户的音频流和视频流，因此会产生用量并影响计费。如果想取消订阅，可以通过设置 options 参数或相应的 mute 方法实现。

    + 为保证通信质量，请确保频道内使用同一类型的数据标识用户身份。即同一频道内需要统一使用 UID 或 User Account。如果有用户通过 Web SDK 加入频道，请确保 Web 加入的用户也是同样类型。 +
    +
    +
    +
    +
    + +
    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccountex.dita b/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccountex.dita index f5c953762c3..bea260ce1c3 100644 --- a/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccountex.dita +++ b/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccountex.dita @@ -2,7 +2,7 @@ <ph keyref="joinChannelWithUserAccountEx" /> - 使用 User Account 加入频道，并设置是否自动订阅音频或视频流。 + 使用 User Account 和 Token 加入频道，并设置频道媒体选项。 @@ -48,20 +48,17 @@ required ChannelMediaOptions options});

    -
    - 详情 -

    -

    该方法允许本地用户使用 User Account 加入频道。成功加入频道后，会触发以下回调： - - -

      -
    • 本地：、 和 回调。
      • -
    • 远端：通信场景下的用户和直播场景下的主播加入频道后，远端会分别触发 和 回调。
      • -

    -

    -

    用户成功加入频道后，默认订阅频道内所有其他用户的音频流和视频流，因此产生用量并影响计费。如果想取消订阅，可以通过调用相应的 mute 方法实现。

    - - 为保证通信质量，请确保频道内使用同一类型的数据标识用户身份。即同一频道内需要统一使用 UID 或 User Account。如果有用户通过 Web SDK 加入频道，请确保 Web 加入的用户也是同样类型。
    +
    +

    调用该方法前，如果你未调用 注册一个 User Account，调用该方法加入频道时，SDK 会自动为你创建一个 User Account。先调用 方法注册 Account，再调用此方法加入频道，可以缩短进入频道的时间。

    +

    用户成功加入频道后，默认订阅频道内所有其他用户的音频流和视频流，因此产生用量并影响计费。如果想取消订阅，可以通过设置 optionsmediaOptions 参数或调用相应的 mute 方法实现。

    + 为保证通信质量，请确保频道内使用同一类型的数据标识用户身份。即同一频道内需要统一使用 UID 或 User Account。如果有用户通过 Web SDK 加入频道，请确保 Web 加入的用户也是同样类型。 +
    +
    +
    +
    +
    +
    参数 @@ -93,12 +90,7 @@
    -
    - <ph keyref="return-section-title"/> -

    方法成功调用时，无返回值；方法调用失败时，会抛出 异常，你需要捕获异常并进行处理。详见了解详情和解决建议。

    -
      -
    • 0: 方法调用成功。
      • -
    • < 0: 方法调用失败。详见了解详情和解决建议。
      • -
    +
    +
    \ No newline at end of file diff --git a/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita b/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita index f821ba7292c..f466020c6c7 100644 --- a/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita +++ b/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita @@ -46,7 +46,7 @@ 若调用失败，远端会触发 回调。

      -
    • 请确保在调用该方法前，已调用 创建了数据通道。
      • +
    • 该方法需要在加入频道后、且调用 创建数据通道之后调用。
    • 直播场景下，该方法仅适用于主播用户。
    diff --git a/dita/RTC-NG/API/api_irtcengine_setcameraautofocusfacemodeenabled.dita b/dita/RTC-NG/API/api_irtcengine_setcameraautofocusfacemodeenabled.dita index 7d7e93e7f3b..2dfff7d1c8f 100644 --- a/dita/RTC-NG/API/api_irtcengine_setcameraautofocusfacemodeenabled.dita +++ b/dita/RTC-NG/API/api_irtcengine_setcameraautofocusfacemodeenabled.dita @@ -16,35 +16,34 @@ public abstract int setCameraAutoFocusFaceModeEnabled(boolean enabled); - (BOOL)setCameraAutoFocusFaceModeEnabled:(BOOL)enable; - virtual int setCameraAutoFocusFaceModeEnabled(bool enabled) = 0; - - UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") - int SetCameraAutoFocusFaceModeEnabled(bool enabled); + virtual int setCameraAutoFocusFaceModeEnabled(bool enabled) = 0; + UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") + int SetCameraAutoFocusFaceModeEnabled(bool enabled); abstract setCameraAutoFocusFaceModeEnabled(enabled: boolean): number; public abstract int SetCameraAutoFocusFaceModeEnabled(bool enabled); abstract setCameraAutoFocusFaceModeEnabled(enabled: boolean): number; Future<void> setCameraAutoFocusFaceModeEnabled(bool enabled);

    -
    - 详情 -

    SDK 默认关闭人脸自动对焦。如需自行设置人脸自动对焦，请调用该方法。

    -

    SDK 默认开启人脸自动对焦。如需自行设置人脸自动对焦，请调用该方法。

    -

    SDK 默认在 Android 平台关闭人脸自动对焦，在 iOS 平台开启人脸自动对焦。如需自行设置人脸自动对焦，请调用该方法。

    - -
      -
    • 该方法仅适用于 Android 和 iOS。
      • -
    • -
    -
    +
    +

    SDK 默认关闭人脸自动对焦。如需开启人脸自动对焦，请调用该方法。

    +

    SDK 默认开启人脸自动对焦。如需关闭人脸自动对焦，请调用该方法。

    +

    SDK 默认在 Android 平台关闭人脸自动对焦，在 iOS 平台开启人脸自动对焦。如需自行设置人脸自动对焦，请调用该方法。

    + 该方法仅适用于 Android 和 iOS。 +
    +
    +
    + 调用限制 +

    无。

    +
    +
    参数 - enabled + enabled enable

    是否开启人脸对焦： -

    • : 开启人脸对焦功能。
    • : 关闭人脸对焦功能。
      • diff --git a/dita/RTC-NG/API/api_irtcengine_setcameracapturerconfiguration.dita b/dita/RTC-NG/API/api_irtcengine_setcameracapturerconfiguration.dita index 1bda8d24313..59714ad3214 100644 --- a/dita/RTC-NG/API/api_irtcengine_setcameracapturerconfiguration.dita +++ b/dita/RTC-NG/API/api_irtcengine_setcameracapturerconfiguration.dita @@ -17,8 +17,8 @@ public abstract setCameraCapturerConfiguration(config: CameraCapturerConfiguration): number; - (int)setCameraCapturerConfiguration:(AgoraCameraCapturerConfiguration * _Nullable)config; virtual int setCameraCapturerConfiguration(const CameraCapturerConfiguration& config) = 0; - UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") - int SetCameraCapturerConfiguration(const FCameraCapturerConfiguration& config); + UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") + int SetCameraCapturerConfiguration(const FCameraCapturerConfiguration& config); abstract setCameraCapturerConfiguration( config: CameraCapturerConfiguration ): number; @@ -30,22 +30,26 @@ CameraCapturerConfiguration config);

    -
    - 详情 - -
      -
    • 该方法仅适用于 Android 和 iOS。
      • -
    • 该方法必须在开启本地摄像头采集前调用，如 和 前调用。
      • -
    • 在调整摄像头的焦距配置前，建议先调用 查询设备支持的焦距能力，再根据查询结果进行配置。
      • -
    • 由于部分 Android 设备的限制，即使根据 的查询结果设置焦距类型，设置结果也可能不生效。
      • -
    -
    +
    +

    在调整摄像头的焦距配置前，建议先调用 查询设备支持的焦距能力，再根据查询结果进行配置。

    +

    由于部分 Android 设备的限制，即使根据 的查询结果设置焦距类型，设置结果也可能不生效。

    + 该方法仅适用于 Android 和 iOS。 +
    +
    + 调用时机 +

    该方法必须在开启本地摄像头采集前调用，如 和 前调用。

    +
    +
    + 调用限制 +

    无。

    +
    +
    参数 - + config 摄像头采集配置，详见 。 - 在该方法中，不需要设置 deviceId 参数。 + 在该方法中，不需要设置 deviceId 参数。
    diff --git a/dita/RTC-NG/API/api_irtcengine_seteffectsvolume.dita b/dita/RTC-NG/API/api_irtcengine_seteffectsvolume.dita index c806598671e..c1b54b60ef8 100644 --- a/dita/RTC-NG/API/api_irtcengine_seteffectsvolume.dita +++ b/dita/RTC-NG/API/api_irtcengine_seteffectsvolume.dita @@ -19,18 +19,24 @@ - (int)setEffectsVolume:(NSInteger)volume; virtual int setEffectsVolume(int volume) = 0; - UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") - int SetEffectsVolume(int volume); + UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") + int SetEffectsVolume(int volume); abstract setEffectsVolume(volume: number): number; public abstract int SetEffectsVolume(int volume); abstract setEffectsVolume(volume: number): number; Future<void> setEffectsVolume(int volume);

    -
    - 详情 - 该方法需要在 后调用。
    -
    +
    +
    + 调用时机 +

    该方法需要在 后调用。

    +
    +
    + 调用限制 +

    无。

    +
    +
    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_setheadphoneeqparameters.dita b/dita/RTC-NG/API/api_irtcengine_setheadphoneeqparameters.dita index 328109251f0..d15839dd542 100644 --- a/dita/RTC-NG/API/api_irtcengine_setheadphoneeqparameters.dita +++ b/dita/RTC-NG/API/api_irtcengine_setheadphoneeqparameters.dita @@ -34,7 +34,7 @@
    v4.1.0
    -

    在空间音效场景下，如果在调用 方法使用预设的耳机均衡效果后仍未达到预期，你可以通过调用该方法进一步调节耳机均衡效果。

    +

    在空间音频场景下，如果在调用 方法使用预设的耳机均衡效果后仍未达到预期，你可以通过调用该方法进一步调节耳机均衡效果。

    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita b/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita index 2432db87a79..fc0f4027653 100644 --- a/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita +++ b/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita @@ -33,7 +33,7 @@
    v4.0.1
    -

    该方法主要应用于空间音效场景下，你可以选择预设的耳机均衡器收听音频，以达到预期的音频体验。

    +

    该方法主要应用于空间音频场景下，你可以选择预设的耳机均衡器收听音频，以达到预期的音频体验。

    如果你使用的耳机已经具备良好的均衡效果，调用该方法时可能不会获得明显的体验提升效果，甚至可能导致体验下降。
    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita b/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita index 67add3b016c..f065aaab458 100644 --- a/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita +++ b/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita @@ -2,7 +2,7 @@ <ph keyref="setRemoteUserSpatialAudioParams" /> - 设置远端用户的空间音效参数。 + 设置远端用户的空间音频参数。 @@ -35,7 +35,7 @@
    详情 -

    该方法需要在 后调用。成功设置远端用户的空间音效参数后，本地用户听远端用户会有空间感。

    +

    该方法需要在 后调用。成功设置远端用户的空间音频参数后，本地用户听远端用户会有空间感。

    参数 @@ -47,7 +47,7 @@ params param - 空间音效参数。详见 。 + 空间音频参数。详见 。
    diff --git a/dita/RTC-NG/API/api_irtcengine_setvideoscenario.dita b/dita/RTC-NG/API/api_irtcengine_setvideoscenario.dita index f90551237e1..fe444460cca 100644 --- a/dita/RTC-NG/API/api_irtcengine_setvideoscenario.dita +++ b/dita/RTC-NG/API/api_irtcengine_setvideoscenario.dita @@ -41,7 +41,7 @@ scenarioType 视频业务场景。详见 。 -

    设置为 (1) 后，SDK 会启用以下策略： +

    (1) 适用于会议场景。SDK 会针对该场景启用以下策略：

    • 针对会议场景对小流码率要求较高的情况，自动启用多项抗弱网技术，提升小流的抗弱网能力，确保多路流订阅时接收端的流畅性。
    • 实时监测接收端大流的订阅人数，根据订阅人数动态调节大流配置：
        @@ -77,6 +77,7 @@

      +

      (2) 适用于视频 1v1 通话场景。针对该场景低延迟、高画质的体验要求，SDK 进行了策略调优，提升了画质、首帧出图、中低端机延迟及弱网流畅度等性能表现。

      diff --git a/dita/RTC-NG/API/api_irtcengine_setvolumeofeffect.dita b/dita/RTC-NG/API/api_irtcengine_setvolumeofeffect.dita index d7574e19335..cc4fc15b763 100644 --- a/dita/RTC-NG/API/api_irtcengine_setvolumeofeffect.dita +++ b/dita/RTC-NG/API/api_irtcengine_setvolumeofeffect.dita @@ -2,7 +2,7 @@ <ph keyref="setVolumeOfEffect" /> - 实时调整音效文件的播放音量。 + 设置指定音效文件的播放音量。 @@ -20,15 +20,24 @@ withVolume:(int)volume; virtual int setVolumeOfEffect(int soundId, int volume) = 0; - UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") - int SetVolumeOfEffect(int soundId, int volume); + UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") + int SetVolumeOfEffect(int soundId, int volume); abstract setVolumeOfEffect(soundId: number, volume: number): number; public abstract int SetVolumeOfEffect(int soundId, int volume); abstract setVolumeOfEffect(soundId: number, volume: number): number; Future<void> setVolumeOfEffect({required int soundId, required int volume});

    -
    +
    +
    + 调用时机 +

    该方法需要在 后调用。

    +
    +
    + 调用限制 +

    无。

    +
    +
    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita b/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita index 1a3ce5b3c23..699244770e7 100644 --- a/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita +++ b/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita @@ -15,7 +15,7 @@

    public abstract int startRhythmPlayer( String sound1, String sound2, AgoraRhythmPlayerConfig config); - - (int)startRhythmPlayer:(NSString * _Nonnull)sound1 sound2:(NSString * _Nonnull)sound2 config:(AgoraRhythmPlayerConfig * _Nullable)config; + - (int)startRhythmPlayer:(NSString * _Nonnull)sound1 sound2:(NSString * _Nonnull)sound2 config:(AgoraRhythmPlayerConfig * _Nullable)config; virtual int startRhythmPlayer(const char* sound1, const char* sound2, const AgoraRhythmPlayerConfig& config) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") int StartRhythmPlayer(FString sound1, FString sound2, const FAgoraRhythmPlayerConfig& config); @@ -36,18 +36,29 @@ required AgoraRhythmPlayerConfig config});

    -
    - 详情 -

    在音乐教学、体育教学等场景中，老师通常需要使用节拍器，让学生跟着正确的节拍练习。节拍由强拍和弱拍组成，每小节的第一拍称为强拍，其余称为弱拍。

    -

    你需要在该方法中设置强拍和弱拍的文件路径、每小节的拍数、节拍速度以及是否将节拍器的声音发送至远端。

    -

    成功调用该方法后，SDK 会在本地触发 回调，报告虚拟节拍器的状态。

    - +
      -
    • 该方法仅适用于 Android 和 iOS。
    • 开启虚拟节拍器后，SDK 会从头开始播放指定的音频文件，并根据你在 中设置的 beatsPerMinute 控制每个文件的播放时长。例如，将 beatsPerMinute 设为 60，则 SDK 会 1 秒播放 1 个节拍。如果文件时长超过了节拍时长，则 SDK 只播放节拍时长部分的音频。
      • -
    • 虚拟节拍器的声音默认会发布至远端，如果你不希望远端用户听到虚拟节拍器的声音，你可以将 中的 publishRhythmPlayerTrack 设为 。
      • -
    -
    +
  • 虚拟节拍器的声音默认不会发布至远端，如果你希望远端用户听到虚拟节拍器的声音，你可以在调用该方法后，将 中的 publishRhythmPlayerTrack 设为 。
    • + +
    +
    + 适用场景 +

    在音乐教学、体育教学等场景中，老师通常需要使用节拍器，让学生跟着正确的节拍练习。节拍由强拍和弱拍组成，每小节的第一拍称为强拍，其余称为弱拍。

    +
    +
    + 调用时机 +

    加入频道前后均可调用。

    +
    +
    + 调用限制 +

    无。

    +
    + +
    参数 @@ -71,10 +82,6 @@
    • 0: 方法调用成功。
    • < 0: 方法调用失败 - - - -
      • -22: 无法找到音频文件。请填写正确的 sound1 和 sound2。
      • diff --git a/dita/RTC-NG/API/api_irtcengine_switchcamera.dita b/dita/RTC-NG/API/api_irtcengine_switchcamera.dita index 2c3aca63773..038a04d6889 100644 --- a/dita/RTC-NG/API/api_irtcengine_switchcamera.dita +++ b/dita/RTC-NG/API/api_irtcengine_switchcamera.dita @@ -17,23 +17,26 @@ public abstract switchCamera(): number; - (int)switchCamera; virtual int switchCamera() = 0; - UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") - int SwitchCamera(); + UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") + int SwitchCamera(); abstract switchCamera(): number; public abstract int SwitchCamera(); abstract switchCamera(): number; Future<void> switchCamera();

    -
    - 详情 -

    你可以调用该方法在 App 运行期间基于可用摄像头的实际情况来动态切换摄像头，而无需重启视频流或重新配置视频源。

    - -
    • 该方法仅适用于 Android 和 iOS。
      • -
    • 该方法必须在摄像头成功开启后调用，即 SDK 触发 回调，返回本地视频状态为 (1) 后。
      • -
    • 该方法仅会对第一路摄像头采集的视频流进行摄像头切换操作，即调用 时设置为 (0) 的视频源。
      • -
    • 该方法和 均用于切换摄像头，区别在于 通过指定摄像头 ID 切换到特定的摄像头，该方法则切换摄像头的方向（前置或后置）。
      • -
    +
    +

    你可以调用该方法在 App 运行期间基于可用摄像头的实际情况来动态切换摄像头，而无需重启视频流或重新配置视频源。

    +

    该方法和 均用于切换摄像头，区别在于 通过指定摄像头 ID 切换到特定的摄像头，该方法则切换摄像头的方向（前置或后置）。

    + 该方法仅适用于 Android 和 iOS。 +
    +
    + 调用时机 +

    该方法必须在摄像头成功开启后调用，即 SDK 触发 回调，返回本地视频状态为 (1) 后。

    +
    +
    + 调用限制 +

    该方法仅会对第一路摄像头采集的视频流进行摄像头切换操作，即调用 时设置为 (0) 的视频源。

    <ph keyref="return-section-title"/> diff --git a/dita/RTC-NG/API/api_irtcengine_switchcamera2.dita b/dita/RTC-NG/API/api_irtcengine_switchcamera2.dita index 0cceae2a596..59dc3a8d500 100644 --- a/dita/RTC-NG/API/api_irtcengine_switchcamera2.dita +++ b/dita/RTC-NG/API/api_irtcengine_switchcamera2.dita @@ -24,23 +24,20 @@

    -
    - 详情 +
    自从
    v4.3.1
    -

    - -

      -
    • -
    • -
    • 该方法和 均用于切换摄像头，区别在于 切换摄像头的方向（前置或后置），该方法则通过指定摄像头 ID 切换到特定的摄像头。
      • -
    +

    +

    该方法和 均用于切换摄像头，区别在于 切换摄像头的方向（前置或后置），该方法则通过指定摄像头 ID 切换到特定的摄像头。

    + 该方法仅适用于 Android 和 iOS。
    -
    +
    +
    +
    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_unloadeffect.dita b/dita/RTC-NG/API/api_irtcengine_unloadeffect.dita index 0fd16b8ea5a..ecd4606f5ef 100644 --- a/dita/RTC-NG/API/api_irtcengine_unloadeffect.dita +++ b/dita/RTC-NG/API/api_irtcengine_unloadeffect.dita @@ -19,15 +19,26 @@ - (int)unloadEffect:(int)soundId; virtual int unloadEffect(int soundId) = 0; - UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") - int UnloadEffect(int soundId); + UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") + int UnloadEffect(int soundId); abstract unloadEffect(soundId: number): number; public abstract int UnloadEffect(int soundId); abstract unloadEffect(soundId: number): number; Future<void> unloadEffect(int soundId);

    -
    +
    +

    调用 将音效文件加载至内存后，如需释放该音效文件，请调用该方法。

    +
    +
    + 调用时机 +

    该方法在加入频道前后均可调用。

    +
    +
    + 调用限制 +

    无。

    +
    +
    参数 diff --git a/dita/RTC-NG/API/api_irtcengineex_adjustuserplaybacksignalvolumeex.dita b/dita/RTC-NG/API/api_irtcengineex_adjustuserplaybacksignalvolumeex.dita index 5faeac2db88..63b9d01276a 100644 --- a/dita/RTC-NG/API/api_irtcengineex_adjustuserplaybacksignalvolumeex.dita +++ b/dita/RTC-NG/API/api_irtcengineex_adjustuserplaybacksignalvolumeex.dita @@ -39,21 +39,24 @@ required RtcConnection connection});

    -
    - 详情 +
    自从
    v4.1.0
    -

    你可以在通话中调用该方法调节指定远端用户在本地播放的音量。如需调节多个用户在本地播放的音量，则需多次调用该方法。

    - -
      -
    • 该方法需要在加入频道后调用。
      • -
    • 该方法调节的是本地播放的指定远端用户混音后的音量。
      • -
    -
    +

    +

    +
    + 调用时机 +

    该方法需要在 之后调用。

    +
    +
    + 调用限制 +

    无。

    +
    +
    参数 diff --git a/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita b/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita index 2bced9424dc..b3cc03bc6c1 100644 --- a/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita +++ b/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita @@ -39,8 +39,8 @@
    调用时机 -

    该方法需要在调用 加入频道后调用。

    -
    +

    该方法需要在 后调用。

    +
    参数 diff --git a/dita/RTC-NG/API/api_irtcengineex_enableaudiovolumeindicationex.dita b/dita/RTC-NG/API/api_irtcengineex_enableaudiovolumeindicationex.dita index 69928a1d17b..96324efecfe 100644 --- a/dita/RTC-NG/API/api_irtcengineex_enableaudiovolumeindicationex.dita +++ b/dita/RTC-NG/API/api_irtcengineex_enableaudiovolumeindicationex.dita @@ -43,11 +43,17 @@ required RtcConnection connection});

    -
    - 详情 -

    该方法允许 SDK 定期向 App 报告本地发流用户和瞬时音量最高的远端用户（最多 3 位）的音量相关信息。启用该方法后，只要频道内有发流用户，SDK 会在加入频道后按设置的时间间隔触发 回调。

    +
    +
    + 调用时机 +

    该方法需要在 之后调用。

    +
    +
    + 调用限制 +

    无。

    -
    +