Merge pull request #3843 from AgoraIO/release/rtc-ng/4.5.0-framework

Release/rtc ng/4.5.0 framework
AgoraIO · Nov 25, 2024 · 35b86d9 · 35b86d9
2 parents 4ac9bd8 + f9c5aa3
commit 35b86d9
Show file tree

Hide file tree

Showing 63 changed files with 3,250 additions and 570 deletions.
diff --git a/dita/RTC-NG/API/api_irtcengine_getfaceshapeareaoptions.dita b/dita/RTC-NG/API/api_irtcengine_getfaceshapeareaoptions.dita
@@ -18,11 +18,20 @@
             <codeblock props="hmos" outputclass="language-arkts"/>
             <codeblock props="ios mac" outputclass="language-objectivec">- (AgoraFaceShapeAreaOptions * _Nullable)getFaceShapeAreaOptions:(AgoraFaceShapeArea) area sourceType:(AgoraMediaSourceType)sourceType NS_SWIFT_NAME(getFaceShapeAreaOptions(_:sourceType:));</codeblock>
             <codeblock props="cpp unreal" outputclass="language-cpp">virtual int getFaceShapeAreaOptions(agora::rtc::FaceShapeAreaOptions::FACE_SHAPE_AREA shapeArea, FaceShapeAreaOptions&amp; options, agora::media::MEDIA_SOURCE_TYPE type = agora::media::PRIMARY_CAMERA_SOURCE) = 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="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
+	int GetFaceShapeAreaOptions(EUABT_FACE_SHAPE_AREA shapeArea, FUABT_FaceShapeAreaOptions&amp; options, EUABT_MEDIA_SOURCE_TYPE type = EUABT_MEDIA_SOURCE_TYPE::PRIMARY_CAMERA_SOURCE);</codeblock>
+            <codeblock props="electron" outputclass="language-typescript">abstract getFaceShapeAreaOptions(
+    shapeArea: FaceShapeArea,
+    type?: MediaSourceType
+  ): FaceShapeAreaOptions;</codeblock>
+            <codeblock props="unity cs" outputclass="language-csharp">public abstract int GetFaceShapeAreaOptions(FACE_SHAPE_AREA shapeArea, ref FaceShapeAreaOptions options, MEDIA_SOURCE_TYPE type = MEDIA_SOURCE_TYPE.PRIMARY_CAMERA_SOURCE);</codeblock>
+            <codeblock props="rn" outputclass="language-typescript">abstract getFaceShapeAreaOptions(
+    shapeArea: FaceShapeArea,
+    type?: MediaSourceType
+  ): FaceShapeAreaOptions;</codeblock>
+            <codeblock props="flutter" outputclass="language-dart">Future&lt;FaceShapeAreaOptions> getFaceShapeAreaOptions(
+      {required FaceShapeArea shapeArea,
+      MediaSourceType type = MediaSourceType.primaryCameraSource});</codeblock> </p>
         </section>
         <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
             <dl outputclass="since">
@@ -40,7 +49,7 @@
         <section id="timing" deliveryTarget="details">
             <title>调用时机</title>
             <p>请在 <xref keyref="enableVideo" /> 之后调用该方法。</p>
-        </section>        
+        </section>
         <section id="restriction" deliveryTarget="details">
             <title>调用限制</title>
             <p>无。</p>
@@ -49,8 +58,8 @@
             <title>参数</title>
             <parml>
             <plentry id="area">
-                <pt props="android ios">shapeArea</pt>
-                <pt props="cpp unreal bp unity flutter rn electron cs">area</pt>
+                <pt props="ios mac">area</pt>
+                <pt props="android cpp unreal bp unity flutter rn electron cs">shapeArea</pt>
                 <pd>
                     <p props="cpp ios mac unreal bp unity flutter electron rn cs">美型部位。详见 <xref keyref="FACE_SHAPE_AREA" />。</p>
                     <p props="android hmos">美型部位：
@@ -72,7 +81,7 @@
                     </p>
                 </pd>
             </plentry>
-            <plentry conkeyref="setFaceShapeAreaOptions/options" props="cpp">
+            <plentry conkeyref="setFaceShapeAreaOptions/options" props="cpp unreal bp unity cs">
                 <pt/>
                 <pd/>
             </plentry>
