460api v2 by Nero-Hu · Pull Request #3948 · AgoraIO/agora_doc_source

Nero-Hu · 2025-06-24T06:54:51Z

No description provided.

dita/RTC-NG/API/api_imediaplayersourceobserver_onagoracdntokenwillexpire.dita

dita/RTC-NG/API/api_irtcengine_addvideowatermark3.dita

Suri539 · 2025-06-24T08:59:21Z

dita/RTC-NG/API/api_irtcengine_createvideoeffectobject.dita

+                </dlentry>
+            </dl>
+            <p>创建一个 <codeph>IVideoEffectObject</codeph> 视频特效对象并返回其指针。</p>
+            <note type="attention" props="android">调用该方法前需先调用 <xref keyref="enableVideo"/> 方法。该方法适用于 Android 4.4 或更高版本。</note>


需要先调用 enableVideo 这个应该是针对全平台的 note？

跟研发确认了是全平台的 note 待文档评审会结束后提 jira 让他改

Suri539 · 2025-06-24T09:14:14Z

dita/RTC-NG/API/api_irtcengine_destroy.dita

+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
+<reference id="api_irtcengine_destroy">
+    <title><ph keyref="destroy"/></title>
+    <shortdesc id="short"><ph id="shortdesc">释放声网 SDK 使用的所有资源。</ph></shortdesc>


这里应该也得改为引擎了 sad

这个先提 JIRA ，API 评审会结束后再改描述，我们就别手动改描述了

Suri539 · 2025-06-24T09:16:18Z

dita/RTC-NG/API/api_irtcengine_destroy.dita

+                <dd props="android apple">自 v4.6.0 版本新增。</dd>
+                </dlentry>
+            </dl>
+            <p>该方法适用于偶尔进行语音通话或视频通话的应用程序，在不通话时释放资源以供其他操作使用。一旦调用该方法销毁已创建的 <xref keyref="IRtcEngine"/> 实例，SDK 中的其他方法将无法使用，也不会再触发任何回调。若需重新开始通信，请调用 <codeph>sharedEngineWithAppId</codeph> 方法重新创建实例。</p>


这个方法名是 iOS 的

手动：
该方法适用于偶尔进行语音通话或视频通话的应用程序，在不通话时释放资源以供其他操作使用。一旦调用该方法销毁已创建的 RTC 引擎实例，SDK 中的其他方法将无法使用，也不会再触发任何回调。若需重新开始通信，请重新创建实例。

Suri539 · 2025-06-24T09:17:25Z

dita/RTC-NG/API/api_irtcengine_destroy.dita

+                </dlentry>
+            </dl>
+            <p>该方法适用于偶尔进行语音通话或视频通话的应用程序，在不通话时释放资源以供其他操作使用。一旦调用该方法销毁已创建的 <xref keyref="IRtcEngine"/> 实例，SDK 中的其他方法将无法使用，也不会再触发任何回调。若需重新开始通信，请调用 <codeph>sharedEngineWithAppId</codeph> 方法重新创建实例。</p>
+            <note type="attention" props="apple">不要在 SDK 生成的任何回调中调用此方法，否则可能导致死锁。</note>


这个描述优点问题，需要看下 input @Suri539

英文写的有问题，应该是直接复用原来 3.x 的注释

Suri539 · 2025-06-24T09:28:36Z

dita/RTC-NG/API/api_irtcengine_queryhdrcapability.dita

+    <refbody>
+        <section id="prototype">
+            <p outputclass="codeblock">
+            <codeblock props="android" outputclass="language-java">public abstract int queryHDRCapability(Constants.VIDEO_MODULE_TYPE moduleType);</codeblock>


是全平台的新增，应该是 scope 没跑到这个 pr

已记录到群公告

Suri539 · 2025-06-24T09:33:35Z

dita/RTC-NG/API/api_irtcengine_renewtoken.dita

            <codeblock props="android" outputclass="language-java">public abstract int renewToken(String token);</codeblock>
-            <codeblock props="hmos" outputclass="language-arkts">public abstract renewToken(token: string): number;</codeblock>
-            <codeblock props="ios mac" outputclass="language-objectivec">- (int)renewToken:(NSString * _Nonnull)token;</codeblock>
+            <codeblock props="hmos" outputclass="language-arkts"/>


这里把鸿蒙的误删了

下面其他框架的也是

api modify 注释，已从 json 移除

dita/RTC-NG/API/api_irtcengine_renewtoken.dita

dita/RTC-NG/API/api_irtcengine_setavsyncsource.dita

Suri539 · 2025-06-24T09:36:26Z

dita/RTC-NG/API/api_irtcengine_setdirectcdnstreamingaudioconfiguration.dita

            <codeblock props="ios mac" outputclass="language-objectivec">- (int)setDirectCdnStreamingAudioConfiguration:(AgoraAudioProfile)profile;</codeblock>
            <codeblock props="cpp unreal" outputclass="language-cpp">virtual int setDirectCdnStreamingAudioConfiguration(AUDIO_PROFILE_TYPE profile) = 0;</codeblock>
