From 706ce4503320f08e30b4550a6b6eae6f8d22cedd Mon Sep 17 00:00:00 2001 From: jinyu Date: Wed, 3 Jul 2024 15:20:14 +0800 Subject: [PATCH 01/25] Update api_imediaengine_setexternalvideosource.dita --- ...i_imediaengine_setexternalvideosource.dita | 30 ++++++++++++------- 1 file changed, 19 insertions(+), 11 deletions(-) diff --git a/dita/RTC-NG/API/api_imediaengine_setexternalvideosource.dita b/dita/RTC-NG/API/api_imediaengine_setexternalvideosource.dita index 52bba6b133e..8e8b1b6ce09 100644 --- a/dita/RTC-NG/API/api_imediaengine_setexternalvideosource.dita +++ b/dita/RTC-NG/API/api_imediaengine_setexternalvideosource.dita @@ -40,15 +40,23 @@ SenderOptions encodedVideoOption = const SenderOptions()});

-
- 详情 - 请在加入频道前调用该方法。
-
+
+

调用该方法启用外部视频源后，SDK 将创建外部源并准备通过 获取外部视频数据。

+
+
+ 调用时机 +

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

+
+
+ 调用限制 +

不支持在频道内动态切换视频源。如果已调用该方法启用外部视频源并加入频道，若想切换为内部视频源，必须先退出频道，然后调用该方法关闭外部视频源，再重新加入频道。

+
+
参数 - enable - enabled + enable + enabled 是否启用外部视频源：
  • : 启用外部视频源。SDK 准备接收外部视频帧。
    • @@ -67,18 +75,18 @@ sourceType 外部视频帧是否编码，详见 。 - + encodedVideoOption 视频编码选项。如果 sourceType 为 ，则需要设置该参数。你可以了解如何设置该参数。
-
+
<ph keyref="return-section-title"/>

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

-
    -
  • 0：方法调用成功。
    • +
      +
    • 0：方法调用成功。
    • < 0: 方法调用失败。详见了解详情和解决建议。
- + \ No newline at end of file From cabd07e333d54d1714c53b34efec0ebd487e4453 Mon Sep 17 00:00:00 2001 From: jinyu Date: Wed, 3 Jul 2024 15:28:29 +0800 Subject: [PATCH 02/25] Update api_imediaengine_setexternalvideosource.dita --- dita/RTC-NG/API/api_imediaengine_setexternalvideosource.dita | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dita/RTC-NG/API/api_imediaengine_setexternalvideosource.dita b/dita/RTC-NG/API/api_imediaengine_setexternalvideosource.dita index 8e8b1b6ce09..3dc14e20080 100644 --- a/dita/RTC-NG/API/api_imediaengine_setexternalvideosource.dita +++ b/dita/RTC-NG/API/api_imediaengine_setexternalvideosource.dita @@ -41,7 +41,7 @@

-

调用该方法启用外部视频源后，SDK 将创建外部源并准备通过 获取外部视频数据。

+

调用该方法启用外部视频源后，你可以调用 向 SDK 推送外部视频数据。

调用时机 From 8133cb38b0561384399c637c72fb87c2a5f303a7 Mon Sep 17 00:00:00 2001 From: jinyu Date: Wed, 3 Jul 2024 15:28:36 +0800 Subject: [PATCH 03/25] Update api_imediaengine_setexternalaudiosink.dita --- ...api_imediaengine_setexternalaudiosink.dita | 39 ++++++++++--------- 1 file changed, 21 insertions(+), 18 deletions(-) diff --git a/dita/RTC-NG/API/api_imediaengine_setexternalaudiosink.dita b/dita/RTC-NG/API/api_imediaengine_setexternalaudiosink.dita index 4f6dd5e0e53..a7902e23fc7 100644 --- a/dita/RTC-NG/API/api_imediaengine_setexternalaudiosink.dita +++ b/dita/RTC-NG/API/api_imediaengine_setexternalaudiosink.dita @@ -34,33 +34,36 @@ {required bool enabled, required int sampleRate, required int channels});

-
- 详情 -

该方法适用于需要自行渲染音频的场景。开启外部音频渲染后，你可以调用 拉取远端音频数据。App 可以对拉取到的原始音频数据进行处理后再渲染，获取想要的音频效果。

- -
    -
  • 使用该方法前，你需要在 中设置 enableAudioDevice 为 。
    • -
  • 该方法需要在加入频道前调用。
    • -
  • 开启外部音频渲染后，App 会无法从 回调中获得数据。
    • -
-
+
+

调用该方法开启外部音频渲染后，你可以调用 拉取远端音频数据。App 可以对拉取到的原始音频数据进行处理后再渲染，获取想要的音频效果。

+
+
+ 适用场景 +

该方法适用于需要自行渲染音频的场景。

+
+
+ 调用时机 +

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

+
+
+ 调用限制 +

调用该方法开启外部音频渲染后，App 将无法从 回调中获得数据。

+
+
参数 enabled - -

设置是否开启外部音频渲染： + 设置是否开启外部音频渲染：

  • ：开启外部音频渲染。
  • ：（默认）关闭外部音频渲染。
    • -

+ sampleRate - -

外部音频渲染的采样率 (Hz)，可设置为 16000，32000，44100 或 48000。

