From 4c95a03f152ceaebb8d3c1431abd8ebc55782883 Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Thu, 4 Jul 2024 16:12:25 +0800 Subject: [PATCH 1/3] ld batch3 --- ...ine_registervideoencodedframeobserver.dita | 2 +- ...ediaengine_registervideoframeobserver.dita | 31 +++++++++------- .../API/api_irtcengine_enableencryption.dita | 23 ++++++++---- ...rtcengine_enableinstantmediarendering.dita | 14 +++++--- dita/RTC-NG/API/api_irtcengine_getcallid.dita | 17 ++++++--- .../api_irtcengine_setlocalrendermode2.dita | 35 ++++++++++++------- ...ngine_setremotedefaultvideostreamtype.dita | 21 ++++++----- .../API/api_irtcengine_setuplocalvideo.dita | 28 ++++++++++----- .../api_irtcengineex_enableencryptionex.dita | 13 +++---- .../API/api_irtcengineex_getcallidex.dita | 12 ++++--- dita/RTC-NG/API/enum_rendermodetype.dita | 4 +-- 11 files changed, 129 insertions(+), 71 deletions(-) diff --git a/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita b/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita index eabcb6fd32f..8f4452dbdef 100644 --- a/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita +++ b/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita @@ -46,7 +46,7 @@

参数 diff --git a/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita b/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita index 165007c38ad..d766b25831d 100644 --- a/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita +++ b/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita @@ -23,24 +23,29 @@ void registerVideoFrameObserver(VideoFrameObserver observer);

-
- 详情 +

如果你想要观测原始视频帧 (如 YUV 或 RGBA 格式)，声网推荐你通过该方法注册一个 类。

调用该方法注册视频观测器时，你可以根据需要注册 类中的回调。在成功注册视频观测器后，SDK 会在捕捉到每个视频帧时，触发你所注册的上述回调。

- -

+
+ 适用场景 +

注册原始视频观测器后，你可以将获取到的原始视频数据应用于各种视频前处理场景，例如自行实现虚拟背景、美颜等场景。

+

声网在 GitHub 上提供了开源的示例项目 供你参考。

+
+
+ 调用时机 +

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

+
+
+ 调用限制 +

在处理回调时，你需要考虑视频帧中 width 和 height 参数的变化，因为观测得到的视频帧可能会随以下情况变化： +

- - 注册原始视频观测器后，你可以将获取到的原始视频数据应用于各种视频前处理场景，例如自行实现虚拟背景、美颜等场景，声网在 GitHub 上提供了开源的示例项目 供你参考。 -
-
+

+
+
参数 diff --git a/dita/RTC-NG/API/api_irtcengine_enableencryption.dita b/dita/RTC-NG/API/api_irtcengine_enableencryption.dita index d402b51f5e0..6d084d2cf2f 100644 --- a/dita/RTC-NG/API/api_irtcengine_enableencryption.dita +++ b/dita/RTC-NG/API/api_irtcengine_enableencryption.dita @@ -26,12 +26,23 @@ {required bool enabled, required EncryptionConfig config});

-
- 详情 -

在安全要求较高的场景下，建议你在加入频道前，调用本方法开启内置加密。

-

同一频道内所有用户必须使用相同的加密模式和密钥。用户离开频道后，SDK 会自动关闭加密。如需重新开启加密，你需要在用户再次加入频道前调用该方法。

- 如果开启了内置加密，则不能使用旁路推流功能。
-
+
+

用户离开频道后，SDK 会自动关闭加密。如需重新开启加密，你需要在用户再次加入频道前调用该方法。

+
+
+ 适用场景 +

对安全要求较高的场景。

+
+
+ 调用时机 +

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

+
+
+ 调用限制 +
  • 同一频道内的所有用户在调用该方法时，必须设置相同的加密模式和密钥。
    • +
  • 如果开启了内置加密，则不能使用旁路推流功能。
+
+
参数 diff --git a/dita/RTC-NG/API/api_irtcengine_enableinstantmediarendering.dita b/dita/RTC-NG/API/api_irtcengine_enableinstantmediarendering.dita index c4f1e2f7be0..324c6664bea 100644 --- a/dita/RTC-NG/API/api_irtcengine_enableinstantmediarendering.dita +++ b/dita/RTC-NG/API/api_irtcengine_enableinstantmediarendering.dita @@ -24,8 +24,7 @@ abstract enableInstantMediaRendering(): number; Future<void> enableInstantMediaRendering();

-
- 详情 +
自从
@@ -33,12 +32,19 @@

成功调用该方法后，SDK 会开启加速出图和出声模式，可加快用户加入频道后的首帧出图与出声速度。

- 一旦开启快速渲染功能，只能通过调用 方法销毁 对象来取消。
-
+
适用场景

