Merge pull request #3423 from AgoraIO/4.2.3-bugfix-1123

4.2.3 bugfix 1123
AgoraIO · Nov 23, 2023 · 646e0f9 · 646e0f9
2 parents beecc58 + dd37eb3
commit 646e0f9
Show file tree

Hide file tree

Showing 19 changed files with 97 additions and 80 deletions.
diff --git a/dita/RTC-NG/API/api_irtcengine_enablelocalvideo.dita b/dita/RTC-NG/API/api_irtcengine_enablelocalvideo.dita
@@ -27,7 +27,8 @@
         <section id="detailed_desc">
             <title>详情</title>
             <p id="desc1">该方法禁用或重新启用本地视频采集，不影响接收远端视频。</p>
-            <p>调用 <xref keyref="enableVideo" /> 后，本地视频采集即默认开启。你可以调用 <xref keyref="enableLocalVideo" />(<codeph><ph keyref="false" /></codeph>) 关闭本地视频采集。关闭后如果想要重新开启，则可调用 <apiname keyref="enableLocalVideo" />(<codeph><ph keyref="true" /></codeph>)。</p>
+            <p>调用 <xref keyref="enableVideo" /> 后，本地视频采集即默认开启。</p>
+            <p>如果你在频道内调用 <xref keyref="enableLocalVideo" />(<codeph><ph keyref="false" /></codeph>) 关闭本地视频采集，也会同时停止在频道内发布视频流。如果想要重新开启，则可调用 <apiname keyref="enableLocalVideo" />(<codeph><ph keyref="true" /></codeph>)，然后调用 <xref keyref="updateChannelMediaOptions"/> 并设置 <parmname>options</parmname> 参数，将本地采集的视频流发布到频道中。</p>
             <p>成功禁用或启用本地视频采集后，远端会触发 <xref keyref="onRemoteVideoStateChanged" /> 回调。</p>
             <note type="attention">
             <ul>

diff --git a/dita/RTC-NG/API/api_irtcengine_preloadeffect.dita b/dita/RTC-NG/API/api_irtcengine_preloadeffect.dita
@@ -38,12 +38,10 @@
         </section>
         <section id="detailed_desc">
             <title>详情</title>
-            <p>为保证通信畅通，请注意控制预加载音效文件的大小，并在 <apiname keyref="joinChannel2" /> 前就使用该方法完成音效预加载。</p>
-            <note type="attention">
-            <ul>
-            <li>该方法不支持在线音频文件。</li>
-            <li id="audioFormats">该方法支持的音频文件格式见 <xref keyref="audio-format">RTC SDK 支持播放哪些格式的音频文件</xref>。</li>
-            </ul></note> </section>
+            <p>为保证通信畅通，请注意控制预加载音效文件的大小，并在 <apiname keyref="joinChannel2"/> 前就使用该方法完成音效预加载。</p>
+            <note type="note">
+            <p id="audioFormats">该方法支持的音频文件格式见 <xref keyref="audio-format">RTC SDK 支持播放哪些格式的音频文件</xref>。</p>
+            </note> </section>
         <section id="parameters">
             <title>参数</title>
             <parml>
@@ -54,7 +52,6 @@
             <plentry id="filePath">
                 <pt>filePath</pt>
                 <pd>文件路径：
-
                     <ul>
                     <li props="android flutter unity cpp unreal bp rn">Android: 文件路径，需精确到文件名及后缀。支持在线文件的 URL 地址，本地文件的 URI 地址、绝对路径或以 <codeph>/assets/</codeph> 开头的路径。通过绝对路径访问本地文件可能会遇到权限问题，建议使用 URI 地址访问本地文件。例如 <codeph>content://com.android.providers.media.documents/document/audio%3A14441</codeph>。</li>
                     <li props="cpp unreal bp flutter unity electron cs">Windows: 音频文件的绝对路径或 URL 地址，需精确到文件名及后缀。例如 <codeph>C:\music\audio.mp4</codeph>。</li>
@@ -76,4 +73,4 @@
             <li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
             </ul> </section>
     </refbody>
