Merge pull request #3676 from AgoraIO/release/rtc-ng/4.4.0

Release/rtc ng/4.4.0

dita/RTC-NG/API/api_imusiccontentcenter_destroy.dita

@@ -25,17 +25,17 @@
             <codeblock props="electron" outputclass="language-typescript"/>
             <codeblock props="unity cs" outputclass="language-csharp"/>
             <codeblock props="rn" outputclass="language-typescript"/>
-           <codeblock props="flutter" outputclass="language-dart"/> 
+           <codeblock props="flutter" outputclass="language-dart"/>
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="detailed_desc">
             <title>详情</title>
             <dl outputclass="since">
-            <dlentry props="native">
-                <dt>自从</dt>
-                <dd>v4.1.0</dd>
-            </dlentry>
-            </dl>
+                <dlentry props="native">
+                    <dt>自从</dt>
+                    <dd>v4.1.0</dd>
+                </dlentry>
+                </dl>
             <p>该方法需要在 <apiname keyref="IRtcEngine"/> 的 <xref keyref="release"/> 方法前调用。</p>
         </section>
     </refbody>

dita/RTC-NG/API/api_imusiccontentcenter_destroymusicplayer.dita

@@ -0,0 +1,61 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
+<reference id="api_imusiccontentcenter_destroymusicplayer">
+    <title><ph keyref="destroyMusicPlayer"/></title>
+    <shortdesc id="short"><ph id="shortdesc">销毁音乐播放器对象。</ph></shortdesc>
+    <prolog>
+        <metadata>
+            <keywords>
+                <indexterm keyref="destroyMusicPlayer"/>
+            </keywords>
+        </metadata>
+    </prolog>
+    <refbody>
+        <section id="prototype">
+            <p outputclass="codeblock">
+            <codeblock props="android" outputclass="language-java">public abstract int destroyMusicPlayer(IAgoraMusicPlayer player);</codeblock>
+            <codeblock props="ios mac" outputclass="language-objectivec">- (NSInteger)destroyMusicPlayer:(id&lt;AgoraMusicPlayerProtocol>)musicPlayer;</codeblock>
+            <codeblock props="cpp unreal" outputclass="language-cpp">virtual int destroyMusicPlayer(agora_refptr&lt;IMusicPlayer> music_player) = 0;</codeblock>
+            <codeblock props="bp" outputclass="language-cpp"/>
+            <codeblock props="electron" outputclass="language-typescript"/>
+            <codeblock props="unity cs" outputclass="language-csharp"/>
+            <codeblock props="rn" outputclass="language-typescript"/>
+            <codeblock props="flutter" outputclass="language-dart"/> </p>
+        </section>
+        <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
+            <dl outputclass="since">
+            <dlentry props="native">
+                <dt>自从</dt>
+                <dd>v4.4.0</dd>
+            </dlentry>
+            </dl>
+            <p>当你不再需要使用音乐播放器时，你可以调用该方法来销毁音乐播放器对象。销毁之后如果需要重新使用音乐播放器，需要调用 <xref keyref="createMusicPlayer"/> 重新创建一个音乐播放器对象。</p>
+        </section>
+        <section id="timing" deliveryTarget="details">
+            <title>调用时机</title>
+            <p>该方法在加入频道前后均可调用，但请确保在 <apiname keyref="IRtcEngine"/> 的 <xref keyref="release"/> 方法前调用。</p>
+        </section>
+        <section id="restriction" deliveryTarget="details">
+            <title>调用限制</title>
+            <p>无。</p>
+        </section>
+        <section id="parameters" deliveryTarget="details">
+            <title>参数</title>
+            <parml>
+            <plentry>
+                <pt props="android">player</pt>
+                <pt props="apple">musicPlayer</pt>
+                <pt props="cpp">music_player</pt>
+                <pd props="apple android"><xref keyref="IMusicPlayer"/> 对象。</pd>
+                <pd props="cpp">指向 <xref keyref="IMusicPlayer"/> 对象的指针。</pd>
+            </plentry>
+            </parml> </section>
+        <section id="return_values">
+            <title><ph keyref="return-section-title"/></title>
+            <p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
+            <ul props="native unreal bp electron unity rn cs">
+                <li>0: 方法调用成功。</li>
+                <li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
+                </ul> </section>
+        </refbody>
+</reference>

