Merge pull request #3382 from AgoraIO/release/rtc-ng/4.2.3

sync_prototype.py
AgoraIO · Oct 10, 2023 · c8f8a56 · c8f8a56
2 parents d3864ca + 0e6f055
commit c8f8a56
Show file tree

Hide file tree

Showing 872 changed files with 2,980 additions and 3,010 deletions.
diff --git a/.github/workflows/python-app-sync-proto.yml b/.github/workflows/python-app-sync-proto.yml
@@ -28,7 +28,6 @@ jobs:
             - name: sync proto type (cn to en)
               run: |
                   cd xml2json
-                  python sync_prototype.py --src_dir ../dita/RTC/API  --dest_dir ../en-US/dita/RTC/API
                   python sync_prototype.py --src_dir ../dita/RTC-NG/API  --dest_dir ../en-US/dita/RTC-NG/API
             - name: Create Pull Request
               uses: peter-evans/create-pull-request@v4

diff --git a/en-US/dita/RTC-NG/API/api_agoravideoencoderconfiguration_initwithsize.dita b/en-US/dita/RTC-NG/API/api_agoravideoencoderconfiguration_initwithsize.dita
@@ -13,18 +13,18 @@
     <refbody>
         <section id="prototype">
             <p outputclass="codeblock">
-            <codeblock props="android" outputclass="language-java" />
+            <codeblock props="android" outputclass="language-java"/>
             <codeblock props="ios mac" outputclass="language-objectivec">- (instancetype _Nonnull)initWithSize:(CGSize)size
                             frameRate:(AgoraVideoFrameRate)frameRate
                               bitrate:(NSInteger)bitrate
                       orientationMode:(AgoraVideoOutputOrientationMode)orientationMode
                            mirrorMode:(AgoraVideoMirrorMode)mirrorMode;</codeblock>
-            <codeblock props="cpp unreal" outputclass="language-cpp" />
-            <codeblock props="electron" outputclass="language-typescript" />
-            <codeblock props="unity cs" outputclass="language-csharp" />
-            <codeblock props="rn" outputclass="language-typescript" />
-            <codeblock props="flutter" outputclass="language-dart" />
-            <codeblock props="reserve" outputclass="language-cpp" /></p>
+            <codeblock props="cpp unreal" outputclass="language-cpp"/>
+            <codeblock props="electron" outputclass="language-typescript"/>
+            <codeblock props="unity cs" outputclass="language-csharp"/>
+            <codeblock props="rn" outputclass="language-typescript"/>
+            <codeblock props="flutter" outputclass="language-dart"/>
+            <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="parameters">
             <title>Parameters</title>

diff --git a/en-US/dita/RTC-NG/API/api_agoravideoencoderconfiguration_initwithwidth.dita b/en-US/dita/RTC-NG/API/api_agoravideoencoderconfiguration_initwithwidth.dita
@@ -13,19 +13,19 @@
     <refbody>
         <section id="prototype">
             <p outputclass="codeblock">
-            <codeblock props="android" outputclass="language-java" />
+            <codeblock props="android" outputclass="language-java"/>
             <codeblock props="ios mac" outputclass="language-objectivec">- (instancetype _Nonnull)initWithWidth:(NSInteger)width
                                 height:(NSInteger)height
                              frameRate:(AgoraVideoFrameRate)frameRate
                                bitrate:(NSInteger)bitrate
                        orientationMode:(AgoraVideoOutputOrientationMode)orientationMode
                             mirrorMode:(AgoraVideoMirrorMode)mirrorMode;</codeblock>
