update 4.6.1

Author: zhangwei

Android/APIExample-Audio/gradle.properties

@@ -23,4 +23,4 @@ android.nonFinalResIds=false
 # read enable simple filter section on README first before set this flag to TRUE
 simpleFilter = false
 
-rtc_sdk_version = 4.6.0
+rtc_sdk_version = 4.6.1

Android/APIExample-Compose/gradle.properties

@@ -22,4 +22,4 @@ kotlin.code.style=official
 # thereby reducing the size of the R class for that library
 android.nonTransitiveRClass=true
 
-rtc_sdk_version = 4.6.0
+rtc_sdk_version = 4.6.1

Android/APIExample/agora-simple-filter/src/main/cpp/AgoraRtcKit/AgoraBase.h

@@ -560,6 +560,11 @@ enum ERROR_CODE_TYPE {
    * fails to allocate any resource.
    */
   ERR_RESOURCE_LIMITED = 22,
+  /**
+   * 23: The function is prohibited. Please allow it in the console, or contact the Agora technical support.
+   * @technical preview
+   */
+  ERR_FUNC_IS_PROHIBITED = 23,
   /**
    * 101: The App ID is invalid, usually because the data format of the App ID is incorrect.
    *
@@ -2266,16 +2271,8 @@ struct SimulcastConfig {
    * 
    */
   bool publish_fallback_enable;
-  /**
-   * Whether to enable on-demand publishing. When set to true, a simulcast layer will only be published
-   * when there are subscribers requesting that layer.
-   * - true: (Default) Enable on-demand publishing.
-   * - false: Disable on-demand publishing. All enabled simulcast layers will be published regardless
-   * of subscription status.
-   */
-  bool publish_on_demand;
 
-  SimulcastConfig(): publish_fallback_enable(false), publish_on_demand(true) {}
+  SimulcastConfig(): publish_fallback_enable(false) {}
 };
 /**
  * The location of the target area relative to the screen or window. If you do not set this parameter,
@@ -2565,6 +2562,7 @@ struct WatermarkConfig {
 enum MultipathMode {
   /**
     * Duplicate mode, the same piece of data is redundantly transmitted over all available paths.
+    * @technical preview
     */
   Duplicate= 0,
   /**
@@ -3490,8 +3488,6 @@ enum LOCAL_VIDEO_STREAM_REASON {
   LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_INTERRUPTED_BY_OTHER = 32,
   /* 32: (HMOS only) ScreenCapture stopped by SIM call */
   LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_STOPPED_BY_CALL = 33,
