From 440e5bf0b1cdfb505978dd0cf80b4f63a4937991 Mon Sep 17 00:00:00 2001 From: Suri539 Date: Mon, 28 Oct 2024 11:40:33 +0800 Subject: [PATCH] RESOLVE COMMENTS --- dita/RTC-NG/API/api_canvas_getconfigs.dita | 2 +- dita/RTC-NG/API/api_canvas_setconfigs.dita | 2 +- .../API/api_canvasconfig_getrendermode.dita | 4 +-- .../API/api_imediaplayer_switchsrc.dita | 2 -- dita/RTC-NG/API/api_player_getconfigs.dita | 4 +-- dita/RTC-NG/API/api_player_muteaudio.dita | 4 +-- dita/RTC-NG/API/api_player_mutevideo.dita | 4 +-- dita/RTC-NG/API/api_player_play.dita | 2 +- .../API/api_player_registerobserver.dita | 2 +- dita/RTC-NG/API/api_player_stop.dita | 3 ++- ..._playerconfig_getabrsubscriptionlayer.dita | 10 ++++--- .../api_playerconfig_setabrfallbacklayer.dita | 10 ++++--- ..._playerconfig_setabrsubscriptionlayer.dita | 9 ++++--- 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 | 7 +++-- dita/RTC-NG/API/api_rte_setconfigs.dita | 4 +-- dita/RTC-NG/API/class_rteplayerinfo.dita | 8 +++--- dita/RTC-NG/API/enum_rteabrfallbacklayer.dita | 26 +++++++++---------- .../API/enum_rteabrsubscriptionlayer.dita | 20 +++++++------- dita/RTC-NG/API/enum_rteplayerevent.dita | 4 +-- dita/RTC-NG/API/enum_rteplayerstate.dita | 2 +- dita/RTC-NG/RTC_NG_API_CPP.ditamap | 4 +-- .../RTC-NG/config/keys-rtc-ng-api-cpp.ditamap | 11 ++++---- 24 files changed, 81 insertions(+), 71 deletions(-) diff --git a/dita/RTC-NG/API/api_canvas_getconfigs.dita b/dita/RTC-NG/API/api_canvas_getconfigs.dita index 4ecc8f09ba6..95d97bed153 100644 --- a/dita/RTC-NG/API/api_canvas_getconfigs.dita +++ b/dita/RTC-NG/API/api_canvas_getconfigs.dita @@ -34,7 +34,7 @@
调用时机 -

该方法需要在 之后调用。

+

该方法需要在 之后调用。

调用限制 diff --git a/dita/RTC-NG/API/api_canvas_setconfigs.dita b/dita/RTC-NG/API/api_canvas_setconfigs.dita index 65d2b4c80b2..42b6d3a26a3 100644 --- a/dita/RTC-NG/API/api_canvas_setconfigs.dita +++ b/dita/RTC-NG/API/api_canvas_setconfigs.dita @@ -34,7 +34,7 @@
调用时机 -

当你调用 指定一个 Canvas 对象来显示视频后，你可以调用该方法来设置渲染配置。

+

该方法需要在 之前调用。

调用限制 diff --git a/dita/RTC-NG/API/api_canvasconfig_getrendermode.dita b/dita/RTC-NG/API/api_canvasconfig_getrendermode.dita index 2810e61845b..b78d8600121 100644 --- a/dita/RTC-NG/API/api_canvasconfig_getrendermode.dita +++ b/dita/RTC-NG/API/api_canvasconfig_getrendermode.dita @@ -51,8 +51,8 @@ <ph keyref="return-section-title"/>

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

-
- 异常 +
+

diff --git a/dita/RTC-NG/API/api_imediaplayer_switchsrc.dita b/dita/RTC-NG/API/api_imediaplayer_switchsrc.dita index df6e6b0ef36..3bc2097bbda 100644 --- a/dita/RTC-NG/API/api_imediaplayer_switchsrc.dita +++ b/dita/RTC-NG/API/api_imediaplayer_switchsrc.dita @@ -59,12 +59,10 @@ syncPts 是否同步切换前后的起始播放位置: -
  • ：同步。
  • ：(默认) 不同步。
-

如果媒体资源为直播流，你只能将该参数设置为 ，否则 SDK 切换媒体资源会失败。如果媒体资源为点播流，你可以根据场景需求对该参数赋值。
diff --git a/dita/RTC-NG/API/api_player_getconfigs.dita b/dita/RTC-NG/API/api_player_getconfigs.dita index 82784d9144b..f261039f061 100644 --- a/dita/RTC-NG/API/api_player_getconfigs.dita +++ b/dita/RTC-NG/API/api_player_getconfigs.dita @@ -32,9 +32,9 @@