@@ -83,12 +92,12 @@
             </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="cpp unreal bp electron unity rn cs">
+            <p props="flutter">方法成功调用时，返回 <apiname keyref="FaceShapeAreaOptions"/> 对象；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
+            <ul props="cpp unreal bp unity cs">
             <li>0: 方法调用成功。</li>
             <li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
             </ul>
-            <ul props="apple android">
+            <ul props="apple android electron rn">
             <li>方法调用成功，返回 <apiname keyref="FaceShapeAreaOptions"/> 对象。</li>
             <li>方法调用失败，返回 <ph keyref="NULL"/>。</li>
             </ul> </section>

diff --git a/dita/RTC-NG/API/api_irtcengine_getfaceshapebeautyoptions.dita b/dita/RTC-NG/API/api_irtcengine_getfaceshapebeautyoptions.dita
@@ -18,11 +18,17 @@
             <codeblock props="hmos" outputclass="language-arkts"/>
             <codeblock props="ios mac" outputclass="language-objectivec">- (AgoraFaceShapeBeautyOptions * _Nullable)getFaceShapeBeautyOptions:(AgoraMediaSourceType)sourceType NS_SWIFT_NAME(getFaceShapeBeautyOptions(_:));</codeblock>
             <codeblock props="cpp unreal" outputclass="language-cpp">virtual int getFaceShapeBeautyOptions(FaceShapeBeautyOptions&amp; options, agora::media::MEDIA_SOURCE_TYPE type = agora::media::PRIMARY_CAMERA_SOURCE) = 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="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
+	int GetFaceShapeBeautyOptions(FUABT_FaceShapeBeautyOptions &amp; options, EUABT_MEDIA_SOURCE_TYPE type = EUABT_MEDIA_SOURCE_TYPE::PRIMARY_CAMERA_SOURCE);</codeblock>
+            <codeblock props="electron" outputclass="language-typescript">abstract getFaceShapeBeautyOptions(
+    type?: MediaSourceType
+  ): FaceShapeBeautyOptions;</codeblock>
+            <codeblock props="unity cs" outputclass="language-csharp">public abstract int GetFaceShapeBeautyOptions(ref FaceShapeBeautyOptions options, MEDIA_SOURCE_TYPE type = MEDIA_SOURCE_TYPE.PRIMARY_CAMERA_SOURCE);</codeblock>
+            <codeblock props="rn" outputclass="language-typescript">abstract getFaceShapeBeautyOptions(
+    type?: MediaSourceType
+  ): FaceShapeBeautyOptions;</codeblock>
+            <codeblock props="flutter" outputclass="language-dart">Future&lt;FaceShapeBeautyOptions> getFaceShapeBeautyOptions(
+      {MediaSourceType type = MediaSourceType.primaryCameraSource});</codeblock> </p>
         </section>
         <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
             <dl outputclass="since">
@@ -40,15 +46,15 @@
         <section id="timing" deliveryTarget="details">
             <title>调用时机</title>
             <p>请在 <xref keyref="enableVideo" /> 之后调用该方法。</p>
-        </section>        
+        </section>
         <section id="restriction" deliveryTarget="details">
             <title>调用限制</title>
             <p>无。</p>
         </section>
         <section id="parameters" deliveryTarget="details">
             <title>参数</title>
             <parml>
-            <plentry conkeyref="setFaceShapeBeautyOptions/options" props="cpp">
+            <plentry conkeyref="setFaceShapeBeautyOptions/options" props="cpp unreal bp unity cs">
                 <pt/>
                 <pd/>
             </plentry>
@@ -60,12 +66,12 @@
         </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="cpp unreal bp electron unity rn cs">
+            <p props="flutter">方法成功调用时，返回 <apiname keyref="FaceShapeBeautyOptions"/> 对象；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
+            <ul props="cpp unreal bp unity cs">
             <li>0: 方法调用成功。</li>
             <li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
             </ul>
-            <ul props="apple android">
+            <ul props="apple android electron rn">
             <li>方法调用成功，返回 <apiname keyref="FaceShapeBeautyOptions"/> 对象。</li>
             <li>方法调用失败，返回 <ph keyref="NULL"/>。</li>
             </ul> </section>

