From b79a92ed936763dc78167425c5e109b689db1600 Mon Sep 17 00:00:00 2001 From: jinyu Date: Wed, 3 Jul 2024 14:26:08 +0800 Subject: [PATCH 01/67] 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 e06396db4d4..a445251b0dc 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 43380d55249f1b033df623b3df29b4ce58bd087c Mon Sep 17 00:00:00 2001 From: Suri539 Date: Wed, 3 Jul 2024 18:07:57 +0800 Subject: [PATCH 02/67] relations --- dita/RTC-NG/RTC_NG_API_Unity.ditamap | 1 + .../config/relations-rtc-ng-api.ditamap | 56 +++++++++++++------ 2 files changed, 39 insertions(+), 18 deletions(-) diff --git a/dita/RTC-NG/RTC_NG_API_Unity.ditamap b/dita/RTC-NG/RTC_NG_API_Unity.ditamap index 4133881d9f1..4261d8cddb9 100644 --- a/dita/RTC-NG/RTC_NG_API_Unity.ditamap +++ b/dita/RTC-NG/RTC_NG_API_Unity.ditamap @@ -621,6 +621,7 @@ + diff --git a/dita/RTC-NG/config/relations-rtc-ng-api.ditamap b/dita/RTC-NG/config/relations-rtc-ng-api.ditamap index ecb20423237..f280c291eb2 100644 --- a/dita/RTC-NG/config/relations-rtc-ng-api.ditamap +++ b/dita/RTC-NG/config/relations-rtc-ng-api.ditamap @@ -2277,7 +2277,7 @@ - + @@ -2321,16 +2321,16 @@ - + - + - - + + - + @@ -2372,9 +2372,9 @@ - + - + @@ -2418,7 +2418,7 @@ - + @@ -2485,7 +2485,7 @@ - + @@ -2510,13 +2510,13 @@ - + - + @@ -2530,7 +2530,7 @@ - + @@ -2721,6 +2721,26 @@ + + + + + + + + + + + + + + + + + + + + @@ -3033,14 +3053,14 @@ - + - + - + - + @@ -3060,7 +3080,7 @@ - + From 923882435656d8441c060a71411b0ed81834eda3 Mon Sep 17 00:00:00 2001 From: Suri539 Date: Wed, 3 Jul 2024 18:11:33 +0800 Subject: [PATCH 03/67] =?UTF-8?q?=E5=A4=9A=E5=AE=9E=E4=BE=8B?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- dita/RTC-NG/API/api_irtcengine_createmediaplayer.dita | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 前，你需要先调用该方法创建一个媒体播放器实例。如果你需要创建多个实例，可以多次调用该方法。

调用时机 From 1c733ae9b9d3e28fdb19d2f76a2bb53be059dee3 Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Wed, 3 Jul 2024 18:36:11 +0800 Subject: [PATCH 04/67] =?UTF-8?q?=E7=A9=BA=E9=97=B4=E9=9F=B3=E6=95=88?= =?UTF-8?q?=E6=94=B9=E5=90=8D?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...spatialaudioengine_muteallremoteaudiostreams.dita | 2 +- ...ibasespatialaudioengine_mutelocalaudiostream.dita | 2 +- ...basespatialaudioengine_muteremoteaudiostream.dita | 2 +- .../API/api_ibasespatialaudioengine_release.dita | 2 +- .../api_ibasespatialaudioengine_setdistanceunit.dita | 2 +- ...ibasespatialaudioengine_setmaxaudiorecvcount.dita | 2 +- ...i_ibasespatialaudioengine_updateselfposition.dita | 6 +++--- .../API/api_ilocalspatialaudioengine_release.dita | 4 ++-- ...localspatialaudioengine_updateremoteposition.dita | 2 +- .../API/api_imediaplayer_setspatialaudioparams.dita | 8 ++++---- .../API/api_irtcengine_enablespatialaudio.dita | 12 ++++++------ .../API/api_irtcengine_setheadphoneeqparameters.dita | 2 +- .../API/api_irtcengine_setheadphoneeqpreset.dita | 2 +- ...i_irtcengine_setremoteuserspatialaudioparams.dita | 6 +++--- dita/RTC-NG/API/class_ilocalspatialaudioengine.dita | 2 +- dita/RTC-NG/API/class_spatialaudioparams.dita | 2 +- .../API/enum_saeconnectionchangedreasontype.dita | 4 ++-- dita/RTC-NG/API/enum_saeconnectionstatetype.dita | 4 ++-- dita/RTC-NG/API/enum_saedeployregion.dita | 2 +- dita/RTC-NG/API/toc_spatial_audio.dita | 2 +- ...i_icloudspatialaudioengine_enablespatializer.dita | 8 ++++---- .../api_icloudspatialaudioengine_enterroom.dita | 2 +- .../api_icloudspatialaudioengine_exitroom.dita | 2 +- .../api_icloudspatialaudioengine_release.dita | 4 ++-- .../api_icloudspatialaudioengine_renewtoken.dita | 2 +- ...ialaudioeventhandler_onconnectionstatechange.dita | 12 ++++++------ .../archive/class_cloudspatialaudioconfig.dita | 4 ++-- .../archive/class_icloudspatialaudioengine.dita | 2 +- .../class_icloudspatialaudioeventhandler.dita | 2 +- dita/RTC-NG/config/keys-rtc-ng-api-blueprint.ditamap | 10 +++++----- dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap | 10 +++++----- dita/RTC-NG/config/keys-rtc-ng-api-electron.ditamap | 6 +++--- dita/RTC-NG/config/keys-rtc-ng-api-flutter.ditamap | 6 +++--- dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap | 6 +++--- dita/RTC-NG/config/keys-rtc-ng-api-ios.ditamap | 10 +++++----- dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap | 10 +++++----- dita/RTC-NG/config/keys-rtc-ng-api-macos.ditamap | 10 +++++----- dita/RTC-NG/config/keys-rtc-ng-api-rn.ditamap | 6 +++--- dita/RTC-NG/config/keys-rtc-ng-api-unity.ditamap | 10 +++++----- dita/RTC-NG/config/keys-rtc-ng-api-unreal.ditamap | 10 +++++----- 40 files changed, 101 insertions(+), 101 deletions(-) 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_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_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_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/class_ilocalspatialaudioengine.dita b/dita/RTC-NG/API/class_ilocalspatialaudioengine.dita index c7249d68ed9..f52b84734ce 100644 --- a/dita/RTC-NG/API/class_ilocalspatialaudioengine.dita +++ b/dita/RTC-NG/API/class_ilocalspatialaudioengine.dita @@ -2,7 +2,7 @@ <ph keyref="ILocalSpatialAudioEngine" /> - 该类通过 SDK 计算用户坐标，实现空间音效。 + 该类通过 SDK 计算用户坐标，实现空间音频。

