Agora C++ API Reference for All Platforms
|
2 #include "AgoraRefPtr.h"
5 #include "NGIAgoraVideoFrame.h"
7 #ifndef OPTIONAL_PROCESSRESULT_SPECIFIER
8 #if __cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1800)
9 #define OPTIONAL_PROCESSRESULT_SPECIFIER ProcessResult::
11 #define OPTIONAL_PROCESSRESULT_SPECIFIER
82 virtual int setProperty(
const char* key,
const void* buf,
int buf_size) = 0;
93 virtual int getProperty(
const char* key,
void* buf,
int buf_size)
const = 0;
172 virtual int setProperty(
const char* key,
const void* buf,
size_t buf_size) {
return -1; }
183 virtual int getProperty(
const char* key,
void* buf,
size_t buf_size) {
return -1; }
260 virtual int postEvent(
const char* key,
const char* value) = 0;
317 return OPTIONAL_PROCESSRESULT_SPECIFIER
kBypass;
325 return OPTIONAL_PROCESSRESULT_SPECIFIER
kBypass;
352 virtual int setProperty(
const char* key,
const void* buf,
int buf_size) {
return -1; }
363 virtual int getProperty(
const char* key,
void* buf,
int buf_size) {
return -1; }
392 virtual void onEvent(
const char* provider_name,
const char* ext_name,
const char* key,
const char* json_value) {}
395 virtual void onExtensionErrored(
const char* provider_name,
const char* ext_name,
int error,
const char* msg) {}
419 const void* audio_data, uint32_t capture_timestamp,
420 const size_t samples_per_channel,
422 const size_t number_of_channels,
423 const uint32_t sample_rate) = 0;
545 const uint8_t *packet,
ProcessResult
Definition: NGIAgoraMediaNode.h:228
virtual bool onDataStreamWillStart()
Definition: NGIAgoraMediaNode.h:381
@ kDrop
Definition: NGIAgoraMediaNode.h:231
virtual int addVideoTrack(agora_refptr< IVideoTrack > track)=0
virtual void onDataStreamWillStop()
Definition: NGIAgoraMediaNode.h:196
virtual int sendVideoFrame(const media::base::ExternalVideoFrame &videoFrame)=0
Definition: NGIAgoraMediaNode.h:636
Definition: NGIAgoraMediaNode.h:21
virtual bool adaptVideoFrame(const media::base::VideoFrame &capturedFrame, media::base::VideoFrame &adaptedFrame)=0
Definition: NGIAgoraVideoTrack.h:36
Definition: AgoraRefPtr.h:44
Definition: NGIAgoraMediaNode.h:755
virtual bool adaptAudioFrame(const media::base::AudioPcmFrame &inAudioFrame, media::base::AudioPcmFrame &adaptedFrame)=0
virtual bool isExtensionFilter()
Definition: NGIAgoraMediaNode.h:329
virtual int setView(void *view)=0
virtual int setProperty(const char *key, const void *buf, size_t buf_size)
Definition: NGIAgoraMediaNode.h:172
virtual bool isExtensionFilter()
Definition: NGIAgoraMediaNode.h:212
Definition: NGIAgoraMediaNode.h:340
virtual int getTranscodingDelayMs()=0
Definition: AgoraBase.h:1700
@ kAsync
Definition: NGIAgoraMediaNode.h:225
virtual bool onDataStreamWillStart()
Definition: NGIAgoraMediaNode.h:191
Definition: AgoraBase.h:1602
virtual int unsetView()=0
BYTES_PER_SAMPLE
Definition: AgoraMediaBase.h:81
virtual bool sendEncodedVideoImage(const uint8_t *imageBuffer, size_t length, const EncodedVideoFrameInfo &videoEncodedFrameInfo)=0
Definition: NGIAgoraMediaNode.h:403
virtual int removeVideoTrack(agora_refptr< IVideoTrack > track)=0
~IAudioPcmDataSender()
Definition: NGIAgoraMediaNode.h:426
@ kBypass
Definition: NGIAgoraMediaNode.h:230
~IAudioFilterBase()
Definition: NGIAgoraMediaNode.h:47
Definition: NGIAgoraMediaNode.h:613
~IAudioEncodedFrameSender()
Definition: NGIAgoraMediaNode.h:454
Definition: AgoraAtomicOps.h:21
virtual bool adaptVideoFrame(const media::base::VideoFrame &capturedFrame, media::base::VideoFrame &adaptedFrame)
Definition: NGIAgoraMediaNode.h:330
virtual int setProperty(const char *key, const void *buf, int buf_size)=0
OPTIONAL_ENUM_CLASS Type
Definition: NGIAgoraVideoFrame.h:149
virtual bool isEnabled() const =0
Definition: NGIAgoraMediaNode.h:56
virtual int stop()=0
SDK will invoke this API when the data stream is about to stop. Filter can perform cleanup jobs in th...
BeautyOptions()
Definition: NGIAgoraMediaNode.h:690
virtual int getPreferredSampleRate()=0
virtual int setProperty(const char *key, const void *buf, int buf_size)
Definition: NGIAgoraMediaNode.h:352
~IVideoFrameSender()
Definition: NGIAgoraMediaNode.h:603
virtual void onDataStreamWillStop()
Definition: NGIAgoraMediaNode.h:386
int getPreferredSampleRate() override
Definition: NGIAgoraMediaNode.h:111
OPTIONAL_ENUM_CLASS LOG_LEVEL
Definition: IAgoraLog.h:35
ProcessMode
Definition: NGIAgoraMediaNode.h:223
virtual void disableMe(int error, const char *msg)=0
Ask SDK to disable the current filter if a fatal error is detected.
@ LIGHTENING_CONTRAST_HIGH
Definition: NGIAgoraMediaNode.h:657
virtual void getProcessMode(ProcessMode &mode, bool &independent_thread)=0
SDK will invoke this API first to get the filter's requested process mode ProcessMode and threading m...
Definition: NGIAgoraMediaNode.h:436
virtual bool sendEncodedAudioFrame(const uint8_t *payload_data, size_t payload_size, const EncodedAudioFrameInfo &audioFrameInfo)=0
OPTIONAL_ENUM_CLASS Format
Definition: NGIAgoraVideoFrame.h:51
virtual int onFrame(const media::base::VideoFrame &videoFrame)=0
Definition: NGIAgoraMediaNode.h:121
virtual ProcessResult adaptVideoFrame(agora::agora_refptr< IVideoFrame > in, agora::agora_refptr< IVideoFrame > &out)
SDK will invoke this API to send video frame to the filter if process mode is "Sync".
Definition: NGIAgoraMediaNode.h:324
LIGHTENING_CONTRAST_LEVEL
Definition: NGIAgoraMediaNode.h:645
virtual int sendAudioPcmData(const void *audio_data, uint32_t capture_timestamp, const size_t samples_per_channel, const agora::rtc::BYTES_PER_SAMPLE bytes_per_sample, const size_t number_of_channels, const uint32_t sample_rate)=0
Definition: NGIAgoraMediaNode.h:712
virtual int setRenderMode(media::base::RENDER_MODE_TYPE renderMode)=0
virtual void getVideoFormatWanted(VideoFrameData::Type &type, RawPixelBuffer::Format &format)=0
SDK will invoke this API every time before sending data to the filter. Filter can desigante the type ...
@ kSync
Definition: NGIAgoraMediaNode.h:224
Definition: NGIAgoraMediaNode.h:241
virtual ProcessResult pendVideoFrame(agora::agora_refptr< IVideoFrame > frame)
SDK will invoke this API to send video frame to the filter if process mode is "Async"....
Definition: NGIAgoraMediaNode.h:316
float rednessLevel
Definition: NGIAgoraMediaNode.h:681
~IAudioSinkBase()
Definition: NGIAgoraMediaNode.h:579
@ ERR_NOT_SUPPORTED
Definition: AgoraBase.h:496
@ LIGHTENING_CONTRAST_LOW
Definition: NGIAgoraMediaNode.h:649
@ kSuccess
Definition: NGIAgoraMediaNode.h:229
Definition: NGIAgoraMediaNode.h:567
virtual bool onAudioFrame(const media::base::AudioPcmFrame &audioFrame)=0
Definition: NGIAgoraMediaNode.h:589
Definition: NGIAgoraMediaNode.h:221
static const int kDeviceIdSize
Definition: NGIAgoraMediaNode.h:749
virtual agora::agora_refptr< IVideoFrameMemoryPool > getMemoryPool()=0
Filter can invoke this function to get the IVideoFrameMemoryPool object if a new IVideoFrame data obj...
Definition: AgoraRefPtr.h:31
virtual int getProperty(const char *key, void *buf, size_t buf_size)
Definition: NGIAgoraMediaNode.h:183
virtual bool isEnabled()
Definition: NGIAgoraMediaNode.h:161
BeautyOptions(LIGHTENING_CONTRAST_LEVEL contrastLevel, float lightening, float smoothness, float redness)
Definition: NGIAgoraMediaNode.h:683
virtual void setEnabled(bool enable)
Definition: NGIAgoraMediaNode.h:154
float smoothnessLevel
Definition: NGIAgoraMediaNode.h:675
virtual ProcessResult deliverVideoFrame(agora::agora_refptr< IVideoFrame > frame)=0
Filter can invoke this function to deliver the processed frame to SDK if the Process Mode is designat...
virtual void setEnabled(bool enable)=0
virtual int setBeautyEffectOptions(bool enabled, BeautyOptions options)=0
float lighteningLevel
Definition: NGIAgoraMediaNode.h:669
virtual bool isExternal()
Definition: NGIAgoraMediaNode.h:204
LIGHTENING_CONTRAST_LEVEL lighteningContrastLevel
Definition: NGIAgoraMediaNode.h:664
@ LIGHTENING_CONTRAST_NORMAL
Definition: NGIAgoraMediaNode.h:653
virtual void printLog(commons::LOG_LEVEL level, const char *format,...)=0
print log to the SDK.
unsigned int uid_t
Definition: AgoraMediaBase.h:25
virtual int getProperty(const char *key, void *buf, int buf_size) const =0
~IAudioFilter()
Definition: NGIAgoraMediaNode.h:114
~IVideoEncodedImageSender()
Definition: NGIAgoraMediaNode.h:630
virtual int setMirror(bool mirror)=0
Definition: NGIAgoraMediaNode.h:145
virtual int start(agora::agora_refptr< Control > control)=0
SDK will invoke this API before feeding video frame data to the filter. Filter can perform its initia...
virtual bool isExternalSink()
Definition: NGIAgoraMediaNode.h:373
Definition: video_node_i.h:27
Definition: NGIAgoraMediaNode.h:641
virtual const char * getName() const =0
virtual int getProperty(const char *key, void *buf, int buf_size)
Definition: NGIAgoraMediaNode.h:363
virtual int postEvent(const char *key, const char *value)=0
Post an event and notify the end users.