Merge branch '4.2.2-bugfix-0803' of https://github.com/AgoraIO/agora_…

…doc_source into 4.2.2-bugfix-0803
AgoraIO · Aug 3, 2023 · b715df0 · b715df0
2 parents 09c1a90 + 3bed4ff
commit b715df0
Show file tree

Hide file tree

Showing 8 changed files with 21 additions and 19 deletions.
diff --git a/dita/RTC-NG/API/api_imusiccontentcenter_createmusicplayer.dita b/dita/RTC-NG/API/api_imusiccontentcenter_createmusicplayer.dita
@@ -14,7 +14,7 @@
         <section id="prototype">
             <p outputclass="codeblock">
             <codeblock props="android" outputclass="language-java">public abstract IAgoraMusicPlayer createMusicPlayer();</codeblock>
-            <codeblock props="ios mac" outputclass="language-objectivec">- (id&lt;AgoraMusicPlayerProtocol>)createMusicPlayerWithDelegate:(id&lt;AgoraRtcMediaPlayerDelegate>_Nullable)delegate NS_SWIFT_NAME(createMusicPlayer(delegate:));</codeblock>
+            <codeblock props="ios mac" outputclass="language-objectivec">- (id&lt;AgoraMusicPlayerProtocol> _Nullable)createMusicPlayerWithDelegate:(id&lt;AgoraRtcMediaPlayerDelegate> _Nullable)delegate NS_SWIFT_NAME(createMusicPlayer(delegate:));</codeblock>
             <codeblock props="cpp unreal bp" outputclass="language-cpp">virtual agora_refptr&lt;IMusicPlayer> createMusicPlayer() = 0;</codeblock>
             <codeblock props="electron" outputclass="language-typescript">abstract createMusicPlayer(): IMusicPlayer;</codeblock>
             <codeblock props="unity cs" outputclass="language-csharp">public abstract IMusicPlayer CreateMusicPlayer();</codeblock>

diff --git a/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita b/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita
@@ -65,7 +65,8 @@ int JoinChannel(FString token, FString channelId, int64 uid, const FChannelMedia
             <parml>
             <plentry id="token">
                 <pt>token</pt>
-                <pd>在服务端生成的用于鉴权的动态密钥。详见<xref keyref="guide-token"/>。</pd>
+                <pd>在服务端生成的用于鉴权的动态密钥。详见<xref keyref="guide-token"/>。
+                <note type="note">如果你需要同时加入多个频道或在频道间频繁切换，声网推荐你使用通配 Token 以避免每加入一个新的频道都需向服务端申请一个新的 Token，详见 <xref keyref="wildcard-token"/>。</note></pd>
             </plentry>
             <plentry id="channelID">
                 <pt>channelId</pt>
@@ -117,4 +118,4 @@ int JoinChannel(FString token, FString channelId, int64 uid, const FChannelMedia
                 </ul></li>
             </ul> </section>
     </refbody>
-</reference>
+</reference>
diff --git a/dita/RTC-NG/API/class_externalvideoframe.dita b/dita/RTC-NG/API/class_externalvideoframe.dita
@@ -309,7 +309,7 @@
                 </ul>
                 </pd>
         </plentry>
-        <plentry props="android cpp unreal bp unity rn electron flutter cs">
+        <plentry>
             <pt props="cpp unreal bp unity electron rn flutter cs">buffer</pt>
             <pt props="android">buf</pt>
             <pt props="ios mac">dataBuf</pt>
@@ -322,17 +322,17 @@
            <pd>iOS 纹理的 Buffer。</pd>
        </plentry>
        <plentry>
-  <pt>stride</pt>
-  <pd>传入视频帧的行间距，单位为像素而不是字节。对于 Texture，该值指的是 Texture 的宽度。
-      <p props="ios mac">
-          <dl outputclass="deprecated">
-              <dlentry>
-                  <dt>弃用：</dt>
-                  <dd>用 <parmname>strideInPixels</parmname> 代替。</dd>
-              </dlentry>
-          </dl>
-      </p>
-       </pd>
+            <pt>stride</pt>
+            <pd>传入视频帧的行间距，单位为像素而不是字节。对于 Texture，该值指的是 Texture 的宽度。
+                <p props="ios mac">
+                    <dl outputclass="deprecated">
+                        <dlentry>
+                            <dt>弃用：</dt>
+                            <dd>用 <parmname>strideInPixels</parmname> 代替。</dd>
+                        </dlentry>
+                    </dl>
+                </p>
+            </pd>
        </plentry>
         <plentry props="ios mac">
            <pt>strideInPixels</pt>

diff --git a/dita/RTC-NG/API/rtc_api_data_type.dita b/dita/RTC-NG/API/rtc_api_data_type.dita
@@ -26,6 +26,7 @@
             <li><xref keyref="ChannelMediaOptions"/></li>
             <li><xref keyref="ChannelMediaRelayConfiguration"/></li>
             <li><xref keyref="ClientRoleOptions"/></li>
+            <li props="cn"><xref keyref="ClimaxSegment"/></li>
             <li><xref keyref="ColorEnhanceOptions"/></li>
             <li><xref keyref="CodecCapInfo"/>
                 <ul>

diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-ios.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-ios.ditamap
@@ -4528,7 +4528,7 @@
         <keydef keys="CodecCapInfo" href="../API/class_codeccapinfo.dita">
             <topicmeta>
                 <keywords>
-                    <keyword>CodecCapAgoraVideoCodecCapInfoInfo</keyword>
+                    <keyword>AgoraVideoCodecCapInfoInfo</keyword>
                 </keywords>
             </topicmeta>
         </keydef>

diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-macos.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-macos.ditamap
@@ -4243,7 +4243,7 @@
         <keydef keys="CodecCapInfo" href="../API/class_codeccapinfo.dita">
             <topicmeta>
                 <keywords>
-                    <keyword>CodecCapAgoraVideoCodecCapInfoInfo</keyword>
+                    <keyword>AgoraVideoCodecCapInfoInfo</keyword>
                 </keywords>
             </topicmeta>
         </keydef>

diff --git a/en-US/dita/RTC-NG/config/keys-rtc-ng-api-ios.ditamap b/en-US/dita/RTC-NG/config/keys-rtc-ng-api-ios.ditamap
@@ -4528,7 +4528,7 @@
         <keydef keys="CodecCapInfo" href="../API/class_codeccapinfo.dita">
             <topicmeta>
                 <keywords>
-                    <keyword>CodecCapAgoraVideoCodecCapInfoInfo</keyword>
+                    <keyword>AgoraVideoCodecCapInfoInfo</keyword>
                 </keywords>
             </topicmeta>
         </keydef>

diff --git a/en-US/dita/RTC-NG/config/keys-rtc-ng-api-macos.ditamap b/en-US/dita/RTC-NG/config/keys-rtc-ng-api-macos.ditamap
@@ -4243,7 +4243,7 @@
         <keydef keys="CodecCapInfo" href="../API/class_codeccapinfo.dita">
             <topicmeta>
                 <keywords>
-                    <keyword>CodecCapAgoraVideoCodecCapInfoInfo</keyword>
+                    <keyword>AgoraVideoCodecCapInfoInfo</keyword>
                 </keywords>
             </topicmeta>
         </keydef>