From 4661664cfbcccd7562467390eef8b25445ced63f Mon Sep 17 00:00:00 2001 From: Nero-Hu Date: Thu, 1 Aug 2024 17:09:05 +0800 Subject: [PATCH 1/3] add batch 6 --- ...laudioengine_updateplayerpositioninfo.dita | 13 ++++++-- .../API/api_imediaplayer_getstreaminfo.dita | 14 +++++--- ...iaplayer_registerplayersourceobserver.dita | 11 ++++++- .../api_irtcengine_isspeakerphoneenabled.dita | 2 +- ...ne_setdefaultaudioroutetospeakerphone.dita | 27 ++++++++------- .../api_irtcengine_setenablespeakerphone.dita | 32 ++++++++++++------ ...rtcengine_setrouteincommunicationmode.dita | 22 +++++++++---- .../API/api_irtcengine_takesnapshot.dita | 33 ++++++++++++------- .../API/api_irtcengineex_takesnapshotex.dita | 22 +++++-------- 9 files changed, 115 insertions(+), 61 deletions(-) diff --git a/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita b/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita index 74f1758507e..4405d8dffa1 100644 --- a/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita +++ b/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita @@ -32,11 +32,18 @@ {required int playerId, required RemoteVoicePositionInfo positionInfo});

-
- 详情 +

成功更新后，本地用户可以听到媒体播放器空间位置的变化。

-
+
+ 调用时机 +

加入频道前后均可调用。

+
+
+ 调用限制 +

无。

+
+
参数 diff --git a/dita/RTC-NG/API/api_imediaplayer_getstreaminfo.dita b/dita/RTC-NG/API/api_imediaplayer_getstreaminfo.dita index 296d1daeb31..026242bf007 100644 --- a/dita/RTC-NG/API/api_imediaplayer_getstreaminfo.dita +++ b/dita/RTC-NG/API/api_imediaplayer_getstreaminfo.dita @@ -25,10 +25,16 @@ Future<PlayerStreamInfo> getStreamInfo(int index);

-
- 详情 - 你需要在 后调用该方法。
-
+
+
+ 调用时机 +

你需要在 后调用该方法。

+
+
+ 调用限制 +

无。

+
+
参数 diff --git a/dita/RTC-NG/API/api_imediaplayer_registerplayersourceobserver.dita b/dita/RTC-NG/API/api_imediaplayer_registerplayersourceobserver.dita index b8895544c06..9a41cbda07d 100644 --- a/dita/RTC-NG/API/api_imediaplayer_registerplayersourceobserver.dita +++ b/dita/RTC-NG/API/api_imediaplayer_registerplayersourceobserver.dita @@ -30,7 +30,16 @@ void registerPlayerSourceObserver(MediaPlayerSourceObserver observer);

-
+
+
+ 调用时机 +

加入频道前后均可调用。

+
+
+ 调用限制 +

无。

+
+
参数 diff --git a/dita/RTC-NG/API/api_irtcengine_isspeakerphoneenabled.dita b/dita/RTC-NG/API/api_irtcengine_isspeakerphoneenabled.dita index 5233230cbd9..687beff3961 100644 --- a/dita/RTC-NG/API/api_irtcengine_isspeakerphoneenabled.dita +++ b/dita/RTC-NG/API/api_irtcengine_isspeakerphoneenabled.dita @@ -25,7 +25,7 @@ Future<bool> isSpeakerphoneEnabled();

-
+
  • 该方法仅适用于 Android 和 iOS。
    • diff --git a/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita b/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita index 459339c489a..1a3da7bb91a 100644 --- a/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita +++ b/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita @@ -30,30 +30,35 @@ Future<void> setDefaultAudioRouteToSpeakerphone(bool defaultToSpeaker);

-
- 详情 +
-
    -
  • 该方法仅适用于 Android 和 iOS 平台。
    • -
  • 该方法需要在加入频道前调用。如需在加入频道后切换音频路由，请调用 。
    • -
+

该方法仅适用于 Android 和 iOS 平台。

手机设备一般有两个音频路由，一个是位于顶部的听筒，播放声音偏小；一个是位于底部的扬声器，播放声音偏大。设置默认的音频路由，就是在没有外接设备的前提下，设置系统使用听筒还是扬声器播放音频。

不同场景下，系统默认的音频路由也不同。具体如下： - - -

  • 语音通话：听筒
  • 语音直播：扬声器
  • 视频通话：扬声器
  • 视频直播：扬声器

-

调用该 API 可以改变上述默认音频路由。成功改变音频路由后，SDK 会触发 回调。

+

调用该 API 可以改变上述默认音频路由。

当手机插入外接设备，如蓝牙设备或耳机时，系统的音频路由会发生改变。详细的路由变化规律请参考 音频路由。
-
+
+ 调用时机 +

该方法需要在加入频道前调用。如需在加入频道后切换音频路由，请调用 。

+
+
+ 调用限制 +

无。

