From 503f727d57ec4446b5a475a2ca94cd46fae3b330 Mon Sep 17 00:00:00 2001 From: Nero-Hu Date: Thu, 10 Apr 2025 11:01:41 +0800 Subject: [PATCH 1/2] 4.5.2 ditagen api --- dita/RTC-NG/API/api_player_getposition.dita | 70 ++++++++ dita/RTC-NG/API/api_player_seek.dita | 84 +++++++++ dita/RTC-NG/API/api_player_switchwithurl.dita | 90 ++++++++++ .../API/api_playerconfig_getloopcount.dita | 65 +++++++ .../api_playerconfig_getplaybackspeed.dita | 64 +++++++ .../api_playerconfig_getplayoutvolume.dita | 63 +++++++ .../API/api_playerconfig_setloopcount.dita | 86 +++++++++ .../api_playerconfig_setplaybackspeed.dita | 70 ++++++++ .../api_playerconfig_setplayoutvolume.dita | 75 ++++++++ .../api_playerinfo_abrsubscriptionlayer.dita | 57 ++++++ .../api_playerinfo_audiobitspersample.dita | 50 ++++++ .../API/api_playerinfo_audiochannels.dita | 49 +++++ .../API/api_playerinfo_audiosamplerate.dita | 49 +++++ .../RTC-NG/API/api_playerinfo_currenturl.dita | 53 ++++++ dita/RTC-NG/API/api_playerinfo_duration.dita | 51 ++++++ dita/RTC-NG/API/api_playerinfo_hasaudio.dita | 58 ++++++ dita/RTC-NG/API/api_playerinfo_hasvideo.dita | 58 ++++++ .../API/api_playerinfo_isaudiomuted.dita | 60 +++++++ .../API/api_playerinfo_isvideomuted.dita | 60 +++++++ dita/RTC-NG/API/api_playerinfo_state.dita | 52 ++++++ .../API/api_playerinfo_streamcount.dita | 51 ++++++ .../API/api_playerinfo_videoheight.dita | 49 +++++ .../RTC-NG/API/api_playerinfo_videowidth.dita | 49 +++++ dita/RTC-NG/API/rtc_api_data_type.dita | 48 ++--- dita/RTC-NG/RTC_NG_API_Android.ditamap | 49 +++-- dita/RTC-NG/RTC_NG_API_CPP.ditamap | 49 +++-- dita/RTC-NG/RTC_NG_API_iOS.ditamap | 37 ++-- dita/RTC-NG/RTC_NG_API_macOS.ditamap | 37 ++-- .../RTC-NG/config/keys-rtc-ng-api-cpp.ditamap | 167 +++++++++++++++++- .../RTC-NG/config/keys-rtc-ng-api-ios.ditamap | 76 +++++++- .../config/keys-rtc-ng-api-java.ditamap | 153 +++++++++++++++- .../config/keys-rtc-ng-api-macos.ditamap | 76 +++++++- .../config/relations-rtc-ng-api.ditamap | 25 ++- 33 files changed, 2032 insertions(+), 98 deletions(-) create mode 100644 dita/RTC-NG/API/api_player_getposition.dita create mode 100644 dita/RTC-NG/API/api_player_seek.dita create mode 100644 dita/RTC-NG/API/api_player_switchwithurl.dita create mode 100644 dita/RTC-NG/API/api_playerconfig_getloopcount.dita create mode 100644 dita/RTC-NG/API/api_playerconfig_getplaybackspeed.dita create mode 100644 dita/RTC-NG/API/api_playerconfig_getplayoutvolume.dita create mode 100644 dita/RTC-NG/API/api_playerconfig_setloopcount.dita create mode 100644 dita/RTC-NG/API/api_playerconfig_setplaybackspeed.dita create mode 100644 dita/RTC-NG/API/api_playerconfig_setplayoutvolume.dita create mode 100644 dita/RTC-NG/API/api_playerinfo_abrsubscriptionlayer.dita create mode 100644 dita/RTC-NG/API/api_playerinfo_audiobitspersample.dita create mode 100644 dita/RTC-NG/API/api_playerinfo_audiochannels.dita create mode 100644 dita/RTC-NG/API/api_playerinfo_audiosamplerate.dita create mode 100644 dita/RTC-NG/API/api_playerinfo_currenturl.dita create mode 100644 dita/RTC-NG/API/api_playerinfo_duration.dita create mode 100644 dita/RTC-NG/API/api_playerinfo_hasaudio.dita create mode 100644 dita/RTC-NG/API/api_playerinfo_hasvideo.dita create mode 100644 dita/RTC-NG/API/api_playerinfo_isaudiomuted.dita create mode 100644 dita/RTC-NG/API/api_playerinfo_isvideomuted.dita create mode 100644 dita/RTC-NG/API/api_playerinfo_state.dita create mode 100644 dita/RTC-NG/API/api_playerinfo_streamcount.dita create mode 100644 dita/RTC-NG/API/api_playerinfo_videoheight.dita create mode 100644 dita/RTC-NG/API/api_playerinfo_videowidth.dita diff --git a/dita/RTC-NG/API/api_player_getposition.dita b/dita/RTC-NG/API/api_player_getposition.dita new file mode 100644 index 00000000000..d16dd67596a --- /dev/null +++ b/dita/RTC-NG/API/api_player_getposition.dita @@ -0,0 +1,70 @@ + + + + <ph keyref="GetPosition"/> + 获取当前的播放位置。 + + + + + + + + +
+

+ public long getPosition() throws RteException + + - (uint64_t)getPosition:(AgoraRteError * _Nullable)error; + uint64_t GetPosition(Error *err = nullptr) + + + + +

+
+
+
+ +
自从：
+
自 v4.5.1 版本新增。
+ +
+

+
+
+ 调用限制 +

无。

+
+
+ 参数 + + + err + error + 输出参数，用于返回跳转失败时的错误信息，详见 。 + 输出参数，表示错误码： +
    +
  • ：成功。
    • +
  • ：
      +
    • 对应的内部 对象已被销毁或无效。
      • +
    • 打开的 URL 是 RTE URL，不支持跳转播放位置。详见 。
      • +
    +
    • +
+ + +
+
+ <ph keyref="return-section-title"/> +

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

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

方法调用成功，返回当前的播放位置，单位为毫秒。

+

