diff --git a/dita/RTC-NG/config/keys-rtc-ng-links-android.ditamap b/dita/RTC-NG/config/keys-rtc-ng-links-android.ditamap index d26b11c685f..82820292ad1 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-links-android.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-links-android.ditamap @@ -26,7 +26,7 @@ - + 使用 Token 鉴权 diff --git a/dita/RTC-NG/release/release_notes.dita b/dita/RTC-NG/release/release_notes.dita index 92c493b0071..25d20079f82 100644 --- a/dita/RTC-NG/release/release_notes.dita +++ b/dita/RTC-NG/release/release_notes.dita @@ -95,8 +95,8 @@
    • -
  • 中新增 d3d11_texture_2d 和 texture_slice_index 成员
    • (Windows) -
  • 中新增 枚举
    • (Windows) +
  • 中新增 d3d11_texture_2d 和 texture_slice_index 成员(Windows)
    • +
  • 中新增 枚举 (Windows)
  • 新增
  • 中的 type 新增
    • diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita index f975af88eb9..58a6d0c220b 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita @@ -34,7 +34,7 @@ delegate audioFrameObserver -

    The observer instance. See . Set the value as to release the instance. Agora recommends calling this method after receiving to release the audio observer object.

    +

    The observer instance. See . Set the value as to release the instance. Agora recommends calling this method after receiving to release the audio observer object.

     diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita index 554513bc41a..dda5ec73c03 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita @@ -43,7 +43,7 @@ observer delegate videoFrameObserver - The observer instance. See . To release the instance, set the value as . + The observer instance. See . To release the instance, set the value as . mode diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita index 88f96236625..70ae00486c1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita @@ -45,7 +45,7 @@

    Call this method before calling or .

      -
    • This feature requires high performance devices. Agora recommends that you implement it on devices equipped with the following chips:
        +
      • This feature has high requirements on device performance. When calling this method, the SDK automatically checks the capabilities of the current device. Agora recommends you use virtual background on devices with the following processors:
        • Snapdragon 700 series 750G and later
        • Snapdragon 800 series 835 and later
        • Dimensity 700 series 720 and later
          • @@ -101,9 +101,7 @@
          • 0: Success.
          • < 0: Failure.
              -
            • -1: The custom background image does not exist. Check the value of source in .
              • -
            • -2: The color format of the custom background image is invalid. Check the value of color in .
              • -
            • -3: The device does not support virtual background.
              • +
            • -4: The device capabilities do not meet the requirements for the virtual background feature. Agora recommends you try it on devices with higher performance.
          diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita index a1e600dee2c..24cd71b9cb2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita @@ -48,7 +48,7 @@ iconSize - The target size of the icon corresponding to the application program (the width and height are in pixels). See . The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and iconSize is 100 × 100, the actual size of the icon is 100 × 75. If the target size is larger than the original size, the icon is the original image and the SDK does not scale it. + The target size of the icon corresponding to the application program (the width and height are in pixels). See . The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and iconSize is 100 × 100, the actual size of the icon is 100 × 75. If the target size is larger than the original size, the icon is the original image and the SDK does not scale it. includeScreen diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_muteallremoteaudiostreams.dita b/en-US/dita/RTC-NG/API/api_irtcengine_muteallremoteaudiostreams.dita index acba03b05c1..6a271be7b98 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_muteallremoteaudiostreams.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_muteallremoteaudiostreams.dita @@ -29,7 +29,8 @@
          • 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.
            • +
          • See recommended settings in Set the Subscribing State.
            • +
          Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita index 846a47ea1c4..899a4c05d81 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita @@ -40,7 +40,8 @@
          • Call this method before calling or .
          • This method only applies to Android 5.0 or later.
            • -
          • This method relies on the video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
            • +
          • This method relies on the image enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
            • +
          • This feature has high requirements on device performance. When calling this method, the SDK automatically checks the capabilities of the current device.
          @@ -68,9 +69,15 @@

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

          • 0: Success.
            • -
          • < 0: Failure.
              -
            • (4): The current device version is below Android 5.0, and this operation is not supported.
              • -
            • -
          +
        • < 0: Failure.
            +
          • -4: The current device does not support this feature. Possible reasons include:
              +
            • The current device capabilities do not meet the requirements for image enhancement. Agora recommends you replace it with a high-performance device.
              • +
            • The current device version is lower than Android 5.0 and does not support this feature. Agora recommends you replace the device or upgrade the operating system.
              • +
            +
            • +
          +
          • +
        + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita index 80c45acc675..62325ecc626 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita @@ -48,7 +48,7 @@
      • When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).
      • When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using .
      • -
    • This method relies on the video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
      • +
    • This method relies on the image enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita index 194df414a2a..94341a13808 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita @@ -48,7 +48,7 @@
  • When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).
  • When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using .
    • -
  • This method relies on the video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    • +
  • This method relies on the image enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    • Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita index 9b16e756311..7c58a552b8a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita @@ -48,7 +48,7 @@
  • When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).
  • When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using .
    • -
  • This method relies on the video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    • +
  • This method relies on the image enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    • Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremoteaudiostreamsex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremoteaudiostreamsex.dita index ae3e499e122..be30a0d5d6f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremoteaudiostreamsex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremoteaudiostreamsex.dita @@ -37,7 +37,7 @@
    • 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.
      • +
    • See recommended settings in Set the Subscribing State.
    Parameters diff --git a/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita b/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita index 95fe49b0845..4e662aba898 100644 --- a/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita +++ b/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita @@ -688,7 +688,7 @@ class ChannelMediaOptions { token -

    (Optional) The token generated on your server for authentication. See Authenticate Your Users with Token.

    +

    (Optional) The token generated on your server for authentication. See .

    • This parameter takes effect only when calling or .
      • diff --git a/en-US/dita/RTC-NG/API/class_livetranscoding.dita b/en-US/dita/RTC-NG/API/class_livetranscoding.dita index 003438e6b86..55d9152e9b5 100644 --- a/en-US/dita/RTC-NG/API/class_livetranscoding.dita +++ b/en-US/dita/RTC-NG/API/class_livetranscoding.dita @@ -595,7 +595,7 @@ videoBitrate

      Bitrate of the output video stream for Media Push in Kbps. The default value is 400 Kbps.

      -

      Set this member according to the Video profile table. If you set a bitrate beyond the proper range, the SDK automatically adapts it to a value within the range.

      +

      Set this member according to the table. If you set a bitrate beyond the proper range, the SDK automatically adapts it to a value within the range.

       diff --git a/en-US/dita/RTC-NG/API/enum_audioprocessingchannels.dita b/en-US/dita/RTC-NG/API/enum_audioprocessingchannels.dita index 7f5b098e3b6..0d014c86014 100644 --- a/en-US/dita/RTC-NG/API/enum_audioprocessingchannels.dita +++ b/en-US/dita/RTC-NG/API/enum_audioprocessingchannels.dita @@ -12,8 +12,8 @@

        -
      • The stereo setting only takes effect when the SDK uses the media volume. See . See and .
        • -
      • On iOS, stereo audio requires high device performance. Stereo audio is only supported on the following devices using iOS 14.0 and later:
          +
        • The stereo setting only takes effect when the SDK uses the media volume. See . See and .
          • +
        • On iOS, stereo audio requires high device performance. Stereo audio is only supported on the following devices using iOS 14.0 and later:
          • iPhone XS
          • iPhone XS Max
          • iPhone XR
            • 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 3372dce08d9..b9281e0d8e8 100644 --- a/en-US/dita/RTC-NG/API/rtc_api_overview.dita +++ b/en-US/dita/RTC-NG/API/rtc_api_overview.dita @@ -904,10 +904,6 @@ (For Windows and macOS only) - - - (For Windows only) - (For Windows and macOS only) diff --git a/en-US/dita/RTC-NG/release/release_notes.dita b/en-US/dita/RTC-NG/release/release_notes.dita index c94ee273986..89d6919e565 100644 --- a/en-US/dita/RTC-NG/release/release_notes.dita +++ b/en-US/dita/RTC-NG/release/release_notes.dita @@ -17,9 +17,9 @@
          • An optional parameter serverConfig is added in , which is for server-side configuration related to video screenshot and upload via extensions from Agora Extensions Marketplace. By configuring this parameter, you can integrate multiple third-party moderation extensions and achieve flexible control over extension switches and other features. For more details, please contact .
          In addition, this version also introduces the method, which supports taking screenshots for multiple video streams and uploading them.

          • -
        • ID3D11Texture2D Rendering

          As of this release, the SDK supports video formats of type ID3D11Texture2D, improving the rendering effect of video frames in game scenarios. You can set format to VIDEO_TEXTURE_ID3D11TEXTURE2D when pushing external raw video frames to the SDK by calling . By setting the d3d11_texture_2d and texture_slice_index properties, you can determine the ID3D11Texture2D texture object to use.

          +
        • ID3D11Texture2D Rendering (Windows)

          As of this release, the SDK supports video formats of type ID3D11Texture2D, improving the rendering effect of video frames in game scenarios. You can set format to VIDEO_TEXTURE_ID3D11TEXTURE2D when pushing external raw video frames to the SDK by calling . By setting the d3d11_texture_2d and texture_slice_index properties, you can determine the ID3D11Texture2D texture object to use.

          • -
        • Local video status error code update

          In order to help users understand the exact reasons for local video errors in screen sharing scenarios, the following sets of enumerations have been added to the callback:

            +
          • Local video status error code update (Windows, macOS)

            In order to help users understand the exact reasons for local video errors in screen sharing scenarios, the following sets of enumerations have been added to the callback:

            • (23): Screen capture has been paused. Common scenarios for reporting this error code: The current screen may have been switched to a secure desktop, such as a UAC dialog box or Winlogon desktop.
            • (24): Screen capture has resumed from the paused state.
            • (25): The window being captured on the current screen is in a hidden state and is not visible on the current screen.
              • @@ -27,6 +27,10 @@
            • (27): The window for screen capture has been restored from the minimized state.

            • +
          • Check device support for advanced features

            This version adds the method to check whether the capability of the current device meets the requirements of the specified advanced feature, such as virtual background and image enhancement.

            +

            Before using advanced features, you can check whether the current device supports these features based on the call result. This helps to avoid performance degradation or unavailable features when enabling advanced features on low-end devices. Based on the return value of this method, you can decide whether to display or enable the corresponding feature button, or notify the user when the device's capabilities are insufficient.

            +

            In addition, since this version, calling and automatically triggers a test on the capability of the current device. When the device is considered underperformed, the error code -4: is returned, indicating the device does not support the feature.

            +
            • @@ -36,7 +40,7 @@
            1. Optimize virtual background memory usage

              This version has upgraded the virtual background algorithm, reducing the memory usage of the virtual background feature. Compared to the previous version, the memory consumption of the app during the use of the virtual background feature on low-end devices has been reduced by approximately 4% to 10% (specific values may vary depending on the device model and platform).

              2. -
            2. Screen sharing scenario optimization

              This release optimizes the performance and encoding efficiency in ultra-high-definition (4K, 60 fps) game sharing scenarios, effectively reducing the system resource usage during screen sharing.

              +
            3. Screen sharing scenario optimization

              This release optimizes the performance and encoding efficiency in ultra-high-definition (4K, 60 fps) game sharing scenarios, effectively reducing the system resource usage during screen sharing.

              This release also optimizes the video encoding configuration in screen sharing scenarios. When users customize the width and height properties of the video, the SDK rounds down the actual encoding resolution while maintaining the aspect ratio of the video and the screen, ensuring that the final encoding resolution does not exceed the user-defined encoding resolution, thereby improving the accuracy of billing for screen sharing streams.

            @@ -53,9 +57,9 @@

            This release fixed the following issues:

              -
            • Occasional crashes and dropped frames occured in screen sharing scenarios.
              • +
            • Occasional crashes and dropped frames occured in screen sharing scenarios. (Windows)
            • When using the H.265 encoding mode, when a Web client joined the interactivity, it caused a redundant callback on the native side: when the host called (true), the receiving end first received a callback (with enabled as false) before receiving a callback (with enabled as true).
              • -

            • Occasional crashes when joining a channel. (macOS)

              • +

            • Occasional crashes when joining a channel. (macOS)

            • Occasional failure of joining a channel when the local system time was not set correctly.
            • When calling the method to play two audio files using the same soundId, the first audio file was somtimes played repeatedly.

            • When the host called the method to play music, sometimes the host couldn't hear the music while the remote users could hear it. (Android)

              • @@ -71,16 +75,14 @@ API changes

              Added

                -
              • The following enumerations in :
                  +
                • The following enumerations in : (Windows, macOS)
                  • -
                • d3d11_texture_2d and texture_slice_index members in .
                  • -
                • in .
                  • -
                  • +
                • d3d11_texture_2d and texture_slice_index members in .(Windows)
                • in .(Windows)
                • in .
                • in type of .
                • serverConfig in