Merge branch 'master' into release/showroom

AgoraIO · Sep 12, 2023 · a637bbd · a637bbd
2 parents 8507a98 + 7eca4e6
commit a637bbd
Show file tree

Hide file tree

Showing 15 changed files with 16 additions and 31 deletions.
diff --git a/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita b/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita
@@ -55,7 +55,8 @@
                 <pd>在服务端生成的用于鉴权的动态密钥。详见<xref keyref="guide-token"/>。
                 <p>Token 过期后，根据预加载频道的数量，你可以通过不同方式来传入用于预加载频道的新 Token：
                 <ul><li>预加载一个频道时：调用此方法来传入新的 Token。</li>
-                <li>预加载多个频道时：<ul><li>如果你使用了通配的 Token，调用 <xref keyref="updatePreloadChannelToken"/> 来更新所有预加载频道的 Token。</li>
+                <li>预加载多个频道时：<ul><li>如果你使用了通配的 Token，调用 <xref keyref="updatePreloadChannelToken"/> 来更新所有预加载频道的 Token。
+                <note type="note" id="uid">生成通配 Token 时，用户 ID 不得设为 0。详见 <xref keyref="wildcard-token"/>。</note></li>
                 <li>如果你使用了不同的 Token：调用此方法并传入你的用户 ID、对应的频道名和更新后的 Token。</li></ul></li></ul></p>
                 </pd>
             </plentry>

diff --git a/dita/RTC-NG/API/class_videoencoderconfiguration.dita b/dita/RTC-NG/API/class_videoencoderconfiguration.dita
@@ -136,7 +136,6 @@
   public static final int DEFAULT_MIN_BITRATE_EQUAL_TO_TARGET_BITRATE = -2;
   public VideoDimensions dimensions;
   public int frameRate;
-  public int minFrameRate;
   public int bitrate;
   public int minBitrate;
   public ORIENTATION_MODE orientationMode;
