Sync cn prototype to en prototype

AgoraIO · Jul 22, 2024 · 39100a8 · 39100a8
1 parent 3e335d7
commit 39100a8
Show file tree

Hide file tree

Showing 12 changed files with 310 additions and 64 deletions.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita
@@ -15,7 +15,7 @@
             <p outputclass="codeblock">
             <codeblock props="android" outputclass="language-java">public abstract int startRhythmPlayer(
     String sound1, String sound2, AgoraRhythmPlayerConfig config);</codeblock>
-            <codeblock props="ios" outputclass="language-objectivec">- (int)startRhythmPlayer:(NSString * _Nonnull)sound1 sound2:(NSString * _Nonnull)sound2 config:(AgoraRhythmPlayerConfig *  _Nullable)config;</codeblock>
+            <codeblock props="ios mac" outputclass="language-objectivec">- (int)startRhythmPlayer:(NSString * _Nonnull)sound1 sound2:(NSString * _Nonnull)sound2 config:(AgoraRhythmPlayerConfig *  _Nullable)config;</codeblock>
             <codeblock props="cpp unreal" outputclass="language-cpp">virtual int startRhythmPlayer(const char* sound1, const char* sound2, const AgoraRhythmPlayerConfig&amp; config) = 0;</codeblock>
          <codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|RtcEngineProxy&quot;)
 	int StartRhythmPlayer(FString sound1, FString sound2, const FAgoraRhythmPlayerConfig&amp; config);</codeblock>

diff --git a/en-US/dita/RTC-NG/config/keys-rtc-ng-api-blueprint.ditamap b/en-US/dita/RTC-NG/config/keys-rtc-ng-api-blueprint.ditamap
@@ -2030,7 +2030,7 @@
                 </topicmeta>
             </keydef>
         </topichead>
-        <topichead navtitle="空间音效基础方法">
+        <topichead navtitle="空间音频基础方法">
             <keydef keys="muteLocalAudioStream_IBaseSpatialAudioEngine" href="../API/api_ibasespatialaudioengine_mutelocalaudiostream.dita">
                 <topicmeta>
                     <keywords>
@@ -2116,7 +2116,7 @@
                 </topicmeta>
             </keydef>
         </topichead>
-        <topichead navtitle="本地直角坐标空间音效算法">
+        <topichead navtitle="本地直角坐标空间音频算法">
             <keydef keys="clearRemotePositions" href="../API/api_ilocalspatialaudioengine_clearremotepositions.dita">
                 <topicmeta>
                     <keywords>
@@ -2146,7 +2146,7 @@
                 </topicmeta>
             </keydef>
         </topichead>
-        <topichead navtitle="本地球坐标空间音效算法">
+        <topichead navtitle="本地球坐标空间音频算法">
             <keydef keys="enableSpatialAudio" href="../API/api_irtcengine_enablespatialaudio.dita">
                 <topicmeta>
                     <keywords>
@@ -2169,7 +2169,7 @@
                 </topicmeta>
             </keydef>
         </topichead>
-        <topichead navtitle="服务器空间音效算法" props="hide">
+        <topichead navtitle="服务器空间音频算法" props="hide">
             <keydef keys="addEventHandler" href="../API/api_icloudspatialaudioengine_addeventhandler.dita">
                 <topicmeta>
                     <keywords>
@@ -4725,7 +4725,7 @@
                 </topicmeta>
             </keydef>
         </topichead>
-        <topichead navtitle="服务器空间音效事件" props="hide">
+        <topichead navtitle="服务器空间音频事件" props="hide">
             <keydef keys="onConnectionStateChange" href="../API/callback_icloudspatialaudioeventhandler_onconnectionstatechange.dita">
                 <topicmeta>
                     <keywords>

diff --git a/en-US/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap b/en-US/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap
@@ -2102,7 +2102,7 @@
                 </topicmeta>
             </keydef>
         </topichead>
-        <topichead navtitle="空间音效基础方法">
+        <topichead navtitle="空间音频基础方法">
             <keydef keys="muteLocalAudioStream_IBaseSpatialAudioEngine" href="../API/api_ibasespatialaudioengine_mutelocalaudiostream.dita">
                 <topicmeta>
                     <keywords>
@@ -2188,7 +2188,7 @@
                 </topicmeta>
             </keydef>
         </topichead>
-        <topichead navtitle="本地直角坐标空间音效算法">
+        <topichead navtitle="本地直角坐标空间音频算法">
             <keydef keys="clearRemotePositions" href="../API/api_ilocalspatialaudioengine_clearremotepositions.dita">
                 <topicmeta>
                     <keywords>
@@ -2218,7 +2218,7 @@
                 </topicmeta>
             </keydef>
         </topichead>
