Merge branch 'master' into 4.4.0-unreal

AgoraIO · Aug 15, 2024 · 3b447f8 · 3b447f8
2 parents d40e744 + c93adfe
commit 3b447f8
Show file tree

Hide file tree

Showing 65 changed files with 5,690 additions and 9,994 deletions.
diff --git a/dita/RTC-NG/API/api_imusiccontentcenter_destroymusicplayer.dita b/dita/RTC-NG/API/api_imusiccontentcenter_destroymusicplayer.dita
@@ -17,10 +17,10 @@
             <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>
-            <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>
+            <codeblock props="electron" outputclass="language-typescript">abstract destroyMusicPlayer(musicPlayer: IMusicPlayer): number;</codeblock>
+            <codeblock props="unity cs" outputclass="language-csharp">public abstract int DestroyMusicPlayer(IMusicPlayer music_player);</codeblock>
+            <codeblock props="rn" outputclass="language-typescript">abstract destroyMusicPlayer(musicPlayer: IMusicPlayer): number;</codeblock>
+            <codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; destroyMusicPlayer(MusicPlayer musicPlayer);</codeblock> </p>
         </section>
         <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
             <dl outputclass="since">
@@ -44,9 +44,9 @@
             <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>
+                <pt props="apple rn electron flutter">musicPlayer</pt>
+                <pt props="cpp unreal unity cs bp">music_player</pt>
+                <pd props="apple android framework"><xref keyref="IMusicPlayer"/> 对象。</pd>
                 <pd props="cpp">指向 <xref keyref="IMusicPlayer"/> 对象的指针。</pd>
             </plentry>
             </parml> </section>

diff --git a/dita/RTC-NG/API/api_imusicplayer_setplaymode.dita b/dita/RTC-NG/API/api_imusicplayer_setplaymode.dita
@@ -17,10 +17,10 @@
             <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>
-            <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>
+            <codeblock props="electron" outputclass="language-typescript">abstract setPlayMode(mode: MusicPlayMode): number;</codeblock>
+            <codeblock props="unity cs" outputclass="language-csharp">public abstract int SetPlayMode(MusicPlayMode mode);</codeblock>
+            <codeblock props="rn" outputclass="language-typescript">abstract setPlayMode(mode: MusicPlayMode): number;</codeblock>
+            <codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; setPlayMode(MusicPlayMode mode);</codeblock> </p>
         </section>
         <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
             <dl outputclass="since">

diff --git a/dita/RTC-NG/API/api_irtcengine_enablevoiceaituner.dita b/dita/RTC-NG/API/api_irtcengine_enablevoiceaituner.dita
@@ -17,10 +17,11 @@
             <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>
-            <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>
+            <codeblock props="electron" outputclass="language-typescript">abstract enableVoiceAITuner(enabled: boolean, type: VoiceAiTunerType): number;</codeblock>
+            <codeblock props="unity cs" outputclass="language-csharp">public abstract int EnableVoiceAITuner(bool enabled, VOICE_AI_TUNER_TYPE type);</codeblock>
+            <codeblock props="rn" outputclass="language-typescript">abstract enableVoiceAITuner(enabled: boolean, type: VoiceAiTunerType): number;</codeblock>
+            <codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; enableVoiceAITuner(
+    {required bool enabled, required VoiceAiTunerType type});</codeblock> </p>
         </section>
         <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
             <dl outputclass="since">

diff --git a/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita b/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita
@@ -39,8 +39,9 @@
             <p>初始化本地用户视图后，你可以调用该方法更新本地用户视图的渲染和镜像模式。该方法只影响本地用户看到的视频画面，不影响本地视频的发布。</p>
             </section>
             <section id="timing" deliveryTarget="details">
-                <title><ph props="native unreal bp electron rn flutter">调用时机</ph></title>
-                <ul props="native unreal bp electron rn flutter"><li>请在调用 <xref keyref="setupLocalVideo" /> 方法初始化本地视图后，调用该方法。</li>
+                <title>调用时机</title>
+                <ul>
+                    <li props="native unreal bp electron unity flutter">请在调用 <xref keyref="setupLocalVideo" /> 方法初始化本地视图后，调用该方法。</li>
                     <li>你可以在通话中多次调用该方法，多次更新本地用户视图的显示模式。</li></ul>
             </section>        
             <section id="restriction" deliveryTarget="details">