dita/RTC-NG/API/api_imusiccontentcenter_getlyric.dita

@@ -41,7 +41,7 @@
                 <pd/>
             </plentry>
             <plentry>
-                <pt>LyricType</pt>
+                <pt>lyricType</pt>
                 <pd>歌词类型：
 
                     <ul>

dita/RTC-NG/API/api_imusicplayer_destroy.dita

@@ -20,17 +20,24 @@
             <codeblock props="electron" outputclass="language-typescript"/>
             <codeblock props="unity cs" outputclass="language-csharp"/>
             <codeblock props="rn" outputclass="language-typescript"/>
-           <codeblock props="flutter" outputclass="language-dart"/> 
+           <codeblock props="flutter" outputclass="language-dart"/>
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="detailed_desc">
             <title>详情</title>
-            <dl outputclass="since">
+
+        <dl outputclass="deprecated">
+                <dlentry>
+                    <dt>弃用：</dt>
+                    <dd>该方法自 v4.4.0 起废弃，请改用 <xref keyref="destroyMusicPlayer"/>。</dd>
+                </dlentry>
+                </dl>
+        <dl outputclass="since">
             <dlentry props="native">
                 <dt>自从</dt>
                 <dd>v4.1.0</dd>
             </dlentry>
-            </dl>
+        </dl>
         </section>
         <section id="return_values">
             <title>返回值</title>

dita/RTC-NG/API/api_imusicplayer_setplaymode.dita

@@ -0,0 +1,65 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
+<reference id="api_imusicplayer_setplaymode">
+    <title><ph keyref="setPlayMode"/></title>
+    <shortdesc id="short"><ph id="shortdesc">设置音乐资源的播放模式。</ph></shortdesc>
+    <prolog>
+        <metadata>
+            <keywords>
+                <indexterm keyref="setPlayMode"/>
+            </keywords>
+        </metadata>
+    </prolog>
+    <refbody>
+        <section id="prototype">
+            <p outputclass="codeblock">
+            <codeblock props="android" outputclass="language-java">int setPlayMode(MusicPlayMode mode);</codeblock>
+            <codeblock props="ios mac" outputclass="language-objectivec">- (NSInteger)setPlayMode:(AgoraMusicPlayMode)mode NS_SWIFT_NAME(setPlayMode(mode:));</codeblock>
+            <codeblock props="cpp unreal" outputclass="language-cpp">virtual int setPlayMode(MusicPlayMode mode) = 0;</codeblock>
+            <codeblock props="bp" outputclass="language-cpp"/>
+            <codeblock props="electron" outputclass="language-typescript"/>
+            <codeblock props="unity cs" outputclass="language-csharp"/>
+            <codeblock props="rn" outputclass="language-typescript"/>
+            <codeblock props="flutter" outputclass="language-dart"/> </p>
+        </section>
+        <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
+            <dl outputclass="since">
+            <dlentry props="native">
+                <dt>自从</dt>
+                <dd>v4.4.0</dd>
+            </dlentry>
+            </dl>
+            <p>你可以调用该方法来设置启用原唱、伴奏或导唱。如不调用该方法进行设置，则默认播放伴奏；如果音乐资源没有伴奏，则播放原唱。</p>
+            <note type="attention">你可以通过 <xref keyref="onMusicCollectionResult"/> 回调获取音乐资源的详细信息，并可通过其中的 <parmname props="android">list</parmname><parmname props="cpp apple framework">result</parmname> 参数得知需播放的版权音乐所支持的播放类型。</note>
+        </section>
+        <section id="scenario" deliveryTarget="details">
+            <title>适用场景</title>
+            <p>在线 K 歌、秀场等娱乐场景下，如果你需要播放声网内容中心提供的版权音乐，你可以调用该方法来设置播放模式。</p>
+        </section>
+        <section id="timing" deliveryTarget="details">
+            <title>调用时机</title>
+            <p>该方法需要在 <xref keyref="createMusicPlayer"/> 之后调用。</p>
+        </section>
+        <section id="restriction" deliveryTarget="details">
+            <title>调用限制</title>
+            <p>无。</p>
+        </section>
+        <section id="parameters" deliveryTarget="details">
+            <title>参数</title>
+            <parml>
+            <plentry>
+                <pt>mode</pt>
+                <pd>播放模式，详见 <xref keyref="MusicPlayMode"/>。</pd>
+            </plentry>
+            </parml> </section>
+        <section id="return_values">
+            <title><ph keyref="return-section-title"/></title>
+            <p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
+            <ul props="native unreal bp electron unity rn cs">
+                <li>0: 方法调用成功。</li>
+                <li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph>
+            <ul>
+                <li>-2: 参数设置错误，请重新设置参数。</li>
+            </ul></li></ul> </section>
+        </refbody>
+</reference>

