From 93d914e6170b6976d2a5ae97996b90f79ca7f584 Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Thu, 9 May 2024 12:40:47 +0800 Subject: [PATCH] New translations --- .../API/api_irtcengine_disableaudio.dita | 31 +++++++------ .../API/api_irtcengine_enableaudio.dita | 27 ++++++----- .../API/api_irtcengine_enablelocalaudio.dita | 41 ++++++++++------- .../API/api_irtcengine_setaudioprofile.dita | 45 +++++++++++-------- .../API/api_irtcengine_setaudioprofile2.dita | 31 ++++++++----- .../API/api_irtcengine_setaudioscenario.dita | 43 +++++++++--------- 6 files changed, 127 insertions(+), 91 deletions(-) diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_disableaudio.dita b/en-US/dita/RTC-NG/API/api_irtcengine_disableaudio.dita index 17dc454c356..c8f720663cc 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_disableaudio.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_disableaudio.dita @@ -16,7 +16,7 @@ public abstract int disableAudio(); - (int)disableAudio; virtual int disableAudio() = 0; - UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") + UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") int DisableAudio(); abstract disableAudio(): number; public abstract int DisableAudio(); @@ -24,25 +24,30 @@ Future<void> disableAudio();

-
- Details - -
    -
  • This method disables the internal engine and can be called anytime after initialization. It is still valid after one leaves channel.
    • -
  • This method resets the internal engine and takes some time to take effect. Agora recommends using the following API methods to control the audio modules separately:
      +
      +

      音频模块默认开启，你可以调用该方法关闭音频模块。

      +
      +
      + Call timing +

      It can be called either before or after joining the channel. It is still valid after one leaves channel.

      +
      +
      + Restrictions +

      This method resets the internal engine and takes some time to take effect. Agora recommends using the following API methods to control the audio modules separately:

      • : Whether to enable the microphone to create the local audio stream.
      • : Whether to enable loopback audio capturing.
      • : Whether to publish the local audio stream.
      • : Whether to subscribe and play the remote audio stream.
      • : Whether to subscribe to and play all remote audio streams.
        • -
      -
+ +

+
<ph keyref="return-section-title"/>

When the method call succeeds, there is no return value; when fails, the exception is thrown. You need to catch the exception and handle it accordingly. See for details and resolution suggestions.

- - + + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableaudio.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableaudio.dita index 5ebe967f624..d31bfe264fa 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableaudio.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableaudio.dita @@ -16,7 +16,7 @@ public abstract int enableAudio(); - (int)enableAudio; virtual int enableAudio() = 0; - UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") + UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") int EnableAudio(); abstract enableAudio(): number; public abstract int EnableAudio(); @@ -24,12 +24,16 @@ Future<void> enableAudio();

-
- Details -

The audio mode is enabled by default.

- +
+

音频模块默认开启。 如果你调用 关闭了音频模块，可调用该方法重新开启。

+
+
+ Call timing +

It can be called either before or after joining the channel. It is still valid after one leaves channel.

+
+
+ Restrictions
    -
  • This method enables the internal engine and can be called anytime after initialization. It is still valid after one leaves channel.
  • Calling this method will reset the entire engine, resulting in a slow response time. Instead of callling this method, you can independently control a specific audio module based on your actual needs using the following methods:
    • : Whether to enable the microphone to create the local audio stream.
    • : Whether to publish the local audio stream.
      • @@ -37,13 +41,14 @@
    • : Whether to subscribe to and play all remote audio streams.
  • A successful call of this method resets , , and . Proceed it with caution.
    • -
+ +
<ph keyref="return-section-title"/>

When the method call succeeds, there is no return value; when fails, the exception is thrown. You need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    -
  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • 0: Success.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- - + + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablelocalaudio.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablelocalaudio.dita index 2554355d28d..0732f2efc21 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablelocalaudio.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablelocalaudio.dita @@ -2,7 +2,7 @@ <ph keyref="enableLocalAudio" /> - Enables or disables the local audio capture. + Enables or disables the local audio. @@ -16,7 +16,7 @@ public abstract int enableLocalAudio(boolean enabled); - (int)enableLocalAudio:(BOOL)enabled; virtual int enableLocalAudio(bool enabled) = 0; - UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") + UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") int EnableLocalAudio(bool enabled); abstract enableLocalAudio(enabled: boolean): number; public abstract int EnableLocalAudio(bool enabled); @@ -24,30 +24,39 @@ Future<void> enableLocalAudio(bool enabled);

-
- Details +

The audio function is enabled by default when users joining a channel. This method disables or re-enables the local audio function to stop or restart local audio capturing.