diff --git a/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita b/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita
@@ -37,7 +37,7 @@
             <li props="flutter" id="render">在 Flutter 中你不需要主动调用该方法，请使用 <xref keyref="AgoraVideoView"/> 渲染本地和远端视图。</li>
              <li props="unity cs">如果你想要在原生窗口上渲染图像，请调用此方法；如果你仅需在 Unity 项目内渲染图像，可直接通过 <xref keyref="VideoSurface"/> 类来实现。</li>
             <li props="native unreal bp unity rn flutter cs">如果你希望在通话中更新远端用户视图的渲染或镜像模式，请使用 <xref keyref="setRemoteRenderMode2"/> 方法。</li>
-            <li props="android cpp apple framework">如果你使用了录制服务，录制服务会作为一个哑客户端加入频道，因此也会触发 <xref keyref="onUserJoined"/> 回调。由于录制服务不会发送视频流，App 无需为它绑定视图。如果 App 无法识别哑客户端，可以在收到 <xref keyref="onFirstRemoteVideoDecoded"/> 回调时再绑定远端用户视图。</li>
+            <li props="android cpp apple framework">当使用录制服务时，由于它不会发送视频流，App 无需为它绑定视图。如果 App 无法识别录制服务，可以在收到 <xref keyref="onFirstRemoteVideoDecoded"/> 回调时再绑定远端用户视图。</li>
             <li props="electron">如果想要停止渲染视图，需要将 <parmname>view</parmname> 设为 <ph keyref="NULL" /> 后再次调用该方法，以停止渲染并清理渲染缓存。</li>
             </ul> </note> </section>
         <section id="parameters">

diff --git a/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita b/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita
@@ -33,7 +33,7 @@
                 <li props="cpp unreal bp unity flutter cs">该方法仅适用于 Android 和 iOS 平台。</li>
                 <li props="cpp unreal bp ios unity rn flutter cs">屏幕共享流的计费标准以 <apiname keyref="ScreenVideoParameters"/> 中的 <parmname>dimensions</parmname> 值为准：<ul>
                     <li>当你未传值时，以 1280 × 720 计费。</li>
-                    <li>当你传值时，以你传入的值计费。计费示例请参考<xref keyref="bill-example"/>。</li></ul></li></ul>
+                    <li>当你传值时，以你传入的值计费。</li></ul></li></ul>
             </note>
         </section>
         <section id="scenario" deliveryTarget="details">

diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiosubscribestatechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiosubscribestatechanged.dita
@@ -80,32 +80,21 @@ elapseSinceLastState:(int)elapseSinceLastState;</codeblock>
                 <pd props="ios mac cpp unreal bp unity flutter electron rn cs">之前的订阅状态，详见 <xref keyref="STREAM_SUBSCRIBE_STATE" />。</pd>
                 <pd props="android hmos">之前的订阅状态。
 
-
-
                     <ul>
                     <li><ph keyref="SUB_STATE_IDLE" /> (0): 加入频道后的初始订阅状态。</li>
                     <li><ph keyref="SUB_STATE_NO_SUBSCRIBED" /> (1): 订阅失败。可能是因为：
-
-
-
                         <ul>
                         <li>远端用户：
-
-
-
                             <ul>
-                            <li>调用 <xref keyref="muteLocalAudioStream" />(<codeph><ph keyref="true" /></codeph>) 或 <xref keyref="muteLocalVideoStream" />(<codeph><ph keyref="true" /></codeph>) 停止发送本地媒体流。</li>
-                            <li>调用 <xref keyref="disableAudio" /> 或 <xref keyref="disableVideo" /> 关闭本地音频或视频模块。</li>
-                            <li>调用 <xref keyref="enableLocalAudio" />(<ph keyref="false" />) 或 <xref keyref="enableLocalVideo" />(<ph keyref="false" />) 关闭本地音频或视频采集。</li>
+                            <li>调用 <xref keyref="muteLocalAudioStream" />(<codeph><ph keyref="true" /></codeph>) 停止发送本地音频流。</li>
+                            <li>调用 <xref keyref="disableAudio" /> 关闭本地音频模块。</li>
+                            <li>调用 <xref keyref="enableLocalAudio" />(<ph keyref="false" />) 关闭本地音频采集。</li>
                             <li>用户角色为观众。</li>
                             </ul></li>
-                        <li>本地用户调用以下方法停止接收远端媒体流：
-
-
-
+                        <li>本地用户调用以下方法停止接收远端音频流：
                             <ul id="ul_mjk_gyk_p4b">
