add aidoc gen

dita/RTC-AIDOC/API/api_agoramediametadatadatasource_metadatamaxsize.dita

@@ -0,0 +1,30 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
+<reference id="api_agoramediametadatadatasource_metadatamaxsize">
+    <title><ph keyref="metadataMaxSize"/></title>
+    <shortdesc id="short"><ph id="shortdesc" props="ios">当 SDK 请求元数据的最大大小时触发。</ph><ph id="shortdesc" props="mac">当 SDK 请求元数据的最大大小时触发。</ph></shortdesc>
+    <prolog>
+        <metadata>
+            <keywords>
+                <indexterm keyref="metadataMaxSize"/>
+            </keywords>
+        </metadata>
+    </prolog>
+    <refbody>
+        <section id="prototype">
+            <p outputclass="codeblock">
+                <codeblock props="ios" outputclass="language-objectivec">- (NSInteger)metadataMaxSize NS_SWIFT_NAME(metadataMaxSize());</codeblock>
+                <codeblock props="mac" outputclass="language-objectivec">- (NSInteger)metadataMaxSize NS_SWIFT_NAME(metadataMaxSize());</codeblock>
+            </p>
+        </section>
+        <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
+            <p props="ios">调用 <xref keyref="registerMediaMetadataObserver"/> 方法成功注册后，SDK 每发送一帧视频时会触发该回调。你需要在该回调的返回值中指定元数据的最大大小。</p>
+            <p props="mac">调用 <xref keyref="registerMediaMetadataObserver"/> 方法成功注册后，SDK 每发送一帧视频时会触发该回调。你需要在该回调的返回值中指定元数据的最大大小。</p>
+        </section>
+        <section id="return_values" props="ios mac">
+            <title>返回值</title>
+            <p props="ios">方法调用成功，返回你希望使用的元数据缓冲区的最大大小，单位为字节。最大值为 1024 字节。</p>
+            <p props="mac">方法调用成功，返回你希望使用的元数据缓冲区的最大大小，单位为字节。最大值为 1024 字节。</p>
+        </section>
+    </refbody>
+</reference>

dita/RTC-AIDOC/API/api_agoramediametadatadatasource_readytosendmetadataattimestamp.dita