-</reference>
+</reference>
diff --git a/dita/RTC-NG/API/api_irtcengine_setaudioeffectpreset.dita b/dita/RTC-NG/API/api_irtcengine_setaudioeffectpreset.dita
@@ -27,7 +27,7 @@
         <section id="detailed_desc">
             <title>详情</title>
             <p>调用该方法可以为本地发流用户设置 SDK 预设的人声音效，且不会改变原声的性别特征。设置音效后，频道内所有用户都能听到该效果。</p>
-            <p props="hide">根据不同的场景，你可以为用户设置不同的音效，各音效的适用场景可参考《设置人声效果》。</p>
+            <p props="cn"><ph props="native">根据不同的场景，你可以为用户设置不同的音效，各音效的适用场景可参考<xref keyref="voice-changer-link"/>。</ph></p>
             <p>为获取更好的人声效果，建议你在调用该方法前将 <xref keyref="setAudioProfile" /> 的 <parmname>scenario</parmname> 设为 <apiname keyref="AUDIO_SCENARIO_GAME_STREAMING" />(3)。</p>
             <note type="attention">
             <ul>

diff --git a/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita b/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita
@@ -34,7 +34,7 @@
             <note type="attention" id="note">
             <ul>
             <li>只有直播场景中角色为主播的用户才能调用该方法。</li>
-            <li>请确保已开通旁路推流的功能，详见进阶功能《旁路推流》中的前提条件。</li>
+            <li>请确保已开通旁路推流的功能。</li>
             <li>首次调用该方法更新转码设置时，不会触发 <apiname keyref="onTranscodingUpdated" /> 回调。</li>
             <li>该方法需要在加入频道后调用。</li>
             </ul> </note> </section>

diff --git a/dita/RTC-NG/API/api_irtcengine_setvoiceconversionpreset.dita b/dita/RTC-NG/API/api_irtcengine_setvoiceconversionpreset.dita
@@ -26,7 +26,8 @@
         </section>
         <section id="detailed_desc">
             <title>详情</title>
-            <p><ph>调用该方法可以为本地发流用户设置 SDK 预设的变声效果。设置变声效果后，频道内所有用户都能听到该效果。根据不同的场景，你可以为用户设置不同的变声效果。</ph><ph props="native unreal bp">各变声效果的适用场景可参考《设置人声效果》。</ph></p>
+            <p><ph>调用该方法可以为本地发流用户设置 SDK 预设的变声效果。设置变声效果后，频道内所有用户都能听到该效果。根据不同的场景，你可以为用户设置不同的变声效果。</ph></p>
+            <p props="cn"><ph props="native">各变声效果的适用场景可参考<xref keyref="voice-changer-link"/>。</ph></p>
             <p>为获取更好的人声效果，建议你在调用该方法前将 <xref keyref="setAudioProfile"/> 的 <parmname>profile</parmname> 设为 <apiname keyref="AUDIO_PROFILE_MUSIC_HIGH_QUALITY"/>(4) 或 <apiname keyref="AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO"/>(5)，并将 <parmname>scenario</parmname> 设为 <apiname keyref="AUDIO_SCENARIO_GAME_STREAMING"/>(3)。</p>
             <note type="attention">
             <ul>

diff --git a/dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita b/dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita
@@ -46,7 +46,7 @@
             <ul>
             <li>该方法在加入频道前后均可调用。如需多次调用 <apiname keyref="startAudioMixing2"/>，请确保调用间隔大于 500 ms。</li>
             <li>如果本地音乐文件不存在、文件格式不支持或无法访问在线音乐文件 URL，则 SDK 会报告警告码 701。</li>
-            <li conkeyref="preloadEffect/audioFormats" />
+            <li>该方法支持的音频文件格式见 <xref keyref="audio-format">RTC SDK 支持播放哪些格式的音频文件</xref>。</li>
             <li conkeyref="startAudioMixing/principle" props="android cpp unreal bp unity"/>
             <li props="rn" id="principle">在 Android 平台上调用该方法时，请注意如下事项：
 

diff --git a/dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithtranscoding.dita b/dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithtranscoding.dita
@@ -64,7 +64,7 @@
             <li props="native unreal bp unity electron rn cs">0: 方法调用成功。</li>
             <li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph>
                 <ul>
-                <li>-2：url 为空或为长度为 0 的字符串。</li>
+                <li>-2：URL 或转码属性参数错误，请检查你的 URL 或参数设置。</li>
                 <li>-7：调用该方法前，未初始化 SDK。</li>
                 <li>-19：该旁路推流 URL 已在使用中，请使用其他旁路推流 URL。</li>
                 </ul> </li>

