Merge pull request #3799 from AgoraIO/translation/4.x-api-ref

New YiCAT updates
AgoraIO · Oct 25, 2024 · c56c17f · c56c17f
2 parents de8b64a + b9b2a93
commit c56c17f
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 18 deletions.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_playeffect3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_playeffect3.dita
@@ -77,8 +77,9 @@
             <p>You can call this method either before or after joining a channel.</p>
         </section>
         <section id="restriction" deliveryTarget="details">
-            <title><ph props="android cpp apple framework">Restrictions</ph></title>
+            <title>Restrictions</title>
             <p props="android cpp apple framework">If you need to play an online audio effect file, Agora recommends that you cache the online audio effect file to your local device, call <xref keyref="preloadEffect"/> to preload the file into memory, and then call this method to play the audio effect. Otherwise, you might encounter playback failures or no sound during playback due to loading timeouts or failures.</p>
+            <p props="hmos">None.</p>
         </section>
         <section id="related" deliveryTarget="details">
             <title>Related callbacks</title>

diff --git a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplaybufferupdated.dita b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplaybufferupdated.dita
@@ -30,8 +30,8 @@
         </section>
         <section id="detailed_desc">
             <p>When playing online media resources, the SDK triggers this callback every two seconds to report the playback duration that the currently buffered data can support.<ul>
-            <li>When the playback duration supported by the buffered data is less than the threshold (0 by default), the SDK returns <apiname keyref="PLAYER_EVENT_BUFFER_LOW"/>.</li>
-            <li>When the playback duration supported by the buffered data is greater than the threshold (0 by default), the SDK returns <apiname keyref="PLAYER_EVENT_BUFFER_RECOVER"/>.</li>
+            <li>When the playback duration supported by the buffered data is less than the threshold (0 by default), the SDK returns <apiname keyref="PLAYER_EVENT_BUFFER_LOW"/> (6).</li>
+            <li>When the playback duration supported by the buffered data is greater than the threshold (0 by default), the SDK returns <apiname keyref="PLAYER_EVENT_BUFFER_RECOVER"/> (7).</li>
             </ul> </p>
         </section>
         <section id="parameters">

diff --git a/en-US/dita/RTC-NG/API/rtc_api_data_type.dita b/en-US/dita/RTC-NG/API/rtc_api_data_type.dita
@@ -283,10 +283,10 @@
                     <li props="hide"><xref keyref="setDestChannelInfo"/></li>
                     <li><xref keyref="setSrcChannelInfo"/></li>
                     </ul> </li>
-                <li props="hide"><xref keyref="Music"/></li>
-                <li props="hide"><xref keyref="MusicChartInfo"/></li>
-                <li props="hide"><xref keyref="MusicCollection"/></li>
-                <li props="hide"><xref keyref="MusicContentCenterConfiguration"/></li>
+                <li><xref keyref="Music"/></li>
+                <li><xref keyref="MusicChartInfo"/></li>
+                <li><xref keyref="MusicCollection"/></li>
+                <li><xref keyref="MusicContentCenterConfiguration"/></li>
                 <li><xref keyref="ContentInspectConfig"/></li>
                 <li><xref keyref="ContentInspectModule"/></li>
                 <li><xref keyref="ClientRoleOptions"/></li>
@@ -1356,6 +1356,7 @@
                 <li><xref keyref="MEDIA_STREAM_TYPE"/></li>
                 <li props="reserve"><xref keyref="MEDIA_TRACE_EVENT"/></li>
                 <li props="reserve"><xref keyref="MusicContentCenterStateReason"/></li>
+                <li props="cn"><xref keyref="MusicPlayMode"/></li>
                 <li props="reserve"><xref keyref="ORIENTATION_MODE"/></li>
                 <li><xref keyref="PLAYER_PRELOAD_EVENT"/></li>
                 <li props="cn"><xref keyref="PreloadState"/></li>

diff --git a/en-US/dita/RTC-NG/API/rtc_api_overview.dita b/en-US/dita/RTC-NG/API/rtc_api_overview.dita
@@ -1550,7 +1550,7 @@
                 </strow>
             </simpletable>
         </section>
-        <section id="media_player" props="android cpp apple framework">
+        <section id="media_player" props="android hmos cpp apple framework">
             <title>Media player</title>
             <p props="cn">For more methods about the media player, see <xref href="toc_mediaplayer_initialize.dita">Built-in Media Player</xref>.</p>
             <p props="en">For more methods about the media player, see <xref keyref="IMediaPlayer"/>.</p>
@@ -1559,9 +1559,9 @@
                     <stentry>Method / Callback</stentry>
                     <stentry>Description</stentry>
                 </sthead>
-                <strow props="android cpp apple framework">
+                <strow props="android hmos cpp apple framework">
                     <stentry><xref keyref="createMediaPlayer"/></stentry>
