Merge branch 'master' of github.com:AgoraIO/agora_doc_source

AgoraIO · Apr 24, 2024 · f558bbb · f558bbb
2 parents b51a0dd + 9ddcd96
commit f558bbb
Show file tree

Hide file tree

Showing 21 changed files with 568 additions and 176 deletions.
diff --git a/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita b/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita
@@ -49,7 +49,7 @@
             <li>视频直播：扬声器</li>
             </ul></p>
             <p>调用该 API 可以改变上述默认音频路由。成功改变音频路由后，SDK 会触发 <xref keyref="onAudioRoutingChanged"/> 回调。</p>
-            <note>
+            <note props="android ios unity rn flutter">
             <p>当手机插入外接设备，如蓝牙设备或耳机时，系统的音频路由会发生改变。详细的路由变化规律请参考 <xref keyref="guide-audio-route">音频路由</xref>。</p>
             </note> </section>
         <section id="parameters">

diff --git a/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita b/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita
@@ -24,7 +24,7 @@
             <codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; setEnableSpeakerphone(bool speakerOn);</codeblock></p> </section>
         <section id="detailed_desc">
             <title>详情</title>
-            <p>如果 SDK 默认的音频路由（见<xref keyref="guide-audio-route">音频路由</xref>）或 <xref keyref="setDefaultAudioRouteToSpeakerphone" /> 的设置无法满足你的需求，你可以调用 <xref keyref="setEnableSpeakerphone" /> 切换当前的音频路由。成功改变音频路由后，SDK 会触发 <xref keyref="onAudioRoutingChanged" /> 回调。</p>
+            <p>如果 SDK 默认的音频路由<ph props="android ios unity rn flutter">（见<xref keyref="guide-audio-route">音频路由</xref>）</ph>或 <xref keyref="setDefaultAudioRouteToSpeakerphone" /> 的设置无法满足你的需求，你可以调用 <xref keyref="setEnableSpeakerphone" /> 切换当前的音频路由。成功改变音频路由后，SDK 会触发 <xref keyref="onAudioRoutingChanged" /> 回调。</ph>
             <p>该方法只设置用户在当前频道内使用的音频路由，不会影响 SDK 默认的音频路由。如果用户离开当前频道并加入新的频道，则用户还是会使用 SDK 默认的音频路由。</p>
             <note type="attention">
             <ul>

diff --git a/dita/RTC-NG/RTC_NG_API_Unity.ditamap b/dita/RTC-NG/RTC_NG_API_Unity.ditamap
@@ -686,6 +686,7 @@
                 <topicref keyref="getRecordingDefaultDevice2" toc="no"/>
                 <topicref keyref="getRecordingDevice" toc="no"/>
                 <topicref keyref="getRecordingDeviceInfo" toc="no"/>
+                <topicref keyref="getRecordingDeviceInfo2" toc="no"/>
                 <topicref keyref="getRecordingDeviceMute" toc="no" props="hide"/>
                 <topicref keyref="getRecordingDeviceVolume" toc="no"/>
                 <topicref keyref="setLoopbackDevice" toc="no"/>

diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-flutter.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-flutter.ditamap
@@ -1464,27 +1464,13 @@
                     </keywords>
                 </topicmeta>
             </keydef>
-            <keydef keys="startChannelMediaRelayEx" href="../API/api_irtcengineex_startchannelmediarelayex.dita">
-                <topicmeta>
-                    <keywords>
-                        <keyword>startChannelMediaRelayEx</keyword>
-                    </keywords>
-                </topicmeta>
-            </keydef>
             <keydef keys="startOrUpdateChannelMediaRelayEx" href="../API/api_irtcengineex_startorupdatechannelmediarelayex.dita">
                 <topicmeta>
                     <keywords>
                         <keyword>startOrUpdateChannelMediaRelayEx</keyword>
                     </keywords>
                 </topicmeta>
             </keydef>
-            <keydef keys="updateChannelMediaRelayEx" href="../API/api_irtcengineex_updatechannelmediarelayex.dita">
-                <topicmeta>
-                    <keywords>
-                        <keyword>updateChannelMediaRelayEx</keyword>
-                    </keywords>
-                </topicmeta>
-            </keydef>
             <keydef keys="pauseAllChannelMediaRelayEx" href="../API/api_irtcengineex_pauseallchannelmediarelayex.dita">
                 <topicmeta>
                     <keywords>
