Merge pull request #3703 from AgoraIO/release/rtc-ng/4.4.0

Release/rtc ng/4.4.0
AgoraIO · Jul 15, 2024 · 2e43377 · 2e43377
2 parents ca8d628 + 925dc18
commit 2e43377
Show file tree

Hide file tree

Showing 15 changed files with 530 additions and 73 deletions.
diff --git a/dita/RTC-NG/API/api_irtcengine_statechanged.dita b/dita/RTC-NG/API/api_irtcengine_statechanged.dita
@@ -49,8 +49,9 @@
                 <pd>
                     <p>设备状态：
                     <ul>
-                    <li>0：设备插入，但未使用。</li>
+                    <li>0：设备就绪。</li>
                     <li>1：设备正在使用。</li>
+                    <li>3：设备已插入。</li>
                     <li>8：设备被拔出。</li>
                     </ul></p>
                 </pd>

diff --git a/dita/RTC-NG/API/enum_mediadevicestatetype.dita b/dita/RTC-NG/API/enum_mediadevicestatetype.dita
@@ -19,6 +19,10 @@
                 <pt><ph keyref="MEDIA_DEVICE_STATE_DISABLED"/></pt>
                 <pd>2: 设备被禁用。</pd>
             </plentry>
+            <plentry>
+                <pt><ph keyref="MEDIA_DEVICE_STATE_PLUGGED_IN"/></pt>
+                <pd>3: 设备已插入。</pd>
+            </plentry>
             <plentry>
                 <pt><ph keyref="MEDIA_DEVICE_STATE_NOT_PRESENT"/></pt>
                 <pd>4: 没有此设备。</pd>

diff --git a/dita/RTC-NG/API/rtc_api_sunset.dita b/dita/RTC-NG/API/rtc_api_sunset.dita
diff --git a/dita/RTC-NG/API/rtc_lite_api.dita b/dita/RTC-NG/API/rtc_lite_api.dita
@@ -6,7 +6,7 @@
 <refbody>
     <section><note type="attention">如果在本页中无法查询到你要使用的 API，则代表 Lite SDK 不支持该 API，调用该 API 时会返回错误码 -2。</note></section>
     <section>
-        <title><ph keyref="IRtcEngine"/></title>
+        <title><apiname keyref="IRtcEngine"/></title>
         <ul>
             <li props="android electron flutter rn unity"><xref keyref="addHandler"/></li>
             <li><xref keyref="adjustAudioMixingPlayoutVolume"/></li>
@@ -335,7 +335,7 @@
     </ul>
     </section>
     <section>
-        <title><ph keyref="IRtcEngineEx"/></title>
+        <title><apiname keyref="IRtcEngineEx"/></title>
         <ul>
             <li props="unity flutter"><xref keyref="createAgoraRtcEngineEx"/></li>
             <li props="android cpp unreal unity"><xref keyref="createDataStreamEx1"/></li>
@@ -390,7 +390,7 @@
         </ul>
     </section>
     <section>
-        <title><ph keyref="IRtcEngineEventHandler"/></title>
+        <title><apiname keyref="IRtcEngineEventHandler"/></title>
         <ul>
             <li><xref keyref="onActiveSpeaker"/></li>
             <li props="cpp unreal bp electron unity flutter"><xref keyref="onAudioDeviceStateChanged"/></li>
@@ -479,7 +479,7 @@
         </ul>
     </section>
     <section props="android apple">
-        <title><ph keyref="IMediaExtensionObserver"/></title>
+        <title><apiname keyref="IMediaExtensionObserver"/></title>
         <ul>
             <li><xref keyref="onExtensionErrorWithContext"/></li>
             <li><xref keyref="onExtensionEventWithContext"/></li>
@@ -488,7 +488,7 @@
         </ul>
     </section>
     <section>
-        <title><ph keyref="IMediaPlayer"/></title>
+        <title><apiname keyref="IMediaPlayer"/></title>
         <note type="attention">媒体播放器中的 API 仅支持处理音频媒体文件、不支持处理视频媒体文件。</note>
         <ul>
             <li><xref keyref="adjustPlayoutVolume"/></li>
@@ -547,28 +547,29 @@
         </ul>
     </section>
     <section>
-        <title><ph keyref="IVideoEncodedFrameObserver"/></title>
+        <title><apiname keyref="IVideoEncodedFrameObserver"/></title>
         <ul>
             <li><xref keyref="onEncodedVideoFrameReceived"/></li>
         </ul>
     </section>
     <section>
