Agora C++ API Reference for All Platforms
Classes | Public Member Functions | List of all members
agora::rtc::IVideoBeautyFilter Class Referenceabstract

Inherits agora::rtc::IVideoFilter.

Classes

struct  BeautyOptions
 

Public Member Functions

virtual int setBeautyEffectOptions (bool enabled, BeautyOptions options)=0
 
- Public Member Functions inherited from agora::rtc::IVideoFilter
virtual void setEnabled (bool enable)
 
virtual bool isEnabled ()
 
virtual int setProperty (const char *key, const void *buf, size_t buf_size)
 
virtual int getProperty (const char *key, void *buf, size_t buf_size)
 
virtual bool onDataStreamWillStart ()
 
virtual void onDataStreamWillStop ()
 
virtual bool isExternal ()
 
virtual bool isExtensionFilter ()
 
- Public Member Functions inherited from agora::rtc::IVideoFilterBase
virtual bool adaptVideoFrame (const media::base::VideoFrame &capturedFrame, media::base::VideoFrame &adaptedFrame)=0
 
- Public Member Functions inherited from agora::RefCountInterface
virtual void AddRef () const =0
 
virtual RefCountReleaseStatus Release () const =0
 
virtual bool HasOneRef () const =0
 

Additional Inherited Members

- Protected Member Functions inherited from agora::RefCountInterface
virtual ~RefCountInterface ()
 

Detailed Description

The IVideoBeautyFilter class.

Member Function Documentation

◆ setBeautyEffectOptions()

virtual int agora::rtc::IVideoBeautyFilter::setBeautyEffectOptions ( bool  enabled,
BeautyOptions  options 
)
pure virtual

Sets the image enhancement options.

Parameters
enabledWhether to enable image enhancement.
  • true: Enable image enhancement.
  • false: Do not enable image enhancement.
optionsThe image enhancement options: BeautyOptions.
Returns
  • 0: Success.
  • < 0: Failure.