diff --git a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_removeremoteposition.dita b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_removeremoteposition.dita index 71574132460..5c8d4c173f2 100644 --- a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_removeremoteposition.dita +++ b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_removeremoteposition.dita @@ -27,7 +27,7 @@
Details

After successfully calling this method, the local user no longer hears the specified remote user.

-

After leaving the channel, to avoid wasting resources, you can also call this method to delete the spatial position of the specified remote user.

+

After leaving the channel, to avoid wasting computing resources, call this method to delete the spatial position information of the specified remote user. Otherwise, the user's spatial position information will be saved continuously. When the number of remote users exceeds the number of audio streams that can be received as set in , the system automatically unsubscribes from the audio stream of the user who is furthest away based on relative distance.

Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_addvideowatermark.dita b/en-US/dita/RTC-NG/API/api_irtcengine_addvideowatermark.dita index 4db9abb7ace..ecaeaab738d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_addvideowatermark.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_addvideowatermark.dita @@ -33,7 +33,7 @@
This method is deprecated. Use instead.
-

This method adds a PNG watermark image to the local video stream in a live streaming session. Once the watermark image is added, all the users in the channel (CDN audience included) and the video capturing device can see and capture it. If you only want to add a watermark to the CDN live streaming, see descriptions in .

+

This method adds a PNG watermark image to the local video stream in a live streaming session. Once the watermark image is added, all the users in the channel (CDN audience included) and the video capturing device can see and capture it. If you only want to add a watermark to the CDN live streaming, see descriptions in .

-
- Details +

After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all remote users, including all subsequent users.

-
    -
  • Call this method after joining a channel.
    • -
  • If you do not want to subscribe the audio streams of remote users before joining a channel, you can set autoSubscribeAudio as when calling .
    • -
  • See recommended settings in Set the Subscribing State.
    • -
+

By default, the SDK subscribes to the audio streams of all remote users when joining a channel. To modify this behavior, you can set autoSubscribeAudio to when calling to join the channel, which will cancel the subscription to the audio streams of all users upon joining the channel.

+ +
+
+ Call timing +

Call this method after joining a channel.

+
+
+ Restrictions +

If you call this method and then call or , the latest call will prevail.

+
Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_muteallremotevideostreams.dita b/en-US/dita/RTC-NG/API/api_irtcengine_muteallremotevideostreams.dita index 3ec633bb8ca..afea03f9c04 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_muteallremotevideostreams.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_muteallremotevideostreams.dita @@ -24,13 +24,20 @@ Future<void> muteAllRemoteVideoStreams(bool mute);

-
- Details +

After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all remote users, including all subsequent users.

-
    -
  • Call this method after joining a channel.
    • -
  • If you do not want to subscribe the video streams of remote users before joining a channel, you can call and set autoSubscribeVideo as .
    • -
+ +

By default, the SDK subscribes to the video streams of all remote users when joining a channel. To modify this behavior, you can set autoSubscribeVideo to when calling to join the channel, which will cancel the subscription to the video streams of all users upon joining the channel.

+ +
+
+ Call timing +

Call this method after joining a channel.

+ If you call () after leaving the channel, you will not subscribe to any user's video stream the next time you join the channel. +
+
+ Restrictions +

If you call this method and then call or , the latest call will prevail.

Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalaudiostream.dita b/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalaudiostream.dita index 7e7fb9f0330..741bb42a030 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalaudiostream.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalaudiostream.dita @@ -24,10 +24,21 @@ Future<void> muteLocalAudioStream(bool mute);

-
- Details - This method does not affect any ongoing audio recording, because it does not disable the audio capture device. -

A successful call of this method triggers the and callbacks on the remote client.

+
+

This method is used to control whether to publish the locally captured audio stream. If you call this method to stop publishing locally captured audio streams, the audio capturing device will still work and won't be affected.

+
+
+ Call timing +

It can be called either before or after joining the channel.

+
+
+ Restrictions +

None.

+
+
Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalvideostream.dita b/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalvideostream.dita index 5c6bc7486c1..eba2dacfecc 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalvideostream.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalvideostream.dita @@ -24,14 +24,22 @@ Future<void> muteLocalVideoStream(bool mute);

