setBeautyEffectOptions abstract method

Future<void> setBeautyEffectOptions({
  1. required bool enabled,
  2. required BeautyOptions options,
  3. MediaSourceType type = MediaSourceType.primaryCameraSource,
})

Sets beauty effect options.

Enables local beauty effects and sets the beauty effect options. This method depends on the video enhancement dynamic library libagora_clear_vision_extension.dll. Deleting this library will cause the feature to fail to start. This feature requires high device performance. When calling this method, the SDK automatically checks the current device capabilities.

  • enabled Whether to enable the beauty effect: true : Enable the beauty effect. false : (Default) Disable the beauty effect.
  • options Beauty options. See BeautyOptions for details.
  • type The media source type to which the effect is applied. See MediaSourceType. In this method, this parameter only supports the following two settings: When capturing local video using the camera, keep the default value primaryCameraSource. To use custom captured video, set this parameter to customVideoSource.

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

Implementation

Future<void> setBeautyEffectOptions(
    {required bool enabled,
    required BeautyOptions options,
    MediaSourceType type = MediaSourceType.primaryCameraSource});