dita/RTC-NG/API/api_irtcengine_enableextension.dita

@@ -59,7 +59,7 @@
         </section>
         <section id="related" deliveryTarget="details">
             <title>相关回调</title>
-            <p>频道内调用该方法成功时会触发插件启用回调 <xref keyref="onExtensionStarted"/> 或插件禁用回调 <xref keyref="onExtensionStopped"/>。</p>
+            <p>频道内调用该方法成功时会触发插件启用回调 <xref keyref="onExtensionStartedWithContext"/> 或插件禁用回调 <xref keyref="onExtensionStoppedWithContext"/>。</p>
         </section>
         <section id="parameters" deliveryTarget="details">
             <title>参数</title>

dita/RTC-NG/API/api_irtcengine_enableinstantmediarendering.dita

@@ -32,13 +32,8 @@
                 <dd>v4.1.1</dd>
             </dlentry>
             </dl>
-            <p>成功调用该方法后，SDK 会开启加速出图和出声模式，可加快用户加入频道后的首帧出图与出声速度。
-                <note type="attention">
-                <ul>
-                    <li>一旦开启快速渲染功能，只能通过调用 <xref keyref="release"/> 方法销毁 <apiname keyref="IRtcEngine"/> 对象来取消。</li>
-                    <li>在该模式下，SDK 启用声网自定义加密算法来缩短建立传输链路的耗时，安全性相对于标准 DTLS (Datagram Transport Layer Security) 有所降低。如果业务场景对安全标准要求较高，请谨慎调用该方法。</li>
-                </ul>
-                </note></p>
+            <p>成功调用该方法后，SDK 会开启加速出图和出声模式，可加快用户加入频道后的首帧出图与出声速度。</p>
+            <note type="attention">一旦开启快速渲染功能，只能通过调用 <xref keyref="release"/> 方法销毁 <apiname keyref="IRtcEngine"/> 对象来取消。</note>
         </section>
         <section id="scenario">
             <title>适用场景</title>

dita/RTC-NG/API/api_irtcengine_enablevoiceaituner.dita

