Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
84 commits
Select commit Hold shift + click to select a range
1f4b4cd
Add external links for Camera API documentation (#3986)
saudsami Oct 29, 2025
49bf74a
Update Android camera links to official documentation (#3987)
saudsami Oct 29, 2025
830919b
Tongxin api (#3989)
lemon-chen Dec 11, 2025
c54b09b
add parent_class
Nero-Hu Oct 22, 2025
2846fa2
add toc
Nero-Hu Oct 27, 2025
a5d09bd
update namegroups
Nero-Hu Nov 5, 2025
46793be
update namegroups
Nero-Hu Nov 5, 2025
10c67ff
update toc
Nero-Hu Nov 5, 2025
7d9819d
update namegroups
Nero-Hu Nov 5, 2025
c7d2574
update namegroups
Nero-Hu Nov 6, 2025
0ebed5c
update script
Nero-Hu Nov 6, 2025
85f358c
remove
Nero-Hu Nov 6, 2025
e3bc2b8
update pys
Nero-Hu Nov 10, 2025
583f158
add RTC-AIDOC
Nero-Hu Nov 10, 2025
f0acf80
update fixture
Nero-Hu Nov 12, 2025
99ca42b
add aidoc gen
Nero-Hu Nov 13, 2025
ad69652
fix links and indent
Nero-Hu Nov 13, 2025
533275d
update dita
Nero-Hu Nov 13, 2025
a3c5fb9
update dita
Nero-Hu Nov 14, 2025
6f8ca78
update sunset
Nero-Hu Nov 14, 2025
4057506
update dita 3
Nero-Hu Nov 14, 2025
0e845cf
update dita 4
Nero-Hu Nov 17, 2025
ccd6bd3
update dita 5
Nero-Hu Nov 17, 2025
c0f1944
update dita 6
Nero-Hu Nov 17, 2025
97c93f7
ditagen 7
Nero-Hu Nov 19, 2025
2ad8a1c
update dita 8
Nero-Hu Nov 19, 2025
fa736a9
update overview
Nero-Hu Nov 19, 2025
1c5dd3b
update dita 9
Nero-Hu Nov 20, 2025
b01ef44
update indent
Nero-Hu Nov 20, 2025
07ef8e8
update dita 10
Nero-Hu Nov 20, 2025
95d1d75
update ditagen 11
Nero-Hu Nov 20, 2025
87348be
update dita 12
Nero-Hu Nov 21, 2025
abaa061
update dita 13
Nero-Hu Nov 24, 2025
9ca9c78
update dita 14
Nero-Hu Nov 24, 2025
e5008db
update dita 15
Nero-Hu Nov 26, 2025
537b8a8
update dita 16
Nero-Hu Nov 26, 2025
7cd2140
update dita 17
Nero-Hu Nov 27, 2025
0fd8af8
update dita 18
Nero-Hu Nov 27, 2025
0cdb06c
update dita 19
Nero-Hu Nov 28, 2025
40dc575
update dita 20
Nero-Hu Nov 28, 2025
ace8f38
update dita 22
Nero-Hu Nov 28, 2025
9b8015b
update dita 23
Nero-Hu Nov 28, 2025
ff8f4ee
update dita 24
Nero-Hu Nov 28, 2025
2cbb76a
fix dita
Nero-Hu Nov 28, 2025
767c2c2
update dita 25
Nero-Hu Dec 1, 2025
aac13c5
add name_groups_framework
Nero-Hu Dec 2, 2025
24a62fc
fix dita
Nero-Hu Dec 3, 2025
b4c7561
add dita-to-json
Nero-Hu Dec 3, 2025
5bcf535
update dita 26
Nero-Hu Dec 4, 2025
1803b62
update dita 27
Nero-Hu Dec 5, 2025
e2ba304
update dita 28
Nero-Hu Dec 5, 2025
a187778
update name_groups gen
Nero-Hu Dec 5, 2025
cdf20c2
add namegroups remove script
Nero-Hu Dec 5, 2025
c8583e8
update framework dita 1
Nero-Hu Dec 5, 2025
5c876d5
add en aidoc
Nero-Hu Dec 8, 2025
908a7bc
update json builder
Nero-Hu Dec 8, 2025
39c5249
update framework dita 2
Nero-Hu Dec 8, 2025
9036f8d
update framework dita 3
Nero-Hu Dec 8, 2025
bed6a61
fix dita and update script
Nero-Hu Dec 8, 2025
8c1ccce
update framework dita 4
Nero-Hu Dec 8, 2025
8def2f8
dita-to-json: fix conkeyref
Nero-Hu Dec 9, 2025
40b845a
add exception
Nero-Hu Dec 9, 2025
f32cf36
remove native
Nero-Hu Dec 9, 2025
75be6af
update framework dita 5
Nero-Hu Dec 9, 2025
090887d
dita-to-json: fix script
Nero-Hu Dec 10, 2025
7aa2e60
update framework dita 6
Nero-Hu Dec 10, 2025
9db1a0f
update framework dita 7
Nero-Hu Dec 10, 2025
65099f5
update dita 29
Nero-Hu Dec 10, 2025
fe46ff2
update dita 30
Nero-Hu Dec 11, 2025
c1ac41b
dita-to-json: fix
Nero-Hu Dec 11, 2025
05fbddf
update framework dita 8
Nero-Hu Dec 11, 2025
a799c36
update framework dita 9
Nero-Hu Dec 12, 2025
da88cc2
fix parml
Nero-Hu Dec 12, 2025
9553167
fix dita
Nero-Hu Dec 15, 2025
a6a30aa
update framework dita 10
Nero-Hu Dec 15, 2025
3f16883
add en full api
Nero-Hu Dec 16, 2025
5a5608d
add bp and unreal in datatype
Nero-Hu Dec 16, 2025
b83d43d
manual updates
lemon-chen Dec 16, 2025
a206be1
fix dita
Nero-Hu Dec 16, 2025
9825798
resolve flutter videoviewcontroller
Nero-Hu Dec 16, 2025
8b2b7bc
update frameworkdita 11
Nero-Hu Dec 16, 2025
65cfb0e
update framework dita 12
Nero-Hu Dec 16, 2025
f1cae27
update framework dita 13
Nero-Hu Dec 17, 2025
efaceea
add updates
lemon-chen Dec 19, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_iagoraparameter_setparameters_iagoraparameter">
<title><ph keyref="setParameters_IAgoraParameter"/></title>
<shortdesc id="short"><ph id="shortdesc" props="unity">通过 JSON 配置 SDK 提供技术预览或特别定制功能。</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="setParameters_IAgoraParameter"/>
</keywords>
</metadata>
</prolog>
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="unity" outputclass="language-csharp">public abstract int SetParameters(string parameters);</codeblock>
</p>
</section>
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<p props="unity">请[联系技术支持](https://ticket.shengwang.cn/)获取 JSON 配置方式。</p>
</section>
<section id="parameters" deliveryTarget="details" props="unity">
<title>参数</title>
<parml>
<plentry props="unity">
<pt>parameters</pt>
<pd>JSON 字符串形式的参数。</pd>
</plentry>
</parml>
</section>
<section id="return_values" props="unity">
<title>返回值</title>
<p props="unity">
<ul>
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。详见[错误码](https://doc.shengwang.cn/api-ref/rtc/unity/error-code)了解详情和解决建议。</li>
</ul>
</p>
</section>
</refbody>
</reference>
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_iaudiodevicemanager_enumerateplaybackdevices">
<title><ph keyref="enumeratePlaybackDevices"/></title>
<shortdesc id="short"><ph id="shortdesc" props="electron">获取系统中所有的播放设备列表。</ph><ph id="shortdesc" props="flutter">获取系统中所有的播放设备列表。</ph><ph id="shortdesc" props="unity">获取系统中所有的播放设备列表。</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="enumeratePlaybackDevices"/>
</keywords>
</metadata>
</prolog>
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="electron" outputclass="language-typescript">abstract enumeratePlaybackDevices(): AudioDeviceInfo[];</codeblock>
<codeblock props="flutter" outputclass="language-dart">List&lt;AudioDeviceInfo&gt; enumeratePlaybackDevices();</codeblock>
<codeblock props="unity" outputclass="language-csharp">public abstract DeviceInfo[] EnumeratePlaybackDevices();</codeblock>
</p>
</section>
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<note props="flutter">该方法仅适用于 Windows 和 macOS。</note>
<note props="unity">该方法仅适用于 Windows 和 macOS。</note>
</section>
<section id="return_values" props="electron flutter unity">
<title>返回值</title>
<p props="electron">
<ul>
<li>方法调用成功,返回 <xref keyref="AudioDeviceInfo"/> 数组,包含所有音频播放设备的设备 ID 和设备名称。</li>
<li>方法调用失败: 返回空列表。</li>
</ul>
</p>
<p props="flutter">
<ul>
<li>方法调用成功,返回 <xref keyref="AudioDeviceInfo"/> 数组,包含所有音频播放设备的设备 ID 和设备名称。</li>
<li>方法调用失败: 返回空列表。</li>
</ul>
</p>
<p props="unity">
<ul>
<li>方法调用成功,返回一个 DeviceInfo 数组,包含所有音频播放设备的设备 ID 和设备名称。</li>
<li>方法调用失败: <codeph><ph keyref="NULL"/></codeph>。</li>
</ul>
</p>
</section>
</refbody>
</reference>
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_iaudiodevicemanager_enumeraterecordingdevices">
<title><ph keyref="enumerateRecordingDevices"/></title>
<shortdesc id="short"><ph id="shortdesc" props="electron">获取系统中所有的音频采集设备列表。</ph><ph id="shortdesc" props="flutter">获取系统中所有的音频采集设备列表。</ph><ph id="shortdesc" props="unity">获取系统中所有的音频采集设备列表。</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="enumerateRecordingDevices"/>
</keywords>
</metadata>
</prolog>
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="electron" outputclass="language-typescript">abstract enumerateRecordingDevices(): AudioDeviceInfo[];</codeblock>
<codeblock props="flutter" outputclass="language-dart">List&lt;AudioDeviceInfo&gt; enumerateRecordingDevices();</codeblock>
<codeblock props="unity" outputclass="language-csharp">abstract DeviceInfo[] EnumerateRecordingDevices();</codeblock>
</p>
</section>
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<note props="flutter">该方法仅适用于 Windows 和 macOS。</note>
<note props="unity">该方法仅适用于 Windows 和 macOS。</note>
</section>
<section id="return_values" props="electron flutter unity">
<title>返回值</title>
<p props="electron">
<ul>
<li>方法调用成功,返回一个 <xref keyref="AudioDeviceInfo"/> 数组,包含所有音频采集设备的设备 ID 和设备名称。</li>
<li>方法调用失败: 返回空列表。</li>
</ul>
</p>
<p props="flutter">
<ul>
<li>方法调用成功,返回一个 <xref keyref="AudioDeviceInfo"/> 数组,包含所有音频采集设备的设备 ID 和设备名称。</li>
<li>方法调用失败: 返回空列表。</li>
</ul>
</p>
<p props="unity">
<ul>
<li>方法调用成功,返回一个 DeviceInfo 数组,包含所有音频采集设备的设备 ID 和设备名称。</li>
<li>方法调用失败: <codeph><ph keyref="NULL"/></codeph>。</li>
</ul>
</p>
</section>
</refbody>
</reference>
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_iaudiodevicemanager_followsystemloopbackdevice">
<title><ph keyref="followSystemLoopbackDevice"/></title>
<shortdesc id="short"><ph id="shortdesc" props="electron">设置声卡采集设备是否跟随系统默认的播放设备。</ph><ph id="shortdesc" props="flutter">设置声卡采集设备是否跟随系统默认的播放设备。</ph><ph id="shortdesc" props="unity">设置声卡采集设备是否跟随系统默认的播放设备。</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="followSystemLoopbackDevice"/>
</keywords>
</metadata>
</prolog>
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="electron" outputclass="language-typescript">abstract followSystemLoopbackDevice(enable: boolean): number;</codeblock>
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; followSystemLoopbackDevice(bool enable);</codeblock>
<codeblock props="unity" outputclass="language-csharp">public abstract int FollowSystemLoopbackDevice(bool enable);</codeblock>
</p>
</section>
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<p props="electron">方法仅适用于 Windows 和 macOS。</p>
<p props="flutter">方法仅适用于 Windows 和 macOS。</p>
<p props="unity">方法仅适用于 Windows 和 macOS。</p>
</section>
<section id="parameters" deliveryTarget="details" props="electron flutter unity">
<title>参数</title>
<parml>
<plentry props="electron">
<pt>enable</pt>
<pd>是否跟随系统默认的播放设备:
<ul>
<li><xref keyref="true"/>:跟随。当系统默认播放设备发生改变时,SDK 立即跟随切换声卡采集设备。</li>
<li><xref keyref="false"/>:不跟随。只有当 SDK 使用的声卡采集设备被移除后,SDK 才切换至系统默认的音频播放设备。</li>
</ul>
</pd>
</plentry>
<plentry props="flutter">
<pt>enable</pt>
<pd>是否跟随系统默认的播放设备:
<ul>
<li><xref keyref="true"/>:跟随。当系统默认播放设备发生改变时,SDK 立即跟随切换声卡采集设备。</li>
<li><xref keyref="false"/>:不跟随。只有当 SDK 使用的声卡采集设备被移除后,SDK 才切换至系统默认的音频播放设备。</li>
</ul>
</pd>
</plentry>
<plentry props="unity">
<pt>enable</pt>
<pd>是否跟随系统默认的播放设备:
<ul>
<li><xref keyref="true"/>:跟随。当系统默认播放设备发生改变时,SDK 立即跟随切换声卡采集设备。</li>
<li><xref keyref="false"/>:不跟随。只有当 SDK 使用的声卡采集设备被移除后,SDK 才切换至系统默认的音频播放设备。</li>
</ul>
</pd>
</plentry>
</parml>
</section>
<section id="return_values" props="electron flutter unity">
<title>返回值</title>
<p props="electron">
<ul>
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。详见[错误码](https://doc.shengwang.cn/api-ref/rtc/electron/error-code)了解详情和解决建议。</li>
</ul>
</p>
<p props="flutter">方法成功调用时,无返回值;方法调用失败时,会抛出 <xref keyref="AgoraRtcException"/> 异常,你需要捕获异常并进行处理。详见[错误码](https://doc.shengwang.cn/api-ref/rtc/flutter/error-code)了解详情和解决建议。</p>
<p props="unity">
<ul>
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。详见[错误码](https://doc.shengwang.cn/api-ref/rtc/unity/error-code)了解详情和解决建议。</li>
</ul>
</p>
</section>
</refbody>
</reference>
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_iaudiodevicemanager_followsystemplaybackdevice">
<title><ph keyref="followSystemPlaybackDevice"/></title>
<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>
<prolog>
<metadata>
<keywords>
<indexterm keyref="followSystemPlaybackDevice"/>
</keywords>
</metadata>
</prolog>
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="electron" outputclass="language-typescript">abstract followSystemPlaybackDevice(enable: boolean): number;</codeblock>
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; followSystemPlaybackDevice(bool enable);</codeblock>
<codeblock props="unity" outputclass="language-csharp">public abstract int FollowSystemPlaybackDevice(bool enable);</codeblock>
</p>
</section>
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<note props="flutter">该方法仅适用于 Windows 和 macOS。</note>
<note props="unity">该方法仅适用于 Windows 和 macOS。</note>
</section>
<section id="parameters" deliveryTarget="details" props="electron flutter unity">
<title>参数</title>
<parml>
<plentry props="electron">
<pt>enable</pt>
<pd>是否跟随系统默认的音频播放设备:
<ul>
<li><xref keyref="true"/>:跟随。当系统默认音频播放设备发生改变时,SDK 立即切换音频播放设备。</li>
<li><xref keyref="false"/>:不跟随。只有当 SDK 使用的音频播放设备被移除后,SDK 才切换至系统默认的音频播放设备。</li>
</ul>
</pd>
</plentry>
<plentry props="flutter">
<pt>enable</pt>
<pd>是否跟随系统默认的音频播放设备:
<ul>
<li><xref keyref="true"/>:跟随。当系统默认音频播放设备发生改变时,SDK 立即切换音频播放设备。</li>
<li><xref keyref="false"/>:不跟随。只有当 SDK 使用的音频播放设备被移除后,SDK 才切换至系统默认的音频播放设备。</li>
</ul>
</pd>
</plentry>
<plentry props="unity">
<pt>enable</pt>
<pd>是否跟随系统默认的音频播放设备:
<ul>
<li><xref keyref="true"/>:跟随。当系统默认音频播放设备发生改变时,SDK 立即切换音频播放设备。</li>
<li><xref keyref="false"/>:不跟随。只有当 SDK 使用的音频播放设备被移除后,SDK 才切换至系统默认的音频播放设备。</li>
</ul>
</pd>
</plentry>
</parml>
</section>
<section id="return_values" props="electron flutter unity">
<title>返回值</title>
<p props="electron">
<ul>
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。详见[错误码](https://doc.shengwang.cn/api-ref/rtc/electron/error-code)了解详情和解决建议。</li>
</ul>
</p>
<p props="flutter">方法成功调用时,无返回值;方法调用失败时,会抛出 <xref keyref="AgoraRtcException"/> 异常,你需要捕获异常并进行处理。详见[错误码](https://doc.shengwang.cn/api-ref/rtc/flutter/error-code)了解详情和解决建议。</p>
<p props="unity">
<ul>
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。详见[错误码](https://doc.shengwang.cn/api-ref/rtc/unity/error-code)了解详情和解决建议。</li>
</ul>
</p>
</section>
</refbody>
</reference>
Loading
Loading