-        <topichead navtitle="本地球坐标空间音效算法">
+        <topichead navtitle="本地球坐标空间音频算法">
             <keydef keys="enableSpatialAudio" href="../API/api_irtcengine_enablespatialaudio.dita">
                 <topicmeta>
                     <keywords>
@@ -2241,7 +2241,7 @@
                 </topicmeta>
             </keydef>
         </topichead>
-        <topichead navtitle="服务器空间音效算法" props="hide">
+        <topichead navtitle="服务器空间音频算法" props="hide">
             <keydef keys="addEventHandler" href="../API/api_icloudspatialaudioengine_addeventhandler.dita">
                 <topicmeta>
                     <keywords>
@@ -5017,7 +5017,7 @@
                 </topicmeta>
             </keydef>
         </topichead>
-        <topichead navtitle="服务器空间音效事件" props="hide">
+        <topichead navtitle="服务器空间音频事件" props="hide">
             <keydef keys="onConnectionStateChange" href="../API/callback_icloudspatialaudioeventhandler_onconnectionstatechange.dita">
                 <topicmeta>
                     <keywords>

diff --git a/en-US/dita/RTC-NG/config/keys-rtc-ng-api-electron.ditamap b/en-US/dita/RTC-NG/config/keys-rtc-ng-api-electron.ditamap
@@ -1837,6 +1837,38 @@
                 </topicmeta>
             </keydef>
         </topichead>
+        <topichead navtitle="虚拟节拍器">
+            <keydef keys="startRhythmPlayer" href="../API/api_irtcengine_startrhythmplayer.dita">
+                <topicmeta>
+                    <keywords>
+                        <keyword>startRhythmPlayer</keyword>
+                    </keywords>
+                </topicmeta>
+            </keydef>
+            <keydef keys="stopRhythmPlayer" href="../API/api_irtcengine_stoprhythmplayer.dita">
+                <topicmeta>
+                    <keywords>
+                        <keyword>stopRhythmPlayer</keyword>
+                    </keywords>
+                </topicmeta>
+            </keydef>
+            <keydef keys="configRhythmPlayer" href="../API/api_irtcengine_configrhythmplayer.dita">
+                <topicmeta>
+                    <keywords>
+                        <keyword>configRhythmPlayer</keyword>
+                    </keywords>
+                </topicmeta>
+            </keydef>
+        </topichead>
+        <topichead navtitle="虚拟节拍器事件">
+            <keydef keys="onRhythmPlayerStateChanged" href="../API/callback_irtcengineeventhandler_onrhythmplayerstatechanged.dita">
+                <topicmeta>
+                    <keywords>
+                        <keyword>onRhythmPlayerStateChanged</keyword>
+                    </keywords>
+                </topicmeta>
+            </keydef>
+        </topichead>
         <topichead navtitle="人声效果">
             <keydef keys="setLocalVoicePitch" href="../API/api_irtcengine_setlocalvoicepitch.dita">
                 <topicmeta>
@@ -1918,7 +1950,7 @@
                 </topicmeta>
             </keydef>
         </topichead>
-        <topichead navtitle="空间音效基础方法">
+        <topichead navtitle="空间音频基础方法">
             <keydef keys="muteLocalAudioStream_IBaseSpatialAudioEngine" href="../API/api_ibasespatialaudioengine_mutelocalaudiostream.dita">
                 <topicmeta>
                     <keywords>
@@ -2004,7 +2036,7 @@
                 </topicmeta>
             </keydef>
         </topichead>
-        <topichead navtitle="本地直角坐标空间音效算法">
+        <topichead navtitle="本地直角坐标空间音频算法">
             <keydef keys="clearRemotePositions" href="../API/api_ilocalspatialaudioengine_clearremotepositions.dita">
                 <topicmeta>
                     <keywords>
@@ -2034,7 +2066,7 @@
                 </topicmeta>
             </keydef>
         </topichead>
-        <topichead navtitle="本地球坐标空间音效算法">
+        <topichead navtitle="本地球坐标空间音频算法">
             <keydef keys="enableSpatialAudio" href="../API/api_irtcengine_enablespatialaudio.dita">
                 <topicmeta>
                     <keywords>
@@ -9956,20 +9988,20 @@
                     </keywords>
                 </topicmeta>
             </keydef>
