From c577ea3519a71bb71fe7310e666910bd86dc34da Mon Sep 17 00:00:00 2001 From: Nero-Hu Date: Wed, 3 Jul 2024 16:03:26 +0800 Subject: [PATCH 1/4] 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 1f398bb64a9ce03b55329eb6f2ed913eb2bde9fd Mon Sep 17 00:00:00 2001 From: Nero-Hu Date: Fri, 5 Jul 2024 16:54:55 +0800 Subject: [PATCH 2/4] 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 3/4] 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 9b1adc50b5d7398acf0b2aca4160ea5f2a58aaf4 Mon Sep 17 00:00:00 2001 From: Nero-Hu Date: Tue, 9 Jul 2024 15:13:48 +0800 Subject: [PATCH 4/4] 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。

    -

    无。

    +

    无。