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

Inherits agora::RefCountInterface.

Public Member Functions

virtual int postEvent (const char *key, const char *value)=0
 
virtual void printLog (commons::LOG_LEVEL level, const char *format,...)=0
 
virtual void disableMe (int error, const char *msg)=0
 
virtual void ReportCounter (int32_t counter_id, int32_t value)=0
 
virtual int GetStats (int32_t counter_id)=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 ()
 

Member Function Documentation

◆ postEvent()

virtual int agora::rtc::ILipSyncFilter::Control::postEvent ( const char *  key,
const char *  value 
)
pure virtual

Post an event and notify the end users.

Parameters
key'\0' ended string that describes the key of the event
value'\0' ended string that describes the value of the event

◆ printLog()

virtual void agora::rtc::ILipSyncFilter::Control::printLog ( commons::LOG_LEVEL  level,
const char *  format,
  ... 
)
pure virtual

print log to the SDK.

Parameters
levelLog level agora::commons::LOG_LEVEL
formatlog formatter string
...variadic arguments

◆ disableMe()

virtual void agora::rtc::ILipSyncFilter::Control::disableMe ( int  error,
const char *  msg 
)
pure virtual

Ask SDK to disable the current filter if a fatal error is detected.

Parameters
errorerror code
msgerror message

◆ ReportCounter()

virtual void agora::rtc::ILipSyncFilter::Control::ReportCounter ( int32_t  counter_id,
int32_t  value 
)
pure virtual

report counter to the SDK.

Parameters
counter_idcounter id
valuecounter value

◆ GetStats()

virtual int agora::rtc::ILipSyncFilter::Control::GetStats ( int32_t  counter_id)
pure virtual

get stats to the SDK.

Parameters
counter_idcounter id