方法调用成功，返回当前播放位置，单位为毫秒。

+

方法调用成功时，返回当前的播放位置，单位为毫秒。

+
+ + diff --git a/dita/RTC-NG/API/api_player_seek.dita b/dita/RTC-NG/API/api_player_seek.dita new file mode 100644 index 00000000000..fe889c87bdb --- /dev/null +++ b/dita/RTC-NG/API/api_player_seek.dita @@ -0,0 +1,84 @@ + + + + <ph keyref="Seek"/> + 跳转播放位置。 + + + + + + + + +
+

+ public void seek(long newTime) throws RteException + + - (BOOL)seek:(uint64_t)newTime error:(AgoraRteError * _Nullable)error; + bool Seek(uint64_t new_time, Error *err = nullptr) + + + + +

+
+
+
+ +
自从：
+
自 v4.5.1 版本新增。
+ +
+

+
+
+ 调用限制 +

无。

+
+
+ 参数 + + + new_time + newTime + 要跳转到的播放位置，单位为毫秒。 + 你希望跳转到的播放位置。 + 要跳转到的新播放位置。 + + + err + error + 输出参数，用于返回跳转失败时的错误信息，详见 。 + 输出参数，表示错误码： +
    +
  • ：成功。
    • +
  • ：
      +
    • 对应的内部 对象已被销毁或无效。
      • +
    • 打开的 URL 是 RTE URL，不支持跳转播放位置。详见 。
      • +
    +
    • +
+ + +
+
+ <ph keyref="return-section-title"/> +

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

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

    +
  • ：跳转成功。
    • +
  • ：跳转失败。
    • +
+

+

    +
  • ：跳转成功。
    • +
  • ：跳转失败。你可以通过 参数查看具体错误信息。
    • +
+

+
+ + diff --git a/dita/RTC-NG/API/api_player_switchwithurl.dita b/dita/RTC-NG/API/api_player_switchwithurl.dita new file mode 100644 index 00000000000..092b23fe0f2 --- /dev/null +++ b/dita/RTC-NG/API/api_player_switchwithurl.dita @@ -0,0 +1,90 @@ + + + + <ph keyref="SwitchWithUrl"/> + 在播放过程中切换至新的 URL。 + + + + + + + + +
+

+ public void switchWithUrl(String url, boolean syncPts, AsyncCallback callback) + + - (void)switchWithUrl:(NSString * _Nonnull)url syncPts:(BOOL)syncPts cb:(void (^_Nullable)(AgoraRteError* _Nullable err))cb; + void SwitchWithUrl(const char* url, bool sync_pts, std::function&lt;void(rte::Error* err)&gt; cb) + + + + +

+
+
+
+ +
自从：
+
自 v4.5.1 版本新增。
+ +
+

+ - 该方法仅在播放器打开的 URL 为非灵隼物联网云平台 URL 时有效。 +- 请在 SDK 返回播放器状态为 `kRtePlayerStateOpenCompleted` 时调用该方法。 + 该方法仅在播放器打开的是非互动直播（非 RTE）URL 时有效。请在 SDK 返回播放器状态为 `AgoraRtePlayerStateOpenCompleted` 时调用该方法。 + 该方法仅在播放器打开的 URL 为非 RTE URL 时有效。请在 SDK 返回播放器状态为 `PlayerState.OPEN_COMPLETED` 时调用该方法。 +
+
+ 调用限制 +

无。

+
+
+ 参数 + + + url + 要切换的 URL 资源。 + 要切换到的新 URL。 + 要切换的新 URL。 + + + syncPts + sync_pts + 是否在切换后同步播放位置（单位为毫秒）： +
    +
  • ：同步播放位置。
    • +
  • ：不同步播放位置。
    • +
+ +
    +
  • ：切换后同步播放位置（单位为毫秒）。
    • +
  • ：切换后不同步播放位置。
    • +
+ + 切换后是否同步播放位置（毫秒）： +
    +
  • ：同步播放位置。
    • +
  • ：（默认）不同步播放位置。
    • +
+ + + + callback + cb + 异步回调，用于通知切换操作的结果，详见 。 + 异步通知切换操作结果的回调。你可以通过该回调的 err 参数得知操作的结果或错误码信息，详见 。 + 异步通知切换操作结果的回调。你可以通过该回调的 err 参数得知操作的结果或错误码信息，详见 。 + +
+
+ <ph keyref="return-section-title"/> +

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

+
    +
  • 0: 方法调用成功。
    • +
  • < 0: 方法调用失败。详见了解详情和解决建议。
    • +
+
+ + diff --git a/dita/RTC-NG/API/api_playerconfig_getloopcount.dita b/dita/RTC-NG/API/api_playerconfig_getloopcount.dita new file mode 100644 index 00000000000..68d0aff1b25 --- /dev/null +++ b/dita/RTC-NG/API/api_playerconfig_getloopcount.dita @@ -0,0 +1,65 @@ + + + + <ph keyref="GetLoopCount"/> + 获取媒体文件的循环次数参数。 + + + + + + + + +
+

+ public int getLoopCount() throws RteException + + - (int32_t)loopCount:(AgoraRteError * _Nullable)error; + int32_t GetLoopCount(Error *err = nullptr) + + + + +

+
+
+
+ +
自从：
+
自 v4.5.1 版本新增。
+ +
+

+
+
+ 调用限制 +

无。

+
+
+ 参数 + + + err + error + 输出参数，状态或错误信息，详见 。 +
    +
  • ：表示成功。
    • +
+ + 输出参数，表示错误信息。详见 。 + +
+
+ <ph keyref="return-section-title"/> +

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

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

方法调用成功，返回媒体文件的循环次数。

+

方法调用成功，返回媒体文件的循环播放次数。

+

方法调用成功时，返回媒体文件的循环播放次数。

+
+ + diff --git a/dita/RTC-NG/API/api_playerconfig_getplaybackspeed.dita b/dita/RTC-NG/API/api_playerconfig_getplaybackspeed.dita new file mode 100644 index 00000000000..222fc8d4994 --- /dev/null +++ b/dita/RTC-NG/API/api_playerconfig_getplaybackspeed.dita @@ -0,0 +1,64 @@ + + + + <ph keyref="GetPlaybackSpeed"/> + 获取播放速度参数。 + + + + + + + + +
+

