Merge pull request #3829 from AgoraIO/DOC-4556

update desc
AgoraIO · Nov 13, 2024 · 8afc95a · 8afc95a
2 parents c4da9e1 + 64f2b69
commit 8afc95a
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 18 deletions.
diff --git a/dita/RTC-NG/API/callback_ivideoframeobserver_getvideoformatpreference.dita b/dita/RTC-NG/API/callback_ivideoframeobserver_getvideoformatpreference.dita
@@ -32,7 +32,7 @@
         <section id="detailed_desc">
             <p>你需要在调用 <xref keyref="registerVideoFrameObserver"/> 方法时注册该回调。成功注册视频数据观测器后，SDK 会在捕捉到每个视频帧时触发该回调，你需要在该回调的返回值中设置期望的视频数据格式。</p>
                     <note>在默认情况下，原始视频像素格式 (<ph keyref="VIDEO_PIXEL_DEFAULT"/>) 存在以下类型：<ul>
-                <li props="android cpp bp unreal">在 Android 平台上，默认的视频帧类型可能为 I420Buffer 或 TextureBuffer。视频帧类型固定为 I420Buffer 的情况包括但不限于：<ul>
+                <li props="android cpp bp unreal">在 Android 平台上，默认的视频帧类型可能为 I420Buffer 或 TextureBuffer。TextureBuffer 类型的纹理格式可能为 OES 格式或者 RGB 格式。如果 <apiname keyref="getVideoFormatPreference"/> 返回的视频帧类型为 <ph keyref="VIDEO_PIXEL_DEFAULT"/>，你需要在处理视频数据时增加对 I420Buffer 或 TextureBuffer 的适配。视频帧类型固定为 I420Buffer 的情况包括但不限于：<ul>
                     <li>特定机型，例如：LG G5 SE (H848)，Google Pixel 4a，Samsung Galaxy A7 或 Xiaomi Mi Max。</li>
                     <li>已集成视频增强插件并开启视频降噪或暗光增强功能。</li>
                     </ul></li>

diff --git a/dita/RTC-NG/API/callback_ivideoframeobserver_oncapturevideoframe.dita b/dita/RTC-NG/API/callback_ivideoframeobserver_oncapturevideoframe.dita
@@ -35,6 +35,10 @@
             <p props="native unreal bp unity cs">你可以在回调中获取本地设备采集到的原始视频数据，并可根据需要进行前处理。完成前处理后，你可以在该回调中直接修改 <parmname>videoFrame</parmname>，并将返回值设置为 <codeph><ph keyref="true"/></codeph>，即可将修改后的视频数据发送给 SDK。</p>
             <p props="native unreal bp">如果你需要将处理后的数据发送给 SDK，需要先调用 <xref keyref="getVideoFrameProcessMode"/> 方法，将视频处理模式设置为读写模式（<ph keyref="PROCESS_MODE_READ_WRITE"/>）。</p>
             <p props="flutter rn electron">你可以在回调中获取本地设备采集到的原始视频数据。</p>
+            <note type="attention" id="default">
+            <p props="android" id="java">该回调默认提供的视频数据格式为 I420Buffer 或 TextureBuffer，TextureBuffer 类型的纹理格式可能为 0ES 格式或者 RGB 格式。如果你需要其他格式的视频数据，可在 <xref keyref="getVideoFormatPreference"/> 回调的返回值中设置预期的数据格式。</p>
+            <p props="apple">该回调默认提供的视频数据格式为 I420 或 CVPixelBufferRef，如果你需要其他格式的视频数据，可在 <xref keyref="getVideoFormatPreference"/> 回调中返回预期的数据格式。</p>
+            <p props="cpp">该回调默认提供的视频数据格式为 YUV420，如果你需要其他格式的视频数据，可在 getVideoFormatPreference 回调的返回值中设置预期的数据格式。</p></note>
         </section>
         <section id="scenario" deliveryTarget="details">
             <title>适用场景</title>
@@ -45,7 +49,7 @@
         <section id="timing" deliveryTarget="details">
             <title>触发时机</title>
             <p>成功注册视频数据观测器后，SDK 捕捉到每个视频帧时。</p>
-        </section>        
+        </section>
         <section id="restriction" deliveryTarget="details">
             <title>使用限制</title>
             <ul>

diff --git a/dita/RTC-NG/API/callback_ivideoframeobserver_onrendervideoframe.dita b/dita/RTC-NG/API/callback_ivideoframeobserver_onrendervideoframe.dita
@@ -37,6 +37,9 @@
         </section>
         <section id="detailed_desc">
             <p>成功注册视频数据观测器后，SDK 会在捕捉到每个视频帧时触发该回调。你可以在回调中获取远端发送的渲染前的视频数据，然后根据场景需要，对视频数据进行处理。</p>