声网推荐在直播场景下，对观众开启该模式。

+
+ 调用时机 +

声网建议你在加入频道前调用该方法。

+
+
+ 调用限制 +

一旦成功调用该方法，只能通过调用 方法销毁 对象来取消。

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

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

diff --git a/dita/RTC-NG/API/api_irtcengine_getcallid.dita b/dita/RTC-NG/API/api_irtcengine_getcallid.dita index d84706b68be..ea92738818c 100644 --- a/dita/RTC-NG/API/api_irtcengine_getcallid.dita +++ b/dita/RTC-NG/API/api_irtcengine_getcallid.dita @@ -25,12 +25,19 @@ Future<String> getCallId();

-
- 详情 +

客户端在每次加入频道后会生成一个对应的 callId，标识该客户端的此次通话。你可以调用该方法获取 callId 参数，然后在调用 、 等方法时填入。

- 该方法需要在加入频道后调用。
-
- 参数 +
+
+ 调用时机 +

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

+
+
+ 调用限制 +

无。

+
+
+ 参数 callId diff --git a/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita b/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita index ab6398eae89..34147f0d7f2 100644 --- a/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita +++ b/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita @@ -35,17 +35,21 @@ VideoMirrorModeType.videoMirrorModeAuto});

-
- 详情 +

初始化本地用户视图后，你可以调用该方法更新本地用户视图的渲染和镜像模式。该方法只影响本地用户看到的视频画面，不影响本地发布视频。

- -
    -
  • 请在调用 方法初始化本地视图后，调用该方法。
    • -
  • 你可以在通话中多次调用该方法，多次更新本地用户视图的显示模式。
    • -
  • 该方法仅对第一个摄像头 () 生效。在自定义视频采集或使用其他类型视频源的场景下，你需要使用 方法替代该方法。
    • -
-
- 参数 +
+
+ 调用时机 +
  • 请在调用 方法初始化本地视图后，调用该方法。
    • +
  • 你可以在通话中多次调用该方法，多次更新本地用户视图的显示模式。
+
+
+ 调用限制 +

该方法仅对第一个摄像头 () 生效。在自定义视频采集或使用其他类型视频源的场景下，你需要使用 方法替代该方法。

+

无。

+
+
+ 参数 renderMode @@ -57,12 +61,19 @@
  • (1)：优先保证视窗被填满。视频尺寸等比缩放，直至整个视窗被视频填满。如果视频长宽与显示窗口不同，多出的视频将被截掉。
  • (2)：优先保证视频内容全部显示。视频尺寸等比缩放，直至视频窗口的一边与视窗边框对齐。如果视频长宽与显示窗口不同，视窗上未被填满的区域将被涂黑。
    • -
  • (3): 该模式已废弃，不推荐使用。
    • +
  • (3): 匹配模式。 +
    + +
    弃用：
    +
    该枚举已废弃，不推荐使用。
    +     +
    +

- mirrorMode + mirrorMode mirror

本地视图的镜像模式，详见 。 diff --git a/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype.dita b/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype.dita index 91ed6bad90e..b3e15f8f1ad 100644 --- a/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype.dita +++ b/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype.dita @@ -25,8 +25,7 @@ Future<void> setRemoteDefaultVideoStreamType(VideoStreamType streamType);

-
- 详情 +
弃用：
@@ -35,13 +34,17 @@

- -

    -
  • 该方法只能在加入频道前调用。SDK 不支持你在加入频道后修改默认订阅的视频流类型。
    • -
  • 如果你既调用了该方法，也调用了 ，则 SDK 以 中的设置为准。
    • -
-
- 参数 +
+
+ 调用时机 +

该方法只能在加入频道前调用。SDK 不支持你在加入频道后修改默认订阅的视频流类型。

+
+
+ 调用限制 +

如果你既调用了该方法，也调用了 ，则 SDK 以 中的设置为准。

+
+
+ 参数 streamType diff --git a/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita b/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita index 131d4c59a8c..3ab5c1e05f9 100644 --- a/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita +++ b/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita @@ -17,7 +17,7 @@ public abstract setupLocalVideo(canvas: VideoCanvas): number; - (int)setupLocalVideo:(AgoraRtcVideoCanvas * _Nullable)local; virtual int setupLocalVideo(const VideoCanvas& canvas) = 0; - UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") + UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") int SetupLocalVideo(const FVideoCanvas& canvas); abstract setupLocalVideo(canvas: VideoCanvas): number; public abstract int SetupLocalVideo(VideoCanvas canvas); @@ -25,24 +25,34 @@ Future<void> setupLocalVideo(VideoCanvas canvas);

-
- 详情 +

该方法初始化本地视图并设置本地用户视频显示属性，只影响本地用户看到的视频画面，不影响本地发布视频。调用该方法绑定本地视频流的显示视窗(view)，并设置本地用户视图的渲染模式和镜像模式。

