From 991e8a78cbcfbd8e1561b9ff1de625e00ec31d8b Mon Sep 17 00:00:00 2001 From: Suri539 Date: Tue, 17 Oct 2023 15:25:39 +0800 Subject: [PATCH 01/14] fix --- dita/RTC-NG/API/api_imusiccontentcenter_release.dita | 2 +- .../API/api_irtcengine_updatepreloadchanneltoken.dita | 10 ++++++---- dita/RTC-NG/API/rtc_api_overview.dita | 6 +++--- dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap | 4 ++-- dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap | 2 +- dita/RTC-NG/config/keys-rtc-ng-api-unity.ditamap | 2 +- 6 files changed, 14 insertions(+), 12 deletions(-) diff --git a/dita/RTC-NG/API/api_imusiccontentcenter_release.dita b/dita/RTC-NG/API/api_imusiccontentcenter_release.dita index 4e6f8dd3b47..e1beb939e40 100644 --- a/dita/RTC-NG/API/api_imusiccontentcenter_release.dita +++ b/dita/RTC-NG/API/api_imusiccontentcenter_release.dita @@ -2,7 +2,7 @@ <ph keyref="release_IMusicContentCenter"/> - 释放音乐内容中心所占用的所有资源。销毁 实例。 + 释放音乐内容中心所占用的所有资源。 diff --git a/dita/RTC-NG/API/api_irtcengine_updatepreloadchanneltoken.dita b/dita/RTC-NG/API/api_irtcengine_updatepreloadchanneltoken.dita index b32d7e7d977..75f3cd1b3ca 100644 --- a/dita/RTC-NG/API/api_irtcengine_updatepreloadchanneltoken.dita +++ b/dita/RTC-NG/API/api_irtcengine_updatepreloadchanneltoken.dita @@ -48,9 +48,11 @@

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

  • 0: 方法调用成功。
    • -
  • < 0: 方法调用失败。详见了解详情和解决建议。
    • -
  • -2：传入的参数无效。例如，使用了不合法的 Token。你需要填入有效的参数，重新加入频道。
    • -
  • -7： 对象尚未初始化。你需要在调用该方法前成功初始化 对象。
    • -
