From fc8c00cc8e001ed5f61b4a022c089a13f5247d51 Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Wed, 17 Jul 2024 18:00:37 +0800 Subject: [PATCH 1/3] done --- dita/RTC-NG/API/api_imediaplayer_mute.dita | 11 +++++- dita/RTC-NG/API/api_imediaplayer_pause.dita | 10 ++++++ dita/RTC-NG/API/api_imediaplayer_play.dita | 12 +++++-- dita/RTC-NG/API/api_imediaplayer_seek.dita | 22 ++++++++---- .../API/api_imediaplayer_setplayeroption.dita | 25 +++++++++---- .../api_imediaplayer_setplayeroption2.dita | 16 +++++---- dita/RTC-NG/API/api_imediaplayer_setview.dita | 14 ++++++-- dita/RTC-NG/API/api_imediaplayer_stop.dita | 10 ++++++ ...api_irtcengine_getaudiomixingduration.dita | 19 ++++++---- ...rtcengine_getaudiomixingplayoutvolume.dita | 19 ++++++---- ...irtcengine_setaudiomixingdualmonomode.dita | 29 +++++++++------ ...api_irtcengine_setaudiomixingposition.dita | 17 ++++++--- .../RTC-NG/API/api_irtcengine_setlogfile.dita | 23 +++++++----- .../API/api_irtcengine_setloglevel.dita | 9 +++-- dita/RTC-NG/API/api_irtcengine_setview.dita | 35 ------------------- 15 files changed, 167 insertions(+), 104 deletions(-) delete mode 100644 dita/RTC-NG/API/api_irtcengine_setview.dita diff --git a/dita/RTC-NG/API/api_imediaplayer_mute.dita b/dita/RTC-NG/API/api_imediaplayer_mute.dita index 2783343aab8..3b6531dde04 100644 --- a/dita/RTC-NG/API/api_imediaplayer_mute.dita +++ b/dita/RTC-NG/API/api_imediaplayer_mute.dita @@ -25,7 +25,16 @@ Future<void> mute(bool muted);

-
+
+
+ 调用时机 +

该方法在加入频道前后均可调用。

+
+
+ 调用限制 +

无。

+
+
参数 diff --git a/dita/RTC-NG/API/api_imediaplayer_pause.dita b/dita/RTC-NG/API/api_imediaplayer_pause.dita index ffe2c66aea9..d02b4ea84cd 100644 --- a/dita/RTC-NG/API/api_imediaplayer_pause.dita +++ b/dita/RTC-NG/API/api_imediaplayer_pause.dita @@ -27,6 +27,16 @@ Future<void> pause();

+
+ +
+ 调用时机 +

该方法在加入频道前后均可调用。

+
+
+ 调用限制 +

无。

+
<ph keyref="return-section-title"/>

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

diff --git a/dita/RTC-NG/API/api_imediaplayer_play.dita b/dita/RTC-NG/API/api_imediaplayer_play.dita index 4c62017e493..caab91cf12e 100644 --- a/dita/RTC-NG/API/api_imediaplayer_play.dita +++ b/dita/RTC-NG/API/api_imediaplayer_play.dita @@ -25,10 +25,16 @@ Future<void> play();

-
- 详情 -

调用 或 后，你可以调用该方法播放媒体文件。

+
+
+ 调用时机 +

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

+
+
+ 调用限制 +

无。

+
<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..cbf191f8cd8 100644 --- a/dita/RTC-NG/API/api_imediaplayer_seek.dita +++ b/dita/RTC-NG/API/api_imediaplayer_seek.dita @@ -27,16 +27,26 @@ Future<void> seek(int newPos);

-
- 详情 -

成功调用该方法后，你会收到 回调，报告当前播放器发生的事件，如定位开始、定位成功或定位失败。

+

如果你想定位播放，请进行如下操作： -

    +
    1. 调用该方法定位。
    2. 定位完成后，调用 方法播放。
      3. -

+

+
+
+ 调用时机 +

该方法在加入频道前后均可调用。

+
+
+ 调用限制 +

无。