@@ -0,0 +1,72 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
+<reference id="api_agoramediametadatadatasource_readytosendmetadataattimestamp">
+    <title><ph keyref="readyToSendMetadataAtTimestamp"/></title>
+    <shortdesc id="short"><ph id="shortdesc" props="ios">当 SDK 准备好发送元数据时触发回调。</ph><ph id="shortdesc" props="mac">当 SDK 准备好发送元数据时触发回调。</ph></shortdesc>
+    <prolog>
+        <metadata>
+            <keywords>
+                <indexterm keyref="readyToSendMetadataAtTimestamp"/>
+            </keywords>
+        </metadata>
+    </prolog>
+    <refbody>
+        <section id="prototype">
+            <p outputclass="codeblock">
+                <codeblock props="ios" outputclass="language-objectivec">- (NSData * _Nullable)readyToSendMetadataAtTimestamp:(NSTimeInterval)timestamp sourceType:(AgoraVideoSourceType)sourceType NS_SWIFT_NAME(readyToSendMetadata(atTimestamp:sourceType:));</codeblock>
+                <codeblock props="mac" outputclass="language-objectivec">- (NSData * _Nullable)readyToSendMetadataAtTimestamp:(NSTimeInterval)timestamp sourceType:(AgoraVideoSourceType)sourceType NS_SWIFT_NAME(readyToSendMetadata(atTimestamp:sourceType:));</codeblock>
+            </p>
+        </section>
+        <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
+            <p props="ios">该回调在 SDK 准备好发送元数据时触发。</p>
+            <p props="mac">该回调在 SDK 准备好发送元数据时触发。</p>
+            <note props="ios">请确保元数据的大小不超过 <xref keyref="metadataMaxSize"/> 回调中设置的值。</note>
+            <note props="mac">请确保元数据的大小不超过 <xref keyref="metadataMaxSize"/> 回调中设置的值。</note>
+        </section>
+        <section id="timing" deliveryTarget="details" props="ios mac">
+            <title>调用时机</title>
+            <p props="ios">当 SDK 准备好发送元数据时触发。</p>
+            <p props="mac">当 SDK 准备好发送元数据时触发。</p>
+        </section>
+        <section id="parameters" deliveryTarget="details" props="ios mac">
+            <title>参数</title>
+            <parml>
+                <plentry props="ios">
+                    <pt>timestamp</pt>
+                    <pd>时间戳。</pd>
+                </plentry>
+                <plentry props="ios">
+                    <pt>sourceType</pt>
+                    <pd>视频数据类型，详见 <xref keyref="VIDEO_SOURCE_TYPE"/>。</pd>
+                </plentry>
+                <plentry props="mac">
+                    <pt>timestamp</pt>
+                    <pd>时间戳。</pd>
+                </plentry>
+                <plentry props="mac">
+                    <pt>sourceType</pt>
+                    <pd>视频数据类型，详见 <xref keyref="VIDEO_SOURCE_TYPE"/>。</pd>
+                </plentry>
+            </parml>
+        </section>
+        <section id="return_values" props="ios mac">
+            <title>返回值</title>
+            <p props="ios">你希望发送的元数据，格式为 <codeph>NSData</codeph>，包含以下参数：
+                <ul>
+                    <li><codeph>uid</codeph>：发送元数据的远端用户 ID。</li>
+                    <li><codeph>size</codeph>：元数据的大小。</li>
+                    <li><codeph>buffer</codeph>：元数据内容。</li>
+                    <li><codeph>timeStampMs</codeph>：发送元数据时的 NTP 时间戳（毫秒）。</li>
+                </ul>
+            </p>
+            <p props="mac">你希望发送的元数据，格式为 <codeph>NSData</codeph>，包含以下参数：
+                <ul>
+                    <li><codeph>uid</codeph>：发送元数据的远端用户 ID。</li>
+                    <li><codeph>size</codeph>：元数据的大小。</li>
+                    <li><codeph>buffer</codeph>：元数据内容。</li>
+                    <li><codeph>timeStampMs</codeph>：发送元数据时的 NTP 时间戳（毫秒）。</li>
+                </ul>
+            </p>
+        </section>
+    </refbody>
+</reference>

dita/RTC-AIDOC/API/api_agorartcmediaplayervideoframedelegate_agorartcmediaplayergetvideopixelformat.dita

@@ -0,0 +1,30 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
+<reference id="api_agorartcmediaplayervideoframedelegate_agorartcmediaplayergetvideopixelformat">
+    <title><ph keyref="AgoraRtcMediaPlayerGetVideoPixelFormat"/></title>
+    <shortdesc id="short"><ph id="shortdesc" props="ios">设置原始视频数据的格式。</ph><ph id="shortdesc" props="mac">设置原始视频数据的格式。</ph></shortdesc>
+    <prolog>
+        <metadata>
+            <keywords>
+                <indexterm keyref="AgoraRtcMediaPlayerGetVideoPixelFormat"/>
+            </keywords>
+        </metadata>
+    </prolog>
+    <refbody>
+        <section id="prototype">
+            <p outputclass="codeblock">
+                <codeblock props="ios" outputclass="language-objectivec">- (AgoraVideoFormat)AgoraRtcMediaPlayerGetVideoPixelFormat NS_SWIFT_NAME(AgoraRtcMediaPlayerGetVideoPixelFormat());</codeblock>
+                <codeblock props="mac" outputclass="language-objectivec">- (AgoraVideoFormat)AgoraRtcMediaPlayerGetVideoPixelFormat NS_SWIFT_NAME(AgoraRtcMediaPlayerGetVideoPixelFormat());</codeblock>
+            </p>
+        </section>
+        <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
+            <p props="ios">你需要在调用 <xref keyref="registerVideoFrameObserver"/> 方法时注册回调。当媒体播放器接收到每一帧视频时，会触发该回调。你可以在该回调的返回值中设置期望的视频数据格式。</p>
+            <p props="mac">你需要在调用 <xref keyref="registerVideoFrameObserver"/> 方法时注册回调。当媒体播放器接收到每一帧视频时，会触发该回调。你可以在该回调的返回值中设置期望的视频数据格式。</p>
+        </section>
+        <section id="return_values" props="ios mac">
+            <title>返回值</title>
+            <p props="ios">你为原始视频数据设置的期望格式，详见 <xref keyref="VIDEO_PIXEL_FORMAT"/>。默认情况下，原始视频像素格式（<codeph>AgoraVideoFormatDefault</codeph>）可能是 <codeph>I420</codeph> 或 <codeph>CVPixelBufferRef</codeph>。</p>
+            <p props="mac">你为原始视频数据设置的期望格式，详见 <xref keyref="VIDEO_PIXEL_FORMAT"/>。默认情况下，原始视频像素格式（<codeph>AgoraVideoFormatDefault</codeph>）可能是 <codeph>I420</codeph> 或 <codeph>CVPixelBufferRef</codeph>。</p>
+        </section>
+    </refbody>
+</reference>