-                            <li>调用 <xref keyref="muteRemoteAudioStream" />(<ph keyref="true" />)、 <xref keyref="muteAllRemoteAudioStreams" />(<ph keyref="true" />) 停止接收远端音频流。</li>
-                            <li>调用 <xref keyref="muteRemoteVideoStream" />(<ph keyref="true" />)、 <xref keyref="muteAllRemoteVideoStreams" />(<ph keyref="true" />) 停止接收远端视频流。</li>
+                                <li>调用 <xref keyref="joinChannel2"/> 或 <xref keyref="updateChannelMediaOptions"/> 时设置 <parmname>autoSubscribeAudio</parmname> 为 <codeph><ph keyref="false" /></codeph>，不自动订阅任何音频流。</li>
+                                <li>调用 <xref keyref="muteRemoteAudioStream" />(<ph keyref="true" />)、 <xref keyref="muteAllRemoteAudioStreams" />(<ph keyref="true" />) 停止接收远端音频流。</li>
                             </ul></li>
                         </ul></li>
                     <li><ph keyref="SUB_STATE_SUBSCRIBING" /> (2): 正在订阅。</li>
@@ -116,33 +105,21 @@ elapseSinceLastState:(int)elapseSinceLastState;</codeblock>
                 <pt>newState</pt>
                 <pd props="ios mac cpp unreal bp unity flutter electron rn cs">当前的订阅状态，详见 <apiname keyref="STREAM_SUBSCRIBE_STATE" />。</pd>
                 <pd props="android hmos">当前的订阅状态。
-
-
-
                     <ul>
                     <li><ph keyref="SUB_STATE_IDLE" /> (0): 加入频道后的初始订阅状态。</li>
                     <li><ph keyref="SUB_STATE_NO_SUBSCRIBED" /> (1): 订阅失败。可能是因为：
-
-
-
                         <ul>
                         <li>远端用户：
-
-
-
                             <ul>
-                            <li>调用 <xref keyref="muteLocalAudioStream" />(<codeph><ph keyref="true" /></codeph>) 或 <xref keyref="muteLocalVideoStream" />(<codeph><ph keyref="true" /></codeph>) 停止发送本地媒体流。</li>
-                            <li>调用 <xref keyref="disableAudio" /> 或 <xref keyref="disableVideo" /> 关闭本地音频或视频模块。</li>
-                            <li>调用 <xref keyref="enableLocalAudio" />(<codeph><ph keyref="false" /></codeph>) 或 <xref keyref="enableLocalVideo" />(<codeph><ph keyref="false" /></codeph>) 关闭本地音频或视频采集。</li>
+                            <li>调用 <xref keyref="muteLocalAudioStream" />(<codeph><ph keyref="true" /></codeph>) 停止发送本地音频流。</li>
+                            <li>调用 <xref keyref="disableAudio" /> 关闭本地音频模块。</li>
+                            <li>调用 <xref keyref="enableLocalAudio" />(<codeph><ph keyref="false" /></codeph>) 关闭本地音频采集。</li>
                             <li>用户角色为观众。</li>
                             </ul></li>
-                        <li>本地用户调用以下方法停止接收远端媒体流：
-
-
-
+                        <li>本地用户调用以下方法停止接收远端音频流：
                             <ul>
-                            <li>调用 <xref keyref="muteRemoteAudioStream" />(<codeph><ph keyref="true" /></codeph>)、 <xref keyref="muteAllRemoteAudioStreams" />(<codeph><ph keyref="true" /></codeph>) 停止接收远端音频流。</li>
-                            <li>调用 <xref keyref="muteRemoteVideoStream" />(<codeph><ph keyref="true" /></codeph>)、 <xref keyref="muteAllRemoteVideoStreams" />(<codeph><ph keyref="true" /></codeph>) 停止接收远端视频流。</li>
+                                <li>调用 <xref keyref="joinChannel2"/> 或 <xref keyref="updateChannelMediaOptions"/> 时设置 <parmname>autoSubscribeAudio</parmname> 为 <codeph><ph keyref="false" /></codeph>，不自动订阅任何音频流。</li>
+                                <li>调用 <xref keyref="muteRemoteAudioStream" />(<codeph><ph keyref="true" /></codeph>)、 <xref keyref="muteAllRemoteAudioStreams" />(<codeph><ph keyref="true" /></codeph>) 停止接收远端音频流。</li>
                             </ul></li>
                         </ul></li>
                     <li><ph keyref="SUB_STATE_SUBSCRIBING" /> (2): 正在订阅。</li>

diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onextensionerrorwithcontext.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onextensionerrorwithcontext.dita
@@ -25,22 +25,19 @@
   }</codeblock>
          <codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintNativeEvent, Category = &quot;Agora|Event&quot;)
 	void OnExtensionErrorWithContext(const FExtensionContext&amp; context, int error, const FString&amp; message);</codeblock>
-            <codeblock props="electron" outputclass="language-typescript">onExtensionError?(
-    provider: string,
-    extension: string,
+            <codeblock props="electron" outputclass="language-typescript">onExtensionErrorWithContext?(
+    context: ExtensionContext,
     error: number,
     message: string
   ): void;</codeblock>
-            <codeblock props="unity cs" outputclass="language-csharp">public virtual void OnExtensionError(string provider, string extension, int error, string message) { }</codeblock>
-            <codeblock props="rn" outputclass="language-typescript">onExtensionError?(
-    provider: string,
-    extension: string,
+            <codeblock props="unity cs" outputclass="language-csharp">public virtual void OnExtensionErrorWithContext(ExtensionContext context, int error, string message){}</codeblock>
+            <codeblock props="rn" outputclass="language-typescript">onExtensionErrorWithContext?(
+    context: ExtensionContext,
     error: number,
     message: string
   ): void;</codeblock>
-            <codeblock props="flutter" outputclass="language-dart">final void Function(
-          String provider, String extension, int error, String message)?
-      onExtensionError;</codeblock>
+            <codeblock props="flutter" outputclass="language-dart">final void Function(ExtensionContext context, int error, String message)?
+    onExtensionErrorWithContext;</codeblock>
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="detailed_desc">
@@ -50,18 +47,10 @@
             <title>参数</title>
             <parml>
             <plentry id="context">
-                <pt props="cpp apple">context</pt>
+                <pt props="cpp apple framework">context</pt>
                 <pt props="android">extContext</pt>
                 <pd>插件上下文信息，详见 <xref keyref="ExtensionContext"/>。</pd>
             </plentry>
-            <plentry conkeyref="setExtensionProperty/vendor" props="framework">
-                <pt />
-                <pd />
-            </plentry>
-            <plentry props="framework">
-                <pt>extension</pt>
-                <pd>插件的名称。</pd>
-            </plentry>
             <plentry>
                 <pt>error</pt>
                 <pd>错误码。详见插件服务商提供的插件文档。</pd>

diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onextensioneventwithcontext.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onextensioneventwithcontext.dita
@@ -25,22 +25,19 @@
   }</codeblock>
          <codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintNativeEvent, Category = &quot;Agora|Event&quot;)
 	void OnExtensionEventWithContext(const FExtensionContext&amp; context, const FString&amp; key, const FString&amp; value);</codeblock>
-            <codeblock props="electron" outputclass="language-typescript">  onExtensionEvent?(
-    provider: string,
-    extension: string,
+            <codeblock props="electron" outputclass="language-typescript">onExtensionEventWithContext?(
+    context: ExtensionContext,
     key: string,
     value: string
   ): void;</codeblock>
-            <codeblock props="unity cs" outputclass="language-csharp">public virtual void OnExtensionEvent(string provider, string extension, string key, string value) { }</codeblock>
-            <codeblock props="rn" outputclass="language-typescript">  onExtensionEvent?(
-    provider: string,
-    extension: string,
+            <codeblock props="unity cs" outputclass="language-csharp">public virtual void OnExtensionEventWithContext(ExtensionContext context, string key, string value){}</codeblock>
+            <codeblock props="rn" outputclass="language-typescript">onExtensionEventWithContext?(
+    context: ExtensionContext,
     key: string,
     value: string
   ): void;</codeblock>
-            <codeblock props="flutter" outputclass="language-dart">final void Function(
-          String provider, String extName, String key, String value)?
-      onExtensionEvent;</codeblock>
+            <codeblock props="flutter" outputclass="language-dart">final void Function(ExtensionContext context, String key, String value)?
+    onExtensionEventWithContext;</codeblock>
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="detailed_desc">
@@ -53,15 +50,6 @@
                 <pt />
                 <pd />
             </plentry>
-            <plentry conkeyref="setExtensionProperty/vendor" props="framework">
-                <pt />
-                <pd />
-            </plentry>
-            <plentry id="extension">
-                <pt props="unreal bp unity electron rn cs">extension</pt>
-                <pt props="flutter">extName</pt>
-                <pd>插件名称。</pd>
-            </plentry>
             <plentry conkeyref="setExtensionProperty/key">
                 <pt />
                 <pd />