Merge branch 'dev/4.6.0' of github.com:AgoraIO/API-Examples into dev/4.6.0

Author: HeZhengQing

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

@@ -306,73 +306,6 @@ enum MEDIA_SOURCE_TYPE {
    */
   UNKNOWN_MEDIA_SOURCE = 100
 };
-/** Definition of contentinspect
- */
-#define MAX_CONTENT_INSPECT_MODULE_COUNT 32
-enum CONTENT_INSPECT_RESULT {
-  CONTENT_INSPECT_NEUTRAL = 1,
-  CONTENT_INSPECT_SEXY = 2,
-  CONTENT_INSPECT_PORN = 3,
-};
-
-enum CONTENT_INSPECT_TYPE {
-  /**
-   * (Default) content inspect type invalid
-   */
-  CONTENT_INSPECT_INVALID = 0,
-  /**
-   * @deprecated
-   * Content inspect type moderation
-   */
-  CONTENT_INSPECT_MODERATION __deprecated = 1,
-  /**
-   * Content inspect type supervise
-   */
-  CONTENT_INSPECT_SUPERVISION = 2,
-  /**
-   * Content inspect type image moderation
-   */
-  CONTENT_INSPECT_IMAGE_MODERATION = 3
-};
-
-struct ContentInspectModule {
-  /**
-   * The content inspect module type.
-   */
-  CONTENT_INSPECT_TYPE type;
-  /**The content inspect frequency, default is 0 second.
-   * the frequency <= 0 is invalid.
-   */
-  unsigned int interval;
-  ContentInspectModule() {
-    type = CONTENT_INSPECT_INVALID;
-    interval = 0;
-  }
-};
-/** Definition of ContentInspectConfig.
- */
-struct ContentInspectConfig {
-  const char* extraInfo;
-  /**
-   * The specific server configuration for image moderation. Please contact technical support.
-   */
-  const char* serverConfig;
-  /**The content inspect modules, max length of modules is 32.
-   * the content(snapshot of send video stream, image) can be used to max of 32 types functions.
-   */
-  ContentInspectModule modules[MAX_CONTENT_INSPECT_MODULE_COUNT];
-  /**The content inspect module count.
-   */
-  int moduleCount;
-  ContentInspectConfig& operator=(const ContentInspectConfig& rth) {
-    extraInfo = rth.extraInfo;
-    serverConfig = rth.serverConfig;
-    moduleCount = rth.moduleCount;
-    memcpy(&modules, &rth.modules, MAX_CONTENT_INSPECT_MODULE_COUNT * sizeof(ContentInspectModule));
-    return *this;
-  }
-  ContentInspectConfig() : extraInfo(NULL), serverConfig(NULL), moduleCount(0) {}
-};
 
 namespace base {
 
@@ -1215,6 +1148,78 @@ enum VIDEO_MODULE_POSITION {
 
 }  // namespace base
 
+/** Definition of contentinspect
+ */
+#define MAX_CONTENT_INSPECT_MODULE_COUNT 32
+enum CONTENT_INSPECT_RESULT {
+  CONTENT_INSPECT_NEUTRAL = 1,
+  CONTENT_INSPECT_SEXY = 2,
+  CONTENT_INSPECT_PORN = 3,
+};
+
+enum CONTENT_INSPECT_TYPE {
+  /**
+   * (Default) content inspect type invalid
+   */
+  CONTENT_INSPECT_INVALID = 0,
+  /**
+   * @deprecated
+   * Content inspect type moderation
+   */
+  CONTENT_INSPECT_MODERATION __deprecated = 1,
+  /**
+   * Content inspect type supervise
+   */
+  CONTENT_INSPECT_SUPERVISION = 2,
+  /**
+   * Content inspect type image moderation
+   */
+  CONTENT_INSPECT_IMAGE_MODERATION = 3
+};
+
+struct ContentInspectModule {
+  /**
+   * The content inspect module type.
+   */
+  CONTENT_INSPECT_TYPE type;
+  /**The content inspect frequency, default is 0 second.
+   * the frequency <= 0 is invalid.
+   */
+  unsigned int interval;
+  /** 
+   * The position of the video observation. See VIDEO_MODULE_POSITION.
+   */
+  base::VIDEO_MODULE_POSITION position;
+  ContentInspectModule() {
+    type = CONTENT_INSPECT_INVALID;
+    interval = 0;
+    position = base::POSITION_PRE_ENCODER;
+  }
+};
+/** Definition of ContentInspectConfig.
+ */
+struct ContentInspectConfig {
+  const char* extraInfo;
+  /**
+   * The specific server configuration for image moderation. Please contact technical support.
+   */
+  const char* serverConfig;
+  /**The content inspect modules, max length of modules is 32.
+   * the content(snapshot of send video stream, image) can be used to max of 32 types functions.
+   */
+  ContentInspectModule modules[MAX_CONTENT_INSPECT_MODULE_COUNT];
+  /**The content inspect module count.
+   */
+  int moduleCount;
+  ContentInspectConfig& operator=(const ContentInspectConfig& rth) {
+    extraInfo = rth.extraInfo;
+    serverConfig = rth.serverConfig;
+    moduleCount = rth.moduleCount;
+    memcpy(&modules, &rth.modules, MAX_CONTENT_INSPECT_MODULE_COUNT * sizeof(ContentInspectModule));
+    return *this;
+  }
+  ContentInspectConfig() : extraInfo(NULL), serverConfig(NULL), moduleCount(0) {}
+};
 /** Definition of SnapshotConfig.
  */
 struct SnapshotConfig {

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

@@ -273,6 +273,9 @@ class IMediaPlayerSource : public RefCountInterface {
    * Open the Agora CDN media source.
    * @param src The src of the media file that you want to play.
    * @param startPos The  playback position (ms).
+   * 
+   * @deprecated 4.6.0
+   * 
    * @return
    * - 0: Success.
    * - < 0: Failure.
@@ -281,6 +284,9 @@ class IMediaPlayerSource : public RefCountInterface {
 
   /**
    * Gets the number of  Agora CDN lines.
+   * 
+   * @deprecated 4.6.0
+   * 
    * @return
    * - > 0: number of CDN.
    * - <= 0: Failure.
@@ -290,6 +296,9 @@ class IMediaPlayerSource : public RefCountInterface {
 
   /**
    * Switch Agora CDN lines.
+   * 
+   * @deprecated 4.6.0
+   * 
    * @param index Specific CDN line index.
    * @return
    * - 0: Success.
@@ -299,6 +308,9 @@ class IMediaPlayerSource : public RefCountInterface {
 
   /**
    * Gets the line of the current CDN.
+   * 
+   * @deprecated 4.6.0
+   * 
    * @return
    * - >= 0: Specific line.
    * - < 0: Failure.
@@ -307,6 +319,9 @@ class IMediaPlayerSource : public RefCountInterface {
 
   /**
    * Enable automatic CDN line switching.
+   * 
+   * @deprecated 4.6.0
+   * 
    * @param enable Whether enable.
    * @return
    * - 0: Success.
@@ -316,6 +331,9 @@ class IMediaPlayerSource : public RefCountInterface {
 
   /**
    * Update the CDN source token and timestamp.
+   * 
+   * @deprecated 4.6.0
+   * 
    * @param token token.
    * @param ts ts.
    * @return
@@ -326,6 +344,9 @@ class IMediaPlayerSource : 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
@@ -444,6 +465,9 @@ class IMediaPlayerSourceObserver {
 
   /**
    * @brief AgoraCDN Token has expired and needs to be set up with renewAgoraCDNSrcToken(const char* src).
+   * 
+   * @deprecated 4.6.0
+   * 
    */
   virtual void onAgoraCDNTokenWillExpire() = 0;
 

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

@@ -23,6 +23,8 @@ class IMediaStreamingSourceObserver;
 
 /**
  * @brief The error code of streaming source
+ * 
+ * @deprecated Since version 4.6.0, this feature has been turned off by default.
  *
  */
 enum STREAMING_SRC_ERR {
@@ -54,6 +56,8 @@ enum STREAMING_SRC_ERR {
 
 /**
  * @brief The state machine of Streaming Source
+ * 
+ * @deprecated Since version 4.6.0, this feature has been turned off by default.
  *
  */
 enum STREAMING_SRC_STATE {
@@ -69,6 +73,8 @@ enum STREAMING_SRC_STATE {
 
 /**
  * @brief The input SEI data
+ * 
+ * @deprecated Since version 4.6.0, this feature has been turned off by default.
  *
  */
 struct InputSeiData {
@@ -85,6 +91,8 @@ struct InputSeiData {
  * @brief The IMediaStreamingSource class provides access to a media streaming source demuxer. 
  *        To playout multiple stream sources simultaneously,
  *        create multiple media stream source objects.
+ * 
+ * @deprecated Since version 4.6.0, this feature has been turned off by default.
  */
 class IMediaStreamingSource : public RefCountInterface {
 public:
@@ -270,6 +278,8 @@ class IMediaStreamingSource : public RefCountInterface {
 
 /**
   * @brief  This observer interface of media streaming source
+  * 
+  * @deprecated Since version 4.6.0, this feature has been turned off by default.
   */
 class IMediaStreamingSourceObserver {
   public:

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

@@ -752,7 +752,7 @@ class IAgoraService {
       const rtc::SenderOptions& options,
       const char* id = OPTIONAL_NULLPTR) = 0;
 
-#if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE)
+#if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) || defined(__OHOS__)
   /**
    * Creates a local video track object with a screen capture source extension and returns the pointer.
    *
@@ -917,7 +917,7 @@ class IAgoraService {
    */
   virtual const char* getExtensionId(const char* provider_name, const char* extension_name) = 0;
 
-#if defined (_WIN32) || defined(__linux__) || defined(__ANDROID__)
+#if defined (_WIN32) ||  defined(__linux__) || defined(__ANDROID__)
   /**
    * @brief load the dynamic library of the extension
    * 
@@ -1019,4 +1019,4 @@ class IAgoraService {
  * - A null pointer: Failure.
  */
 AGORA_API agora::base::IAgoraService* AGORA_CALL createAgoraService();
-/** @} */
+/** @} */

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

@@ -25,12 +25,12 @@ static const int kAdmMaxGuidSize = 128;
 static const int kIntervalInMillseconds = 200;
 
 
-#if defined(_WIN32) || (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE) 
+#if defined(_WIN32) || (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE) || defined(__linux__)
 /**
  * The struct of AudioDeviceInfo.
  *
  * @note
- * This struct applies to Windows and macOS only.
+ * This struct applies to Windows,macOS and Linux.
  */
 struct AudioDeviceInfo {
   /**
@@ -299,7 +299,7 @@ class INGAudioDeviceManager : public RefCountInterface {
    */
   virtual int getRecordAudioParameters(AudioParameters* params) const = 0;
 
-#if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE)
+#if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) || defined (__OHOS__)
   /**
    * Sets the default audio routing.
    *
@@ -352,9 +352,9 @@ class INGAudioDeviceManager : public RefCountInterface {
    * - < 0: Failure.
    */
   virtual int getCurrentRouting(AudioRoute& route) = 0;
-#endif  // __ANDROID__ || TARGET_OS_IPHONE
+#endif  // __ANDROID__ || TARGET_OS_IPHONE || __OHOS__
 
-#if defined(_WIN32) || (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE) 
+#if defined(_WIN32) || (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE) || defined(__linux__)
   /**
    * Gets the index numbers of all audio playout devices.
    *