@@ -2214,27 +2200,13 @@
                     </keywords>
                 </topicmeta>
             </keydef>
-            <keydef keys="startChannelMediaRelay" href="../API/api_irtcengine_startchannelmediarelay.dita">
-                <topicmeta>
-                    <keywords>
-                        <keyword>startChannelMediaRelay</keyword>
-                    </keywords>
-                </topicmeta>
-            </keydef>
             <keydef keys="startOrUpdateChannelMediaRelay" href="../API/api_irtcengine_startorupdatechannelmediarelay.dita">
                 <topicmeta>
                     <keywords>
                         <keyword>startOrUpdateChannelMediaRelay</keyword>
                     </keywords>
                 </topicmeta>
             </keydef>
-            <keydef keys="updateChannelMediaRelay" href="../API/api_irtcengine_updatechannelmediarelay.dita">
-                <topicmeta>
-                    <keywords>
-                        <keyword>updateChannelMediaRelay</keyword>
-                    </keywords>
-                </topicmeta>
-            </keydef>
             <keydef keys="stopChannelMediaRelay" href="../API/api_irtcengine_stopchannelmediarelay.dita">
                 <topicmeta>
                     <keywords>
@@ -4494,13 +4466,6 @@
                     </keywords>
                 </topicmeta>
             </keydef>
-            <keydef keys="onChannelMediaRelayEvent" href="../API/callback_irtcengineeventhandler_onchannelmediarelayevent.dita">
-                <topicmeta>
-                    <keywords>
-                        <keyword>onChannelMediaRelayEvent</keyword>
-                    </keywords>
-                </topicmeta>
-            </keydef>
         </topichead>
         <topichead navtitle="音量提示事件">
             <keydef keys="onAudioVolumeIndication" href="../API/callback_irtcengineeventhandler_onaudiovolumeindication.dita">

diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap
@@ -1518,27 +1518,13 @@
                     </keywords>
                 </topicmeta>
             </keydef>
-            <keydef keys="startChannelMediaRelayEx" href="../API/api_irtcengineex_startchannelmediarelayex.dita">
-                <topicmeta>
-                    <keywords>
-                        <keyword>startChannelMediaRelayEx</keyword>
-                    </keywords>
-                </topicmeta>
-            </keydef>
             <keydef keys="startOrUpdateChannelMediaRelayEx" href="../API/api_irtcengineex_startorupdatechannelmediarelayex.dita">
                 <topicmeta>
                     <keywords>
                         <keyword>startOrUpdateChannelMediaRelayEx</keyword>
                     </keywords>
                 </topicmeta>
             </keydef>
-            <keydef keys="updateChannelMediaRelayEx" href="../API/api_irtcengineex_updatechannelmediarelayex.dita">
-                <topicmeta>
-                    <keywords>
-                        <keyword>updateChannelMediaRelayEx</keyword>
-                    </keywords>
-                </topicmeta>
-            </keydef>
             <keydef keys="pauseAllChannelMediaRelayEx" href="../API/api_irtcengineex_pauseallchannelmediarelayex.dita">
                 <topicmeta>
                     <keywords>
@@ -2466,27 +2452,13 @@
                     </keywords>
                 </topicmeta>
             </keydef>
-            <keydef keys="startChannelMediaRelay" href="../API/api_irtcengine_startchannelmediarelay.dita">
-                <topicmeta>
-                    <keywords>
-                        <keyword>startChannelMediaRelay</keyword>
-                    </keywords>
-                </topicmeta>
-            </keydef>
             <keydef keys="startOrUpdateChannelMediaRelay" href="../API/api_irtcengine_startorupdatechannelmediarelay.dita">
                 <topicmeta>
                     <keywords>
                         <keyword>startOrUpdateChannelMediaRelay</keyword>
                     </keywords>
                 </topicmeta>
             </keydef>
-            <keydef keys="updateChannelMediaRelay" href="../API/api_irtcengine_updatechannelmediarelay.dita">
-                <topicmeta>
-                    <keywords>
-                        <keyword>updateChannelMediaRelay</keyword>
-                    </keywords>
-                </topicmeta>
-            </keydef>
             <keydef keys="stopChannelMediaRelay" href="../API/api_irtcengine_stopchannelmediarelay.dita">
                 <topicmeta>
                     <keywords>
