From a1abdf1432058800dd28ba405402251fb8c91183 Mon Sep 17 00:00:00 2001 From: Suri539 Date: Wed, 16 Oct 2024 18:30:22 +0800 Subject: [PATCH] update --- .../API/api_canvasconfig_getmirrormode.dita | 2 +- .../API/api_canvasconfig_getrendermode.dita | 6 +- .../API/api_canvasconfig_setrendermode.dita | 2 +- dita/RTC-NG/API/api_config_getappid.dita | 8 +- dita/RTC-NG/API/api_config_setappid.dita | 7 +- .../api_playerconfig_getabrfallbacklayer.dita | 56 ++++++++ ..._playerconfig_getabrsubscriptionlayer.dita | 56 ++++++++ .../API/api_playerconfig_getautoplay.dita | 61 +++++++++ .../api_playerconfig_setabrfallbacklayer.dita | 63 +++++++++ ..._playerconfig_setabrsubscriptionlayer.dita | 64 +++++++++ .../API/api_playerconfig_setautoplay.dita | 60 ++++++++ dita/RTC-NG/API/api_rte_getconfigs.dita | 4 +- dita/RTC-NG/API/api_rte_getfrombridge.dita | 4 +- dita/RTC-NG/API/api_rte_initmediaengine.dita | 6 +- dita/RTC-NG/API/api_rte_setconfigs.dita | 2 +- ...layerobserver_onaudiovolumeindication.dita | 57 ++++++++ .../callback_playerobserver_onevent.dita | 25 +--- .../callback_playerobserver_onmetadata.dita | 62 +++++++++ ...ck_playerobserver_onplayerinfoupdated.dita | 57 ++++++++ dita/RTC-NG/API/class_playerconfig.dita | 6 + dita/RTC-NG/API/class_playerobserver.dita | 6 + dita/RTC-NG/API/enum_rteabrfallbacklayer.dita | 24 ++++ .../API/enum_rteabrsubscriptionlayer.dita | 52 +++++++ dita/RTC-NG/API/enum_rteplayerevent.dita | 41 ++++++ dita/RTC-NG/API/rtc_api_data_type.dita | 4 +- dita/RTC-NG/RTC_NG_API_CPP.ditamap | 11 ++ .../RTC-NG/config/keys-rtc-ng-api-cpp.ditamap | 129 +++++++++++++++++- .../config/relations-rtc-ng-api.ditamap | 16 +++ 28 files changed, 845 insertions(+), 46 deletions(-) create mode 100644 dita/RTC-NG/API/api_playerconfig_getabrfallbacklayer.dita create mode 100644 dita/RTC-NG/API/api_playerconfig_getabrsubscriptionlayer.dita create mode 100644 dita/RTC-NG/API/api_playerconfig_getautoplay.dita create mode 100644 dita/RTC-NG/API/api_playerconfig_setabrfallbacklayer.dita create mode 100644 dita/RTC-NG/API/api_playerconfig_setabrsubscriptionlayer.dita create mode 100644 dita/RTC-NG/API/api_playerconfig_setautoplay.dita create mode 100644 dita/RTC-NG/API/callback_playerobserver_onaudiovolumeindication.dita rename dita/RTC-NG/{config => API}/callback_playerobserver_onevent.dita (64%) create mode 100644 dita/RTC-NG/API/callback_playerobserver_onmetadata.dita create mode 100644 dita/RTC-NG/API/callback_playerobserver_onplayerinfoupdated.dita create mode 100644 dita/RTC-NG/API/class_playerconfig.dita create mode 100644 dita/RTC-NG/API/class_playerobserver.dita create mode 100644 dita/RTC-NG/API/enum_rteabrfallbacklayer.dita create mode 100644 dita/RTC-NG/API/enum_rteabrsubscriptionlayer.dita create mode 100644 dita/RTC-NG/API/enum_rteplayerevent.dita diff --git a/dita/RTC-NG/API/api_canvasconfig_getmirrormode.dita b/dita/RTC-NG/API/api_canvasconfig_getmirrormode.dita index 01aaed8354d..174dfaf955d 100644 --- a/dita/RTC-NG/API/api_canvasconfig_getmirrormode.dita +++ b/dita/RTC-NG/API/api_canvasconfig_getmirrormode.dita @@ -34,7 +34,7 @@
调用时机 -