diff --git a/dita/RTC-NG/API/class_echotestconfiguration.dita b/dita/RTC-NG/API/class_echotestconfiguration.dita
@@ -159,7 +159,7 @@ class EchoTestConfiguration {
             <parml>
             <plentry>
                 <pt>view</pt>
-                <pd>用于渲染本地用户视频的视图。该参数仅适用于测试视频设备的场景，即该结构体中 <parmname>enableVideo</parmname> 为 <ph keyref="true"/>。</pd>
+                <pd>用于渲染本地用户视频的视图。该参数仅适用于测试视频设备的场景，请确保 <parmname>enableVideo</parmname> 为 <ph keyref="true"/>。</pd>
             </plentry>
             <plentry>
                 <pt>enableAudio</pt>

diff --git a/dita/RTC-NG/API/class_encryptionconfig.dita b/dita/RTC-NG/API/class_encryptionconfig.dita
@@ -82,11 +82,11 @@ struct FEncryptionConfig
 	FString encryptionKdfSalt;
 };</codeblock>
       <codeblock props="electron" outputclass="language-typescript">export class EncryptionConfig {
-  
+
   encryptionMode?: EncryptionMode;
-  
+
   encryptionKey?: string;
-  
+
   encryptionKdfSalt?: number[];
 }</codeblock>
       <codeblock props="unity cs" outputclass="language-csharp">public class EncryptionConfig