@@ -4410,13 +4382,6 @@
                     </keywords>
                 </topicmeta>
             </keydef>
-            <keydef keys="onChannelMediaRelayEvent" href="../API/callback_irtcengineeventhandler_onchannelmediarelayevent.dita">
-                <topicmeta>
-                    <keywords>
-                        <keyword>onChannelMediaRelayEvent</keyword>
-                    </keywords>
-                </topicmeta>
-            </keydef>
         </topichead>
         <topichead navtitle="音量提示事件">
             <keydef keys="onAudioVolumeIndication" href="../API/callback_irtcengineeventhandler_onaudiovolumeindication.dita">

diff --git a/dita/RTC-NG/config/keys-rtc-ng-links-rn.ditamap b/dita/RTC-NG/config/keys-rtc-ng-links-rn.ditamap
@@ -4,7 +4,7 @@
     <title>Keys RTC NG Windows Links</title>
     <topichead navtitle="Agora">
         <keydef keys="guide-cdn-streaming" href="https://docs.agora.io/cn/live-streaming-premium-4.x/cdn_streaming_apple_ng?platform=iOS" scope="external" format="html"/>
-        <keydef keys="guide-audio-route" href="https://doc.shengwang.cn/doc/rtc/rn/advanced-features/audio-route" scope="external" format="html"/>
+        <keydef keys="guide-audio-route" href="https://doc.shengwang.cn/doc/rtc/android/advanced-features/audio-route" scope="external" format="html"/>
         <keydef keys="guide-voice-changer" href="https://doc.shengwang.cn/doc/rtc/rn/advanced-features/voice-changer" scope="external" format="html"/>
         <keydef keys="volume-type" href="https://doc.shengwang.cn/faq/integration-issues/system-volume" scope="external" format="html">
             <topicmeta>

diff --git a/dita/RTC-NG/config/keys-rtc-ng-links-unity.ditamap b/dita/RTC-NG/config/keys-rtc-ng-links-unity.ditamap
@@ -4,6 +4,7 @@
     <title>Keys RTC NG Unity Links</title>
     <topichead navtitle="Agora">
         <keydef keys="guide-lastmile-quality" href="https://docs.agora.io/cn/video-call-4.x/lastmile_quality_unity_ng?platform=Unity" scope="external" format="html"/>
+        <keydef keys="guide-audio-route" href="https://doc.shengwang.cn/doc/rtc/android/advanced-features/audio-route" scope="external" format="html"/>
         <keydef keys="guide-token" href="https://doc.shengwang.cn/doc/rtc/unity/basic-features/token-authentication" scope="external" format="html">
         <topicmeta>
                 <keywords>

diff --git a/dita/RTC-NG/release/release_notes.dita b/dita/RTC-NG/release/release_notes.dita
@@ -99,8 +99,10 @@
                     <li props="android"><ph><b>摄像头采集改进</b></ph>
                         <p>优化了摄像头采集的视频处理机制，减少噪点、提高亮度、改善色彩，使采集到的图形更加清晰、明亮和真实。</p>
                     </li>
-                    <li props="mac"><ph><b>获取音频设备类型</b></ph>
-                        <p>该版本在 <codeph><xref keyref="AgoraRtcDeviceInfo"/></codeph> 中新增 <codeph>deviceTypeName</codeph> 成员，用于获取音频设备的类型，如 built-in、USB、HDMI 等。</p>
+                    <li props="mac unity flutter electron"><ph><b>获取音频设备类型</b></ph><ph props="unity rn flutter electron">（macOS）</ph>
+                        <p props="mac">该版本在 <xref keyref="AgoraRtcDeviceInfo"/> 中新增 <codeph>deviceTypeName</codeph> 成员，用于获取音频设备的类型，如 built-in、USB、HDMI 等。</p>
+                        <p props="flutter electron">该版本在 <xref keyref="AudioDeviceInfo"/> 中新增 <codeph>deviceTypeName</codeph> 成员，用于获取音频设备的类型，如 built-in、USB、HDMI 等。</p>
+                        <p props="unity">该版本新增 <xref keyref="getPlaybackDefaultDevice2"/>、<xref keyref="getRecordingDefaultDevice2"/>、<xref keyref="getPlaybackDeviceInfo2"/>、<xref keyref="getRecordingDeviceInfo2"/> 方法，分别用于获取音频播放、采集设备的设备信息及类型。</p>
                     </li>
                     <li><ph><b>虚拟背景算法优化</b></ph>
                         <p>为了提高纯色背景下开启虚拟背景时人像分割的精确度和稳定性，该版本优化了绿幕分割算法：