-
- Details -

A successful call of this method triggers the callback on the remote client.

- -
    -
  • This method executes faster than the () method, which controls the sending of the local video stream.
    • -
  • This method does not affect any ongoing video recording, because it does not disable the camera.
    • -
+
+

This method is used to control whether to publish the locally captured video stream. If you call this method to stop publishing locally captured video streams, the video capturing device will still work and won't be affected.

+

Compared to (), which can also cancel the publishing of local video stream by turning off the local video stream capture, this method responds faster.

+
+
+ Call timing +

It can be called either before or after joining the channel.

+
+
+ Restrictions +

None.

+
+
Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_muteremoteaudiostream.dita b/en-US/dita/RTC-NG/API/api_irtcengine_muteremoteaudiostream.dita index 9268099c80a..b7ed449368d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_muteremoteaudiostream.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_muteremoteaudiostream.dita @@ -25,13 +25,20 @@ Future<void> muteRemoteAudioStream({required int uid, required bool mute});

-
- Details - -
    -
  • Call this method after joining a channel.
    • -
  • See recommended settings in Set the Subscribing State.
    • -
+
+
+
+ Call timing +

Call this method after joining a channel.

+
+
+ Restrictions +

None.

+
+
Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_muteremotevideostream.dita b/en-US/dita/RTC-NG/API/api_irtcengine_muteremotevideostream.dita index 1ce11bf7b47..6b7391d84c0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_muteremotevideostream.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_muteremotevideostream.dita @@ -25,13 +25,20 @@ Future<void> muteRemoteVideoStream({required int uid, required bool mute});

-
- Details - -
    -
  • Call this method after joining a channel.
    • -
  • See recommended settings in Set the Subscribing State.
    • -
+
+
+
+ Call timing +

Call this method after joining a channel.

+
+
+ Restrictions +

None.

+
+
Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_querycamerafocallengthcapability.dita b/en-US/dita/RTC-NG/API/api_irtcengine_querycamerafocallengthcapability.dita index 0cd4cd612f6..c3cbcc7b369 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_querycamerafocallengthcapability.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_querycamerafocallengthcapability.dita @@ -35,6 +35,7 @@

If you want to enable the wide-angle or ultra-wide-angle mode for camera capture, it is recommended to start by calling this method to check whether the device supports the required focal length capability. Then, adjust the camera's focal length configuration based on the query result by calling , ensuring the best camera capture performance.

+ For the specific implementation of querying camera focal length capabilities through this method, refer to the provided . This method is for Android and iOS only.
Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita b/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita index 1eb20638d1a..401d5cdb606 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita @@ -2,7 +2,7 @@ <ph keyref="queryCodecCapability"/> - Queries the current device's supported video codec capabilities. + Queries the video codec capabilities of the SDK. @@ -40,10 +40,10 @@ codecInfo -

Input and output parameter. An array representing the video codec capabilities of the device. See .

+