-        <keydef keys="AgoraRhythmPlayerConfig" href="../API/class_agorarhythmplayerconfig.dita">
-            <topicmeta>
-                <keywords>
-                    <keyword>AgoraRhythmPlayerConfig</keyword>
-                </keywords>
-            </topicmeta>
-        </keydef>
-        <keydef keys="RecorderReasonCode" href="../API/enum_recorderreasoncode.dita">
-            <topicmeta>
-                <keywords>
-                    <keyword>RecorderReasonCode</keyword>
-                </keywords>
-            </topicmeta>
-        </keydef>
+            <keydef keys="AgoraRhythmPlayerConfig" href="../API/class_agorarhythmplayerconfig.dita">
+                <topicmeta>
+                    <keywords>
+                        <keyword>AgoraRhythmPlayerConfig</keyword>
+                    </keywords>
+                </topicmeta>
+            </keydef>
+            <keydef keys="RecorderReasonCode" href="../API/enum_recorderreasoncode.dita">
+                <topicmeta>
+                    <keywords>
+                        <keyword>RecorderReasonCode</keyword>
+                    </keywords>
+                </topicmeta>
+            </keydef>
             <keydef keys="RECORDER_REASON_NONE">
                 <topicmeta>
                     <keywords>
@@ -10285,6 +10317,90 @@
                     </keywords>
                 </topicmeta>
             </keydef>
+            <keydef keys="RHYTHM_PLAYER_STATE_TYPE" href="../API/enum_rhythmplayerstatetype.dita">
+                <topicmeta>
+                    <keywords>
+                        <keyword>RhythmPlayerStateType</keyword>
+                    </keywords>
+                </topicmeta>
+            </keydef>
+            <keydef keys="RHYTHM_PLAYER_STATE_IDLE">
+                <topicmeta>
+                    <keywords>
+                        <keyword>RhythmPlayerStateIdle</keyword>
+                    </keywords>
+                </topicmeta>
+            </keydef>
+            <keydef keys="RHYTHM_PLAYER_STATE_OPENING">
+                <topicmeta>
+                    <keywords>
+                        <keyword>RhythmPlayerStateOpening</keyword>
+                    </keywords>
+                </topicmeta>
+            </keydef>
+            <keydef keys="RHYTHM_PLAYER_STATE_DECODING">
+                <topicmeta>
+                    <keywords>
+                        <keyword>RhythmPlayerStateDecoding</keyword>
+                    </keywords>
+                </topicmeta>
+            </keydef>
+            <keydef keys="RHYTHM_PLAYER_STATE_PLAYING">
+                <topicmeta>
+                    <keywords>
+                        <keyword>RhythmPlayerStatePlaying</keyword>
+                    </keywords>
+                </topicmeta>
+            </keydef>
+            <keydef keys="RHYTHM_PLAYER_STATE_FAILED">
+                <topicmeta>
+                    <keywords>
+                        <keyword>RhythmPlayerStateFailed</keyword>
+                </keywords>
+            </topicmeta>
+        </keydef>
+            <keydef keys="RHYTHM_PLAYER_REASON" href="../API/enum_rhythmplayerreason.dita">
+                <topicmeta>
+                    <keywords>
+                        <keyword>RhythmPlayerReason</keyword>
+                    </keywords>
+                </topicmeta>
+            </keydef>
+            <keydef keys="RHYTHM_PLAYER_REASON_OK">
+                <topicmeta>
+                    <keywords>
+                        <keyword>RhythmPlayerReasonOk</keyword>
+                    </keywords>
+                </topicmeta>
+            </keydef>
+            <keydef keys="RHYTHM_PLAYER_REASON_FAILED">
+                <topicmeta>
+                    <keywords>
+                        <keyword>RhythmPlayerReasonFailed</keyword>
+                    </keywords>
+                </topicmeta>
+            </keydef>
+            <keydef keys="RHYTHM_PLAYER_REASON_CAN_NOT_OPEN">
+                <topicmeta>
+                    <keywords>
+                        <keyword>RhythmPlayerReasonCanNotOpen</keyword>
+                    </keywords>
+                </topicmeta>
+            </keydef>
+            <keydef keys="RHYTHM_PLAYER_REASON_CAN_NOT_PLAY">
+                <topicmeta>
+                    <keywords>
+                        <keyword>RhythmPlayerReasonCanNotPlay</keyword>
+                    </keywords>
+                </topicmeta>
+            </keydef>
+            <keydef keys="RHYTHM_PLAYER_REASON_FILE_OVER_DURATION_LIMIT">
+                <topicmeta>
+                    <keywords>
+                        <keyword>RhythmPlayerReasonFileOverDurationLimit</keyword>
+                    </keywords>
+                </topicmeta>
+            </keydef>
             <keydef keys="SIMULCAST_STREAM_MODE" href="../API/enum_simulcaststreammode.dita">
                 <topicmeta>
                     <keywords>