-         <codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IRtcEngine&quot;)
+         <codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")


这个把转译改回来了，unreal 发布可能会报错

@Nero-Hu 等待排查

dita/RTC-NG/API/api_irtcengine_setplaybackaudioframebeforemixingparameters.dita

Suri539 · 2025-06-24T09:49:31Z

dita/RTC-NG/API/api_irtcengine_stopdirectcdnstreaming.dita

            <codeblock props="ios mac" outputclass="language-objectivec">- (int)stopDirectCdnStreaming;</codeblock>
            <codeblock props="cpp unreal" outputclass="language-cpp">virtual int stopDirectCdnStreaming() = 0;</codeblock>
-         <codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|RtcEngineProxy&quot;)
+         <codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")


上面几个方法也有这个问题，需要确认下

dita/RTC-NG/API/api_irtcengine_stopdirectcdnstreaming.dita

Suri539 · 2025-06-24T09:51:20Z

dita/RTC-NG/API/api_irtcengineeventhandler_onmultipathstats.dita

+            </dl>
+            <p>该回调在你将 <codeph>enableMultipath</codeph> 设置为 <codeph><ph keyref="true"/></codeph> 以启用多路径传输后触发。</p>
+            </section>
+        <section id="timing" deliveryTarget="details">


描述重复了，应该是 llm 的问题 @Suri539

没有复现

dita/RTC-NG/API/api_irtcengineeventhandler_onrenewtokenresult.dita

Suri539 · 2025-06-24T10:01:17Z

dita/RTC-NG/API/api_irtcengineex_addvideowatermarkex1.dita

+    <refbody>
+        <section id="prototype">
+            <p outputclass="codeblock">
+            <codeblock props="android" outputclass="language-java">public abstract int addVideoWatermarkEx(String watermarkUrl, WatermarkOptions options, RtcConnection connection);</codeblock>


原型有问题，描述也是

这个具体啥问题

这个描述是废弃的ex方法的描述，新增方法是watermarkconfig&connection

Suri539 · 2025-06-24T10:02:36Z

dita/RTC-NG/API/api_irtcengineex_playeffectex.dita

+                </dlentry>
+            </dl>
+            <p>调用 <xref keyref="preloadEffect"/> 预加载音效后，可以调用该方法将指定音效播放给频道内的所有用户。每次调用该方法只能播放一个音效。如需同时播放多个音效，请多次调用该方法。</p>
+            <note type="attention" props="apple">该方法适用于多频道场景。如果你通过 <xref keyref="preloadEffect"/> 方法将音效文件预加载到内存中，请确保 <codeph>soundId</codeph> 的值与 <xref keyref="preloadEffect"/> 中设置的值一致。</note>


cpp漏掉了note？ @Suri539

测试下来是有的

dita/RTC-NG/API/api_irtcengineex_preloadeffectex.dita

Suri539 · 2025-06-24T10:21:56Z

dita/RTC-NG/API/api_irtcengineex_preloadeffectex.dita

+            <p outputclass="codeblock">
+            <codeblock props="android" outputclass="language-java">public int preloadEffectEx(RtcConnection connection, int soundId, String filePath);</codeblock>
+            <codeblock props="hmos" outputclass="language-arkts"/>
+            <codeblock props="ios mac" outputclass="language-objectivec">- (int)preloadEffectEx:(AgoraRtcConnection* _Nonnull)connection soundId:(int)soundId filePath:(NSString* _Nonnull)filePath NS_SWIFT_NAME(preloadEffectEx(_:soundId:filePath:));</codeblock>


这个原型跟参数对不上

具体啥问题我看着貌似对的上啊

这个oc和java是有重载方法，这里oc和java应该是带startpos 参数，不带的再另外新建一个文件

dita/RTC-NG/API/api_irtcengineex_removevideowatermarkex.dita

Suri539 · 2025-06-24T10:23:30Z

dita/RTC-NG/API/api_irtcengineex_removevideowatermarkex.dita

+            </plentry>
+            <plentry props="native">
+                <pt props="native">connection</pt>
+                <pd props="android">用于控制不同连接实例的参数。详见 <xref keyref="RtcConnection"/>。</pd>


这个描述也是绝了 llm 不稳定 @Suri539

Suri539 · 2025-06-24T10:25:56Z

dita/RTC-NG/API/api_irtcenginereleasecallback_onenginereleased.dita

+            <codeblock props="flutter" outputclass="language-dart"/> </p>
+        </section>
+        <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
+            <p>该回调在调用 <xref keyref="release_IMusicContentCenter"/> 方法以异步释放 <xref keyref="IRtcEngine"/> 对象时被触发。</p>


这里写错了 api keyref，下面也是