+ public int getPlaybackSpeed() throws RteException + + - (int32_t)playbackSpeed:(AgoraRteError * _Nullable)error; + int32_t GetPlaybackSpeed(Error *err = nullptr) + + + + +

+
+
+
+ +
自从：
+
自 v4.5.1 版本新增。
+ +
+

+
+
+ 调用限制 +

无。

+
+
+ 参数 + + + err + error + 状态或错误信息，详见 。 +
    +
  • ：表示成功。
    • +
+ + 输出参数，表示错误信息。详见 。 + +
+
+ <ph keyref="return-section-title"/> +

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

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

方法调用成功，返回播放速度的值。

+

方法调用成功，返回播放速度的数值。

+
+ + diff --git a/dita/RTC-NG/API/api_playerconfig_getplayoutvolume.dita b/dita/RTC-NG/API/api_playerconfig_getplayoutvolume.dita new file mode 100644 index 00000000000..98374c92eba --- /dev/null +++ b/dita/RTC-NG/API/api_playerconfig_getplayoutvolume.dita @@ -0,0 +1,63 @@ + + + + <ph keyref="GetPlayoutVolume"/> + 获取播放器的播放音量。 + + + + + + + + +
+

+ public int getPlayoutVolume() throws RteException + + - (int32_t)playoutVolume:(AgoraRteError * _Nullable)error; + int32_t GetPlayoutVolume(Error *err = nullptr) + + + + +

+
+
+
+ +
自从：
+
自 v4.5.1 版本新增。
+ +
+

+
+
+ 调用限制 +

无。

+
+
+ 参数 + + + err + error + 状态或错误信息，详见 。 +
    +
  • ：表示成功。
    • +
+ + 输出参数，返回错误信息。详见 。 + +
+
+ <ph keyref="return-section-title"/> +

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

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

方法调用成功，返回播放器的音量值。

+
+ + diff --git a/dita/RTC-NG/API/api_playerconfig_setloopcount.dita b/dita/RTC-NG/API/api_playerconfig_setloopcount.dita new file mode 100644 index 00000000000..c9b1dd1a4d7 --- /dev/null +++ b/dita/RTC-NG/API/api_playerconfig_setloopcount.dita @@ -0,0 +1,86 @@ + + + + <ph keyref="SetLoopCount"/> + 设置媒体文件的循环播放次数。 + + + + + + + + +
+

+ public void setLoopCount(int count) throws RteException + + - (void)setLoopCount:(int32_t)count error:(AgoraRteError * _Nullable)error; + void SetLoopCount(int32_t count, Error *err = nullptr) + + + + +

+
+
+
+ +
自从：
+
自 v4.5.1 版本新增。
+ +
+

你可以通过该方法设置媒体文件的播放次数，例如播放一次、两次，或无限循环播放，直到调用 stop 方法停止播放。

+
+
+ 调用限制 +

无。

+
+
+ 参数 + + + count + 媒体文件的循环播放次数： +
    +
  • 0：播放一次。
    • +
  • 1：播放两次。
    • +
  • -1：无限循环播放，直到调用 方法停止播放。
    • +
+ + 媒体文件的循环播放次数。 +
    +
  • 0：播放一次。
    • +
  • 1：播放两次。
    • +
  • -1：无限循环播放，直到调用 方法停止。
    • +
+ + 媒体文件的循环播放次数。 +
    +
  • 0：播放一次。
    • +
  • 1：播放两次。
    • +
  • -1：无限循环播放，直到调用 停止播放。
    • +
+ + + + error + err + 输出参数，返回调用结果。详见 。 + 状态或错误信息，详见 。 +
    +
  • ：成功。
    • +
+ + +
+
+ <ph keyref="return-section-title"/> +

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

+
    +
  • 0: 方法调用成功。
    • +
  • < 0: 方法调用失败。详见了解详情和解决建议。
    • +
+
+ + diff --git a/dita/RTC-NG/API/api_playerconfig_setplaybackspeed.dita b/dita/RTC-NG/API/api_playerconfig_setplaybackspeed.dita new file mode 100644 index 00000000000..cb992776056 --- /dev/null +++ b/dita/RTC-NG/API/api_playerconfig_setplaybackspeed.dita @@ -0,0 +1,70 @@ + + + + <ph keyref="SetPlaybackSpeed"/> + 设置播放速度参数。 + + + + + + + + +
+

+ public void setPlaybackSpeed(int speed) throws RteException + + - (void)setPlaybackSpeed:(int32_t)speed error:(AgoraRteError * _Nullable)error; + void SetPlaybackSpeed(int32_t speed, Error *err = nullptr) + + + + +

+
+
+
+ +
自从：
+
自 v4.5.1 版本新增。
+ +
+

你可以在调用 方法之后调用此方法。

+ 你可以在调用 `OpenWithUrl` 方法之后调用此方法。 + 你可以在调用 `openWithUrl:startTime:cb:` 方法之后调用此方法。 +
+
+ 调用限制 +

无。

+
+
+ 参数 + + + speed + 播放速度。取值范围为 [50, 400]。 + 播放速度，取值范围为 [50, 400]。 + + + error + err + 输出参数，用于返回错误信息，详见 。 + 状态或错误信息，详见 。 +
    +
  • ：调用成功。
    • +
  • ：speed 参数设置为非法值。
    • +
+ + +
+
+ <ph keyref="return-section-title"/> +

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

+
    +
  • 0: 方法调用成功。
    • +
  • < 0: 方法调用失败。详见了解详情和解决建议。
    • +
+
+ + diff --git a/dita/RTC-NG/API/api_playerconfig_setplayoutvolume.dita b/dita/RTC-NG/API/api_playerconfig_setplayoutvolume.dita new file mode 100644 index 00000000000..414aec5c07f --- /dev/null +++ b/dita/RTC-NG/API/api_playerconfig_setplayoutvolume.dita @@ -0,0 +1,75 @@ + + + + <ph keyref="SetPlayoutVolume"/> + 设置播放音量参数。 + + + + + + + + +
+

+ public void setPlayoutVolume(int volume) throws RteException + + - (void)setPlayoutVolume:(int32_t)volume error:(AgoraRteError * _Nullable)error; + void SetPlayoutVolume(int32_t volume, Error *err = nullptr) + + + + +

+
+
+
+ +
自从：
+
自 v4.5.1 版本新增。
+ +
+