该类继承自 。调用该类下其他 API 前，你需要调用 方法初始化该类。

diff --git a/dita/RTC-NG/API/class_spatialaudioparams.dita b/dita/RTC-NG/API/class_spatialaudioparams.dita index 1e9c34e85ab..0ecf84a0de3 100644 --- a/dita/RTC-NG/API/class_spatialaudioparams.dita +++ b/dita/RTC-NG/API/class_spatialaudioparams.dita @@ -2,7 +2,7 @@ <ph keyref="SpatialAudioParams"/> - 空间音效参数。 + 空间音频参数。

diff --git a/dita/RTC-NG/API/enum_saeconnectionchangedreasontype.dita b/dita/RTC-NG/API/enum_saeconnectionchangedreasontype.dita index e9698895456..6b9dc11d17a 100644 --- a/dita/RTC-NG/API/enum_saeconnectionchangedreasontype.dita +++ b/dita/RTC-NG/API/enum_saeconnectionchangedreasontype.dita @@ -2,7 +2,7 @@ <ph keyref="SAE_CONNECTION_CHANGED_REASON_TYPE"/> - SDK 与声网空间音效服务器连接状态发生改变的原因。 + SDK 与声网空间音频服务器连接状态发生改变的原因。

枚举值 @@ -29,7 +29,7 @@ - 5: SDK 超过 15 秒未收到声网空间音效服务器的消息。 + 5: SDK 超过 15 秒未收到声网空间音频服务器的消息。
diff --git a/dita/RTC-NG/API/enum_saeconnectionstatetype.dita b/dita/RTC-NG/API/enum_saeconnectionstatetype.dita index 7eaa24f7e21..301ff190026 100644 --- a/dita/RTC-NG/API/enum_saeconnectionstatetype.dita +++ b/dita/RTC-NG/API/enum_saeconnectionstatetype.dita @@ -2,7 +2,7 @@ <ph keyref="SAE_CONNECTION_STATE_TYPE"/> - SDK 与声网空间音效服务器的连接状态。 + SDK 与声网空间音频服务器的连接状态。
枚举值 @@ -13,7 +13,7 @@ - 1: 已连接。该状态下， 等空间音效设置才会生效。 + 1: 已连接。该状态下， 等空间音频设置才会生效。 diff --git a/dita/RTC-NG/API/enum_saedeployregion.dita b/dita/RTC-NG/API/enum_saedeployregion.dita index 87ea5801f7c..91c4ad518d2 100644 --- a/dita/RTC-NG/API/enum_saedeployregion.dita +++ b/dita/RTC-NG/API/enum_saedeployregion.dita @@ -2,7 +2,7 @@ <ph keyref="SAE_DEPLOY_REGION"/> - 声网空间音效服务器的访问区域。 + 声网空间音频服务器的访问区域。
枚举值 diff --git a/dita/RTC-NG/API/toc_spatial_audio.dita b/dita/RTC-NG/API/toc_spatial_audio.dita index aaa6b2a3c5a..9f6fc5ee173 100644 --- a/dita/RTC-NG/API/toc_spatial_audio.dita +++ b/dita/RTC-NG/API/toc_spatial_audio.dita @@ -1,7 +1,7 @@ - 空间音效 + 空间音频 diff --git a/dita/RTC-NG/archive/api_icloudspatialaudioengine_enablespatializer.dita b/dita/RTC-NG/archive/api_icloudspatialaudioengine_enablespatializer.dita index 7d7af90cc0e..a964f64091c 100644 --- a/dita/RTC-NG/archive/api_icloudspatialaudioengine_enablespatializer.dita +++ b/dita/RTC-NG/archive/api_icloudspatialaudioengine_enablespatializer.dita @@ -2,7 +2,7 @@ <ph keyref="enableSpatializer" /> - 开启或关闭声网空间音效服务器对空间音效参数的计算。 + 开启或关闭声网空间音频服务器对空间音频参数的计算。 @@ -23,7 +23,7 @@
详情 -

开启后，用户可以听到远端用户的空间音效及其空间位置的变化。 +

开启后，用户可以听到远端用户的空间音频及其空间位置的变化。 该方法在 前后均可调用，区别如下： @@ -39,7 +39,7 @@ enable - 是否在音频接收范围内开启空间音效参数的计算： + 是否在音频接收范围内开启空间音频参数的计算：

    @@ -49,7 +49,7 @@ applyToTeam - 是否在队伍内开启空间音效参数的计算： + 是否在队伍内开启空间音频参数的计算：
      diff --git a/dita/RTC-NG/archive/api_icloudspatialaudioengine_enterroom.dita b/dita/RTC-NG/archive/api_icloudspatialaudioengine_enterroom.dita index c6b5ef3f475..ec66f6fd6f0 100644 --- a/dita/RTC-NG/archive/api_icloudspatialaudioengine_enterroom.dita +++ b/dita/RTC-NG/archive/api_icloudspatialaudioengine_enterroom.dita @@ -23,7 +23,7 @@
详情 -

进入房间后，空间音效才会生效。调用该方法后，SDK 会触发 回调。

+

进入房间后，空间音频才会生效。调用该方法后，SDK 会触发 回调。

该方法需要在 后调用。
参数 diff --git a/dita/RTC-NG/archive/api_icloudspatialaudioengine_exitroom.dita b/dita/RTC-NG/archive/api_icloudspatialaudioengine_exitroom.dita index 372e83a5645..5d741bd4cb7 100644 --- a/dita/RTC-NG/archive/api_icloudspatialaudioengine_exitroom.dita +++ b/dita/RTC-NG/archive/api_icloudspatialaudioengine_exitroom.dita @@ -23,7 +23,7 @@
详情 -

用户离开房间后，空间音效会立即消失。

+

用户离开房间后，空间音频会立即消失。

返回值 diff --git a/dita/RTC-NG/archive/api_icloudspatialaudioengine_release.dita b/dita/RTC-NG/archive/api_icloudspatialaudioengine_release.dita index 729bd9218f6..cf4f9ab9e18 100644 --- a/dita/RTC-NG/archive/api_icloudspatialaudioengine_release.dita +++ b/dita/RTC-NG/archive/api_icloudspatialaudioengine_release.dita @@ -29,8 +29,8 @@
详情 -

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

-

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

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

+

