diff --git a/dita/RTC-NG/API/api_canvas_addview.dita b/dita/RTC-NG/API/api_canvas_addview.dita index c52c8110744..94b6f6a8975 100644 --- a/dita/RTC-NG/API/api_canvas_addview.dita +++ b/dita/RTC-NG/API/api_canvas_addview.dita @@ -2,7 +2,7 @@ <ph keyref="AddView"/> - + 添加渲染视图。 @@ -13,10 +13,10 @@

- + public void addView(View view, ViewConfig viewConfig) throws RteException; - - + - (BOOL)addView:(AgoraRteView * _Nonnull)view config:(AgoraRteViewConfig* _Nullable)config error:(AgoraRteError* _Nullable)error; + bool AddView(View *view, ViewConfig *config, rte::Error *err) @@ -27,41 +27,48 @@

自从
-
v
+
v4.5.0
-

+

适用场景 -

+

当你需要使用播放器播放视频，你可以调用该方法将一个视图（view）添加到视频渲染器中，以便显示视频内容。

调用时机 -

+

//TODO

调用限制 -

-

-
参数 - - + view + HWND 窗口句柄值。 + SurfaceView 对象。 + UIView 对象。 + + + config + View 对象的设置，详见 。//TODO 目前可传空是什么意思？什么情况下可以传空？ + + + +
-
+
<ph keyref="return-section-title"/>

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

-
    -
  • 0: 方法调用成功。
    • -
  • < 0: 方法调用失败。详见了解详情和解决建议。
    • -
+

添加视图是否成功：

    +
  • ：添加视图成功。
    • +
  • ：添加视图失败。
    • +
+

diff --git a/dita/RTC-NG/API/api_canvas_removeview.dita b/dita/RTC-NG/API/api_canvas_removeview.dita new file mode 100644 index 00000000000..0f6fdd6dcdd --- /dev/null +++ b/dita/RTC-NG/API/api_canvas_removeview.dita @@ -0,0 +1,68 @@ + + + + <ph keyref="RemoveView"/> + 移除渲染视图。 + + + + + + + + +
+

+ public void removeView(View view, ViewConfig viewConfig) throws RteException; + + - (BOOL)removeView:(AgoraRteView * _Nonnull)view config:(AgoraRteViewConfig* _Nullable)config error:(AgoraRteError* _Nullable)error; + bool RemoveView(View *view, ViewConfig *config, rte::Error *err); + + + + +

+
+
+
+ +
自从
+
v4.5.0
+ +
+

当你调用 添加视图后，如果你需要移除渲染视图，可调用此方法。

+
+
+ 调用时机 +

该方法需在 后调用。

+
+
+ 调用限制 +

//TODO 一次只能移除一个视图？

+
+
+ 参数 + + + view + 需要移除的视图对象。 + + + + + + + + + +
+
+ <ph keyref="return-section-title"/> +

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

+

移除视图是否成功：

    +
  • ：移除视图成功。
    • +
  • ：移除视图失败。
    • +
+

+ + diff --git a/dita/RTC-NG/API/api_canvasconfig_getmirrormode.dita b/dita/RTC-NG/API/api_canvasconfig_getmirrormode.dita new file mode 100644 index 00000000000..01aaed8354d --- /dev/null +++ b/dita/RTC-NG/API/api_canvasconfig_getmirrormode.dita @@ -0,0 +1,55 @@ + + + + <ph keyref="GetMirrorMode"/> + 获取当前设置的镜像模式。 + + + + + + + + +
+

+ public Constants.VideoMirrorMode getVideoMirrorMode() throws RteException ; + + - (AgoraRteVideoMirrorMode)videoMirrorMode:(AgoraRteError * _Nullable)error; + VideoMirrorMode GetMirrorMode(Error *err = nullptr); + + + + +

+
+
+
+ +
自从
+
v4.5.0
+ +
+

+

+
+ 调用时机 +

该方法需要在 之后调用。

