Merge pull request #3867 from AgoraIO/4.5.0-bugfix-1220

4.5.0 bugfix 1220
AgoraIO · Dec 26, 2024 · 9bbcc94 · 9bbcc94
2 parents 0800369 + 5928cd7
commit 9bbcc94
Show file tree

Hide file tree

Showing 14 changed files with 71 additions and 15 deletions.
diff --git a/dita/RTC-NG/API/api_irtcengine_createdatastream.dita b/dita/RTC-NG/API/api_irtcengine_createdatastream.dita
@@ -27,8 +27,9 @@
         </section>
         <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
             <p id="desc">你可以调用该方法创建数据流并提高数据传输的可靠性和有序性。</p>
+            <note conkeyref="createDataStream2/note" props="android apple cpp unity flutter"/>
         </section>
-        <section id="timing" deliveryTarget="details" conkeyref="createDataStream2/timing"/> 
+        <section id="timing" deliveryTarget="details" conkeyref="createDataStream2/timing"/>
         <section id="restriction" deliveryTarget="details" conkeyref="createDataStream2/restriction"/>
         <section id="related" deliveryTarget="details">
             <title>相关回调</title>

diff --git a/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita b/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita
@@ -28,6 +28,7 @@
         </section>
         <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
             <p props="android cpp apple unreal unity cs">相比 <xref keyref="createDataStream1" />，本方法不保证数据传输的可靠性。接收方会丢弃超出发送时间 5 秒后的数据包。</p>
+            <note type="attention" id="note" props="android apple cpp unity flutter">如你需要更加全面的低延时、高并发、可扩展的实时消息及状态同步解决方案，推荐使用<xref keyref="rtm2"/>。</note>
         </section>
         <section id="timing" deliveryTarget="details">
             <title>调用时机</title>

diff --git a/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita b/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita
@@ -35,6 +35,7 @@
         </section>
         <section id="detailed_desc">
             <title>详情</title>
+            <note conkeyref="createDataStream2/note" props="android apple cpp unity flutter"/>
             <p>调用 <xref keyref="createDataStream2" /> 后，你可以调用该方法向频道内所有用户发送数据流消息。</p>
             <p id="limit">SDK 对该方法的实现进行了如下限制：
             <ul>

diff --git a/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita b/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita
@@ -36,6 +36,7 @@
         </section>
         <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
             <p props="android cpp apple unreal unity cs">相比 <xref keyref="createDataStreamEx1" />，本方法不保证数据传输的可靠性。接收方会丢弃超出发送时间 5 秒后的数据包。</p>
+            <note conkeyref="createDataStream2/note" props="android apple cpp unity flutter"/>
         </section>
         <section id="timing" deliveryTarget="details">
             <title>调用时机</title>

diff --git a/dita/RTC-NG/API/api_irtcengineex_sendstreammessageex.dita b/dita/RTC-NG/API/api_irtcengineex_sendstreammessageex.dita
@@ -41,6 +41,7 @@
             <p conkeyref="sendStreamMessage/error"/>
             <note type="attention">
             <ul>
+            <li props="android apple cpp unity flutter">如你需要更加全面的低延时、高并发、可扩展的实时消息及状态同步解决方案，推荐使用<xref keyref="rtm2"/>。</li>
             <li>该方法需要在 <xref keyref="joinChannelEx"/> 后调用。</li>
             <li>请确保在调用该方法前，已调用 <apiname keyref="createDataStreamEx2" /> 创建了数据通道。</li>
             <li>该方法仅适用于通信场景以及直播场景下的主播用户，如果直播场景下的观众调用此方法可能会造成观众变主播。</li>

diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessage.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessage.dita
@@ -50,6 +50,7 @@
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="detailed_desc">
+        <note conkeyref="createDataStream2/note" props="android apple cpp unity flutter"/>
             <p>
                 该回调表示本地用户收到了远端用户调用 <xref keyref="sendStreamMessage" /> 方法发送的流消息。
             </p>

diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessageerror.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessageerror.dita
@@ -53,6 +53,7 @@
             <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="detailed_desc">
+        <note conkeyref="createDataStream2/note" props="android apple cpp unity flutter"/>
             <p>
                 该回调表示本地用户未收到远端用户调用 <xref keyref="sendStreamMessage" /> 方法发送的流消息。</p>
         </section>

diff --git a/dita/RTC-NG/API/class_transcodingvideostream.dita b/dita/RTC-NG/API/class_transcodingvideostream.dita
@@ -32,27 +32,27 @@
   }
 };</codeblock>
             <codeblock props="hmos" outputclass="language-arkts">export class TranscodingVideoStream {
-  
+
   public remoteUserUid:number;
-  
+
   public  sourceType:Constants.VideoSourceType;
-  
+
   public imageUrl:string;
-  
+
   public mediaPlayerId:number;
-  
+
   public x:number;
-  
+
   public y:number;
-  
+
   public width:number;
-  
+
   public height:number;
-  
+
   public zOrder:number;
-  
+
   public alpha:number;
-  
+
   public mirror:boolean;
   public constructor() {
     this.remoteUserUid = 0;
@@ -143,7 +143,7 @@ public:
 		mirror = AgoraData.mirror;
 	}
 	agora::rtc::TranscodingVideoStream CreateAgoraData() const{
-		
+
 		agora::rtc::TranscodingVideoStream AgoraData;
 		AgoraData.sourceType = static_cast&lt;agora::rtc::VIDEO_SOURCE_TYPE&gt;(sourceType);
 		AgoraData.remoteUserUid = remoteUserUid;
@@ -295,8 +295,15 @@ class TranscodingVideoStream {
             <plentry>
                 <pt>imageUrl</pt>
                 <pd>
-                    <p>图像的 URL。
-                    <note type="attention">请仅在参与本地合图的视频源类型为图片时，使用该参数。</note></p>
+                    <p>本地图片的路径。</p>
+                    <note type="attention">请仅在参与本地合图的视频源类型为图片时，使用该参数。</note>
+                    <p props="android ios mac cpp framework">示例路径：
+                    <ul>
+                        <li props="android unity flutter rn cs">Android: <codeph>/storage/emulated/0/Pictures/image.png</codeph></li>
+                        <li props="ios unity flutter rn cs">iOS: <codeph>/var/mobile/Containers/Data/Application/&lt;APP-UUID>/Documents/image.png</codeph></li>
+                        <li props="mac unity flutter electron cs">macOS: <codeph>~/Pictures/image.png</codeph></li>
+                        <li props="cpp unreal bp unity flutter electron cs">Windows: <codeph>C:\\Users\\{username}\\Pictures\\image.png</codeph></li>
+                    </ul></p>
                 </pd>
             </plentry>
             <plentry>

diff --git a/dita/RTC-NG/config/keys-rtc-ng-links-android.ditamap b/dita/RTC-NG/config/keys-rtc-ng-links-android.ditamap
@@ -129,6 +129,13 @@
                 </keywords>
             </topicmeta>
         </keydef>
+        <keydef keys="rtm2" href="https://doc.shengwang.cn/doc/rtm2/android/landing-page" scope="external" format="html">
+            <topicmeta>
+                <keywords>
+                    <keyword>实时消息</keyword>
+                </keywords>
+            </topicmeta>
+        </keydef>
     </topichead>
     <topichead navtitle="External">
         <keydef keys="filePath-link" href="https://developer.android.google.cn/guide/topics/media/media-formats?hl=zh-cn" scope="external" format="html"/>

diff --git a/dita/RTC-NG/config/keys-rtc-ng-links-cpp.ditamap b/dita/RTC-NG/config/keys-rtc-ng-links-cpp.ditamap
@@ -109,6 +109,13 @@
                 </keywords>
             </topicmeta>
         </keydef>
+        <keydef keys="rtm2" href="https://doc.shengwang.cn/doc/rtm2/cpp/landing-page" scope="external" format="html">
+            <topicmeta>
+                <keywords>
+                    <keyword>实时消息</keyword>
+                </keywords>
+            </topicmeta>
+        </keydef>
     </topichead>
     <topichead navtitle="External">
         <keydef keys="filePath-link" href="https://docs.microsoft.com/zh-cn/windows/win32/medfound/supported-media-formats-in-media-foundation" scope="external" format="html"/>

diff --git a/dita/RTC-NG/config/keys-rtc-ng-links-flutter.ditamap b/dita/RTC-NG/config/keys-rtc-ng-links-flutter.ditamap
@@ -74,6 +74,13 @@
             </keywords>
         </topicmeta>
     </keydef>
+        <keydef keys="rtm2" href="https://doc.shengwang.cn/doc/rtm2/flutter/landing-page" scope="external" format="html">
+            <topicmeta>
+                <keywords>
+                    <keyword>实时消息</keyword>
+                </keywords>
+            </topicmeta>
+        </keydef>
     <!-- <keydef keys="advanced-beauty" href="https://doc.shengwang.cn/doc/rtc/rn/advanced-features/advanced-beauty" scope="external" format="html">
             <topicmeta>
                 <keywords>

diff --git a/dita/RTC-NG/config/keys-rtc-ng-links-ios.ditamap b/dita/RTC-NG/config/keys-rtc-ng-links-ios.ditamap
@@ -123,6 +123,13 @@
                 </keywords>
             </topicmeta>
         </keydef>
+        <keydef keys="rtm2" href="https://doc.shengwang.cn/doc/rtm2/ios/landing-page" scope="external" format="html">
+            <topicmeta>
+                <keywords>
+                    <keyword>实时消息</keyword>
+                </keywords>
+            </topicmeta>
+        </keydef>
     <topichead navtitle="External">
         <keydef keys="filePath-link" href="https://developer.apple.com/library/archive/documentation/AudioVideo/Conceptual/MultimediaPG/UsingAudio/UsingAudio.html#//apple_ref/doc/uid/TP40009767-CH2-SW28" scope="external" format="html"/>
         <keydef keys="rect-link" href="https://developer.apple.com/documentation/corefoundation/cgrect" scope="external" format="html">

diff --git a/dita/RTC-NG/config/keys-rtc-ng-links-macos.ditamap b/dita/RTC-NG/config/keys-rtc-ng-links-macos.ditamap
@@ -95,6 +95,13 @@
                 </keywords>
             </topicmeta>
         </keydef>
+        <keydef keys="rtm2" href="https://doc.shengwang.cn/doc/rtm2/ios/landing-page" scope="external" format="html">
+            <topicmeta>
+                <keywords>
+                    <keyword>实时消息</keyword>
+                </keywords>
+            </topicmeta>
+        </keydef>
     <topichead navtitle="External">
         <keydef keys="filePath-link" href="https://developer.apple.com/library/archive/documentation/MusicAudio/Conceptual/CoreAudioOverview/SupportedAudioFormatsMacOSX/SupportedAudioFormatsMacOSX.html" scope="external" format="html"/>
         <keydef keys="nsimage-link" href="https://developer.apple.com/documentation/appkit/nsimage?language=objc" scope="external" format="html">

diff --git a/dita/RTC-NG/config/keys-rtc-ng-links-unity.ditamap b/dita/RTC-NG/config/keys-rtc-ng-links-unity.ditamap
@@ -68,6 +68,13 @@
                 </keywords>
             </topicmeta>
         </keydef>
+        <keydef keys="rtm2" href="https://doc.shengwang.cn/doc/rtm2/unity/landing-page" scope="external" format="html">
+            <topicmeta>
+                <keywords>
+                    <keyword>实时消息</keyword>
+                </keywords>
+            </topicmeta>
+        </keydef>
         <!-- <keydef keys="advanced-beauty" href="https://doc.shengwang.cn/doc/rtc/rn/advanced-features/advanced-beauty" scope="external" format="html">
             <topicmeta>
                 <keywords>