Merge pull request #3742 from AgoraIO/4.4.0-framework

4.4.0 framework
AgoraIO · Aug 15, 2024 · b50d5e0 · b50d5e0
2 parents 9e88c86 + bb37e02
commit b50d5e0
Show file tree

Hide file tree

Showing 28 changed files with 2,069 additions and 4,189 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 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 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 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/callback_irtcengineeventhandler_onextensionerrorwithcontext.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onextensionerrorwithcontext.dita
@@ -24,22 +24,19 @@
     (void)message;
   }</codeblock>
          <codeblock props="bp" outputclass="language-cpp">DECLARE_DYNAMIC_MULTICAST_DELEGATE_FourParams(FOnExtensionError, FString, provider, FString, extension, int, error, FString, 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">
@@ -49,18 +46,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
@@ -24,22 +24,19 @@
     (void)value;
   }</codeblock>
          <codeblock props="bp" outputclass="language-cpp">DECLARE_DYNAMIC_MULTICAST_DELEGATE_FourParams(FOnExtensionEvent, FString, provider, FString, extension, FString, key, FString, 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">
@@ -52,15 +49,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 />

diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onextensionstartedwithcontext.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onextensionstartedwithcontext.dita
@@ -20,10 +20,10 @@
     (void)context;
   }</codeblock>
          <codeblock props="bp" outputclass="language-cpp">DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FOnExtensionStarted, FString, provider, FString, extension);</codeblock>
-            <codeblock props="electron" outputclass="language-typescript">  onExtensionStarted?(provider: string, extension: string): void;</codeblock>
-            <codeblock props="unity cs" outputclass="language-csharp">public virtual void OnExtensionStarted(string provider, string extension) { }</codeblock>
-            <codeblock props="rn" outputclass="language-typescript">  onExtensionStarted?(provider: string, extension: string): void;</codeblock>
-            <codeblock props="flutter" outputclass="language-dart">final void Function(String provider, String extName)? onExtensionStarted;</codeblock>
+            <codeblock props="electron" outputclass="language-typescript">onExtensionStartedWithContext?(context: ExtensionContext): void;</codeblock>
+            <codeblock props="unity cs" outputclass="language-csharp">public virtual void OnExtensionEventWithContext(ExtensionContext context, string key, string value){ }</codeblock>
+            <codeblock props="rn" outputclass="language-typescript">onExtensionStartedWithContext?(context: ExtensionContext): void;</codeblock>
+            <codeblock props="flutter" outputclass="language-dart">final void Function(ExtensionContext context)? onExtensionStartedWithContext;</codeblock>
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="detailed_desc">
@@ -36,15 +36,6 @@
                 <pt />
                 <pd />
             </plentry>
-            <plentry conkeyref="setExtensionProperty/vendor" props="framework">
-                <pt />
-                <pd />
-            </plentry>
-            <plentry props="framework">
-                <pt props="unreal bp unity electron rn cs">extension</pt>
-                <pt props="flutter">extName</pt>
-                <pd>插件名称。</pd>
-            </plentry>
             </parml> </section>
     </refbody>
 </reference>
diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onextensionstoppedwithcontext.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onextensionstoppedwithcontext.dita
@@ -20,10 +20,10 @@
     (void)context;
   }</codeblock>
          <codeblock props="bp" outputclass="language-cpp">DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FOnExtensionStopped, FString, provider, FString, extension);</codeblock>
-            <codeblock props="electron" outputclass="language-typescript">  onExtensionStopped?(provider: string, extension: string): void;</codeblock>
-            <codeblock props="unity cs" outputclass="language-csharp">public virtual void OnExtensionStopped(string provider, string extension) { }</codeblock>
-            <codeblock props="rn" outputclass="language-typescript">  onExtensionStopped?(provider: string, extension: string): void;</codeblock>
-            <codeblock props="flutter" outputclass="language-dart">final void Function(String provider, String extName)? onExtensionStopped;</codeblock>
+            <codeblock props="electron" outputclass="language-typescript">onExtensionStoppedWithContext?(context: ExtensionContext): void;</codeblock>
+            <codeblock props="unity cs" outputclass="language-csharp">public virtual void OnExtensionStoppedWithContext(ExtensionContext context){ }</codeblock>
+            <codeblock props="rn" outputclass="language-typescript">onExtensionStoppedWithContext?(context: ExtensionContext): void;</codeblock>
+            <codeblock props="flutter" outputclass="language-dart">final void Function(ExtensionContext context)? onExtensionStoppedWithContext;</codeblock>
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="detailed_desc">
@@ -36,14 +36,6 @@
                 <pt />
                 <pd />
             </plentry>
-            <plentry conkeyref="setExtensionProperty/vendor" props="framework">
-                <pt />
-                <pd />
-            </plentry>
-            <plentry conkeyref="onExtensionEventWithContext/extension" props="framework">
-                <pt />
-                <pd />
-            </plentry>
             </parml> </section>
     </refbody>
 </reference>
diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onjoinchannelsuccess.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onjoinchannelsuccess.dita
@@ -37,7 +37,8 @@
         </section>
         <section id="timing" deliveryTarget="details">
             <title>触发时机</title>
-            <p props="android cpp cs apple unity unreal">当你调用 <xref keyref="joinChannel1"/>、<xref keyref="joinChannel2"/>、<xref keyref="joinChannelWithUserAccount1"/>、<xref keyref="joinChannelWithUserAccount2"/>、 <xref keyref="joinChannelEx"/> 或 <xref keyref="joinChannelWithUserAccountEx"/> 方法成功加入频道后，SDK 会触发该回调。</p>
+            <p props="android cpp cs apple unreal">当你调用 <xref keyref="joinChannel1"/>、<xref keyref="joinChannel2"/>、<xref keyref="joinChannelWithUserAccount1"/>、<xref keyref="joinChannelWithUserAccount2"/>、 <xref keyref="joinChannelEx"/> 或 <xref keyref="joinChannelWithUserAccountEx"/> 方法成功加入频道后，SDK 会触发该回调。</p>
+            <p props="unity">当你调用 <xref keyref="joinChannel1"/>、<xref keyref="joinChannel2"/>、<xref keyref="joinChannelWithUserAccount1"/>、<xref keyref="joinChannelWithUserAccount2"/>、 <xref keyref="joinChannelEx"/> 方法成功加入频道后，SDK 会触发该回调。</p>
             <p props="bp electron flutter rn">当你调用 <xref keyref="joinChannel2"/>、<xref keyref="joinChannelWithUserAccount2"/>、 <xref keyref="joinChannelEx"/> 或 <xref keyref="joinChannelWithUserAccountEx"/> 方法成功加入频道后，SDK 会触发该回调。</p>
             <p props="hmos">当你调用 <xref keyref="joinChannel1"/>、<xref keyref="joinChannel2"/> 或 <xref keyref="joinChannelEx"/> 方法成功加入频道后，SDK 会触发该回调。</p>
         </section>
@@ -70,4 +71,4 @@
             </plentry>
             </parml> </section>
     </refbody>
-</reference>
+</reference>