Skip to content

Commit c746a93

Browse files
Suri539Nero-HuNero-Hu
authored
Release/rtc ng/4.6.0 (#3961)
* update template * api v1 * Revert "api v1" This reverts commit 8eecc74. * update en template * update gitignore * latest CN APIs (#3955) * latest CN APIs * fix * fix * Update api_rtcengineex_playeffectex2.dita * Update api_agorartcenginekit_destroy1.dita * update gitignore * add beauty constants * update * restore * update * android: add get api in watermark datatype * fix relations * fix * fix tag * add on engine released * add video stream types * fix playeffectex and preloadeffectex * update relations and overview * fix publish error * fix faceshpestyle * update * fix publish error * Update keys-rtc-ng-api-cpp.ditamap --------- Co-authored-by: Nero-Hu <[email protected]> --------- Co-authored-by: Nero-Hu <[email protected]> Co-authored-by: Nero-Hu <[email protected]>
1 parent d47edfb commit c746a93

File tree

110 files changed

+9639
-1754
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

110 files changed

+9639
-1754
lines changed

‎.cursorindexingignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
2+
# Don't index SpecStory auto-save files, but allow explicit context inclusion via @ references
3+
.specstory/**

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,5 @@ temp/
1212
.vscode/settings.json
1313
.vscode/extensions.json
1414
*.py
15+
16+
.specstory/**

‎dita/RTC-NG/API/api_imediaplayer_enableautoswitchagoracdn.dita‎

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,40 @@
1-
<?xml version="1.0" encoding="UTF-8"?>
1+
<?xml version='1.0' encoding='UTF-8'?>
22
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
33
<reference id="api_imediaplayer_enableautoswitchagoracdn">
4-
<title><ph keyref="enableAutoSwitchAgoraCDN" /></title>
4+
<title><ph keyref="enableAutoSwitchAgoraCDN"/></title>
55
<shortdesc id="short"><ph id="shortdesc">开启/关闭自动切换媒体资源的 CDN 线路。</ph></shortdesc>
66
<prolog>
77
<metadata>
88
<keywords>
9-
<indexterm keyref="enableAutoSwitchAgoraCDN" />
9+
<indexterm keyref="enableAutoSwitchAgoraCDN"/>
1010
</keywords>
1111
</metadata>
1212
</prolog>
1313
<refbody>
1414
<section id="prototype">
1515
<p outputclass="codeblock">
1616
<codeblock props="android" outputclass="language-java">int enableAutoSwitchAgoraCDN(boolean enable);</codeblock>
17-
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
17+
<codeblock props="hmos" outputclass="language-arkts"/>
1818
<codeblock props="ios mac" outputclass="language-objectivec">- (int)enableAutoSwitchAgoraCDN:(BOOL)enable;</codeblock>
1919
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int enableAutoSwitchAgoraCDN(bool enable) = 0;</codeblock>
2020
<codeblock props="electron" outputclass="language-typescript">abstract enableAutoSwitchAgoraCDN(enable: boolean): number;</codeblock>
2121
<codeblock props="unity cs" outputclass="language-csharp">public abstract int EnableAutoSwitchAgoraCDN(bool enable);</codeblock>
2222
<codeblock props="rn" outputclass="language-typescript">abstract enableAutoSwitchAgoraCDN(enable: boolean): number;</codeblock>
2323
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; enableAutoSwitchAgoraCDN(bool enable);</codeblock>
24-
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
24+
<codeblock props="reserve" outputclass="language-cpp"/></p>
2525
</section>
2626
<section id="detailed_desc">
2727
<title>详情</title>
28+
<dl outputclass="deprecated" props="native">
29+
<dlentry outputclass="deprecated">
30+
<dt>弃用：</dt>
31+
<dd props="cpp">该 API 自 v4.6.0 版本废弃。</dd>
32+
<dd props="android apple">该方法自 v4.6.0 版本废弃。</dd>
33+
</dlentry>
34+
</dl>
2835
<p>如果你想设置 SDK 根据网络情况自动切换媒体资源 CDN 线路，你可以调用该方法。</p>
2936
<note type="note">
30-
<p>请在 <xref keyref="openWithAgoraCDNSrc" /> 前调用该方法。</p>
37+
<p>请在 <xref keyref="openWithAgoraCDNSrc"/> 前调用该方法。</p>
3138
</note> </section>
3239
<section id="parameters">
3340
<title>参数</title>
@@ -37,17 +44,17 @@
3744
<pd>设置是否开启自动切换媒体资源的 CDN 线路:
3845

3946
<ul>
40-
<li><codeph><ph keyref="true" /></codeph>：开启自动切换媒体资源的 CDN 线路。</li>
41-
<li><codeph><ph keyref="false" /></codeph>：(默认) 关闭自动切换媒体资源的 CDN 线路。</li>
47+
<li><codeph><ph keyref="true"/></codeph>：开启自动切换媒体资源的 CDN 线路。</li>
48+
<li><codeph><ph keyref="false"/></codeph>：(默认) 关闭自动切换媒体资源的 CDN 线路。</li>
4249
</ul></pd>
4350
</plentry>
4451
</parml> </section>
4552
<section id="return_values">
4653
<title><ph keyref="return-section-title"/></title>
4754
<p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
48-
<ul props="native unreal bp electron unity rn cs">
55+
<ul props="bp cs electron native rn unity unreal">
4956
<li>0: 方法调用成功。</li>
5057
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
5158
</ul> </section>
5259
</refbody>
53-
</reference>
60+
</reference>

‎dita/RTC-NG/API/api_imediaplayer_getagoracdnlinecount.dita‎

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,42 @@
1-
<?xml version="1.0" encoding="UTF-8"?>
1+
<?xml version='1.0' encoding='UTF-8'?>
22
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
33
<reference id="api_imediaplayer_getagoracdnlinecount">
4-
<title><ph keyref="getAgoraCDNLineCount" /></title>
4+
<title><ph keyref="getAgoraCDNLineCount"/></title>
55
<shortdesc id="short"><ph id="shortdesc">获取媒体资源的 CDN 线路数量。</ph></shortdesc>
66
<prolog>
77
<metadata>
88
<keywords>
9-
<indexterm keyref="getAgoraCDNLineCount" />
9+
<indexterm keyref="getAgoraCDNLineCount"/>
1010
</keywords>
1111
</metadata>
1212
</prolog>
1313
<refbody>
1414
<section id="prototype">
1515
<p outputclass="codeblock">
1616
<codeblock props="android" outputclass="language-java">int getAgoraCDNLineCount();</codeblock>
17-
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
17+
<codeblock props="hmos" outputclass="language-arkts"/>
1818
<codeblock props="ios mac" outputclass="language-objectivec">- (int)getAgoraCDNLineCount;</codeblock>
1919
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getAgoraCDNLineCount() = 0;</codeblock>
2020
<codeblock props="electron" outputclass="language-typescript">abstract getAgoraCDNLineCount(): number;</codeblock>
2121
<codeblock props="unity cs" outputclass="language-csharp">public abstract int GetAgoraCDNLineCount();</codeblock>
2222
<codeblock props="rn" outputclass="language-typescript">abstract getAgoraCDNLineCount(): number;</codeblock>
2323
<codeblock props="flutter" outputclass="language-dart">Future&lt;int&gt; getAgoraCDNLineCount();</codeblock>
24-
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
24+
<codeblock props="reserve" outputclass="language-cpp"/></p>
2525
</section>
26+
<section id="detailed_desc">
27+
<title>详情</title>
28+
<dl outputclass="deprecated" props="native">
29+
<dlentry outputclass="deprecated">
30+
<dt>弃用：</dt>
31+
<dd props="native">该 API 自 v4.6.0 版本废弃。</dd>
32+
</dlentry>
33+
</dl>
34+
</section>
2635
<section id="return_values">
2736
<title>返回值</title>
2837
<ul>
2938
<li>&gt; 0：方法调用成功，返回媒体资源的 CDN 线路数量。</li>
3039
<li>≤ 0：方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
3140
</ul> </section>
3241
</refbody>
33-
</reference>
42+
</reference>

‎dita/RTC-NG/API/api_imediaplayer_getcurrentagoracdnindex.dita‎

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,43 @@
1-
<?xml version="1.0" encoding="UTF-8"?>
1+
<?xml version='1.0' encoding='UTF-8'?>
22
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
33
<reference id="api_imediaplayer_getcurrentagoracdnindex">
4-
<title><ph keyref="getCurrentAgoraCDNIndex" /></title>
4+
<title><ph keyref="getCurrentAgoraCDNIndex"/></title>
55
<shortdesc id="short"><ph id="shortdesc">获取当前使用的媒体资源的 CDN 线路索引。</ph></shortdesc>
66
<prolog>
77
<metadata>
88
<keywords>
9-
<indexterm keyref="getCurrentAgoraCDNIndex" />
9+
<indexterm keyref="getCurrentAgoraCDNIndex"/>
1010
</keywords>
1111
</metadata>
1212
</prolog>
1313
<refbody>
1414
<section id="prototype">
1515
<p outputclass="codeblock">
1616
<codeblock props="android" outputclass="language-java">int getCurrentAgoraCDNIndex();</codeblock>
17-
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
17+
<codeblock props="hmos" outputclass="language-arkts"/>
1818
<codeblock props="ios mac" outputclass="language-objectivec">- (int)getCurrentAgoraCDNIndex;</codeblock>
1919
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getCurrentAgoraCDNIndex() = 0;</codeblock>
2020
<codeblock props="electron" outputclass="language-typescript">abstract getCurrentAgoraCDNIndex(): number;</codeblock>
2121
<codeblock props="unity cs" outputclass="language-csharp">public abstract int GetCurrentAgoraCDNIndex();</codeblock>
2222
<codeblock props="rn" outputclass="language-typescript">abstract getCurrentAgoraCDNIndex(): number;</codeblock>
2323
<codeblock props="flutter" outputclass="language-dart">Future&lt;int&gt; getCurrentAgoraCDNIndex();</codeblock>
24-
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
24+
<codeblock props="reserve" outputclass="language-cpp"/></p>
2525
</section>
26+
<section id="detailed_desc">
27+
<title>详情</title>
28+
<dl outputclass="deprecated" props="native">
29+
<dlentry outputclass="deprecated">
30+
<dt>弃用：</dt>
31+
<dd props="apple cpp">该 API 自 v4.6.0 版本废弃。</dd>
32+
<dd props="android">该方法自 v4.6.0 版本废弃。</dd>
33+
</dlentry>
34+
</dl>
35+
</section>
2636
<section id="return_values">
2737
<title>返回值</title>
2838
<ul>
29-
<li>≥ 0: 方法调用成功，返回媒体资源的 CDN 线路索引。数值范围为 [0, <apiname keyref="getAgoraCDNLineCount" /><codeph>()</codeph>)。</li>
39+
<li>≥ 0: 方法调用成功，返回媒体资源的 CDN 线路索引。数值范围为 [0, <apiname keyref="getAgoraCDNLineCount"/><codeph>()</codeph>)。</li>
3040
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
3141
</ul> </section>
3242
</refbody>
33-
</reference>
43+
</reference>

‎dita/RTC-NG/API/api_imediaplayer_openwithagoracdnsrc.dita‎

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
<?xml version="1.0" encoding="UTF-8"?>
1+
<?xml version='1.0' encoding='UTF-8'?>
22
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
33
<reference id="api_imediaplayer_openwithagoracdnsrc">
4-
<title> <ph keyref="openWithAgoraCDNSrc" /> </title>
4+
<title> <ph keyref="openWithAgoraCDNSrc"/> </title>
55
<shortdesc id="short"><ph id="shortdesc">打开媒体资源，并通过自研调度中心请求媒体资源的所有 CDN 线路。</ph> </shortdesc>
66
<prolog>
77
<metadata>
88
<keywords>
9-
<indexterm keyref="openWithAgoraCDNSrc" />
9+
<indexterm keyref="openWithAgoraCDNSrc"/>
1010
</keywords>
1111
</metadata>
1212
</prolog>
@@ -15,7 +15,7 @@
1515
<p outputclass="codeblock">
1616
<codeblock props="android" outputclass="language-java">int openWithAgoraCDNSrc(String src, long startPos);
1717
</codeblock>
18-
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
18+
<codeblock props="hmos" outputclass="language-arkts"/>
1919
<codeblock props="ios mac" outputclass="language-objectivec">- (int)openWithAgoraCDNSrc:(NSString *)src startPos:(NSInteger)startPos;
2020
</codeblock>
2121
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int openWithAgoraCDNSrc(const char* src, int64_t startPos) = 0;
@@ -25,21 +25,28 @@
2525
<codeblock props="rn" outputclass="language-typescript">abstract openWithAgoraCDNSrc(src: string, startPos: number): number;</codeblock>
2626
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; openWithAgoraCDNSrc(
2727
{required String src, required int startPos});</codeblock>
28-
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
28+
<codeblock props="reserve" outputclass="language-cpp"/></p>
2929
</section>
3030
<section id="detailed_desc">
3131
<title>详情</title>
32-
<note type="attention" conkeyref="open/note" />
33-
<p>调用该方法后，声网会打开媒体资源并通过自研调度中心请求媒体资源的所有 CDN 线路。默认使用第一个线路，你也可以通过 <xref keyref="switchAgoraCDNLineByIndex" /> 自行切换线路。</p>
34-
<p id="auth">如果你希望保障连接和播放媒体资源的安全性，你可以<xref keyref="ticket-link" />协商鉴权字段 (<parmname>sign</parmname>) 和鉴权过期时间 (<parmname>ts</parmname>)。确定字段后，请将其作为 URL 的 <codeph>query parameter</codeph> 以更新媒体资源的网路路径。例如：
32+
<dl outputclass="deprecated" props="native">
33+
<dlentry outputclass="deprecated">
34+
<dt>弃用：</dt>
35+
<dd props="android cpp">该方法自 v4.6.0 版本废弃。</dd>
36+
<dd props="apple">该 API 自 v4.6.0 版本废弃。</dd>
37+
</dlentry>
38+
</dl>
39+
<note type="attention" conkeyref="open/note"/>
40+
<p>调用该方法后，声网会打开媒体资源并通过自研调度中心请求媒体资源的所有 CDN 线路。默认使用第一个线路，你也可以通过 <xref keyref="switchAgoraCDNLineByIndex"/> 自行切换线路。</p>
41+
<p id="auth">如果你希望保障连接和播放媒体资源的安全性，你可以<xref keyref="ticket-link"/>协商鉴权字段 (<parmname>sign</parmname>) 和鉴权过期时间 (<parmname>ts</parmname>)。确定字段后，请将其作为 URL 的 <codeph>query parameter</codeph> 以更新媒体资源的网路路径。例如：
3542
<ul>
3643
<li>媒体资源网络路径为 <codeph>rtmp://$domain/$appName/$streamName</codeph></li>
3744
<li>通过鉴权信息更新过的媒体资源网络路径为 <codeph>rtmp://$domain/$appName/$streamName?ts=$ts&amp;sign=$sign</codeph></li>
3845
</ul>
3946
<note>
4047
<p>鉴权信息说明：
4148
<ul>
42-
<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>
49+
<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>
4350
<li><parmname>ts</parmname> : 鉴权过期时间。你可以指定再过多久鉴权过期。例如， <codeph>24h</codeph> 或 <codeph>1h30m20s</codeph>。</li>
4451
</ul></p>
4552
</note></p>
@@ -59,9 +66,9 @@
5966
<section id="return_values">
6067
<title><ph keyref="return-section-title"/></title>
6168
<p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
62-
<ul props="native unreal bp unity rn electron cs">
69+
<ul props="bp cs electron native rn unity unreal">
6370
<li>0: 方法调用成功。</li>
6471
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
6572
</ul> </section>
6673
</refbody>
67-
</reference>
74+
</reference>

0 commit comments

Comments
 (0)