dita/RTC-AIDOC/API/api_agorartcmediaplayervideoframedelegate_didreceivepixelbuffer.dita

@@ -0,0 +1,53 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
+<reference id="api_agorartcmediaplayervideoframedelegate_didreceivepixelbuffer">
+    <title><ph keyref="didReceivePixelBuffer"/></title>
+    <shortdesc id="short"><ph id="shortdesc" props="ios">媒体播放器接收到视频源的像素缓冲区时触发的回调。</ph><ph id="shortdesc" props="mac">媒体播放器接收到视频源的像素缓冲区时触发的回调。</ph></shortdesc>
+    <prolog>
+        <metadata>
+            <keywords>
+                <indexterm keyref="didReceivePixelBuffer"/>
+            </keywords>
+        </metadata>
+    </prolog>
+    <refbody>
+        <section id="prototype">
+            <p outputclass="codeblock">
+                <codeblock props="ios" outputclass="language-objectivec">- (void)AgoraRtcMediaPlayer:(id&lt;AgoraRtcMediaPlayerProtocol&gt; _Nonnull)playerKit
+       didReceivePixelBuffer:(CVPixelBufferRef _Nonnull)pixelBuffer NS_SWIFT_NAME(AgoraRtcMediaPlayer(_:didReceivePixelBuffer:));</codeblock>
+                <codeblock props="mac" outputclass="language-objectivec">- (void)AgoraRtcMediaPlayer:(id&lt;AgoraRtcMediaPlayerProtocol&gt; _Nonnull)playerKit
+       didReceivePixelBuffer:(CVPixelBufferRef _Nonnull)pixelBuffer NS_SWIFT_NAME(AgoraRtcMediaPlayer(_:didReceivePixelBuffer:));</codeblock>
+            </p>
+        </section>
+        <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
+            <p props="ios">触发该回调以报告类型为 <codeph>CVPixelBufferRef</codeph> 的像素缓冲区的详细信息。你可以使用这些信息进行图像处理与分析、自定义渲染等。</p>
+            <p props="mac">触发该回调以报告类型为 <codeph>CVPixelBufferRef</codeph> 的像素缓冲区的详细信息。你可以使用这些信息进行图像处理与分析、自定义渲染等。</p>
+        </section>
+        <section id="timing" deliveryTarget="details" props="ios mac">
+            <title>调用时机</title>
+            <p props="ios">该回调在媒体播放器接收到视频源的像素缓冲区时被触发。</p>
+            <p props="mac">该回调在媒体播放器接收到视频源的像素缓冲区时被触发。</p>
+        </section>
+        <section id="parameters" deliveryTarget="details" props="ios mac">
+            <title>参数</title>
+            <parml>
+                <plentry props="ios">
+                    <pt>playerKit</pt>
+                    <pd>媒体播放器对象，详见 <xref keyref="IMediaPlayer"/>。</pd>
+                </plentry>
+                <plentry props="ios">
+                    <pt>pixelBuffer</pt>
+                    <pd>包含像素缓冲区详细信息的 <codeph>CVPixelBufferRef</codeph> 对象。</pd>
+                </plentry>
+                <plentry props="mac">
+                    <pt>playerKit</pt>
+                    <pd>媒体播放器对象，详见 <xref keyref="IMediaPlayer"/>。</pd>
+                </plentry>
+                <plentry props="mac">
+                    <pt>pixelBuffer</pt>
+                    <pd>包含像素缓冲区详细信息的 <codeph>CVPixelBufferRef</codeph> 对象。</pd>
+                </plentry>
+            </parml>
+        </section>
+    </refbody>
+</reference>