-
+
调用时机 -

该方法需要在 之后调用。

+

调用限制 diff --git a/dita/RTC-NG/API/api_player_muteaudio.dita b/dita/RTC-NG/API/api_player_muteaudio.dita index 76e0f25d3b9..57abf1d14cb 100644 --- a/dita/RTC-NG/API/api_player_muteaudio.dita +++ b/dita/RTC-NG/API/api_player_muteaudio.dita @@ -50,8 +50,8 @@ mute 是否订阅主播的音频流： -
  • ：订阅主播的音频流。
    • -
  • ：不订阅主播的音频流。
 +
  • ：不订阅主播的音频流。
    • +
  • ：订阅主播的音频流。
 diff --git a/dita/RTC-NG/API/api_player_mutevideo.dita b/dita/RTC-NG/API/api_player_mutevideo.dita index f6732e24bbb..a926bd32496 100644 --- a/dita/RTC-NG/API/api_player_mutevideo.dita +++ b/dita/RTC-NG/API/api_player_mutevideo.dita @@ -50,8 +50,8 @@ mute 是否订阅主播的视频流： -
  • ：订阅主播的视频流。
    • -
  • ：不订阅主播的视频流。
 +
  • ：不订阅主播的视频流。
    • +
  • ：订阅主播的视频流。
 diff --git a/dita/RTC-NG/API/api_player_play.dita b/dita/RTC-NG/API/api_player_play.dita index 1610222139a..9bf3d194c94 100644 --- a/dita/RTC-NG/API/api_player_play.dita +++ b/dita/RTC-NG/API/api_player_play.dita @@ -30,7 +30,7 @@
v4.5.0
-

如果你关闭了自动播放，当你调用 打开成功拉取实时流媒体，你可以调用此方法进行播放。

+

如果你关闭了自动播放，当你调用 成功打开实时流媒体，你可以调用此方法进行播放。

调用时机 diff --git a/dita/RTC-NG/API/api_player_registerobserver.dita b/dita/RTC-NG/API/api_player_registerobserver.dita index 9d038eaebee..21a0eda8d9a 100644 --- a/dita/RTC-NG/API/api_player_registerobserver.dita +++ b/dita/RTC-NG/API/api_player_registerobserver.dita @@ -30,7 +30,7 @@
v4.5.0
-

你需要在调用该方法前，实现一个继承自 的接口类。

+

调用该方法前，你需要实现一个继承自 的接口类。

调用时机 diff --git a/dita/RTC-NG/API/api_player_stop.dita b/dita/RTC-NG/API/api_player_stop.dita index fc46a4f1635..4237364adcd 100644 --- a/dita/RTC-NG/API/api_player_stop.dita +++ b/dita/RTC-NG/API/api_player_stop.dita @@ -30,7 +30,8 @@
v4.5.0
-

当你调用 播放 URL 流后，如果你想停止播放，可以调用此方法。如果你需要暂停播放，请调用 。

+

如果你调用 打开 URL 流失败，需要先调用此方法，然后再调用 重新打开 URL。

+

当你成功打开 URL 流并调用 播放后，如果你想停止播放，可以调用此方法。如果你需要暂停播放，请调用 。

调用时机 diff --git a/dita/RTC-NG/API/api_playerconfig_getabrsubscriptionlayer.dita b/dita/RTC-NG/API/api_playerconfig_getabrsubscriptionlayer.dita index 048a22bd2c9..cbbddf0d5d0 100644 --- a/dita/RTC-NG/API/api_playerconfig_getabrsubscriptionlayer.dita +++ b/dita/RTC-NG/API/api_playerconfig_getabrsubscriptionlayer.dita @@ -50,7 +50,11 @@
<ph keyref="return-section-title"/> -

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

-

方法调用成功时，返回设置的视频质量层级，详见 。方法调用失败时，SDK 会抛出 异常，并返回相应的错误信息。你需要捕获异常并进行处理。

- +

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

+
+
+ +

+
+ diff --git a/dita/RTC-NG/API/api_playerconfig_setabrfallbacklayer.dita b/dita/RTC-NG/API/api_playerconfig_setabrfallbacklayer.dita index c99d263c9ca..9976a6d4d42 100644 --- a/dita/RTC-NG/API/api_playerconfig_setabrfallbacklayer.dita +++ b/dita/RTC-NG/API/api_playerconfig_setabrfallbacklayer.dita @@ -31,6 +31,7 @@