-

在 App 开发中，通常在初始化后调用该方法进行本地视频设置，然后再加入频道。退出频道后，绑定仍然有效，如果需要解除绑定，可以调用该方法将参数 view 设为 。

-

在实时互动场景下，如果你需要在本地视频预览的画面中同时看到多个预览画面、且不同画面分别处于视频链路上不同观测点，可以重复调用该方法设置不同的 view，并针对每个 view 设置不同的观测位置。例如：将视频源设置为摄像头，然后对应两个 view 分别设置 position 为 和 ，即可在本地视频预览中同时看到没有经过视频前处理的原始画面和已经过视频前处理（美颜、虚拟背景、水印本地预览）的画面。

+

退出频道后，绑定仍然有效，如果需要解除绑定，可以调用该方法将参数 view 设为 。

  • 如果你想要在原生窗口上渲染图像，请调用此方法；如果你仅需在 Unity 项目内渲染图像，可直接通过 类来实现。
    • -
  • 该方法在加入频道前后都能调用。
  • 如果你希望在通话中更新本地用户视图的渲染或镜像模式，请使用 方法。
  • 如果想要停止渲染视图，需要将 view 设为 后再次调用该方法，以停止渲染并清理渲染缓存。
-
- 参数 +
+ 适用场景 +

在 App 开发中，通常在初始化后调用该方法进行本地视频设置，然后再加入频道。

+

如果你需要在本地视频预览的画面中同时看到多个预览画面、且不同画面分别处于视频链路上不同观测点，可以重复调用该方法设置不同的 view，并针对每个 view 设置不同的观测位置。例如：将视频源设置为摄像头，然后对应两个 view 分别设置 position 为 和 ，即可在本地视频预览中同时看到没有经过视频前处理的原始画面和已经过视频前处理（美颜、虚拟背景、水印本地预览）的画面。

+
+
+ 调用时机 +

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

+
+
+ 调用限制 +

无。

+
+
+ 参数 - canvas + canvas local 本地视频显示属性。详见 。 diff --git a/dita/RTC-NG/API/api_irtcengineex_enableencryptionex.dita b/dita/RTC-NG/API/api_irtcengineex_enableencryptionex.dita index 2128f7e4a26..34d3fbb33ac 100644 --- a/dita/RTC-NG/API/api_irtcengineex_enableencryptionex.dita +++ b/dita/RTC-NG/API/api_irtcengineex_enableencryptionex.dita @@ -35,19 +35,20 @@ required bool enabled, required EncryptionConfig config});

-
- 详情 +
自从
v4.3.1
-

-

+

用户离开频道后，SDK 会自动关闭加密。如需重新开启加密，你需要在用户再次加入频道前调用该方法。

-
- 参数 +
+
+
+
+ 参数 diff --git a/dita/RTC-NG/API/api_irtcengineex_getcallidex.dita b/dita/RTC-NG/API/api_irtcengineex_getcallidex.dita index 2350e31c4cf..fa19a1fb744 100644 --- a/dita/RTC-NG/API/api_irtcengineex_getcallidex.dita +++ b/dita/RTC-NG/API/api_irtcengineex_getcallidex.dita @@ -23,8 +23,7 @@ abstract getCallIdEx(connection: RtcConnection): string; Future<String> getCallIdEx(RtcConnection connection);

-
- 详情 +
自从
@@ -32,9 +31,14 @@

-

-
+
+
+
+ 调用限制 +

无。

+
+
参数 diff --git a/dita/RTC-NG/API/enum_rendermodetype.dita b/dita/RTC-NG/API/enum_rendermodetype.dita index 6d2d1bb2306..e9ceffe5f26 100644 --- a/dita/RTC-NG/API/enum_rendermodetype.dita +++ b/dita/RTC-NG/API/enum_rendermodetype.dita @@ -21,11 +21,11 @@ - + 3：匹配模式。
弃用：
-
3: 该模式已弃用。
+
该枚举已废弃，不推荐使用。
From f18e862b8826fb2f169e35e0940483dc5308e7f2 Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Tue, 9 Jul 2024 16:53:36 +0800 Subject: [PATCH 2/3] resolve review comments --- .../api_irtcengine_enableinstantmediarendering.dita | 2 +- .../API/api_irtcengine_setlocalrendermode2.dita | 12 ++++++------ dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita | 6 +++--- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/dita/RTC-NG/API/api_irtcengine_enableinstantmediarendering.dita b/dita/RTC-NG/API/api_irtcengine_enableinstantmediarendering.dita index 324c6664bea..cbdde23cbfb 100644 --- a/dita/RTC-NG/API/api_irtcengine_enableinstantmediarendering.dita +++ b/dita/RTC-NG/API/api_irtcengine_enableinstantmediarendering.dita @@ -43,7 +43,7 @@
调用限制 -