该方法需要在 之后调用。

+

在创建类对象之后调用。//TODO

调用限制 diff --git a/dita/RTC-NG/API/api_canvasconfig_getrendermode.dita b/dita/RTC-NG/API/api_canvasconfig_getrendermode.dita index a1435df41d3..13dab60fa7a 100644 --- a/dita/RTC-NG/API/api_canvasconfig_getrendermode.dita +++ b/dita/RTC-NG/API/api_canvasconfig_getrendermode.dita @@ -31,10 +31,6 @@

-

-
- 调用时机 -

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

调用限制 @@ -50,7 +46,7 @@
<ph keyref="return-section-title"/> -

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

+

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

diff --git a/dita/RTC-NG/API/api_canvasconfig_setrendermode.dita b/dita/RTC-NG/API/api_canvasconfig_setrendermode.dita index 7611c736a7a..9d83551a935 100644 --- a/dita/RTC-NG/API/api_canvasconfig_setrendermode.dita +++ b/dita/RTC-NG/API/api_canvasconfig_setrendermode.dita @@ -34,7 +34,7 @@
调用时机 -

//TODO

+

//TODO setconfig 之前调用

调用限制 diff --git a/dita/RTC-NG/API/api_config_getappid.dita b/dita/RTC-NG/API/api_config_getappid.dita index 67a3f179ee9..521259fb801 100644 --- a/dita/RTC-NG/API/api_config_getappid.dita +++ b/dita/RTC-NG/API/api_config_getappid.dita @@ -30,11 +30,7 @@
v4.5.0
-

-
-
- 调用时机 -

该方法需要在 之后调用。

+

调用限制 @@ -53,7 +49,7 @@

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

diff --git a/dita/RTC-NG/API/api_config_setappid.dita b/dita/RTC-NG/API/api_config_setappid.dita index 2e7edcb8e7a..a76acc47775 100644 --- a/dita/RTC-NG/API/api_config_setappid.dita +++ b/dita/RTC-NG/API/api_config_setappid.dita @@ -30,12 +30,11 @@
v4.5.0
-

+

调用时机 -

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

-

+

//TODO 该方法需要在初始化之前调用。

调用限制 @@ -46,7 +45,7 @@ appId - 你的项目的 App ID，在声网控制台获取。一个 App ID 只能用于创建一个 RtcEngine。如需更换 App ID，必须先调用 destroy 销毁当前 RtcEngine 再重新创建。//TODO rtc 有这个限制，rte 是否有同样的限制？ + 你的项目的 App ID，在声网控制台获取。建议一个 App ID 创建一个 RtcEngine。如需更换 App ID，必须先调用 destroy 销毁当前 RtcEngine 再重新创建。//TODO 还需要确认 diff --git a/dita/RTC-NG/API/api_playerconfig_getabrfallbacklayer.dita b/dita/RTC-NG/API/api_playerconfig_getabrfallbacklayer.dita new file mode 100644 index 00000000000..c3e1c7444b5 --- /dev/null +++ b/dita/RTC-NG/API/api_playerconfig_getabrfallbacklayer.dita @@ -0,0 +1,56 @@ + + + + <ph keyref="GetAbrFallbackLayer"/> + 获取设置的视频流回退选项。 + + + + + + + + +
+

+ public Constants.AbrFallbackLayer getAbrFallbackLayer() throws RteException; + + - (AgoraRteAbrFallbackLayer)abrFallbackLayer:(AgoraRteError * _Nullable)error; + AbrFallbackLayer GetAbrFallbackLayer(Error *err = nullptr); + + + + +

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

//TODO是否有默认值？

+

+

+
+ 调用时机 +

//TODO

+
+
+ 调用限制 +

无。

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

设置的视频流回退选项，详见 。

+ + diff --git a/dita/RTC-NG/API/api_playerconfig_getabrsubscriptionlayer.dita b/dita/RTC-NG/API/api_playerconfig_getabrsubscriptionlayer.dita new file mode 100644 index 00000000000..f6d3ab56640 --- /dev/null +++ b/dita/RTC-NG/API/api_playerconfig_getabrsubscriptionlayer.dita @@ -0,0 +1,56 @@ + + + + <ph keyref="GetAbrSubscriptionLayer"/> + 获取所订阅的视频流的质量层级。 + + + + + + + + +
+