- + 外部音频渲染的采样率 (Hz)，可设置为 16000，32000，44100 或 48000。 channels @@ -71,12 +74,12 @@
-
+
<ph keyref="return-section-title"/>

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

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见了解详情和解决建议。
- + \ No newline at end of file From edc0da92d0f485712b226df9b67116f3d5e5839b Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Wed, 3 Jul 2024 15:30:41 +0800 Subject: [PATCH 04/25] 1 --- dita/RTC-NG/API/class_videocanvas.dita | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dita/RTC-NG/API/class_videocanvas.dita b/dita/RTC-NG/API/class_videocanvas.dita index 6bd2f466fef..ed844588797 100644 --- a/dita/RTC-NG/API/class_videocanvas.dita +++ b/dita/RTC-NG/API/class_videocanvas.dita @@ -347,7 +347,7 @@ class VideoCanvas {
  • ：开启 Alpha 遮罩渲染。
  • ：（默认）关闭 Alpha 遮罩渲染。
    • -

    alpha 遮罩渲染可以创建具有透明效果的图像，还可以提取视频中的人像。与其他方法结合使用时，可以实现人像画中画、添加水印等效果。

    +

    Alpha 遮罩渲染可以创建具有透明效果的图像，还可以提取视频中的人像。与其他方法结合使用时，可以实现人像画中画、添加水印等效果。

    • 仅当发送端开启 Alpha 传输功能时，接收端才能渲染 Alpha 通道的信息。
      • From c577ea3519a71bb71fe7310e666910bd86dc34da Mon Sep 17 00:00:00 2001 From: Nero-Hu Date: Wed, 3 Jul 2024 16:03:26 +0800 Subject: [PATCH 05/25] batch2 --- .../api_irtcengine_enablecontentinspect.dita | 14 ++++++--- .../api_irtcengine_setlocalaccesspoint.dita | 19 +++++++----- .../API/api_irtcengine_startechotest3.dita | 26 ++++++++++------- ...api_irtcengine_startlastmileprobetest.dita | 29 ++++++++++++------- ...i_irtcengineex_enablecontentinspectex.dita | 14 ++++++--- 5 files changed, 65 insertions(+), 37 deletions(-) diff --git a/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita b/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita index af914a344cf..53117ae0557 100644 --- a/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita +++ b/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita @@ -32,12 +32,18 @@ {required bool enabled, required ContentInspectConfig config});

    -
    - 详情 +

    开启本地截图上传后，SDK 会根据你在 中设置的模块类型和频率对本地用户发送的视频进行截图和上传。截图完成后，声网服务器会以 HTTPS 请求的形式，向你的服务器发送回调通知，并将所有截图发送至你指定的第三方云存储。

    - 调用该方法前，请确保已开通本地截图上传服务。
    -
    +
    + 调用时机 +

    加入频道前后均可调用。

    +
    +
    + 调用限制 +

    调用该方法前，请确保已开通本地截图上传服务。

    +
    +
    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita b/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita index cce6f40f832..db38aa740cb 100644 --- a/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita +++ b/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita @@ -25,15 +25,18 @@ Future<void> setLocalAccessPoint(LocalAccessPointConfiguration config);

    -
    - 详情 +

    成功部署声网私有媒体服务器并在内网终端集成 RTC SDK v4.x 后，你可以调用该方法指定 Local Access Point，给 SDK 分配接入模块。

    - -
      -
    • 该方法仅在部署声网混合云方案后生效。你可以联系 了解和部署声网混合云。
      • -
    • 该方法需要在加入频道前调用。
      • -
    -
    +
    +
    + 调用时机 +

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

    +
    +
    + 调用限制 +

    该方法仅在部署声网混合云方案后生效。你可以联系 了解和部署声网混合云。

    +
    +
    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_startechotest3.dita b/dita/RTC-NG/API/api_irtcengine_startechotest3.dita index d154ebf2532..68b46ba4c91 100644 --- a/dita/RTC-NG/API/api_irtcengine_startechotest3.dita +++ b/dita/RTC-NG/API/api_irtcengine_startechotest3.dita @@ -25,18 +25,24 @@ Future<void> startEchoTest(EchoTestConfiguration config);

    -
    - 详情 +

    为测试用户本地发流、收流是否正常，你可以调用该方法进行音视频通话回路测试，即测试系统的音视频设备和用户的上下行网络是否正常。

    -

    开始测试后，用户需发出声音或面对摄像头，音频或视频会在约 2 秒后播放出来。如果音频播放正常，则表示系统音频设备和用户上下行网络均正常； 如果视频播放正常，则表示系统视频设备和用户上下行网络均正常。 - -

      -
    • 该方法在加入频道前后均可调用。在频道内调用时，需确保当前没有发布音视频流。
      • -
    • 调用该方法后，必须调用 结束测试，否则该用户无法进行下一次音视频通话回路测试， 也无法加入频道。
      • -
    • 直播场景下，该方法仅能由主播调用。
      • -

    +

    开始测试后，用户需发出声音或面对摄像头，音频或视频会在约 2 秒后播放出来。如果音频播放正常，则表示系统音频设备和用户上下行网络均正常； 如果视频播放正常，则表示系统视频设备和用户上下行网络均正常。

    -
    +
    + 调用时机 +

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

    +
    +
    + 调用限制 +
      +
    • 在频道内调用该方法时，需确保当前没有发布音视频流。
      • +
    • 调用该方法后，必须调用 结束测试，否则该用户无法进行下一次音视频通话回路测试， 也无法加入频道。
      • +
    • 直播场景下，该方法仅能由主播调用。
      • +
    +

    +

    +
    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_startlastmileprobetest.dita b/dita/RTC-NG/API/api_irtcengine_startlastmileprobetest.dita index f20cd326a2a..d1eccc9708b 100644 --- a/dita/RTC-NG/API/api_irtcengine_startlastmileprobetest.dita +++ b/dita/RTC-NG/API/api_irtcengine_startlastmileprobetest.dita @@ -25,24 +25,31 @@ Future<void> startLastmileProbeTest(LastmileProbeConfig config);

    -
    - 详情 +

    开始通话前网络质量探测，向用户反馈上下行网络的带宽、丢包、网络抖动和往返时延数据。

    -

    启用该方法后，SDK 会依次返回如下 2 个回调： +

    +
    + 调用时机 +

    该方法需要在加入频道前调用，用于判断和预测目前的上行网络质量是否足够好。

    +
    +
    + 调用限制 +

    +

      +
    • 调用该方法后，在收到 和 回调之前请不要调用其他方法，否则可能会由于 API 操作过于频繁导致此方法无法执行。
      • +
    • 在直播场景中，如果本地用户为主播，请勿加入频道后调用该方法。
      • +
    +
    + -
    +
    参数 diff --git a/dita/RTC-NG/API/api_irtcengineex_enablecontentinspectex.dita b/dita/RTC-NG/API/api_irtcengineex_enablecontentinspectex.dita index 348636f9b01..4480d6c36d1 100644 --- a/dita/RTC-NG/API/api_irtcengineex_enablecontentinspectex.dita +++ b/dita/RTC-NG/API/api_irtcengineex_enablecontentinspectex.dita @@ -29,8 +29,7 @@ required ContentInspectConfig config, required RtcConnection connection});

    -
    - 详情 +
    自从
    @@ -38,9 +37,16 @@

    该方法可以对多条视频流截图并上传。开启本地截图上传后，SDK 会根据你在 中设置的模块类型和频率对本地用户发送的视频进行截图和上传。截图完成后，声网服务器会以 HTTPS 请求的形式，向你的服务器发送回调通知，并将所有截图发送至你指定的第三方云存储。

    - 调用该方法前，请确保已开通本地截图上传服务。
    -
    +
    + 调用时机 +

    加入频道前后均可调用。

    +
    +
    + 调用限制 +

    调用该方法前，请确保已开通本地截图上传服务。

    +
    +
    参数 From b2d80003c5cffe8939cbc43af7f41351e7835e3d Mon Sep 17 00:00:00 2001 From: jinyu Date: Wed, 3 Jul 2024 16:24:24 +0800 Subject: [PATCH 06/25] 1 --- .../API/api_imediaengine_pullaudioframe.dita | 35 +++++++++++-------- .../API/api_irtcengine_pullaudioframe2.dita | 12 ++++--- 2 files changed, 27 insertions(+), 20 deletions(-) diff --git a/dita/RTC-NG/API/api_imediaengine_pullaudioframe.dita b/dita/RTC-NG/API/api_imediaengine_pullaudioframe.dita index 6f6b6ea4c99..12e76292986 100644 --- a/dita/RTC-NG/API/api_imediaengine_pullaudioframe.dita +++ b/dita/RTC-NG/API/api_imediaengine_pullaudioframe.dita @@ -24,22 +24,27 @@ Future<void> pullAudioFrame(AudioFrame frame);

    -
    - 详情 -

    使用该方法前，你需要调用 (enabled: ) 通知 App 开启并设置外部渲染。

    +

    调用该方法后，App 会采取主动拉取的方式获取远端已解码和混音后的音频数据，用于音频播放。

    - +
    +
    + 调用时机
      -
    • 该方法需要在加入频道后调用。
      • -
    • 该方法和 回调均可用于获取远端混音后的音频数据。需要注意的是：在调用 开启外部音频渲染后，App 将无法从 回调中获得数据，因此，请根据实际的业务需求在该方法和 回调之间进行选择。二者的处理机制不同，具体区别如下： +
    • 使用该方法前，你需要调用 (enabled: ) 开启并设置外部渲染。
      • +
    • 该方法需要在加入频道后调用。
      • +
    +
    +
    + 调用限制 +

    该方法和 回调均可用于获取远端混音后的音频播放数据。在调用 开启外部音频渲染后，App 将无法从 回调中获得数据。因此，请根据实际的业务需求在该方法和 回调之间进行选择。二者的处理机制不同，具体区别如下：

      -
    • 调用该方法后 App 会主动拉取音频数据。通过设置音频数据，SDK 可以调整缓存，帮助 App 处理延时，从而有效避免音频播放抖动。
      • -
    • SDK 通过 回调将音频数据传输给 App。如果 App 处理延时，可能会导致音频播放抖动。
      • -
    -
  • 该方法仅用于拉取远端混音后的音频数据，如需获取采集、播放等不同音频处理阶段的音频数据，可以通过调用 注册相应的回调。
    • -
    -
    - 参数 +
  • 调用该方法后，App 会主动拉取音频数据。通过设置音频数据，SDK 可以调整缓存，帮助 App 处理延时，从而有效避免音频播放抖动。
    • +
  • 注册 后，SDK 通过该回调将音频数据传输给 App。App 在处理音频帧时的延迟可能会导致音频播放抖动。
    • +

    +

    该方法仅用于拉取远端混音后的音频播放数据，如需获取采集的原始音频数据、混音前每条拉流单独的原始音频播放数据等，可以通过调用 注册相应的回调。

    +
    +
    + 参数 frame @@ -69,5 +74,5 @@
  • 方法调用成功，返回一个 对象。
  • 方法调用失败，返回错误码。
    • - - + + \ No newline at end of file diff --git a/dita/RTC-NG/API/api_irtcengine_pullaudioframe2.dita b/dita/RTC-NG/API/api_irtcengine_pullaudioframe2.dita index 42769e03bfc..dc2a32dab1c 100644 --- a/dita/RTC-NG/API/api_irtcengine_pullaudioframe2.dita +++ b/dita/RTC-NG/API/api_irtcengine_pullaudioframe2.dita @@ -23,17 +23,19 @@

    -
    -
    +
    +
    +
    +
    参数 data 待拉取的远端音频数据，数据类型为 ByteBuffer。 - - lengthInByte - 远端音频数据长度，单位为字节。 该参数的值由音频数据时长、 的 sampleRate 和 channels 参数确定。lengthInByte = sampleRate/1000 × 2 × channels × 音频数据时长 (ms)。 + + +
    From 3cdbbc56d7a68ed36d978fef6437f5a28d60228e Mon Sep 17 00:00:00 2001 From: jinyu Date: Wed, 3 Jul 2024 16:39:53 +0800 Subject: [PATCH 07/25] 1 --- ..._imediaengine_setexternalaudiosource2.dita | 39 ++++++++-------- ...api_irtcengine_setexternalaudiosource.dita | 44 ++++++------------- 2 files changed, 33 insertions(+), 50 deletions(-) diff --git a/dita/RTC-NG/API/api_imediaengine_setexternalaudiosource2.dita b/dita/RTC-NG/API/api_imediaengine_setexternalaudiosource2.dita index 17400b8247c..c51f1373389 100644 --- a/dita/RTC-NG/API/api_imediaengine_setexternalaudiosource2.dita +++ b/dita/RTC-NG/API/api_imediaengine_setexternalaudiosource2.dita @@ -48,54 +48,55 @@ bool publish = true});

    -
    - 详情 +
    弃用：
    该方法已废弃，请改用 。
    - 请在加入频道前调用该方法。
    -
    +
    +
    + 调用时机 +

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

    +
    +
    + 调用限制 +

    无。

    +
    +
    参数 - + enabled - -

    是否开启使用外部音频源的功能： - + 是否开启使用外部音频源的功能：

    • ：开启外部音频源。
    • ：（默认）关闭外部音频源。
      • -

    +     - + sampleRate 外部音频源的采样率 (Hz)，可设置为 8000，16000，32000，44100 或 48000。 - + channels 外部音频源的声道数，可设置为 1（单声道）或 2（双声道）。 localPlayback - -

    是否在本地播放外部音频源： - + 是否在本地播放外部音频源：

    • ：在本地播放。
    • ：（默认）不在本地播放。
      • -

    +     publish - -

    是否将音频发布到远端： - -

      + 是否将音频发布到远端： +
      • ：（默认）发布到远端。
      • ：不发布到远端。

      diff --git a/dita/RTC-NG/API/api_irtcengine_setexternalaudiosource.dita b/dita/RTC-NG/API/api_irtcengine_setexternalaudiosource.dita index ed3490a0235..e126932dcd5 100644 --- a/dita/RTC-NG/API/api_irtcengine_setexternalaudiosource.dita +++ b/dita/RTC-NG/API/api_irtcengine_setexternalaudiosource.dita @@ -25,41 +25,23 @@

    -
    - 详情 -
    - -
    弃用：
    -
    该方法已废弃，请改用 。
    -     -
    -

    请在 和 前调用该方法。

    -
    -
    +
    +
    +
    +
    参数 - - enabled - -
      -
    • : 开启使用外部音频源的功能。
      • -
    • : （默认）关闭使用外部音频源的功能。
      • -
    + + + - - sampleRate - 外部音频源的采样率 (Hz)，可设置为 8000，16000，32000，44100 或 48000。 + + + - - channels - -

    外部音频源的通道数，可设置为 1 或 2: - -

      -
    • 1: 单声道
      • -
    • 2: 双声道
      • -

    -     + + +
    From 3ebee82f30608c9dc3d490fbc815dcef14b101a7 Mon Sep 17 00:00:00 2001 From: Suri539 Date: Wed, 3 Jul 2024 16:47:13 +0800 Subject: [PATCH 08/25] =?UTF-8?q?api=20=E4=BB=AC?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../API/api_irtcengine_pauseaudiomixing.dita | 13 ++- .../API/api_irtcengine_resumeaudiomixing.dita | 13 ++- .../API/api_irtcengine_setainsmode.dita | 46 ++++++----- .../api_irtcengine_setaudiomixingpitch.dita | 17 ++-- .../API/api_irtcengine_startaudiomixing.dita | 80 +++++++------------ .../API/api_irtcengine_startaudiomixing2.dita | 67 ++++++++-------- .../API/api_irtcengine_stopaudiomixing.dita | 13 ++- ..._irtcengineeventhandler_onuseroffline.dita | 34 +++++--- dita/RTC-NG/API/rtc_api_overview.dita | 2 +- .../config/keys-rtc-ng-links-flutter.ditamap | 4 +- .../config/keys-rtc-ng-links-rn.ditamap | 8 +- .../config/keys-rtc-ng-links-unity.ditamap | 4 +- 12 files changed, 160 insertions(+), 141 deletions(-) diff --git a/dita/RTC-NG/API/api_irtcengine_pauseaudiomixing.dita b/dita/RTC-NG/API/api_irtcengine_pauseaudiomixing.dita index 99865625371..245fcbbe43f 100644 --- a/dita/RTC-NG/API/api_irtcengine_pauseaudiomixing.dita +++ b/dita/RTC-NG/API/api_irtcengine_pauseaudiomixing.dita @@ -25,9 +25,16 @@ Future<void> pauseAudioMixing();

    -
    - 详情 -

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

    +
    +

    当你调用 方法播放音乐文件后，如需暂停播放，请调用该方法。如果你需要停止播放，请调用 。

    +
    +
    + 调用时机 +

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

    +
    +
    + 调用限制 +

    无。

    <ph keyref="return-section-title"/> diff --git a/dita/RTC-NG/API/api_irtcengine_resumeaudiomixing.dita b/dita/RTC-NG/API/api_irtcengine_resumeaudiomixing.dita index 7ff2e9fed41..3ba851539b4 100644 --- a/dita/RTC-NG/API/api_irtcengine_resumeaudiomixing.dita +++ b/dita/RTC-NG/API/api_irtcengine_resumeaudiomixing.dita @@ -25,9 +25,16 @@ Future<void> resumeAudioMixing();

    -
    - 详情 -

    该方法恢复混音，继续播放音乐文件。请在频道内调用该方法。

    +
    +

    当你调用 暂停播放音乐文件后，如需恢复播放，请调用该方法。

    +
    +
    + 调用时机 +

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

    +
    +
    + 调用限制 +

    无。

    <ph keyref="return-section-title"/> diff --git a/dita/RTC-NG/API/api_irtcengine_setainsmode.dita b/dita/RTC-NG/API/api_irtcengine_setainsmode.dita index 33e39512b69..e187adee2f2 100644 --- a/dita/RTC-NG/API/api_irtcengine_setainsmode.dita +++ b/dita/RTC-NG/API/api_irtcengine_setainsmode.dita @@ -25,33 +25,39 @@ Future<void> setAINSMode( {required bool enabled, required AudioAinsMode mode});

    -
    - 详情 +
    - -
    自从
    -
    v4.2.0
    -     + +
    自从
    +
    v4.2.0
    +

    你可以调用开方法来开启 AI 降噪功能。该功能可以在保证语音质量的前提下，智能化检测并降低周围环境中多种稳态与非稳态噪声，使人声更加清晰。 -稳态噪声指在任何时间点上都具有相同频率的噪声，常见的稳态噪声有： -

    • 电视机噪声
      • -
    • 空调噪声
      • -
    • 工厂机器噪声等
    -非稳态噪声是指随时间而快速变化的噪声，常见的非稳态噪声有： -
    • 雷声
      • -
    • 爆炸声
      • -
    • 破裂声等

    - -
    • 该方法依赖于 AI 降噪动态库 ，如果删除该动态库会导致无法正常开启该功能。
      • -
    • 该方法依赖于 AI 降噪动态库，如果删除该动态库会导致无法正常开启该功能。AI 降噪动态库名称见。
      • -
    • 目前暂不推荐在 Android 6.0 及以下版本的设备上开启该功能。
     + 稳态噪声指在任何时间点上都具有相同频率的噪声，常见的稳态噪声有： +
    • 电视机噪声
      • +
    • 空调噪声
      • +
    • 工厂机器噪声等
    + 非稳态噪声是指随时间而快速变化的噪声，常见的非稳态噪声有： +
    • 雷声
      • +
    • 爆炸声
      • +
    • 破裂声等
    +

    -
    +
    适用场景

    在语音连麦、在线教育、在线会议等场景中，如果周围环境比较嘈杂，AI 降噪功能可以在保证语音质量的前提下，识别并降低周围的稳态噪声和非稳态噪声，提高语音质量和体验。

    -
    +
    + 调用时机 +

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

    +
    +
    + 调用限制 +
    • 该方法依赖于 AI 降噪动态库 ，如果删除该动态库会导致无法正常开启该功能。
      • +
    • 该方法依赖于 AI 降噪动态库，如果删除该动态库会导致无法正常开启该功能。AI 降噪动态库名称见。
      • +
    • 目前暂不推荐在 Android 6.0 及以下版本的设备上开启该功能。
    +
    +
    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_setaudiomixingpitch.dita b/dita/RTC-NG/API/api_irtcengine_setaudiomixingpitch.dita index 1ea4efffa52..6c74142a137 100644 --- a/dita/RTC-NG/API/api_irtcengine_setaudiomixingpitch.dita +++ b/dita/RTC-NG/API/api_irtcengine_setaudiomixingpitch.dita @@ -25,11 +25,18 @@ Future<void> setAudioMixingPitch(int pitch);

    -
    - 详情 -

    本地人声和播放的音乐文件混音时，调用该方法可以仅调节音乐文件的音调。

    - 你需要在调用 并收到 () 回调后调用该方法。
    -
    +
    +

    本地人声和播放的音乐文件混音时，调用该方法可以仅调节音乐文件的音调。

    +
    +
    + 调用时机 +

    你需要在调用 并收到 () 回调后调用该方法。

    +
    +
    + 调用限制 +

    无。

    +
    +
    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita b/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita index 0d1118cc13e..0c50cd4a9f1 100644 --- a/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita +++ b/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita @@ -34,28 +34,23 @@ int startPos = 0});

    -
    - 详情 -
    - -
    弃用：
    -
    请改用 。
    -     -
    -

    该方法支持将本地或在线音乐文件和麦克风采集的音频进行混音或替换。成功播放音乐文件后，本地会触发 () 回调。播放结束后，本地会触发 () 回调。

    -

    该方法支持播放以 content:// 开头的 URI 文件。

    - -
      -
    • 该方法在加入频道前后均可调用。如需多次调用 ，请确保调用间隔大于 500 ms。
      • -
    • 如果本地音乐文件不存在、文件格式不支持或无法访问在线音乐文件 URL，则 SDK 会报告警告码 701。
      • -
    • 在 Android 平台上调用该方法时，请注意如下事项： -
        -
      • 请确保使用 Android 4.2 或以上设备，且 API Level 不低于 16。
        • -
      • 如果播放的是在线音乐文件，建议不要使用重定向地址。重定向地址在某些机型上可能无法打开。
        • -
      • 如果在模拟器上调用该方法，则请确保音乐文件在 /sdcard/ 目录下，且格式为 MP3。
        • -
      • -
    -
    +
    +
    + +
    弃用：
    +
    请改用 。
    +     +
    +

    该方法支持播放的音频文件格式见 RTC SDK 支持播放哪些格式的音频文件。如果本地音乐文件不存在、文件格式不支持或无法访问在线音乐文件 URL，则 SDK 会报告警告码 701。

    +

    该方法支持播放以 content:// 开头的 URI 文件。支持的音频格式详见 RTC SDK 支持播放哪些格式的音频文件。如果本地音乐文件不存在、文件格式不支持或无法访问在线音乐文件 URL，则 SDK 会报告警告码 701。

    +
    +
    +
    +
    +
    + +
    参数 @@ -63,40 +58,19 @@ - filePath - -

    - + + - - loopback - -

    是否只在本地播放音乐文件： - -

      -
    • : 只在本地播放音乐文件，只有本地用户能听到音乐。
      • -
    • : 将本地播放的音乐文件发布至远端，本地用户和远端用户都能听到音乐。
      • -

    -     + + + - - cycle - -

    音乐文件的播放次数。 - -

      -
    • ≥ 0: 播放次数。例如，0 表示不播放；1 表示播放 1 次。
      • -
    • -1: 无限循环播放。
      • -

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

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

    -
      -
    • 0: 方法调用成功。
      • -
    • < 0: 方法调用失败。详见了解详情和解决建议。
      • -
    +
    +
    diff --git a/dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita b/dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita index 89b6584e891..3bad5f1f4ff 100644 --- a/dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita +++ b/dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita @@ -39,53 +39,56 @@ int startPos = 0});

    -
    - 详情 -

    该方法支持将本地或在线音乐文件和麦克风采集的音频进行混音或替换。成功播放音乐文件后，本地会触发 () 回调。播放结束后，本地会触发 () 回调。

    -

    该方法支持播放以 content:// 开头的 URI 文件。

    - -
      -
    • 该方法在加入频道前后均可调用。如需多次调用 ，请确保调用间隔大于 500 ms。
      • -
    • 如果本地音乐文件不存在、文件格式不支持或无法访问在线音乐文件 URL，则 SDK 会报告警告码 701。
      • -
    • 该方法支持的音频文件格式见 RTC SDK 支持播放哪些格式的音频文件。
      • -
    • -
    • 在 Android 平台上调用该方法时，请注意如下事项： - +
      +

      该方法支持播放的音频文件格式见 RTC SDK 支持播放哪些格式的音频文件。如果本地音乐文件不存在、文件格式不支持或无法访问在线音乐文件 URL，则 SDK 会报告警告码 701。

      +

      该方法支持播放以 content:// 开头的 URI 文件。支持的音频格式详见 RTC SDK 支持播放哪些格式的音频文件。如果本地音乐文件不存在、文件格式不支持或无法访问在线音乐文件 URL，则 SDK 会报告警告码 701。

      +
      +
      + 调用时机 +

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

      +
      +
      + 调用限制
        -
      • 请确保使用 Android 4.2 或以上设备，且 API Level 不低于 16。
        • -
      • 如果播放的是在线音乐文件，建议不要使用重定向地址。重定向地址在某些机型上可能无法打开。
        • -
      • 如果在模拟器上调用该方法，则请确保音乐文件在 /sdcard/ 目录下，且格式为 MP3。
        • -
      • -
    -
    +
  • 如需多次调用该方法，请确保调用间隔大于 500 ms。
    • +
  • 在 Android 平台上调用该方法时，请注意如下事项： +
      +
    • 请确保使用 Android 4.2 或以上设备，且 API Level 不低于 16。
      • +
    • 如果播放的是在线音乐文件，建议不要使用重定向地址。重定向地址在某些机型上可能无法打开。
      • +
    • 如果在模拟器上调用该方法，则请确保音乐文件在 /sdcard/ 目录下，且格式为 MP3。
      • +
    • + +
    + +
    参数 - + loopback

    是否只在本地播放音乐文件：

      -
    • : 只在本地播放音乐文件，只有本地用户能听到音乐。
      • -
    • : 将本地播放的音乐文件发布至远端，本地用户和远端用户都能听到音乐。
      • +
    • ：只在本地播放音乐文件，只有本地用户能听到音乐。
      • +
    • ：将本地播放的音乐文件发布至远端，本地用户和远端用户都能听到音乐。

         - + cycle

    音乐文件的播放次数。 - - - -

      -
    • ≥ 0: 播放次数。例如，0 表示不播放；1 表示播放 1 次。
      • -
    • -1: 无限循环播放。
      • -

    +
      +
    • >0: 播放次数。例如，1 表示播放 1 次。
      • +
    • -1: 无限循环播放。
      • +

    @@ -98,10 +101,10 @@

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

    • 0: 方法调用成功。
      • -
    • < 0: 方法调用失败 +
    • < 0: 方法调用失败：
        -
      • -1: 一般性的错误（未明确归类）。
        • -
      • -2: 设置了无效的参数。
        • +
      • -1：一般性的错误（未明确归类）。
        • +
      • -2：设置了无效的参数。
      • -3：SDK 尚未准备好：
        • 请检查是否已开启音频模块。
        • 请检查程序集完整性。
          • diff --git a/dita/RTC-NG/API/api_irtcengine_stopaudiomixing.dita b/dita/RTC-NG/API/api_irtcengine_stopaudiomixing.dita index bd290e64502..da98c7894e4 100644 --- a/dita/RTC-NG/API/api_irtcengine_stopaudiomixing.dita +++ b/dita/RTC-NG/API/api_irtcengine_stopaudiomixing.dita @@ -25,9 +25,16 @@ Future<void> stopAudioMixing();

    -
    - 详情 -

    该方法停止播放音乐文件。请在频道内调用该方法。

    +
    +

    当你调用 方法播放音乐文件后，如需停止播放，可调用该方法。如果仅需暂停播放，请调用 。

    +
    +
    + 调用时机 +

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

    +
    +
    + 调用限制 +

    无。

    <ph keyref="return-section-title"/> diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onuseroffline.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onuseroffline.dita index 429d6af9b2c..a0468df4b9a 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onuseroffline.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onuseroffline.dita @@ -2,7 +2,7 @@ <ph keyref="onUserOffline" /> - 远端用户（通信场景）/主播（直播场景）离开当前频道回调。 + 远端用户或主播离开当前频道回调。 @@ -38,14 +38,22 @@ UserOfflineReasonType reason)? onUserOffline;

    -
    -

    用户离开频道有两个原因： -

      -
    • 正常离开：远端用户/主播会发送类似“再见”的消息。接收此消息后，判断用户离开频道。
      • -
    • 超时掉线：在一定时间内（通信场景为 20 秒，直播场景稍有延时），用户没有收到对方的任何数据包，则判定为对方掉线。在网络较差的情况下，有可能会误报。建议使用云信令 SDK 来做可靠的掉线检测。
      • -

    +
    +

    用户离开频道一般有以下两个原因： +

      +
    • 正常离开：远端用户或主播会发送类似“再见”的消息然后主动离开频道。
      • +
    • 超时掉线：在一定时间内（通信场景为 20 秒，直播场景稍有延时），用户没有收到对方的任何数据包，则判定为对方掉线。在网络较差的情况下，有可能会误报。建议使用 RTM SDK 来做可靠的掉线检测。
      • +

    -
    +
    + 触发时机 +

    在音视频互动过程中，当远端用户或主播离开当前频道时会触发该回调。

    +
    +
    + 使用限制 +

    无。

    +
    +
    <ph keyref="callback-section-title" /> @@ -59,16 +67,16 @@ uid remoteUid - 离线用户或主播的用户 ID。 + 离线的远端用户或主播的 ID。 reason -

    离线原因: 。

    -

    远端用户（通信场景）或主播（直播场景）下线的原因： +

    离线原因，详见 。

    +

    远端用户或主播离线的原因：

      -
    • (0)：用户主动离开。此时离开频道的用户会发送一个类似“再见”的消息。收到该消息是，SDK 判定该用户离开频道。
      • -
    • (1)：因过长时间收不到对方数据包，SDK 判定该远端用户超时掉线。注意：在网络连接不稳定时，该判定 可能会有误。建议使用实时消息 SDK 来做可靠的掉线检测。
      • +
    • (0)：用户主动离开。此时离开频道的用户会发送一个类似“再见”的消息。
      • +
    • (1)：因过长时间收不到对方数据包，SDK 判定该远端用户超时掉线。注意：在网络连接不稳定时，该判定可能会有误。建议使用 RTM SDK 来做可靠的掉线检测。
    • (2)：用户的角色从主播切换为观众。

     diff --git a/dita/RTC-NG/API/rtc_api_overview.dita b/dita/RTC-NG/API/rtc_api_overview.dita index e06396db4d4..6f771326b09 100644 --- a/dita/RTC-NG/API/rtc_api_overview.dita +++ b/dita/RTC-NG/API/rtc_api_overview.dita @@ -412,7 +412,7 @@ - + diff --git a/dita/RTC-NG/config/keys-rtc-ng-links-flutter.ditamap b/dita/RTC-NG/config/keys-rtc-ng-links-flutter.ditamap index 6e8051f248a..873d2b7c715 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-links-flutter.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-links-flutter.ditamap @@ -47,10 +47,10 @@ - + - 减小 App 体积 + 插件列表 diff --git a/dita/RTC-NG/config/keys-rtc-ng-links-rn.ditamap b/dita/RTC-NG/config/keys-rtc-ng-links-rn.ditamap index ec6035d937d..2859fb21218 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-links-rn.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-links-rn.ditamap @@ -33,7 +33,7 @@ 使用 Token 鉴权 - + @@ -47,11 +47,11 @@ 错误码 - - + + - 减小 App 体积 + 插件列表 diff --git a/dita/RTC-NG/config/keys-rtc-ng-links-unity.ditamap b/dita/RTC-NG/config/keys-rtc-ng-links-unity.ditamap index d825aa60085..86b36183034 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-links-unity.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-links-unity.ditamap @@ -48,10 +48,10 @@ - + - 减小 App 体积 + 插件列表 From 88a0d0aff9e8e4adfdee34329d51ab5475b10a74 Mon Sep 17 00:00:00 2001 From: jinyu Date: Wed, 3 Jul 2024 17:12:46 +0800 Subject: [PATCH 09/25] 1 --- .../API/api_imediaengine_pushaudioframe0.dita | 20 +++++++++----- .../API/api_irtcengine_pushaudioframe2.dita | 26 ++++++++++--------- 2 files changed, 27 insertions(+), 19 deletions(-) diff --git a/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita b/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita index 4faa87d4c92..92869fbec24 100644 --- a/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita +++ b/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita @@ -23,15 +23,21 @@ Future<void> pushAudioFrame({required AudioFrame frame, int trackId = 0});

    -
    - 详情 - +

    调用该方法推送外部音频数据前，请先进行以下操作：

    1. 调用 创建音频轨道并获得音频轨道 ID。
    2. 调用 加入频道时，将 中的 publishCustomAudioTrackId 设置为你想要发布的音频轨道 ID，并将 publishCustomAudioTrack 设置为 。

    -
    -
    +
    +
    + 调用时机 +

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

    +
    +
    + 调用限制 +

    无。

    +
    +
    参数 @@ -46,8 +52,8 @@
    <ph keyref="return-section-title"/>

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

    -
      -
    • 0：方法调用成功。
      • +
        +
      • 0：方法调用成功。
      • < 0：方法调用失败。详见了解详情和解决建议。
    diff --git a/dita/RTC-NG/API/api_irtcengine_pushaudioframe2.dita b/dita/RTC-NG/API/api_irtcengine_pushaudioframe2.dita index 2765d5e34f1..0b0c01f2f4b 100644 --- a/dita/RTC-NG/API/api_irtcengine_pushaudioframe2.dita +++ b/dita/RTC-NG/API/api_irtcengine_pushaudioframe2.dita @@ -29,15 +29,21 @@

    -
    - 详情 - +

    调用该方法推送外部音频数据前，请先进行以下操作：

    1. 调用 创建音频轨道并获得音频轨道 ID。
    2. 调用 加入频道时，将 中的 publishCustomAudioTrackId 设置为你想要发布的音频轨道 ID，并将 publishCustomAudioTrack 设置为 。

    -
    -
    +
    +
    + 调用时机 +

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

    +
    +
    + 调用限制 +

    无。

    +
    +
    参数 @@ -54,15 +60,11 @@ sampleRate - 外部音频渲染的采样率 (Hz)，可设置为 8000，16000，32000，44100 或 48000。 + 外部音频源的采样率 (Hz)，可设置为 8000，16000，32000，44100 或 48000。 channels - 外部音频渲染的声道数: -
      -
    • 1: 单声道
      • -
    • 2: 双声道
      • -
    + 外部音频源的声道数，可设置为 1（单声道）或 2（双声道）。     bytesPerSample @@ -70,7 +72,7 @@ trackId - 音频轨道 ID。将该参数设置为 方法中返回的自定义音频轨道 ID。 + 音频轨道 ID。将该参数设置为 方法中返回的自定义音频轨道 ID。
    From 12c33e32b11861dc4b38f84efc2c7017014bd400 Mon Sep 17 00:00:00 2001 From: jinyu Date: Wed, 3 Jul 2024 18:15:59 +0800 Subject: [PATCH 10/25] 1 --- dita/RTC-NG/API/api_imediaengine_pullaudioframe.dita | 12 +++++------- .../api_imediaengine_setexternalaudiosource2.dita | 2 +- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/dita/RTC-NG/API/api_imediaengine_pullaudioframe.dita b/dita/RTC-NG/API/api_imediaengine_pullaudioframe.dita index 12e76292986..fcd436dc495 100644 --- a/dita/RTC-NG/API/api_imediaengine_pullaudioframe.dita +++ b/dita/RTC-NG/API/api_imediaengine_pullaudioframe.dita @@ -26,25 +26,23 @@

    调用该方法后，App 会采取主动拉取的方式获取远端已解码和混音后的音频数据，用于音频播放。

    + 调用该方法前，你需要调用 (enabled: ) 开启并设置外部渲染。
    调用时机 -
      -
    • 使用该方法前，你需要调用 (enabled: ) 开启并设置外部渲染。
      • -
    • 该方法需要在加入频道后调用。
      • -
    +

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

    调用限制

    该方法和 回调均可用于获取远端混音后的音频播放数据。在调用 开启外部音频渲染后，App 将无法从 回调中获得数据。因此，请根据实际的业务需求在该方法和 回调之间进行选择。二者的处理机制不同，具体区别如下：

    • 调用该方法后，App 会主动拉取音频数据。通过设置音频数据，SDK 可以调整缓存，帮助 App 处理延时，从而有效避免音频播放抖动。
      • -
    • 注册 后，SDK 通过该回调将音频数据传输给 App。App 在处理音频帧时的延迟可能会导致音频播放抖动。
      • +
    • 注册 后，SDK 通过该回调将音频数据传输给 App。App 在处理音频帧的延迟时，可能会导致音频播放抖动。

    该方法仅用于拉取远端混音后的音频播放数据，如需获取采集的原始音频数据、混音前每条拉流单独的原始音频播放数据等，可以通过调用 注册相应的回调。

    - 参数 + <ph props="android apple cpp unreal bp flutter unity cs">参数</ph> frame @@ -75,4 +73,4 @@
  • 方法调用失败，返回错误码。
    • - \ No newline at end of file + diff --git a/dita/RTC-NG/API/api_imediaengine_setexternalaudiosource2.dita b/dita/RTC-NG/API/api_imediaengine_setexternalaudiosource2.dita index c51f1373389..6e803ccaa8d 100644 --- a/dita/RTC-NG/API/api_imediaengine_setexternalaudiosource2.dita +++ b/dita/RTC-NG/API/api_imediaengine_setexternalaudiosource2.dita @@ -99,7 +99,7 @@
    • ：（默认）发布到远端。
    • ：不发布到远端。
      • -

    +
    From 4c95a03f152ceaebb8d3c1431abd8ebc55782883 Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Thu, 4 Jul 2024 16:12:25 +0800 Subject: [PATCH 11/25] ld batch3 --- ...ine_registervideoencodedframeobserver.dita | 2 +- ...ediaengine_registervideoframeobserver.dita | 31 +++++++++------- .../API/api_irtcengine_enableencryption.dita | 23 ++++++++---- ...rtcengine_enableinstantmediarendering.dita | 14 +++++--- dita/RTC-NG/API/api_irtcengine_getcallid.dita | 17 ++++++--- .../api_irtcengine_setlocalrendermode2.dita | 35 ++++++++++++------- ...ngine_setremotedefaultvideostreamtype.dita | 21 ++++++----- .../API/api_irtcengine_setuplocalvideo.dita | 28 ++++++++++----- .../api_irtcengineex_enableencryptionex.dita | 13 +++---- .../API/api_irtcengineex_getcallidex.dita | 12 ++++--- dita/RTC-NG/API/enum_rendermodetype.dita | 4 +-- 11 files changed, 129 insertions(+), 71 deletions(-) diff --git a/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita b/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita index eabcb6fd32f..8f4452dbdef 100644 --- a/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita +++ b/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita @@ -46,7 +46,7 @@

      -
    • 请在加入频道前调用该方法。
      • +
    • 该方法需要在加入频道前调用。
    参数 diff --git a/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita b/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita index 165007c38ad..d766b25831d 100644 --- a/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita +++ b/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita @@ -23,24 +23,29 @@ void registerVideoFrameObserver(VideoFrameObserver observer);

    -
    - 详情 +

    如果你想要观测原始视频帧 (如 YUV 或 RGBA 格式)，声网推荐你通过该方法注册一个 类。

    调用该方法注册视频观测器时，你可以根据需要注册 类中的回调。在成功注册视频观测器后，SDK 会在捕捉到每个视频帧时，触发你所注册的上述回调。

    - -

      -
    • 该方法需要在加入频道前调用。
      • -
    • 在处理回调时，你需要考虑视频帧中 width 和 height 参数的变化，因为观测得到的视频帧可能会随以下情况变化： - -
        +
    +
    + 适用场景 +

    注册原始视频观测器后，你可以将获取到的原始视频数据应用于各种视频前处理场景，例如自行实现虚拟背景、美颜等场景。

    +

    声网在 GitHub 上提供了开源的示例项目 供你参考。

    +
    +
    + 调用时机 +

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

    +
    +
    + 调用限制 +

    在处理回调时，你需要考虑视频帧中 width 和 height 参数的变化，因为观测得到的视频帧可能会随以下情况变化： +

    • 当网络状况差时，分辨率会阶梯式下降。
    • 当用户自行调整分辨率时，回调中报告的分辨率也会变化。
      • -
    - - 注册原始视频观测器后，你可以将获取到的原始视频数据应用于各种视频前处理场景，例如自行实现虚拟背景、美颜等场景，声网在 GitHub 上提供了开源的示例项目 供你参考。 -
    -
    +

    +
    +
    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_enableencryption.dita b/dita/RTC-NG/API/api_irtcengine_enableencryption.dita index d402b51f5e0..6d084d2cf2f 100644 --- a/dita/RTC-NG/API/api_irtcengine_enableencryption.dita +++ b/dita/RTC-NG/API/api_irtcengine_enableencryption.dita @@ -26,12 +26,23 @@ {required bool enabled, required EncryptionConfig config});

    -
    - 详情 -

    在安全要求较高的场景下，建议你在加入频道前，调用本方法开启内置加密。

    -

    同一频道内所有用户必须使用相同的加密模式和密钥。用户离开频道后，SDK 会自动关闭加密。如需重新开启加密，你需要在用户再次加入频道前调用该方法。

    - 如果开启了内置加密，则不能使用旁路推流功能。
    -
    +
    +

    用户离开频道后，SDK 会自动关闭加密。如需重新开启加密，你需要在用户再次加入频道前调用该方法。

    +
    +
    + 适用场景 +

    对安全要求较高的场景。

    +
    +
    + 调用时机 +

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

    +
    +
    + 调用限制 +
    • 同一频道内的所有用户在调用该方法时，必须设置相同的加密模式和密钥。
      • +
    • 如果开启了内置加密，则不能使用旁路推流功能。
    +
    +
    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_enableinstantmediarendering.dita b/dita/RTC-NG/API/api_irtcengine_enableinstantmediarendering.dita index c4f1e2f7be0..324c6664bea 100644 --- a/dita/RTC-NG/API/api_irtcengine_enableinstantmediarendering.dita +++ b/dita/RTC-NG/API/api_irtcengine_enableinstantmediarendering.dita @@ -24,8 +24,7 @@ abstract enableInstantMediaRendering(): number; Future<void> enableInstantMediaRendering();

    -
    - 详情 +
    自从
    @@ -33,12 +32,19 @@

    成功调用该方法后，SDK 会开启加速出图和出声模式，可加快用户加入频道后的首帧出图与出声速度。

    - 一旦开启快速渲染功能，只能通过调用 方法销毁 对象来取消。
    -
    +
    适用场景

    声网推荐在直播场景下，对观众开启该模式。

    +
    + 调用时机 +

    声网建议你在加入频道前调用该方法。

    +
    +
    + 调用限制 +

    一旦成功调用该方法，只能通过调用 方法销毁 对象来取消。

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

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

    diff --git a/dita/RTC-NG/API/api_irtcengine_getcallid.dita b/dita/RTC-NG/API/api_irtcengine_getcallid.dita index d84706b68be..ea92738818c 100644 --- a/dita/RTC-NG/API/api_irtcengine_getcallid.dita +++ b/dita/RTC-NG/API/api_irtcengine_getcallid.dita @@ -25,12 +25,19 @@ Future<String> getCallId();

    -
    - 详情 +

    客户端在每次加入频道后会生成一个对应的 callId，标识该客户端的此次通话。你可以调用该方法获取 callId 参数，然后在调用 、 等方法时填入。

    - 该方法需要在加入频道后调用。
    -
    - 参数 +
    +
    + 调用时机 +

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

    +
    +
    + 调用限制 +

    无。

    +
    +
    + 参数 callId diff --git a/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita b/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita index ab6398eae89..34147f0d7f2 100644 --- a/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita +++ b/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita @@ -35,17 +35,21 @@ VideoMirrorModeType.videoMirrorModeAuto});

    -
    - 详情 +

    初始化本地用户视图后，你可以调用该方法更新本地用户视图的渲染和镜像模式。该方法只影响本地用户看到的视频画面，不影响本地发布视频。

    - -
      -
    • 请在调用 方法初始化本地视图后，调用该方法。
      • -
    • 你可以在通话中多次调用该方法，多次更新本地用户视图的显示模式。
      • -
    • 该方法仅对第一个摄像头 () 生效。在自定义视频采集或使用其他类型视频源的场景下，你需要使用 方法替代该方法。
      • -
    -
    - 参数 +
    +
    + 调用时机 +
    • 请在调用 方法初始化本地视图后，调用该方法。
      • +
    • 你可以在通话中多次调用该方法，多次更新本地用户视图的显示模式。
    +
    +
    + 调用限制 +

    该方法仅对第一个摄像头 () 生效。在自定义视频采集或使用其他类型视频源的场景下，你需要使用 方法替代该方法。

    +

    无。

    +
    +
    + 参数 renderMode @@ -57,12 +61,19 @@
    • (1)：优先保证视窗被填满。视频尺寸等比缩放，直至整个视窗被视频填满。如果视频长宽与显示窗口不同，多出的视频将被截掉。
    • (2)：优先保证视频内容全部显示。视频尺寸等比缩放，直至视频窗口的一边与视窗边框对齐。如果视频长宽与显示窗口不同，视窗上未被填满的区域将被涂黑。
      • -
    • (3): 该模式已废弃，不推荐使用。
      • +
    • (3): 匹配模式。 +
      + +
      弃用：
      +
      该枚举已废弃，不推荐使用。
      +       +
      +

    - mirrorMode + mirrorMode mirror

    本地视图的镜像模式，详见 。 diff --git a/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype.dita b/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype.dita index 91ed6bad90e..b3e15f8f1ad 100644 --- a/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype.dita +++ b/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype.dita @@ -25,8 +25,7 @@ Future<void> setRemoteDefaultVideoStreamType(VideoStreamType streamType);

    -
    - 详情 +
    弃用：
    @@ -35,13 +34,17 @@

    - -

      -
    • 该方法只能在加入频道前调用。SDK 不支持你在加入频道后修改默认订阅的视频流类型。
      • -
    • 如果你既调用了该方法，也调用了 ，则 SDK 以 中的设置为准。
      • -
    -
    - 参数 +
    +
    + 调用时机 +

    该方法只能在加入频道前调用。SDK 不支持你在加入频道后修改默认订阅的视频流类型。

    +
    +
    + 调用限制 +

    如果你既调用了该方法，也调用了 ，则 SDK 以 中的设置为准。

    +
    +
    + 参数 streamType diff --git a/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita b/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita index 131d4c59a8c..3ab5c1e05f9 100644 --- a/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita +++ b/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita @@ -17,7 +17,7 @@ public abstract setupLocalVideo(canvas: VideoCanvas): number; - (int)setupLocalVideo:(AgoraRtcVideoCanvas * _Nullable)local; virtual int setupLocalVideo(const VideoCanvas& canvas) = 0; - UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") + UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") int SetupLocalVideo(const FVideoCanvas& canvas); abstract setupLocalVideo(canvas: VideoCanvas): number; public abstract int SetupLocalVideo(VideoCanvas canvas); @@ -25,24 +25,34 @@ Future<void> setupLocalVideo(VideoCanvas canvas);

    -
    - 详情 +

    该方法初始化本地视图并设置本地用户视频显示属性，只影响本地用户看到的视频画面，不影响本地发布视频。调用该方法绑定本地视频流的显示视窗(view)，并设置本地用户视图的渲染模式和镜像模式。

    -

    在 App 开发中，通常在初始化后调用该方法进行本地视频设置，然后再加入频道。退出频道后，绑定仍然有效，如果需要解除绑定，可以调用该方法将参数 view 设为 。

    -

    在实时互动场景下，如果你需要在本地视频预览的画面中同时看到多个预览画面、且不同画面分别处于视频链路上不同观测点，可以重复调用该方法设置不同的 view，并针对每个 view 设置不同的观测位置。例如：将视频源设置为摄像头，然后对应两个 view 分别设置 position 为 和 ，即可在本地视频预览中同时看到没有经过视频前处理的原始画面和已经过视频前处理（美颜、虚拟背景、水印本地预览）的画面。

    +

    退出频道后，绑定仍然有效，如果需要解除绑定，可以调用该方法将参数 view 设为 。

    • 如果你想要在原生窗口上渲染图像，请调用此方法；如果你仅需在 Unity 项目内渲染图像，可直接通过 类来实现。
      • -
    • 该方法在加入频道前后都能调用。
    • 如果你希望在通话中更新本地用户视图的渲染或镜像模式，请使用 方法。
    • 如果想要停止渲染视图，需要将 view 设为 后再次调用该方法，以停止渲染并清理渲染缓存。
    -
    - 参数 +
    + 适用场景 +

    在 App 开发中，通常在初始化后调用该方法进行本地视频设置，然后再加入频道。

    +

    如果你需要在本地视频预览的画面中同时看到多个预览画面、且不同画面分别处于视频链路上不同观测点，可以重复调用该方法设置不同的 view，并针对每个 view 设置不同的观测位置。例如：将视频源设置为摄像头，然后对应两个 view 分别设置 position 为 和 ，即可在本地视频预览中同时看到没有经过视频前处理的原始画面和已经过视频前处理（美颜、虚拟背景、水印本地预览）的画面。

    +
    +
    + 调用时机 +

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

    +
    +
    + 调用限制 +

    无。

    +
    +
    + 参数 - canvas + canvas local 本地视频显示属性。详见 。 diff --git a/dita/RTC-NG/API/api_irtcengineex_enableencryptionex.dita b/dita/RTC-NG/API/api_irtcengineex_enableencryptionex.dita index 2128f7e4a26..34d3fbb33ac 100644 --- a/dita/RTC-NG/API/api_irtcengineex_enableencryptionex.dita +++ b/dita/RTC-NG/API/api_irtcengineex_enableencryptionex.dita @@ -35,19 +35,20 @@ required bool enabled, required EncryptionConfig config});

    -
    - 详情 +
    自从
    v4.3.1
    -

    -

    +

    用户离开频道后，SDK 会自动关闭加密。如需重新开启加密，你需要在用户再次加入频道前调用该方法。

    -
    - 参数 +
    +
    +
    +
    + 参数 diff --git a/dita/RTC-NG/API/api_irtcengineex_getcallidex.dita b/dita/RTC-NG/API/api_irtcengineex_getcallidex.dita index 2350e31c4cf..fa19a1fb744 100644 --- a/dita/RTC-NG/API/api_irtcengineex_getcallidex.dita +++ b/dita/RTC-NG/API/api_irtcengineex_getcallidex.dita @@ -23,8 +23,7 @@ abstract getCallIdEx(connection: RtcConnection): string; Future<String> getCallIdEx(RtcConnection connection);

    -
    - 详情 +
    自从
    @@ -32,9 +31,14 @@

    -

    -
    +
    +
    +
    + 调用限制 +

    无。

    +
    +
    参数 diff --git a/dita/RTC-NG/API/enum_rendermodetype.dita b/dita/RTC-NG/API/enum_rendermodetype.dita index 6d2d1bb2306..e9ceffe5f26 100644 --- a/dita/RTC-NG/API/enum_rendermodetype.dita +++ b/dita/RTC-NG/API/enum_rendermodetype.dita @@ -21,11 +21,11 @@ - + 3：匹配模式。
    弃用：
    -
    3: 该模式已弃用。
    +
    该枚举已废弃，不推荐使用。
    From 1f398bb64a9ce03b55329eb6f2ed913eb2bde9fd Mon Sep 17 00:00:00 2001 From: Nero-Hu Date: Fri, 5 Jul 2024 16:54:55 +0800 Subject: [PATCH 12/25] batch 3 --- .../api_irtcengine_enablefacedetection.dita | 21 +++++--- ...api_irtcengine_setbeautyeffectoptions.dita | 16 +++--- ...pi_irtcengine_setbeautyeffectoptions2.dita | 18 +++++-- ...i_irtcengine_setvoicebeautifierpreset.dita | 52 ++++++++++++------- .../api_irtcengine_startaudiorecording3.dita | 17 +++--- .../api_irtcengine_stopaudiorecording.dita | 1 + 6 files changed, 82 insertions(+), 43 deletions(-) diff --git a/dita/RTC-NG/API/api_irtcengine_enablefacedetection.dita b/dita/RTC-NG/API/api_irtcengine_enablefacedetection.dita index 7d9c1123833..a1813b594e8 100644 --- a/dita/RTC-NG/API/api_irtcengine_enablefacedetection.dita +++ b/dita/RTC-NG/API/api_irtcengine_enablefacedetection.dita @@ -25,20 +25,27 @@ Future<void> enableFaceDetection(bool enabled);

    -
    - 详情 -

    该方法在加入频道前后都能调用。

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

    该方法需要在相机启动（如通过调用 或 实现）后调用。

    +
    +
    + 调用限制 +

    该方法仅适用于 Android 和 iOS。

    +

    无。

    +
    + -
    +
    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita b/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita index 428a1812524..679e5a6ac49 100644 --- a/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita +++ b/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita @@ -36,18 +36,22 @@ MediaSourceType type = MediaSourceType.primaryCameraSource});

    -
    - 详情 +

    开启本地美颜功能，并设置美颜效果选项。

    - +
    +
    + 调用时机 +

    请在 或 之后调用该方法。

    +
    +
    + 调用限制
      -
    • 请在 或 之后调用该方法。
    • 该方法仅适用于 Android 5.0 及以上版本。
    • 该方法依赖于视频增强动态库 ，如果删除该动态库会导致无法正常开启该功能。
    • 该功能对设备性能要求较高，调用该方法时 SDK 会自动对当前设备能力进行检查。
    -
    -
    +
    +
    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions2.dita b/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions2.dita index 91d6123fbda..f053efcef51 100644 --- a/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions2.dita +++ b/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions2.dita @@ -25,13 +25,23 @@

    -
    - 详情 +

    开启本地美颜功能，并设置美颜效果选项和效果应用的媒体源。

    该方法和 均可用于设置美颜效果选项，区别在于该方法支持在设置美颜效果选项时指定应用美颜的媒体源。

    -
    -
    +
    + 调用时机 +

    请在 或 之后调用该方法。

    +
    +
    + 调用限制 +
      +
    • 该方法仅适用于 Android 5.0 及以上版本。
      • +
    • 该方法依赖于视频增强动态库 ，如果删除该动态库会导致无法正常开启该功能。
      • +
    • 该功能对设备性能要求较高，调用该方法时 SDK 会自动对当前设备能力进行检查。
      • +
    +
    +
    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita b/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita index 2f03a88b041..2de1f129601 100644 --- a/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita +++ b/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita @@ -25,33 +25,45 @@ Future<void> setVoiceBeautifierPreset(VoiceBeautifierPreset preset);

    -
    - 详情 +

    调用该方法可以为本地发流用户设置预设的人声美化效果。设置美声效果后，频道内所有用户都能听到该效果。根据不同的场景，你可以为用户设置不同的美声效果。各美声效果的适用场景可参考设置人声效果。

    为获取更好的人声效果，建议你在调用该方法前进行以下操作：

    • 调用 将音频场景设为高音质场景，即 (3)。
    • 调用 将 profile 设为 (4) 或 (5)。
    -

    - +
    +
    + 适用场景 +

    +

    +
    + 调用时机 +

    加入频道前后都能调用。

    +
    +
    + 调用限制
      -
    • 该方法在加入频道前后都能调用。
      • -
    • 请勿将 的 profile 参数设置为 (1) 或 (6)，否则该方法不生效。
      • -
    • 该方法对人声的处理效果最佳，不建议调用该方法处理含音乐的音频数据。
      • -
    • 调用 ，不建议调用以下方法，否则 设置的效果会被覆盖： -
        -
        • -
        • -
        • -
        • -
        • -
        • -
        • -
      • -
    • 该方法依赖于美声动态库 ，如果删除该动态库会导致无法正常开启该功能。
      • -
    -
    +
  • 请勿将 的 profile 参数设置为 (1) 或 (6)，否则该方法不生效。
    • +
  • 该方法对人声的处理效果最佳，不建议调用该方法处理含音乐的音频数据。
    • +
  • 调用 ，不建议调用以下方法，否则 设置的效果会被覆盖： +
      +
      • +
      • +
      • +
      • +
      • +
      • +
      • +
    • +
  • 该方法依赖于美声动态库 ，如果删除该动态库会导致无法正常开启该功能。
    • + +
    + +
    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita b/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita index 751dcee39a7..7cb6a8b6985 100644 --- a/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita +++ b/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita @@ -25,18 +25,23 @@ Future<void> startAudioRecording(AudioRecordingConfiguration config);

    -
    - 详情 +

    SDK 支持通话过程中在客户端进行录音。调用该方法后，你可以录制频道内用户的音频，并得到一个录音文件。录音文件仅支持下列格式： - -

    • WAV: 音质保真度较高，文件较大。例如，采样率为 32000 Hz，录音时长为 10 分钟的文件大小约为 73 M。
    • AAC: 音质保真度较低，文件较小。例如，采样率为 32000 Hz，录音音质为 ，录音时长为 10 分钟的文件大小约为 2 M。

    用户离开频道后，录音会自动停止。

    - 该方法需要在加入频道后调用。
    -
    +
    +
    + 调用时机 +

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

    +
    +
    + 调用限制 +

    无

    。 +
    +
    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_stopaudiorecording.dita b/dita/RTC-NG/API/api_irtcengine_stopaudiorecording.dita index e2117121a75..709974600b4 100644 --- a/dita/RTC-NG/API/api_irtcengine_stopaudiorecording.dita +++ b/dita/RTC-NG/API/api_irtcengine_stopaudiorecording.dita @@ -25,6 +25,7 @@ Future<void> stopAudioRecording();

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

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

    From ec2d7163520fb8e077e9c5211bf14fa964907aed Mon Sep 17 00:00:00 2001 From: Nero-Hu Date: Fri, 5 Jul 2024 17:04:02 +0800 Subject: [PATCH 13/25] fix publish error --- .../API/api_irtcengine_setvoicebeautifierpreset.dita | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita b/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita index 2de1f129601..99885096ff0 100644 --- a/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita +++ b/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita @@ -28,10 +28,11 @@

    调用该方法可以为本地发流用户设置预设的人声美化效果。设置美声效果后，频道内所有用户都能听到该效果。根据不同的场景，你可以为用户设置不同的美声效果。各美声效果的适用场景可参考设置人声效果。

    为获取更好的人声效果，建议你在调用该方法前进行以下操作： -

      -
    • 调用 将音频场景设为高音质场景，即 (3)。
      • -
    • 调用 将 profile 设为 (4) 或 (5)。
      • -
    +
      +
    • 调用 将音频场景设为高音质场景，即 (3)。
      • +
    • 调用 将 profile 设为 (4) 或 (5)。
      • +
    +

    适用场景 From 7173fadc315211700e67c539a12d5c06235cf166 Mon Sep 17 00:00:00 2001 From: jinyu Date: Wed, 3 Jul 2024 14:26:08 +0800 Subject: [PATCH 14/25] Update rtc_api_overview.dita --- dita/RTC-NG/API/rtc_api_overview.dita | 1 - 1 file changed, 1 deletion(-) diff --git a/dita/RTC-NG/API/rtc_api_overview.dita b/dita/RTC-NG/API/rtc_api_overview.dita index ec7666152cd..334f6783acd 100644 --- a/dita/RTC-NG/API/rtc_api_overview.dita +++ b/dita/RTC-NG/API/rtc_api_overview.dita @@ -4,7 +4,6 @@ API 概览 声网通过全球部署的 SD-RTN™，提供可以灵活搭配的 API 组合，实现质量可靠的实时音视频通信。 -

    本文档为 Unreal C++ API 参考文档，如使用 Unreal Blueprint SDK，请参考声网在 github 上提供的开源示例项目，或联系 获取教学视频。

    初始化相关 From cdcc4c0884c3bc777df0df96e8c43296fe871ea3 Mon Sep 17 00:00:00 2001 From: jinyu Date: Mon, 8 Jul 2024 16:02:28 +0800 Subject: [PATCH 15/25] 1 --- dita/RTC-NG/API/api_imediaengine_pullaudioframe.dita | 6 +++--- dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita | 8 ++++---- dita/RTC-NG/API/api_irtcengine_pushaudioframe2.dita | 8 ++++---- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/dita/RTC-NG/API/api_imediaengine_pullaudioframe.dita b/dita/RTC-NG/API/api_imediaengine_pullaudioframe.dita index fcd436dc495..b908a17172f 100644 --- a/dita/RTC-NG/API/api_imediaengine_pullaudioframe.dita +++ b/dita/RTC-NG/API/api_imediaengine_pullaudioframe.dita @@ -26,24 +26,24 @@

    调用该方法后，App 会采取主动拉取的方式获取远端已解码和混音后的音频数据，用于音频播放。

    - 调用该方法前，你需要调用 (enabled: ) 开启并设置外部渲染。
    调用时机

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

    +

    调用该方法前，你需要调用 (enabled: ) 开启并设置外部渲染。

    调用限制

    该方法和 回调均可用于获取远端混音后的音频播放数据。在调用 开启外部音频渲染后，App 将无法从 回调中获得数据。因此，请根据实际的业务需求在该方法和 回调之间进行选择。二者的处理机制不同，具体区别如下：

    • 调用该方法后，App 会主动拉取音频数据。通过设置音频数据，SDK 可以调整缓存，帮助 App 处理延时，从而有效避免音频播放抖动。
      • -
    • 注册 后，SDK 通过该回调将音频数据传输给 App。App 在处理音频帧的延迟时，可能会导致音频播放抖动。
      • +
    • 注册 回调后，SDK 通过该回调将音频数据传输给 App。App 在处理音频帧的延迟时，可能会导致音频播放抖动。

    该方法仅用于拉取远端混音后的音频播放数据，如需获取采集的原始音频数据、混音前每条拉流单独的原始音频播放数据等，可以通过调用 注册相应的回调。

    <ph props="android apple cpp unreal bp flutter unity cs">参数</ph> - + frame 指向 的指针。 diff --git a/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita b/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita index 92869fbec24..75453cbdc15 100644 --- a/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita +++ b/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita @@ -24,14 +24,14 @@

    +

    调用该方法通过音频轨道推送外部音频帧。

    +
    +
    + 调用时机

    调用该方法推送外部音频数据前，请先进行以下操作：

    1. 调用 创建音频轨道并获得音频轨道 ID。
    2. 调用 加入频道时，将 中的 publishCustomAudioTrackId 设置为你想要发布的音频轨道 ID，并将 publishCustomAudioTrack 设置为 。

    -
    -
    - 调用时机 -

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

    调用限制 diff --git a/dita/RTC-NG/API/api_irtcengine_pushaudioframe2.dita b/dita/RTC-NG/API/api_irtcengine_pushaudioframe2.dita index 0b0c01f2f4b..7d0e0715619 100644 --- a/dita/RTC-NG/API/api_irtcengine_pushaudioframe2.dita +++ b/dita/RTC-NG/API/api_irtcengine_pushaudioframe2.dita @@ -30,14 +30,14 @@

    +

    调用该方法通过音频轨道推送外部音频帧。

    +
    +
    + 调用时机

    调用该方法推送外部音频数据前，请先进行以下操作：

    1. 调用 创建音频轨道并获得音频轨道 ID。
    2. 调用 加入频道时，将 中的 publishCustomAudioTrackId 设置为你想要发布的音频轨道 ID，并将 publishCustomAudioTrack 设置为 。

    -
    -
    - 调用时机 -

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

    调用限制 From b66a4c92aa54ec99872bc71fc825737c9386e89f Mon Sep 17 00:00:00 2001 From: Suri539 Date: Mon, 8 Jul 2024 17:58:27 +0800 Subject: [PATCH 16/25] resolve review comments --- dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita | 7 ++----- dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita | 2 +- 2 files changed, 3 insertions(+), 6 deletions(-) diff --git a/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita b/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita index 0c50cd4a9f1..6d7abf09aeb 100644 --- a/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita +++ b/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita @@ -53,11 +53,8 @@
    参数 - - - - - + + diff --git a/dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita b/dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita index 3bad5f1f4ff..57b48bc12c7 100644 --- a/dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita +++ b/dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita @@ -61,7 +61,7 @@
    参数 From 9b1adc50b5d7398acf0b2aca4160ea5f2a58aaf4 Mon Sep 17 00:00:00 2001 From: Nero-Hu Date: Tue, 9 Jul 2024 15:13:48 +0800 Subject: [PATCH 17/25] peer review fixes --- .../api_irtcengine_enablefacedetection.dita | 6 ++--- ...api_irtcengine_setbeautyeffectoptions.dita | 2 +- ...pi_irtcengine_setbeautyeffectoptions2.dita | 9 +------ .../api_irtcengine_setlocalaccesspoint.dita | 2 +- ...i_irtcengine_setvoicebeautifierpreset.dita | 25 +++++++------------ .../api_irtcengine_startaudiorecording3.dita | 2 +- .../API/api_irtcengine_startechotest3.dita | 2 +- ...api_irtcengine_startlastmileprobetest.dita | 8 ++---- .../API/api_irtcengine_stopechotest.dita | 3 +++ .../config/keys-rtc-ng-links-android.ditamap | 1 - .../config/keys-rtc-ng-links-cpp.ditamap | 1 - .../config/keys-rtc-ng-links-electron.ditamap | 8 +++++- .../config/keys-rtc-ng-links-flutter.ditamap | 8 +++++- .../config/keys-rtc-ng-links-harmony.ditamap | 1 - .../config/keys-rtc-ng-links-ios.ditamap | 1 - .../config/keys-rtc-ng-links-rn.ditamap | 8 +++++- .../config/keys-rtc-ng-links-unity.ditamap | 7 ++++++ ...keys-rtc-ng-links-unreal-blueprint.ditamap | 8 +++++- .../keys-rtc-ng-links-unreal-cpp.ditamap | 8 +++++- 19 files changed, 64 insertions(+), 46 deletions(-) diff --git a/dita/RTC-NG/API/api_irtcengine_enablefacedetection.dita b/dita/RTC-NG/API/api_irtcengine_enablefacedetection.dita index a1813b594e8..d166fc2052b 100644 --- a/dita/RTC-NG/API/api_irtcengine_enablefacedetection.dita +++ b/dita/RTC-NG/API/api_irtcengine_enablefacedetection.dita @@ -26,6 +26,7 @@

    +

    该方法仅适用于 Android 和 iOS。

    调用时机 @@ -33,12 +34,11 @@
    调用限制 -

    该方法仅适用于 Android 和 iOS。

    -

    无。

    +

    无。