Input and output parameter. An array representing the video codec capabilities of the SDK. See .

  • Input value: One defined by the user when executing this method, representing the video codec capability to be queried.
    • -
  • Output value: The after the method is executed, representing the actual video codec capabilities supported by the device.
    • +
  • Output value: The after the method is executed, representing the actual video codec capabilities of the SDK.
 diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectparameters.dita index cb0cd729e94..3a7d391886c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectparameters.dita @@ -38,12 +38,11 @@
  • Pitch correction effect: Sets the basic mode and tonic pitch of the pitch correction effect. Different songs have different modes and tonic pitches. Agora recommends bounding this method with interface elements to enable users to adjust the pitch correction interactively.

    • After setting the audio parameters, all users in the channel can hear the effect.

    +

    • You can call this method either before or after joining a channel.
      • -
    • To get better audio effect quality, Agora recommends setting the scenario parameter of as (3) before calling this method.
      • -
    • Do not set the profile parameter in to (1) or (6), or the method does not take effect.
      • -
    • Do not set the profile parameter in to (1), or the method does not take effect.
      • +
    • This method has the best effect on human voice processing, and Agora does not recommend calling this method to process audio data containing music.
    • After calling , Agora does not recommend you to call the following methods, otherwise the effect set by will be overwritten:
        • @@ -62,10 +61,10 @@ preset The options for SDK preset audio effects:
        • , 3D voice effect:
            -
          • Call and set the profile parameter in to (3) or (5) before setting this enumerator; otherwise, the enumerator setting does not take effect.
            • +
          • You need to set the profile parameter in to (3) or (5) before setting this enumerator; otherwise, the enumerator setting does not take effect.
          • If the 3D voice effect is enabled, users need to use stereo audio playback devices to hear the anticipated voice effect.
          • -
        • , Pitch correction effect: To achieve better audio effect quality, Agora recommends setting the profile parameter in to (4) or (5) before setting this enumerator.
          • +
        • , Pitch correction effect:
         diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectpreset.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectpreset.dita index 4dabf493887..6188268cca1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectpreset.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectpreset.dita @@ -28,13 +28,11 @@ Details

        Call this method to set an SDK preset audio effect for the local user who sends an audio stream. This audio effect does not change the gender characteristics of the original voice. After setting an audio effect, all users in the channel can hear the effect.

        You can set different audio effects for different scenarios. See .

        -

        To get better audio effect quality, Agora recommends setting the scenario parameter of as (3) before calling this method.

        +

        • You can call this method either before or after joining a channel.
          • -
        • Do not set the profile parameter in to (1) or (6), or the method does not take effect.
          • -
        • Do not set the profile parameter in to (1), or the method does not take effect.
          • -
        • This method has the best effect on human voice processing, and Agora does not recommend calling this method to process audio data containing music.
          • +
        • If you call and set enumerators except for or , do not call ; otherwise, is overridden.
        • After calling , Agora does not recommend you to call the following methods, otherwise the effect set by will be overwritten:
            • @@ -58,13 +56,13 @@
          • : The reverberation style typical of a concert hall.
          • : The reverberation style typical of a recording studio.
          • : The reverberation style typical of the vintage phonograph.
            • -
          • : A virtual stereo effect that renders monophonic audio as stereo audio. Before using this preset, set the profile parameter of to or ; otherwise, the preset setting is invalid.
            • +
          • : A virtual stereo effect that renders monophonic audio as stereo audio. Before using this preset, set the profile parameter of to (4) or (5) ; otherwise, the preset setting is invalid.
          • : A more spatial audio effect.
          • : A more ethereal audio effect.
          • : Virtual surround sound, that is, the SDK generates a simulated surround sound field on the basis of stereo channels, thereby creating a surround sound effect.If the virtual surround sound is enabled, users need to use stereo audio playback devices to hear the anticipated audio effect.
          • : A chorus audio effect. Agora recommends using this effect in chorus scenarios to enhance the sense of depth and dimension in the vocals.
          • : A 3D voice effect that makes the voice appear to be moving around the user. The default cycle period is 10 seconds. After setting this effect, you can call to modify the movement period.
              -
            • Before using this preset, set the profile parameter of to or ; otherwise, the preset setting is invalid.
              • +
            • Before using this preset, set the profile parameter of to (3) or (5); otherwise, the preset setting is invalid.
            • If the 3D voice effect is enabled, users need to use stereo audio playback devices to hear the anticipated voice effect.
          • : The reverberation style typical of an uncle's voice. Agora recommends using this preset to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.
            • @@ -74,8 +72,8 @@
          • : The voice of a girl. Agora recommends using this preset to process a female-sounding voice; otherwise, you may not hear the anticipated voice effect.
          • : The voice of Pig King, a character in Journey to the West who has a voice like a growling bear.
          • : The voice of the Hulk.
            • -
          • : The reverberation style typical of R&B music. Before using this preset, set the profile parameter of to or ; otherwise, the preset setting is invalid.
            • -
          • : The reverberation style typical of popular music. Before using this preset, set the profile parameter of to or ; otherwise, the preset setting is invalid.
            • +
          • : The reverberation style typical of R&B music. Before using this preset, set the profile parameter of to (4) or (5) ; otherwise, the preset setting is invalid.
            • +
          • : The reverberation style typical of popular music. Before using this preset, set the profile parameter of to (4) or (5) ; otherwise, the preset setting is invalid.
          • : A pitch correction effect that corrects the user's pitch based on the pitch of the natural C major scale. After setting this voice effect, you can call to adjust the basic mode of tuning and the pitch of the main tone.
          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 250635115c1..40338a85cdd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile.dita @@ -35,7 +35,7 @@
          Details
          - +
          Deprecated:
          This method is deprecated. If you need to set the audio profile, use ; if you need to set the audio scenario, use .
           diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita index 1b50c2fe7a9..634ef94e76f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita @@ -29,13 +29,15 @@
          Details -

          You can call this method either before or after joining the channel to set the user role as audience or host.

          +

          In the interactive live streaming profile, the SDK sets the user role as audience by default. You can call this method to set the user role as host.

          +

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

          -

          If you call this method to switch the user role after joining the channel, the SDK triggers the following callbacks:

            -
          • The local client: .
            • -
          • The remote client: or ().
            • -

          -
          +

          If you call this method to switch the user role after joining a channel, the SDK automatically does the following:

            +
          • Calls and to change the publishing state.
            • +
          • Triggers on the local client.
            • +
          • Triggers or on the remote client.
            • +

          +
    Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita index 32179a43fd6..c2b8e7e755f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita @@ -45,7 +45,7 @@
  • Video broadcast: Speakerphone.

    • You can call this method to change the default audio route. After a successful method call, the SDK triggers the callback.

    - +

    The system audio route changes when an external audio device, such as a headphone or a Bluetooth audio device, is connected. See Audio Route for detailed change principles.
    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita index a91c6239b65..0da33e6a87d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita @@ -24,7 +24,7 @@ Future<void> setEnableSpeakerphone(bool speakerOn);

    Details -

    If the default audio route of the SDK (see Set the Audio Route) or the setting in cannot meet your requirements, you can call to switch the current audio route. After a successful method call, the SDK triggers the callback.

    +

    If the default audio route of the SDK (see Set the Audio Route) or the setting in cannot meet your requirements, you can call to switch the current audio route. After a successful method call, the SDK triggers the callback.

    This method only sets the audio route in the current channel and does not influence the default audio route. If the user leaves the current channel and joins another channel, the default audio route is used.

      diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierparameters.dita index a63cf5ce0ab..58bd18a0823 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierparameters.dita @@ -34,11 +34,11 @@
      Details

      Call this method to set a gender characteristic and a reverberation effect for the singing beautifier effect. This method sets parameters for the local user who sends an audio stream. After setting the audio parameters, all users in the channel can hear the effect.

      -

      For better voice effects, Agora recommends that you call and set scenario to (3) and profile to (4) or (5) before calling this method.

      +

      • You can call this method either before or after joining a channel.
        • -
      • Do not set the profile parameter in to (1) or (6), or the method does not take effect.
        • +
      • This method has the best effect on human voice processing, and Agora does not recommend calling this method to process audio data containing music.
      • After calling , Agora does not recommend calling the following methods, otherwise the effect set by will be overwritten:
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita index c20033ca101..2e5bb9fcc6e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita @@ -27,11 +27,15 @@
          Details

          Call this method to set a preset voice beautifier effect for the local user who sends an audio stream. After setting a voice beautifier effect, all users in the channel can hear the effect. You can set different voice beautifier effects for different scenarios. For the applicable scenarios of each voice beautifier effect, refer to Set the Voice Effect.

          -

          For better voice effects, Agora recommends that you call and set scenario to (3) and profile to (4) or (5) before calling this method.

          +

          To achieve better vocal effects, it is recommended that you call the following APIs before calling this method:

            +
          • Call to set the audio scenario to high-quality audio scenario, namely (3).
            • +
          • Call to set the profile parameter to (4) or (5).
            • +
          +

          • You can call this method either before or after joining a channel.
            • -
          • Do not set the profile parameter in to (1) or (6), or the method does not take effect.
            • +
          • Do not set the profile parameter in to (1) or (6), or the method does not take effect.
          • This method has the best effect on human voice processing, and Agora does not recommend calling this method to process audio data containing music.
          • After calling , Agora does not recommend calling the following methods, otherwise the effect set by will be overwritten:
              • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvoiceconversionpreset.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvoiceconversionpreset.dita index 8095efd1edc..711bed04449 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvoiceconversionpreset.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvoiceconversionpreset.dita @@ -28,11 +28,11 @@ Details

              Call this method to set a preset voice beautifier effect for the local user who sends an audio stream. After setting an audio effect, all users in the channel can hear the effect. You can set different voice beautifier effects for different scenarios.

              The applicable scenarios for each voice-changing effect can be referred to .

              -

              To achieve better audio effect quality, Agora recommends that you call and set the profile to (4) or (5) and scenario to (3) before calling this method.

              +

              • You can call this method either before or after joining a channel.
                • -
              • Do not set the profile parameter in to (1) or (6), or the method does not take effect.
                • +
              • This method has the best effect on human voice processing, and Agora does not recommend calling this method to process audio data containing music.
              • After calling , Agora does not recommend you to call the following methods, otherwise the effect set by will be overwritten:
                  • diff --git a/en-US/dita/RTC-NG/API/callback_iaudioframeobserver_onplaybackaudioframebeforemixing.dita b/en-US/dita/RTC-NG/API/callback_iaudioframeobserver_onplaybackaudioframebeforemixing.dita index a97597884f7..4305f639cb3 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudioframeobserver_onplaybackaudioframebeforemixing.dita +++ b/en-US/dita/RTC-NG/API/callback_iaudioframeobserver_onplaybackaudioframebeforemixing.dita @@ -2,7 +2,7 @@ <ph keyref="onPlaybackAudioFrameBeforeMixing"/> - Retrieves the audio frame of a specified user before mixing. + Retrieves the audio frame before mixing of subscribed remote users. @@ -52,7 +52,7 @@ uid userId - The user ID of the specified user. + The ID of subscribed remote users. audioFrame diff --git a/en-US/dita/RTC-NG/API/class_agorartcdeviceinfo.dita b/en-US/dita/RTC-NG/API/class_agorartcdeviceinfo.dita index 12dbe161746..dd0ffadc826 100644 --- a/en-US/dita/RTC-NG/API/class_agorartcdeviceinfo.dita +++ b/en-US/dita/RTC-NG/API/class_agorartcdeviceinfo.dita @@ -1,7 +1,7 @@ - <ph keyref="AgoraRtcDeviceInfo" /> + <ph keyref="AgoraRtcDeviceInfo"/> The class that provides device information.
                  @@ -21,22 +21,26 @@

                  +
                  - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> - - type - The device type. See . - - - deviceId - The device ID. - - - deviceName - The device name. - - -
                  + + type + The device type. See . + + + deviceId + The device ID. + + + deviceName + The device name. + + + deviceTypeName + The type of audio devices, such as built-in, USB and HDMI. + +
          - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita b/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita index c12eb652dd2..cc639c145f1 100644 --- a/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita @@ -142,6 +142,19 @@ struct FChannelMediaRelayConfiguration getDestChannelMediaInfos Gets the information of the target channel. See . + +
      +
      + Method + + + setDestinationInfo + Sets the information of the target channel. See . + + + removeDestinationInfoForChannelName + Deletes the information of target channel. See . +
      @@ -179,14 +192,6 @@ struct FChannelMediaRelayConfiguration destCount The number of target channels. The default value is 0, and the value range is from 0 to 6. Ensure that the value of this parameter corresponds to the number of structs you define in destInfo. - - setDestinationInfo - Sets the information of the target channel. See . - - - removeDestinationInfoForChannelName - Deletes the information of target channel. See . -
      diff --git a/en-US/dita/RTC-NG/API/class_codeccapinfo.dita b/en-US/dita/RTC-NG/API/class_codeccapinfo.dita index 23354443b0e..9610cf30498 100644 --- a/en-US/dita/RTC-NG/API/class_codeccapinfo.dita +++ b/en-US/dita/RTC-NG/API/class_codeccapinfo.dita @@ -2,7 +2,7 @@ <ph keyref="CodecCapInfo"/> - The codec capability of the device. + The codec capability of the SDK.

      @@ -109,7 +109,7 @@ class CodecCapInfo { codecCapMask - The bit mask of the codec type. See . + Bit mask of the codec types in SDK. See .

      The bit mask of the codec type:

      • (0): The device does not support encoding or decoding.
        • @@ -122,7 +122,7 @@ class CodecCapInfo { codecLevels - The level of the codec capability. See . + Codec capability of the SDK. See .
      diff --git a/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita b/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita index 62f6c6a2b4b..bcc6cb8b130 100644 --- a/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita +++ b/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita @@ -254,7 +254,7 @@ struct FScreenCaptureParameters
    <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> - The video profiles of the shared screen stream are only set by , independent of . + The video properties of the screen sharing stream only need to be set through , and are unrelated to . dimensions @@ -276,11 +276,11 @@ struct FScreenCaptureParameters frameRate - The frame rate of the shared region. The video encoding resolution of the shared screen stream. On Windows and macOS, this represents the video encoding frame rate (fps) of the shared screen stream. The frame rate (fps) of the shared region. The default value is 5. Agora does not recommend setting this to a value greater than 15. + The frame rate of the shared region. The video encoding frame rate of the screen sharing stream. On Windows and macOS, this represents the video encoding frame rate (fps) of the screen sharing stream. The frame rate (fps) of the shared region. The default value is 5. Agora does not recommend setting this to a value greater than 15. bitrate - The bitrate of the shared region. The video encoding bitrate of the shared screen stream. On Windows and macOS, this represents the video encoding bitrate of the shared screen stream. The bitrate (Kbps) of the shared region. The default value is 0 (the SDK works out a bitrate according to the dimensions of the current screen). + The bitrate of the shared region. The video encoding bitrate of the screen sharing stream. On Windows and macOS, this represents the video encoding bitrate of the screen sharing stream. The bitrate (Kbps) of the shared region. The default value is 0 (the SDK works out a bitrate according to the dimensions of the current screen). captureMouseCursor diff --git a/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita b/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita index cbabaf63a88..e8302ef20eb 100644 --- a/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita @@ -580,7 +580,7 @@ struct FVideoEncoderConfiguration bitrate -

    The encoding bitrate (Kbps) of the video. See . This parameter does not need to be set; keeping the default value is sufficient. The SDK automatically matches the most suitable bitrate based on the video resolution and frame rate you have set. For the correspondence between video resolution, frame rate, and bitrate, please refer to .

    +

    The encoding bitrate (Kbps) of the video. See . This parameter does not need to be set; keeping the default value is sufficient. The SDK automatically matches the most suitable bitrate based on the video resolution and frame rate you have set. For the correspondence between video resolution and frame rate, see .

    • (0): (Recommended) Standard bitrate mode.
    • (-1): Adaptive bitrate mode. In general, Agora suggests that you do not use this value.
      • diff --git a/en-US/dita/RTC-NG/API/enum_codeccapmask.dita b/en-US/dita/RTC-NG/API/enum_codeccapmask.dita index 384acebff7c..301ba9cdc97 100644 --- a/en-US/dita/RTC-NG/API/enum_codeccapmask.dita +++ b/en-US/dita/RTC-NG/API/enum_codeccapmask.dita @@ -2,7 +2,7 @@ <ph keyref="CODEC_CAP_MASK"/> - The bit mask that indicates the device codec capability. + The bit mask of the codec type.
      diff --git a/en-US/dita/RTC-NG/API/rtc_api_overview.dita b/en-US/dita/RTC-NG/API/rtc_api_overview.dita index d8e44520077..5a18706c23e 100644 --- a/en-US/dita/RTC-NG/API/rtc_api_overview.dita +++ b/en-US/dita/RTC-NG/API/rtc_api_overview.dita @@ -1066,8 +1066,8 @@ - - + +