+ public Constants.AbrSubscriptionLayer getAbrSubscriptionLayer() throws RteException; + + - (AgoraRteAbrSubscriptionLayer)abrSubscriptionLayer:(AgoraRteError * _Nullable)error; + AbrSubscriptionLayer GetAbrSubscriptionLayer(Error *err = nullptr); + + + + +

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

//TODO

+

+

+
+ 调用时机 +

//rte engine 之后。

+
+
+ 调用限制 +

无。

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

当前设置的视频质量层级，详见 。

+ + diff --git a/dita/RTC-NG/API/api_playerconfig_getautoplay.dita b/dita/RTC-NG/API/api_playerconfig_getautoplay.dita new file mode 100644 index 00000000000..fe6bdbda985 --- /dev/null +++ b/dita/RTC-NG/API/api_playerconfig_getautoplay.dita @@ -0,0 +1,61 @@ + + + + <ph keyref="GetAutoPlay"/> + 获取自动播放设置。 + + + + + + + + +
+

+ public boolean getAutoPlay() throws RteException; + + - (BOOL)autoPlay:(AgoraRteError * _Nullable)error; + bool GetAutoPlay(Error *err = nullptr); + + + + +

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

你可以调用该方法来得知当前播放器是否开启了自动播放。

+

+

+
+ 调用时机 +

//TODO

+
+
+ 调用限制 +

无。

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

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

+

获取自动播放设置是否成功：

    +
  • ：获取成功。
    • +
  • ：获取失败。
    • +
+

+ + diff --git a/dita/RTC-NG/API/api_playerconfig_setabrfallbacklayer.dita b/dita/RTC-NG/API/api_playerconfig_setabrfallbacklayer.dita new file mode 100644 index 00000000000..e88c5861870 --- /dev/null +++ b/dita/RTC-NG/API/api_playerconfig_setabrfallbacklayer.dita @@ -0,0 +1,63 @@ + + + + <ph keyref="SetAbrFallbackLayer"/> + 设置订阅的视频流的回退选项。 + + + + + + + + +
+

+ public void setAbrFallbackLayer(Constants.AbrFallbackLayer fallbackLayer) throws RteException; + + - (void)setAbrFallbackLayer:(AgoraRteAbrFallbackLayer)layer error:(AgoraRteError * _Nullable)error; + void SetAbrFallbackLayer(AbrFallbackLayer abr_fallback_layer, Error *err = nullptr); + + + + +

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

//TODO 应该也需要开启 abr？如果没开，1-6 layer 不能切换。

+

+

+
+ 适用场景 +

你可以调用该方法来设置网络环境不稳定时，视频流的回退选项。以确保视听体验。你可以根据需求设置回退到不同质量层级的视频流，分别对应不同的视频分辨率和码率。//TODO 分两个场景讨论，普通场景（只能切 audio only 和low），如果有高的要求，开启abr。

+
+
+ 调用时机 +

//engine 之后。

+
+
+ 调用限制 +

无。

+
+
+ 参数 + + + fallbackLayer + abr_fallback_layer + layer + 视频流回退的质量层级，详见 。 + + + + + +
+ + diff --git a/dita/RTC-NG/API/api_playerconfig_setabrsubscriptionlayer.dita b/dita/RTC-NG/API/api_playerconfig_setabrsubscriptionlayer.dita new file mode 100644 index 00000000000..406cdafa369 --- /dev/null +++ b/dita/RTC-NG/API/api_playerconfig_setabrsubscriptionlayer.dita @@ -0,0 +1,64 @@ + + + + <ph keyref="SetAbrSubscriptionLayer"/> + 设置订阅的媒体流的质量层级。 + + + + + + + + +
+

+ public void setAbrSubscriptionLayer(Constants.AbrSubscriptionLayer subscriptionLayer) throws RteException; + + - (void)setAbrSubscriptionLayer:(AgoraRteAbrSubscriptionLayer)layer error:(AgoraRteError * _Nullable)error; + void SetAbrSubscriptionLayer(AbrSubscriptionLayer abr_subscription_layer, Error *err = nullptr); + + + + +

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