+
+ -
+
参数 diff --git a/dita/RTC-NG/API/api_imediaplayer_setplayeroption.dita b/dita/RTC-NG/API/api_imediaplayer_setplayeroption.dita index f4f5ee94d98..3205fc9b717 100644 --- a/dita/RTC-NG/API/api_imediaplayer_setplayeroption.dita +++ b/dita/RTC-NG/API/api_imediaplayer_setplayeroption.dita @@ -2,7 +2,7 @@ <ph keyref="setPlayerOption"/> - 设置媒体播放器选项，用于提供技术预览或特别定制功能。 + 设置媒体播放器选项。 @@ -23,13 +23,24 @@ Future<void> setPlayerOptionInInt({required String key, required int value});

-
- 详情 -

媒体播放器支持通过 key 和 value 来设置选项。一般情况下，你无需知晓选项设置，使用媒体播放器默认的选项设置即可。

+
+

媒体播放器支持通过 key 和 value 来设置选项。

该方法和 的区别在于，该方法的 value 是 Int 型， 的 value 是 String 型。二者不可混用。

- 请确保在 或 之前调用该方法。
-
- 参数 +
+
+ 适用场景 +

需要提供技术预览或特别定制功能的场景。一般情况下，你无需调用该方法，使用媒体播放器默认的选项设置即可。

+
+
+ 调用时机 +

该方法需要在 或 之前调用。

+
+
+ 调用限制 +

无。

+
+
+ 参数 key diff --git a/dita/RTC-NG/API/api_imediaplayer_setplayeroption2.dita b/dita/RTC-NG/API/api_imediaplayer_setplayeroption2.dita index c44db065ed8..55d5c9dd8a8 100644 --- a/dita/RTC-NG/API/api_imediaplayer_setplayeroption2.dita +++ b/dita/RTC-NG/API/api_imediaplayer_setplayeroption2.dita @@ -2,7 +2,7 @@ <ph keyref="setPlayerOption2"/> - 设置媒体播放器选项，用于提供技术预览或特别定制功能。 + 设置媒体播放器选项。 @@ -24,13 +24,17 @@ {required String key, required String value});

-
- 详情 +

该方法和 的区别在于，该方法的 value 是 String 型， 的 value 是 Int 型。二者不可混用。

-
-
-
+
+
+
+
+ 调用限制 +

无。

+
+
<ph keyref="return-section-title"/>

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

diff --git a/dita/RTC-NG/API/api_imediaplayer_setview.dita b/dita/RTC-NG/API/api_imediaplayer_setview.dita index 62d44bdd6e2..aa7c2dc49ee 100644 --- a/dita/RTC-NG/API/api_imediaplayer_setview.dita +++ b/dita/RTC-NG/API/api_imediaplayer_setview.dita @@ -30,9 +30,17 @@
在 Flutter 中你不需要主动调用该方法，请使用 渲染本地和远端视图。
-
- 参数 - +
+ 调用时机 +

该方法在加入频道前后均可调用。

+
+
+ 调用限制 +

无。

+
+
+ <ph props="native flutter unreal bp electron rn">参数</ph> + videoView view diff --git a/dita/RTC-NG/API/api_imediaplayer_stop.dita b/dita/RTC-NG/API/api_imediaplayer_stop.dita index 15cc6221c8d..5044317dafc 100644 --- a/dita/RTC-NG/API/api_imediaplayer_stop.dita +++ b/dita/RTC-NG/API/api_imediaplayer_stop.dita @@ -26,6 +26,16 @@ Future<void> stop();

+
+ +
+ 调用时机 +

该方法需要在 之后调用。

+
+
+ 调用限制 +

无。

+
<ph keyref="return-section-title"/>

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

diff --git a/dita/RTC-NG/API/api_irtcengine_getaudiomixingduration.dita b/dita/RTC-NG/API/api_irtcengine_getaudiomixingduration.dita index b5c3ca7c9d4..c4dd6b3ef1f 100644 --- a/dita/RTC-NG/API/api_irtcengine_getaudiomixingduration.dita +++ b/dita/RTC-NG/API/api_irtcengine_getaudiomixingduration.dita @@ -25,16 +25,21 @@ Future<int> getAudioMixingDuration();

-
- 详情 +