-            <codeblock props="cpp unreal" outputclass="language-cpp" />
-            <codeblock props="electron" outputclass="language-typescript" />
-            <codeblock props="unity cs" outputclass="language-csharp" />
-            <codeblock props="rn" outputclass="language-typescript" />
-            <codeblock props="flutter" outputclass="language-dart" />
-            <codeblock props="reserve" outputclass="language-cpp" /></p>
+            <codeblock props="cpp unreal" outputclass="language-cpp"/>
+            <codeblock props="electron" outputclass="language-typescript"/>
+            <codeblock props="unity cs" outputclass="language-csharp"/>
+            <codeblock props="rn" outputclass="language-typescript"/>
+            <codeblock props="flutter" outputclass="language-dart"/>
+            <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="parameters">
             <title>Parameters</title>

diff --git a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita
@@ -13,16 +13,16 @@
     <refbody>
         <section id="prototype">
             <p outputclass="codeblock">
-            <codeblock props="android" outputclass="language-java">public Map&lt;String, ChannelMediaInfo&gt; getDestChannelMediaInfos() {
+            <codeblock props="android" outputclass="language-java">public Map&lt;String, ChannelMediaInfo> getDestChannelMediaInfos() {
   return destInfos;
 }</codeblock>
-            <codeblock props="ios mac" outputclass="language-objectivec" />
-            <codeblock props="cpp unreal" outputclass="language-cpp" />
-            <codeblock props="electron" outputclass="language-typescript" />
-            <codeblock props="unity cs" outputclass="language-csharp" />
-            <codeblock props="rn" outputclass="language-typescript" />
-           <codeblock props="flutter" outputclass="language-dart" /> 
-            <codeblock props="reserve" outputclass="language-cpp" /></p>
+            <codeblock props="ios mac" outputclass="language-objectivec"/>
+            <codeblock props="cpp unreal" outputclass="language-cpp"/>
+            <codeblock props="electron" outputclass="language-typescript"/>
+            <codeblock props="unity cs" outputclass="language-csharp"/>
+            <codeblock props="rn" outputclass="language-typescript"/>
+           <codeblock props="flutter" outputclass="language-dart"/> 
+            <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="return_values">
             <title>Returns</title>

diff --git a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getsrcchannelmediainfo.dita b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getsrcchannelmediainfo.dita
@@ -16,13 +16,13 @@
             <codeblock props="android" outputclass="language-java">public ChannelMediaInfo getSrcChannelMediaInfo() {
   return srcInfo;
 }</codeblock>
-            <codeblock props="ios mac" outputclass="language-objectivec" />
-            <codeblock props="cpp unreal" outputclass="language-cpp" />
-            <codeblock props="electron" outputclass="language-typescript" />
-            <codeblock props="unity cs" outputclass="language-csharp" />
-            <codeblock props="rn" outputclass="language-typescript" />
-           <codeblock props="flutter" outputclass="language-dart" /> 
-            <codeblock props="reserve" outputclass="language-cpp" /></p>
+            <codeblock props="ios mac" outputclass="language-objectivec"/>
+            <codeblock props="cpp unreal" outputclass="language-cpp"/>
+            <codeblock props="electron" outputclass="language-typescript"/>
+            <codeblock props="unity cs" outputclass="language-csharp"/>
+            <codeblock props="rn" outputclass="language-typescript"/>
+           <codeblock props="flutter" outputclass="language-dart"/> 
+            <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="return_values">
             <title>Returns</title>

diff --git a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_removedestchannelinfo.dita b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_removedestchannelinfo.dita
@@ -17,12 +17,12 @@
   destInfos.remove(channelName);
 }</codeblock>
             <codeblock props="ios mac" outputclass="language-objectivec">- (BOOL)removeDestinationInfoForChannelName:(NSString *_Nonnull)channelName;</codeblock>