你可以通过该方法设置播放音量，取值范围为 [0, 400]。

+
+
+ 调用限制 +

无。

+
+
+ 参数 + + + volume + 播放器的音量值。取值范围为 [0, 400]。 + 要设置的播放音量，取值范围为 [0, 400]。 + 要设置的音量值，取值范围为 [0, 400]。 + + + error + err + 输出参数，返回错误信息，详见 。 +
    +
  • ：设置成功。
    • +
  • ：音量参数非法。
    • +
+ + 状态或错误信息，详见 。 +可能的错误码包括： +
    +
  • ：设置成功。
    • +
  • ：音量参数设置为非法值。
    • +
+ + +
+
+ <ph keyref="return-section-title"/> +

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

+
    +
  • 0: 方法调用成功。
    • +
  • < 0: 方法调用失败。详见了解详情和解决建议。
    • +
+
+ + diff --git a/dita/RTC-NG/API/api_playerinfo_abrsubscriptionlayer.dita b/dita/RTC-NG/API/api_playerinfo_abrsubscriptionlayer.dita new file mode 100644 index 00000000000..07787c3d04c --- /dev/null +++ b/dita/RTC-NG/API/api_playerinfo_abrsubscriptionlayer.dita @@ -0,0 +1,57 @@ + + + + <ph keyref="AbrSubscriptionLayer"/> + 获取当前订阅的视频层级。 + + + + + + + + +
+

+ public Constants.AbrSubscriptionLayer abrSubscriptionLayer() + + + AbrSubscriptionLayer AbrSubscriptionLayer() const + + + + +

+
+
+
+ +
自从：
+
自 v4.5.1 版本新增。
+ +
+

该字段仅在打开 RTE URL 时有效。

+ 该字段仅在你打开 RTE URL 时有效。 +
+
+ 调用限制 +

无。

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

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

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

    +
  • 方法调用成功，返回当前订阅的视频层级，详见 。
    • +
+

+

    +
  • 方法调用成功，返回 对象，详见 。
    • +
+

+
+ + diff --git a/dita/RTC-NG/API/api_playerinfo_audiobitspersample.dita b/dita/RTC-NG/API/api_playerinfo_audiobitspersample.dita new file mode 100644 index 00000000000..bd0414072a0 --- /dev/null +++ b/dita/RTC-NG/API/api_playerinfo_audiobitspersample.dita @@ -0,0 +1,50 @@ + + + + <ph keyref="AudioBitsPerSample"/> + 获取每个音频采样点的位数。 + + + + + + + + +
+

+ public int audioBitsPerSample() + + + int AudioBitsPerSample() const + + + + +

+
+
+
+ +
自从：
+
自 v4.5.1 版本新增。
+ +
+

+ 该字段仅在打开非 RTE URL 时有效。 +
+
+ 调用限制 +

无。

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

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

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

方法调用成功，返回每个音频采样点的位数，单位为 bit。

+
+ + diff --git a/dita/RTC-NG/API/api_playerinfo_audiochannels.dita b/dita/RTC-NG/API/api_playerinfo_audiochannels.dita new file mode 100644 index 00000000000..1e9cf951905 --- /dev/null +++ b/dita/RTC-NG/API/api_playerinfo_audiochannels.dita @@ -0,0 +1,49 @@ + + + + <ph keyref="AudioChannels"/> + 获取音频的声道数量。 + + + + + + + + +
+

+ + + + int AudioChannels() const + + + + +

+
+
+
+ +
自从：
+
自 v4.5.1 版本新增。
+ +
+

+
+
+ 调用限制 +

无。

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

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

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

方法调用成功，返回音频的声道数量。

+
+ + diff --git a/dita/RTC-NG/API/api_playerinfo_audiosamplerate.dita b/dita/RTC-NG/API/api_playerinfo_audiosamplerate.dita new file mode 100644 index 00000000000..27a0ad35f60 --- /dev/null +++ b/dita/RTC-NG/API/api_playerinfo_audiosamplerate.dita @@ -0,0 +1,49 @@ + + + + <ph keyref="AudioSampleRate"/> + 获取音频采样率。 + + + + + + + + +
+

+ public int audioSampleRate() + + + int AudioSampleRate() const + + + + +

+
+
+
+ +
自从：
+
自 v4.5.1 版本新增。
+ +
+

+
+
+ 调用限制 +

无。

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

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

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

方法调用成功，返回音频采样率，单位为 Hz。

+
+ + diff --git a/dita/RTC-NG/API/api_playerinfo_currenturl.dita b/dita/RTC-NG/API/api_playerinfo_currenturl.dita new file mode 100644 index 00000000000..7d8d5ef8c5c --- /dev/null +++ b/dita/RTC-NG/API/api_playerinfo_currenturl.dita @@ -0,0 +1,53 @@ + + + + <ph keyref="CurrentUrl"/> + 获取当前正在播放的 URL。 + + + + + + + + +
+

+ public String currentUrl() + + + std::string CurrentUrl() const + + + + +

+
+
+
+ +
自从：
+
自 v4.5.1 版本新增。
+ +
+

+
+
+ 调用限制 +

无。

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

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

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

    +
  • 方法调用成功时，返回当前正在播放的 URL。
    • +
  • 方法调用失败，返回空字符串。
    • +
+

+
+ + diff --git a/dita/RTC-NG/API/api_playerinfo_duration.dita b/dita/RTC-NG/API/api_playerinfo_duration.dita new file mode 100644 index 00000000000..eba6e0c89aa --- /dev/null +++ b/dita/RTC-NG/API/api_playerinfo_duration.dita @@ -0,0 +1,51 @@ + + + + <ph keyref="Duration"/> + 获取当前媒体资源的时长。 + + + + + + + + +
+

+ public long duration() + + + size_t Duration() const + + + + +

+
+
+
+ +
自从：
+
自 v4.5.1 版本新增。
+ +
+

+ 仅在播放本地媒体文件或点播流时有效。 + 该方法仅在播放本地媒体文件或点播流时有效。 +
+
+ 调用限制 +

无。

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

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

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

方法调用成功，返回当前媒体资源的时长，单位为毫秒。