调用该方法后，你将无法再使用 或 下的任何 API。如需再次使用空间音频，你需要等 执行结束后再调用 创建一个新的 。 diff --git a/dita/RTC-NG/archive/api_icloudspatialaudioengine_renewtoken.dita b/dita/RTC-NG/archive/api_icloudspatialaudioengine_renewtoken.dita index 0ffad415869..8d0e4f8d759 100644 --- a/dita/RTC-NG/archive/api_icloudspatialaudioengine_renewtoken.dita +++ b/dita/RTC-NG/archive/api_icloudspatialaudioengine_renewtoken.dita @@ -24,7 +24,7 @@

详情 -

RTM Token 的有效时长为 24 小时。当 SDK 触发 回调时，app 应重新获取 RTM Token，然后调用该方法传入新的 RTM Token，否则 SDK 无法和声网空间音效服务器建立连接。

+

RTM Token 的有效时长为 24 小时。当 SDK 触发 回调时，app 应重新获取 RTM Token，然后调用该方法传入新的 RTM Token，否则 SDK 无法和声网空间音频服务器建立连接。

参数 diff --git a/dita/RTC-NG/archive/callback_icloudspatialaudioeventhandler_onconnectionstatechange.dita b/dita/RTC-NG/archive/callback_icloudspatialaudioeventhandler_onconnectionstatechange.dita index 645c4f694f4..9b2d2ef9167 100644 --- a/dita/RTC-NG/archive/callback_icloudspatialaudioeventhandler_onconnectionstatechange.dita +++ b/dita/RTC-NG/archive/callback_icloudspatialaudioeventhandler_onconnectionstatechange.dita @@ -2,7 +2,7 @@ <ph keyref="onConnectionStateChange" /> - SDK 与声网空间音效服务器连接状态已改变回调。 + SDK 与声网空间音频服务器连接状态已改变回调。 @@ -21,7 +21,7 @@

-
该回调在 SDK 与声网空间音效服务器连接状态发生改变时触发，并告知用户当前的连接状态和引起连接状态改变的原因。
+
该回调在 SDK 与声网空间音频服务器连接状态发生改变时触发，并告知用户当前的连接状态和引起连接状态改变的原因。
参数 @@ -31,10 +31,10 @@ state - SDK 与声网空间音效服务器的连接状态。详见 。 + SDK 与声网空间音频服务器的连接状态。详见 。
  • (0): 建立连接中。
    • -
  • (1): 已连接。该状态下， 等空间音效设置才会生效。
    • +
  • (1): 已连接。该状态下， 等空间音频设置才会生效。
  • (2): 连接断开。
  • (3): 重新建立连接中。
  • (4): 已重新建立连接。
    • @@ -42,14 +42,14 @@ reason - SDK 与声网空间音效服务器连接状态发生改变的原因。详见 。 + SDK 与声网空间音频服务器连接状态发生改变的原因。详见 。
    • (0): 正常。
    • (1): SDK 建立连接中。
    • (2): SDK 创建房间失败。
    • (3): SDK 与 RTM 系统连接中断。
    • (4): 用户被 RTM 系统踢出。
      • -
    • (5): SDK 超过 15 秒未收到声网空间音效服务器的消息。
      • +
    • (5): SDK 超过 15 秒未收到声网空间音频服务器的消息。
diff --git a/dita/RTC-NG/archive/class_cloudspatialaudioconfig.dita b/dita/RTC-NG/archive/class_cloudspatialaudioconfig.dita index baea0b7c8cf..e9a44d21aa7 100644 --- a/dita/RTC-NG/archive/class_cloudspatialaudioconfig.dita +++ b/dita/RTC-NG/archive/class_cloudspatialaudioconfig.dita @@ -91,14 +91,14 @@ deployRegion mDeployRegion - 声网空间音效服务器的访问区域。支持如下区域： + 声网空间音频服务器的访问区域。支持如下区域：
  • : （默认）中国大陆。
  • : 北美区域。
  • : 欧洲区域。
  • : 除中国以外的亚洲区域。
-

指定访问区域后，使用空间音效的 App 会连接指定区域内的声网空间音效服务器。

+

指定访问区域后，使用空间音频的 App 会连接指定区域内的声网空间音频服务器。
diff --git a/dita/RTC-NG/archive/class_icloudspatialaudioengine.dita b/dita/RTC-NG/archive/class_icloudspatialaudioengine.dita index 4ef9e63ba45..2e6adda0d8b 100644 --- a/dita/RTC-NG/archive/class_icloudspatialaudioengine.dita +++ b/dita/RTC-NG/archive/class_icloudspatialaudioengine.dita @@ -2,7 +2,7 @@ <ph keyref="ICloudSpatialAudioEngine" /> - 该类通过声网空间音效服务器计算用户坐标，实现空间音效。 + 该类通过声网空间音频服务器计算用户坐标，实现空间音频。

该类继承自 。调用该类下其他 API 前，你需要调用 方法初始化该类。