@@ -146,7 +145,6 @@
   public VideoEncoderConfiguration() {
     this.dimensions = new VideoDimensions(640, 480);
     this.frameRate = FRAME_RATE.FRAME_RATE_FPS_15.getValue();
-    this.minFrameRate = DEFAULT_MIN_FRAMERATE;
     this.bitrate = STANDARD_BITRATE;
     this.minBitrate = DEFAULT_MIN_BITRATE;
     this.orientationMode = ORIENTATION_MODE.ORIENTATION_MODE_ADAPTIVE;
@@ -159,7 +157,6 @@
       ORIENTATION_MODE orientationMode) {
     this.dimensions = dimensions;
     this.frameRate = frameRate.getValue();
-    this.minFrameRate = DEFAULT_MIN_FRAMERATE;
     this.bitrate = bitrate;
     this.minBitrate = DEFAULT_MIN_BITRATE;
     this.orientationMode = orientationMode;
@@ -172,7 +169,6 @@
       ORIENTATION_MODE orientationMode, MIRROR_MODE_TYPE mirrorMode) {
     this.dimensions = dimensions;
     this.frameRate = frameRate.getValue();
-    this.minFrameRate = DEFAULT_MIN_FRAMERATE;
     this.bitrate = bitrate;
     this.minBitrate = DEFAULT_MIN_BITRATE;
     this.orientationMode = orientationMode;
@@ -185,7 +181,6 @@
       int width, int height, FRAME_RATE frameRate, int bitrate, ORIENTATION_MODE orientationMode) {
     this.dimensions = new VideoDimensions(width, height);
     this.frameRate = frameRate.getValue();
-    this.minFrameRate = DEFAULT_MIN_FRAMERATE;
     this.bitrate = bitrate;
     this.minBitrate = DEFAULT_MIN_BITRATE;
     this.orientationMode = orientationMode;
@@ -198,7 +193,6 @@
       ORIENTATION_MODE orientationMode, MIRROR_MODE_TYPE mirrorMode) {
     this.dimensions = new VideoDimensions(width, height);
     this.frameRate = frameRate.getValue();
-    this.minFrameRate = DEFAULT_MIN_FRAMERATE;
     this.bitrate = bitrate;
     this.minBitrate = DEFAULT_MIN_BITRATE;
     this.orientationMode = orientationMode;
@@ -481,10 +475,6 @@
                 <pt>frameRate</pt>
                 <pd>视频编码的帧率(fps)，默认值为 15。详见 <xref keyref="FRAME_RATE"/>。</pd>
             </plentry>
-            <plentry props="native unreal bp">
-                <pt>minFramerate</pt>
-                <pd>视频的最小帧率。默认值为 -1。</pd>
-            </plentry>
             <plentry>
                 <pt>bitrate</pt>
                 <pd>

diff --git a/dita/RTC-NG/API/rtc_api_overview_ng.dita b/dita/RTC-NG/API/rtc_api_overview_ng.dita
@@ -1937,7 +1937,7 @@
             <strow props="electron flutter rn unity">
                 <stentry><xref keyref="sendMetaData"/></stentry>
                 <stentry><ph conkeyref="sendMetaData/shortdesc"/></stentry>
-            </strow>    
+            </strow>
             </simpletable> <simpletable>
             <sthead>
                 <stentry>事件</stentry>
@@ -2562,7 +2562,7 @@
                 <stentry><xref keyref="setApplicationMute"/></stentry>
                 <stentry><ph conkeyref="setApplicationMute/shortdesc"/></stentry>
             </strow>
-            <strow>
+            <strow props="hide">
                 <stentry><xref keyref="isApplicationMute"/></stentry>
                 <stentry><ph conkeyref="isApplicationMute/shortdesc"/></stentry>
             </strow>

diff --git a/dita/RTC-NG/RTC_NG_API_Blueprint.ditamap b/dita/RTC-NG/RTC_NG_API_Blueprint.ditamap
@@ -568,7 +568,7 @@
             <topicref keyref="getRecordingDeviceInfo" toc="no"/>
             <topicref keyref="getRecordingDeviceMute" toc="no" props="hide"/>
             <topicref keyref="getRecordingDeviceVolume" toc="no" props="hide"/>
-            <topicref keyref="isApplicationMute" toc="no"/>
+            <topicref keyref="isApplicationMute" toc="no" props="hide"/>
             <topicref keyref="isSpeakerphoneEnabled" toc="no"/>
             <topicref keyref="release_IAudioDeviceCollection" toc="no"/>
             <topicref keyref="release_IAudioDeviceManager" toc="no"/>

diff --git a/dita/RTC-NG/RTC_NG_API_CPP.ditamap b/dita/RTC-NG/RTC_NG_API_CPP.ditamap
@@ -576,7 +576,7 @@
             <topicref keyref="getRecordingDeviceInfo" toc="no"/>
             <topicref keyref="getRecordingDeviceMute" toc="no" props="hide"/>
             <topicref keyref="getRecordingDeviceVolume" toc="no" props="hide"/>
-            <topicref keyref="isApplicationMute" toc="no"/>
+            <topicref keyref="isApplicationMute" toc="no" props="hide"/>
             <topicref keyref="isSpeakerphoneEnabled" toc="no"/>
             <topicref keyref="release_IAudioDeviceCollection" toc="no"/>
             <topicref keyref="release_IAudioDeviceManager" toc="no"/>

diff --git a/dita/RTC-NG/RTC_NG_API_Unreal.ditamap b/dita/RTC-NG/RTC_NG_API_Unreal.ditamap
@@ -568,7 +568,7 @@
             <topicref keyref="getRecordingDeviceInfo" toc="no"/>
             <topicref keyref="getRecordingDeviceMute" toc="no" props="hide"/>
             <topicref keyref="getRecordingDeviceVolume" toc="no" props="hide"/>
-            <topicref keyref="isApplicationMute" toc="no"/>
+            <topicref keyref="isApplicationMute" toc="no" props="hide"/>
             <topicref keyref="isSpeakerphoneEnabled" toc="no"/>
             <topicref keyref="release_IAudioDeviceCollection" toc="no"/>
             <topicref keyref="release_IAudioDeviceManager" toc="no"/>

diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-blueprint.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-blueprint.ditamap
@@ -3204,7 +3204,7 @@
                     </keywords>
                 </topicmeta>
             </keydef>
-            <keydef keys="isApplicationMute" href="../API/api_iaudiodevicecollection_isapplicationmute.dita">
+            <keydef keys="isApplicationMute" href="../API/api_iaudiodevicecollection_isapplicationmute.dita" prop="hide">
                 <topicmeta>
                     <keywords>
                         <keyword>isApplicationMute</keyword>

diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap
@@ -3225,7 +3225,7 @@
                     </keywords>
                 </topicmeta>
             </keydef>
-            <keydef keys="isApplicationMute" href="../API/api_iaudiodevicecollection_isapplicationmute.dita">
+            <keydef keys="isApplicationMute" href="../API/api_iaudiodevicecollection_isapplicationmute.dita" props="hide">
                 <topicmeta>
                     <keywords>
                         <keyword>isApplicationMute</keyword>

diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap
@@ -508,7 +508,7 @@
             <keydef keys="getMute" href="../API/api_imediaplayer_getmute.dita">
                 <topicmeta>
                     <keywords>
-                        <keyword>isMuted</keyword>
+                        <keyword>getMute</keyword>
                     </keywords>
                 </topicmeta>
             </keydef>
@@ -9744,7 +9744,7 @@
                 </keywords>
             </topicmeta>
         </keydef>
-        
+
         <keydef keys="REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY">
             <topicmeta>
                 <keywords>

diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-unreal.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-unreal.ditamap
@@ -3204,7 +3204,7 @@
                     </keywords>
                 </topicmeta>
             </keydef>
-            <keydef keys="isApplicationMute" href="../API/api_iaudiodevicecollection_isapplicationmute.dita">
+            <keydef keys="isApplicationMute" href="../API/api_iaudiodevicecollection_isapplicationmute.dita" prop="hide">
                 <topicmeta>
                     <keywords>
                         <keyword>isApplicationMute</keyword>

diff --git a/dita/RTC-NG/config/relations-rtc-ng-api.ditamap b/dita/RTC-NG/config/relations-rtc-ng-api.ditamap
@@ -2835,7 +2835,7 @@
                 <topicref keyref="getCount_IAudioDeviceCollection"/>
                 <topicref keyref="getDefaultDevice_IAudioDeviceCollection"/>
                 <topicref keyref="getDevice_IAudioDeviceCollection"/>
-                <topicref keyref="isApplicationMute"/>
+                <topicref keyref="isApplicationMute" props="hide"/>
                 <topicref keyref="release_IAudioDeviceCollection"/>
                 <topicref keyref="setApplicationMute"/>
                 <topicref keyref="setApplicationVolume"/>

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_videoencoderconfiguration.dita b/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita
@@ -136,7 +136,6 @@
   public static final int DEFAULT_MIN_BITRATE_EQUAL_TO_TARGET_BITRATE = -2;
   public VideoDimensions dimensions;
   public int frameRate;
-  public int minFrameRate;
   public int bitrate;
   public int minBitrate;
   public ORIENTATION_MODE orientationMode;
@@ -146,7 +145,6 @@
   public VideoEncoderConfiguration() {
     this.dimensions = new VideoDimensions(640, 480);
     this.frameRate = FRAME_RATE.FRAME_RATE_FPS_15.getValue();
-    this.minFrameRate = DEFAULT_MIN_FRAMERATE;
     this.bitrate = STANDARD_BITRATE;
     this.minBitrate = DEFAULT_MIN_BITRATE;
     this.orientationMode = ORIENTATION_MODE.ORIENTATION_MODE_ADAPTIVE;
@@ -159,7 +157,6 @@
       ORIENTATION_MODE orientationMode) {
     this.dimensions = dimensions;
     this.frameRate = frameRate.getValue();
-    this.minFrameRate = DEFAULT_MIN_FRAMERATE;
     this.bitrate = bitrate;
     this.minBitrate = DEFAULT_MIN_BITRATE;
     this.orientationMode = orientationMode;
@@ -172,7 +169,6 @@
       ORIENTATION_MODE orientationMode, MIRROR_MODE_TYPE mirrorMode) {
     this.dimensions = dimensions;
     this.frameRate = frameRate.getValue();
-    this.minFrameRate = DEFAULT_MIN_FRAMERATE;
     this.bitrate = bitrate;
     this.minBitrate = DEFAULT_MIN_BITRATE;
     this.orientationMode = orientationMode;
@@ -185,7 +181,6 @@
       int width, int height, FRAME_RATE frameRate, int bitrate, ORIENTATION_MODE orientationMode) {
     this.dimensions = new VideoDimensions(width, height);
     this.frameRate = frameRate.getValue();
-    this.minFrameRate = DEFAULT_MIN_FRAMERATE;
     this.bitrate = bitrate;
     this.minBitrate = DEFAULT_MIN_BITRATE;
     this.orientationMode = orientationMode;
@@ -198,7 +193,6 @@
       ORIENTATION_MODE orientationMode, MIRROR_MODE_TYPE mirrorMode) {
     this.dimensions = new VideoDimensions(width, height);
     this.frameRate = frameRate.getValue();
-    this.minFrameRate = DEFAULT_MIN_FRAMERATE;
     this.bitrate = bitrate;
     this.minBitrate = DEFAULT_MIN_BITRATE;
     this.orientationMode = orientationMode;