Skip to content

dita_gen output #3880

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
wants to merge 5 commits into
base: release/rtc-ng/4.5.1
Choose a base branch
from
Open

dita_gen output #3880

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b9454f3
dita_gen output
Nero-Hu Feb 12, 2025
8282620
fix return values
Nero-Hu Feb 12, 2025
d8c9996
fix cpp setplaybackspeed and toc
Nero-Hu Feb 12, 2025
f346eab
fix cpp ditamap
Nero-Hu Feb 12, 2025
77d72d1
fix relations
Nero-Hu Feb 12, 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
71 changes: 71 additions & 0 deletions dita/RTC-NG/API/api_player_getloopcount.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_player_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>自 v4.5.1 版本新增。</dd>
</dlentry>
</dl>
<p></p>
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>加入频道前后均可调用。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry props="cpp">
<pt>err</pt>
<pd>ErrorCode 的可能返回值：
<ul>
<li>kRteOk: 成功。</li>
</ul></pd>
<pd props="ios">输出参数，表示可能返回的 <xref keyref="RteErrorCode"/>。
<ul>
<li><ph keyref="kRteOk"/>: 成功。</li>
</ul></pd>
<pd props="mac">输出参数，表示可能返回的 <xref keyref="RteErrorCode"/>。
<ul>
<li><ph keyref="kRteOk"/>: 成功。</li>
</ul></pd>
</plentry>
</parml> </section>
<section id="return_values">
<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="native unreal bp electron unity rn cs">
<li>0: 方法调用成功。返回媒体文件循环的次数。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul>
</section>
</refbody>
</reference>
71 changes: 71 additions & 0 deletions dita/RTC-NG/API/api_player_getplaybackspeed.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_player_getplaybackspeed">
<title><ph keyref="GetPlaybackSpeed"/></title>
<shortdesc id="short"><ph id="shortdesc">获取播放速度参数。</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="GetPlaybackSpeed"/>
</keywords>
</metadata>
</prolog>
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public int getPlaybackSpeed() throws RteException</codeblock>
<codeblock props="hmos" outputclass="language-arkts"/>
<codeblock props="ios mac" outputclass="language-objectivec">- (int32_t)playbackSpeed:(AgoraRteError * _Nullable)error;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">int32_t GetPlaybackSpeed(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>自 v4.5.1 版本新增。</dd>
</dlentry>
</dl>
<p></p>
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>加入频道前后均可调用。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry props="cpp">
<pt>err</pt>
<pd>ErrorCode 的可能返回值：
<ul>
<li>kRteOk: 成功。</li>
</ul></pd>
<pd props="ios">输出参数，表示 <xref keyref="Error"/> 对象可能返回以下 <xref keyref="RteErrorCode"/>。
<ul>
<li><ph keyref="kRteOk"/>: 成功。</li>
</ul></pd>
<pd props="mac">输出参数，表示 <xref keyref="Error"/> 对象可能返回以下 <xref keyref="RteErrorCode"/>。
<ul>
<li><ph keyref="kRteOk"/>: 成功。</li>
</ul></pd>
</plentry>
</parml> </section>
<section id="return_values">
<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="native unreal bp electron unity rn cs">
<li>0: 方法调用成功时，返回播放速度的值。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul>
</section>
</refbody>
</reference>
63 changes: 63 additions & 0 deletions dita/RTC-NG/API/api_player_getplayoutvolume.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_player_getplayoutvolume">
<title><ph keyref="GetPlayoutVolume"/></title>
<shortdesc id="short"><ph id="shortdesc">获取播放器的播放音量。</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="GetPlayoutVolume"/>
</keywords>
</metadata>
</prolog>
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public int getPlayoutVolume() throws RteException</codeblock>
<codeblock props="hmos" outputclass="language-arkts"/>
<codeblock props="ios mac" outputclass="language-objectivec">- (int32_t)playoutVolume:(AgoraRteError * _Nullable)error;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">int32_t GetPlayoutVolume(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>自 v4.5.1 版本新增。</dd>
</dlentry>
</dl>
<p></p>
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>加入频道前后均可调用。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry props="cpp">
<pt>err</pt>
<pd>ErrorCode 的可能返回值：
<ul>
<li>kRteOk: 成功。</li>
</ul></pd>
</plentry>
</parml> </section>
<section id="return_values">
<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="native unreal bp electron unity rn cs">
<li>0: 方法调用成功时，返回播放器的音量值。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul>
</section>
</refbody>
</reference>
69 changes: 69 additions & 0 deletions dita/RTC-NG/API/api_player_setplaybackspeed.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_player_setplaybackspeed">
<title><ph keyref="SetPlaybackSpeed_Player"/></title>
<shortdesc id="short"><ph id="shortdesc">设置播放速度参数。</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="SetPlaybackSpeed_Player"/>
</keywords>
</metadata>
</prolog>
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public void setPlaybackSpeed(int speed) throws RteException</codeblock>
<codeblock props="hmos" outputclass="language-arkts"/>
<codeblock props="ios mac" outputclass="language-objectivec">- (void)setPlaybackSpeed:(int32_t)speed error:(AgoraRteError * _Nullable)error;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">void SetPlaybackSpeed(int32_t speed, 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>自 v4.5.1 版本新增。</dd>
</dlentry>
</dl>
<p>你可以在调用 <codeph>Player::OpenWithUrl</codeph> 后调用此方法。</p>
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>加入频道前后均可调用。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>你可以在调用 <codeph>Player::OpenWithUrl</codeph> 之后调用此方法。</p>
</section>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry props="android ios cpp mac">
<pt>speed</pt>
<pd>播放速度。取值范围是 [50,400]。</pd>
</plentry>
<plentry props="cpp">
<pt>err</pt>
<pd>ErrorCode 的可能返回值：
<ul>
<li>kRteOk: 成功</li>
<li>kRteErrorInvalidArgument: <codeph>speed</codeph> 参数设置为非法值。</li>
</ul></pd>
<pd props="android">设置播放速度失败，SDK 会抛出异常，并返回相应的错误信息。你需要捕获异常并进行处理。</pd>
</plentry>
</parml> </section>
<section id="return_values">
<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="native unreal bp electron unity rn cs">
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul>
</section>
</refbody>
</reference>
84 changes: 84 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,84 @@
<?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>自 v4.5.1 版本新增。</dd>
</dlentry>
</dl>
<p></p>
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>加入频道前后均可调用。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>此方法仅在播放器打开非 RTE URL 时有效。当 SDK 返回播放器状态为 <ph keyref="kRtePlayerStateOpenCompleted"/> 时调用此方法。</p>
</section>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry props="android ios cpp mac">
<pt>url</pt>
<pd>要切换到的新的 URL。</pd>
</plentry>
<plentry props="android ios cpp mac">
<pt>syncPts</pt>
<pd>是否在切换前后同步播放位置（毫秒）：
<ul>
<li><codeph><ph keyref="true"/></codeph>：同步播放位置。</li>
<li><codeph><ph keyref="false"/></codeph>：（默认）不同步播放位置。</li>
</ul></pd>
</plentry>
<plentry props="cpp mac">
<pt>cb</pt>
<pd>异步通知切换操作结果的回调。</pd>
<pd props="ios">异步通知切换操作结果的回调。
<ul>
<li><ul>
<li><ph keyref="kRteOk"/>: 成功。</li>
<li><ph keyref="kRteErrorDefault"/>: 切换到新 URL 失败。</li>
<li><ph keyref="kRteErrorInvalidArgument"/>: 传入的 URL 为空或格式无效。</li>
<li><ph keyref="kRteErrorInvalidOperation"/>: <ul>
<li>对应的内部 AgoraRtePlayer 对象已被销毁或无效。</li>
<li>打开的 URL 是 RTE URL，不支持切换到新 URL。</li>
</ul></li>
</ul></li>
</ul></pd>
</plentry>
</parml> </section>
<section id="return_values">
<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="native unreal bp electron unity rn cs">
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul>
</section>
</refbody>
</reference>
Loading
Loading