+
+ + diff --git a/dita/RTC-NG/API/api_playerinfo_hasaudio.dita b/dita/RTC-NG/API/api_playerinfo_hasaudio.dita new file mode 100644 index 00000000000..0700327ee62 --- /dev/null +++ b/dita/RTC-NG/API/api_playerinfo_hasaudio.dita @@ -0,0 +1,58 @@ + + + + <ph keyref="HasAudio"/> + 判断媒体资源中是否包含音频流。 + + + + + + + + +
+

+ public boolean hasAudio() + + + bool HasAudio() const + + + + +

+
+
+
+ +
自从：
+
自 v4.5.1 版本新增。
+ +
+

表示 URL 源是否包含音频流。

+
+
+ 调用限制 +

无。

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

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

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

    +
  • ：媒体资源中包含音频流。
    • +
  • ：媒体资源中不包含音频流。
    • +
+

+

    +
  • ：URL 源包含音频流。
    • +
  • ：URL 源不包含音频流。
    • +
+

+
+ + diff --git a/dita/RTC-NG/API/api_playerinfo_hasvideo.dita b/dita/RTC-NG/API/api_playerinfo_hasvideo.dita new file mode 100644 index 00000000000..24274dc668e --- /dev/null +++ b/dita/RTC-NG/API/api_playerinfo_hasvideo.dita @@ -0,0 +1,58 @@ + + + + <ph keyref="HasVideo"/> + 判断是否包含视频流。 + + + + + + + + +
+

+ public boolean hasVideo() + + + bool HasVideo() const + + + + +

+
+
+
+ +
自从：
+
自 v4.5.1 版本新增。
+ +
+

+
+
+ 调用限制 +

无。

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

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

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

    +
  • ：URL 源中包含视频流。
    • +
  • ：URL 源中不包含视频流。
    • +
+

+

    +
  • ：URL 源包含视频流。
    • +
  • ：URL 源不包含视频流。
    • +
+

+
+ + diff --git a/dita/RTC-NG/API/api_playerinfo_isaudiomuted.dita b/dita/RTC-NG/API/api_playerinfo_isaudiomuted.dita new file mode 100644 index 00000000000..421a604e289 --- /dev/null +++ b/dita/RTC-NG/API/api_playerinfo_isaudiomuted.dita @@ -0,0 +1,60 @@ + + + + <ph keyref="IsAudioMuted"/> + 判断播放器是否停止接收音频流。 + + + + + + + + +
+

+ public boolean isAudioMuted() + + + bool IsAudioMuted() const + + + + +

+
+
+
+ +
自从：
+
自 v4.5.1 版本新增。
+
自 v4.4.0 版本新增。
+ +
+

+
+
+ 调用限制 +

无。

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

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

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

bool 类型。 +

    +
  • ：播放器已停止接收音频流。
    • +
  • ：播放器仍在接收音频流。
    • +
+

+

    +
  • ：停止接收音频流。
    • +
  • ：继续接收音频流。
    • +
+

+
+ + diff --git a/dita/RTC-NG/API/api_playerinfo_isvideomuted.dita b/dita/RTC-NG/API/api_playerinfo_isvideomuted.dita new file mode 100644 index 00000000000..24ac7b0b5ed --- /dev/null +++ b/dita/RTC-NG/API/api_playerinfo_isvideomuted.dita @@ -0,0 +1,60 @@ + + + + <ph keyref="IsVideoMuted"/> + 判断播放器是否停止接收视频流。 + + + + + + + + +
+

+ public boolean isVideoMuted() + + + bool IsVideoMuted() const + + + + +

+
+
+
+ +
自从：
+
自 v4.5.1 版本新增。
+
自 v4.4.0 版本新增。
+ +
+

+ `IsVideoMuted` 接口仅在打开 RTE URL 时有效。 +
+
+ 调用限制 +

无。

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

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

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

    +
  • ：播放器已停止接收视频流。
    • +
  • ：播放器仍在接收视频流。
    • +
+

+

    +
  • ：停止接收视频流。
    • +
  • ：继续接收视频流。
    • +
+

+
+ + diff --git a/dita/RTC-NG/API/api_playerinfo_state.dita b/dita/RTC-NG/API/api_playerinfo_state.dita new file mode 100644 index 00000000000..20900383693 --- /dev/null +++ b/dita/RTC-NG/API/api_playerinfo_state.dita @@ -0,0 +1,52 @@ + + + + <ph keyref="State"/> + 获取当前播放器状态。 + + + + + + + + +
+

+ + + + RtePlayerState State() const + + + + +

+
+
+
+ +
自从：
+
自 v4.5.1 版本新增。
+ +
+

+
+
+ 调用限制 +

无。

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

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

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

    +
  • 方法调用成功，返回当前播放器状态，详见 。
    • +
+

+
+ + diff --git a/dita/RTC-NG/API/api_playerinfo_streamcount.dita b/dita/RTC-NG/API/api_playerinfo_streamcount.dita new file mode 100644 index 00000000000..828508470bd --- /dev/null +++ b/dita/RTC-NG/API/api_playerinfo_streamcount.dita @@ -0,0 +1,51 @@ + + + + <ph keyref="StreamCount"/> + 获取当前播放源中的流的数量。 + + + + + + + + +
+

+ public int streamCount() + + + size_t StreamCount() const + + + + +

+
+
+
+ +
自从：
+
自 v4.5.1 版本新增。
+ +
+

该方法仅在打开非 RTE URL 时有效。

+ 该方法在打开非 RTE URL 时有效。 +
+
+ 调用限制 +

无。

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

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

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

方法调用成功，返回当前播放源中的流的数量。

+

方法调用成功，返回流的数量。

+
+ + diff --git a/dita/RTC-NG/API/api_playerinfo_videoheight.dita b/dita/RTC-NG/API/api_playerinfo_videoheight.dita new file mode 100644 index 00000000000..3214f9d0221 --- /dev/null +++ b/dita/RTC-NG/API/api_playerinfo_videoheight.dita @@ -0,0 +1,49 @@ + + + + <ph keyref="VideoHeight"/> + 获取视频分辨率高度。 + + + + + + + + +
+

+ public int videoHeight() + + + int VideoHeight() const + + + + +

+
+
+
+ +
自从：
+
自 v4.5.1 版本新增。
+ +
+

+
+
+ 调用限制 +

无。

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

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

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

方法调用成功，返回视频分辨率的高度，单位为像素。