-

This method does not affect receiving the remote audio streams, and () is applicable to scenarios where the user wants to receive remote audio streams without sending any audio stream to other users in the channel.

-

Once the local audio function is disabled or re-enabled, the SDK triggers the callback, which reports (0) or (1). -

    -
  • The difference between this method and are as follow:
      +

      The difference between this method and are as follow:

      • : Disables or re-enables the local audio capturing and processing. If you disable or re-enable local audio capturing using the method, the local user might hear a pause in the remote audio playback.
        • -
      • : Sends or stops sending the local audio streams.
        • -
      -
    • You can call this method either before or after joining a channel. Calling it before joining a channel only sets the device state, and it takes effect immediately after you join the channel.
      • -

    +
  • : 停止或继续发送本地音频流，不影响音频的采集状态。
    • +

+
+
+ Applicable scenarios +

This method does not affect receiving the remote audio streams, and () is applicable to scenarios where the user wants to receive remote audio streams without sending any audio stream to other users in the channel.

+
+
+ Call timing +

You can call this method either before or after joining a channel. Calling it before joining a channel only sets the device state, and it takes effect immediately after you join the channel.

+
+
+ Restrictions +

None.

+
+ -
+
Parameters enabled -

  • : (Default) Re-enable the local audio function, that is, to start the local audio capturing device (for example, the microphone).
  • : Disable the local audio function, that is, to stop local audio capturing.
    • -