-                    <stentry><ph conkeyref="createMediaPlayer/shortdesc" props="android cpp framework"/><ph conkeyref="createMediaPlayer/shortdesc1" props="apple"/></stentry>
+                    <stentry><ph conkeyref="createMediaPlayer/shortdesc" props="android hmos cpp framework"/><ph conkeyref="createMediaPlayer/shortdesc1" props="apple"/></stentry>
                 </strow>
                 <strow props="android cpp apple unreal flutter electron rn unity cs">
                     <stentry><xref keyref="getMediaPlayerCacheManager"/></stentry>
@@ -1575,11 +1575,11 @@
                     <stentry><xref keyref="IMediaPlayer"/></stentry>
                     <stentry><ph conkeyref="IMediaPlayer/shortdesc"/></stentry>
                 </strow>
-                <strow props="native unreal flutter unity cs electron rn">
+                <strow props="android cpp apple unreal flutter unity cs electron rn">
                     <stentry><xref keyref="IMediaPlayerCacheManager"/></stentry>
                     <stentry><ph conkeyref="IMediaPlayerCacheManager/shortdesc"/></stentry>
                 </strow>
-                <strow>
+                <strow props="android hmos cpp apple framework">
                     <stentry><xref keyref="IMediaPlayerSourceObserver"/></stentry>
                     <stentry><ph conkeyref="IMediaPlayerSourceObserver/shortdesc"/></stentry>
                 </strow>
@@ -1658,7 +1658,7 @@
                 </strow>
             </simpletable>
         </section>
-        <section id="drm" props="android ios cpp unreal unity flutter rn">
+        <section id="drm" props="native unreal unity flutter rn">
             <title><ph props="cn">DRM-protected music</ph></title>
             <p props="cpp unreal unity flutter"><ph props="cn">This group of methods is for Android and iOS only.</ph></p>
             <simpletable props="cn">
@@ -1682,7 +1682,7 @@
                     <stentry><xref keyref="destroyMusicPlayer"/></stentry>
                     <stentry><ph conkeyref="destroyMusicPlayer/shortdesc"/></stentry>
                 </strow>
-                <strow props="native unity cs unreal">
+                <strow props="android cpp apple unity cs unreal">
                     <stentry><xref keyref="preload"/></stentry>
                     <stentry><ph conkeyref="preload/shortdesc"/></stentry>
                 </strow>
@@ -1734,18 +1734,22 @@
                     <stentry><xref keyref="getMusicContentCenter"/></stentry>
                     <stentry><ph conkeyref="getMusicContentCenter/shortdesc"/></stentry>
                 </strow>
-                <strow>
+                <strow props="android cpp apple unreal unity flutter rn">
                     <stentry><xref keyref="getMusicCollectionByMusicChartId"/></stentry>
                     <stentry><ph conkeyref="getMusicCollectionByMusicChartId/shortdesc"/></stentry>
                 </strow>
                 <strow props="android hmos">
                     <stentry><xref keyref="getMusicCollectionByMusicChartId2"/></stentry>
                     <stentry><ph conkeyref="getMusicCollectionByMusicChartId2/shortdesc"/></stentry>
                 </strow>
-                <strow>
+                <strow props="android cpp apple unreal unity flutter rn">
                     <stentry><xref keyref="searchMusic"/></stentry>
                     <stentry><ph conkeyref="searchMusic/shortdesc"/></stentry>
                 </strow>
+                <strow props="hmos">
+                    <stentry><xref keyref="searchMusic2"/></stentry>
+                    <stentry><ph conkeyref="searchMusic2/shortdesc"/></stentry>
+                </strow>
                 <strow>
                     <stentry><xref keyref="setPlayMode"/></stentry>
                     <stentry><ph conkeyref="setPlayMode/shortdesc"/></stentry>
@@ -1770,15 +1774,15 @@
                     <stentry><xref keyref="getSongSimpleInfo"/></stentry>
                     <stentry><ph conkeyref="getSongSimpleInfo/shortdesc"/></stentry>
                 </strow>
-                <strow props="android hmos">
+                <strow props="android">
                     <stentry><xref keyref="getPlaySrc"/></stentry>
                     <stentry><ph conkeyref="getPlaySrc/shortdesc"/></stentry>
                 </strow>
                 <strow props="ios">
                     <stentry><xref keyref="enableMainQueueDispatch"/></stentry>
                     <stentry><ph conkeyref="enableMainQueueDispatch/shortdesc"/></stentry>
                 </strow>
-                <strow props="android hmos">
+                <strow props="android">
                     <stentry><xref keyref="stop_IMusicPlayer"/></stentry>
                     <stentry><ph conkeyref="stop_IMusicPlayer/shortdesc"/></stentry>
                 </strow>