//TODO 使用这个方法需要额外找销售开通 abr 功能吗？切换 layer1-6 需要开通。不同的视频质量层级对应不同的分辨率和码率。//TODO 链接到最佳实践：补充源频道和转码频道的差异。 +

+

+

+
+ 适用场景 +

在网络环境不稳定的情况下，观众端可以根据实际的网络状况来选择合适的视频质量级别，以保证流畅的观感体验。

+
+
+ 调用时机 +

//TODO

+
+
+ 调用限制 +

//TODO

+
+
+ 参数 + + + subscriptionLayer + abr_subscription_layer + layer + 订阅的视频质量层级，详见 。 + + + + + +
+ + diff --git a/dita/RTC-NG/API/api_playerconfig_setautoplay.dita b/dita/RTC-NG/API/api_playerconfig_setautoplay.dita new file mode 100644 index 00000000000..5a21026c35b --- /dev/null +++ b/dita/RTC-NG/API/api_playerconfig_setautoplay.dita @@ -0,0 +1,60 @@ + + + + <ph keyref="SetAutoPlay"/> + 设置是否自动播放。 + + + + + + + + +
+

+ public void setAutoPlay(boolean autoPlay) throws RteException; + + - (void)setAutoPlay:(BOOL)autoPlay error:(AgoraRteError * _Nullable)error; + void SetAutoPlay(bool auto_play, Error *err = nullptr); + + + + +

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

当你调用 打开媒体流之后，你可以调用该方法设置是否自动播放。如不设置，默认会启用自动播放。

+

+

+
+ 调用时机 +

该方法需要在 之后调用。

+
+
+ 调用限制 +

无。

+
+
+ 参数 + + + autoPlay + auto_play + 是否自动播放： +
  • ：（默认）开启自动播放。
    • +
  • ：（默认）关闭自动播放。
 + + + + + +
+ + diff --git a/dita/RTC-NG/API/api_rte_getconfigs.dita b/dita/RTC-NG/API/api_rte_getconfigs.dita index 1d97321bd2a..f724c22694a 100644 --- a/dita/RTC-NG/API/api_rte_getconfigs.dita +++ b/dita/RTC-NG/API/api_rte_getconfigs.dita @@ -30,12 +30,12 @@
v4.5.0
-

//TODO 如果没有调用 setconfig，用的是默认配置吗？

+

调用时机 -

//TODO

+

//TODO 创建 rte 对象之后。

调用限制 diff --git a/dita/RTC-NG/API/api_rte_getfrombridge.dita b/dita/RTC-NG/API/api_rte_getfrombridge.dita index adb5f6d5c72..dd0f52d5962 100644 --- a/dita/RTC-NG/API/api_rte_getfrombridge.dita +++ b/dita/RTC-NG/API/api_rte_getfrombridge.dita @@ -30,7 +30,7 @@
v4.5.0
-

此方法适用于已经初始化了 RTC 引擎的场景，可以省去 RTE 引擎的初始化步骤。//TODO 如果没有初始化 rtc 引擎，是否需要调用 RTE + InitMediaEngine？

+

此方法适用于已经初始化了 RTC 引擎的场景，可以省去 RTE 引擎的初始化步骤。//TODO 如果没有初始化 rtc 引擎，是否需要调用 RTE + InitMediaEngine。需要。两种初始化方法，一个是bridge，一个是rte+init。

调用时机 @@ -55,7 +55,7 @@

方法成功调用时，无返回值；方法调用失败时，会抛出 异常，你需要捕获异常并进行处理。

diff --git a/dita/RTC-NG/API/api_rte_initmediaengine.dita b/dita/RTC-NG/API/api_rte_initmediaengine.dita index 8d67a47ec70..3bb662af9d9 100644 --- a/dita/RTC-NG/API/api_rte_initmediaengine.dita +++ b/dita/RTC-NG/API/api_rte_initmediaengine.dita @@ -35,7 +35,7 @@
调用时机 -

//TODO

+

在创建对象和设置appid之后。