+
@@ -58,5 +67,5 @@
  • 0: Success.
  • < 0: Failure. See for details and resolution suggestions.
    • - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile.dita index 40338a85cdd..c8c27ac513b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile.dita @@ -16,7 +16,7 @@ public abstract int setAudioProfile(int profile, int scenario); - (int)setAudioProfile:(AgoraAudioProfile)profile scenario:(AgoraAudioScenario)scenario; virtual int setAudioProfile(AUDIO_PROFILE_TYPE profile, AUDIO_SCENARIO_TYPE scenario) = 0; - UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") + UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") int SetAudioProfile(EAUDIO_PROFILE_TYPE profile = EAUDIO_PROFILE_TYPE::AUDIO_PROFILE_DEFAULT, EAUDIO_SCENARIO_TYPE scenario = EAUDIO_SCENARIO_TYPE::AUDIO_SCENARIO_DEFAULT); abstract setAudioProfile( profile: AudioProfileType, @@ -32,35 +32,42 @@ AudioScenarioType scenario = AudioScenarioType.audioScenarioDefault});

    -
    - Details +
    Deprecated:
    This method is deprecated. If you need to set the audio profile, use ; if you need to set the audio scenario, use .
    - -
      -
    • You can call this method either before or after joining a channel.
      • -
    • Due to iOS system restrictions, some audio routes cannot be recognized in call volume mode. Therefore, if you need to use an external sound card, it is recommended to set the audio scenario to (3). In this scenario, the SDK will switch to media volume to avoid this issue.
      • -
    • In scenarios requiring high-quality audio, such as online music tutoring, Agora recommends you set profile as (4)and scenario as (3).
      • -
    -
    +
    +
    + Applicable scenarios +

    该方法适用于各种音频场景，你可以按需选择。 例如，在音乐教学等高音质需求的场景中，建议将 profile 设置为 (4)，scenario 设置为 (3)。

    +
    +
    + Call timing +

    You can call this method either before or after joining a channel.

    +
    +
    + Restrictions +

    Due to iOS system restrictions, some audio routes cannot be recognized in call volume mode. Therefore, if you need to use an external sound card, it is recommended to set the audio scenario to (3). In this scenario, the SDK will switch to media volume to avoid this issue.

    +

    None.

    +
    +
    Parameters profile -

    The audio profile, including the sampling rate, bitrate, encoding mode, and the number of channels. See .

      -
    • (0): The default value.
        +

        The audio profile, including the sampling rate, bitrate, encoding mode, and the number of channels. See .

          +
        • (0): The default value.
          • -
        • (1): A sampling rate of 32 kHz, audio encoding, mono, and a bitrate of up to 18 Kbps.
          • -
        • (2): A sampling rate of 48 kHz, music encoding, mono, and a bitrate of up to 64 Kbps.
          • -
        • (3): A sampling rate of 48 kHz, music encoding, stereo, and a bitrate of up to 80 Kbps.
          • -
        • (4): A sampling rate of 48 kHz, music encoding, mono, and a bitrate of up to 96 Kbps.
          • -
        • (5): A sampling rate of 48 kHz, music encoding, stereo, and a bitrate of up to 128 Kbps.
          • +
        • (1): A sampling rate of 32 kHz, audio encoding, mono, and a bitrate of up to 18 Kbps.
          • +
        • (2): A sampling rate of 48 kHz, music encoding, mono, and a bitrate of up to 64 Kbps.
          • +
        • (3): A sampling rate of 48 kHz, music encoding, stereo, and a bitrate of up to 80 Kbps.
          • +
        • (4): A sampling rate of 48 kHz, music encoding, mono, and a bitrate of up to 96 Kbps.
          • +
        • (5): A sampling rate of 48 kHz, music encoding, stereo, and a bitrate of up to 128 Kbps.

        @@ -76,5 +83,5 @@
      • 0: Success.
      • < 0: Failure. See for details and resolution suggestions.
    - - + + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile2.dita index 4a559ef43a9..1dc39e65a67 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile2.dita @@ -21,15 +21,22 @@

    -
    - Details - -
      -
    • You can call this method either before or after joining a channel.
      • -
    • In scenarios requiring high-quality audio, such as online music tutoring, Agora recommends you set profile as (4).
      • -
    • If you need to set the audio scenario, you can either call , or and set the mAudioScenarioaudioScenario in .
      • -
    -
    +
    +

    If you need to set the audio scenario, you can either call , or and set the mAudioScenarioaudioScenario in .

    +
    +
    + Applicable scenarios +

    该方法适用于各种音频场景，你可以按需选择。 例如，在音乐教学等高音质需求的场景中，建议将 profile 设置为 (4)。

    +
    +
    + Call timing +

    You can call this method either before or after joining a channel.

    +
    +
    + Restrictions +

    None.

    +
    +
    Parameters @@ -39,11 +46,11 @@
    -
    +
    Returns
    • 0: Success.
    • < 0: Failure. See for details and resolution suggestions.
    - - + + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita index e8cb0892f97..dd312df75d9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita @@ -16,7 +16,7 @@ public abstract int setAudioScenario(int scenario); - (int)setAudioScenario:(AgoraAudioScenario)scenario; virtual int setAudioScenario(AUDIO_SCENARIO_TYPE scenario) = 0; - UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") + UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") int SetAudioScenario(EAUDIO_SCENARIO_TYPE scenario = EAUDIO_SCENARIO_TYPE::AUDIO_SCENARIO_DEFAULT); abstract setAudioScenario(scenario: AudioScenarioType): number; public abstract int SetAudioScenario(AUDIO_SCENARIO_TYPE scenario); @@ -24,29 +24,32 @@ Future<void> setAudioScenario(AudioScenarioType scenario);

    -
    - Details - -
      -
    • You can call this method either before or after joining a channel.
      • -
    • -
    -
    -
    +
    +

    +

    +
    + Applicable scenarios +

    该方法适用于各种音频场景，你可以按需选择。 例如，在音乐教学等高音质需求的场景中，建议将 scenario 设置为 (3)。

    +
    +
    + Call timing +

    You can call this method either before or after joining a channel.

    +
    +
    +
    Parameters scenario - The audio scenarios. Under different audio scenarios, the device uses different volume types. See .
      -
    • (0): (Default) Automatic scenario, where the SDK chooses the appropriate audio quality according to the user role and audio route.
      • -
    • (3): High-quality audio scenario, where users mainly play music.
      • -
    • (5): Chatroom scenario, where users need to frequently switch the user role or mute and unmute the microphone. In this scenario, audience members receive a pop-up window to request permission of using microphones.
      • -
    • (7): Real-time chorus scenario, where users have good network conditions and require ultra-low latency.
      • -
    • (8): Meeting scenario that mainly involves the human voice.
      • + The audio scenarios. Under different audio scenarios, the device uses different volume types. See .
        +
      • (0): (Default) Automatic scenario, where the SDK chooses the appropriate audio quality according to the user role and audio route.
        • +
      • (3): High-quality audio scenario, where users mainly play music.
        • +
      • (5): Chatroom scenario, where users need to frequently switch the user role or mute and unmute the microphone. In this scenario, audience members receive a pop-up window to request permission of using microphones.
        • +
      • (7): Real-time chorus scenario, where users have good network conditions and require ultra-low latency.
        • +
      • (8): Meeting scenario that mainly involves the human voice.
       - -
    +
    <ph keyref="return-section-title"/>

    When the method call succeeds, there is no return value; when fails, the exception is thrown. You need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    @@ -54,5 +57,5 @@
  • 0: Success.
  • < 0: Failure. See for details and resolution suggestions.
    • - - + + \ No newline at end of file