+            <p props="android" id="java">该回调默认提供的视频数据格式为 I420Buffer 或 TextureBuffer，TextureBuffer 类型的纹理格式可能为 0ES 格式或者 RGB 格式。如果你需要其他格式的视频数据，可在 <xref keyref="getVideoFormatPreference"/> 回调的返回值中设置预期的数据格式。</p>
+            <p props="apple">该回调默认提供的视频数据格式为 I420 或 CVPixelBufferRef，如果你需要其他格式的视频数据，可在 <xref keyref="getVideoFormatPreference"/> 回调中返回预期的数据格式。</p>
+            <p props="cpp">该回调默认提供的视频数据格式为 YUV420，如果你需要其他格式的视频数据，可在 getVideoFormatPreference 回调的返回值中设置预期的数据格式。</p>
             <note type="attention" props="native unreal bp electron rn flutter">
             <ul>
             <li props="native unreal bp">如果你需要将处理后的数据发送给 SDK，需要先调用 <xref keyref="getVideoFrameProcessMode"/> 方法，将视频处理模式设置为读写模式（<ph keyref="PROCESS_MODE_READ_WRITE"/>）。</li>

diff --git a/dita/RTC-NG/API/rtc_api_overview.dita b/dita/RTC-NG/API/rtc_api_overview.dita
@@ -1108,37 +1108,37 @@
                     <stentry><xref keyref="setFilterEffectOptions2"/></stentry>
                     <stentry><ph conkeyref="setFilterEffectOptions2/shortdesc"/></stentry>
                 </strow>
-                <strow>
+                <strow props="cn">
                     <stentry><xref keyref="setFaceShapeBeautyOptions"/></stentry>
                     <stentry><ph conkeyref="setFaceShapeBeautyOptions/shortdesc"/></stentry>
                 </strow>
-                <strow props="android apple">
-                    <stentry><xref keyref="setFaceShapeBeautyOptions2"/></stentry>
-                    <stentry><ph conkeyref="setFaceShapeBeautyOptions2/shortdesc"/></stentry>
+                <strow props="cn">
+                    <stentry props="android apple"><xref keyref="setFaceShapeBeautyOptions2"/></stentry>
+                    <stentry props="android apple"><ph conkeyref="setFaceShapeBeautyOptions2/shortdesc"/></stentry>
                 </strow>
-                <strow>
+                <strow props="cn">
                     <stentry><xref keyref="setFaceShapeAreaOptions"/></stentry>
                     <stentry><ph conkeyref="setFaceShapeAreaOptions/shortdesc"/></stentry>
                 </strow>
-                <strow props="android apple">
-                    <stentry><xref keyref="setFaceShapeAreaOptions2"/></stentry>
-                    <stentry><ph conkeyref="setFaceShapeAreaOptions2/shortdesc"/></stentry>
+                <strow props="cn">
+                    <stentry props="android apple"><xref keyref="setFaceShapeAreaOptions2"/></stentry>
+                    <stentry props="android apple"><ph conkeyref="setFaceShapeAreaOptions2/shortdesc"/></stentry>
                 </strow>
-                <strow>
+                <strow props="cn">
                     <stentry><xref keyref="getFaceShapeBeautyOptions"/></stentry>
                     <stentry><ph conkeyref="getFaceShapeBeautyOptions/shortdesc"/></stentry>
                 </strow>
-                <strow props="android apple">
-                    <stentry><xref keyref="getFaceShapeBeautyOptions2"/></stentry>
-                    <stentry><ph conkeyref="getFaceShapeBeautyOptions2/shortdesc"/></stentry>
+                <strow props="cn">
+                    <stentry props="android apple"><xref keyref="getFaceShapeBeautyOptions2"/></stentry>
+                    <stentry props="android apple"><ph conkeyref="getFaceShapeBeautyOptions2/shortdesc"/></stentry>
                 </strow>
-                <strow>
+                <strow props="cn">
                     <stentry><xref keyref="getFaceShapeAreaOptions"/></stentry>
                     <stentry><ph conkeyref="getFaceShapeAreaOptions/shortdesc"/></stentry>
                 </strow>
-                <strow props="android apple">
-                    <stentry><xref keyref="getFaceShapeAreaOptions2"/></stentry>
-                    <stentry><ph conkeyref="getFaceShapeAreaOptions2/shortdesc"/></stentry>
+                <strow props="cn">
+                    <stentry props="android apple"><xref keyref="getFaceShapeAreaOptions2"/></stentry>
+                    <stentry props="android apple"><ph conkeyref="getFaceShapeAreaOptions2/shortdesc"/></stentry>
                 </strow>
                 <strow props="android hmos ios cpp unity rn flutter unreal bp cs">
                     <stentry><xref keyref="enableFaceDetection"/></stentry>