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..6d7abf09aeb 100644 --- a/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita +++ b/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita @@ -34,69 +34,40 @@ 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。

+
+
+
+
+
+ +
参数 - - - - - - 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..57b48bc12c7 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 334f6783acd..2a1fc6a3ed7 100644 --- a/dita/RTC-NG/API/rtc_api_overview.dita +++ b/dita/RTC-NG/API/rtc_api_overview.dita @@ -411,7 +411,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 体积 + 插件列表