+
  • < 0: 方法调用失败。详见了解详情和解决建议。 +
      +
    • -2：传入的参数无效。例如，使用了不合法的 Token。你需要填入有效的参数，重新加入频道。
      • +
    • -7： 对象尚未初始化。你需要在调用该方法前成功初始化 对象。
      • +
    • +     diff --git a/dita/RTC-NG/API/rtc_api_overview.dita b/dita/RTC-NG/API/rtc_api_overview.dita index bd30a2bd33d..3098b1e842e 100644 --- a/dita/RTC-NG/API/rtc_api_overview.dita +++ b/dita/RTC-NG/API/rtc_api_overview.dita @@ -1508,7 +1508,7 @@
    媒体播放器 -

    更多有关媒体播放器的方法，详见内置媒体播放器。

    +

    更多有关媒体播放器的方法，详见内置媒体播放器。

    更多有关媒体播放器的方法，详见 。

    @@ -1611,7 +1611,7 @@
    - 版权音乐 + <ph props="cn">版权音乐</ph>

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

    @@ -1624,7 +1624,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 d5bfdf118da..90de9cb2b0c 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap @@ -429,14 +429,14 @@ - preloadChannel[1/2] + PreloadChannel [1/2] - preloadChannel[2/2] + preloadChannel [2/2] 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 dd5b0d82ce6..d94eadab14d 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap @@ -317,7 +317,7 @@ - preloadChannel[1/2] + PreloadChannel [1/2] 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 5a64a156fe0..a91cb569a57 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-unity.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-unity.ditamap @@ -368,7 +368,7 @@ - PreloadChannel[1/2] + PreloadChannel [1/2] From 468696d715dcccfdbd040eb744fddeef4d422962 Mon Sep 17 00:00:00 2001 From: Suri539 Date: Tue, 17 Oct 2023 15:32:20 +0800 Subject: [PATCH 02/14] fix2 --- dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap | 4 ++-- dita/RTC-NG/config/keys-rtc-ng-api-unity.ditamap | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) 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 d94eadab14d..4e9b9cd8539 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap @@ -317,14 +317,14 @@ - PreloadChannel [1/2] + preloadChannel [1/2] - preloadChannel[2/2] + preloadChannel [2/2] 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 a91cb569a57..a1ab0672e28 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-unity.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-unity.ditamap @@ -375,7 +375,7 @@ - PreloadChannel[2/2] + PreloadChannel [2/2] From 380a0b9cddf1a23e3689cf10a2cf3e63b39899de Mon Sep 17 00:00:00 2001 From: Cilla-luodan Date: Wed, 18 Oct 2023 10:34:51 +0800 Subject: [PATCH 03/14] Delete rtc_api_overview_ng.dita --- dita/RTC-NG/API/rtc_api_overview_ng.dita | 675 ----------------------- 1 file changed, 675 deletions(-) delete mode 100644 dita/RTC-NG/API/rtc_api_overview_ng.dita diff --git a/dita/RTC-NG/API/rtc_api_overview_ng.dita b/dita/RTC-NG/API/rtc_api_overview_ng.dita deleted file mode 100644 index 20505bfeb3f..00000000000 --- a/dita/RTC-NG/API/rtc_api_overview_ng.dita +++ /dev/null @@ -1,675 +0,0 @@ - - - - API 概览 - 声网通过全球部署的 SD-RTN™，提供可以灵活搭配的 API 组合，实现质量可靠的实时音视频通信。 - -

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

    -
    - 数据统计事件 - - - 事件 - 描述 - - - - - - - - - - -
    -
    - 音频前后处理 - - - 方法 - 描述 - - - - - - - - - -
    -
    - 视频前后处理 - - - 方法 - 描述 - - -
    -
    - 人脸检测 - 该组功能仅适用于 Android 和 iOS 平台。 - - 方法 - 描述 - - - - - 事件 - 描述 - - -
    -
    - 耳返 - - - 方法 - 描述 - - - - - - - - - - - - - - - - 事件 - 描述 - - - - - - - - - -
    -
    - 变声与混响 - - - 方法 - 描述 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -
    - 视频流回退 - - - 方法 - 描述 - - - - - - - - 事件 - 描述 - - - - - -
    -
    - 通话前网络测试 - - - 方法 - 描述 - - - - - - - - - - - - - - - - - - - - - - - - - - - - 事件 - 描述 - - - - - - - - - -
    -
    - 听声辨位 - - - 方法 - 描述 - - - - - - - - - - - - - -
    -
    - 空间音效 - - - 服务端计算方法 - 描述 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 本地直角坐标系计算方法 - 描述 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 本地球坐标系计算方法 - 描述 - - - - - - - - - - - - - - - - 服务端计算事件 - 描述 - - - - - - - - - - - - - - - - - -
    -
    - 本地合图 - - - 方法 - 描述 - - - - - - 事件 - 描述 - - - -
    -
    - 自定义音频采集 - - - 方法 - 描述 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -
    - 自定义音频渲染 - - - 方法 - 描述 - - - - - - - - - -
    -
    - 原始音频数据 - - - 方法 - 描述 - - - - - - - - - - - - - - - - - - - - - - - - 事件 - 描述 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -
    - 音频编码数据 - - - 方法 - 描述 - - - - - - - - 事件 - 描述 - - - - - - - - - - - - - -
    -
    - 音频频谱 - - - 方法 - 描述 - - - - - - - - - - - - - - - - - - - - 事件 - 描述 - - - - - - - - - -
    -
    - 外部视频数据 - - - 方法 - 描述 - - - - - - - - - -
    -
    - 多频道 -

    更多有关多频道的方法，详见多频道管理。

    -

    更多有关多频道的方法，详见 。

    - - - 方法 - 描述 - - - - - - - - - - - - - -
    -
    - 设备管理 - - - 方法 - 描述 - - - - 事件 - 描述 - -
    -
    - 视频设备管理 - - - 方法 - 描述 - - - - 事件 - 描述 - -
    -
    - 视频设备集合 - -

    该组方法仅适用于 Windows。

    -     - - 方法 - 描述 - -
    -
    - 音频设备集合 - -

    该组方法仅适用于 Windows。

    -     - - 方法 - 描述 - -
    -
    - 其他音频控制 - -

    该组方法仅适用于 Windows 和 macOS。

    -     - - 方法 - 描述 - - -
    - -     From d81450e883c9b8144f66d33f5de3765c03cacf09 Mon Sep 17 00:00:00 2001 From: Cilla-luodan Date: Wed, 18 Oct 2023 10:43:25 +0800 Subject: [PATCH 04/14] add macos and delete redundant unity prototype --- dita/RTC-NG/API/api_iscreencapturesourcelist_getcount.dita | 6 +++++- .../API/api_iscreencapturesourcelist_getsourceinfo.dita | 3 ++- dita/RTC-NG/API/api_iscreencapturesourcelist_release.dita | 3 ++- dita/RTC-NG/API/rtc_api_overview.dita | 6 +++--- 4 files changed, 12 insertions(+), 6 deletions(-) diff --git a/dita/RTC-NG/API/api_iscreencapturesourcelist_getcount.dita b/dita/RTC-NG/API/api_iscreencapturesourcelist_getcount.dita index bd5849b7e61..a788b4c50d3 100644 --- a/dita/RTC-NG/API/api_iscreencapturesourcelist_getcount.dita +++ b/dita/RTC-NG/API/api_iscreencapturesourcelist_getcount.dita @@ -19,11 +19,15 @@ UFUNCTION(BlueprintCallable, Category = "Agora|ScreenCaptureSourceList") int64 GetCount(); - public uint getCount() { return 0; } +

    +
    + 详情 + 该方法仅适用于 macOS 和 Windows。 +
    返回值

    可共享的窗口和屏幕的个数。

    diff --git a/dita/RTC-NG/API/api_iscreencapturesourcelist_getsourceinfo.dita b/dita/RTC-NG/API/api_iscreencapturesourcelist_getsourceinfo.dita index 70e3bdea029..af09ab01b51 100644 --- a/dita/RTC-NG/API/api_iscreencapturesourcelist_getsourceinfo.dita +++ b/dita/RTC-NG/API/api_iscreencapturesourcelist_getsourceinfo.dita @@ -19,7 +19,7 @@ UFUNCTION(BlueprintCallable, Category = "Agora|ScreenCaptureSourceList") FScreenCaptureSourceInfo GetSourceInfo(int64 index); - public ScreenCaptureSourceInfo getSourceInfo(uint index) { return null; } +

    @@ -27,6 +27,7 @@
    详情

    获取到 后，你可以传入指定的可共享窗口或屏幕的索引值，以获取到该窗口或屏幕的信息 。

    + 该方法仅适用于 macOS 和 Windows。
    参数 diff --git a/dita/RTC-NG/API/api_iscreencapturesourcelist_release.dita b/dita/RTC-NG/API/api_iscreencapturesourcelist_release.dita index 02382bc6e6f..6d7a031e794 100644 --- a/dita/RTC-NG/API/api_iscreencapturesourcelist_release.dita +++ b/dita/RTC-NG/API/api_iscreencapturesourcelist_release.dita @@ -19,7 +19,7 @@ UFUNCTION(BlueprintCallable, Category = "Agora|ScreenCaptureSourceList") void Release(); - public void release() { } +

    @@ -27,6 +27,7 @@
    详情

    获取可共享的窗口和屏幕对象列表后，为避免内存泄露，请调用该方法释放 ，不要直接删除 。

    + 该方法仅适用于 macOS 和 Windows。
    diff --git a/dita/RTC-NG/API/rtc_api_overview.dita b/dita/RTC-NG/API/rtc_api_overview.dita index 3098b1e842e..19def3e1643 100644 --- a/dita/RTC-NG/API/rtc_api_overview.dita +++ b/dita/RTC-NG/API/rtc_api_overview.dita @@ -946,15 +946,15 @@ - （仅适用于 Windows） + 仅适用于 Windows 和 macOS） - （仅适用于 Windows） + （仅适用于 Windows 和 macOS） - （仅适用于 Windows） + （仅适用于 Windows 和 macOS） From 3ec9dc87c75fc557353b6ca93b5c5777667b6631 Mon Sep 17 00:00:00 2001 From: Cilla-luodan Date: Wed, 18 Oct 2023 11:33:38 +0800 Subject: [PATCH 05/14] =?UTF-8?q?move=20unused=20files=20to=20archive=20fo?= =?UTF-8?q?lder=20(=E6=89=93=E5=85=A5=E5=86=B7=E5=AE=AB)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../api_icloudspatialaudioengine_addeventhandler.dita | 0 .../{API => archive}/api_icloudspatialaudioengine_create.dita | 0 .../api_icloudspatialaudioengine_enablespatializer.dita | 0 .../{API => archive}/api_icloudspatialaudioengine_enterroom.dita | 0 .../{API => archive}/api_icloudspatialaudioengine_exitroom.dita | 0 .../api_icloudspatialaudioengine_getteammates.dita | 0 .../{API => archive}/api_icloudspatialaudioengine_initialize.dita | 0 .../{API => archive}/api_icloudspatialaudioengine_release.dita | 0 .../api_icloudspatialaudioengine_removeeventhandler.dita | 0 .../{API => archive}/api_icloudspatialaudioengine_renewtoken.dita | 0 .../api_icloudspatialaudioengine_setaudiorangemode.dita | 0 .../{API => archive}/api_icloudspatialaudioengine_setteamid.dita | 0 ...ck_icloudspatialaudioeventhandler_onconnectionstatechange.dita | 0 .../callback_icloudspatialaudioeventhandler_onteammatejoined.dita | 0 .../callback_icloudspatialaudioeventhandler_onteammateleft.dita | 0 ...callback_icloudspatialaudioeventhandler_ontokenwillexpire.dita | 0 dita/RTC-NG/{API => archive}/class_icloudspatialaudioengine.dita | 0 .../{API => archive}/class_icloudspatialaudioeventhandler.dita | 0 18 files changed, 0 insertions(+), 0 deletions(-) rename dita/RTC-NG/{API => archive}/api_icloudspatialaudioengine_addeventhandler.dita (100%) rename dita/RTC-NG/{API => archive}/api_icloudspatialaudioengine_create.dita (100%) rename dita/RTC-NG/{API => archive}/api_icloudspatialaudioengine_enablespatializer.dita (100%) rename dita/RTC-NG/{API => archive}/api_icloudspatialaudioengine_enterroom.dita (100%) rename dita/RTC-NG/{API => archive}/api_icloudspatialaudioengine_exitroom.dita (100%) rename dita/RTC-NG/{API => archive}/api_icloudspatialaudioengine_getteammates.dita (100%) rename dita/RTC-NG/{API => archive}/api_icloudspatialaudioengine_initialize.dita (100%) rename dita/RTC-NG/{API => archive}/api_icloudspatialaudioengine_release.dita (100%) rename dita/RTC-NG/{API => archive}/api_icloudspatialaudioengine_removeeventhandler.dita (100%) rename dita/RTC-NG/{API => archive}/api_icloudspatialaudioengine_renewtoken.dita (100%) rename dita/RTC-NG/{API => archive}/api_icloudspatialaudioengine_setaudiorangemode.dita (100%) rename dita/RTC-NG/{API => archive}/api_icloudspatialaudioengine_setteamid.dita (100%) rename dita/RTC-NG/{API => archive}/callback_icloudspatialaudioeventhandler_onconnectionstatechange.dita (100%) rename dita/RTC-NG/{API => archive}/callback_icloudspatialaudioeventhandler_onteammatejoined.dita (100%) rename dita/RTC-NG/{API => archive}/callback_icloudspatialaudioeventhandler_onteammateleft.dita (100%) rename dita/RTC-NG/{API => archive}/callback_icloudspatialaudioeventhandler_ontokenwillexpire.dita (100%) rename dita/RTC-NG/{API => archive}/class_icloudspatialaudioengine.dita (100%) rename dita/RTC-NG/{API => archive}/class_icloudspatialaudioeventhandler.dita (100%) diff --git a/dita/RTC-NG/API/api_icloudspatialaudioengine_addeventhandler.dita b/dita/RTC-NG/archive/api_icloudspatialaudioengine_addeventhandler.dita similarity index 100% rename from dita/RTC-NG/API/api_icloudspatialaudioengine_addeventhandler.dita rename to dita/RTC-NG/archive/api_icloudspatialaudioengine_addeventhandler.dita diff --git a/dita/RTC-NG/API/api_icloudspatialaudioengine_create.dita b/dita/RTC-NG/archive/api_icloudspatialaudioengine_create.dita similarity index 100% rename from dita/RTC-NG/API/api_icloudspatialaudioengine_create.dita rename to dita/RTC-NG/archive/api_icloudspatialaudioengine_create.dita diff --git a/dita/RTC-NG/API/api_icloudspatialaudioengine_enablespatializer.dita b/dita/RTC-NG/archive/api_icloudspatialaudioengine_enablespatializer.dita similarity index 100% rename from dita/RTC-NG/API/api_icloudspatialaudioengine_enablespatializer.dita rename to dita/RTC-NG/archive/api_icloudspatialaudioengine_enablespatializer.dita diff --git a/dita/RTC-NG/API/api_icloudspatialaudioengine_enterroom.dita b/dita/RTC-NG/archive/api_icloudspatialaudioengine_enterroom.dita similarity index 100% rename from dita/RTC-NG/API/api_icloudspatialaudioengine_enterroom.dita rename to dita/RTC-NG/archive/api_icloudspatialaudioengine_enterroom.dita diff --git a/dita/RTC-NG/API/api_icloudspatialaudioengine_exitroom.dita b/dita/RTC-NG/archive/api_icloudspatialaudioengine_exitroom.dita similarity index 100% rename from dita/RTC-NG/API/api_icloudspatialaudioengine_exitroom.dita rename to dita/RTC-NG/archive/api_icloudspatialaudioengine_exitroom.dita diff --git a/dita/RTC-NG/API/api_icloudspatialaudioengine_getteammates.dita b/dita/RTC-NG/archive/api_icloudspatialaudioengine_getteammates.dita similarity index 100% rename from dita/RTC-NG/API/api_icloudspatialaudioengine_getteammates.dita rename to dita/RTC-NG/archive/api_icloudspatialaudioengine_getteammates.dita diff --git a/dita/RTC-NG/API/api_icloudspatialaudioengine_initialize.dita b/dita/RTC-NG/archive/api_icloudspatialaudioengine_initialize.dita similarity index 100% rename from dita/RTC-NG/API/api_icloudspatialaudioengine_initialize.dita rename to dita/RTC-NG/archive/api_icloudspatialaudioengine_initialize.dita diff --git a/dita/RTC-NG/API/api_icloudspatialaudioengine_release.dita b/dita/RTC-NG/archive/api_icloudspatialaudioengine_release.dita similarity index 100% rename from dita/RTC-NG/API/api_icloudspatialaudioengine_release.dita rename to dita/RTC-NG/archive/api_icloudspatialaudioengine_release.dita diff --git a/dita/RTC-NG/API/api_icloudspatialaudioengine_removeeventhandler.dita b/dita/RTC-NG/archive/api_icloudspatialaudioengine_removeeventhandler.dita similarity index 100% rename from dita/RTC-NG/API/api_icloudspatialaudioengine_removeeventhandler.dita rename to dita/RTC-NG/archive/api_icloudspatialaudioengine_removeeventhandler.dita diff --git a/dita/RTC-NG/API/api_icloudspatialaudioengine_renewtoken.dita b/dita/RTC-NG/archive/api_icloudspatialaudioengine_renewtoken.dita similarity index 100% rename from dita/RTC-NG/API/api_icloudspatialaudioengine_renewtoken.dita rename to dita/RTC-NG/archive/api_icloudspatialaudioengine_renewtoken.dita diff --git a/dita/RTC-NG/API/api_icloudspatialaudioengine_setaudiorangemode.dita b/dita/RTC-NG/archive/api_icloudspatialaudioengine_setaudiorangemode.dita similarity index 100% rename from dita/RTC-NG/API/api_icloudspatialaudioengine_setaudiorangemode.dita rename to dita/RTC-NG/archive/api_icloudspatialaudioengine_setaudiorangemode.dita diff --git a/dita/RTC-NG/API/api_icloudspatialaudioengine_setteamid.dita b/dita/RTC-NG/archive/api_icloudspatialaudioengine_setteamid.dita similarity index 100% rename from dita/RTC-NG/API/api_icloudspatialaudioengine_setteamid.dita rename to dita/RTC-NG/archive/api_icloudspatialaudioengine_setteamid.dita diff --git a/dita/RTC-NG/API/callback_icloudspatialaudioeventhandler_onconnectionstatechange.dita b/dita/RTC-NG/archive/callback_icloudspatialaudioeventhandler_onconnectionstatechange.dita similarity index 100% rename from dita/RTC-NG/API/callback_icloudspatialaudioeventhandler_onconnectionstatechange.dita rename to dita/RTC-NG/archive/callback_icloudspatialaudioeventhandler_onconnectionstatechange.dita diff --git a/dita/RTC-NG/API/callback_icloudspatialaudioeventhandler_onteammatejoined.dita b/dita/RTC-NG/archive/callback_icloudspatialaudioeventhandler_onteammatejoined.dita similarity index 100% rename from dita/RTC-NG/API/callback_icloudspatialaudioeventhandler_onteammatejoined.dita rename to dita/RTC-NG/archive/callback_icloudspatialaudioeventhandler_onteammatejoined.dita diff --git a/dita/RTC-NG/API/callback_icloudspatialaudioeventhandler_onteammateleft.dita b/dita/RTC-NG/archive/callback_icloudspatialaudioeventhandler_onteammateleft.dita similarity index 100% rename from dita/RTC-NG/API/callback_icloudspatialaudioeventhandler_onteammateleft.dita rename to dita/RTC-NG/archive/callback_icloudspatialaudioeventhandler_onteammateleft.dita diff --git a/dita/RTC-NG/API/callback_icloudspatialaudioeventhandler_ontokenwillexpire.dita b/dita/RTC-NG/archive/callback_icloudspatialaudioeventhandler_ontokenwillexpire.dita similarity index 100% rename from dita/RTC-NG/API/callback_icloudspatialaudioeventhandler_ontokenwillexpire.dita rename to dita/RTC-NG/archive/callback_icloudspatialaudioeventhandler_ontokenwillexpire.dita diff --git a/dita/RTC-NG/API/class_icloudspatialaudioengine.dita b/dita/RTC-NG/archive/class_icloudspatialaudioengine.dita similarity index 100% rename from dita/RTC-NG/API/class_icloudspatialaudioengine.dita rename to dita/RTC-NG/archive/class_icloudspatialaudioengine.dita diff --git a/dita/RTC-NG/API/class_icloudspatialaudioeventhandler.dita b/dita/RTC-NG/archive/class_icloudspatialaudioeventhandler.dita similarity index 100% rename from dita/RTC-NG/API/class_icloudspatialaudioeventhandler.dita rename to dita/RTC-NG/archive/class_icloudspatialaudioeventhandler.dita From 006c78aae2f5f022a76bc25e9b0d720f933dab64 Mon Sep 17 00:00:00 2001 From: Cilla-luodan Date: Wed, 18 Oct 2023 11:36:42 +0800 Subject: [PATCH 06/14] add error-code quotations in escaped files --- dita/RTC-NG/API/api_irtcengine_addpublishstreamurl.dita | 2 +- dita/RTC-NG/API/api_irtcengine_enableaudiospectrummonitor.dita | 2 +- dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita | 2 +- dita/RTC-NG/API/api_irtcengine_joinchannel2.dita | 2 +- dita/RTC-NG/API/api_irtcengine_preloadchannel.dita | 2 +- dita/RTC-NG/API/api_irtcengine_preloadchannel2.dita | 2 +- dita/RTC-NG/API/api_irtcengine_renewtoken.dita | 2 +- dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita | 2 +- dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita | 2 +- dita/RTC-NG/API/api_irtcengine_setclientrole.dita | 2 +- dita/RTC-NG/API/api_irtcengine_setcloudproxy.dita | 2 +- dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita | 2 +- .../API/api_irtcengine_startorupdatechannelmediarelay.dita | 2 +- .../API/api_irtcengine_startrtmpstreamwithtranscoding.dita | 2 +- .../API/api_irtcengine_startscreencapturebydisplayid.dita | 2 +- .../API/api_irtcengine_startscreencapturebyscreenrect.dita | 2 +- .../RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita | 2 +- dita/RTC-NG/API/api_irtcengine_stopechotest.dita | 2 +- dita/RTC-NG/API/api_irtcengine_updatechannelmediaoptions.dita | 2 +- .../API/api_irtcengine_updatescreencaptureparameters.dita | 2 +- dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion.dita | 2 +- dita/RTC-NG/API/api_irtcengine_uploadlogfile.dita | 2 +- .../API/api_irtcengineex_startorupdatechannelmediarelayex.dita | 2 +- 23 files changed, 23 insertions(+), 23 deletions(-) diff --git a/dita/RTC-NG/API/api_irtcengine_addpublishstreamurl.dita b/dita/RTC-NG/API/api_irtcengine_addpublishstreamurl.dita index 40eb5e4f72d..b48b483daa7 100644 --- a/dita/RTC-NG/API/api_irtcengine_addpublishstreamurl.dita +++ b/dita/RTC-NG/API/api_irtcengine_addpublishstreamurl.dita @@ -66,7 +66,7 @@
    • 0: 方法调用成功。
    • - < 0: 方法调用失败。 + < 0: 方法调用失败。详见了解详情和解决建议。
      • -2: 参数无效，一般是 URL 为空或是长度为 0 的字符串。
        • diff --git a/dita/RTC-NG/API/api_irtcengine_enableaudiospectrummonitor.dita b/dita/RTC-NG/API/api_irtcengine_enableaudiospectrummonitor.dita index 94a48c54060..a224d374a4a 100644 --- a/dita/RTC-NG/API/api_irtcengine_enableaudiospectrummonitor.dita +++ b/dita/RTC-NG/API/api_irtcengine_enableaudiospectrummonitor.dita @@ -45,7 +45,7 @@

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

        • 0: 方法调用成功。
          • -
        • < 0: 方法调用失败。 +
        • < 0: 方法调用失败。详见了解详情和解决建议。
          • -2: 参数设置错误。
          • diff --git a/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita b/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita index 6dc0a4a40fa..6502320c381 100644 --- a/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita +++ b/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita @@ -108,7 +108,7 @@

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

          • 0: 方法调用成功。
            • -
          • < 0: 方法调用失败。 +
          • < 0: 方法调用失败。详见了解详情和解决建议。
            • -4：设备能力不满足虚拟背景的使用要求，建议更换性能更高的设备。
            • diff --git a/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita b/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita index 8bdfc022f5b..0a0de974a78 100644 --- a/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita +++ b/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita @@ -103,7 +103,7 @@

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

            • 0：方法调用成功。
              • -
            • < 0：方法调用失败。 +
            • < 0：方法调用失败。详见了解详情和解决建议。 diff --git a/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita b/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita index 185a6c876ca..c89cef6a099 100644 --- a/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita +++ b/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita @@ -83,7 +83,7 @@

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

              • 0：方法调用成功。
                • -
              • < 0：方法调用失败。 +
              • < 0：方法调用失败。详见了解详情和解决建议。
                • -7： 对象尚未初始化。你需要在调用该方法前成功初始化 对象。
                • -102：频道名无效。你需要填入有效的频道名，重新加入频道。
                  • diff --git a/dita/RTC-NG/API/api_irtcengine_preloadchannel2.dita b/dita/RTC-NG/API/api_irtcengine_preloadchannel2.dita index 867d2fe1d14..4745841e659 100644 --- a/dita/RTC-NG/API/api_irtcengine_preloadchannel2.dita +++ b/dita/RTC-NG/API/api_irtcengine_preloadchannel2.dita @@ -72,7 +72,7 @@

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

                  • 0：方法调用成功。
                    • -
                  • < 0：方法调用失败。 +
                  • < 0：方法调用失败。详见了解详情和解决建议。
                    • -2：传入的参数无效。例如，User Account 为空。你需要填入有效的参数，重新加入频道。
                    • -7： 对象尚未初始化。你需要在调用该方法前成功初始化 对象。
                      • diff --git a/dita/RTC-NG/API/api_irtcengine_renewtoken.dita b/dita/RTC-NG/API/api_irtcengine_renewtoken.dita index 9675110101e..de0979c3e32 100644 --- a/dita/RTC-NG/API/api_irtcengine_renewtoken.dita +++ b/dita/RTC-NG/API/api_irtcengine_renewtoken.dita @@ -44,7 +44,7 @@

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

                      • 0: 方法调用成功。
                        • -
                      • < 0: 方法调用失败。 +
                      • < 0: 方法调用失败。详见了解详情和解决建议。
                        • -2：传入的参数无效。例如，使用了不合法的 Token。你需要填入有效的参数。
                          • diff --git a/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita b/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita index 78035ab72b9..36301971805 100644 --- a/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita +++ b/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita @@ -73,7 +73,7 @@

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

                          • 0: 方法调用成功。
                            • -
                          • < 0: 方法调用失败。 +
                          • < 0: 方法调用失败。详见了解详情和解决建议。
                            • -4：当前设备不支持该功能，可能的原因有：
                                diff --git a/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita b/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita index 7320a9e7e5c..95c7761aec8 100644 --- a/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita +++ b/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita @@ -71,7 +71,7 @@

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

                                • 0(ERR_OK) 方法调用成功。
                                  • -
                                • < 0 方法调用失败。 +
                                • < 0 方法调用失败。详见了解详情和解决建议。
                                  • -2: 参数无效。
                                  • -7: SDK 尚未初始化。
                                    • diff --git a/dita/RTC-NG/API/api_irtcengine_setclientrole.dita b/dita/RTC-NG/API/api_irtcengine_setclientrole.dita index a8fa650620b..72a5cc44723 100644 --- a/dita/RTC-NG/API/api_irtcengine_setclientrole.dita +++ b/dita/RTC-NG/API/api_irtcengine_setclientrole.dita @@ -60,7 +60,7 @@ 返回值
                                    • 0: 方法调用成功。
                                      • -
                                    • < 0: 方法调用失败。 +
                                    • < 0: 方法调用失败。详见了解详情和解决建议。
                                      • -1: 一般性的错误（未明确归类）。
                                        • diff --git a/dita/RTC-NG/API/api_irtcengine_setcloudproxy.dita b/dita/RTC-NG/API/api_irtcengine_setcloudproxy.dita index e66c7cda1a9..fe98c93d86a 100644 --- a/dita/RTC-NG/API/api_irtcengine_setcloudproxy.dita +++ b/dita/RTC-NG/API/api_irtcengine_setcloudproxy.dita @@ -60,7 +60,7 @@

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

                                        • 0: 方法调用成功。
                                          • -
                                        • < 0: 方法调用失败。 +
                                        • < 0: 方法调用失败。详见了解详情和解决建议。
                                          • -2: 传入的参数无效。
                                            • diff --git a/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita b/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita index 102134c5564..85fc8c68815 100644 --- a/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita +++ b/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita @@ -43,7 +43,7 @@

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

                                            • 0: 方法调用成功。
                                              • -
                                            • < 0: 方法调用失败。 +
                                            • < 0: 方法调用失败。详见了解详情和解决建议。
                                            diff --git a/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita b/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita index b343d16c879..89acb320053 100644 --- a/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita +++ b/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita @@ -65,7 +65,7 @@

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

                                            • 0：方法调用成功。
                                              • -
                                            • < 0：方法调用失败。 +
                                            • < 0：方法调用失败。详见了解详情和解决建议。
                                              • -1: 一般性的错误（未明确归类）。
                                              • -2: 参数无效。
                                                • diff --git a/dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithtranscoding.dita b/dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithtranscoding.dita index 2c9b316d596..d469d0ad38d 100644 --- a/dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithtranscoding.dita +++ b/dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithtranscoding.dita @@ -62,7 +62,7 @@

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

                                                • 0: 方法调用成功。
                                                  • -
                                                • < 0: 方法调用失败。 +
                                                • < 0: 方法调用失败。详见了解详情和解决建议。
                                                  • -2：url 为空或为长度为 0 的字符串。
                                                  • -7：调用该方法前，未初始化 SDK。
                                                    • diff --git a/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita b/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita index 5d735d35459..7e42d22d1a5 100644 --- a/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita +++ b/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita @@ -80,7 +80,7 @@

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

                                                    • 0: 方法调用成功。
                                                      • -
                                                    • < 0: 方法调用失败。 +
                                                    • < 0: 方法调用失败。详见了解详情和解决建议。
                                                      • -2：传入的参数无效。
                                                        • diff --git a/dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita b/dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita index 93877446516..60a753b8d8c 100644 --- a/dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita +++ b/dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita @@ -71,7 +71,7 @@

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

                                                        • 0: 方法调用成功。
                                                          • -
                                                        • < 0: 方法调用失败。 +
                                                        • < 0: 方法调用失败。详见了解详情和解决建议。
    diff --git a/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita b/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita index b1e7bd1abeb..489c782dc19 100644 --- a/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita +++ b/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita @@ -208,7 +208,7 @@

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

    • 0: 方法调用成功。
      • -
    • < 0: 方法调用失败。 +
    • < 0: 方法调用失败。详见了解详情和解决建议。
    diff --git a/dita/RTC-NG/API/api_irtcengine_stopechotest.dita b/dita/RTC-NG/API/api_irtcengine_stopechotest.dita index f0432bf9ce0..501e815409d 100644 --- a/dita/RTC-NG/API/api_irtcengine_stopechotest.dita +++ b/dita/RTC-NG/API/api_irtcengine_stopechotest.dita @@ -30,7 +30,7 @@