diff --git a/dita/RTC-NG/API/api_irtcengine_setexternalmediaprojection.dita b/dita/RTC-NG/API/api_irtcengine_setexternalmediaprojection.dita
@@ -19,9 +19,9 @@
             <codeblock props="cpp unreal" outputclass="language-cpp">virtual int setExternalMediaProjection(void* mediaProjection) = 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="unity cs" outputclass="language-csharp">public abstract int SetExternalMediaProjection(IntPtr mediaProjection);</codeblock>
+            <codeblock props="rn" outputclass="language-typescript">abstract setExternalMediaProjection(mediaProjection: any): number;</codeblock>
+            <codeblock props="flutter" outputclass="language-dart">Future&lt;void> setExternalMediaProjection(int mediaProjection);</codeblock> </p>
         </section>
         <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
             <dl outputclass="since">
@@ -30,7 +30,7 @@
                 <dd>v4.5.0</dd>
             </dlentry>
             </dl>
-             <note type="attention" props="cpp">该方法仅适用于 Android。</note> 
+             <note type="attention" props="cpp unreal unity rn flutter">该方法仅适用于 Android。</note>
             <p>成功调用该方法后，你设置的外部 <codeph>MediaProjection</codeph> 会替换掉 SDK 申请的 <codeph>MediaProjection</codeph> 采集屏幕视频流。</p>
             <p>当停止屏幕共享或销毁 <xref keyref="IRtcEngine"/> 时，SDK 会自动释放 MediaProjection。</p>
         </section>
@@ -44,7 +44,7 @@
         <section id="timing" deliveryTarget="details">
             <title>调用时机</title>
             <p>该方法需要在 <xref keyref="startScreenCapture"/> 之前调用。</p>
-        </section>        
+        </section>
         <section id="restriction" deliveryTarget="details">
             <title>调用限制</title>
             <p>在调用该方法前，必须先申请 <codeph>MediaProjection</codeph> 权限。</p>

diff --git a/dita/RTC-NG/API/api_irtcengine_setexternalremoteeglcontext.dita b/dita/RTC-NG/API/api_irtcengine_setexternalremoteeglcontext.dita
@@ -19,9 +19,9 @@
             <codeblock props="cpp unreal" outputclass="language-cpp">virtual int setExternalRemoteEglContext(void* eglContext) = 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="unity cs" outputclass="language-csharp">public abstract int SetExternalRemoteEglContext(IntPtr eglContext);</codeblock>
+            <codeblock props="rn" outputclass="language-typescript">abstract setExternalRemoteEglContext(eglContext: any): number;</codeblock>
+            <codeblock props="flutter" outputclass="language-dart">Future&lt;void> setExternalRemoteEglContext(int eglContext);</codeblock> </p>
         </section>
         <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
             <dl outputclass="since">

diff --git a/dita/RTC-NG/API/api_irtcengine_setfaceshapeareaoptions.dita b/dita/RTC-NG/API/api_irtcengine_setfaceshapeareaoptions.dita
@@ -18,11 +18,20 @@
             <codeblock props="hmos" outputclass="language-arkts"/>
             <codeblock props="ios mac" outputclass="language-objectivec">- (int)setFaceShapeAreaOptions:(AgoraFaceShapeAreaOptions* _Nullable)options sourceType:(AgoraMediaSourceType)sourceType NS_SWIFT_NAME(setFaceShapeAreaOptions(_:sourceType:));</codeblock>
             <codeblock props="cpp unreal" outputclass="language-cpp">virtual int setFaceShapeAreaOptions(const FaceShapeAreaOptions&amp; options, agora::media::MEDIA_SOURCE_TYPE type = agora::media::PRIMARY_CAMERA_SOURCE) = 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="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
