Merge branch 'master' of github.com:AgoraIO/agora_doc_source

AgoraIO · Sep 11, 2023 · 508fbd6 · 508fbd6
2 parents 9569dea + 88bb815
commit 508fbd6
Show file tree

Hide file tree

Showing 7 changed files with 28 additions and 28 deletions.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita
@@ -37,7 +37,7 @@
         <section id="detailed_desc">
             <title>Details</title>
             <p>You can call this method before sharing a screen or window to get a list of shareable screens and windows, which enables a user to use thumbnails in the list to easily choose a particular screen or window to share. This list also contains important information such as window ID and screen ID, with which you can call <xref keyref="startScreenCaptureByWindowId" /> or <xref keyref="startScreenCaptureByDisplayId" /> to start the sharing.</p>
-            <note type="note" props="cpp unreal bp unity flutter">This method applies to macOS and Windows only.</note> 
+            <note type="note" props="cpp unreal bp unity flutter">This method applies to macOS and Windows only.</note>
             </section>
         <section id="parameters">
             <title>Parameters</title>

diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita
@@ -53,7 +53,7 @@
             <plentry id="token">
                 <pt>token</pt>
                 <pd>The token generated on your server for authentication. See <xref keyref="guide-token" />.<p>When the token for preloading channels expires, you can update the token based on the number of channels you preload.<ul><li>When preloading one channel, calling this method to pass in the new token.</li>
-                <li>When preloading more than one channels:<ul><li>If you use a wildcard token for all preloaded channels, call <xref keyref="updatePreloadChannelToken" /> to update the token.</li>
+                <li>When preloading more than one channels:<ul><li>If you use a wildcard token for all preloaded channels, call <xref keyref="updatePreloadChannelToken" /> to update the token.<note type="note" id="uid">When generating a wildcard token, ensure the user ID is not set as 0. See <xref keyref="wildcard-token" />.</note></li>
                 <li>If you use different tokens to preload different channels, call this method to pass in your user ID, channel name and the new token.</li></ul></li></ul></p>
                 </pd>
             </plentry>

diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita
@@ -45,7 +45,7 @@
                 <li>Call this method before joining a channel, and then call <xref keyref="joinChannel2" /> to join a channel and set <parmname>publishScreenTrack</parmname> or <parmname>publishSecondaryScreenTrack</parmname> to <codeph><ph keyref="true" /></codeph> to start screen sharing.</li>
                 <li>Call this method after joining a channel, and then call <xref keyref="updateChannelMediaOptions" /> and set <parmname>publishScreenTrack</parmname> or <parmname>publishSecondaryScreenTrack</parmname> to <codeph><ph keyref="true" /></codeph> to start screen sharing.</li>
                 </ul></p>
-            <note type="attention" props="cpp unreal bp flutter unity">This method is for Windows and macOS only.</note> 
+            <note type="attention" props="cpp unreal bp flutter unity">This method is for Windows and macOS only.</note>
         </section>
         <section id="parameters">
             <title>Parameters</title>

diff --git a/en-US/dita/RTC-NG/API/class_audioparams.dita b/en-US/dita/RTC-NG/API/class_audioparams.dita
@@ -40,13 +40,13 @@
   AudioParams(int samplerate, int channel, rtc::RAW_AUDIO_FRAME_OP_MODE_TYPE type, int samplesPerCall) : sample_rate(samplerate), channels(channel), mode(type), samples_per_call(samplesPerCall) {}
 };</codeblock>
             <codeblock props="electron" outputclass="language-typescript">export class AudioParams {
-  
+
   sample_rate?: number;
-  
+
   channels?: number;
-  
+
   mode?: RawAudioFrameOpModeType;
-  
+
   samples_per_call?: number;
 }</codeblock>
             <codeblock props="unity cs" outputclass="language-csharp">public class AudioParams
@@ -73,13 +73,13 @@
         }
     };</codeblock>
             <codeblock props="rn" outputclass="language-typescript">export class AudioParams {
-  
+
   sample_rate?: number;
-  
+
   channels?: number;
-  
+
   mode?: RawAudioFrameOpModeType;
-  
+
   samples_per_call?: number;
 }</codeblock>
             <codeblock props="flutter" outputclass="language-dart">class AudioParams {

diff --git a/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita b/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita
@@ -135,11 +135,11 @@
   }
 };</codeblock>
       <codeblock props="electron" outputclass="language-typescript">export class CameraCapturerConfiguration {
-  
+
   cameraDirection?: CameraDirection;
-  
+
   deviceId?: string;
-  
+
   format?: VideoFormat;
 
   followEncodeDimensionRatio?: boolean;
@@ -170,11 +170,11 @@
         public CAMERA_DIRECTION cameraDirection { set; get; }
     }</codeblock>
       <codeblock props="rn" outputclass="language-typescript">export class CameraCapturerConfiguration {
-  
+
   cameraDirection?: CameraDirection;
-  
+
   deviceId?: string;
-  
+
   format?: VideoFormat;
 
   followEncodeDimensionRatio?: boolean;
@@ -203,7 +203,7 @@
       _$CameraCapturerConfigurationFromJson(json);
 
   Map&lt;String, dynamic&gt; toJson() =&gt; _$CameraCapturerConfigurationToJson(this);
-}</codeblock>            
+}</codeblock>
             <codeblock props="reserve" outputclass="language-cpp" /></p>
     </section>
     <section id="parameters">

diff --git a/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita b/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita
@@ -224,7 +224,7 @@
       _$ScreenCaptureParametersFromJson(json);
 
   Map&lt;String, dynamic&gt; toJson() =&gt; _$ScreenCaptureParametersToJson(this);
-}</codeblock>            
+}</codeblock>
             <codeblock props="reserve" outputclass="language-cpp" /></p>
         </section>
         <section id="parameters">

diff --git a/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita b/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita
@@ -40,21 +40,21 @@
 #endif
 };</codeblock>
             <codeblock props="electron" outputclass="language-typescript">export class ScreenCaptureSourceInfo {
-  
+
   type?: ScreenCaptureSourceType;
-  
+
   sourceId?: any;
-  
+
   sourceName?: string;
-  
+
   thumbImage?: ThumbImageBuffer;
-  
+
   iconImage?: ThumbImageBuffer;
-  
+
   processPath?: string;
-  
+
   sourceTitle?: string;
-  
+
   primaryMonitor?: boolean;
 
   position?: Rectangle;
@@ -128,7 +128,7 @@
       _$ScreenCaptureSourceInfoFromJson(json);
 
   Map&lt;String, dynamic&gt; toJson() =&gt; _$ScreenCaptureSourceInfoToJson(this);
-}</codeblock>            
+}</codeblock>
             <codeblock props="reserve" outputclass="language-cpp" /></p>
         </section>
         <section id="parameters">