一旦成功调用该方法，只能通过调用 方法销毁 对象来取消。

+

一旦成功调用该方法，只能通过调用 方法销毁 对象来取消加速渲染。

<ph keyref="return-section-title"/> diff --git a/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita b/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita index 34147f0d7f2..c1fbd70142f 100644 --- a/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita +++ b/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita @@ -36,16 +36,16 @@

-

初始化本地用户视图后，你可以调用该方法更新本地用户视图的渲染和镜像模式。该方法只影响本地用户看到的视频画面，不影响本地发布视频。

+

初始化本地用户视图后，你可以调用该方法更新本地用户视图的渲染和镜像模式。该方法只影响本地用户看到的视频画面，不影响本地视频的发布。

- 调用时机 -
  • 请在调用 方法初始化本地视图后，调用该方法。
    • + <ph props="native unreal bp electron rn flutter">调用时机</ph> +
    • 请在调用 方法初始化本地视图后，调用该方法。
    • 你可以在通话中多次调用该方法，多次更新本地用户视图的显示模式。
- 调用限制 -

该方法仅对第一个摄像头 () 生效。在自定义视频采集或使用其他类型视频源的场景下，你需要使用 方法替代该方法。

+ <ph props="native unreal bp electron rn flutter">调用限制</ph> +

该方法仅对第一个摄像头 () 生效。在自定义视频采集或使用其他类型视频源的场景下，你需要使用 方法替代该方法。

无。

@@ -61,7 +61,7 @@
  • (1)：优先保证视窗被填满。视频尺寸等比缩放，直至整个视窗被视频填满。如果视频长宽与显示窗口不同，多出的视频将被截掉。
  • (2)：优先保证视频内容全部显示。视频尺寸等比缩放，直至视频窗口的一边与视窗边框对齐。如果视频长宽与显示窗口不同，视窗上未被填满的区域将被涂黑。
    • -
  • (3): 匹配模式。 +
  • (3)：匹配模式。
    弃用：
    diff --git a/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita b/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita index 3ab5c1e05f9..d4b11625013 100644 --- a/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita +++ b/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita @@ -26,14 +26,14 @@

-

该方法初始化本地视图并设置本地用户视频显示属性，只影响本地用户看到的视频画面，不影响本地发布视频。调用该方法绑定本地视频流的显示视窗(view)，并设置本地用户视图的渲染模式和镜像模式。

+

该方法初始化本地视图并设置本地用户视频显示属性，只影响本地用户看到的视频画面，不影响本地视频的发布。调用该方法绑定本地视频流的显示视窗(view)，并设置本地用户视图的渲染模式和镜像模式。

退出频道后，绑定仍然有效，如果需要解除绑定，可以调用该方法将参数 view 设为 。

  • 如果你想要在原生窗口上渲染图像，请调用此方法；如果你仅需在 Unity 项目内渲染图像，可直接通过 类来实现。
    • -
  • 如果你希望在通话中更新本地用户视图的渲染或镜像模式，请使用 方法。
    • -
  • 如果想要停止渲染视图，需要将 view 设为 后再次调用该方法，以停止渲染并清理渲染缓存。
    • +
  • 如果你希望在通话中仅更新本地用户视图的渲染或镜像模式，请使用 方法。
    • +
  • 如果想要停止渲染视图，需要在调用该方法时将 view 设为 ，以停止渲染并清理渲染缓存。
适用场景 From d8663cce9dffa3b1d76b26db02dced92138bb2f1 Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Tue, 9 Jul 2024 16:57:07 +0800 Subject: [PATCH 3/3] 1 --- dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita b/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita index d4b11625013..074d77e3d1d 100644 --- a/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita +++ b/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita @@ -27,13 +27,12 @@

该方法初始化本地视图并设置本地用户视频显示属性，只影响本地用户看到的视频画面，不影响本地视频的发布。调用该方法绑定本地视频流的显示视窗(view)，并设置本地用户视图的渲染模式和镜像模式。

-

退出频道后，绑定仍然有效，如果需要解除绑定，可以调用该方法将参数 view 设为 。

+

退出频道后绑定仍然有效。如果需要停止渲染或解除绑定，可以调用该方法将参数 view 设为 ，以停止渲染并清理渲染缓存。

  • 如果你想要在原生窗口上渲染图像，请调用此方法；如果你仅需在 Unity 项目内渲染图像，可直接通过 类来实现。
  • 如果你希望在通话中仅更新本地用户视图的渲染或镜像模式，请使用 方法。
    • -
  • 如果想要停止渲染视图，需要在调用该方法时将 view 设为 ，以停止渲染并清理渲染缓存。
适用场景