+
+ +
参数 diff --git a/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita b/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita index ccc00d6354b..0688edbd0d7 100644 --- a/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita +++ b/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita @@ -23,18 +23,30 @@ public abstract int SetEnableSpeakerphone(bool speakerOn); abstract setEnableSpeakerphone(speakerOn: boolean): number; Future<void> setEnableSpeakerphone(bool speakerOn);

-
- 详情 -

如果 SDK 默认的音频路由或 的设置无法满足你的需求，你可以调用 切换当前的音频路由。成功改变音频路由后，SDK 会触发 回调。

+

不同场景下 SDK 默认的音频路由见音频路由。

-

该方法只设置用户在当前频道内使用的音频路由，不会影响 SDK 默认的音频路由。如果用户离开当前频道并加入新的频道，则用户还是会使用 SDK 默认的音频路由。

- + 该方法仅适用于 Android 和 iOS 平台。 +
+
+ 适用场景 +

如果 SDK 默认的音频路由或 的设置无法满足你的需求，你可以调用该方法切换当前的音频路由。

+
+
+ 调用时机 +

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

+
+
+ 调用限制
    -
  • 该方法仅适用于 Android 和 iOS 平台。
    • -
  • 该方法需要在加入频道后调用。
    • -
  • 如果用户使用了蓝牙耳机、有线耳机等外接音频播放设备，则该方法的设置无效，音频只会通过外接设备播放。当有多个外接设备时，音频会通过最后一个接入的设备播放。
    • -