网络不理想的环境下，实时通信音视频的质量会下降。调用该方法后，SDK 会在网络情况差的时候将视频流的分辨率回退到你指定的视频质量层级。不同的视频质量层级对应不同的分辨率和码率。同时，SDK 会持续监控网络质量，并在网络质量改善时恢复至你所订阅的视频流质量层级。

+

默认情况下，调用该方法后只能在源频道选择回退至 或 。如果你对视频体验有更高要求，你可以开通 ABR 功能。启用该功能后，可以在转码频道选择回退到所有质量层级的视频流，并支持自定义不同质量层级的视频流所对应的分辨率。

适用场景 @@ -47,7 +48,7 @@
调用限制 -

如果没有开通 ABR（自适应码率）功能，调用该方法后只能在源频道选择回退至 或 。开通 ABR 功能后，可以转码频道选择回退到所有质量层级的视频流，并支持自定义不同质量层级的视频流所对应的分辨率。

+

调用该方法时如果你未开通 ABR 功能，视频流回退的质量层级只能选择 或 。

参数 @@ -56,9 +57,10 @@ 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 index 6a928ea38f0..aa0ff2b18db 100644 --- a/dita/RTC-NG/API/api_playerconfig_setabrsubscriptionlayer.dita +++ b/dita/RTC-NG/API/api_playerconfig_setabrsubscriptionlayer.dita @@ -30,7 +30,8 @@
v4.5.0
-

你可以根据实际的网络情况切换订阅不同的视频流质量层级，对应不同的分辨率和码率。具体实现细节详见。 +

你可以根据实际的网络情况切换订阅不同的视频流质量层级，对应不同的分辨率。 + 默认情况下，调用该方法后观众只能在源频道切换订阅视频的大小流，即在 和 之间切换。如对视频分辨率切换有更高要求，你可以开通 ABR（自适应码率）功能。启用该功能后，你可以自定义不同质量层级的视频流所对应的分辨率，观众可以在专门的转码频道根据需求切换所有质量层级的视频流。详细功能实现详见。

@@ -43,7 +44,7 @@
调用限制 -

如果没有开通 ABR（自适应码率）功能，调用该方法后观众只能在源频道切换视频大小流，即在 和 之间切换。开通 ABR 功能后，你可以自定义不同质量层级的视频流所对应的分辨率，观众可以在专门的转码频道根据需求切换所有质量层级的视频流。详细功能实现详见。

+

调用该方法时如果你未开通 ABR 功能，订阅的视频质量层级只能选择 或 。

参数 @@ -53,7 +54,7 @@ abr_subscription_layer layer 订阅的视频质量层级，详见 。 -

在自定义 至 的分辨率时，可以参考下表进行设置，你也可以根据实际需求自行设置： +

在自定义 至 的分辨率时，可以参考下表进行设置，你也可以根据实际需求自行设置： 视频质量层级 分辨率 @@ -85,7 +86,7 @@ 480p（SD）

- 自定义分辨率时请务必将视频质量层级（Layer）按分辨率从大到小进行排序，分辨率相同时需按帧率从大到小进行排序。 + 自定义分辨率时请务必将视频质量层级（Layer）按分辨率从大到小进行排序，分辨率相同时需按帧率从大到小进行排序。 diff --git a/dita/RTC-NG/API/api_rte_getconfigs.dita b/dita/RTC-NG/API/api_rte_getconfigs.dita index f92f5d5d3e9..4561e656e24 100644 --- a/dita/RTC-NG/API/api_rte_getconfigs.dita +++ b/dita/RTC-NG/API/api_rte_getconfigs.dita @@ -32,9 +32,9 @@

-
+
调用时机 -

该方法需要在 之后调用。

+

调用限制 diff --git a/dita/RTC-NG/API/api_rte_getfrombridge.dita b/dita/RTC-NG/API/api_rte_getfrombridge.dita index 3aaeedcd381..5ffc88a613e 100644 --- a/dita/RTC-NG/API/api_rte_getfrombridge.dita +++ b/dita/RTC-NG/API/api_rte_getfrombridge.dita @@ -30,11 +30,11 @@
v4.5.0
-

调用该方法后无需再额外初始化 RTE 引擎。如果你未创建 RTC 引擎，可直接调用 创建一个 RTE 对象，然后再调用 进行初始化。

+

调用该方法创建的 RTE 对象，无需再通过 进行初始化。如果你之前未创建并初始化 RTC 引擎， 可以先调用 创建一个 RTE对象，然后再调用 进行初始化。

调用时机 -

调用该方法前，请确保已创建并初始化 RTC 引擎。

+

调用该方法前，请确保已调用 初始化 RTC 引擎。

