Agora Java API Reference for Android
Classes | Public Member Functions | List of all members
agora::rtc::IExtensionControl Class Referenceabstract

#include <NGIAgoraExtensionControl.h>

Classes

struct  Capabilities
 

Public Member Functions

virtual void getCapabilities (Capabilities &capabilities)=0
 
virtual agora_refptr< IVideoFramecreateVideoFrame (IVideoFrame::Type type, IVideoFrame::Format format, int width, int height)=0
 
virtual agora_refptr< IVideoFramecopyVideoFrame (agora_refptr< IVideoFrame > src)=0
 
virtual void recycleVideoCache (IVideoFrame::Type type)=0
 
virtual int dumpVideoFrame (agora_refptr< IVideoFrame > frame, const char *file)=0
 
virtual int log (commons::LOG_LEVEL level, const char *message)=0
 
virtual int fireEvent (const char *id, const char *event_key, const char *event_json_str)=0
 

Detailed Description

Interface for handling agora extensions.

Member Function Documentation

◆ getCapabilities()

virtual void agora::rtc::IExtensionControl::getCapabilities ( Capabilities capabilities)
pure virtual

Gets the capabilities of agora extensions.

Parameters
capabilitiesSupported extension capabilities.

◆ createVideoFrame()

virtual agora_refptr<IVideoFrame> agora::rtc::IExtensionControl::createVideoFrame ( IVideoFrame::Type  type,
IVideoFrame::Format  format,
int  width,
int  height 
)
pure virtual

This method creates an IVideoFrame object with specified type, format, width and height

Returns
  • The pointer to IVideoFrame: The method call succeeds.
  • An empty pointer nullptr: The method call fails.

◆ copyVideoFrame()

virtual agora_refptr<IVideoFrame> agora::rtc::IExtensionControl::copyVideoFrame ( agora_refptr< IVideoFrame src)
pure virtual

Creates a new IVideoFrame object by copying from the source video frame.

Returns
  • The pointer to IVideoFrame: The method call succeeds.
  • An empty pointer nullptr: The method call fails.

◆ recycleVideoCache()

virtual void agora::rtc::IExtensionControl::recycleVideoCache ( IVideoFrame::Type  type)
pure virtual

Recycles internal frame memory with a specified Video frame type.

The SDK automatically recycles deprecated video frames. However, you can still call this method to perform an immediate memory recycle.

Parameters
typeFrame type to be recycled.

◆ dumpVideoFrame()

virtual int agora::rtc::IExtensionControl::dumpVideoFrame ( agora_refptr< IVideoFrame frame,
const char *  file 
)
pure virtual

This method dumps the content of the video frame to the specified file.

Returns
  • 0: The method call succeeds.
  • <0: The method call fails.

◆ log()

virtual int agora::rtc::IExtensionControl::log ( commons::LOG_LEVEL  level,
const char *  message 
)
pure virtual

Sets log file.

Parameters
levelLogging level. See #commons::LOG_LEVEL.
messageMessage to add to the log file.
Returns
  • 0: The method call succeeds.
  • <0: The method call fails.