-
+
  • 该方法只设置用户在当前频道内使用的音频路由，不会影响 SDK 默认的音频路由。如果用户离开当前频道并加入新的频道，则用户还是会使用 SDK 默认的音频路由。
    • +
  • 如果用户使用了蓝牙耳机、有线耳机等外接音频播放设备，则该方法的设置无效，音频只会通过外接设备播放。当有多个外接设备时，音频会通过最后一个接入的设备播放。
    • + +
    + +
    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_setrouteincommunicationmode.dita b/dita/RTC-NG/API/api_irtcengine_setrouteincommunicationmode.dita index 7c535a8116b..33b318df6a5 100644 --- a/dita/RTC-NG/API/api_irtcengine_setrouteincommunicationmode.dita +++ b/dita/RTC-NG/API/api_irtcengine_setrouteincommunicationmode.dita @@ -22,19 +22,29 @@ abstract setRouteInCommunicationMode(route: number): number; Future<void> setRouteInCommunicationMode(int route);

    -
    - 详情 +
    自从
    v4.2.2
    -

    该方法用于在通话音量模式（）下，将音频路由从蓝牙耳机切换为听筒、有线耳机或扬声器。该方法调用成功后，SDK 会触发 回调，报告修改后的路由。

    - 该方法与 同时使用时可能引起冲突。声网建议你单独使用 。 -
    • 该方法仅适用于 Android。
    • 该方法与 同时使用时可能引起冲突。声网建议你单独使用 。
     +

    该方法用于在通话音量模式（）下，将音频路由从蓝牙耳机切换为听筒、有线耳机或扬声器。

    +
      该方法仅适用于 Android。
    -
    +
    + 调用时机 +

    加入频道前后均可调用。

    +
    +
    + 调用限制 +

    该方法与 同时使用时可能引起冲突。声网建议你单独使用 。

    +
    + +
    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita b/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita index b4e1e55e1ee..0e4d99cd162 100644 --- a/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita +++ b/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita @@ -25,18 +25,27 @@ Future<void> takeSnapshot({required int uid, required String filePath});

    -
    - 详情 -

    该方法用于对指定用户的视频流进行截图，生成一张 JPG 格式的图片，并保存至指定的路径。

    -

    该方法是异步操作，调用返回时 SDK 并没有真正获取截图。成功调用该方法后，SDK 会触发 回调报告截图是否成功和获取截图的详情。

    -

    调用该方法返回时 SDK 并没有真正获取截图。成功调用该方法后，SDK 会触发 回调报告截图是否成功和获取截图的详情。

    - -
      -
    • 该方法需要在加入频道后调用。
      • -
    • 该方法用于本地视频截图时，是对 中指定发布的视频流进行截图。
      • -
    • 如果用户的视频经过前处理，例如，添加了水印或美颜，生成的截图会包含前处理效果。
      • -
    -
    +
    +

    该方法用于对指定用户的视频流进行截图，生成一张 JPG 格式的图片，并保存至指定的路径。

    +
    +
    + 调用时机 +

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

    +
    +
    + 调用限制 +
      +
    • 该方法是异步操作，调用返回时 SDK 并没有真正获取截图。
      • +
    • 调用该方法返回时 SDK 并没有真正获取截图。
      • +
    • 该方法用于本地视频截图时，是对 中指定发布的视频流进行截图。
      • +
    • 如果用户的视频经过前处理，例如，添加了水印或美颜，生成的截图会包含前处理效果。
      • +
    +
    + +
    参数 diff --git a/dita/RTC-NG/API/api_irtcengineex_takesnapshotex.dita b/dita/RTC-NG/API/api_irtcengineex_takesnapshotex.dita index ed48b5fb8c4..3d0cfe77280 100644 --- a/dita/RTC-NG/API/api_irtcengineex_takesnapshotex.dita +++ b/dita/RTC-NG/API/api_irtcengineex_takesnapshotex.dita @@ -2,7 +2,7 @@ <ph keyref="takeSnapshotEx"/> - 获取视频截图。 + 使用连接 ID 获取视频截图。 @@ -36,18 +36,14 @@ required String filePath});

    -
    - 详情 -

    -

    -

    调用该方法返回时 SDK 并没有真正获取截图。成功调用该方法后，SDK 会触发 回调报告截图是否成功和获取截图的详情。

    - -
      -
    • 该方法需要在调用 后调用。
      • -
    • 该方法用于本地视频截图时，是对 中指定发布的视频流进行截图。
      • -
    • 如果用户的视频经过前处理，例如，添加了水印或美颜，生成的截图会包含前处理效果。
      • -
    -
    +
    +
    + 调用时机 +

    该方法需要在调用 后调用。

    +
    +
    + +
    + 调用时机 +

    该方法在加入频道前后都能调用。

    +
    +
    + 调用限制 +

    无。

    +
    返回值
      diff --git a/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita b/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita index 1a3da7bb91a..57adedd7a68 100644 --- a/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita +++ b/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita @@ -31,9 +31,7 @@

    - -

    该方法仅适用于 Android 和 iOS 平台。

    -     + 该方法仅适用于 Android 和 iOS 平台。

    手机设备一般有两个音频路由，一个是位于顶部的听筒，播放声音偏小；一个是位于底部的扬声器，播放声音偏大。设置默认的音频路由，就是在没有外接设备的前提下，设置系统使用听筒还是扬声器播放音频。

    不同场景下，系统默认的音频路由也不同。具体如下：

      @@ -44,11 +42,11 @@

    调用该 API 可以改变上述默认音频路由。

    -

    当手机插入外接设备，如蓝牙设备或耳机时，系统的音频路由会发生改变。详细的路由变化规律请参考 音频路由。

    +

    在调用该方法设置默认音频路由后，系统实际音频路由会随着外接音频设备（有线耳机或蓝牙耳机）的连接发生改变。详见。
    调用时机 -

    该方法需要在加入频道前调用。如需在加入频道后切换音频路由，请调用 。

    +

    该方法需要在加入频道前调用。如需在加入频道后切换音频路由，请调用 。

    调用限制 @@ -56,7 +54,7 @@
    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita b/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita index 0688edbd0d7..385deb44f24 100644 --- a/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita +++ b/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita @@ -24,7 +24,7 @@ abstract setEnableSpeakerphone(speakerOn: boolean): number; Future<void> setEnableSpeakerphone(bool speakerOn);

    -

    不同场景下 SDK 默认的音频路由见音频路由。

    +

    不同场景下 SDK 默认的音频路由见。

    该方法仅适用于 Android 和 iOS 平台。
    @@ -44,7 +44,7 @@
    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_setrouteincommunicationmode.dita b/dita/RTC-NG/API/api_irtcengine_setrouteincommunicationmode.dita index 33b318df6a5..2523d131fa9 100644 --- a/dita/RTC-NG/API/api_irtcengine_setrouteincommunicationmode.dita +++ b/dita/RTC-NG/API/api_irtcengine_setrouteincommunicationmode.dita @@ -30,7 +30,7 @@

    该方法用于在通话音量模式（）下，将音频路由从蓝牙耳机切换为听筒、有线耳机或扬声器。

    -
      该方法仅适用于 Android。 + 该方法仅适用于 Android。
    调用时机 @@ -42,7 +42,7 @@
    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita b/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita index 0e4d99cd162..588f8f4dd3b 100644 --- a/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita +++ b/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita @@ -43,7 +43,7 @@
    参数 @@ -55,13 +55,15 @@ filePath -

    截图的本地保存路径，需精确到文件名及格式， 例如： +

    截图的本地保存路径，需精确到文件名及格式，例如：

    • Windows: C:\Users\<user_name>\AppData\Local\Agora\<process_name>\example.jpg
    • iOS: /App Sandbox/Library/Caches/example.jpg
    • macOS: ～/Library/Logs/example.jpg
    • Android: /storage/emulated/0/Android/data/<package name>/files/example.jpg
      • -
    请确保目录存在且可写。

    + +

    + 请确保目录存在且可写。
    diff --git a/dita/RTC-NG/API/api_irtcengineex_takesnapshotex.dita b/dita/RTC-NG/API/api_irtcengineex_takesnapshotex.dita index 3d0cfe77280..093f7d085ce 100644 --- a/dita/RTC-NG/API/api_irtcengineex_takesnapshotex.dita +++ b/dita/RTC-NG/API/api_irtcengineex_takesnapshotex.dita @@ -39,7 +39,7 @@
    调用时机 -

    该方法需要在调用 后调用。

    +

    该方法需要在 后调用。

    -
    - 该方法仅适用于 Android 和 iOS。 +
    + 该方法仅适用于 Android 和 iOS。
    调用时机