Skip to content

460api v2 #3948

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 1 commit into
base: release/rtc-ng/4.6.0
Choose a base branch
from
Open

460api v2 #3948

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 17 additions & 10 deletions dita/RTC-NG/API/api_imediaplayer_enableautoswitchagoracdn.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,40 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_imediaplayer_enableautoswitchagoracdn">
<title><ph keyref="enableAutoSwitchAgoraCDN" /></title>
<title><ph keyref="enableAutoSwitchAgoraCDN"/></title>
<shortdesc id="short"><ph id="shortdesc">开启/关闭自动切换媒体资源的 CDN 线路。</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="enableAutoSwitchAgoraCDN" />
<indexterm keyref="enableAutoSwitchAgoraCDN"/>
</keywords>
</metadata>
</prolog>
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">int enableAutoSwitchAgoraCDN(boolean enable);</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="hmos" outputclass="language-arkts"/>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)enableAutoSwitchAgoraCDN:(BOOL)enable;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int enableAutoSwitchAgoraCDN(bool enable) = 0;</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract enableAutoSwitchAgoraCDN(enable: boolean): number;</codeblock>
<codeblock props="unity cs" outputclass="language-csharp">public abstract int EnableAutoSwitchAgoraCDN(bool enable);</codeblock>
<codeblock props="rn" outputclass="language-typescript">abstract enableAutoSwitchAgoraCDN(enable: boolean): number;</codeblock>
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; enableAutoSwitchAgoraCDN(bool enable);</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
<codeblock props="reserve" outputclass="language-cpp"/></p>
</section>
<section id="detailed_desc">
<title>详情</title>
<dl outputclass="deprecated" props="native">
<dlentry outputclass="deprecated">
<dt>弃用：</dt>
<dd props="cpp">该 API 自 v4.6.0 版本废弃。</dd>
<dd props="android apple">该方法自 v4.6.0 版本废弃。</dd>
</dlentry>
</dl>
<p>如果你想设置 SDK 根据网络情况自动切换媒体资源 CDN 线路，你可以调用该方法。</p>
<note type="note">
<p>请在 <xref keyref="openWithAgoraCDNSrc" /> 前调用该方法。</p>
<p>请在 <xref keyref="openWithAgoraCDNSrc"/> 前调用该方法。</p>
</note> </section>
<section id="parameters">
<title>参数</title>
Expand All @@ -37,17 +44,17 @@
<pd>设置是否开启自动切换媒体资源的 CDN 线路:

<ul>
<li><codeph><ph keyref="true" /></codeph>：开启自动切换媒体资源的 CDN 线路。</li>
<li><codeph><ph keyref="false" /></codeph>：(默认) 关闭自动切换媒体资源的 CDN 线路。</li>
<li><codeph><ph keyref="true"/></codeph>：开启自动切换媒体资源的 CDN 线路。</li>
<li><codeph><ph keyref="false"/></codeph>：(默认) 关闭自动切换媒体资源的 CDN 线路。</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">
<ul props="bp cs electron native rn unity unreal">
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul> </section>
</refbody>
</reference>
</reference>
21 changes: 15 additions & 6 deletions dita/RTC-NG/API/api_imediaplayer_getagoracdnlinecount.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,42 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_imediaplayer_getagoracdnlinecount">
<title><ph keyref="getAgoraCDNLineCount" /></title>
<title><ph keyref="getAgoraCDNLineCount"/></title>
<shortdesc id="short"><ph id="shortdesc">获取媒体资源的 CDN 线路数量。</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="getAgoraCDNLineCount" />
<indexterm keyref="getAgoraCDNLineCount"/>
</keywords>
</metadata>
</prolog>
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">int getAgoraCDNLineCount();</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="hmos" outputclass="language-arkts"/>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)getAgoraCDNLineCount;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getAgoraCDNLineCount() = 0;</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract getAgoraCDNLineCount(): number;</codeblock>
<codeblock props="unity cs" outputclass="language-csharp">public abstract int GetAgoraCDNLineCount();</codeblock>
<codeblock props="rn" outputclass="language-typescript">abstract getAgoraCDNLineCount(): number;</codeblock>
<codeblock props="flutter" outputclass="language-dart">Future&lt;int&gt; getAgoraCDNLineCount();</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
<codeblock props="reserve" outputclass="language-cpp"/></p>
</section>
<section id="detailed_desc">
<title>详情</title>
<dl outputclass="deprecated" props="native">
<dlentry outputclass="deprecated">
<dt>弃用：</dt>
<dd props="native">该 API 自 v4.6.0 版本废弃。</dd>
</dlentry>
</dl>
</section>
<section id="return_values">
<title>返回值</title>
<ul>
<li>&gt; 0：方法调用成功，返回媒体资源的 CDN 线路数量。</li>
<li>≤ 0：方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul> </section>
</refbody>
</reference>
</reference>
24 changes: 17 additions & 7 deletions dita/RTC-NG/API/api_imediaplayer_getcurrentagoracdnindex.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,43 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_imediaplayer_getcurrentagoracdnindex">
<title><ph keyref="getCurrentAgoraCDNIndex" /></title>
<title><ph keyref="getCurrentAgoraCDNIndex"/></title>
<shortdesc id="short"><ph id="shortdesc">获取当前使用的媒体资源的 CDN 线路索引。</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="getCurrentAgoraCDNIndex" />
<indexterm keyref="getCurrentAgoraCDNIndex"/>
</keywords>
</metadata>
</prolog>
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">int getCurrentAgoraCDNIndex();</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="hmos" outputclass="language-arkts"/>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)getCurrentAgoraCDNIndex;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getCurrentAgoraCDNIndex() = 0;</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract getCurrentAgoraCDNIndex(): number;</codeblock>
<codeblock props="unity cs" outputclass="language-csharp">public abstract int GetCurrentAgoraCDNIndex();</codeblock>
<codeblock props="rn" outputclass="language-typescript">abstract getCurrentAgoraCDNIndex(): number;</codeblock>
<codeblock props="flutter" outputclass="language-dart">Future&lt;int&gt; getCurrentAgoraCDNIndex();</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
<codeblock props="reserve" outputclass="language-cpp"/></p>
</section>
<section id="detailed_desc">
<title>详情</title>
<dl outputclass="deprecated" props="native">
<dlentry outputclass="deprecated">
<dt>弃用：</dt>
<dd props="apple cpp">该 API 自 v4.6.0 版本废弃。</dd>
<dd props="android">该方法自 v4.6.0 版本废弃。</dd>
</dlentry>
</dl>
</section>
<section id="return_values">
<title>返回值</title>
<ul>
<li>≥ 0: 方法调用成功，返回媒体资源的 CDN 线路索引。数值范围为 [0, <apiname keyref="getAgoraCDNLineCount" /><codeph>()</codeph>)。</li>
<li>≥ 0: 方法调用成功，返回媒体资源的 CDN 线路索引。数值范围为 [0, <apiname keyref="getAgoraCDNLineCount"/><codeph>()</codeph>)。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul> </section>
</refbody>
</reference>
</reference>
29 changes: 18 additions & 11 deletions dita/RTC-NG/API/api_imediaplayer_openwithagoracdnsrc.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_imediaplayer_openwithagoracdnsrc">
<title> <ph keyref="openWithAgoraCDNSrc" /> </title>
<title> <ph keyref="openWithAgoraCDNSrc"/> </title>
<shortdesc id="short"><ph id="shortdesc">打开媒体资源，并通过自研调度中心请求媒体资源的所有 CDN 线路。</ph> </shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="openWithAgoraCDNSrc" />
<indexterm keyref="openWithAgoraCDNSrc"/>
</keywords>
</metadata>
</prolog>
Expand All @@ -15,7 +15,7 @@
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">int openWithAgoraCDNSrc(String src, long startPos);
</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="hmos" outputclass="language-arkts"/>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)openWithAgoraCDNSrc:(NSString *)src startPos:(NSInteger)startPos;
</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int openWithAgoraCDNSrc(const char* src, int64_t startPos) = 0;
Expand All @@ -25,21 +25,28 @@
<codeblock props="rn" outputclass="language-typescript">abstract openWithAgoraCDNSrc(src: string, startPos: number): number;</codeblock>
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; openWithAgoraCDNSrc(
{required String src, required int startPos});</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
<codeblock props="reserve" outputclass="language-cpp"/></p>
</section>
<section id="detailed_desc">
<title>详情</title>
<note type="attention" conkeyref="open/note" />
<p>调用该方法后，声网会打开媒体资源并通过自研调度中心请求媒体资源的所有 CDN 线路。默认使用第一个线路，你也可以通过 <xref keyref="switchAgoraCDNLineByIndex" /> 自行切换线路。</p>
<p id="auth">如果你希望保障连接和播放媒体资源的安全性，你可以<xref keyref="ticket-link" />协商鉴权字段 (<parmname>sign</parmname>) 和鉴权过期时间 (<parmname>ts</parmname>)。确定字段后，请将其作为 URL 的 <codeph>query parameter</codeph> 以更新媒体资源的网路路径。例如：
<dl outputclass="deprecated" props="native">
<dlentry outputclass="deprecated">
<dt>弃用：</dt>
<dd props="android cpp">该方法自 v4.6.0 版本废弃。</dd>
<dd props="apple">该 API 自 v4.6.0 版本废弃。</dd>
</dlentry>
</dl>
<note type="attention" conkeyref="open/note"/>
<p>调用该方法后，声网会打开媒体资源并通过自研调度中心请求媒体资源的所有 CDN 线路。默认使用第一个线路，你也可以通过 <xref keyref="switchAgoraCDNLineByIndex"/> 自行切换线路。</p>
<p id="auth">如果你希望保障连接和播放媒体资源的安全性，你可以<xref keyref="ticket-link"/>协商鉴权字段 (<parmname>sign</parmname>) 和鉴权过期时间 (<parmname>ts</parmname>)。确定字段后，请将其作为 URL 的 <codeph>query parameter</codeph> 以更新媒体资源的网路路径。例如：
<ul>
<li>媒体资源网络路径为 <codeph>rtmp://$domain/$appName/$streamName</codeph></li>
<li>通过鉴权信息更新过的媒体资源网络路径为 <codeph>rtmp://$domain/$appName/$streamName?ts=$ts&amp;sign=$sign</codeph></li>
</ul>
<note>
<p>鉴权信息说明：
<ul>
<li><parmname>sign</parmname> : 通过 <codeph>authKey</codeph> + <codeph>appName</codeph> + <codeph>streamName</codeph> + <codeph>ts</codeph> 进行 md5 算法加密得出的鉴权字段。你需要<xref keyref="ticket-link" />咨询你的 <codeph>authKey</codeph> 字段内容。</li>
<li><parmname>sign</parmname> : 通过 <codeph>authKey</codeph> + <codeph>appName</codeph> + <codeph>streamName</codeph> + <codeph>ts</codeph> 进行 md5 算法加密得出的鉴权字段。你需要<xref keyref="ticket-link"/>咨询你的 <codeph>authKey</codeph> 字段内容。</li>
<li><parmname>ts</parmname> : 鉴权过期时间。你可以指定再过多久鉴权过期。例如， <codeph>24h</codeph> 或 <codeph>1h30m20s</codeph>。</li>
</ul></p>
</note></p>
Expand All @@ -59,9 +66,9 @@
<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 unity rn electron cs">
<ul props="bp cs electron native rn unity unreal">
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul> </section>
</refbody>
</reference>
</reference>
Loading
Loading