-  /* 34: HDR Video Source fallback to SDR */
-  LOCAL_AUDIO_STREAM_REASON_VIDEO_SOURCE_HDR_TO_SDR = 34,
 };
 
 /**
@@ -5656,22 +5652,53 @@ struct VirtualBackgroundSource {
         blur_degree(BLUR_DEGREE_HIGH) {}
 };
 
+/**
+ * The properties for virtual background algorithm.
+ */
 struct SegmentationProperty {
+  /** The type of algorithms for segmentation processing.
+   */
   enum SEG_MODEL_TYPE {
+    /** 1: (Default) AI segmentation algorithm.
+     */
     SEG_MODEL_AI = 1,
+    /** 2: Green screen segmentation algorithm.
+     */
     SEG_MODEL_GREEN = 2
   };
 
+  /** The color of the screen for green screen segmentation.
+   */
   enum SCREEN_COLOR_TYPE {
+    /** 0: (Default) Automatically recognizes the screen color.
+     */
     SCREEN_COLOR_AUTO = 0,
+    /** 1: Green.
+     */
     SCREEN_COLOR_GREEN = 1,
+    /** 2: Blue.
+     */
     SCREEN_COLOR_BLUE = 2
   };
 
+  /** The type of segmentation algorithm. See #SEG_MODEL_TYPE.
+   * The default value is `SEG_MODEL_AI`.
+   */
   SEG_MODEL_TYPE modelType;
 
+  /** The color tolerance for green screen segmentation.
+   *
+   * This parameter is only effective when `modelType` is set to `SEG_MODEL_GREEN`.
+   * The value ranges from 0.0 to 1.0, with a default of 0.5.
+   * A larger value widens the range of identifiable shades of the screen color. Setting the value too high may cause parts of the portrait to be detected as the background.
+   * Agora recommends dynamically adjusting this value based on the observed segmentation effect.
+   */
   float greenCapacity;
 
+  /** The color of the screen for green screen segmentation. See #SCREEN_COLOR_TYPE.
+   *
+   * This property is only for green screen segmentation. The default value is `SCREEN_COLOR_AUTO`.
+   */
   SCREEN_COLOR_TYPE screenColorType;
 
   SegmentationProperty() : modelType(SEG_MODEL_AI), greenCapacity(0.5), screenColorType(SCREEN_COLOR_AUTO) {}
@@ -6884,7 +6911,9 @@ enum RENEW_TOKEN_ERROR_CODE {
    */
   RENEW_TOKEN_SUCCESS = 0,
   /**
-   * 1: It is recommended that the user generate a new token and retry renewToken.
+   * 1: The token renewal failed because of some unknown server error.
+   * It is recommended that the user check the parameters passed in when generating the token and
+   * generate a new token and retry renewToken.
    */
   RENEW_TOKEN_FAILURE = 1,
   /**
@@ -6893,12 +6922,18 @@ enum RENEW_TOKEN_ERROR_CODE {
    */
   RENEW_TOKEN_TOKEN_EXPIRED = 2,
   /**
-   * 3: The token renewal failed because the provided token is invalid.
-   * It is recommended that the user check the token generation process, generate a new token, and retry renewToken.
+   * 3: The token renewal failed because the token is not valid. Typical reasons include:
+   * - The App Certificate for the project is enabled in Agora Console, but you do not use a token
+   * when joining the channel. If you enable the App Certificate, you must use a token to join the
+   * channel.
+   * - The `uid` specified when calling `joinChannel` to join the channel is inconsistent with the
+   * `uid` passed in when generating the token.
+   * - The `channelName` specified when calling `joinChannel` to join the channel is inconsistent 
+   * with the `channelName` passed in when generating the token.
    */
   RENEW_TOKEN_INVALID_TOKEN = 3,
   /**
-   * 4: The token renewal failed because the channel name in the token does not match the current channel.
+   * 4: The token renewal failed because the channel name is invalid.
    * It is recommended that the user check the channel name, generate a new token, and retry renewToken.
    */
   RENEW_TOKEN_INVALID_CHANNEL_NAME = 4,

Android/APIExample/agora-simple-filter/src/main/cpp/AgoraRtcKit/NGIAgoraRtcConnection.h

@@ -531,6 +531,12 @@ class IRtcConnection : public RefCountInterface {
    * When enabled, the SDK can use multiple network paths for data transmission,
    * which can improve the reliability and performance of the connection.
    *
+   * @note
+   * - Permission And System Required:
+   *   - Android: Android 7.0 or later(API level 24 or later), with ACCESS_NETWORK_STATE and CHANGE_NETWORK_STATE permission.
+   *   - IOS: IOS 12.0 or later
+   *   - Macos: 10.14 or later
+   *   - Windows: Windows Vista or later
    * @param enable A boolean value indicating whether to enable (true) or disable (false) multipath.
    * @param ares A reference for asynchronous operations, defaulting to AOSL_REF_INVALID.
    * @return

Android/APIExample/agora-simple-filter/src/main/cpp/AgoraRtcKit/NGIAgoraVideoTrack.h

@@ -326,6 +326,7 @@ struct LocalVideoTrackStats {
   int height;
   uint32_t encoder_type;
   uint32_t hw_encoder_accelerating;
+  uint32_t encoder_frame_depth;
   /*
    * encoder vender id, VideoCodecVenderId
   */
@@ -349,8 +350,6 @@ struct LocalVideoTrackStats {
 
   SimulcastStreamProfile simulcast_stream_profile[STREAM_LAYER_COUNT_MAX];
 
-  uint8_t hdr_stream_encoder;
-
   LocalVideoTrackStats() : number_of_streams(0),
                            bytes_major_stream(0),
                            bytes_minor_stream(0),
@@ -373,12 +372,12 @@ struct LocalVideoTrackStats {
                            height(0),
                            encoder_type(0),
                            hw_encoder_accelerating(0),
+                           encoder_frame_depth(8),
                            encoder_vender_id(0),
                            uplink_cost_time_ms(0),
                            quality_adapt_indication(ADAPT_NONE),
                            txPacketLossRate(0),
-                           capture_brightness_level(CAPTURE_BRIGHTNESS_LEVEL_INVALID),
-                           hdr_stream_encoder(0)  {}
+                           capture_brightness_level(CAPTURE_BRIGHTNESS_LEVEL_INVALID) {}
 };
 
 /**

Android/APIExample/agora-stream-encrypt/src/main/cpp/include/agora/AgoraBase.h

@@ -560,6 +560,11 @@ enum ERROR_CODE_TYPE {
    * fails to allocate any resource.
    */
   ERR_RESOURCE_LIMITED = 22,
+  /**
+   * 23: The function is prohibited. Please allow it in the console, or contact the Agora technical support.
+   * @technical preview
+   */
+  ERR_FUNC_IS_PROHIBITED = 23,
   /**
    * 101: The App ID is invalid, usually because the data format of the App ID is incorrect.
    *
@@ -2266,16 +2271,8 @@ struct SimulcastConfig {
    * 
    */
   bool publish_fallback_enable;
-  /**
-   * Whether to enable on-demand publishing. When set to true, a simulcast layer will only be published
-   * when there are subscribers requesting that layer.
-   * - true: (Default) Enable on-demand publishing.
-   * - false: Disable on-demand publishing. All enabled simulcast layers will be published regardless
-   * of subscription status.
-   */
-  bool publish_on_demand;
 
-  SimulcastConfig(): publish_fallback_enable(false), publish_on_demand(true) {}
+  SimulcastConfig(): publish_fallback_enable(false) {}
 };
 /**
  * The location of the target area relative to the screen or window. If you do not set this parameter,
@@ -2565,6 +2562,7 @@ struct WatermarkConfig {
 enum MultipathMode {
   /**
     * Duplicate mode, the same piece of data is redundantly transmitted over all available paths.
+    * @technical preview
     */
   Duplicate= 0,
   /**
@@ -3490,8 +3488,6 @@ enum LOCAL_VIDEO_STREAM_REASON {
   LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_INTERRUPTED_BY_OTHER = 32,
   /* 32: (HMOS only) ScreenCapture stopped by SIM call */
   LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_STOPPED_BY_CALL = 33,
-  /* 34: HDR Video Source fallback to SDR */
-  LOCAL_AUDIO_STREAM_REASON_VIDEO_SOURCE_HDR_TO_SDR = 34,
 };
 
 /**
@@ -5656,22 +5652,53 @@ struct VirtualBackgroundSource {
         blur_degree(BLUR_DEGREE_HIGH) {}
 };
 
+/**
+ * The properties for virtual background algorithm.
+ */
 struct SegmentationProperty {
+  /** The type of algorithms for segmentation processing.
+   */
   enum SEG_MODEL_TYPE {
+    /** 1: (Default) AI segmentation algorithm.
+     */
     SEG_MODEL_AI = 1,
+    /** 2: Green screen segmentation algorithm.
+     */
     SEG_MODEL_GREEN = 2
   };
 
+  /** The color of the screen for green screen segmentation.
+   */
   enum SCREEN_COLOR_TYPE {
+    /** 0: (Default) Automatically recognizes the screen color.
+     */
     SCREEN_COLOR_AUTO = 0,
+    /** 1: Green.
+     */
     SCREEN_COLOR_GREEN = 1,
+    /** 2: Blue.
+     */
     SCREEN_COLOR_BLUE = 2
   };
 
+  /** The type of segmentation algorithm. See #SEG_MODEL_TYPE.
+   * The default value is `SEG_MODEL_AI`.
+   */
   SEG_MODEL_TYPE modelType;
 
+  /** The color tolerance for green screen segmentation.
+   *
+   * This parameter is only effective when `modelType` is set to `SEG_MODEL_GREEN`.
+   * The value ranges from 0.0 to 1.0, with a default of 0.5.
+   * A larger value widens the range of identifiable shades of the screen color. Setting the value too high may cause parts of the portrait to be detected as the background.
+   * Agora recommends dynamically adjusting this value based on the observed segmentation effect.
+   */
   float greenCapacity;
 
+  /** The color of the screen for green screen segmentation. See #SCREEN_COLOR_TYPE.
+   *
+   * This property is only for green screen segmentation. The default value is `SCREEN_COLOR_AUTO`.
+   */
   SCREEN_COLOR_TYPE screenColorType;
 
   SegmentationProperty() : modelType(SEG_MODEL_AI), greenCapacity(0.5), screenColorType(SCREEN_COLOR_AUTO) {}
@@ -6884,7 +6911,9 @@ enum RENEW_TOKEN_ERROR_CODE {
    */
   RENEW_TOKEN_SUCCESS = 0,
   /**
-   * 1: It is recommended that the user generate a new token and retry renewToken.
+   * 1: The token renewal failed because of some unknown server error.
+   * It is recommended that the user check the parameters passed in when generating the token and
+   * generate a new token and retry renewToken.
    */
   RENEW_TOKEN_FAILURE = 1,
   /**
@@ -6893,12 +6922,18 @@ enum RENEW_TOKEN_ERROR_CODE {
    */
   RENEW_TOKEN_TOKEN_EXPIRED = 2,
   /**
-   * 3: The token renewal failed because the provided token is invalid.
-   * It is recommended that the user check the token generation process, generate a new token, and retry renewToken.
+   * 3: The token renewal failed because the token is not valid. Typical reasons include:
+   * - The App Certificate for the project is enabled in Agora Console, but you do not use a token
+   * when joining the channel. If you enable the App Certificate, you must use a token to join the
+   * channel.
+   * - The `uid` specified when calling `joinChannel` to join the channel is inconsistent with the
+   * `uid` passed in when generating the token.
+   * - The `channelName` specified when calling `joinChannel` to join the channel is inconsistent 
+   * with the `channelName` passed in when generating the token.
    */
   RENEW_TOKEN_INVALID_TOKEN = 3,
   /**
-   * 4: The token renewal failed because the channel name in the token does not match the current channel.
+   * 4: The token renewal failed because the channel name is invalid.
    * It is recommended that the user check the channel name, generate a new token, and retry renewToken.
    */
   RENEW_TOKEN_INVALID_CHANNEL_NAME = 4,

Android/APIExample/agora-stream-encrypt/src/main/cpp/include/agora/IAgoraMediaPlayer.h

@@ -402,6 +402,9 @@ class IMediaPlayer : public RefCountInterface {
 
     /**
    * Open the Agora CDN media source.
+   * 
+   * @deprecated 4.6.0
+   * 
    * @param src The src of the media file that you want to play.
    * @param startPos The  playback position (ms).
    * @return
@@ -412,6 +415,9 @@ class IMediaPlayer : public RefCountInterface {
 
   /**
    * Gets the number of  Agora CDN lines.
+   * 
+   * @deprecated 4.6.0
+   * 
    * @return
    * - > 0: number of CDN.
    * - <= 0: Failure.
@@ -420,6 +426,9 @@ class IMediaPlayer : public RefCountInterface {
 
   /**
    * Switch Agora CDN lines.
+   * 
+   * @deprecated 4.6.0
+   * 
    * @param index Specific CDN line index.
    * @return
    * - 0: Success.
@@ -429,6 +438,9 @@ class IMediaPlayer : public RefCountInterface {
 
   /**
    * Gets the line of the current CDN.
+   * 
+   * @deprecated 4.6.0
+   * 
    * @return
    * - >= 0: Specific line.
    * - < 0: Failure.
@@ -437,6 +449,9 @@ class IMediaPlayer : public RefCountInterface {
 
   /**
    * Enable automatic CDN line switching.
+   * 
+   * @deprecated 4.6.0
+   * 
    * @param enable Whether enable.
    * @return
    * - 0: Success.
@@ -446,6 +461,9 @@ class IMediaPlayer : public RefCountInterface {
 
   /**
    * Update the CDN source token and timestamp.
+   * 
+   * @deprecated 4.6.0
+   * 
    * @param token token.
    * @param ts ts.
    * @return
@@ -456,6 +474,9 @@ class IMediaPlayer : public RefCountInterface {
 
   /**
    * Switch the CDN source when open a media through "openWithAgoraCDNSrc" API
+   * 
+   * @deprecated 4.6.0
+   * 
    * @param src Specific src.
    * @param syncPts Live streaming must be set to false.
    * @return