@@ -181,10 +183,11 @@
                         </ul></li>
                     <li props="android"><codeph><apiname keyref="ENCRYPTION_ERROR_DATASTREAM_DECRYPTION_FAILURE"/></codeph></li>
                     <li props="android"><codeph><apiname keyref="ENCRYPTION_ERROR_DATASTREAM_ENCRYPTION_FAILURE"/></codeph></li>
-                    <li props="unity electron flutter"><xref keyref="getDevice2_IAudioDeviceCollection"/><ph> (macOS)</ph></li>
-                    <li props="unity electron flutter"><xref keyref="getDefaultDevice2_IAudioDeviceCollection"/><ph> (macOS)</ph></li>
-                    <li props="unity electron flutter"><xref keyref="getPlaybackDeviceInfo2"/><ph> (macOS)</ph></li>
-                    <li props="unity electron flutter"><xref keyref="getRecordingDeviceInfo2"/><ph> (macOS)</ph></li>
+                    <li props="unity"><xref keyref="getPlaybackDefaultDevice2"/><ph> (macOS)</ph></li>
+                    <li props="unity"><xref keyref="getRecordingDefaultDevice2"/><ph> (macOS)</ph></li>
+                    <li props="unity"><xref keyref="getPlaybackDeviceInfo2"/><ph> (macOS)</ph></li>
+                    <li props="unity"><xref keyref="getRecordingDeviceInfo2"/><ph> (macOS)</ph></li>
+                    <li props="electron flutter"><xref keyref="AudioDeviceInfo"/> 中新增 <codeph>deviceTypeName</codeph> (macOS)</li>
                     <li props="mac"><xref keyref="AgoraRtcDeviceInfo"/> 新增 <codeph>deviceTypeName</codeph></li>
                     <li><xref keyref="RemoteAudioStats"/> 新增 <codeph>e2eDelay</codeph></li>
                     <li props="apple cpp framework"><xref keyref="ERROR_CODE_TYPE"/> 新增 <codeph><apiname keyref="ERR_DATASTREAM_DECRYPTION_FAILED"/></codeph></li>

diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablecameracenterstage.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablecameracenterstage.dita
@@ -2,7 +2,7 @@
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
 <reference id="api_irtcengine_enablecameracenterstage">
     <title><ph keyref="enableCameraCenterStage"/></title>
-    <shortdesc id="short"><ph id="shortdesc">Enables or disables the portrait lock feature.</ph></shortdesc>
+    <shortdesc id="short"><ph id="shortdesc">Enables or disables portrait center stage.</ph></shortdesc>
     <prolog>
         <metadata>
             <keywords>
@@ -29,14 +29,14 @@
                 <dd>v4.3.1</dd>
             </dlentry>
             </dl>
-            <p>The portrait lock feature is off by default. You need to call this method to turn it on. If you need to disable this feature, you need to call this method again and set <parmname>enabled</parmname> to <codeph><ph keyref="false"/></codeph>.</p>
-            <note type="attention" props="cpp flutter unreal bp unity">This method is for Windows and macOS only.</note>
+            <p>The portrait center stage feature is off by default. You need to call this method to turn it on. If you need to disable this feature, you need to call this method again and set <parmname>enabled</parmname> to <codeph><ph keyref="false"/></codeph>.</p>
+            <note type="attention" props="cpp flutter unreal bp unity">This method is for iOS and macOS only.</note>
             <note type="attention" props="rn">This method applies to iOS only.</note>
             <note type="attention" props="electron">This method applies to macOS only.</note>
         </section>
         <section id="scenario" deliveryTarget="details">
             <title>Applicable scenarios</title>