调用限制 @@ -46,11 +46,11 @@ cb - 一个异步回调函数，用于返回引擎初始化结果。引擎初始化无论成功还是失败，SDK 都会调用该回调函数，并向回调中的 err 传参。这个参数包含了引擎初始化的结果或错误码信息，详见 。//TODO 没找到原型 + 一个异步回调函数，用于返回引擎初始化结果。并向回调中的 err 传参。这个参数包含了引擎初始化的结果或错误码信息，详见 。//TODO 改下描述，不是所有情况都会调用这个会调。 callback - 一个异步回调函数，用于返回引擎初始化结果。引擎初始化无论成功还是失败，SDK 都会调用该回调函数并根据情况返回下列状态或错误码：//TODO 是否直接链接到 Error 这个类？还是要写出来每个枚举值。 + 一个异步回调函数，用于返回引擎初始化结果。根据情况返回下列状态或错误码：//TODO 是否直接链接到 Error 这个类？还是要写出来每个枚举值。
  • (0): 初始化成功。
  • (1): 初始化引擎失败。//TODO 错误信息通过 message 得知。这个方法应该也要写文档？
 diff --git a/dita/RTC-NG/API/api_rte_setconfigs.dita b/dita/RTC-NG/API/api_rte_setconfigs.dita index 556d53d02f9..953b5706d39 100644 --- a/dita/RTC-NG/API/api_rte_setconfigs.dita +++ b/dita/RTC-NG/API/api_rte_setconfigs.dita @@ -35,7 +35,7 @@
调用时机 -

//TODO

+

//TODO设置 app id 必须在初始化之前，其他的选项可以按需随时更新。

调用限制 diff --git a/dita/RTC-NG/API/callback_playerobserver_onaudiovolumeindication.dita b/dita/RTC-NG/API/callback_playerobserver_onaudiovolumeindication.dita new file mode 100644 index 00000000000..1c3e467eabd --- /dev/null +++ b/dita/RTC-NG/API/callback_playerobserver_onaudiovolumeindication.dita @@ -0,0 +1,57 @@ + + + + <ph keyref="onAudioVolumeIndication_PlayerObserver"/> + //TODO 主播音量提示回调。这个不是播放器的音量？ + + + + + + + + +
+

+ public void onAudioVolumeIndication(int volume){} + + - (void)onAudioVolumeIndication:(int32_t)volume; + virtual void onAudioVolumeIndication(int32_t volume) = 0; + + + + + +

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

+
+
+ 适用场景 +

+

+
+ 触发时机 +

当主播的音量发生变化时，SDK 会触发该回调。//TODO 触发频率？主播静音后，会继续报告音量为 0 吗？

+
+
+ 使用限制 +

无。

+
+
+ 参数 + + + volume + 主播当前的音量，取值范围为 [0,225]。 + +
+ + diff --git a/dita/RTC-NG/config/callback_playerobserver_onevent.dita b/dita/RTC-NG/API/callback_playerobserver_onevent.dita similarity index 64% rename from dita/RTC-NG/config/callback_playerobserver_onevent.dita rename to dita/RTC-NG/API/callback_playerobserver_onevent.dita index 30d716bf1db..68fe870d3b7 100644 --- a/dita/RTC-NG/config/callback_playerobserver_onevent.dita +++ b/dita/RTC-NG/API/callback_playerobserver_onevent.dita @@ -2,7 +2,7 @@ <ph keyref="onEvent"/> - + 播放器事件回调。 @@ -28,37 +28,26 @@
自从
-
v
+
v4.5.0
-

-

-
- 适用场景 -

+

如果你需要监控播放器事件，需要在调用 方法时注册该回调。

触发时机 -

+

//TODO 什么情况下会触发？

使用限制 -

+

无。

参数 - - + event + 播放器事件，详见 。
-
- <ph keyref="return-section-title"/> -

方法成功调用时，无返回值；方法调用失败时，会抛出 异常，你需要捕获异常并进行处理。

-
diff --git a/dita/RTC-NG/API/callback_playerobserver_onmetadata.dita b/dita/RTC-NG/API/callback_playerobserver_onmetadata.dita new file mode 100644 index 00000000000..f88c7f4798a --- /dev/null +++ b/dita/RTC-NG/API/callback_playerobserver_onmetadata.dita @@ -0,0 +1,62 @@ + + + + <ph keyref="onMetadata_PlayerObserver"/> + 已获取媒体附属信息回调。 + + + + + + + + +
+