-        <title><ph keyref="IVideoFrameObserver"/></title>
+        <title><apiname keyref="IVideoFrameObserver"/></title>
+        <note type="attention">通过 <xref keyref="onCaptureVideoFrame"/>、<xref keyref="onPreEncodeVideoFrame"/> 和 <xref keyref="onRenderVideoFrame"/> 回调返回的视频数据中，<parmname>alphabuffer</parmname> 为 <codeph><ph keyref="NULL"/></codeph>。</note>
         <ul>
             <li props="native unreal bp"><xref keyref="getMirrorApplied"/></li>
             <li props="native unreal bp"><xref keyref="getObservedFramePosition"/></li>
             <li props="native unreal bp"><xref keyref="getRotationApplied"/></li>
             <li props="native unreal bp"><xref keyref="getVideoFormatPreference"/></li>
             <li props="native unreal bp"><xref keyref="getVideoFrameProcessMode"/></li>
-            <li><xref keyref="onCaptureVideoFrame"/></li>
             <li props="cpp unreal bp"><xref keyref="onFrame_IVideoFrameObserver"/></li>
             <li props="hide"><xref keyref="onMediaPlayerVideoFrame"/></li>
+            <li><xref keyref="onCaptureVideoFrame"/></li>
             <li><xref keyref="onPreEncodeVideoFrame"/></li>
             <li><xref keyref="onRenderVideoFrame"/></li>
         </ul>
     </section>
     <section>
-        <title><ph keyref="IMediaExtensionObserver"/></title>
+        <title><apiname keyref="IMediaExtensionObserver"/></title>
         <ul>
             <li><xref keyref="onExtensionErrorWithContext"/></li>
             <li><xref keyref="onExtensionEventWithContext"/></li>
@@ -577,7 +578,7 @@
         </ul>
     </section>
     <section>
-        <title><ph keyref="IMusicPlayer"/></title>
+        <title><apiname keyref="IMusicPlayer"/></title>
         <ul>
             <li props="android"><xref keyref="getPlaySrc"/></li>
             <li><xref keyref="open_IMusicPlayer"/></li>

diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap
@@ -9728,6 +9728,13 @@
                 </keywords>
             </topicmeta>
         </keydef>
+        <keydef keys="MEDIA_DEVICE_STATE_PLUGGED_IN">
+            <topicmeta>
+                <keywords>
+                    <keyword>MEDIA_DEVICE_STATE_PLUGGED_IN</keyword>
+                </keywords>
+            </topicmeta>
+        </keydef>
         <keydef keys="MEDIA_DEVICE_STATE_NOT_PRESENT">
             <topicmeta>
                 <keywords>

diff --git a/dita/RTC-NG/config/keys-rtc-ng-links-unity.ditamap b/dita/RTC-NG/config/keys-rtc-ng-links-unity.ditamap
@@ -86,6 +86,5 @@
                 </keywords>
             </topicmeta>
         </keydef>
-        <keydef keys="ticket-link" href="https://agora-ticket.agora.io/" scope="external" format="html"/>
     </topichead>
 </map>
diff --git a/dita/RTC-NG/config/keys-rtc-ng-links.ditamap b/dita/RTC-NG/config/keys-rtc-ng-links.ditamap
@@ -92,14 +92,14 @@
         </keydef>
     </topichead>
     <topichead navtitle="External">
-        <keydef keys="mailto-link" href="mailto:sales@shengwang.cn" scope="external" format="html">
+        <keydef keys="mailto-link" href="https://www.shengwang.cn/contact-sales/" scope="external" format="html">
             <topicmeta>
                 <keywords>
                     <keyword>[email protected]</keyword>
                 </keywords>
             </topicmeta>
         </keydef>
-        <keydef keys="ticket-link" href="ticket.shengwang.cn" scope="external" format="html">
+        <keydef keys="ticket-link" href="https://ticket.shengwang.cn/" scope="external" format="html">
             <topicmeta>
                 <keywords>
                     <keyword>联系技术支持</keyword>

diff --git a/dita/RTC-NG/release/release_notes.dita b/dita/RTC-NG/release/release_notes.dita
@@ -20,19 +20,19 @@
                                 <stentry>现有回调</stentry>
                             </sthead>
                             <strow>
-                                <stentry><codeph>onExtensionEvent</codeph></stentry>
+                                <stentry><codeph props="cpp">onExtensionEvent</codeph><codeph props="apple android">onEvent</codeph></stentry>
                                 <stentry><codeph><apiname keyref="onExtensionEventWithContext"/></codeph></stentry>
                             </strow>
                             <strow>
-                                <stentry><codeph>onExtensionStarted</codeph></stentry>
+                                <stentry><codeph props="apple cpp">onExtensionStarted</codeph><codeph props="android">onStarted</codeph></stentry>
                                 <stentry><codeph><apiname keyref="onExtensionStartedWithContext"/></codeph></stentry>
                             </strow>
                             <strow>
-                                <stentry><codeph>onExtensionStopped</codeph></stentry>
+                                <stentry><codeph props="apple cpp">onExtensionStopped</codeph><codeph props="android">onStopped</codeph></stentry>
                                 <stentry><codeph><apiname keyref="onExtensionStoppedWithContext"/></codeph></stentry>
                             </strow>
                             <strow>
