diff --git a/dita/RTC-NG/API/api_imediaengine_pullaudioframe.dita b/dita/RTC-NG/API/api_imediaengine_pullaudioframe.dita index 6f6b6ea4c99..b908a17172f 100644 --- a/dita/RTC-NG/API/api_imediaengine_pullaudioframe.dita +++ b/dita/RTC-NG/API/api_imediaengine_pullaudioframe.dita @@ -24,23 +24,26 @@ Future<void> pullAudioFrame(AudioFrame frame);

-
- 详情 -

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

+

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

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

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

+

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

+
+
+ 调用限制 +

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

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

    +

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

    +
    +
    + <ph props="android apple cpp unreal bp flutter unity cs">参数</ph> + frame 指向 的指针。 @@ -69,5 +72,5 @@
  • 方法调用成功，返回一个 对象。
  • 方法调用失败，返回错误码。
    • - + diff --git a/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita b/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita index 4faa87d4c92..75453cbdc15 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_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 diff --git a/dita/RTC-NG/API/api_imediaengine_setexternalaudiosource2.dita b/dita/RTC-NG/API/api_imediaengine_setexternalaudiosource2.dita index 17400b8247c..6e803ccaa8d 100644 --- a/dita/RTC-NG/API/api_imediaengine_setexternalaudiosource2.dita +++ b/dita/RTC-NG/API/api_imediaengine_setexternalaudiosource2.dita @@ -48,57 +48,58 @@ bool publish = true});

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

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

    +
    +
    + 调用限制 +

    无。

    +
    +
    参数 - + enabled - -

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

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

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

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

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

    +     publish - -

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

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

      +
    diff --git a/dita/RTC-NG/API/api_imediaengine_setexternalvideosource.dita b/dita/RTC-NG/API/api_imediaengine_setexternalvideosource.dita index 52bba6b133e..3dc14e20080 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 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)。 + + +
    diff --git a/dita/RTC-NG/API/api_irtcengine_pushaudioframe2.dita b/dita/RTC-NG/API/api_irtcengine_pushaudioframe2.dita index 2765d5e34f1..7d0e0715619 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。
    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: 双声道
      • -

    -     + + +