diff --git a/dita/RTC-NG/archive/class_icloudspatialaudioeventhandler.dita b/dita/RTC-NG/archive/class_icloudspatialaudioeventhandler.dita index 72b29951de2..37037ede7b6 100644 --- a/dita/RTC-NG/archive/class_icloudspatialaudioeventhandler.dita +++ b/dita/RTC-NG/archive/class_icloudspatialaudioeventhandler.dita @@ -2,5 +2,5 @@ <ph keyref="ICloudSpatialAudioEventHandler" /> - 空间音效事件通知回调类。 + 空间音频事件通知回调类。 \ No newline at end of file diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-blueprint.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-blueprint.ditamap index 6dbe0cb87b2..1eb8b120359 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-blueprint.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-blueprint.ditamap @@ -2022,7 +2022,7 @@ - + @@ -2108,7 +2108,7 @@ - + @@ -2138,7 +2138,7 @@ - + @@ -2161,7 +2161,7 @@ - + @@ -4717,7 +4717,7 @@ - + diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap index cdfce1489af..036a7304359 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap @@ -2094,7 +2094,7 @@ - + @@ -2180,7 +2180,7 @@ - + @@ -2210,7 +2210,7 @@ - + @@ -2233,7 +2233,7 @@ - + @@ -5023,7 +5023,7 @@ - + diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-electron.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-electron.ditamap index cc56dff4d09..439c86e6adc 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-electron.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-electron.ditamap @@ -1910,7 +1910,7 @@ - + @@ -1996,7 +1996,7 @@ - + @@ -2026,7 +2026,7 @@ - + diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-flutter.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-flutter.ditamap index d6631f6243a..efa92c99453 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-flutter.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-flutter.ditamap @@ -1983,7 +1983,7 @@ - + @@ -2069,7 +2069,7 @@ - + @@ -2099,7 +2099,7 @@ - + diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap index 941946da7f6..8795eee2fe2 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap @@ -1904,7 +1904,7 @@ - + @@ -1976,7 +1976,7 @@ - + @@ -2020,7 +2020,7 @@ - + diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-ios.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-ios.ditamap index 2239d6cbced..82f462edf41 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-ios.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-ios.ditamap @@ -1924,7 +1924,7 @@ - + @@ -2010,7 +2010,7 @@ - + @@ -2054,7 +2054,7 @@ - + @@ -2077,7 +2077,7 @@ - + @@ -4476,7 +4476,7 @@ - + diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap index 22cf468a35e..49555798847 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap @@ -1979,7 +1979,7 @@ - + @@ -2051,7 +2051,7 @@ - + @@ -2095,7 +2095,7 @@ - + @@ -2118,7 +2118,7 @@ - + @@ -4657,7 +4657,7 @@ - + diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-macos.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-macos.ditamap index 3a4c499035f..a38b6c3b726 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-macos.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-macos.ditamap @@ -1920,7 +1920,7 @@ - + @@ -1999,7 +1999,7 @@ - + @@ -2043,7 +2043,7 @@ - + @@ -2066,7 +2066,7 @@ - + @@ -4195,7 +4195,7 @@ - + diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-rn.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-rn.ditamap index e95580bf78b..61b56d2d4d8 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-rn.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-rn.ditamap @@ -1954,7 +1954,7 @@ - + @@ -2040,7 +2040,7 @@ - + @@ -2070,7 +2070,7 @@ - + diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-unity.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-unity.ditamap index eb2c9cfedc6..94e16982d71 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-unity.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-unity.ditamap @@ -2032,7 +2032,7 @@ - + @@ -2090,7 +2090,7 @@ - + @@ -2162,7 +2162,7 @@ - + @@ -2185,7 +2185,7 @@ - + @@ -4706,7 +4706,7 @@ - + diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-unreal.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-unreal.ditamap index 13c386b6e58..46fcf7a902a 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-unreal.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-unreal.ditamap @@ -2029,7 +2029,7 @@ - + @@ -2115,7 +2115,7 @@ - + @@ -2145,7 +2145,7 @@ - + @@ -2168,7 +2168,7 @@ - + @@ -4794,7 +4794,7 @@ - + From 63be85f590bf9f2d126e6ccc5c24190ef811dc25 Mon Sep 17 00:00:00 2001 From: Suri539 Date: Thu, 4 Jul 2024 14:49:06 +0800 Subject: [PATCH 05/67] =?UTF-8?q?media=20player=20=E7=9A=84=20api=20?= =?UTF-8?q?=E4=BB=AC?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- dita/RTC-NG/API/api_imediaplayer_play.dita | 3 ++- dita/RTC-NG/API/api_imediaplayer_seek.dita | 7 +++---- dita/RTC-NG/API/api_imediaplayer_setloopcount.dita | 7 ++++++- dita/RTC-NG/API/api_imediaplayer_stop.dita | 3 +++ dita/RTC-NG/config/relations-rtc-ng-api.ditamap | 2 +- 5 files changed, 15 insertions(+), 7 deletions(-) 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_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/config/relations-rtc-ng-api.ditamap b/dita/RTC-NG/config/relations-rtc-ng-api.ditamap index f280c291eb2..65e6d919d24 100644 --- a/dita/RTC-NG/config/relations-rtc-ng-api.ditamap +++ b/dita/RTC-NG/config/relations-rtc-ng-api.ditamap @@ -3053,7 +3053,7 @@ - + From a60d16bc9b870443f61d7b4261ab09a93833ee47 Mon Sep 17 00:00:00 2001 From: Nero-Hu Date: Fri, 5 Jul 2024 11:41:56 +0800 Subject: [PATCH 06/67] update rhythmPlayer sequence --- .../API/api_irtcengine_startrhythmplayer.dita | 31 ++++++++++-------- dita/RTC-NG/API/rtc_api_data_type.dita | 1 + dita/RTC-NG/API/rtc_api_overview.dita | 5 +-- dita/RTC-NG/RTC_NG_API_Electron.ditamap | 4 +++ dita/RTC-NG/RTC_NG_API_macOS.ditamap | 6 ++++ .../config/keys-rtc-ng-api-electron.ditamap | 32 +++++++++++++++++++ .../config/keys-rtc-ng-api-macos.ditamap | 32 +++++++++++++++++++ .../config/relations-rtc-ng-api.ditamap | 8 ++--- 8 files changed, 98 insertions(+), 21 deletions(-) diff --git a/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita b/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita index 1a3ce5b3c23..d747caae59c 100644 --- a/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita +++ b/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita @@ -36,18 +36,27 @@ required AgoraRhythmPlayerConfig config});

    -
    - 详情 +
    +
    + 适用场景

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

    -

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

    -

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

    - +
    +
    + 调用时机 +

    加入频道前后均可调用。

    +
    +
    + 调用限制
      -
    • 该方法仅适用于 Android 和 iOS。
      • +
    • 虚拟节拍器的声音默认不会发布至远端，如果你希望远端用户听到虚拟节拍器的声音，你可以在调用该方法后，将 中的 publishRhythmPlayerTrack 设为 。
    • 开启虚拟节拍器后，SDK 会从头开始播放指定的音频文件，并根据你在 中设置的 beatsPerMinute 控制每个文件的播放时长。例如，将 beatsPerMinute 设为 60，则 SDK 会 1 秒播放 1 个节拍。如果文件时长超过了节拍时长，则 SDK 只播放节拍时长部分的音频。
      • -
    • 虚拟节拍器的声音默认会发布至远端，如果你不希望远端用户听到虚拟节拍器的声音，你可以将 中的 publishRhythmPlayerTrack 设为 。
      • -
    -
    + +
    + +
    参数 @@ -71,10 +80,6 @@
    • 0: 方法调用成功。
    • < 0: 方法调用失败 - - - -
      • -22: 无法找到音频文件。请填写正确的 sound1 和 sound2。
      • diff --git a/dita/RTC-NG/API/rtc_api_data_type.dita b/dita/RTC-NG/API/rtc_api_data_type.dita index d0ecf8c56ac..271aab8686d 100644 --- a/dita/RTC-NG/API/rtc_api_data_type.dita +++ b/dita/RTC-NG/API/rtc_api_data_type.dita @@ -462,6 +462,7 @@
      • +
      • diff --git a/dita/RTC-NG/API/rtc_api_overview.dita b/dita/RTC-NG/API/rtc_api_overview.dita index a445251b0dc..eb5867b4a44 100644 --- a/dita/RTC-NG/API/rtc_api_overview.dita +++ b/dita/RTC-NG/API/rtc_api_overview.dita @@ -1505,11 +1505,8 @@
    -
    +
    虚拟节拍器 - -

    本组方法仅适用于 Android 和 iOS。

    -     方法/回调 diff --git a/dita/RTC-NG/RTC_NG_API_Electron.ditamap b/dita/RTC-NG/RTC_NG_API_Electron.ditamap index 9ddd69b2b51..18ca6c161b7 100644 --- a/dita/RTC-NG/RTC_NG_API_Electron.ditamap +++ b/dita/RTC-NG/RTC_NG_API_Electron.ditamap @@ -427,6 +427,10 @@ + + + + diff --git a/dita/RTC-NG/RTC_NG_API_macOS.ditamap b/dita/RTC-NG/RTC_NG_API_macOS.ditamap index 0058273fdae..bd80d2891e6 100644 --- a/dita/RTC-NG/RTC_NG_API_macOS.ditamap +++ b/dita/RTC-NG/RTC_NG_API_macOS.ditamap @@ -438,6 +438,12 @@ + + + + + + diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-electron.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-electron.ditamap index 439c86e6adc..cbe23b4d7b2 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-electron.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-electron.ditamap @@ -1829,6 +1829,38 @@ + + + + + startRhythmPlayer + + + + + + + stopRhythmPlayer + + + + + + + configRhythmPlayer + + + + + + + + + onRhythmPlayerStateChanged + + + + diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-macos.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-macos.ditamap index a38b6c3b726..93e29ae580a 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-macos.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-macos.ditamap @@ -1832,6 +1832,38 @@ + + + + + startRhythmPlayer + + + + + + + stopRhythmPlayer + + + + + + + configRhythmPlayer + + + + + + + + + didRhythmPlayerStateChanged + + + + diff --git a/dita/RTC-NG/config/relations-rtc-ng-api.ditamap b/dita/RTC-NG/config/relations-rtc-ng-api.ditamap index 65e6d919d24..e57d85e0042 100644 --- a/dita/RTC-NG/config/relations-rtc-ng-api.ditamap +++ b/dita/RTC-NG/config/relations-rtc-ng-api.ditamap @@ -2210,7 +2210,7 @@ - + @@ -2501,7 +2501,7 @@ - + @@ -2522,7 +2522,7 @@ - + @@ -2692,7 +2692,7 @@ - + From 7302a07ae5a0fa0eadf9aafefda839fb1107f986 Mon Sep 17 00:00:00 2001 From: Nero-Hu Date: Fri, 5 Jul 2024 14:31:05 +0800 Subject: [PATCH 07/67] fix rhythmplayer --- .../API/api_irtcengine_startrhythmplayer.dita | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita b/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita index d747caae59c..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,7 +36,12 @@ required AgoraRhythmPlayerConfig config});

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

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

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

    无。

    -
    - 详情 -

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

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

    加入频道前后均可调用。

    +
    +
    + 调用限制 +

    无。

    +
    + -
    +
    +
    参数 From 7743964ecf2da0ababb7c7d9c567cf4d4187bc85 Mon Sep 17 00:00:00 2001 From: Suri539 Date: Fri, 5 Jul 2024 14:56:45 +0800 Subject: [PATCH 09/67] Update rtc_api_overview.dita --- dita/RTC-NG/API/rtc_api_overview.dita | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dita/RTC-NG/API/rtc_api_overview.dita b/dita/RTC-NG/API/rtc_api_overview.dita index eb5867b4a44..0d11d6d70a7 100644 --- a/dita/RTC-NG/API/rtc_api_overview.dita +++ b/dita/RTC-NG/API/rtc_api_overview.dita @@ -411,7 +411,7 @@ - + From 0fa3123ac02fae04604ab4c19bae0e965b79bafe Mon Sep 17 00:00:00 2001 From: Suri539 Date: Fri, 5 Jul 2024 15:06:19 +0800 Subject: [PATCH 10/67] Update keys-rtc-ng-api-unity.ditamap --- dita/RTC-NG/config/keys-rtc-ng-api-unity.ditamap | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-unity.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-unity.ditamap index 94e16982d71..7ecad715360 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-unity.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-unity.ditamap @@ -4627,6 +4627,13 @@ + + + + OnReadyToSendMetadata + + + From a08d809513b718c134f114c343de7b5c40fb99cd Mon Sep 17 00:00:00 2001 From: Nero-Hu Date: Fri, 5 Jul 2024 15:06:35 +0800 Subject: [PATCH 11/67] add rhythm enum keysmap --- dita/RTC-NG/API/rtc_api_data_type.dita | 4 + .../config/keys-rtc-ng-api-electron.ditamap | 112 +++++++++++++++--- .../config/keys-rtc-ng-api-macos.ditamap | 91 ++++++++++++++ 3 files changed, 193 insertions(+), 14 deletions(-) diff --git a/dita/RTC-NG/API/rtc_api_data_type.dita b/dita/RTC-NG/API/rtc_api_data_type.dita index 271aab8686d..a371b8de476 100644 --- a/dita/RTC-NG/API/rtc_api_data_type.dita +++ b/dita/RTC-NG/API/rtc_api_data_type.dita @@ -1573,6 +1573,8 @@
    • +
    • +
    • @@ -1986,6 +1988,8 @@
    • +
    • +
    • diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-electron.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-electron.ditamap index cbe23b4d7b2..3e342e4ee4e 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-electron.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-electron.ditamap @@ -9980,20 +9980,20 @@     - - - - AgoraRhythmPlayerConfig - - - - - - - RecorderReasonCode - - - + + + + AgoraRhythmPlayerConfig + + + + + + + RecorderReasonCode + + + @@ -10309,6 +10309,90 @@ + + + + RhythmPlayerStateType + + + + + + + RhythmPlayerStateIdle + + + + + + + RhythmPlayerStateOpening + + + + + + + RhythmPlayerStateDecoding + + + + + + + RhythmPlayerStatePlaying + + + + + + + RhythmPlayerStateFailed + + + + + + + RhythmPlayerReason + + + + + + + RhythmPlayerReasonOk + + + + + + + RhythmPlayerReasonFailed + + + + + + + RhythmPlayerReasonCanNotOpen + + + + + + + RhythmPlayerReasonCanNotPlay + + + + + + + RhythmPlayerReasonFileOverDurationLimit + + + diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-macos.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-macos.ditamap index 93e29ae580a..95b70950601 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-macos.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-macos.ditamap @@ -4358,6 +4358,13 @@ + + + + AgoraRhythmPlayerConfig + + + @@ -9906,6 +9913,90 @@ + + + + AgoraRhythmPlayerState + + + + + + + AgoraRhythmPlayerStateIdle + + + + + + + AgoraRhythmPlayerStateOpening + + + + + + + AgoraRhythmPlayerStateDecoding + + + + + + + AgoraRhythmPlayerStatePlaying + + + + + + + AgoraRhythmPlayerStateFailed + + + + + + + AgoraRhythmPlayerReason + + + + + + + AgoraRhythmPlayerReasonOK + + + + + + + AgoraRhythmPlayerReasonFailed + + + + + + + AgoraRhythmPlayerReasonCanNotOpen + + + + + + + AgoraRhythmPlayerReasonCanNotPlay + + + + + + + AgoraRhythmPlayerReasonFileOverDurationLimit + + + From f239cd57645c39f47c6fe6c2d8134bad5b12a44a Mon Sep 17 00:00:00 2001 From: jinyu Date: Wed, 3 Jul 2024 15:20:14 +0800 Subject: [PATCH 12/67] 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 2d8c734f3e7545cbabf574a68a6e8e2e0c2f2f94 Mon Sep 17 00:00:00 2001 From: jinyu Date: Wed, 3 Jul 2024 15:28:29 +0800 Subject: [PATCH 13/67] 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 f7397a5755212bfa9ab83633e5e090fee18dd3d7 Mon Sep 17 00:00:00 2001 From: jinyu Date: Wed, 3 Jul 2024 15:28:36 +0800 Subject: [PATCH 14/67] 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 201ec4f6d08685ab1311551757aa69e3ca342349 Mon Sep 17 00:00:00 2001 From: jinyu Date: Wed, 3 Jul 2024 16:24:24 +0800 Subject: [PATCH 15/67] 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 e668a66255a890b552e573561035111d1c6fa487 Mon Sep 17 00:00:00 2001 From: jinyu Date: Wed, 3 Jul 2024 16:39:53 +0800 Subject: [PATCH 16/67] 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 2ce7df674b47aa4e5f94ffe7523c608136f1322b Mon Sep 17 00:00:00 2001 From: jinyu Date: Wed, 3 Jul 2024 17:12:46 +0800 Subject: [PATCH 17/67] 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 a257ae3f17baa67ecb5e8a7ad6cacbae1b757cce Mon Sep 17 00:00:00 2001 From: jinyu Date: Wed, 3 Jul 2024 18:15:59 +0800 Subject: [PATCH 18/67] 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 eed6ab29ae1a8c0c9f7034fdf2330ccdce8b54fb Mon Sep 17 00:00:00 2001 From: jinyu Date: Mon, 8 Jul 2024 16:02:28 +0800 Subject: [PATCH 19/67] 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 63f480bb01abc2f893a0133d78ffc4ff6e6828c2 Mon Sep 17 00:00:00 2001 From: jinyu Date: Thu, 11 Jul 2024 14:45:23 +0800 Subject: [PATCH 20/67] remove --- .../API/api_imediaengine_registeraudioframeobserver.dita | 4 ---- .../API/api_irtcengine_setmixedaudioframeparameters.dita | 4 ---- ...rtcengine_setplaybackaudioframebeforemixingparameters.dita | 4 ---- .../API/api_irtcengine_setplaybackaudioframeparameters.dita | 4 ---- .../API/api_irtcengine_setrecordingaudioframeparameters.dita | 4 ---- 5 files changed, 20 deletions(-) diff --git a/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita b/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita index 365ea569a6a..69c5203841b 100644 --- a/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita +++ b/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita @@ -34,10 +34,6 @@ 调用限制

    无。

    -
    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_setmixedaudioframeparameters.dita b/dita/RTC-NG/API/api_irtcengine_setmixedaudioframeparameters.dita index 2802bf50b7a..91b21c3985b 100644 --- a/dita/RTC-NG/API/api_irtcengine_setmixedaudioframeparameters.dita +++ b/dita/RTC-NG/API/api_irtcengine_setmixedaudioframeparameters.dita @@ -49,10 +49,6 @@ 调用限制

    无。

    -
    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframebeforemixingparameters.dita b/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframebeforemixingparameters.dita index 1f7321290c6..8d5a9a79a4d 100644 --- a/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframebeforemixingparameters.dita +++ b/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframebeforemixingparameters.dita @@ -44,10 +44,6 @@ 调用限制

    无。

    -
    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframeparameters.dita b/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframeparameters.dita index 8361244bf97..5f55912a395 100644 --- a/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframeparameters.dita +++ b/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframeparameters.dita @@ -58,10 +58,6 @@ 调用限制

    无。

    -
    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_setrecordingaudioframeparameters.dita b/dita/RTC-NG/API/api_irtcengine_setrecordingaudioframeparameters.dita index 85d226ab9e7..b4d9e9f5804 100644 --- a/dita/RTC-NG/API/api_irtcengine_setrecordingaudioframeparameters.dita +++ b/dita/RTC-NG/API/api_irtcengine_setrecordingaudioframeparameters.dita @@ -57,10 +57,6 @@ 调用限制

    无。

    -
    参数 From df78b4c1c96daf3104cb6e816cb1460e7cc68ab6 Mon Sep 17 00:00:00 2001 From: jinyu Date: Fri, 12 Jul 2024 11:05:50 +0800 Subject: [PATCH 21/67] + --- dita/RTC-NG/API/api_irtcengine_createdatastream2.dita | 2 +- dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita | 1 + dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita | 5 +---- dita/RTC-NG/API/api_irtcengineex_sendstreammessageex.dita | 1 + 4 files changed, 4 insertions(+), 5 deletions(-) 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_sendstreammessage.dita b/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita index f821ba7292c..3d13964f172 100644 --- a/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita +++ b/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita @@ -46,6 +46,7 @@ 若调用失败，远端会触发 回调。

      +
    • 该方法需要在加入频道前调用。
    • 请确保在调用该方法前，已调用 创建了数据通道。
    • 直播场景下，该方法仅适用于主播用户。
    diff --git a/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita b/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita index 2bced9424dc..1738811907a 100644 --- a/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita +++ b/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita @@ -37,10 +37,7 @@

    相比 ，本方法不保证数据传输的可靠性。接收方会丢弃超出发送时间 5 秒后的数据包。

    -
    - 调用时机 -

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

    -
    +
    参数 diff --git a/dita/RTC-NG/API/api_irtcengineex_sendstreammessageex.dita b/dita/RTC-NG/API/api_irtcengineex_sendstreammessageex.dita index d072bfb37c1..ac56a0a6b33 100644 --- a/dita/RTC-NG/API/api_irtcengineex_sendstreammessageex.dita +++ b/dita/RTC-NG/API/api_irtcengineex_sendstreammessageex.dita @@ -41,6 +41,7 @@

      +
    • 该方法需要在 前调用。
    • 请确保在调用该方法前，已调用 创建了数据通道。
    • 该方法仅适用于通信场景以及直播场景下的主播用户，如果直播场景下的观众调用此方法可能会造成观众变主播。
    From 1987fe01acfb6db2df9c5bc84b59229e60576f80 Mon Sep 17 00:00:00 2001 From: jinyu Date: Fri, 12 Jul 2024 10:07:40 +0800 Subject: [PATCH 22/67] 1 --- dita/RTC-NG/API/api_irtcengine_pushaudioframe2.dita | 2 +- .../API/api_irtcengine_pushexternalaudioframesamplebuffer2.dita | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/dita/RTC-NG/API/api_irtcengine_pushaudioframe2.dita b/dita/RTC-NG/API/api_irtcengine_pushaudioframe2.dita index 7d0e0715619..93085bbaa09 100644 --- a/dita/RTC-NG/API/api_irtcengine_pushaudioframe2.dita +++ b/dita/RTC-NG/API/api_irtcengine_pushaudioframe2.dita @@ -34,7 +34,7 @@
    调用时机 -

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

      +

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

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

      diff --git a/dita/RTC-NG/API/api_irtcengine_pushexternalaudioframesamplebuffer2.dita b/dita/RTC-NG/API/api_irtcengine_pushexternalaudioframesamplebuffer2.dita index 2a9c3e936b7..fc3ec2c385b 100644 --- a/dita/RTC-NG/API/api_irtcengine_pushexternalaudioframesamplebuffer2.dita +++ b/dita/RTC-NG/API/api_irtcengine_pushexternalaudioframesamplebuffer2.dita @@ -32,7 +32,7 @@
      v4.3.1
      - +

    参数 From 3da09d366fed39d3fa73f30d581fcaf5e37f4bbe Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Fri, 12 Jul 2024 16:53:24 +0800 Subject: [PATCH 23/67] New translations --- en-US/dita/RTC-NG/API/class_externalvideoframe.dita | 4 ---- en-US/dita/RTC-NG/API/rtc_api_sunset.dita | 10 +++++----- 2 files changed, 5 insertions(+), 9 deletions(-) diff --git a/en-US/dita/RTC-NG/API/class_externalvideoframe.dita b/en-US/dita/RTC-NG/API/class_externalvideoframe.dita index 18d96f3e08c..b3bfee20dd8 100644 --- a/en-US/dita/RTC-NG/API/class_externalvideoframe.dita +++ b/en-US/dita/RTC-NG/API/class_externalvideoframe.dita @@ -436,10 +436,6 @@ class ExternalVideoFrame { - - - - texture_slice_index textureSliceIndex diff --git a/en-US/dita/RTC-NG/API/rtc_api_sunset.dita b/en-US/dita/RTC-NG/API/rtc_api_sunset.dita index 1edd5b3319e..4f36a603c8e 100644 --- a/en-US/dita/RTC-NG/API/rtc_api_sunset.dita +++ b/en-US/dita/RTC-NG/API/rtc_api_sunset.dita @@ -129,11 +129,11 @@ or v4.0.0 - - - - - v4.0.0 + + + + + v4.0.0 From ca8d628bd7e05960f90f1bd6f0b65d88d8ced991 Mon Sep 17 00:00:00 2001 From: jinyu Date: Mon, 15 Jul 2024 13:32:01 +0800 Subject: [PATCH 24/67] Update api_irtcengine_setremotedefaultvideostreamtype2.dita --- ...pi_irtcengine_setremotedefaultvideostreamtype2.dita | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype2.dita b/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype2.dita index 9e2710924c1..2544db476b9 100644 --- a/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype2.dita +++ b/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype2.dita @@ -16,8 +16,7 @@ public abstract int setRemoteDefaultVideoStreamType(Constants.VideoStreamType streamType);

    -
    - 详情 +
    自从
    @@ -25,9 +24,10 @@

    -

    -

    -
    +

    +
    +
    +
    参数 From 4201bf55a40ea535008e7b7eea1dd089066d9daf Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Mon, 15 Jul 2024 13:34:37 +0800 Subject: [PATCH 25/67] New translations --- ...pi_irtcengine_setremotedefaultvideostreamtype2.dita | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype2.dita index 1bb407e444d..40704b3dcd4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype2.dita @@ -16,8 +16,7 @@ public abstract int setRemoteDefaultVideoStreamType(Constants.VideoStreamType streamType);

    -
    - Details +
    Since
    @@ -25,9 +24,10 @@

    -

    -

    -
    +

    +
    +
    +
    Parameters From b7a25d3fec6e430b26a8558558169a54b48d0bb6 Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Mon, 15 Jul 2024 17:17:34 +0800 Subject: [PATCH 26/67] New translations --- .../API/api_irtcengine_statechanged.dita | 3 +- .../RTC-NG/API/enum_mediadevicestatetype.dita | 4 + en-US/dita/RTC-NG/API/rtc_api_sunset.dita | 210 ++++++++++++++++-- en-US/dita/RTC-NG/API/rtc_lite_api.dita | 21 +- 4 files changed, 210 insertions(+), 28 deletions(-) diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_statechanged.dita b/en-US/dita/RTC-NG/API/api_irtcengine_statechanged.dita index 66057da0a37..954dca7bb8d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_statechanged.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_statechanged.dita @@ -48,8 +48,9 @@ state

    Media device states:

      -
    • 0: The device is connected but not in use.
      • +
    • 0：设备就绪。
    • 1: The device is in use.
      • +
    • 3：设备已插入。
    • 8: The devive is disconnected.

     diff --git a/en-US/dita/RTC-NG/API/enum_mediadevicestatetype.dita b/en-US/dita/RTC-NG/API/enum_mediadevicestatetype.dita index a993b1489aa..a8cca5ee8c7 100644 --- a/en-US/dita/RTC-NG/API/enum_mediadevicestatetype.dita +++ b/en-US/dita/RTC-NG/API/enum_mediadevicestatetype.dita @@ -19,6 +19,10 @@ 2: The device is disabled.     + + + 3: 设备已插入。 + 4: The device is not found. diff --git a/en-US/dita/RTC-NG/API/rtc_api_sunset.dita b/en-US/dita/RTC-NG/API/rtc_api_sunset.dita index 4f36a603c8e..e24eca2c090 100644 --- a/en-US/dita/RTC-NG/API/rtc_api_sunset.dita +++ b/en-US/dita/RTC-NG/API/rtc_api_sunset.dita @@ -6,12 +6,13 @@
    Deprecated APIs

    The deprecated APIs are expected to be officially deleted in approximately one year. Agora recommends that you promptly replace them with the recommended APIs to avoid any impact on your online services.

    - +
    + - - - - + + + + API @@ -45,6 +46,12 @@ v4.4.0 + + + + + v4.4.0 + @@ -78,19 +85,19 @@ - Use the logConfig parameter in + Use the logConfig parameter in v4.0.0 - + v4.0.0 - + v4.0.0 @@ -102,13 +109,13 @@ - or + or v4.0.0 - + v4.0.0 @@ -120,20 +127,189 @@ - Use the logConfig parameter in + Use the logConfig parameter in v4.0.0 - or + or v4.0.0 - - - - v4.0.0 + + + + v4.0.0 + + + + + + v4.0.0 + + + + + - + v4.0.0 + + + + + - + v4.0.0 + + + + + - + v4.0.0 + + + + + - + v4.0.0 + + + + + - + v4.0.0 + + + + + - + v4.0.0 + + + +
    + + + + + + + + + + API + Description + Alternative API + Deprecated version + + + + + + + + v4.4.0 + + + + + + v4.4.0 + + + + + + v4.4.0 + + + + + + v4.4.0 + + + + + + v4.3.1 + + + + + + v4.2.0 + + + + + + v4.2.0 + + + + + + v4.2.0 + + + + + - + v4.0.0 + + + + + Use the logConfig parameter in + v4.0.0 + + + + + + v4.0.0 + + + + + + v4.0.0 + + + + + + v4.0.0 + + + + + or + v4.0.0 + + + + + + v4.0.0 + + + + + + v4.0.0 + + + + + Use the logConfig parameter in + v4.0.0 + + + + + or + v4.0.0 @@ -285,7 +461,7 @@ v4.4.0 - +
    diff --git a/en-US/dita/RTC-NG/API/rtc_lite_api.dita b/en-US/dita/RTC-NG/API/rtc_lite_api.dita index 1f4ecccd428..b5ee882551a 100644 --- a/en-US/dita/RTC-NG/API/rtc_lite_api.dita +++ b/en-US/dita/RTC-NG/API/rtc_lite_api.dita @@ -6,7 +6,7 @@
    If you cannot find the API you are looking for on this page, it means the Lite SDK does not support this API, and calling it returns error code -2.
    - <ph keyref="IRtcEngine"/> + <apiname keyref="IRtcEngine"/>
      • @@ -332,7 +332,7 @@
    - <ph keyref="IRtcEngineEx"/> + <apiname keyref="IRtcEngineEx"/>
      • @@ -386,7 +386,7 @@
    - <ph keyref="IRtcEngineEventHandler"/> + <apiname keyref="IRtcEngineEventHandler"/>
      • @@ -475,7 +475,7 @@
    - <ph keyref="IMediaExtensionObserver"/> + <apiname keyref="IMediaExtensionObserver"/>
      • @@ -484,7 +484,7 @@
    - <ph keyref="IMediaPlayer"/> + <apiname keyref="IMediaPlayer"/> The APIs in this group only support processing audio media files and di not support processing video media files.
      • @@ -543,28 +543,29 @@
    - <ph keyref="IVideoEncodedFrameObserver"/> + <apiname keyref="IVideoEncodedFrameObserver"/>
    - <ph keyref="IVideoFrameObserver"/> + <apiname keyref="IVideoFrameObserver"/> + 通过 、 和 回调返回的视频数据中，alphabuffer 为 。
      • -
      • +
    - <ph keyref="IMediaExtensionObserver"/> + <apiname keyref="IMediaExtensionObserver"/>
      • @@ -573,7 +574,7 @@
    - <ph keyref="IMusicPlayer"/> + <apiname keyref="IMusicPlayer"/>
      • From 0c7e64039018131b19b3eafdd6743e30de5c5c00 Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Mon, 15 Jul 2024 18:06:05 +0800 Subject: [PATCH 27/67] New translations --- en-US/dita/RTC-NG/API/api_irtcengine_statechanged.dita | 4 ++-- en-US/dita/RTC-NG/API/enum_mediadevicestatetype.dita | 2 +- en-US/dita/RTC-NG/API/rtc_lite_api.dita | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_statechanged.dita b/en-US/dita/RTC-NG/API/api_irtcengine_statechanged.dita index 954dca7bb8d..9459aeee46e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_statechanged.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_statechanged.dita @@ -48,9 +48,9 @@ state

      Media device states:

        -
      • 0：设备就绪。
        • +
      • 0: The device is ready for use.
      • 1: The device is in use.
        • -
      • 3：设备已插入。
        • +
      • 3: The device is plugged in.
      • 8: The devive is disconnected.

       diff --git a/en-US/dita/RTC-NG/API/enum_mediadevicestatetype.dita b/en-US/dita/RTC-NG/API/enum_mediadevicestatetype.dita index a8cca5ee8c7..775052b5d05 100644 --- a/en-US/dita/RTC-NG/API/enum_mediadevicestatetype.dita +++ b/en-US/dita/RTC-NG/API/enum_mediadevicestatetype.dita @@ -21,7 +21,7 @@ - 3: 设备已插入。 + 3: The device is plugged in. diff --git a/en-US/dita/RTC-NG/API/rtc_lite_api.dita b/en-US/dita/RTC-NG/API/rtc_lite_api.dita index b5ee882551a..75c0d65346c 100644 --- a/en-US/dita/RTC-NG/API/rtc_lite_api.dita +++ b/en-US/dita/RTC-NG/API/rtc_lite_api.dita @@ -550,7 +550,7 @@
    <apiname keyref="IVideoFrameObserver"/> - 通过 、 和 回调返回的视频数据中，alphabuffer 为 。 + In the video data returned by the , , and callbacks, the alphabuffer is .
      • From 8a72670f7f6f586fabdfa74792888b399cb66781 Mon Sep 17 00:00:00 2001 From: jinyu Date: Mon, 8 Jul 2024 16:39:53 +0800 Subject: [PATCH 28/67] + --- ...engine_adjustuserplaybacksignalvolume.dita | 2 +- ...neex_adjustuserplaybacksignalvolumeex.dita | 21 +++++++++++-------- ...ngineex_enableaudiovolumeindicationex.dita | 14 +++++++++---- 3 files changed, 23 insertions(+), 14 deletions(-) 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_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_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 会在加入频道后按设置的时间间隔触发 回调。

    +
    +
    + 调用时机 +

    该方法需要在 之后调用。

    +
    +
    + 调用限制 +

    无。

    -
    +