调用限制 diff --git a/dita/RTC-NG/API/api_rte_initmediaengine.dita b/dita/RTC-NG/API/api_rte_initmediaengine.dita index c3a73b1f8b0..6a725942390 100644 --- a/dita/RTC-NG/API/api_rte_initmediaengine.dita +++ b/dita/RTC-NG/API/api_rte_initmediaengine.dita @@ -31,7 +31,6 @@

此方法为异步方法，通过回调函数返回初始化结果。

-

如果初始化过程中出现错误，SDK 会抛出 异常，并返回相应的错误信息。你需要捕获异常并进行处理。

调用时机 @@ -67,5 +66,9 @@
  • ：未成功加入队列。
    • 该返回值仅表示初始化操作是否成功地被安排在异步任务队列中，不表示初始化是否成功。

    - +
    + +

    +
    + diff --git a/dita/RTC-NG/API/api_rte_setconfigs.dita b/dita/RTC-NG/API/api_rte_setconfigs.dita index ba937483103..4824750510b 100644 --- a/dita/RTC-NG/API/api_rte_setconfigs.dita +++ b/dita/RTC-NG/API/api_rte_setconfigs.dita @@ -30,12 +30,12 @@
    v4.5.0
    -

    你可以调用该方法来设置 App ID、SDK 日志文件、服务器的访问区域等信息。

    +

    你可以调用该方法来设置 App ID 等信息。

    调用时机 -

    如果你需要通过该方法设置 App ID，请在 之前调用。如需更新其他配置，可随时调用该方法。

    +

    该方法需要在 之后调用。

    调用限制 diff --git a/dita/RTC-NG/API/class_rteplayerinfo.dita b/dita/RTC-NG/API/class_rteplayerinfo.dita index 96b89845206..45e2d7c0bb7 100644 --- a/dita/RTC-NG/API/class_rteplayerinfo.dita +++ b/dita/RTC-NG/API/class_rteplayerinfo.dita @@ -100,15 +100,15 @@ is_audio_muted isAudioMuted 本地用户是否订阅了音频流： -
    • ：订阅了音频流。
      • -
    • ：未订阅音频流。
     + is_video_muted isVideoMuted 本地用户是否订阅了视频流： -
    • ：订阅了视频流。
      • -
    • ：未订阅视频流。
     +
    • ：未订阅视频流。
      • +
    • ：订阅了视频流。
     video_height diff --git a/dita/RTC-NG/API/enum_rteabrfallbacklayer.dita b/dita/RTC-NG/API/enum_rteabrfallbacklayer.dita index 32db846f25c..e88de4c75df 100644 --- a/dita/RTC-NG/API/enum_rteabrfallbacklayer.dita +++ b/dita/RTC-NG/API/enum_rteabrfallbacklayer.dita @@ -11,6 +11,11 @@
    v4.5.0
    +
      +
    • 使用 至 需开通 ABR 功能。开通后，你可以自定义每一个层级的分辨率，然后选择其中任意一个层级作为视频流回退的最低分辨率。在网络情况差时，SDK 会以此为下限，在此范围内根据网络状况动态调整分辨率。
      • +
    • 自定义分辨率时请务必将视频质量层级（Layer）按分辨率从大到小进行排序，分辨率相同时需按帧率从大到小进行排序。
      • +
    +
    枚举值 @@ -21,9 +26,8 @@ - 1：（默认）回退至最低质量的视频流。该层级的分辨率和码率最低。 - 如果你开启了 ABR 功能，并将回退的质量层级设为 , 弱网情况下 SDK 的回退顺序是：
    • 层级 1 - 6（如有）
      • -
    • 最低质量层级
     + 1：（默认）回退至最低质量的视频流。该层级的分辨率最低。 +     @@ -32,31 +36,27 @@ 3：回退到视频质量层级 1。该层级的分辨率和码率仅低于所订阅的最高质量的视频流。 -
      -
    • 使用 至 需开通 ABR 功能。开通后，你可以自定义每一个层级的分辨率，然后选择其中任意一个层级作为视频流回退的最低分辨率。在网络情况差时，SDK 会以此为下限，在此范围内根据网络状况动态调整分辨率。
      • -
    • 自定义分辨率时请务必将视频质量层级（Layer）按分辨率从大到小进行排序，分辨率相同时需按帧率从大到小进行排序。
      • -
    -     +     - 4：回退到视频质量层级 2。该层级的分辨率和码率仅低于层级 1。 + 4：回退到视频质量层级 2。该层级的分辨率仅低于层级 1。 - 5：回退到视频质量层级 3。该层级的分辨率和码率仅低于层级 2。 + 5：回退到视频质量层级 3。该层级的分辨率仅低于层级 2。 - 5：回退到视频质量层级 4。该层级的分辨率和码率仅低于层级 3。 + 5：回退到视频质量层级 4。该层级的分辨率仅低于层级 3。 - 5：回退到视频质量层级 5。该层级的分辨率和码率仅低于层级 4。 + 5：回退到视频质量层级 5。该层级的分辨率仅低于层级 4。 - 5：回退到视频质量层级 6。该层级的分辨率和码率仅低于层级 5。 + 5：回退到视频质量层级 6。该层级的分辨率仅低于层级 5。
    diff --git a/dita/RTC-NG/API/enum_rteabrsubscriptionlayer.dita b/dita/RTC-NG/API/enum_rteabrsubscriptionlayer.dita index e834d72c540..d27e239d8bf 100644 --- a/dita/RTC-NG/API/enum_rteabrsubscriptionlayer.dita +++ b/dita/RTC-NG/API/enum_rteabrsubscriptionlayer.dita @@ -11,43 +11,43 @@
    v4.5.0
    + 如果需要自定义 至 层级的视频分辨率并进行订阅，请开通 ABR 功能。
    枚举值 - 0：最高质量的视频流。该质量层级的分辨率和码率最高。 + 0：最高质量的视频流。该质量层级的分辨率最高。 - 1：（默认）最低质量的视频流。该质量层级的分辨率和码率最低。 + 1：（默认）最低质量的视频流。该质量层级的分辨率最低。 - 2：视频质量层级 1。该质量层级的分辨率和码率仅低于 。 - 如果需要自定义 至 层级的视频分辨率并进行订阅，请开通 ABR 功能。 - + 2：视频质量层级 1。该质量层级的分辨率仅低于 。 + - 3：视频质量层级 2。该质量层级的分辨率和码率低于 。 + 3：视频质量层级 2。该质量层级的分辨率低于 。 - 4：视频质量层级 3。该质量层级的分辨率和码率低于 。 + 4：视频质量层级 3。该质量层级的分辨率低于 。 - 5：视频质量层级 4。该质量层级的分辨率和码率低于 。 + 5：视频质量层级 4。该质量层级的分辨率低于 。 - 6：视频质量层级 5。该质量层级的分辨率和码率低于 。 + 6：视频质量层级 5。该质量层级的分辨率低于 。 - 7：视频质量层级 6。该质量层级的分辨率和码率低于 。 + 7：视频质量层级 6。该质量层级的分辨率低于 。
    diff --git a/dita/RTC-NG/API/enum_rteplayerevent.dita b/dita/RTC-NG/API/enum_rteplayerevent.dita index 1d05c405615..57e6910e28d 100644 --- a/dita/RTC-NG/API/enum_rteplayerevent.dita +++ b/dita/RTC-NG/API/enum_rteplayerevent.dita @@ -17,11 +17,11 @@ - 5：音频或视频卡顿开始。 + 5：音频或视频出现卡顿。 - 6：音频或视频卡顿结束。 + 6：音频和视频均停止卡顿。 diff --git a/dita/RTC-NG/API/enum_rteplayerstate.dita b/dita/RTC-NG/API/enum_rteplayerstate.dita index 7787147fdfb..cee5d2ea572 100644 --- a/dita/RTC-NG/API/enum_rteplayerstate.dita +++ b/dita/RTC-NG/API/enum_rteplayerstate.dita @@ -45,7 +45,7 @@ - 7：失败状态。当内部发生错误时会报告该状态码。 + 7：失败状态。当内部发生错误时会报告该状态码。如果你收到该状态，需要先调用 然后再调用 重新打开该资源。 diff --git a/dita/RTC-NG/RTC_NG_API_CPP.ditamap b/dita/RTC-NG/RTC_NG_API_CPP.ditamap index d9ceeecb46b..1180a72823f 100644 --- a/dita/RTC-NG/RTC_NG_API_CPP.ditamap +++ b/dita/RTC-NG/RTC_NG_API_CPP.ditamap @@ -479,7 +479,7 @@ - + @@ -492,7 +492,7 @@ - + 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 ca2caba40f3..591e44ce929 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap @@ -1186,11 +1186,11 @@ - SetJsonParameter [1/2] + SetJsonParameter - + SetJsonParameter [2/2] @@ -1228,11 +1228,11 @@ - GetJsonParameter [1/2] + GetJsonParameter - + GetJsonParameter [2/2] @@ -1241,6 +1241,7 @@ + Pause @@ -1277,7 +1278,7 @@ - RegisterObserver_Player + RegisterObserver