-                                <stentry><codeph>onExtensionError</codeph></stentry>
+                                <stentry><codeph props="apple cpp">onExtensionError</codeph><codeph props="android">onError</codeph></stentry>
                                 <stentry><codeph><apiname keyref="onExtensionErrorWithContext"/></codeph></stentry>
                             </strow>
                         </simpletable>
@@ -42,11 +42,13 @@
                     <li props="android">该版本删除了 <codeph><apiname keyref="onMetadataReceived"/></codeph> 回调中的 <codeph>buffer</codeph>、<codeph>uid</codeph>、<codeph>timeStampMs</codeph> 参数，你可以通过新增的 <codeph>metadata</codeph> 参数来获取 Metadata 的相关信息，包括 <codeph>timeStampMs</codeph>（发送数据的时间戳）、<codeph>uid</codeph>（用户 ID）、<codeph>channelId</codeph>（源频道名称）等。</li>
                     <li props="cpp">该版本修改了 <xref keyref="ExternalVideoFrame"/> 中的以下成员名称：
                         <ul>
-                        <li><parmname>d3d11_texture_2d</parmname> 更名为 <parmname>d3d11Texture2d</parmname>。</li>
-                        <li><parmname>texture_slice_index</parmname> 更名为 <parmname>textureSliceIndex</parmname>。</li>
-                        <li><parmname>metadata_buffer</parmname> 更名为 <parmname>metadataBuffer</parmname>。</li>
-                        <li><parmname>metadata_size</parmname> 更名为 <parmname>metadataSize</parmname>。</li>
+                        <li><codeph>d3d11_texture_2d</codeph> 更名为 <codeph>d3d11Texture2d</codeph>。</li>
+                        <li><codeph>texture_slice_index</codeph> 更名为 <codeph>textureSliceIndex</codeph>。</li>
+                        <li><codeph>metadata_buffer</codeph> 更名为 <codeph>metadataBuffer</codeph>。</li>
+                        <li><codeph>metadata_size</codeph> 更名为 <codeph>metadataSize</codeph>。</li>
                         </ul></li>
+                    <li props="windows">在 v4.4.0 之前，音视频设备已插入、已就绪均会通过 <codeph><apiname keyref="MEDIA_DEVICE_STATE_TYPE"/></codeph> 中的 <codeph><apiname keyref="MEDIA_DEVICE_STATE_IDLE"/></codeph>（0）状态报告。为进一步区分设备状态，自 v4.4.0 起，SDK 会通过新增的 <codeph><apiname keyref="MEDIA_DEVICE_STATE_PLUGGED_IN"/></codeph>（3）报告设备已插入。</li>
+                    <li props="mac">在 v4.4.0 之前，音视频设备已插入、已就绪均会通过 <codeph><apiname keyref="stateChanged"/></codeph> 回调中的 <codeph>state</codeph> 参数报告状态码 <codeph>0</codeph>。为进一步区分设备状态，自 v4.4.0 起，SDK 会通过新增的状态码 <codeph>3</codeph> 报告设备已插入。</li>
                 </ol>
             </body>
         </topic>

diff --git a/en-US/dita/RTC-NG/API/rtc_api_sunset.dita b/en-US/dita/RTC-NG/API/rtc_api_sunset.dita
@@ -78,7 +78,7 @@
                         <row>
                             <entry><xref keyref="setLogFileSize"/></entry>
                             <entry><ph conkeyref="setLogFileSize/shortdesc"/></entry>
-                            <entry>Use the <codeph>logConfig</codeph> parameter in <xref keyref="initialize" /></entry>
+                            <entry>Use the <parmname>logConfig</parmname> parameter in <xref keyref="initialize" /></entry>
                             <entry>v4.0.0</entry>
                         </row>
                         <row props="android apple">
@@ -120,7 +120,7 @@
                         <row>
                             <entry><xref keyref="setLogFile"/></entry>
                             <entry><ph conkeyref="setLogFile/shortdesc"/></entry>
-                            <entry>Use the <codeph>logConfig</codeph> parameter in <xref keyref="initialize" /></entry>
+                            <entry>Use the <parmname>logConfig</parmname> parameter in <xref keyref="initialize" /></entry>
                             <entry>v4.0.0</entry>
                         </row>
                         <row>

diff --git a/en-US/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap b/en-US/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap
@@ -9728,6 +9728,13 @@
                 </keywords>
             </topicmeta>
         </keydef>
+        <keydef keys="MEDIA_DEVICE_STATE_PLUGGED_IN">
+            <topicmeta>
+                <keywords>
+                    <keyword>MEDIA_DEVICE_STATE_PLUGGED_IN</keyword>
+                </keywords>
+            </topicmeta>
+        </keydef>
         <keydef keys="MEDIA_DEVICE_STATE_NOT_PRESENT">
             <topicmeta>
                 <keywords>