+ public void onMetadata(int type, byte[] data){} + + - (void)onMetadata:(AgoraRtePlayerMetadataType)type data:(NSData * _Nonnull)data; + virtual void onMetadata(PlayerMetadataType type, + const uint8_t *data, size_t length) = 0; + + + + + +

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

如果你需要获取媒体流的元数据，需要在调用 方法时注册该回调。

+
+
+ 触发时机 +

在 SDK 解析播放器所播放的媒体流的元数据后，会触发该回调报告数据的类型及其具体内容。//TODO review

+
+
+ 使用限制 +

无。

+
+
+ 参数 + + + type + 元数据类型，详见 。 + + + data + 解析的元数据。 + + + length + 数据的大小（字节）。 + +
+ + diff --git a/dita/RTC-NG/API/callback_playerobserver_onplayerinfoupdated.dita b/dita/RTC-NG/API/callback_playerobserver_onplayerinfoupdated.dita new file mode 100644 index 00000000000..4df44b4f01d --- /dev/null +++ b/dita/RTC-NG/API/callback_playerobserver_onplayerinfoupdated.dita @@ -0,0 +1,57 @@ + + + + <ph keyref="onPlayerInfoUpdated_PlayerObserver"/> + 媒体流的相关信息发生变化回调。 + + + + + + + + +
+

+ public void onPlayerInfoUpdated(PlayerInfo info){} + + - (void)onPlayerInfoUpdated:(AgoraRtePlayerInfo * _Nonnull)info; + virtual void onPlayerInfoUpdated(const PlayerInfo *info) = 0; + + + + + +

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

如果你需要获取媒体流的相关信息，可以在调用 方法时注册该回调，或者通过 方法来获取。

+
+
+ 适用场景 +

+

+
+ 触发时机 +

当播放器播放的媒体流的相关信息发生变化时，SDK 会触发该回调。

+
+
+ 使用限制 +

无。