+
+ + diff --git a/dita/RTC-NG/API/api_playerinfo_videowidth.dita b/dita/RTC-NG/API/api_playerinfo_videowidth.dita new file mode 100644 index 00000000000..d57f927dbce --- /dev/null +++ b/dita/RTC-NG/API/api_playerinfo_videowidth.dita @@ -0,0 +1,49 @@ + + + + <ph keyref="VideoWidth"/> + 获取视频分辨率宽度。 + + + + + + + + +
+

+ public int videoWidth() + + + int VideoWidth() const + + + + +

+
+
+
+ +
自从：
+
自 v4.5.1 版本新增。
+ +
+

+
+
+ 调用限制 +

无。

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

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

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

方法调用成功，返回视频分辨率的宽度，单位为像素。

+
+ + diff --git a/dita/RTC-NG/API/rtc_api_data_type.dita b/dita/RTC-NG/API/rtc_api_data_type.dita index 9965df3a56e..17ae48e1155 100644 --- a/dita/RTC-NG/API/rtc_api_data_type.dita +++ b/dita/RTC-NG/API/rtc_api_data_type.dita @@ -1,4 +1,4 @@ - + <ph keyref="typedef"/> @@ -328,7 +328,7 @@
    • -
    • +
    • @@ -385,12 +385,13 @@
    • -
    • +
    • @@ -453,9 +454,9 @@
    • -
    • -
    • +
    • +
    • @@ -463,22 +464,22 @@
    • -
    • +
    • -
    • +
    • -
    • +
    • @@ -500,27 +501,30 @@
    • -
    • +
    • - +
    • -
    • +
    • @@ -574,9 +578,9 @@
    • -
    • -
    • +
    • +
    • @@ -586,15 +590,15 @@
    • -
    • +
    • -
    • +
    • @@ -617,10 +621,8 @@
    • -
    • -
    • - + -     + \ No newline at end of file diff --git a/dita/RTC-NG/RTC_NG_API_Android.ditamap b/dita/RTC-NG/RTC_NG_API_Android.ditamap index 85000530fa2..14192b00fd9 100644 --- a/dita/RTC-NG/RTC_NG_API_Android.ditamap +++ b/dita/RTC-NG/RTC_NG_API_Android.ditamap @@ -1,4 +1,4 @@ - + Android API Reference @@ -58,10 +58,23 @@ + + + + + + + + + + + + + @@ -72,16 +85,6 @@ - - - - - - - - - - @@ -95,8 +98,26 @@ + + + + + + + + + + + + + + + + + + - + @@ -704,7 +725,7 @@ - + @@ -822,4 +843,4 @@ - + \ No newline at end of file diff --git a/dita/RTC-NG/RTC_NG_API_CPP.ditamap b/dita/RTC-NG/RTC_NG_API_CPP.ditamap index c9388d308d1..8f099857914 100644 --- a/dita/RTC-NG/RTC_NG_API_CPP.ditamap +++ b/dita/RTC-NG/RTC_NG_API_CPP.ditamap @@ -1,4 +1,4 @@ - + C++ API Reference for All Platforms @@ -59,8 +59,22 @@ + + + + + + + + + + + + + + @@ -71,16 +85,6 @@ - - - - - - - - - - @@ -94,8 +98,27 @@ + + + + + + + + + + + + + + + + + + + - + @@ -886,4 +909,4 @@ - + \ No newline at end of file diff --git a/dita/RTC-NG/RTC_NG_API_iOS.ditamap b/dita/RTC-NG/RTC_NG_API_iOS.ditamap index 03130ad447d..49b76f45445 100644 --- a/dita/RTC-NG/RTC_NG_API_iOS.ditamap +++ b/dita/RTC-NG/RTC_NG_API_iOS.ditamap @@ -1,4 +1,4 @@ - + iOS API Reference @@ -55,30 +55,24 @@ + + + + + - - - - - - - - - - - @@ -92,8 +86,23 @@ + + + + + + + + + + + + + + + - + @@ -808,4 +817,4 @@ - + \ No newline at end of file diff --git a/dita/RTC-NG/RTC_NG_API_macOS.ditamap b/dita/RTC-NG/RTC_NG_API_macOS.ditamap index 27091a429a0..c1879650332 100644 --- a/dita/RTC-NG/RTC_NG_API_macOS.ditamap +++ b/dita/RTC-NG/RTC_NG_API_macOS.ditamap @@ -1,4 +1,4 @@ - + @@ -50,30 +50,24 @@ + + + + + - - - - - - - - - - - @@ -87,8 +81,23 @@ + + + + + + + + + + + + + + + - + @@ -759,4 +768,4 @@ - + \ No newline at end of file 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 efb1ab271ab..4014dcefc21 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap @@ -1,4 +1,4 @@ - + Keys RTC NG C++ API @@ -1310,6 +1310,167 @@ + + + + State + + + + + + + Duration + + + + + + + StreamCount + + + + + + + HasAudio + + + + + + + HasVideo + + + + + + + IsAudioMuted + + + + + + + IsVideoMuted + + + + + + + VideoHeight + + + + + + + VideoWidth + + + + + + + AbrSubscriptionLayer + + + + + + + AudioSampleRate + + + + + + + AudioChannels + + + + + + + AudioBitsPerSample + + + + + + + CurrentUrl + + + + + + + SetPlaybackSpeed + + + + + + + GetPlaybackSpeed + + + + + + + SetPlayoutVolume + + + + + + + GetPlayoutVolume + + + + + + + SetLoopCount + + + + + + + GetLoopCount + + + + + + + SwitchWithUrl + + + + + + + Seek + + + + + + + GetPosition + + + @@ -14240,7 +14401,7 @@ - C:\Users\<user_name>\AppData\Local\Agora\<process_name>\example.jpg + C:\Users\<user_name>\AppData\Local\Agora\<process_name>\example.jpg @@ -14336,4 +14497,4 @@ - + \ No newline at end of file diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-ios.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-ios.ditamap index aa9deff270c..db8d3e99079 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-ios.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-ios.ditamap @@ -1,4 +1,4 @@ - + Keys RTC NG Objective-C API @@ -1207,6 +1207,69 @@ + + + + setPlaybackSpeed + + + + + + + playbackSpeed + + + + + + + setPlayoutVolume + + + + + + + playoutVolume + + + + + + + setLoopCount + + + + + + + loopCount + + + + + + + switchWithUrl + + + + + + + seek + + + + + + + getPosition + + + @@ -6003,7 +6066,14 @@ - + + + + AgoraRtePlayerInfo + + + + @@ -13296,4 +13366,4 @@ - + \ No newline at end of file diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap index 2454503264f..3f0587fbe70 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap @@ -1,4 +1,4 @@ - + Keys RTC NG Java API @@ -1253,6 +1253,153 @@ + + + + duration + + + + + + + streamCount + + + + + + + hasAudio + + + + + + + hasVideo + + + + + + + isAudioMuted + + + + + + + isVideoMuted + + + + + + + videoHeight + + + + + + + videoWidth + + + + + + + abrSubscriptionLayer + + + + + + + audioSampleRate + + + + + + + audioBitsPerSample + + + + + + + currentUrl + + + + + + + setPlaybackSpeed + + + + + + + getPlaybackSpeed + + + + + + + setPlayoutVolume + + + + + + + getPlayoutVolume + + + + + + + setLoopCount + + + + + + + getLoopCount + + + + + + + switchWithUrl + + + + + + + seek + + + + + + + getPosition + + + @@ -13448,7 +13595,7 @@ - /storage/emulated/0/Android/data/<packagename>/files/example.jpg + /storage/emulated/0/Android/data/<packagename>/files/example.jpg @@ -13559,4 +13706,4 @@ - + \ No newline at end of file diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-macos.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-macos.ditamap index 2acd7cb3804..ffdda0e8412 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-macos.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-macos.ditamap @@ -1,4 +1,4 @@ - + Keys RTC NG Objective-C API @@ -1164,6 +1164,69 @@ + + + + setPlaybackSpeed + + + + + + + playbackSpeed + + + + + + + setPlayoutVolume + + + + + + + playoutVolume + + + + + + + setLoopCount + + + + + + + loopCount + + + + + + + switchWithUrl + + + + + + + seek + + + + + + + getPosition + + + @@ -5614,7 +5677,14 @@ - + + + + AgoraRtePlayerInfo + + + + @@ -12749,4 +12819,4 @@ - + \ No newline at end of file diff --git a/dita/RTC-NG/config/relations-rtc-ng-api.ditamap b/dita/RTC-NG/config/relations-rtc-ng-api.ditamap index 1186ccb62ee..3508ae8468b 100644 --- a/dita/RTC-NG/config/relations-rtc-ng-api.ditamap +++ b/dita/RTC-NG/config/relations-rtc-ng-api.ditamap @@ -1,4 +1,4 @@ - + Relations @@ -2470,7 +2470,7 @@ - + @@ -3377,22 +3377,25 @@ + + + + + + - - - + - - + @@ -3404,9 +3407,15 @@ + + + + + + @@ -3442,4 +3451,4 @@ - + \ No newline at end of file From 704d9eb5f4988b51289394027dedbb3d0ede61e9 Mon Sep 17 00:00:00 2001 From: Nero-Hu Date: Thu, 10 Apr 2025 15:36:00 +0800 Subject: [PATCH 2/2] new data.json --- dita/RTC-NG/API/api_player_getposition.dita | 27 ++++++++---- dita/RTC-NG/API/api_player_seek.dita | 2 +- dita/RTC-NG/API/api_player_switchwithurl.dita | 42 ++++++++++--------- .../API/api_playerconfig_setloopcount.dita | 14 +++---- .../api_playerconfig_setplaybackspeed.dita | 3 +- .../API/api_playerinfo_isaudiomuted.dita | 5 +-- .../API/api_playerinfo_isvideomuted.dita | 2 +- 7 files changed, 53 insertions(+), 42 deletions(-) diff --git a/dita/RTC-NG/API/api_player_getposition.dita b/dita/RTC-NG/API/api_player_getposition.dita index d16dd67596a..a990a11f356 100644 --- a/dita/RTC-NG/API/api_player_getposition.dita +++ b/dita/RTC-NG/API/api_player_getposition.dita @@ -30,7 +30,7 @@
    自 v4.5.1 版本新增。
    -

    +

    该方法用于获取当前播放的时间位置，单位为毫秒。

    调用限制 @@ -40,15 +40,25 @@ 参数 - err error - 输出参数，用于返回跳转失败时的错误信息，详见 。 - 输出参数，表示错误码： + err + 输出参数，表示错误信息。可能返回以下 AgoraRteErrorCode： +
      +
    • ：调用成功。
      • +
    • ：
        +
      • 对应的内部 AgoraRtePlayer 对象已被销毁或无效。
        • +
      • 打开的是 RTE URL，不支持调用 。详见 。
        • +
      +
      • +
    +     + 状态或错误信息，详见 。 +可能的错误码包括：
      -
    • ：成功。
      • +
    • ：调用成功。
    • ：
      • 对应的内部 对象已被销毁或无效。
        • -
      • 打开的 URL 是 RTE URL，不支持跳转播放位置。详见 。
        • +
      • 打开的是 RTE URL，不支持调用 。
    @@ -62,9 +72,8 @@
  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见了解详情和解决建议。
    • -

    方法调用成功，返回当前的播放位置，单位为毫秒。

    -

    方法调用成功，返回当前播放位置，单位为毫秒。

    -

    方法调用成功时，返回当前的播放位置，单位为毫秒。

    +

    方法调用成功，返回当前的播放位置，单位为毫秒。

    +

    方法调用成功，返回当前播放位置，单位为毫秒。

    diff --git a/dita/RTC-NG/API/api_player_seek.dita b/dita/RTC-NG/API/api_player_seek.dita index fe889c87bdb..0b91426b5e0 100644 --- a/dita/RTC-NG/API/api_player_seek.dita +++ b/dita/RTC-NG/API/api_player_seek.dita @@ -49,7 +49,7 @@ err error - 输出参数，用于返回跳转失败时的错误信息，详见 。 + 输出参数，用于返回跳转失败时的错误信息。详见 。 输出参数，表示错误码：
    • ：成功。
      • diff --git a/dita/RTC-NG/API/api_player_switchwithurl.dita b/dita/RTC-NG/API/api_player_switchwithurl.dita index 092b23fe0f2..962e0cba886 100644 --- a/dita/RTC-NG/API/api_player_switchwithurl.dita +++ b/dita/RTC-NG/API/api_player_switchwithurl.dita @@ -30,11 +30,9 @@
      自 v4.5.1 版本新增。
      -

      - - 该方法仅在播放器打开的 URL 为非灵隼物联网云平台 URL 时有效。 -- 请在 SDK 返回播放器状态为 `kRtePlayerStateOpenCompleted` 时调用该方法。 - 该方法仅在播放器打开的是非互动直播（非 RTE）URL 时有效。请在 SDK 返回播放器状态为 `AgoraRtePlayerStateOpenCompleted` 时调用该方法。 - 该方法仅在播放器打开的 URL 为非 RTE URL 时有效。请在 SDK 返回播放器状态为 `PlayerState.OPEN_COMPLETED` 时调用该方法。 +

      请在 SDK 返回播放器状态为 时调用该方法。

      + 该方法仅在播放器打开的是非 URL 时有效。请在 SDK 返回播放器状态为 时调用该方法。 + 该方法仅在播放器打开的是非 RTE URL 时有效。
      调用限制 @@ -46,27 +44,20 @@ url 要切换的 URL 资源。 - 要切换到的新 URL。 + 要切换的目标 URL。 要切换的新 URL。 - syncPts - sync_pts - 是否在切换后同步播放位置（单位为毫秒）： -
        + syncPts + syncPts +
        • ：同步播放位置。
          • -
        • ：不同步播放位置。
          • +
        • ：（默认）不同步播放位置。
        • ：切换后同步播放位置（单位为毫秒）。
          • -
        • ：切换后不同步播放位置。
          • -
        -         - 切换后是否同步播放位置（毫秒）： -
          -
        • ：同步播放位置。
          • -
        • ：（默认）不同步播放位置。
          • +
        • ：（默认）切换后不同步播放位置。
         @@ -75,7 +66,20 @@ cb 异步回调，用于通知切换操作的结果，详见 。 异步通知切换操作结果的回调。你可以通过该回调的 err 参数得知操作的结果或错误码信息，详见 。 - 异步通知切换操作结果的回调。你可以通过该回调的 err 参数得知操作的结果或错误码信息，详见 。 + 异步通知切换操作结果的回调。你可以通过该回调的 err 参数得知操作的结果或错误码信息，详见 。 + +err 的可能取值包括： +
          +
        • ：切换成功。
          • +
        • ：切换失败。
          • +
        • ：传入的 URL 为空或格式非法。
          • +
        • ：
            +
          • 对应的内部 对象已被销毁或无效。
            • +
          • 当前打开的是 URL，不支持切换。
            • +
          +
          • +
        +
      diff --git a/dita/RTC-NG/API/api_playerconfig_setloopcount.dita b/dita/RTC-NG/API/api_playerconfig_setloopcount.dita index c9b1dd1a4d7..fd2ae0a12d1 100644 --- a/dita/RTC-NG/API/api_playerconfig_setloopcount.dita +++ b/dita/RTC-NG/API/api_playerconfig_setloopcount.dita @@ -30,7 +30,7 @@
      自 v4.5.1 版本新增。
      -

      你可以通过该方法设置媒体文件的播放次数，例如播放一次、两次，或无限循环播放，直到调用 stop 方法停止播放。

      +

      你可以通过该方法设置媒体文件的循环播放次数，包括播放一次、两次，或无限循环播放，直到调用 方法停止播放。

      调用限制 @@ -41,18 +41,18 @@ count - 媒体文件的循环播放次数： + 媒体文件的循环播放次数。
        -
      • 0：播放一次。
        • -
      • 1：播放两次。
        • -
      • -1：无限循环播放，直到调用 方法停止播放。
        • +
      • 0：播放一次。
        • +
      • 1：播放两次。
        • +
      • -1：无限循环播放，直到调用 方法停止播放。
       媒体文件的循环播放次数。
      • 0：播放一次。
      • 1：播放两次。
        • -
      • -1：无限循环播放，直到调用 方法停止。
        • +
      • -1：无限循环播放，直到调用 方法停止播放。
       媒体文件的循环播放次数。 @@ -66,7 +66,7 @@ error err - 输出参数，返回调用结果。详见 。 + 输出参数，返回错误信息。详见 。 状态或错误信息，详见 。
      • ：成功。
        • diff --git a/dita/RTC-NG/API/api_playerconfig_setplaybackspeed.dita b/dita/RTC-NG/API/api_playerconfig_setplaybackspeed.dita index cb992776056..0019cab1d91 100644 --- a/dita/RTC-NG/API/api_playerconfig_setplaybackspeed.dita +++ b/dita/RTC-NG/API/api_playerconfig_setplaybackspeed.dita @@ -31,8 +31,7 @@

        你可以在调用 方法之后调用此方法。

        - 你可以在调用 `OpenWithUrl` 方法之后调用此方法。 - 你可以在调用 `openWithUrl:startTime:cb:` 方法之后调用此方法。 + 你可以在调用 方法之后调用此方法。
      调用限制 diff --git a/dita/RTC-NG/API/api_playerinfo_isaudiomuted.dita b/dita/RTC-NG/API/api_playerinfo_isaudiomuted.dita index 421a604e289..26356019d24 100644 --- a/dita/RTC-NG/API/api_playerinfo_isaudiomuted.dita +++ b/dita/RTC-NG/API/api_playerinfo_isaudiomuted.dita @@ -31,7 +31,7 @@
      自 v4.4.0 版本新增。
      -

      +

      该方法用于判断播放器是否停止接收音频流。

      调用限制 @@ -44,8 +44,7 @@
    • 0: 方法调用成功。
    • < 0: 方法调用失败。详见了解详情和解决建议。
    -

    bool 类型。 -

      +

      • ：播放器已停止接收音频流。
      • ：播放器仍在接收音频流。
      diff --git a/dita/RTC-NG/API/api_playerinfo_isvideomuted.dita b/dita/RTC-NG/API/api_playerinfo_isvideomuted.dita index 24ac7b0b5ed..f94d5d0a2d7 100644 --- a/dita/RTC-NG/API/api_playerinfo_isvideomuted.dita +++ b/dita/RTC-NG/API/api_playerinfo_isvideomuted.dita @@ -32,7 +32,7 @@

      - `IsVideoMuted` 接口仅在打开 RTE URL 时有效。 + IsVideoMuted 接口仅在打开 RTE URL 时有效。
      调用限制