这个暂时只能改下 dita，因为是从该平台 keysmap 里找 keyword 再去拿对应 key，如果 keysmap 有多个同名 key，脚本没有依据判断应该选哪个
我记一下后面想想办法

Suri539 · 2025-06-24T10:28:19Z

dita/RTC-NG/API/api_ivideoeffectobject_getvideoeffectboolparam.dita

+                        <li><codeph><ph keyref="false"/></codeph>：参数未启用或不存在。</li>
+                        </ul>
+                    </p>
+        <p props="android"><ul>


check 下是输入问题还是啥 android 的描述很奇怪 @Suri539

注释写的有问题

Suri539 · 2025-06-24T10:29:55Z

dita/RTC-NG/API/api_ivideoeffectobject_removevideoeffect.dita

+                <pt props="android cpp">nodeId</pt>
+                <pt props="apple">nodeId</pt>
+                <pd props="android">要移除的视频特效节点的唯一标识符。</pd>
+                <pd props="apple">要移除的视频特效节点的唯一标识符，详见 <codeph>AgoraVideoEffectNodeId</codeph>。</pd>


这里描述有问题 @Suri539 不应该有详见

详见没问题，java 需要有详见，6.17 的 json 里面是有的，之后重新跑下scope再看下吧

dita/RTC-NG/API/callback_imediaplayersourceobserver_onagoracdntokenwillexpire.dita

dita/RTC-NG/API/class_cameracapturerconfiguration.dita

dita/RTC-NG/API/class_contentinspectmodule.dita

dita/RTC-NG/API/class_directcdnstreamingmediaoptions.dita

dita/RTC-NG/API/class_directcdnstreamingstats.dita

dita/RTC-NG/API/class_pathstats.dita

Suri539 · 2025-06-24T12:15:12Z

dita/RTC-NG/API/class_streamlayerconfig.dita

+            <parml>
+            <plentry props="android apple">
+                <pt props="android apple">dimensions</pt>
+                <pd props="android">视频帧的尺寸。默认值为 0。详见 <codeph>VideoEncoderConfiguration.VideoDimensions</codeph>。</pd>


详见有问题 @Suri539

dita/RTC-NG/API/class_watermarkbuffer.dita

Suri539 · 2025-06-24T12:20:20Z

dita/RTC-NG/API/class_watermarkconfig.dita

+                <pd props="apple">水印的显示选项，详见 <xref keyref="WatermarkOptions"/>。</pd>
+                <pd props="cpp">水印的选项。详见 <xref keyref="WatermarkOptions"/>。</pd>
+            </plentry>
+            <plentry props="cpp">


这两个要文档不对外 @Suri539

dita/RTC-NG/API/class_watermarkconfig.dita

dita/RTC-NG/API/class_watermarkliteral.dita

dita/RTC-NG/API/class_watermarktimestamp.dita

dita/RTC-NG/API/enum_directcdnstreamingreason.dita

dita/RTC-NG/API/enum_directcdnstreamingstate.dita

Suri539 · 2025-06-24T12:23:15Z

dita/RTC-NG/API/enum_multipathmode.dita

+            <parml>
+            <plentry props="native">
+                <pt><ph keyref="Duplicate"/></pt>
+                <pd props="cpp">（0）：将相同的数据冗余发送至所有可用路径。</pd>


研发补了注释，这里没有同步，cpp 应该前面要加一个冗余发送模式。手动改下 @Suri539

Suri539 · 2025-06-24T12:23:54Z

dita/RTC-NG/API/enum_multipathmode.dita

+            </plentry>
+        <plentry props="native">
+                <pt><ph keyref="Dynamic"/></pt>
+                <pd props="cpp">数据仅通过内部算法判定为传输质量最优的路径进行发送。</pd>


动态发送模式 @Suri539

Suri539 · 2025-06-24T12:24:33Z

dita/RTC-NG/API/enum_renewtokenerrorcode.dita

+            </plentry>
+        <plentry props="native">
+                <pt><ph keyref="RENEW_TOKEN_FAILURE"/></pt>
+                <pd props="cpp">（1）：Token 更新失败。建议用户生成新的 Token 并重新调用 <xref keyref="renewToken_IMusicContentCenter"/>。</pd>


同上，需要手动改 dita

Suri539 · 2025-06-24T12:24:51Z

dita/RTC-NG/API/enum_renewtokenerrorcode.dita

+            </plentry>
+        <plentry props="android cpp">
+                <pt><ph keyref="RENEW_TOKEN_TOKEN_EXPIRED"/></pt>
+                <pd props="cpp">（2）：Token 更新失败，原因是提供的 Token 已过期。建议用户生成一个过期时间更长的新 Token 并重新调用 <xref keyref="renewToken_IMusicContentCenter"/>。</pd>


全量替换下 key

同上，需要手动改 dita

460 v2api

7eaef12

Nero-Hu changed the base branch from master to release/rtc-ng/4.6.0 June 24, 2025 06:55