diff --git a/en-US/dita/RTC-NG/config/keys-rtc-ng-api-flutter.ditamap b/en-US/dita/RTC-NG/config/keys-rtc-ng-api-flutter.ditamap
@@ -1991,7 +1991,7 @@
                 </topicmeta>
             </keydef>
         </topichead>
-        <topichead navtitle="空间音效基础方法">
+        <topichead navtitle="空间音频基础方法">
             <keydef keys="muteLocalAudioStream_IBaseSpatialAudioEngine" href="../API/api_ibasespatialaudioengine_mutelocalaudiostream.dita">
                 <topicmeta>
                     <keywords>
@@ -2077,7 +2077,7 @@
                 </topicmeta>
             </keydef>
         </topichead>
-        <topichead navtitle="本地直角坐标空间音效算法">
+        <topichead navtitle="本地直角坐标空间音频算法">
             <keydef keys="clearRemotePositions" href="../API/api_ilocalspatialaudioengine_clearremotepositions.dita">
                 <topicmeta>
                     <keywords>
@@ -2107,7 +2107,7 @@
                 </topicmeta>
             </keydef>
         </topichead>
-        <topichead navtitle="本地球坐标空间音效算法">
+        <topichead navtitle="本地球坐标空间音频算法">
             <keydef keys="enableSpatialAudio" href="../API/api_irtcengine_enablespatialaudio.dita">
                 <topicmeta>
                     <keywords>

diff --git a/en-US/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap b/en-US/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap
@@ -1904,7 +1904,7 @@
                 </topicmeta>
             </keydef>
         </topichead>
-        <topichead navtitle="空间音效基础方法" props="reserve">
+        <topichead navtitle="空间音频基础方法" props="reserve">
             <keydef keys="muteLocalAudioStream_IBaseSpatialAudioEngine" href="../API/api_ibasespatialaudioengine_mutelocalaudiostream.dita">
                 <topicmeta>
                     <keywords>
@@ -1976,7 +1976,7 @@
                 </topicmeta>
             </keydef>
         </topichead>
-        <topichead navtitle="本地直角坐标空间音效算法" props="reserve">
+        <topichead navtitle="本地直角坐标空间音频算法" props="reserve">
             <keydef keys="clearRemotePositions" href="../API/api_ilocalspatialaudioengine_clearremotepositions.dita">
                 <topicmeta>
                     <keywords>
@@ -2020,7 +2020,7 @@
                 </topicmeta>
             </keydef>
         </topichead>
-        <topichead navtitle="本地球坐标空间音效算法" props="reserve">
+        <topichead navtitle="本地球坐标空间音频算法" props="reserve">
             <keydef keys="enableSpatialAudio" href="../API/api_irtcengine_enablespatialaudio.dita">
                 <topicmeta>
                     <keywords>

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
@@ -1911,7 +1911,7 @@
                 </topicmeta>
             </keydef>
         </topichead>
-        <topichead navtitle="空间音效基础方法">
+        <topichead navtitle="空间音频基础方法">
             <keydef keys="muteLocalAudioStream_IBaseSpatialAudioEngine" href="../API/api_ibasespatialaudioengine_mutelocalaudiostream.dita">
                 <topicmeta>
                     <keywords>
@@ -1997,7 +1997,7 @@
                 </topicmeta>
             </keydef>
         </topichead>
-        <topichead navtitle="本地直角坐标空间音效算法">
+        <topichead navtitle="本地直角坐标空间音频算法">
             <keydef keys="clearRemotePositions" href="../API/api_ilocalspatialaudioengine_clearremotepositions.dita">
                 <topicmeta>
                     <keywords>
@@ -2041,7 +2041,7 @@
                 </topicmeta>
             </keydef>
         </topichead>
-        <topichead navtitle="本地球坐标空间音效算法">
+        <topichead navtitle="本地球坐标空间音频算法">
             <keydef keys="enableSpatialAudio" href="../API/api_irtcengine_enablespatialaudio.dita">
                 <topicmeta>
                     <keywords>
@@ -2064,7 +2064,7 @@
                 </topicmeta>
             </keydef>
         </topichead>
-        <topichead navtitle="服务器空间音效算法" props="hide">
+        <topichead navtitle="服务器空间音频算法" props="hide">
             <keydef keys="enableSpatializer" href="../API/api_icloudspatialaudioengine_enablespatializer.dita">
                 <topicmeta>
                     <keywords>
@@ -4449,7 +4449,7 @@
                 </topicmeta>
             </keydef>
         </topichead>
-        <topichead navtitle="服务器空间音效事件" props="hide">
+        <topichead navtitle="服务器空间音频事件" props="hide">
             <keydef keys="onConnectionStateChange" href="../API/callback_icloudspatialaudioeventhandler_onconnectionstatechange.dita">
                 <topicmeta>
                     <keywords>