该方法获取音乐文件总时长，单位为毫秒。

- -

你需要在调用 并收到 () 回调后调用该方法。

-
-
+
+
+ 调用时机 +

该方法需要在 之后，并收到 () 回调后调用。

+
+
+ 调用限制 +

无。

+
+
返回值
    -
  • ≥ 0: 方法调用成功返回音乐文件时长。
    • +
  • ≥ 0: 方法调用成功则返回音乐文件时长。
  • < 0: 方法调用失败。详见了解详情和解决建议。
diff --git a/dita/RTC-NG/API/api_irtcengine_getaudiomixingplayoutvolume.dita b/dita/RTC-NG/API/api_irtcengine_getaudiomixingplayoutvolume.dita index 65dbb1c3e0b..635090956a5 100644 --- a/dita/RTC-NG/API/api_irtcengine_getaudiomixingplayoutvolume.dita +++ b/dita/RTC-NG/API/api_irtcengine_getaudiomixingplayoutvolume.dita @@ -25,13 +25,18 @@ Future<int> getAudioMixingPlayoutVolume();

-
- 详情 -

该方法获取混音的音乐文件本地播放音量，方便排查音量相关问题。

- -

你需要在调用 并收到() 回调后调用该方法。

-
-
+
+

你可以调用该方法获取混音的音乐文件的本地播放音量，方便排查音量相关问题。

+
+
+ 调用时机 +

该方法需要在 之后，并收到 () 回调后调用。

+
+
+ 调用限制 +

无。

+
+
返回值
  • ≥ 0: 方法调用成功则返回音量值，范围为 [0,100]。
    • diff --git a/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita b/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita index b33298c7c80..10459b4078d 100644 --- a/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita +++ b/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita @@ -25,16 +25,25 @@ Future<void> setAudioMixingDualMonoMode(AudioMixingDualMonoMode mode);

-
- 详情 -

在双声道音频文件中，左声道和右声道可以存储不同的音频数据。根据实际需要，你可以设置声道模式为原始模式、左声道模式、右声道模式或混合模式。例如，在 KTV 场景中，音频文件的左声道存储了伴奏，右声道存储了原唱的歌声。如果你只需听伴奏，调用该方法设置音频文件的声道模式为左声道模式；如果你需要同时听伴奏和原唱，调用该方法设置声道模式为混合模式。

- -
    -
  • 你需要在调用 并收到 () 回调后调用该方法。
    • -
  • 该方法仅适用于双声道的音频文件。
    • -
-
- 参数 +
+

在双声道音频文件中，左声道和右声道可以存储不同的音频数据。根据实际需要，你可以设置声道模式为原始模式、左声道模式、右声道模式或混合模式。

+
+
+ 适用场景 +

在 KTV 场景中，音频文件的左声道存储了伴奏，右声道存储了原唱的歌声。你可以根据实际需求进行设置：

    +
  • 如果你只需听伴奏，则用该方法设置音频文件的声道模式为左声道模式。
    • +
  • 如果你需要同时听伴奏和原唱，则调用该方法设置声道模式为混合模式。

+
+
+ 调用时机 +

该方法需要在 之后，并收到 () 回调后调用。

+
+
+ 调用限制 +

该方法仅适用于双声道的音频文件。

+
+
+ 参数 mode diff --git a/dita/RTC-NG/API/api_irtcengine_setaudiomixingposition.dita b/dita/RTC-NG/API/api_irtcengine_setaudiomixingposition.dita index 74b174938fc..52d053e20e4 100644 --- a/dita/RTC-NG/API/api_irtcengine_setaudiomixingposition.dita +++ b/dita/RTC-NG/API/api_irtcengine_setaudiomixingposition.dita @@ -25,12 +25,19 @@ Future<void> setAudioMixingPosition(int pos);

-
- 详情 +

该方法可以设置音频文件的播放位置，这样你可以根据实际情况播放文件，而非从头到尾播放整个文件。

- 你需要在调用 并收到 () 回调后调用该方法。
-
- 参数 +
+
+ 调用时机 +

该方法需要在 之后，并收到 () 回调后调用。

+
+
+ 调用限制 +