+
+
+ 调用限制 +

无。

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

当前设置的镜像模式，详见 。

+ + diff --git a/dita/RTC-NG/API/api_canvasconfig_getrendermode.dita b/dita/RTC-NG/API/api_canvasconfig_getrendermode.dita new file mode 100644 index 00000000000..a1435df41d3 --- /dev/null +++ b/dita/RTC-NG/API/api_canvasconfig_getrendermode.dita @@ -0,0 +1,56 @@ + + + + <ph keyref="GetRenderMode"/> + 获取当前设置的视频渲染模式。 + + + + + + + + +
+

+ public Constants.VideoRenderMode getVideoRenderMode() throws RteException ; + + - (AgoraRteVideoRenderMode)videoRenderMode:(AgoraRteError * _Nullable)error; + VideoRenderMode GetRenderMode(Error *err = nullptr) + + + + +

+
+
+
+ +
自从
+
v4.5.0
+ +
+

+

+
+ 调用时机 +

该方法需要在 之后调用。//TODO

+
+
+ 调用限制 +

无。

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

当前的视频渲染模式，详见 。

+
+ + diff --git a/dita/RTC-NG/API/api_canvasconfig_setmirrormode.dita b/dita/RTC-NG/API/api_canvasconfig_setmirrormode.dita new file mode 100644 index 00000000000..d82986b1807 --- /dev/null +++ b/dita/RTC-NG/API/api_canvasconfig_setmirrormode.dita @@ -0,0 +1,56 @@ + + + + <ph keyref="SetMirrorMode"/> + 设置视频的镜像模式。 + + + + + + + + +
+

+ public void setVideoMirrorMode(Constants.VideoMirrorMode mode) throws RteException ; + + - (void)setVideoMirrorMode:(AgoraRteVideoMirrorMode)mode error:(AgoraRteError* _Nullable)error; + void SetMirrorMode(VideoMirrorMode mode, Error *err = nullptr); + + + + +

+
+
+
+ +
自从
+
v4.5.0
+ +
+

+

+
+ 调用时机 +

//TODO

+
+
+ 调用限制 +

无。

+
+
+ 参数 + + + mode + 镜像模式，详见 。默认为 ，即由 SDK 决定镜像模式。默认关闭远端用户的镜像模式。//TODO review + + + + + +
+ + diff --git a/dita/RTC-NG/API/api_canvasconfig_setrendermode.dita b/dita/RTC-NG/API/api_canvasconfig_setrendermode.dita new file mode 100644 index 00000000000..7611c736a7a --- /dev/null +++ b/dita/RTC-NG/API/api_canvasconfig_setrendermode.dita @@ -0,0 +1,56 @@ + + + + <ph keyref="SetRenderMode_CanvasConfig"/> + 设置视频的渲染模式。 + + + + + + + + +
+

+ public void setVideoRenderMode(Constants.VideoRenderMode mode) throws RteException ; + + - (void)setVideoMirrorMode:(AgoraRteVideoMirrorMode)mode error:(AgoraRteError* _Nullable)error; + void SetRenderMode(VideoRenderMode mode, Error *err = nullptr); + + + + +

+
+
+
+ +
自从
+
v4.5.0
+ +
+

+

+
+ 调用时机 +

//TODO

+
+
+ 调用限制 +

无。

+
+
+ 参数 + + + mode + 渲染模式，详见 。默认的渲染模式为 ，即视频尺寸等比缩放，优先保证视窗被填满。 + + + + + +
+ + diff --git a/dita/RTC-NG/API/api_imediaplayer_pause.dita b/dita/RTC-NG/API/api_imediaplayer_pause.dita index d02b4ea84cd..d45d85fceb9 100644 --- a/dita/RTC-NG/API/api_imediaplayer_pause.dita +++ b/dita/RTC-NG/API/api_imediaplayer_pause.dita @@ -32,7 +32,7 @@
调用时机

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

-
+
调用限制