+	int SetFaceShapeAreaOptions(const FUABT_FaceShapeAreaOptions&amp; options, EUABT_MEDIA_SOURCE_TYPE type = EUABT_MEDIA_SOURCE_TYPE::PRIMARY_CAMERA_SOURCE);</codeblock>
+            <codeblock props="electron" outputclass="language-typescript">abstract setFaceShapeAreaOptions(
+    options: FaceShapeAreaOptions,
+    type?: MediaSourceType
+  ): number;</codeblock>
+            <codeblock props="unity cs" outputclass="language-csharp">public abstract int SetFaceShapeAreaOptions(FaceShapeAreaOptions options, MEDIA_SOURCE_TYPE type = MEDIA_SOURCE_TYPE.PRIMARY_CAMERA_SOURCE);</codeblock>
+            <codeblock props="rn" outputclass="language-typescript">abstract setFaceShapeAreaOptions(
+    options: FaceShapeAreaOptions,
+    type?: MediaSourceType
+  ): number;</codeblock>
+            <codeblock props="flutter" outputclass="language-dart">Future&lt;void> setFaceShapeAreaOptions(
+      {required FaceShapeAreaOptions options,
+      MediaSourceType type = MediaSourceType.primaryCameraSource});</codeblock> </p>
         </section>
         <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
             <dl outputclass="since">
@@ -31,14 +40,14 @@
                 <dd>v4.5.0</dd>
             </dlentry>
             </dl>
-            <p>如果在 <xref keyref="setFaceShapeBeautyOptions"/> 方法中实现的预设美型效果达不到预期，你可以通过该方法设置美型部位选项，对人脸的各个部位单独微调，实现更加精细的美型效果，详见<xref keyref="advanced-beauty"/>。</p>
+            <p>如果在 <xref keyref="setFaceShapeBeautyOptions"/> 方法中实现的预设美型效果达不到预期，你可以通过该方法设置美型部位选项，对人脸的各个部位单独微调，实现更加精细的美型效果。<ph props="cpp apple android">详见<xref keyref="advanced-beauty"/>。</ph></p>
             <p props="android apple">该方法和 <xref keyref="setFaceShapeAreaOptions2"/> 均可用于设置美型部位选项，区别在于该方法支持指定应用美型效果的媒体源。</p>
             <note conkeyref="setFaceShapeBeautyOptions/billing"/>
         </section>
         <section id="timing" deliveryTarget="details">
             <title>调用时机</title>
             <p>请在 <xref keyref="setFaceShapeBeautyOptions"/><ph props="apple android"> 或 <xref keyref="setFaceShapeBeautyOptions2" /></ph> 之后调用该方法。</p>
-        </section>        
+        </section>
         <section id="restriction" deliveryTarget="details" conkeyref="setFaceShapeBeautyOptions/restriction">
         </section>
         <section id="parameters" deliveryTarget="details">
@@ -63,7 +72,7 @@
                         <li>-4：当前设备不支持该功能，可能的原因有：
                             <ul>
                                 <li>当前设备能力不满足美颜的使用要求，建议更换性能更高的设备。</li>
-                                <li props="android rn unity flutter cs">当前设备版本低于 Android 4.4，不支持该操作，建议更换设备或升级操作系统。</li>
+                                <li props="android rn unity flutter cpp bp unreal">当前设备版本低于 Android 4.4，不支持该操作，建议更换设备或升级操作系统。</li>
                             </ul>
                         </li>
                     </ul>

diff --git a/dita/RTC-NG/API/api_irtcengine_setfaceshapeareaoptions2.dita b/dita/RTC-NG/API/api_irtcengine_setfaceshapeareaoptions2.dita
@@ -30,7 +30,7 @@
                 <dd>v4.5.0</dd>
             </dlentry>
             </dl>
-            <p>如果在 <xref keyref="setFaceShapeBeautyOptions"/> 方法中实现的预设美型效果达不到预期，你可以通过该方法设置美型部位选项，对人脸的各个部位单独微调，实现更加精细的美型效果，详见<xref keyref="advanced-beauty"/>。</p>
+            <p>如果在 <xref keyref="setFaceShapeBeautyOptions"/> 方法中实现的预设美型效果达不到预期，你可以通过该方法设置美型部位选项，对人脸的各个部位单独微调，实现更加精细的美型效果。<ph props="cpp apple android">详见<xref keyref="advanced-beauty"/>。</ph></p>
             <note conkeyref="setFaceShapeBeautyOptions/billing"/>
         </section>
         <section id="timing" deliveryTarget="details">