Skip to content

4.5.2 ditagen api #3924

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Parent: Release/rtc ng/4.5.2
wants to merge 2 commits into
base: release/rtc-ng/4.5.2
Choose a base branch
from
Open

4.5.2 ditagen api #3924

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
503f727
4.5.2 ditagen api
Apr 10, 2025
704d9eb
new data.json
Apr 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 79 additions & 0 deletions dita/RTC-NG/API/api_player_getposition.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_player_getposition">
<title><ph keyref="GetPosition"/></title>
<shortdesc id="short"><ph id="shortdesc">获取当前的播放位置。</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="GetPosition"/>
</keywords>
</metadata>
</prolog>
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public long getPosition() throws RteException</codeblock>
<codeblock props="hmos" outputclass="language-arkts"/>
<codeblock props="ios mac" outputclass="language-objectivec">- (uint64_t)getPosition:(AgoraRteError * _Nullable)error;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">uint64_t GetPosition(Error *err = nullptr)</codeblock>
<codeblock props="bp" outputclass="language-cpp"/>
<codeblock props="electron" outputclass="language-typescript"/>
<codeblock props="unity cs" outputclass="language-csharp"/>
<codeblock props="rn" outputclass="language-typescript"/>
<codeblock props="flutter" outputclass="language-dart"/> </p>
</section>
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<dl outputclass="since">
<dlentry props="native">
<dt>自从：</dt>
<dd props="native">自 v4.5.1 版本新增。</dd>
</dlentry>
</dl>
<p>该方法用于获取当前播放的时间位置，单位为毫秒。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="parameters" deliveryTarget="details" props="apple cpp">
<title>参数</title>
<parml>
<plentry props="apple cpp">
<pt props="apple">error</pt>
<pt props="cpp">err</pt>
<pd props="apple">输出参数，表示错误信息。可能返回以下 AgoraRteErrorCode：
<ul>
<li><ph keyref="kRteOk"/>：调用成功。</li>
<li><ph keyref="kRteErrorInvalidOperation"/>：<ul>
<li>对应的内部 <codeph>AgoraRtePlayer</codeph> 对象已被销毁或无效。</li>
<li>打开的是 RTE URL，不支持调用 <xref keyref="getPlayPosition"/>。详见 <xref keyref="Error"/>。</li>
</ul>
</li>
</ul>
</pd>
<pd props="cpp">状态或错误信息，详见 <xref keyref="Error"/>。
可能的错误码包括：
<ul>
<li><ph keyref="kRteOk"/>：调用成功。</li>
<li><ph keyref="kRteErrorInvalidOperation"/>：<ul>
<li>对应的内部 <xref keyref="Player_Player"/> 对象已被销毁或无效。</li>
<li>打开的是 RTE URL，不支持调用 <xref keyref="getPlayPosition"/>。</li>
</ul>
</li>
</ul>
</pd>
</plentry>
</parml> </section>
<section id="return_values" props="bp cs electron flutter native rn unity unreal">
<title><ph keyref="return-section-title"/></title>
<p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
<ul props="bp cs electron rn unity unreal">
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul>
<p props="apple cpp">方法调用成功，返回当前的播放位置，单位为毫秒。</p>
<p props="android">方法调用成功，返回当前播放位置，单位为毫秒。</p>
</section>
</refbody>
</reference>
84 changes: 84 additions & 0 deletions dita/RTC-NG/API/api_player_seek.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_player_seek">
<title><ph keyref="Seek"/></title>
<shortdesc id="short"><ph id="shortdesc">跳转播放位置。</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="Seek"/>
</keywords>
</metadata>
</prolog>
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public void seek(long newTime) throws RteException</codeblock>
<codeblock props="hmos" outputclass="language-arkts"/>
<codeblock props="ios mac" outputclass="language-objectivec">- (BOOL)seek:(uint64_t)newTime error:(AgoraRteError * _Nullable)error;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">bool Seek(uint64_t new_time, Error *err = nullptr)</codeblock>
<codeblock props="bp" outputclass="language-cpp"/>
<codeblock props="electron" outputclass="language-typescript"/>
<codeblock props="unity cs" outputclass="language-csharp"/>
<codeblock props="rn" outputclass="language-typescript"/>
<codeblock props="flutter" outputclass="language-dart"/> </p>
</section>
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<dl outputclass="since">
<dlentry props="native">
<dt>自从：</dt>
<dd props="native">自 v4.5.1 版本新增。</dd>
</dlentry>
</dl>
<p></p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="parameters" deliveryTarget="details" props="native">
<title>参数</title>
<parml>
<plentry props="native">
<pt props="cpp">new_time</pt>
<pt props="android apple">newTime</pt>
<pd props="android">要跳转到的播放位置，单位为毫秒。</pd>
<pd props="apple">你希望跳转到的播放位置。</pd>
<pd props="cpp">要跳转到的新播放位置。</pd>
</plentry>
<plentry props="apple cpp">
<pt props="cpp">err</pt>
<pt props="apple">error</pt>
<pd props="apple">输出参数，用于返回跳转失败时的错误信息。详见 <xref keyref="Error"/>。</pd>
<pd props="cpp">输出参数，表示错误码：
<ul>
<li><ph keyref="kRteOk"/>：成功。</li>
<li><ph keyref="kRteErrorInvalidOperation"/>：<ul>
<li>对应的内部 <xref keyref="Player_Player"/> 对象已被销毁或无效。</li>
<li>打开的 URL 是 RTE URL，不支持跳转播放位置。详见 <xref keyref="Error"/>。</li>
</ul>
</li>
</ul>
</pd>
</plentry>
</parml> </section>
<section id="return_values" props="bp cs electron flutter rn unity unreal">
<title><ph keyref="return-section-title"/></title>
<p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
<ul props="bp cs electron rn unity unreal">
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul>
<p props="cpp"><ul>
<li><codeph><ph keyref="true"/></codeph>：跳转成功。</li>
<li><codeph><ph keyref="false"/></codeph>：跳转失败。</li>
</ul>
</p>
<p props="apple"><ul>
<li><codeph><ph keyref="true"/></codeph>：跳转成功。</li>
<li><codeph><ph keyref="false"/></codeph>：跳转失败。你可以通过 <xref keyref="Error"/> 参数查看具体错误信息。</li>
</ul>
</p>
</section>
</refbody>
</reference>
94 changes: 94 additions & 0 deletions dita/RTC-NG/API/api_player_switchwithurl.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_player_switchwithurl">
<title><ph keyref="SwitchWithUrl"/></title>
<shortdesc id="short"><ph id="shortdesc">在播放过程中切换至新的 URL。</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="SwitchWithUrl"/>
</keywords>
</metadata>
</prolog>
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public void switchWithUrl(String url, boolean syncPts, AsyncCallback callback)</codeblock>
<codeblock props="hmos" outputclass="language-arkts"/>
<codeblock props="ios mac" outputclass="language-objectivec">- (void)switchWithUrl:(NSString * _Nonnull)url syncPts:(BOOL)syncPts cb:(void (^_Nullable)(AgoraRteError* _Nullable err))cb;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">void SwitchWithUrl(const char* url, bool sync_pts, std::function&amp;lt;void(rte::Error* err)&amp;gt; cb)</codeblock>
<codeblock props="bp" outputclass="language-cpp"/>
<codeblock props="electron" outputclass="language-typescript"/>
<codeblock props="unity cs" outputclass="language-csharp"/>
<codeblock props="rn" outputclass="language-typescript"/>
<codeblock props="flutter" outputclass="language-dart"/> </p>
</section>
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<dl outputclass="since">
<dlentry props="native">
<dt>自从：</dt>
<dd props="native">自 v4.5.1 版本新增。</dd>
</dlentry>
</dl>
<p>请在 SDK 返回播放器状态为 <ph keyref="kRtePlayerStateOpenCompleted"/> 时调用该方法。</p>
<note type="attention" props="apple cpp">该方法仅在播放器打开的是非 <xref keyref="Rte_Rte"/> URL 时有效。请在 SDK 返回播放器状态为 <ph keyref="kRtePlayerStateOpenCompleted"/> 时调用该方法。</note>
<note type="attention" props="android">该方法仅在播放器打开的是非 RTE URL 时有效。</note>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="parameters" deliveryTarget="details" props="native">
<title>参数</title>
<parml>
<plentry props="native">
<pt props="native">url</pt>
<pd props="android">要切换的 URL 资源。</pd>
<pd props="apple">要切换的目标 URL。</pd>
<pd props="cpp">要切换的新 URL。</pd>
</plentry>
<plentry props="native">
<pt props="android cpp">syncPts</pt>
<pt props="apple">syncPts</pt>
<pd props="android cpp"><ul>
<li><codeph><ph keyref="true"/></codeph>：同步播放位置。</li>
<li><codeph><ph keyref="false"/></codeph>：（默认）不同步播放位置。</li>
</ul>
</pd>
<pd props="apple"><ul>
<li><codeph><ph keyref="true"/></codeph>：切换后同步播放位置（单位为毫秒）。</li>
<li><codeph><ph keyref="false"/></codeph>：（默认）切换后不同步播放位置。</li>
</ul>
</pd>
</plentry>
<plentry props="native">
<pt props="android">callback</pt>
<pt props="apple cpp">cb</pt>
<pd props="android">异步回调，用于通知切换操作的结果，详见 <xref keyref="AsyncCallback"/>。</pd>
<pd props="apple">异步通知切换操作结果的回调。你可以通过该回调的 <codeph>err</codeph> 参数得知操作的结果或错误码信息，详见 <xref keyref="Error"/>。</pd>
<pd props="cpp">异步通知切换操作结果的回调。你可以通过该回调的 <codeph>err</codeph> 参数得知操作的结果或错误码信息，详见 <xref keyref="Error"/>。

