Merge branch 'master' into release/rtc-ng/4.2.3

AgoraIO · Sep 21, 2023 · 1e762d5 · 1e762d5
2 parents 27ab3ec + cf42f4e
commit 1e762d5
Show file tree

Hide file tree

Showing 23 changed files with 456 additions and 811 deletions.
diff --git a/dita/RTC-NG/API/api_imediaplayer_getstreamcount.dita b/dita/RTC-NG/API/api_imediaplayer_getstreamcount.dita
@@ -24,7 +24,7 @@
         </section>
         <section id="detailed_desc">
             <title>详情</title>
-            <note type="attention" id="note">你需要在 <xref keyref="open" /> 后调用该方法。</note> </section>
+            <note type="attention" id="note">请在 <xref keyref="open"/> 后并收到 <xref keyref="onPlayerSourceStateChanged" /> 回调报告播放状态为 <apiname keyref="PLAYER_STATE_OPEN_COMPLETED" /> 后再调用该方法。</note> </section>
         <section id="parameters" props="cpp unreal bp unity cs">
             <title>参数</title>
             <parml>
@@ -41,4 +41,4 @@
             <li>&lt; 0: 方法调用失败，详见 <xref keyref="MEDIA_PLAYER_ERROR" />。</li>
             </ul> </section>
     </refbody>
