setFaceShapeAreaOptions

Sets the image enhancement options for facial areas and specifies the media source.

virtual int setFaceShapeAreaOptions(const FaceShapeAreaOptions& options, agora::media::MEDIA_SOURCE_TYPE type = agora::media::PRIMARY_CAMERA_SOURCE) = 0;
Since
v4.5.0

If the preset beauty effects implemented in the setFaceShapeBeautyOptions method do not meet expectations, you can use this method to set beauty area options, individually fine-tune each part of the face, and achieve a more refined beauty effect.

Call timing

Call this method after calling setFaceShapeBeautyOptions.

Restrictions

  • This method only applies to Android 4.4 or later.
  • This method relies on the image enhancement dynamic library libagora_clear_vision_extension.dll. 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.

Parameters

options
Facial enhancement areas, see FaceShapeAreaOptions.
type
The type of the media source to which the filter effect is applied. See MEDIA_SOURCE_TYPE.
Attention: In this method, this parameter supports only the following two settings:
  • Use the default value PRIMARY_CAMERA_SOURCE if you use camera to capture local video.
  • Set this parameter to CUSTOM_VIDEO_SOURCE if you use custom video source.

Returns

  • 0: Success.
  • < 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 4.4 and does not support this feature. Agora recommends you replace the device or upgrade the operating system.