-            <p>The portrait lock feature can be widely used in scenarios such as online meetings, shows, online education, etc. The host can use this feature to ensure that they are always in the center of the screen, whether they move or not, in order to achieve a good display effect.</p>
+            <p>The portrait center stage feature can be widely used in scenarios such as online meetings, shows, online education, etc. The host can use this feature to ensure that they are always in the center of the screen, whether they move or not, in order to achieve a good display effect.</p>
         </section>
         <section id="timing" deliveryTarget="details">
             <title>Call timing</title>
@@ -50,10 +50,10 @@
                     <li>11-inch iPad Pro (3rd generation)</li>
                     <li>iPad (9th generation)</li>
                     <li>iPad mini (6th generation)</li>
-                    <li>iPad Air 3 (4th generation)</li></ul></li>
+                    <li>iPad Air (5th generation)</li></ul></li>
                 <li>2020 M1 MacBook Pro 13-inch + iPhone 11 (using iPhone as external camera for the MacBook)</li>
             </ul></p>
-            <p>Agora recommends that you call <xref keyref="isCameraCenterStageSupported"/> to check whether the current device supports portrait lock before enabling this feature.</p>
+            <p>Agora recommends that you call <xref keyref="isCameraCenterStageSupported"/> to check whether the current device supports portrait center stage before enabling this feature.</p>
         </section>
         <section id="related" deliveryTarget="details">
             <title>Related callbacks</title>
@@ -64,9 +64,9 @@
             <parml>
             <plentry>
                 <pt>enabled</pt>
-                <pd>Whether to enable the portrait lock feature:<ul>
-                    <li><codeph><ph keyref="true"/></codeph>: Enable portrait lock.</li>
-                    <li><codeph><ph keyref="false"/></codeph>: Disable portrait lock.</li>
+                <pd>Whether to enable the portrait center stage:<ul>
+                    <li><codeph><ph keyref="true"/></codeph>: Enable portrait center stage.</li>
+                    <li><codeph><ph keyref="false"/></codeph>: Disable portrait center stage.</li>
                     </ul></pd>
             </plentry>
             </parml> </section>

diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_iscameracenterstagesupported.dita b/en-US/dita/RTC-NG/API/api_irtcengine_iscameracenterstagesupported.dita
@@ -2,7 +2,7 @@
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
 <reference id="api_irtcengine_iscameracenterstagesupported">
     <title><ph keyref="isCameraCenterStageSupported"/></title>
-    <shortdesc id="short"><ph id="shortdesc">Check if the camera supports the portrait lock feature.</ph></shortdesc>
+    <shortdesc id="short"><ph id="shortdesc">Check if the camera supports portrait center stage.</ph></shortdesc>
     <prolog>
         <metadata>
             <keywords>
@@ -29,10 +29,10 @@
                 <dd>v4.3.1</dd>
             </dlentry>
             </dl>
-            <note type="attention" props="cpp flutter unreal bp unity">This method is for Windows and macOS only.</note>
+            <note type="attention" props="cpp flutter unreal bp unity">This method is for iOS and macOS only.</note>
             <note type="attention" props="rn">This method applies to iOS only.</note>
             <note type="attention" props="electron">This method applies to macOS only.</note>
-            <p>Before calling <xref keyref="enableCameraCenterStage"/> to enable portrait lock, it is recommended to call this method to check if the current device supports portrait lock.</p>
+            <p>Before calling <xref keyref="enableCameraCenterStage"/> to enable portrait center stage, it is recommended to call this method to check if the current device supports the feature.</p>
         </section>
         <section id="timing" deliveryTarget="details">
             <title>Call timing</title>
@@ -45,8 +45,8 @@
         <section id="return_values">
             <title><ph keyref="return-section-title"/></title>
             <ul>
-            <li><codeph><ph keyref="true"/></codeph>: The current camera supports the portrait lock feature.</li>
-            <li><codeph><ph keyref="false"/></codeph>: The current camera supports the portrait lock feature.</li>
+            <li><codeph><ph keyref="true"/></codeph>: The current camera supports the portrait center stage.</li>
+            <li><codeph><ph keyref="false"/></codeph>: The current camera supports the portrait center stage.</li>
             </ul>  </section>
         </refbody>
 </reference>