无。

diff --git a/dita/RTC-NG/API/api_player_openwithurl.dita b/dita/RTC-NG/API/api_player_openwithurl.dita index 271d128978b..7216f788be9 100644 --- a/dita/RTC-NG/API/api_player_openwithurl.dita +++ b/dita/RTC-NG/API/api_player_openwithurl.dita @@ -30,8 +30,8 @@
v4.5.0
-

如果你想要加快打开 URL 资源的速度，可以在调用该方法前，调用 预加载资源。

-

如果资源打开失败，你会收到 的回调报告状态为 。此时你需要先调用 然后再调用 重新打开 URL 资源。

+

该方法支持通过 URL 打开实时流媒体。如果你想要加快打开 URL 资源的速度，可以在调用该方法前，调用 预加载资源。

+

如果资源打开失败，你会收到 的回调报告状态为 。此时你需要先调用 然后再调用 重新打开 URL 资源。成功打开后，你可以调用 进行播放。

适用场景 @@ -47,7 +47,7 @@
参数 diff --git a/dita/RTC-NG/API/api_player_pause.dita b/dita/RTC-NG/API/api_player_pause.dita new file mode 100644 index 00000000000..23a546c526a --- /dev/null +++ b/dita/RTC-NG/API/api_player_pause.dita @@ -0,0 +1,67 @@ + + + + <ph keyref="Pause_Player"/> + 暂停播放。 + + + + + + + + +
+

+ public void pause() throws RteException; + + - (BOOL)pause:(AgoraRteError * _Nullable)error; + bool Pause(Error* err); + + + + +

+
+
+
+ +
自从
+
v4.5.0
+ +
+

+

+
+ 适用场景 +

+

+
+ 调用时机 +

+

+
+ 调用限制 +

+

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

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

+
    +
  • 0: 方法调用成功。
    • +
  • < 0: 方法调用失败。详见了解详情和解决建议。
    • +
+ + diff --git a/dita/RTC-NG/API/api_player_play.dita b/dita/RTC-NG/API/api_player_play.dita new file mode 100644 index 00000000000..09c72763c00 --- /dev/null +++ b/dita/RTC-NG/API/api_player_play.dita @@ -0,0 +1,65 @@ + + + + <ph keyref="Play_Player"/> + 播放 URL 资源。 + + + + + + + + +
+

+ public void play() throws RteException; + + - (BOOL)play:(AgoraRteError * _Nullable)error; + bool Play(Error* err); + + + + +

+
+
+
+ +
自从
+
v4.5.0
+ +
+

当你调用 打开成功拉取实时流媒体后，你可以调用此方法进行播放。

+

+

+
+ 调用时机 +

//TODO 是否需要收到 player state 为 opencompleted 然后才能调用 play？

+
+
+ 调用限制 +

该方法目前仅支持播放带 rte:// 前缀的 URL。//TODO

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

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

+

播放是否成功：

    +
  • ：播放成功。
    • +
  • ：播放失败。
    • +
+

+ + diff --git a/dita/RTC-NG/API/class_canvasconfig.dita b/dita/RTC-NG/API/class_canvasconfig.dita new file mode 100644 index 00000000000..db39eb9d579 --- /dev/null +++ b/dita/RTC-NG/API/class_canvasconfig.dita @@ -0,0 +1,6 @@ + + + + <ph keyref="CanvasConfig"/> + 该类提供设置视频渲染的相关方法。 + diff --git a/dita/RTC-NG/API/enum_rtevideomirrormode.dita b/dita/RTC-NG/API/enum_rtevideomirrormode.dita new file mode 100644 index 00000000000..419dc84baf4 --- /dev/null +++ b/dita/RTC-NG/API/enum_rtevideomirrormode.dita @@ -0,0 +1,36 @@ + + + + <ph keyref="RteVideoMirrorMode"/> + 视频镜像模式。 + +
+
+ +
自从
+
v
+ +
+
+
+ 枚举值 + + + + 0：由 SDK 决定镜像模式。 +
    +
  • 本地视图镜像模式：如果你使用前置摄像头，默认启动本地视图镜像模式；如果你使用后置摄像头，默认关闭本地视图镜像模式。
    • +
  • 远端用户视图镜像模式：默认关闭远端用户的镜像模式。
 + + + + 1：启用镜像模式。 + + + + 2：关闭镜像模式。 + + + +