+
+
+ 参数 + + + info + 媒体流的相关信息，详见 。 + +
+ + diff --git a/dita/RTC-NG/API/class_playerconfig.dita b/dita/RTC-NG/API/class_playerconfig.dita new file mode 100644 index 00000000000..b54d8e44e56 --- /dev/null +++ b/dita/RTC-NG/API/class_playerconfig.dita @@ -0,0 +1,6 @@ + + + + <ph keyref="PlayerConfig"/> + 播放器设置的接口类。 + diff --git a/dita/RTC-NG/API/class_playerobserver.dita b/dita/RTC-NG/API/class_playerobserver.dita new file mode 100644 index 00000000000..93d13f32ea4 --- /dev/null +++ b/dita/RTC-NG/API/class_playerobserver.dita @@ -0,0 +1,6 @@ + + + + <ph keyref="PlayerObserver"/> + 提供播放器回调的接口类。 + diff --git a/dita/RTC-NG/API/enum_rteabrfallbacklayer.dita b/dita/RTC-NG/API/enum_rteabrfallbacklayer.dita new file mode 100644 index 00000000000..68679d8fe3c --- /dev/null +++ b/dita/RTC-NG/API/enum_rteabrfallbacklayer.dita @@ -0,0 +1,24 @@ + + + + <ph keyref="RteAbrFallbackLayer"/> + 视频流回退的质量层级。 + +
+
+ +
自从
+
v4.5.0
+ +
+
+
+ 枚举值 + + + + + + +
+ diff --git a/dita/RTC-NG/API/enum_rteabrsubscriptionlayer.dita b/dita/RTC-NG/API/enum_rteabrsubscriptionlayer.dita new file mode 100644 index 00000000000..58a3018d75d --- /dev/null +++ b/dita/RTC-NG/API/enum_rteabrsubscriptionlayer.dita @@ -0,0 +1,52 @@ + + + + <ph keyref="RteAbrSubscriptionLayer"/> + 订阅的视频流的质量层级。 + +
+
+ +
自从
+
v4.5.0
+ +
+
+
+ 枚举值 + + + + 0：高质量视频流。//TODO 每个层级能否明确对应的码率和分辨率是多少？ + + + + 1：（默认）低质量的视频流。 + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ diff --git a/dita/RTC-NG/API/enum_rteplayerevent.dita b/dita/RTC-NG/API/enum_rteplayerevent.dita new file mode 100644 index 00000000000..0cfebefe4ba --- /dev/null +++ b/dita/RTC-NG/API/enum_rteplayerevent.dita @@ -0,0 +1,41 @@ + + + + <ph keyref="RtePlayerEvent"/> + 播放器事件类型。 + +
+
+ +
自从
+
v4.5.0
+ +
+
+
+ 枚举值//TODO 目前不可用的枚举文档不对外暴露。 + + + + 5：卡顿开始。//TODO 当音视频流出现卡顿时，会报告该事件。用户在什么场景下需要知道卡顿开始和结束的时间？ + + + + 6：卡顿结束。 + + + + 8：Token 即将过期。在收到此事件后你需要重新生成一个新的 Token 并更新 URL。//TODO + + + + 9：由于网络问题，音视频流回退为音频流。 + 该参数需要开通自适应码率功能并需要设置允许流回退。详情请。//TODO + + + + 10：网络状态恢复后，从仅接收音频流恢复到接收音视频流。该参数需要开通自适应码率功能并需要设置允许流回退。详情请。 + + +
+ diff --git a/dita/RTC-NG/API/rtc_api_data_type.dita b/dita/RTC-NG/API/rtc_api_data_type.dita index 6435c5ccea5..a5a9dcc37fb 100644 --- a/dita/RTC-NG/API/rtc_api_data_type.dita +++ b/dita/RTC-NG/API/rtc_api_data_type.dita @@ -102,6 +102,7 @@
    • +
    • @@ -1241,10 +1242,10 @@
    • -
    • +
    • @@ -1278,6 +1279,7 @@
    • +
    • diff --git a/dita/RTC-NG/RTC_NG_API_CPP.ditamap b/dita/RTC-NG/RTC_NG_API_CPP.ditamap index b5603c9b9d5..fa54026f12b 100644 --- a/dita/RTC-NG/RTC_NG_API_CPP.ditamap +++ b/dita/RTC-NG/RTC_NG_API_CPP.ditamap @@ -50,6 +50,8 @@ + + @@ -465,15 +467,21 @@ + + + + + + @@ -485,6 +493,9 @@ + + + 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 274621f114c..b75d111519a 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap @@ -329,6 +329,20 @@ + + + + PlayerConfig + + + + + + + PlayerObserver + + + @@ -987,6 +1001,13 @@ + + + + GetAutoPlay + + + @@ -1022,6 +1043,13 @@ + + + + SetAutoPlay + + + @@ -1043,6 +1071,34 @@ + + + + SetAbrFallbackLayer + + + + + + + SetAbrSubscriptionLayer + + + + + + + GetAbrFallbackLayer + + + + + + + GetAbrSubscriptionLayer + + + @@ -1199,6 +1255,27 @@ + + + + onEvent + + + + + + + onMetadata [2/2] + + + + + + + onPlayerInfoUpdated [2/2] + + + @@ -4774,7 +4851,7 @@ - onMetaData + onMetaData [1/2] @@ -4858,7 +4935,7 @@ - onPlayerInfoUpdated + onPlayerInfoUpdated [1/2] @@ -5901,6 +5978,13 @@ + + + + RtePlayerInfo + + + @@ -11419,6 +11503,47 @@ + + + + RtePlayerEvent + + + + + + + kRtePlayerEventFreezeStart + + + + + + + kRtePlayerEventFreezeStop + + + + + + + kRtePlayerEventAuthenticationWillExpire + + + + + + + kRtePlayerEventAbrFallbackToAudioOnlyLayer + + + + + + kRtePlayerEventAbrRecoverFromAudioOnlyLayer + + + diff --git a/dita/RTC-NG/config/relations-rtc-ng-api.ditamap b/dita/RTC-NG/config/relations-rtc-ng-api.ditamap index 33c2ff9bf75..69df4a31d27 100644 --- a/dita/RTC-NG/config/relations-rtc-ng-api.ditamap +++ b/dita/RTC-NG/config/relations-rtc-ng-api.ditamap @@ -3350,6 +3350,22 @@ + + + + + + + + + + + + + + + +