无。

+
+
+ 参数 pos diff --git a/dita/RTC-NG/API/api_irtcengine_setlogfile.dita b/dita/RTC-NG/API/api_irtcengine_setlogfile.dita index eeb2f17a80e..962fb765cb7 100644 --- a/dita/RTC-NG/API/api_irtcengine_setlogfile.dita +++ b/dita/RTC-NG/API/api_irtcengine_setlogfile.dita @@ -25,20 +25,25 @@ Future<void> setLogFile(String filePath);

-
- 详情 +
弃用：
-
此方法已废弃，请改用 中的 logConfigmLogConfig 参数设置日志文件路径。
+
该方法已废弃，请在调用 时通过 contextconfig 参数设置日志文件路径。
-

设置 SDK 的输出 log 文件。SDK 运行时产生的所有 log 将写入该文件。App 必须保证指定的目录存在而且可写。

- -

如需调用本方法，请在调用 方法初始化 对象后立即调用，否则输出日志可能不完整。

-
-
- 参数 +

设置 SDK 的输出 log 文件。SDK 运行时产生的所有 log 将写入该文件。

+
+
+ 调用时机 +

该方法需要在 后立即调用，否则输出日志可能不完整。

+
+
+ 调用限制 +

App 必须保证指定的目录存在而且可写。

+
+
+ 参数 filePath diff --git a/dita/RTC-NG/API/api_irtcengine_setloglevel.dita b/dita/RTC-NG/API/api_irtcengine_setloglevel.dita index 5fa3a974fd0..7d982394b26 100644 --- a/dita/RTC-NG/API/api_irtcengine_setloglevel.dita +++ b/dita/RTC-NG/API/api_irtcengine_setloglevel.dita @@ -26,22 +26,21 @@ Future<void> setLogLevel(LogLevel level);

-
- 详情 +
弃用：
-
该方法已经废弃。请改用 设置日志输出级别。
+
该方法已废弃，请在调用 时通过 contextconfig 参数设置日志输出级别。

选择一个级别，你就可以看到该级别的日志信息。

-
+
参数 level - 日志级别: 。 + 日志级别。详见 。
diff --git a/dita/RTC-NG/API/api_irtcengine_setview.dita b/dita/RTC-NG/API/api_irtcengine_setview.dita deleted file mode 100644 index d90a9336104..00000000000 --- a/dita/RTC-NG/API/api_irtcengine_setview.dita +++ /dev/null @@ -1,35 +0,0 @@ - - - - <ph keyref="setView"/> - 设置视频渲染。 - - - - - - - - -
-

- - - - - - - - -

-
-
- 参数 - - - renderConfig - 视频渲染配置。详见 。 - -
- - From 22f1babc32384038b7514c50d011314997a53c8a Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Tue, 30 Jul 2024 09:56:52 +0800 Subject: [PATCH 2/3] 1 --- dita/RTC-NG/API/api_imediaplayer_play.dita | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dita/RTC-NG/API/api_imediaplayer_play.dita b/dita/RTC-NG/API/api_imediaplayer_play.dita index caab91cf12e..1da8efcc464 100644 --- a/dita/RTC-NG/API/api_imediaplayer_play.dita +++ b/dita/RTC-NG/API/api_imediaplayer_play.dita @@ -28,7 +28,7 @@
调用时机 -

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

+

该方法需要在 、 或 之后调用。

调用限制 From 16ce4d59a649a6581755ed02ff325d060c2de3fa Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Tue, 30 Jul 2024 10:51:18 +0800 Subject: [PATCH 3/3] 1 --- dita/RTC-NG/API/api_imediaplayer_play.dita | 1 - 1 file changed, 1 deletion(-) diff --git a/dita/RTC-NG/API/api_imediaplayer_play.dita b/dita/RTC-NG/API/api_imediaplayer_play.dita index ec7ad86656b..0446ed0effb 100644 --- a/dita/RTC-NG/API/api_imediaplayer_play.dita +++ b/dita/RTC-NG/API/api_imediaplayer_play.dita @@ -35,7 +35,6 @@ 调用限制

无。

-
<ph keyref="return-section-title"/>

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