Skip to content

Commit e04a73d

Browse files
lemon-chenNero-Hu
lemon-chen
and
Nero-Hu
authored
Ditagen review (#3990)
* add parent_class * add toc * update namegroups * update namegroups * update toc * update namegroups * update namegroups * update script * remove * update pys * add RTC-AIDOC * update fixture * add aidoc gen * fix links and indent * update dita * update dita * update sunset * update dita 3 * update dita 4 * update dita 5 * update dita 6 * ditagen 7 * update dita 8 * update overview * update dita 9 * update indent * update dita 10 * update ditagen 11 * update dita 12 * update dita 13 * update dita 14 * update dita 15 * update dita 16 * update dita 17 * update dita 18 * update dita 19 * update dita 20 * update dita 22 * update dita 23 * update dita 24 * fix dita * update dita 25 * add name_groups_framework * fix dita * add dita-to-json * update dita 26 * update dita 27 * update dita 28 * update name_groups gen * add namegroups remove script * update framework dita 1 * add en aidoc * update json builder * update framework dita 2 * update framework dita 3 * fix dita and update script * update framework dita 4 * dita-to-json: fix conkeyref * add exception * remove native * update framework dita 5 * dita-to-json: fix script * update framework dita 6 * update framework dita 7 * update dita 29 * update dita 30 * dita-to-json: fix * update framework dita 8 * update framework dita 9 * fix parml * fix dita * update framework dita 10 * add en full api * add bp and unreal in datatype * manual updates * fix dita * resolve flutter videoviewcontroller * update frameworkdita 11 * update framework dita 12 * update framework dita 13 * add updates --------- Co-authored-by: Nero-Hu <[email protected]>
1 parent 830919b commit e04a73d

3,782 files changed

Lines changed: 574941 additions & 16193 deletions

File tree

Some content is hidden

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

‎dita/RTC-AIDOC-FRAMEWORK/API/api_iagoraparameter_setparameters_iagoraparameter.dita‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<?xml version='1.0' encoding='UTF-8'?>
2+
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
3+
<reference id="api_iagoraparameter_setparameters_iagoraparameter">
4+
<title><ph keyref="setParameters_IAgoraParameter"/></title>
5+
<shortdesc id="short"><ph id="shortdesc" props="unity">通过 JSON 配置 SDK 提供技术预览或特别定制功能。</ph></shortdesc>
6+
<prolog>
7+
<metadata>
8+
<keywords>
9+
<indexterm keyref="setParameters_IAgoraParameter"/>
10+
</keywords>
11+
</metadata>
12+
</prolog>
13+
<refbody>
14+
<section id="prototype">
15+
<p outputclass="codeblock">
16+
<codeblock props="unity" outputclass="language-csharp">public abstract int SetParameters(string parameters);</codeblock>
17+
</p>
18+
</section>
19+
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
20+
<p props="unity">请[联系技术支持](https://ticket.shengwang.cn/)获取 JSON 配置方式。</p>
21+
</section>
22+
<section id="parameters" deliveryTarget="details" props="unity">
23+
<title>参数</title>
24+
<parml>
25+
<plentry props="unity">
26+
<pt>parameters</pt>
27+
<pd>JSON 字符串形式的参数。</pd>
28+
</plentry>
29+
</parml>
30+
</section>
31+
<section id="return_values" props="unity">
32+
<title>返回值</title>
33+
<p props="unity">
34+
<ul>
35+
<li>0: 方法调用成功。</li>
36+
<li>&lt; 0: 方法调用失败。详见[错误码](https://doc.shengwang.cn/api-ref/rtc/unity/error-code)了解详情和解决建议。</li>
37+
</ul>
38+
</p>
39+
</section>
40+
</refbody>
41+
</reference>

‎dita/RTC-AIDOC-FRAMEWORK/API/api_iaudiodevicemanager_enumerateplaybackdevices.dita‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<?xml version='1.0' encoding='UTF-8'?>
2+
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
3+
<reference id="api_iaudiodevicemanager_enumerateplaybackdevices">
4+
<title><ph keyref="enumeratePlaybackDevices"/></title>
5+
<shortdesc id="short"><ph id="shortdesc" props="electron">获取系统中所有的播放设备列表。</ph><ph id="shortdesc" props="flutter">获取系统中所有的播放设备列表。</ph><ph id="shortdesc" props="unity">获取系统中所有的播放设备列表。</ph></shortdesc>
6+
<prolog>
7+
<metadata>
8+
<keywords>
9+
<indexterm keyref="enumeratePlaybackDevices"/>
10+
</keywords>
11+
</metadata>
12+
</prolog>
13+
<refbody>
14+
<section id="prototype">
15+
<p outputclass="codeblock">
16+
<codeblock props="electron" outputclass="language-typescript">abstract enumeratePlaybackDevices(): AudioDeviceInfo[];</codeblock>
17+
<codeblock props="flutter" outputclass="language-dart">List&lt;AudioDeviceInfo&gt; enumeratePlaybackDevices();</codeblock>
18+
<codeblock props="unity" outputclass="language-csharp">public abstract DeviceInfo[] EnumeratePlaybackDevices();</codeblock>
19+
</p>
20+
</section>
21+
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
22+
<note props="flutter">该方法仅适用于 Windows 和 macOS。</note>
23+
<note props="unity">该方法仅适用于 Windows 和 macOS。</note>
24+
</section>
25+
<section id="return_values" props="electron flutter unity">
26+
<title>返回值</title>
27+
<p props="electron">
28+
<ul>
29+
<li>方法调用成功，返回 <xref keyref="AudioDeviceInfo"/> 数组，包含所有音频播放设备的设备 ID 和设备名称。</li>
30+
<li>方法调用失败: 返回空列表。</li>
31+
</ul>
32+
</p>
33+
<p props="flutter">
34+
<ul>
35+
<li>方法调用成功，返回 <xref keyref="AudioDeviceInfo"/> 数组，包含所有音频播放设备的设备 ID 和设备名称。</li>
36+
<li>方法调用失败: 返回空列表。</li>
37+
</ul>
38+
</p>
39+
<p props="unity">
40+
<ul>
41+
<li>方法调用成功，返回一个 DeviceInfo 数组，包含所有音频播放设备的设备 ID 和设备名称。</li>
42+
<li>方法调用失败: <codeph><ph keyref="NULL"/></codeph>。</li>
43+
</ul>
44+
</p>
45+
</section>
46+
</refbody>
47+
</reference>

‎dita/RTC-AIDOC-FRAMEWORK/API/api_iaudiodevicemanager_enumeraterecordingdevices.dita‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<?xml version='1.0' encoding='UTF-8'?>
2+
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
3+
<reference id="api_iaudiodevicemanager_enumeraterecordingdevices">
4+
<title><ph keyref="enumerateRecordingDevices"/></title>
5+
<shortdesc id="short"><ph id="shortdesc" props="electron">获取系统中所有的音频采集设备列表。</ph><ph id="shortdesc" props="flutter">获取系统中所有的音频采集设备列表。</ph><ph id="shortdesc" props="unity">获取系统中所有的音频采集设备列表。</ph></shortdesc>
6+
<prolog>
7+
<metadata>
8+
<keywords>
9+
<indexterm keyref="enumerateRecordingDevices"/>
10+
</keywords>
11+
</metadata>
12+
</prolog>
13+
<refbody>
14+
<section id="prototype">
15+
<p outputclass="codeblock">
16+
<codeblock props="electron" outputclass="language-typescript">abstract enumerateRecordingDevices(): AudioDeviceInfo[];</codeblock>
17+
<codeblock props="flutter" outputclass="language-dart">List&lt;AudioDeviceInfo&gt; enumerateRecordingDevices();</codeblock>
18+
<codeblock props="unity" outputclass="language-csharp">abstract DeviceInfo[] EnumerateRecordingDevices();</codeblock>
19+
</p>
20+
</section>
21+
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
22+
<note props="flutter">该方法仅适用于 Windows 和 macOS。</note>
23+
<note props="unity">该方法仅适用于 Windows 和 macOS。</note>
24+
</section>
25+
<section id="return_values" props="electron flutter unity">
26+
<title>返回值</title>
27+
<p props="electron">
28+
<ul>
29+
<li>方法调用成功，返回一个 <xref keyref="AudioDeviceInfo"/> 数组，包含所有音频采集设备的设备 ID 和设备名称。</li>
30+
<li>方法调用失败: 返回空列表。</li>
31+
</ul>
32+
</p>
33+
<p props="flutter">
34+
<ul>
35+
<li>方法调用成功，返回一个 <xref keyref="AudioDeviceInfo"/> 数组，包含所有音频采集设备的设备 ID 和设备名称。</li>
36+
<li>方法调用失败: 返回空列表。</li>
37+
</ul>
38+
</p>
39+
<p props="unity">
40+
<ul>
41+
<li>方法调用成功，返回一个 DeviceInfo 数组，包含所有音频采集设备的设备 ID 和设备名称。</li>
42+
<li>方法调用失败: <codeph><ph keyref="NULL"/></codeph>。</li>
43+
</ul>
44+
</p>
45+
</section>
46+
</refbody>
47+
</reference>

‎dita/RTC-AIDOC-FRAMEWORK/API/api_iaudiodevicemanager_followsystemloopbackdevice.dita‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
<?xml version='1.0' encoding='UTF-8'?>
2+
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
3+
<reference id="api_iaudiodevicemanager_followsystemloopbackdevice">
4+
<title><ph keyref="followSystemLoopbackDevice"/></title>
5+
<shortdesc id="short"><ph id="shortdesc" props="electron">设置声卡采集设备是否跟随系统默认的播放设备。</ph><ph id="shortdesc" props="flutter">设置声卡采集设备是否跟随系统默认的播放设备。</ph><ph id="shortdesc" props="unity">设置声卡采集设备是否跟随系统默认的播放设备。</ph></shortdesc>
6+
<prolog>
7+
<metadata>
8+
<keywords>
9+
<indexterm keyref="followSystemLoopbackDevice"/>
10+
</keywords>
11+
</metadata>
12+
</prolog>
13+
<refbody>
14+
<section id="prototype">
15+
<p outputclass="codeblock">
16+
<codeblock props="electron" outputclass="language-typescript">abstract followSystemLoopbackDevice(enable: boolean): number;</codeblock>
17+
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; followSystemLoopbackDevice(bool enable);</codeblock>
18+
<codeblock props="unity" outputclass="language-csharp">public abstract int FollowSystemLoopbackDevice(bool enable);</codeblock>
19+
</p>
20+
</section>
21+
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
22+
<p props="electron">方法仅适用于 Windows 和 macOS。</p>
23+
<p props="flutter">方法仅适用于 Windows 和 macOS。</p>
24+
<p props="unity">方法仅适用于 Windows 和 macOS。</p>
25+
</section>
26+
<section id="parameters" deliveryTarget="details" props="electron flutter unity">
27+
<title>参数</title>
28+
<parml>
29+
<plentry props="electron">
30+
<pt>enable</pt>
31+
<pd>是否跟随系统默认的播放设备：
32+
<ul>
33+
<li><xref keyref="true"/>：跟随。当系统默认播放设备发生改变时，SDK 立即跟随切换声卡采集设备。</li>
34+
<li><xref keyref="false"/>：不跟随。只有当 SDK 使用的声卡采集设备被移除后，SDK 才切换至系统默认的音频播放设备。</li>
35+
</ul>
36+
</pd>
37+
</plentry>
38+
<plentry props="flutter">
39+
<pt>enable</pt>
40+
<pd>是否跟随系统默认的播放设备：
41+
<ul>
42+
<li><xref keyref="true"/>：跟随。当系统默认播放设备发生改变时，SDK 立即跟随切换声卡采集设备。</li>
43+
<li><xref keyref="false"/>：不跟随。只有当 SDK 使用的声卡采集设备被移除后，SDK 才切换至系统默认的音频播放设备。</li>
44+
</ul>
45+
</pd>
46+
</plentry>
47+
<plentry props="unity">
48+
<pt>enable</pt>
49+
<pd>是否跟随系统默认的播放设备：
50+
<ul>
51+
<li><xref keyref="true"/>：跟随。当系统默认播放设备发生改变时，SDK 立即跟随切换声卡采集设备。</li>
52+
<li><xref keyref="false"/>：不跟随。只有当 SDK 使用的声卡采集设备被移除后，SDK 才切换至系统默认的音频播放设备。</li>
53+
</ul>
54+
</pd>
55+
</plentry>
56+
</parml>
57+
</section>
58+
<section id="return_values" props="electron flutter unity">
59+
<title>返回值</title>
60+
<p props="electron">
61+
<ul>
62+
<li>0: 方法调用成功。</li>
63+
<li>&lt; 0: 方法调用失败。详见[错误码](https://doc.shengwang.cn/api-ref/rtc/electron/error-code)了解详情和解决建议。</li>
64+
</ul>
65+
</p>
66+
<p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。详见[错误码](https://doc.shengwang.cn/api-ref/rtc/flutter/error-code)了解详情和解决建议。</p>
67+
<p props="unity">
68+
<ul>
69+
<li>0: 方法调用成功。</li>
70+
<li>&lt; 0: 方法调用失败。详见[错误码](https://doc.shengwang.cn/api-ref/rtc/unity/error-code)了解详情和解决建议。</li>
71+
</ul>
72+
</p>
73+
</section>
74+
</refbody>
75+
</reference>

‎dita/RTC-AIDOC-FRAMEWORK/API/api_iaudiodevicemanager_followsystemplaybackdevice.dita‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
<?xml version='1.0' encoding='UTF-8'?>
2+
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
3+
<reference id="api_iaudiodevicemanager_followsystemplaybackdevice">
4+
<title><ph keyref="followSystemPlaybackDevice"/></title>
5+
<shortdesc id="short"><ph id="shortdesc" props="electron">设置 SDK 使用的音频播放设备跟随系统默认的音频播放设备。</ph><ph id="shortdesc" props="flutter">设置 SDK 使用的音频播放设备跟随系统默认的音频播放设备。</ph><ph id="shortdesc" props="unity">设置 SDK 使用的音频播放设备跟随系统默认的音频播放设备。</ph></shortdesc>
6+
<prolog>
7+
<metadata>
8+
<keywords>
9+
<indexterm keyref="followSystemPlaybackDevice"/>
10+
</keywords>
11+
</metadata>
12+
</prolog>
13+
<refbody>
14+
<section id="prototype">
15+
<p outputclass="codeblock">
16+
<codeblock props="electron" outputclass="language-typescript">abstract followSystemPlaybackDevice(enable: boolean): number;</codeblock>
17+
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; followSystemPlaybackDevice(bool enable);</codeblock>
18+
<codeblock props="unity" outputclass="language-csharp">public abstract int FollowSystemPlaybackDevice(bool enable);</codeblock>
19+
</p>
20+
</section>
21+
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
22+
<note props="flutter">该方法仅适用于 Windows 和 macOS。</note>
23+
<note props="unity">该方法仅适用于 Windows 和 macOS。</note>
24+
</section>
25+
<section id="parameters" deliveryTarget="details" props="electron flutter unity">
26+
<title>参数</title>
27+
<parml>
28+
<plentry props="electron">
29+
<pt>enable</pt>
30+
<pd>是否跟随系统默认的音频播放设备：
31+
<ul>
32+
<li><xref keyref="true"/>：跟随。当系统默认音频播放设备发生改变时，SDK 立即切换音频播放设备。</li>
33+
<li><xref keyref="false"/>：不跟随。只有当 SDK 使用的音频播放设备被移除后，SDK 才切换至系统默认的音频播放设备。</li>
34+
</ul>
35+
</pd>
36+
</plentry>
37+
<plentry props="flutter">
38+
<pt>enable</pt>
39+
<pd>是否跟随系统默认的音频播放设备：
40+
<ul>
41+
<li><xref keyref="true"/>：跟随。当系统默认音频播放设备发生改变时，SDK 立即切换音频播放设备。</li>
42+
<li><xref keyref="false"/>：不跟随。只有当 SDK 使用的音频播放设备被移除后，SDK 才切换至系统默认的音频播放设备。</li>
43+
</ul>
44+
</pd>
45+
</plentry>
46+
<plentry props="unity">
47+
<pt>enable</pt>
48+
<pd>是否跟随系统默认的音频播放设备：
49+
<ul>
50+
<li><xref keyref="true"/>：跟随。当系统默认音频播放设备发生改变时，SDK 立即切换音频播放设备。</li>
51+
<li><xref keyref="false"/>：不跟随。只有当 SDK 使用的音频播放设备被移除后，SDK 才切换至系统默认的音频播放设备。</li>
52+
</ul>
53+
</pd>
54+
</plentry>
55+
</parml>
56+
</section>
57+
<section id="return_values" props="electron flutter unity">
58+
<title>返回值</title>
59+
<p props="electron">
60+
<ul>
61+
<li>0: 方法调用成功。</li>
62+
<li>&lt; 0: 方法调用失败。详见[错误码](https://doc.shengwang.cn/api-ref/rtc/electron/error-code)了解详情和解决建议。</li>
63+
</ul>
64+
</p>
65+
<p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。详见[错误码](https://doc.shengwang.cn/api-ref/rtc/flutter/error-code)了解详情和解决建议。</p>
66+
<p props="unity">
67+
<ul>
68+
<li>0: 方法调用成功。</li>
69+
<li>&lt; 0: 方法调用失败。详见[错误码](https://doc.shengwang.cn/api-ref/rtc/unity/error-code)了解详情和解决建议。</li>
70+
</ul>
71+
</p>
72+
</section>
73+
</refbody>
74+
</reference>

0 commit comments

Comments
 (0)