@@ -116,11 +116,11 @@ struct FEncryptionConfig
         }
     }</codeblock>
       <codeblock props="rn" outputclass="language-typescript">export class EncryptionConfig {
-  
+
   encryptionMode?: EncryptionMode;
-  
+
   encryptionKey?: string;
-  
+
   encryptionKdfSalt?: number[];
 }</codeblock>
       <codeblock props="flutter" outputclass="language-dart">class EncryptionConfig {
@@ -157,10 +157,11 @@ struct FEncryptionConfig
       <plentry>
         <pt>encryptionKdfSalt</pt>
         <pd>
-          <p><ph>盐，长度为 32 字节。建议你在服务端使用 OpenSSL 生成盐。</ph><ph props="native unreal bp">详见《媒体流加密》。</ph></p>
+          <p>盐，长度为 32 字节。建议你在服务端使用 OpenSSL 生成盐。</p>
+          <p props="native"><ph props="cn">如需在 App 中添加声网内置媒体流加密，详见<xref keyref="channel-encryption"/>。</ph></p>
           <note type="attention">只有在 <codeph><ph keyref="AES_128_GCM2" /></codeph> 或 <codeph><ph keyref="AES_256_GCM2" /></codeph> 加密模式下，该参数才生效。此时，需确保填入该参数的值不全为 <codeph>0</codeph>。</note>
         </pd>
       </plentry>
       </parml> </section>
   </refbody>
-</reference>
+</reference>
diff --git a/dita/RTC-NG/API/enum_audioprocessingchannels.dita b/dita/RTC-NG/API/enum_audioprocessingchannels.dita
@@ -16,7 +16,10 @@
             </ol></p>
             <note type="attention">
             <ul>
-            <li>立体声设置仅在媒体音量下生效。<ph props="android ios">详见<xref keyref="volume-type"/>。</ph><ph props="cpp unreal bp unity flutter rn">详见<xref keyref="volume-type-android"/>和<xref keyref="volume-type-ios"/>。</ph></li>
+            <li>
+                <p>立体声设置仅在媒体音量下生效。</p>
+                <p props="cn">如需了解媒体音量和通话音量的区别，<ph props="android ios cpp unreal bp flutter unity rn">详见<xref keyref="volume-type"/>。</ph></p>
+            </li>
             <li props="cpp unreal bp ios rn unity flutter">在 iOS 上，立体声对设备性能要求较高。仅支持在 iOS 14.0 及以上版本的如下设备中实现立体声：
 
 

diff --git a/dita/RTC-NG/config/keys-rtc-ng-links-android.ditamap b/dita/RTC-NG/config/keys-rtc-ng-links-android.ditamap
@@ -5,7 +5,7 @@
     <topichead navtitle="Agora">
         <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/android/advanced-features/voice-changer" scope="external" format="html"/>
-        <keydef keys="volume-type" href="https://doc.shengwang.cn/doc/rtc/android/basic-features/audio-profile#%E9%9F%B3%E9%87%8F%E7%B1%BB%E5%9E%8B" scope="external" format="html">
+        <keydef keys="volume-type" href="https://doc.shengwang.cn/faq/integration-issues/system-volume" scope="external" format="html">
             <topicmeta>
                 <keywords>
                     <keyword>音量类型</keyword>
@@ -47,6 +47,20 @@
                 </keywords>
             </topicmeta>
         </keydef>
+        <keydef keys="voice-changer-link" href="https://doc.shengwang.cn/doc/rtc/android/advanced-features/voice-changer" scope="external" format="html">
+            <topicmeta>
+                <keywords>
+                    <keyword>设置人声效果</keyword>
+                </keywords>
+            </topicmeta>
+        </keydef>
+        <keydef keys="channel-encryption" href="https://doc.shengwang.cn/doc/rtc/android/advanced-features/channel-encryption" scope="external" format="html">
+            <topicmeta>
+                <keywords>
+                    <keyword>媒体流加密</keyword>
+                </keywords>
+            </topicmeta>
+        </keydef>
     </topichead>
     <topichead navtitle="External">
         <keydef keys="filePath-link" href="https://developer.android.google.cn/guide/topics/media/media-formats?hl=zh-cn" scope="external" format="html"/>

diff --git a/dita/RTC-NG/config/keys-rtc-ng-links-cpp.ditamap b/dita/RTC-NG/config/keys-rtc-ng-links-cpp.ditamap
@@ -6,17 +6,10 @@
         <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/windows/advanced-features/audio-route" scope="external" format="html"/>
         <keydef keys="guide-voice-changer" href="https://doc.shengwang.cn/doc/rtc/windows/advanced-features/voice-changer" scope="external" format="html"/>
-        <keydef keys="volume-type-ios" href="https://doc.shengwang.cn/doc/rtc/ios/basic-features/audio-profile#%E9%9F%B3%E9%87%8F%E7%B1%BB%E5%9E%8B" scope="external" format="html">
+        <keydef keys="volume-type" href="https://doc.shengwang.cn/faq/integration-issues/system-volume" scope="external" format="html">
             <topicmeta>
                 <keywords>
-                    <keyword>音量类型（iOS）</keyword>
-                </keywords>
-            </topicmeta>
-        </keydef>
-        <keydef keys="volume-type-android" href="https://doc.shengwang.cn/doc/rtc/android/basic-features/audio-profile#%E9%9F%B3%E9%87%8F%E7%B1%BB%E5%9E%8B" scope="external" format="html">
-            <topicmeta>
-                <keywords>
-                    <keyword>音量类型（Android）</keyword>
+                    <keyword>音量类型</keyword>
                 </keywords>
             </topicmeta>
         </keydef>
@@ -55,6 +48,20 @@
                 </keywords>
             </topicmeta>
         </keydef>
+        <keydef keys="voice-changer-link" href="https://doc.shengwang.cn/doc/rtc/windows/advanced-features/voice-changer" scope="external" format="html">
+            <topicmeta>
+                <keywords>
+                    <keyword>设置人声效果</keyword>
+                </keywords>
+            </topicmeta>
+        </keydef>
+        <keydef keys="channel-encryption" href="https://doc.shengwang.cn/doc/rtc/windows/advanced-features/channel-encryption" scope="external" format="html">
+            <topicmeta>
+                <keywords>
+                    <keyword>媒体流加密</keyword>
+                </keywords>
+            </topicmeta>
+        </keydef>
     </topichead>
         <topichead navtitle="External">
         <keydef keys="filePath-link" href="https://docs.microsoft.com/zh-cn/windows/win32/medfound/supported-media-formats-in-media-foundation" scope="external" format="html"/>

diff --git a/dita/RTC-NG/config/keys-rtc-ng-links-flutter.ditamap b/dita/RTC-NG/config/keys-rtc-ng-links-flutter.ditamap
@@ -5,17 +5,10 @@
     <topichead navtitle="Agora">
         <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/android/advanced-features/voice-changer" scope="external" format="html"/>
-        <keydef keys="volume-type-ios" href="https://doc.shengwang.cn/doc/rtc/ios/basic-features/audio-profile#%E9%9F%B3%E9%87%8F%E7%B1%BB%E5%9E%8B" scope="external" format="html">
+        <keydef keys="volume-type" href="https://doc.shengwang.cn/faq/integration-issues/system-volume" scope="external" format="html">
             <topicmeta>
                 <keywords>
-                    <keyword>音量类型（iOS）</keyword>
-                </keywords>
-            </topicmeta>
-        </keydef>
-        <keydef keys="volume-type-android" href="https://doc.shengwang.cn/doc/rtc/android/basic-features/audio-profile#%E9%9F%B3%E9%87%8F%E7%B1%BB%E5%9E%8B" scope="external" format="html">
-            <topicmeta>
-                <keywords>
-                    <keyword>音量类型（Android）</keyword>
+                    <keyword>音量类型</keyword>
                 </keywords>
             </topicmeta>
         </keydef>

diff --git a/dita/RTC-NG/config/keys-rtc-ng-links-ios.ditamap b/dita/RTC-NG/config/keys-rtc-ng-links-ios.ditamap
@@ -5,7 +5,7 @@
     <topichead navtitle="Agora">
         <keydef keys="guide-audio-route" href="https://doc.shengwang.cn/doc/rtc/ios/advanced-features/audio-route" scope="external" format="html"/>
         <keydef keys="guide-voice-changer" href="https://doc.shengwang.cn/doc/rtc/ios/advanced-features/voice-changer" scope="external" format="html"/>
-        <keydef keys="volume-type" href="https://doc.shengwang.cn/doc/rtc/ios/basic-features/audio-profile#%E9%9F%B3%E9%87%8F%E7%B1%BB%E5%9E%8B" scope="external" format="html">
+        <keydef keys="volume-type" href="https://doc.shengwang.cn/faq/integration-issues/system-volume" scope="external" format="html">
             <topicmeta>
                 <keywords>
                     <keyword>音量类型</keyword>
@@ -47,6 +47,20 @@
                 </keywords>
             </topicmeta>
         </keydef>
+        <keydef keys="voice-changer-link" href="https://doc.shengwang.cn/doc/rtc/ios/advanced-features/voice-changer" scope="external" format="html">
+            <topicmeta>
+                <keywords>
+                    <keyword>设置人声效果</keyword>
+                </keywords>
+            </topicmeta>
+        </keydef>
+        <keydef keys="channel-encryption" href="https://doc.shengwang.cn/doc/rtc/ios/advanced-features/channel-encryption" scope="external" format="html">
+            <topicmeta>
+                <keywords>
+                    <keyword>媒体流加密</keyword>
+                </keywords>
+            </topicmeta>
+        </keydef>
     </topichead>
     <topichead navtitle="External">
         <keydef keys="filePath-link" href="https://developer.apple.com/library/archive/documentation/AudioVideo/Conceptual/MultimediaPG/UsingAudio/UsingAudio.html#//apple_ref/doc/uid/TP40009767-CH2-SW28" scope="external" format="html"/>

diff --git a/dita/RTC-NG/config/keys-rtc-ng-links-macos.ditamap b/dita/RTC-NG/config/keys-rtc-ng-links-macos.ditamap
@@ -31,6 +31,20 @@
                 </keywords>
             </topicmeta>
         </keydef>
+        <keydef keys="voice-changer-link" href="https://doc.shengwang.cn/doc/rtc/macos/advanced-features/voice-changer" scope="external" format="html">
+            <topicmeta>
+                <keywords>
+                    <keyword>设置人声效果</keyword>
+                </keywords>
+            </topicmeta>
+        </keydef>
+        <keydef keys="channel-encryption" href="https://doc.shengwang.cn/doc/rtc/macos/advanced-features/channel-encryption" scope="external" format="html">
+            <topicmeta>
+                <keywords>
+                    <keyword>媒体流加密</keyword>
+                </keywords>
+            </topicmeta>
+        </keydef>
     </topichead>
     <topichead navtitle="External">
         <keydef keys="filePath-link" href="https://developer.apple.com/library/archive/documentation/MusicAudio/Conceptual/CoreAudioOverview/SupportedAudioFormatsMacOSX/SupportedAudioFormatsMacOSX.html" scope="external" format="html"/>