Skip to content

Commit

Permalink
Merge pull request #3301 from AgoraIO/api-reorg
Browse files Browse the repository at this point in the history
API reorg
  • Loading branch information
Cilla-luodan authored Sep 21, 2023
2 parents a7dbf22 + 39edcd0 commit 3aba2ca
Show file tree
Hide file tree
Showing 602 changed files with 11,745 additions and 9,442 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_channelmediarelayconfiguration_getdestchannelmediainfo">
<reference id="api_channelmediarelayconfiguration_getdestchannelmediainfos">
<title><ph keyref="getDestChannelMediaInfos"/></title>
<shortdesc id="short"><ph id="shortdesc">获取目标频道信息。</ph></shortdesc>
<prolog>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
<section id="return_values" props="ios mac">
<ul>
<li><codeph><ph keyref="true"/></codeph>:方法调用成功。</li>
<li><codeph><ph keyref="false"/></codeph>:方法调用失败。</li>
<li><codeph><ph keyref="false"/></codeph>:方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul>
</section>
</refbody>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
<section id="return_values" props="ios mac">
<ul>
<li><codeph><ph keyref="true"/></codeph>:方法调用成功。</li>
<li><codeph><ph keyref="false"/></codeph>:方法调用失败。</li>
<li><codeph><ph keyref="false"/></codeph>:方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul>
</section>
</refbody>
Expand Down
2 changes: 1 addition & 1 deletion dita/RTC-NG/API/api_iagoraparameter_setparameters.dita
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<title>返回值</title>
<ul id="ul_uns_l2y_hqb">
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul> </section>
</refbody>
</reference>
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<title>返回值</title>
<ul>
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul> </section>
</refbody>
</reference>
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
<title>返回值</title>
<ul props="cpp unreal bp">
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。</li>
<li>&lt; 0: 方法调用失败。详见 <xref keyref="error-code-link"/>了解详情和解决建议。</li>
</ul>
<ul props="mac">
<li>调用成功时,返回 <xref keyref="AgoraRtcDeviceInfo"/> 对象,包含默认的音频设备信息。</li>
Expand Down
2 changes: 1 addition & 1 deletion dita/RTC-NG/API/api_iaudiodevicecollection_getdevice.dita
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
<title>返回值</title>
<ul props="cpp unreal bp">
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul>
<p props="unity flutter electron rn cs">音频采集设备信息。</p>
</section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
<title>返回值</title>
<ul>
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul> </section>
</refbody>
</reference>
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<title>返回值</title>
<ul>
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul> </section>
</refbody>
</reference>
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<title>返回值</title>
<ul>
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul> </section>
</refbody>
</reference>
4 changes: 2 additions & 2 deletions dita/RTC-NG/API/api_iaudiodevicecollection_setdevice.dita
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@
</parml> </section>
<section id="return_values">
<title><ph keyref="return-section-title"/></title>
<p props="flutter">方法成功调用时,无返回值;方法调用失败时,会抛出 <xref keyref="AgoraRtcException"/> 异常,你需要捕获异常并进行处理。</p>
<p props="flutter">方法成功调用时,无返回值;方法调用失败时,会抛出 <xref keyref="AgoraRtcException"/> 异常,你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
<ul>
<li props="native unreal bp electron unity rn cs">0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul> </section>
</refbody>
</reference>
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,10 @@
</parml> </section>
<section id="return_values">
<title><ph keyref="return-section-title"/></title>
<p props="flutter">方法成功调用时,无返回值;方法调用失败时,会抛出 <xref keyref="AgoraRtcException"/> 异常,你需要捕获异常并进行处理。</p>
<p props="flutter">方法成功调用时,无返回值;方法调用失败时,会抛出 <xref keyref="AgoraRtcException"/> 异常,你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
<ul>
<li props="native unreal bp unity electron cs">0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul> </section>
</refbody>
</reference>
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@
</parml> </section>
<section id="return_values">
<title><ph keyref="return-section-title"/></title>
<p props="flutter">方法成功调用时,无返回值;方法调用失败时,会抛出 <xref keyref="AgoraRtcException"/> 异常,你需要捕获异常并进行处理。</p>
<p props="flutter">方法成功调用时,无返回值;方法调用失败时,会抛出 <xref keyref="AgoraRtcException"/> 异常,你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
<ul>
<li props="native unreal bp unity electron rn cs">0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul> </section>
</refbody>
</reference>
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,10 @@
</parml></section>
<section id="return_values">
<title><ph keyref="return-section-title"/></title>
<p props="flutter">方法成功调用时,无返回值;方法调用失败时,会抛出 <xref keyref="AgoraRtcException"/> 异常,你需要捕获异常并进行处理。</p>
<p props="flutter">方法成功调用时,无返回值;方法调用失败时,会抛出 <xref keyref="AgoraRtcException"/> 异常,你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
<ul>
<li props="mac cpp unreal bp unity electron rn cs">0:方法调用成功</li>
<li>&lt; 0:方法调用失败</li>
<li props="mac cpp unreal bp unity electron rn cs">0:方法调用成功</li>
<li>&lt; 0:方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul> </section>
</refbody>
</reference>
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
<title>返回值</title>
<ul props="cpp unreal bp unity cs">
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul>
<p props="electron flutter">当前声卡采集设备的 ID。</p></section>
</refbody>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@
<title>返回值</title>
<p props="flutter electron">默认音频播放设备的信息。详见 <xref keyref="AudioDeviceInfo"/>。</p>
<ul props="unity cs">
<li>0:方法调用成功</li>
<li>&lt; 0:方法调用失败</li>
<li>0:方法调用成功</li>
<li>&lt; 0:方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul>
</section>
</refbody>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<title>返回值</title>
<ul props="cpp unreal bp unity cs">
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul>
<p props="flutter electron rn flutter">当前音频播放设备。</p>
</section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
<title>返回值</title>
<ul props="cpp unreal bp unity cs">
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul>
<p props="electron flutter rn"><xref keyref="AudioDeviceInfo" /> 对象,包含音频播放设备的设备 ID 和设备名称。</p>
</section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
<title>返回值</title>
<ul props="cpp unreal bp">
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul>
<ul props="electron unity flutter cs">
<li><codeph><ph keyref="true" /></codeph>: 播放设备为静音状态。</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<title>返回值</title>
<ul props="cpp unreal bp">
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul>
<p props="electron unity flutter cs">播放设备音量。取值范围 [0,255]。</p>
</section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@
<title>返回值</title>
<p props="flutter electron">默认音频采集设备的信息。详见 <xref keyref="AudioDeviceInfo"/>。</p>
<ul props="unity cs">
<li>0:方法调用成功</li>
<li>&lt; 0:方法调用失败</li>
<li>0:方法调用成功</li>
<li>&lt; 0:方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul>
</section>
</refbody>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<title>返回值</title>
<ul props="cpp unreal bp unity cs">
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul>
<p props="flutter electron rn">当前音频采集设备。</p>
</section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
<title>返回值</title>
<ul props="cpp unreal bp unity cs">
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul>
<p props="electron flutter rn"><xref keyref="AudioDeviceInfo" /> 对象,包含音频采集设备的设备 ID 和设备名称。</p>
</section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<title>返回值</title>
<ul props="cpp unreal bp">
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul>
<ul props="electron unity flutter cs">
<li><codeph><ph keyref="true" /></codeph>: 采集设备为静音状态。</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<title>返回值</title>
<ul props="cpp unreal bp">
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul>
<p props="electron unity flutter cs">音频采集设备音量。取值范围 [0,255]。</p>
</section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,10 @@
</parml> </section>
<section id="return_values">
<title><ph keyref="return-section-title"/></title>
<p props="flutter">方法成功调用时,无返回值;方法调用失败时,会抛出 <xref keyref="AgoraRtcException"/> 异常,你需要捕获异常并进行处理。</p>
<p props="flutter">方法成功调用时,无返回值;方法调用失败时,会抛出 <xref keyref="AgoraRtcException"/> 异常,你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
<ul>
<li props="cpp unreal bp electron unity cs">0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul> </section>
</refbody>
</reference>
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@
</parml> </section>
<section id="return_values">
<title><ph keyref="return-section-title"/></title>
<p props="flutter">方法成功调用时,无返回值;方法调用失败时,会抛出 <xref keyref="AgoraRtcException"/> 异常,你需要捕获异常并进行处理。</p>
<p props="flutter">方法成功调用时,无返回值;方法调用失败时,会抛出 <xref keyref="AgoraRtcException"/> 异常,你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
<ul>
<li props="native unreal bp electron unity rn cs">0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul> </section>
</refbody>
</reference>
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,10 @@
</parml> </section>
<section id="return_values">
<title><ph keyref="return-section-title"/></title>
<p props="flutter">方法成功调用时,无返回值;方法调用失败时,会抛出 <xref keyref="AgoraRtcException"/> 异常,你需要捕获异常并进行处理。</p>
<p props="flutter">方法成功调用时,无返回值;方法调用失败时,会抛出 <xref keyref="AgoraRtcException"/> 异常,你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
<ul>
<li props="native unreal bp electron unity rn cs">0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul> </section>
</refbody>
</reference>
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@
</parml> </section>
<section id="return_values">
<title><ph keyref="return-section-title"/></title>
<p props="flutter">方法成功调用时,无返回值;方法调用失败时,会抛出 <xref keyref="AgoraRtcException"/> 异常,你需要捕获异常并进行处理。</p>
<p props="flutter">方法成功调用时,无返回值;方法调用失败时,会抛出 <xref keyref="AgoraRtcException"/> 异常,你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
<ul>
<li props="native unreal bp electron unity rn cs">0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul> </section>
</refbody>
</reference>
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@
</parml> </section>
<section id="return_values">
<title><ph keyref="return-section-title"/></title>
<p props="flutter">方法成功调用时,无返回值;方法调用失败时,会抛出 <xref keyref="AgoraRtcException"/> 异常,你需要捕获异常并进行处理。</p>
<p props="flutter">方法成功调用时,无返回值;方法调用失败时,会抛出 <xref keyref="AgoraRtcException"/> 异常,你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
<ul>
<li props="native unreal bp electron unity rn cs">0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul> </section>
</refbody>
</reference>
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,10 @@
</parml> </section>
<section id="return_values">
<title><ph keyref="return-section-title"/></title>
<p props="flutter">方法成功调用时,无返回值;方法调用失败时,会抛出 <xref keyref="AgoraRtcException"/> 异常,你需要捕获异常并进行处理。</p>
<p props="flutter">方法成功调用时,无返回值;方法调用失败时,会抛出 <xref keyref="AgoraRtcException"/> 异常,你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
<ul>
<li props="native unreal bp electron unity rn cs">0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul> </section>
</refbody>
</reference>
Loading

0 comments on commit 3aba2ca

Please sign in to comment.