@@ -0,0 +1,72 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
+<reference id="api_irtcengine_enablevoiceaituner">
+    <title><ph keyref="enableVoiceAITuner"/></title>
+    <shortdesc id="short"><ph id="shortdesc">开启或关闭 AI 调音器功能。</ph></shortdesc>
+    <prolog>
+        <metadata>
+            <keywords>
+                <indexterm keyref="enableVoiceAITuner"/>
+            </keywords>
+        </metadata>
+    </prolog>
+    <refbody>
+        <section id="prototype">
+            <p outputclass="codeblock">
+            <codeblock props="android" outputclass="language-java">public abstract int enableVoiceAITuner(boolean enabled, Constants.VOICE_AI_TUNER_TYPE type);</codeblock>
+            <codeblock props="ios mac" outputclass="language-objectivec">- (int)enableVoiceAITuner:(bool)enabled type:(AgoraVoiceAITunerType)type NS_SWIFT_NAME(enableVoiceAITuner(_:type:));</codeblock>
+            <codeblock props="cpp unreal" outputclass="language-cpp">virtual int enableVoiceAITuner(bool enabled, VOICE_AI_TUNER_TYPE type) = 0;</codeblock>
+            <codeblock props="bp" outputclass="language-cpp"/>
+            <codeblock props="electron" outputclass="language-typescript"/>
+            <codeblock props="unity cs" outputclass="language-csharp"/>
+            <codeblock props="rn" outputclass="language-typescript"/>
+            <codeblock props="flutter" outputclass="language-dart"/> </p>
+        </section>
+        <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
+            <dl outputclass="since">
+            <dlentry props="native">
+                <dt>自从</dt>
+                <dd>v4.4.0</dd>
+            </dlentry>
+            </dl>
+            <p>AI 调音器功能支持美化音质，调整音色风格。</p>
+        </section>
+        <section id="scenario" deliveryTarget="details">
+            <title>适用场景</title>
+            <p>在线 K 歌、在线播客、秀场直播等对音质有较高要求的社交娱乐场景。</p>
+        </section>
+        <section id="timing" deliveryTarget="details">
+            <title>调用时机</title>
+            <p>加入频道前后均可调用。</p>
+        </section>        
+        <section id="restriction" deliveryTarget="details">
+            <title>调用限制</title>
+            <p>无。</p>
+        </section>
+        <section id="parameters" deliveryTarget="details">
+            <title>参数</title>
+            <parml>
+            <plentry>
+                <pt>enabled</pt>
+                <pd>是否开启 AI 调音器功能：
+                    <ul>
+                        <li><codeph><ph keyref="true"/></codeph>：开启 AI 调音器功能。</li>
+                        <li><codeph><ph keyref="false"/></codeph>：（默认）关闭 AI 调音器功能。</li>
+                    </ul>
+                </pd>
+            </plentry>
+            <plentry>
+                <pt>type</pt>
+                <pd>AI 调音器音效类型，详见 <xref keyref="VOICE_AI_TUNER_TYPE"/>。
+                </pd>
+            </plentry>
+            </parml> </section>
+        <section id="return_values">
+            <title><ph keyref="return-section-title"/></title>
+            <p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
+            <ul props="native unreal bp electron unity rn cs">
+                <li>0: 方法调用成功。</li>
+                <li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
+                </ul> </section>
+        </refbody>
+</reference>

dita/RTC-NG/API/api_irtcengine_pauseallchannelmediarelay.dita

@@ -34,7 +34,9 @@
             <p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
             <ul props="native unreal bp electron unity rn cs">
             <li>0: 方法调用成功。</li>
-            <li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
+            <li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph>
+            <ul><li>-5: 方法调用被拒绝。当前没有正在进行的跨频道媒体流转发。</li></ul>
+            </li>
             </ul> </section>
     </refbody>
 </reference>

dita/RTC-NG/API/api_irtcengine_resumeallchannelmediarelay.dita

@@ -34,7 +34,9 @@
             <p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
             <ul>
             <li props="native unreal bp electron unity rn cs">0：方法调用成功。</li>
-            <li>&lt; 0：方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
+            <li>&lt; 0：方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph>
+            <ul><li>-5: 方法调用被拒绝。当前没有暂停的跨频道媒体流转发。</li></ul>
+            </li>
             </ul> </section>
     </refbody>
 </reference>