-</reference>
+</reference>
diff --git a/dita/RTC-NG/API/class_channelmediaoptions.dita b/dita/RTC-NG/API/class_channelmediaoptions.dita
@@ -502,7 +502,9 @@ class ChannelMediaOptions {
                     <note type="note">
                     <ul><li props="native unity rn electron">自 v4.0.0 起，该参数名称由 <parmname>publishAudioTrack</parmname> 改为 <parmname>publishMicrophoneTrack</parmname>。</li>
                     <li props="flutter">自 v6.0.0 起，该参数名称由 <parmname>publishAudioTrack</parmname> 改为 <parmname>publishMicrophoneTrack</parmname>。</li>
-                    <li>如果你想要发布麦克风采集到的音频流，请确保 <parmname>enableAudioRecordingOrPlayout</parmname> 设为 <codeph><ph keyref="true"/></codeph>。</li></ul></note>
+                    <li>如果你将该参数设为 <codeph><ph keyref="false"/></codeph>，SDK 也会关闭麦克风采集。</li>
+                        <li>如果你想要发布麦克风采集到的音频流，请确保 <parmname>enableAudioRecordingOrPlayout</parmname> 设为 <codeph><ph keyref="true"/></codeph>。</li>
+                    </ul></note>
                 </pd>
             </plentry>
             <plentry props="cpp mac unity cs flutter electron">

diff --git a/dita/RTC-NG/API/class_screencaptureparameters.dita b/dita/RTC-NG/API/class_screencaptureparameters.dita
@@ -258,6 +258,7 @@
                     <li><codeph><ph keyref="true"/></codeph>:（默认）采集鼠标。</li>
                     <li><codeph><ph keyref="false"/></codeph>: 不采集鼠标。</li>
                     </ul></p>
+                    <note props="cpp mac unity flutter electron">受 macOS 系统限制，在共享屏幕时将该参数设置为 <codeph><ph keyref="false"/></codeph> 无效（共享窗口时无影响）。</note>
                 </pd>
             </plentry>
             <plentry props="mac cpp unreal bp unity electron rn flutter cs">

diff --git a/dita/RTC-NG/API/enum_networktype.dita b/dita/RTC-NG/API/enum_networktype.dita
@@ -21,7 +21,7 @@
        </plentry>
        <plentry>
   <pt><ph keyref="NETWORK_TYPE_WIFI"/></pt>
-  <pd>2: 网络类型为 Wi-Fi (包含热点）。</pd>
+  <pd>2: 网络类型为 Wi-Fi（包含热点）。</pd>
        </plentry>
        <plentry>
   <pt><ph keyref="NETWORK_TYPE_MOBILE_2G"/></pt>

diff --git a/dita/RTC-NG/API/rtc_api_overview.dita b/dita/RTC-NG/API/rtc_api_overview.dita
@@ -57,7 +57,7 @@
                     <stentry><xref keyref="setChannelProfile"/></stentry>
                     <stentry><ph conkeyref="setChannelProfile/shortdesc"/></stentry>
                 </strow>
-                <strow props="android ios mac cpp unreal bp unity">
+                <strow props="android ios mac cpp unreal unity">
                     <stentry><xref keyref="joinChannel1"/></stentry>
                     <stentry><ph conkeyref="joinChannel1/shortdesc"/></stentry>
                 </strow>
@@ -77,7 +77,7 @@
                     <stentry><xref keyref="updateChannelMediaOptionsEx"/></stentry>
                     <stentry><ph conkeyref="updateChannelMediaOptionsEx/shortdesc"/></stentry>
                 </strow>
-                <strow props="native unreal bp unity">
+                <strow props="native unreal unity">
                     <stentry><xref keyref="leaveChannel"/></stentry>
                     <stentry><ph conkeyref="leaveChannel/shortdesc"/></stentry>
                 </strow>
@@ -109,7 +109,7 @@
                     <stentry><xref keyref="renewToken"/></stentry>
                     <stentry><ph conkeyref="renewToken/shortdesc"/></stentry>
                 </strow>
-                <strow props="native unreal bp unity">
+                <strow props="native unreal unity">
                     <stentry><xref keyref="setClientRole1"/></stentry>
                     <stentry><ph conkeyref="setClientRole1/shortdesc"/></stentry>
                 </strow>
@@ -1013,23 +1013,23 @@
                 <stentry><xref keyref="setVideoDenoiserOptions"/></stentry>
                 <stentry><ph conkeyref="setVideoDenoiserOptions/shortdesc"/></stentry>
             </strow>
-                <strow props="native unity rn flutter unreal bp cs">
+                <strow props="android ios cpp unity rn flutter unreal bp cs">
                 <stentry><xref keyref="enableFaceDetection"/></stentry>
                 <stentry><ph conkeyref="enableFaceDetection/shortdesc"/></stentry>
             </strow>
                 <strow props="hide">
                 <stentry><xref keyref="onContentInspectResult"/></stentry>
                 <stentry><ph conkeyref="onContentInspectResult/shortdesc"/></stentry>
             </strow>
-                <strow props="native unity rn flutter unreal bp cs">
+                <strow props="android ios cpp unity rn flutter unreal bp cs">
                 <stentry><xref keyref="onFacePositionChanged"/></stentry>
                 <stentry><ph conkeyref="onFacePositionChanged/shortdesc"/></stentry>
             </strow>
                 <strow>
                 <stentry><xref keyref="onSnapshotTaken"/></stentry>
                 <stentry><ph conkeyref="onSnapshotTaken/shortdesc"/></stentry>
             </strow>
-            <strow props="native unity unreal bp">
+            <strow props="native unity unreal">
                 <stentry><xref keyref="addVideoWatermark1"/></stentry>
                 <stentry><ph conkeyref="addVideoWatermark1/shortdesc"/></stentry>
             </strow>
@@ -1070,7 +1070,7 @@
                 <stentry><xref keyref="setRemoteDefaultVideoStreamType"/></stentry>
                 <stentry><ph conkeyref="setRemoteDefaultVideoStreamType/shortdesc"/></stentry>
             </strow>
-            <strow props="native unreal bp unity">
+            <strow props="native unreal unity">
                 <stentry><xref keyref="enableDualStreamMode"/></stentry>
                 <stentry><ph conkeyref="enableDualStreamMode/shortdesc"/></stentry>
             </strow>
@@ -1082,7 +1082,7 @@
                 <stentry><xref keyref="enableDualStreamModeEx"/></stentry>
                 <stentry><ph conkeyref="enableDualStreamModeEx/shortdesc"/></stentry>
             </strow>
-            <strow props="native unreal bp unity">
+            <strow props="native unreal unity">
                 <stentry><xref keyref="setDualStreamMode"/></stentry>
                 <stentry><ph conkeyref="setDualStreamMode/shortdesc"/></stentry>
             </strow>
@@ -1307,7 +1307,7 @@
                     <stentry>方法/回调</stentry>
                     <stentry>描述</stentry>
                 </sthead>
-                <strow props="native unreal bp unity">
+                <strow props="native unreal unity">
                     <stentry><xref keyref="startAudioMixing"/></stentry>
                     <stentry><ph conkeyref="startAudioMixing/shortdesc"/></stentry>
                 </strow>
@@ -2003,7 +2003,7 @@
                     <stentry><xref keyref="createDataStream2"/></stentry>
                     <stentry><ph conkeyref="createDataStream2/shortdesc"/></stentry>
                 </strow>
-                <strow props="android cpp cs unity unreal bp">
+                <strow props="android cpp cs unity unreal">
                     <stentry><xref keyref="createDataStreamEx1"/></stentry>
                     <stentry><ph conkeyref="createDataStreamEx1/shortdesc"/></stentry>
                 </strow>
@@ -2131,7 +2131,51 @@
                     <stentry><xref keyref="stateChanged"/></stentry>
                     <stentry><ph conkeyref="stateChanged/shortdesc"/></stentry>
                 </strow>
-             </simpletable>
+                <strow>
+                    <stentry><xref keyref="followSystemPlaybackDevice"/></stentry>
+                    <stentry><ph conkeyref="followSystemPlaybackDevice/shortdesc"/></stentry>
+                </strow>
+                <strow>
+                    <stentry><xref keyref="followSystemRecordingDevice"/></stentry>
+                    <stentry><ph conkeyref="followSystemRecordingDevice/shortdesc"/></stentry>
+                </strow>
+                <strow>
+                    <stentry><xref keyref="startPlaybackDeviceTest"/></stentry>
+                    <stentry><ph conkeyref="startPlaybackDeviceTest/shortdesc"/></stentry>
+                </strow>
+                <strow>
+                    <stentry><xref keyref="stopPlaybackDeviceTest"/></stentry>
+                    <stentry><ph conkeyref="stopPlaybackDeviceTest/shortdesc"/></stentry>
+                </strow>
+                <strow>
+                    <stentry><xref keyref="startRecordingDeviceTest"/></stentry>
+                    <stentry><ph conkeyref="startRecordingDeviceTest/shortdesc"/></stentry>
+                </strow>
+                <strow>
+                    <stentry><xref keyref="stopRecordingDeviceTest"/></stentry>
+                    <stentry><ph conkeyref="stopRecordingDeviceTest/shortdesc"/></stentry>
+                </strow>
+                <strow>
+                    <stentry><xref keyref="startAudioDeviceLoopbackTest"/></stentry>
+                    <stentry><ph conkeyref="startAudioDeviceLoopbackTest/shortdesc"/></stentry>
+                </strow>
+                <strow>
+                    <stentry><xref keyref="stopAudioDeviceLoopbackTest"/></stentry>
+                    <stentry><ph conkeyref="stopAudioDeviceLoopbackTest/shortdesc"/></stentry>
+                </strow>
+                <strow>
+                    <stentry><xref keyref="getDefaultDevice_IAudioDeviceCollection"/></stentry>
+                    <stentry><ph conkeyref="getDefaultDevice_IAudioDeviceCollection/shortdesc"/></stentry>
+                </strow>
+                <strow>
+                    <stentry><xref keyref="queryCodecCapability"/></stentry>
+                    <stentry><ph conkeyref="queryCodecCapability/shortdesc"/></stentry>
+                </strow>
+                <strow>
+                    <stentry><xref keyref="setDevice_IVideoDeviceCollection"/></stentry>
+                    <stentry><ph conkeyref="setDevice_IVideoDeviceCollection/shortdesc"/></stentry>
+                </strow>
+            </simpletable>
         </section>
         <section id="mobile_camera_control" props="android ios cpp unreal bp unity flutter rn">
             <title>移动端摄像头管理</title>
@@ -2227,9 +2271,9 @@
                 </strow>
              </simpletable>
         </section>
-        <section id="pc_audio_device_management" props="cpp mac unreal bp unity flutter electron cs">
+        <section id="pc_audio_device_management" props="cpp unreal bp unity flutter electron cs">
             <title>桌面端音频设备管理</title>
-            <p props="cpp unreal bp unity flutter cs">该组方法仅适用于 Windows 和 macOS 平台。</p>
+            <p props="cpp unreal bp unity flutter">该组方法仅适用于 Windows 和 macOS 平台。</p>
             <simpletable>
                 <sthead>
                     <stentry>方法/回调</stentry>
@@ -2405,9 +2449,9 @@
                 </strow>
             </simpletable>
         </section>
-        <section id="pc_video_device_management" props="cpp mac unreal bp unity flutter electron cs" >
+        <section id="pc_video_device_management" props="cpp unreal bp unity flutter electron cs">
             <title>桌面端视频设备管理</title>
-            <p props="cpp unreal bp unity flutter cs">该组方法仅适用于 Windows 和 macOS 平台。</p>
+            <p props="cpp unreal bp unity flutter">该组方法仅适用于 Windows 和 macOS 平台。</p>
             <simpletable>
                 <sthead>
                     <stentry>方法/回调</stentry>
@@ -2539,11 +2583,11 @@
                     <stentry>方法/回调</stentry>
                     <stentry>描述</stentry>
                 </sthead>
-                <strow props="native unreal bp unity cs">
+                <strow props="native unreal unity cs">
                     <stentry><xref keyref="startEchoTest1"/></stentry>
                     <stentry><ph conkeyref="startEchoTest1/shortdesc"/></stentry>
                 </strow>
-                <strow props="native unreal bp unity cs">
+                <strow props="native unreal unity cs">
                     <stentry><xref keyref="startEchoTest2"/></stentry>
                     <stentry><ph conkeyref="startEchoTest2/shortdesc"/></stentry>
                 </strow>

diff --git a/dita/RTC-NG/API/rtc_api_overview_ng.dita b/dita/RTC-NG/API/rtc_api_overview_ng.dita
@@ -627,7 +627,7 @@
                 <stentry>描述</stentry>
             </sthead>
             </simpletable> </section>
-        <section id="section_ts1_shw_jqb">
+        <section props="cpp unreal bp unity flutter electron cs" id="section_ts1_shw_jqb">
             <title>视频设备管理</title>
             <simpletable id="simpletable_us1_shw_jqb">
             <sthead>

diff --git a/dita/RTC-NG/API/toc_common_device.dita b/dita/RTC-NG/API/toc_common_device.dita
@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
+<reference id="toc_audio_basic">
+    <title>通用设备管理</title>
+    <shortdesc id="short"/>
+    <refbody/>
+</reference>