Merge pull request #3743 from AgoraIO/auto/sync-cn-proto-to-en-patch-…

…1723708266
AgoraIO · Aug 15, 2024 · c93adfe · c93adfe
2 parents b50d5e0 + 88dad9f
commit c93adfe
Show file tree

Hide file tree

Showing 18 changed files with 1,722 additions and 3,820 deletions.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablevoiceaituner.dita b/en-US/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/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onextensionerrorwithcontext.dita b/en-US/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">

diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onextensioneventwithcontext.dita b/en-US/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">

diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onextensionstartedwithcontext.dita b/en-US/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">

diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onextensionstoppedwithcontext.dita b/en-US/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">

diff --git a/en-US/dita/RTC-NG/API/class_advanceoptions.dita b/en-US/dita/RTC-NG/API/class_advanceoptions.dita
@@ -68,41 +68,52 @@ struct FAdvanceOptions {
             <codeblock props="electron" outputclass="language-typescript">export class AdvanceOptions {
   encodingPreference?: EncodingPreference;
   compressionPreference?: CompressionPreference;
+  encodeAlpha?: boolean;
 }</codeblock>
             <codeblock props="unity cs" outputclass="language-csharp">public class AdvanceOptions
-              {
-                  public ENCODING_PREFERENCE encodingPreference { set; get; }
-                  public COMPRESSION_PREFERENCE compressionPreference { set; get; }
+    {
+        public ENCODING_PREFERENCE encodingPreference;
+        public COMPRESSION_PREFERENCE compressionPreference;
+        public bool encodeAlpha;
 
-                  public AdvanceOptions()
-                  {
-                      encodingPreference = ENCODING_PREFERENCE.PREFER_AUTO;
-                      compressionPreference = COMPRESSION_PREFERENCE.PREFER_LOW_LATENCY;
-                  }
+        public AdvanceOptions()
+        {
+            this.encodingPreference = ENCODING_PREFERENCE.PREFER_AUTO;
+            this.compressionPreference = COMPRESSION_PREFERENCE.PREFER_LOW_LATENCY;
+            this.encodeAlpha = false;
+        }
 
-                  public AdvanceOptions(ENCODING_PREFERENCE encoding_preference, COMPRESSION_PREFERENCE compression_preference)
-                  {
-                      encodingPreference = encoding_preference;
-                      compressionPreference = compression_preference;
-                  }
-              }</codeblock>
+        public AdvanceOptions(ENCODING_PREFERENCE encoding_preference, COMPRESSION_PREFERENCE compression_preference, bool encode_alpha)
+        {
+            this.encodingPreference = encoding_preference;
+            this.compressionPreference = compression_preference;
+            this.encodeAlpha = encode_alpha;
+        }
+
+    }</codeblock>
             <codeblock props="rn" outputclass="language-typescript">export class AdvanceOptions {
   encodingPreference?: EncodingPreference;
   compressionPreference?: CompressionPreference;
+  encodeAlpha?: boolean;
 }</codeblock>
-                <codeblock props="flutter" outputclass="language-dart">class AdvanceOptions {
-  const AdvanceOptions({this.encodingPreference, this.compressionPreference});
+                <codeblock props="flutter" outputclass="language-dart">@JsonSerializable(explicitToJson: true, includeIfNull: false)
+class AdvanceOptions {
+  const AdvanceOptions(
+      {this.encodingPreference, this.compressionPreference, this.encodeAlpha});
 
-  @JsonKey(name: 'encodingPreference')
+  @JsonKey(name: &#x27;encodingPreference&#x27;)
   final EncodingPreference? encodingPreference;
 
-  @JsonKey(name: 'compressionPreference')
+  @JsonKey(name: &#x27;compressionPreference&#x27;)
   final CompressionPreference? compressionPreference;
 
-  factory AdvanceOptions.fromJson(Map&lt;String, dynamic> json) =>
+  @JsonKey(name: &#x27;encodeAlpha&#x27;)
+  final bool? encodeAlpha;
+
+  factory AdvanceOptions.fromJson(Map&lt;String, dynamic&gt; json) =&gt;
       _$AdvanceOptionsFromJson(json);
 
-  Map&lt;String, dynamic> toJson() => _$AdvanceOptionsToJson(this);
+  Map&lt;String, dynamic&gt; toJson() =&gt; _$AdvanceOptionsToJson(this);
 }</codeblock>            
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>