+ diff --git a/dita/RTC-NG/API/enum_rtevideorendermode.dita b/dita/RTC-NG/API/enum_rtevideorendermode.dita new file mode 100644 index 00000000000..9b111a58211 --- /dev/null +++ b/dita/RTC-NG/API/enum_rtevideorendermode.dita @@ -0,0 +1,28 @@ + + + + <ph keyref="RteVideoRenderMode"/> + 视频渲染模式。 + +
+
+ +
自从
+
v4.5.0
+ +
+
+
+ 枚举值 + + + + 0：视频尺寸等比缩放。优先保证视窗被填满。因视频尺寸与显示视窗尺寸不一致而多出的视频将被截掉。 + + + + 1：视频尺寸等比缩放。优先保证视频内容全部显示。因视频尺寸与显示视窗尺寸不一致造成的视窗未被填满的区域填充黑色。//TODO rtc的这个描述是否适用 rte？ + + +
+ diff --git a/dita/RTC-NG/API/rtc_api_data_type.dita b/dita/RTC-NG/API/rtc_api_data_type.dita index e4a4c968ae9..a16725e2f2c 100644 --- a/dita/RTC-NG/API/rtc_api_data_type.dita +++ b/dita/RTC-NG/API/rtc_api_data_type.dita @@ -1245,6 +1245,8 @@
    • +
    • +
    • diff --git a/dita/RTC-NG/RTC_NG_API_CPP.ditamap b/dita/RTC-NG/RTC_NG_API_CPP.ditamap index ae3cc05df62..aabd405115c 100644 --- a/dita/RTC-NG/RTC_NG_API_CPP.ditamap +++ b/dita/RTC-NG/RTC_NG_API_CPP.ditamap @@ -47,6 +47,10 @@ + + + + @@ -450,17 +454,24 @@ + + + + + + + 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 b492402bcf0..895f61a0692 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap @@ -301,6 +301,34 @@ + + + + Canvas + + + + + + + CanvasConfig + + + + + + + Rte + + + + + + + Player + + + @@ -951,7 +979,14 @@ - + + + + + AddView + + + @@ -1001,6 +1036,13 @@ + + + + SetRenderMode + + + @@ -1015,6 +1057,20 @@ + + + + GetMirrorMode + + + + + + + GetRenderMode + + + @@ -1029,6 +1085,13 @@ + + + + SetMirrorMode + + + @@ -1043,6 +1106,13 @@ + + + + Play + + + @@ -1050,6 +1120,13 @@ + + + + RemoveView + + + @@ -10913,6 +10990,34 @@ + + + + RteVideoMirrorMode + + + + + + + kRteVideoMirrorModeAuto + + + + + + + kRteVideoMirrorModeEnabled + + + + + + + kRteVideoMirrorModeDisabled + + + @@ -11067,6 +11172,27 @@ + + + + RteVideoRenderMode + + + + + + + kRteVideoRenderModeHidden + + + + + + + kRteVideoRenderModeFit + + + diff --git a/dita/RTC-NG/config/relations-rtc-ng-api.ditamap b/dita/RTC-NG/config/relations-rtc-ng-api.ditamap index f95ae2c9bb2..fab455b5fde 100644 --- a/dita/RTC-NG/config/relations-rtc-ng-api.ditamap +++ b/dita/RTC-NG/config/relations-rtc-ng-api.ditamap @@ -3307,8 +3307,10 @@ + + @@ -3316,6 +3318,18 @@ + + + + + + + + + + + +