dita/RTC-AIDOC/API/api_agorartcmediaplayervideoframedelegate_didreceivevideoframe.dita

@@ -0,0 +1,50 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
+<reference id="api_agorartcmediaplayervideoframedelegate_didreceivevideoframe">
+    <title><ph keyref="didReceiveVideoFrame"/></title>
+    <shortdesc id="short"><ph id="shortdesc" props="ios">每次播放器接收到视频帧时触发的回调。</ph><ph id="shortdesc" props="mac">每次播放器接收到视频帧时触发的回调。</ph></shortdesc>
+    <prolog>
+        <metadata>
+            <keywords>
+                <indexterm keyref="didReceiveVideoFrame"/>
+            </keywords>
+        </metadata>
+    </prolog>
+    <refbody>
+        <section id="prototype">
+            <p outputclass="codeblock">
+                <codeblock props="ios" outputclass="language-objectivec">- (void)AgoraRtcMediaPlayer:(id&lt;AgoraRtcMediaPlayerProtocol&gt; _Nonnull)playerKit
+       didReceiveVideoFrame:(AgoraOutputVideoFrame * _Nonnull)videoFrame NS_SWIFT_NAME(AgoraRtcMediaPlayer(_:didReceiveVideoFrame:));</codeblock>
+                <codeblock props="mac" outputclass="language-objectivec">- (void)AgoraRtcMediaPlayer:(id&lt;AgoraRtcMediaPlayerProtocol&gt; _Nonnull)playerKit
+       didReceiveVideoFrame:(AgoraOutputVideoFrame * _Nonnull)videoFrame NS_SWIFT_NAME(AgoraRtcMediaPlayer(_:didReceiveVideoFrame:));</codeblock>
+            </p>
+        </section>
+        <section id="detailed_desc" deliveryTarget="details" otherprops="no-title"/>
+        <section id="timing" deliveryTarget="details" props="ios mac">
+            <title>调用时机</title>
+            <p props="ios">该回调在播放器每次接收到视频帧时被触发。</p>
+            <p props="mac">该回调在播放器每次接收到视频帧时被触发。</p>
+        </section>
+        <section id="parameters" deliveryTarget="details" props="ios mac">
+            <title>参数</title>
+            <parml>
+                <plentry props="ios">
+                    <pt>playerKit</pt>
+                    <pd>播放器对象。详见 <xref keyref="IMediaPlayer"/>。</pd>
+                </plentry>
+                <plentry props="ios">
+                    <pt>videoFrame</pt>
+                    <pd>视频帧信息。详见 <xref keyref="VideoFrame"/>。</pd>
+                </plentry>
+                <plentry props="mac">
+                    <pt>playerKit</pt>
+                    <pd>播放器对象。详见 <xref keyref="IMediaPlayer"/>。</pd>
+                </plentry>
+                <plentry props="mac">
+                    <pt>videoFrame</pt>
+                    <pd>视频帧信息。详见 <xref keyref="VideoFrame"/>。</pd>
+                </plentry>
+            </parml>
+        </section>
+    </refbody>
+</reference>