-            <codeblock props="cpp unreal" outputclass="language-cpp" />
-            <codeblock props="electron" outputclass="language-typescript" />
-            <codeblock props="unity cs" outputclass="language-csharp" />
-            <codeblock props="rn" outputclass="language-typescript" />
-           <codeblock props="flutter" outputclass="language-dart" /> 
-            <codeblock props="reserve" outputclass="language-cpp" /></p>
+            <codeblock props="cpp unreal" outputclass="language-cpp"/>
+            <codeblock props="electron" outputclass="language-typescript"/>
+            <codeblock props="unity cs" outputclass="language-csharp"/>
+            <codeblock props="rn" outputclass="language-typescript"/>
+           <codeblock props="flutter" outputclass="language-dart"/> 
+            <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="parameters">
             <title>Parameters</title>

diff --git a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_setdestchannelinfo.dita b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_setdestchannelinfo.dita
@@ -18,12 +18,12 @@
   }</codeblock>
             <codeblock props="ios mac" outputclass="language-objectivec">- (BOOL)setDestinationInfo:(AgoraChannelMediaRelayInfo *_Nonnull)destinationInfo forChannelName:(NSString *_Nonnull)channelName;
 </codeblock>
-            <codeblock props="cpp unreal" outputclass="language-cpp" />
-            <codeblock props="electron" outputclass="language-typescript" />
-            <codeblock props="unity cs" outputclass="language-csharp" />
-            <codeblock props="rn" outputclass="language-typescript" />
-           <codeblock props="flutter" outputclass="language-dart" /> 
-            <codeblock props="reserve" outputclass="language-cpp" /></p>
+            <codeblock props="cpp unreal" outputclass="language-cpp"/>
+            <codeblock props="electron" outputclass="language-typescript"/>
+            <codeblock props="unity cs" outputclass="language-csharp"/>
+            <codeblock props="rn" outputclass="language-typescript"/>
+           <codeblock props="flutter" outputclass="language-dart"/> 
+            <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="parameters">
             <title>Parameters</title>

diff --git a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_setsrcchannelinfo.dita b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_setsrcchannelinfo.dita
@@ -16,13 +16,13 @@
             <codeblock props="android" outputclass="language-java">public void setSrcChannelInfo(ChannelMediaInfo srcInfo) {
   this.srcInfo = srcInfo;
 }</codeblock>
-            <codeblock props="ios mac" outputclass="language-objectivec" />
-            <codeblock props="cpp unreal" outputclass="language-cpp" />
-            <codeblock props="electron" outputclass="language-typescript" />
-            <codeblock props="unity cs" outputclass="language-csharp" />
-            <codeblock props="rn" outputclass="language-typescript" />
-           <codeblock props="flutter" outputclass="language-dart" /> 
-            <codeblock props="reserve" outputclass="language-cpp" /></p>
+            <codeblock props="ios mac" outputclass="language-objectivec"/>
+            <codeblock props="cpp unreal" outputclass="language-cpp"/>
+            <codeblock props="electron" outputclass="language-typescript"/>
+            <codeblock props="unity cs" outputclass="language-csharp"/>
+            <codeblock props="rn" outputclass="language-typescript"/>
+           <codeblock props="flutter" outputclass="language-dart"/> 
+            <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="parameters">
             <title>Parameters</title>

diff --git a/en-US/dita/RTC-NG/API/api_createagorartcengine.dita b/en-US/dita/RTC-NG/API/api_createagorartcengine.dita
@@ -13,8 +13,8 @@
     <refbody>
         <section id="prototype">
             <p outputclass="codeblock">