<codeph>err</codeph> 的可能取值包括：
<ul>
<li><ph keyref="kRteOk"/>：切换成功。</li>
<li><ph keyref="kRteErrorDefault"/>：切换失败。</li>
<li><ph keyref="kRteErrorInvalidArgument"/>：传入的 URL 为空或格式非法。</li>
<li><ph keyref="kRteErrorInvalidOperation"/>：<ul>
<li>对应的内部 <xref keyref="Player_Player"/> 对象已被销毁或无效。</li>
<li>当前打开的是 <xref keyref="Rte_Rte"/> URL，不支持切换。</li>
</ul>
</li>
</ul>
</pd>
</plentry>
</parml> </section>
<section id="return_values" props="bp cs electron flutter rn unity unreal">
<title><ph keyref="return-section-title"/></title>
<p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
<ul props="bp cs electron rn unity unreal">
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul>
</section>
</refbody>
</reference>
65 changes: 65 additions & 0 deletions dita/RTC-NG/API/api_playerconfig_getloopcount.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_playerconfig_getloopcount">
<title><ph keyref="GetLoopCount"/></title>
<shortdesc id="short"><ph id="shortdesc">获取媒体文件的循环次数参数。</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="GetLoopCount"/>
</keywords>
</metadata>
</prolog>
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public int getLoopCount() throws RteException</codeblock>
<codeblock props="hmos" outputclass="language-arkts"/>
<codeblock props="ios mac" outputclass="language-objectivec">- (int32_t)loopCount:(AgoraRteError * _Nullable)error;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">int32_t GetLoopCount(Error *err = nullptr)</codeblock>
<codeblock props="bp" outputclass="language-cpp"/>
<codeblock props="electron" outputclass="language-typescript"/>
<codeblock props="unity cs" outputclass="language-csharp"/>
<codeblock props="rn" outputclass="language-typescript"/>
<codeblock props="flutter" outputclass="language-dart"/> </p>
</section>
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<dl outputclass="since">
<dlentry props="native">
<dt>自从：</dt>
<dd props="native">自 v4.5.1 版本新增。</dd>
</dlentry>
</dl>
<p></p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="parameters" deliveryTarget="details" props="apple cpp">
<title>参数</title>
<parml>
<plentry props="apple cpp">
<pt props="cpp">err</pt>
<pt props="apple">error</pt>
<pd props="cpp">输出参数，状态或错误信息，详见 <xref keyref="Error"/>。
<ul>
<li><ph keyref="kRteOk"/>：表示成功。</li>
</ul>
</pd>
<pd props="apple">输出参数，表示错误信息。详见 <xref keyref="Error"/>。</pd>
</plentry>
</parml> </section>
<section id="return_values" props="bp cs electron flutter native rn unity unreal">
<title><ph keyref="return-section-title"/></title>
<p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
<ul props="bp cs electron rn unity unreal">
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul>
<p props="cpp">方法调用成功，返回媒体文件的循环次数。</p>
<p props="apple">方法调用成功，返回媒体文件的循环播放次数。</p>
<p props="android">方法调用成功时，返回媒体文件的循环播放次数。</p>
</section>
</refbody>
</reference>
Loading
Loading