-            <codeblock props="android" outputclass="language-java" />
-            <codeblock props="ios mac" outputclass="language-objectivec" />
+            <codeblock props="android" outputclass="language-java"/>
+            <codeblock props="ios mac" outputclass="language-objectivec"/>
             <codeblock props="cpp unreal" outputclass="language-cpp">AGORA_API agora::rtc::IRtcEngine *AGORA_CALL createAgoraRtcEngine ()</codeblock>
             <codeblock props="electron" outputclass="language-typescript">export function createAgoraRtcEngine(): IRtcEngineEx {
   return instance;
@@ -29,7 +29,7 @@
             <codeblock props="flutter" outputclass="language-dart">RtcEngine createAgoraRtcEngine() {
   return impl.RtcEngineImpl.create();
 }</codeblock>            
-            <codeblock props="reserve" outputclass="language-cpp" /></p>
+            <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="detailed_desc">
             <title>Details</title>

diff --git a/en-US/dita/RTC-NG/API/api_createagorartcengineex.dita b/en-US/dita/RTC-NG/API/api_createagorartcengineex.dita
@@ -13,19 +13,19 @@
     <refbody>
         <section id="prototype">
             <p outputclass="codeblock">
-            <codeblock props="android" outputclass="language-java" />
-            <codeblock props="ios mac" outputclass="language-objectivec" />
-            <codeblock props="cpp unreal" outputclass="language-cpp" />
-            <codeblock props="electron" outputclass="language-typescript" />
+            <codeblock props="android" outputclass="language-java"/>
+            <codeblock props="ios mac" outputclass="language-objectivec"/>
+            <codeblock props="cpp unreal" outputclass="language-cpp"/>
+            <codeblock props="electron" outputclass="language-typescript"/>
             <codeblock props="unity cs" outputclass="language-csharp">public static IRtcEngineEx CreateAgoraRtcEngineEx()
         {
             return (IRtcEngineEx)(instance ?? (instance = new RtcEngine(IntPtr.Zero)));
         }</codeblock>
-            <codeblock props="rn" outputclass="language-typescript" />
+            <codeblock props="rn" outputclass="language-typescript"/>
             <codeblock props="flutter" outputclass="language-dart">RtcEngineEx createAgoraRtcEngineEx() {
   return impl.RtcEngineImpl.create();
 }</codeblock>
-            <codeblock props="reserve" outputclass="language-cpp" /></p>
+            <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="detailed_desc">
             <title>Details</title>

diff --git a/en-US/dita/RTC-NG/API/api_getmediaplayercachemanager.dita b/en-US/dita/RTC-NG/API/api_getmediaplayercachemanager.dita
@@ -24,7 +24,7 @@
   return new IMediaPlayerCacheManagerImpl();
 }</codeblock>
             <codeblock props="flutter" outputclass="language-dart">MediaPlayerCacheManager getMediaPlayerCacheManager()</codeblock>
-            <codeblock props="reserve" outputclass="language-cpp" /></p>
+            <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="detailed_desc">
             <title>Details</title>

diff --git a/en-US/dita/RTC-NG/API/api_iagoraparameter_setparameters.dita b/en-US/dita/RTC-NG/API/api_iagoraparameter_setparameters.dita
@@ -13,14 +13,14 @@
     <refbody>
         <section id="prototype">
             <p outputclass="codeblock">
-            <codeblock props="android" outputclass="language-java" />
-            <codeblock props="ios mac" outputclass="language-objectivec" />
+            <codeblock props="android" outputclass="language-java"/>
+            <codeblock props="ios mac" outputclass="language-objectivec"/>
             <codeblock props="cpp unreal" outputclass="language-cpp">virtual int setParameters(const char* parameters) = 0;</codeblock>
-            <codeblock props="electron" outputclass="language-typescript" />
+            <codeblock props="electron" outputclass="language-typescript"/>
             <codeblock props="unity cs" outputclass="language-csharp">public abstract int SetParameters(string parameters);</codeblock>
-            <codeblock props="rn" outputclass="language-typescript" />
-            <codeblock props="flutter" outputclass="language-dart" />
-            <codeblock props="reserve" outputclass="language-cpp" /></p>
+            <codeblock props="rn" outputclass="language-typescript"/>
+            <codeblock props="flutter" outputclass="language-dart"/>
+            <codeblock props="reserve" outputclass="language-cpp"/></p>
         </section>
         <section id="detailed_desc">
             <title>Details</title>

diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getapplicationvolume.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getapplicationvolume.dita
@@ -13,14 +13,14 @@
     <refbody>
         <section id="prototype">
             <p outputclass="codeblock">
-            <codeblock props="android" outputclass="language-java" />
-            <codeblock props="ios mac" outputclass="language-objectivec" />
+            <codeblock props="android" outputclass="language-java"/>
+            <codeblock props="ios mac" outputclass="language-objectivec"/>
             <codeblock props="cpp unreal" outputclass="language-cpp">virtual int getApplicationVolume(int&amp; volume) = 0;</codeblock>
-            <codeblock props="electron" outputclass="language-typescript" />
-            <codeblock props="unity cs" outputclass="language-csharp" />
-            <codeblock props="rn" outputclass="language-typescript" />
-           <codeblock props="flutter" outputclass="language-dart" /> 
-            <codeblock props="reserve" outputclass="language-cpp" /></p>
+            <codeblock props="electron" outputclass="language-typescript"/>
+            <codeblock props="unity cs" outputclass="language-csharp"/>
+            <codeblock props="rn" outputclass="language-typescript"/>
+           <codeblock props="flutter" outputclass="language-dart"/> 
+            <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="parameters">
             <title>Parameters</title>

diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getcount.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getcount.dita
@@ -13,14 +13,14 @@
     <refbody>
         <section id="prototype">
             <p outputclass="codeblock">
-            <codeblock props="android" outputclass="language-java" />
-            <codeblock props="ios mac" outputclass="language-objectivec" />
+            <codeblock props="android" outputclass="language-java"/>
+            <codeblock props="ios mac" outputclass="language-objectivec"/>
             <codeblock props="cpp unreal" outputclass="language-cpp">virtual int getCount() = 0;</codeblock>
-            <codeblock props="electron" outputclass="language-typescript" />
-            <codeblock props="unity cs" outputclass="language-csharp" />
-            <codeblock props="rn" outputclass="language-typescript" />
-           <codeblock props="flutter" outputclass="language-dart" /> 
-            <codeblock props="reserve" outputclass="language-cpp" /></p>
+            <codeblock props="electron" outputclass="language-typescript"/>
+            <codeblock props="unity cs" outputclass="language-csharp"/>
+            <codeblock props="rn" outputclass="language-typescript"/>
+           <codeblock props="flutter" outputclass="language-dart"/> 
+            <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="detailed_desc">
             <title>Details</title>

diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdefaultdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdefaultdevice.dita
@@ -16,9 +16,9 @@
             <codeblock props="mac" outputclass="language-objectivec">- (AgoraRtcDeviceInfo* _Nullable)getDefaultAudioDevice:(AgoraMediaDeviceType)type;
 </codeblock>
             <codeblock props="cpp unreal" outputclass="language-cpp">virtual int getDefaultDevice(char deviceName[MAX_DEVICE_ID_LENGTH], char deviceId[MAX_DEVICE_ID_LENGTH]) = 0;</codeblock>
-            <codeblock props="electron" outputclass="language-typescript" />
-            <codeblock props="unity cs" outputclass="language-csharp" />
-            <codeblock props="reserve" outputclass="language-cpp" /></p>
+            <codeblock props="electron" outputclass="language-typescript"/>
+            <codeblock props="unity cs" outputclass="language-csharp"/>
+            <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="detailed_desc" props="cpp">
             <ul><li>This method is for Windows and macOS only.</li>

diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdevice.dita
@@ -20,7 +20,7 @@
             <codeblock props="unity cs" outputclass="language-csharp">public abstract string GetDevice();</codeblock>
             <codeblock props="rn" outputclass="language-typescript" />
             <codeblock props="flutter" outputclass="language-dart">Future&lt;String&gt; getDevice();</codeblock>
-            <codeblock props="reserve" outputclass="language-cpp" /></p>
+            <codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
         </section>
         <section id="parameters" props="cpp unreal bp">
             <title>Parameters</title>