Agora RTC Objective-C API Reference
Refactor
|
Go to the documentation of this file.
8 #ifndef OPTIONAL_PROCESSRESULT_SPECIFIER
9 #if __cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1800)
10 #define OPTIONAL_PROCESSRESULT_SPECIFIER ProcessResult::
12 #define OPTIONAL_PROCESSRESULT_SPECIFIER
93 virtual int setProperty(
const char* key,
const void* buf,
int buf_size) = 0;
104 virtual int getProperty(
const char* key,
void* buf,
int buf_size)
const = 0;
193 virtual int setProperty(
const char* key,
const void* buf,
size_t buf_size) {
return -1; }
204 virtual int getProperty(
const char* key,
void* buf,
size_t buf_size) {
return -1; }
281 virtual int postEvent(
const char* key,
const char* value) = 0;
380 virtual int setProperty(
const char* key,
const void* buf,
int buf_size) {
return -1; }
391 virtual int getProperty(
const char* key,
void* buf,
int buf_size) {
return -1; }
434 virtual void onEvent(
const char* provider_name,
const char* ext_name,
const char* key,
const char* json_value) {}
437 virtual void onExtensionErrored(
const char* provider_name,
const char* ext_name,
int error,
const char* msg) {}
461 const void* audio_data, uint32_t capture_timestamp,
462 const size_t samples_per_channel,
464 const size_t number_of_channels,
465 const uint32_t sample_rate) = 0;
603 const uint8_t *packet,
764 virtual int setBeautyEffectOptions(
bool enabled,
BeautyOptions options) = 0;
virtual int addView(void *view, const Rectangle &cropArea)=0
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...
~IAudioSinkBase()
Definition: NGIAgoraMediaNode.h:637
@ kSync
Definition: NGIAgoraMediaNode.h:245
Definition: AgoraBase.h:3989
virtual void disableMe(int error, const char *msg)=0
Ask SDK to disable the current filter if a fatal error is detected.
~IVideoFrameSender()
Definition: NGIAgoraMediaNode.h:661
virtual int getProperty(const char *key, void *buf, int buf_size)
Definition: NGIAgoraMediaNode.h:391
virtual int getProperty(const char *key, void *buf, int buf_size) const =0
virtual void setEnabled(bool enable)
Definition: NGIAgoraMediaNode.h:175
virtual bool isExtensionFilter()
Definition: NGIAgoraMediaNode.h:233
~IAudioFilterBase()
Definition: NGIAgoraMediaNode.h:58
Definition: NGIAgoraMediaNode.h:694
Definition: NGIAgoraMediaNode.h:22
Definition: NGIAgoraVideoTrack.h:36
virtual int getTranscodingDelayMs()=0
unsigned int uid_t
Definition: AgoraMediaBase.h:29
Definition: AgoraRefPtr.h:44
Definition: NGIAgoraMediaNode.h:849
virtual int setProperty(const char *key, const void *buf, int buf_size)
Definition: NGIAgoraMediaNode.h:380
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:337
virtual int getPreferredSampleRate()=0
virtual bool isExternalSink()
Definition: NGIAgoraMediaNode.h:401
virtual bool applyMirror()
Definition: NGIAgoraMediaNode.h:421
virtual int addVideoTrack(agora_refptr< IVideoTrack > track)=0
virtual int setProperty(const char *key, const void *buf, size_t buf_size)
Definition: NGIAgoraMediaNode.h:193
Definition: AgoraBase.h:2054
virtual agora::agora_refptr< IVideoFrameMemoryPool > getMemoryPool()=0
Filter can invoke this function to get the IVideoFrameMemoryPool object if a new IVideoFrame data obj...
virtual int unsetView()=0
~IAudioEncodedFrameSender()
Definition: NGIAgoraMediaNode.h:496
Definition: NGIAgoraMediaNode.h:368
@ kAsync
Definition: NGIAgoraMediaNode.h:246
Definition: AgoraBase.h:1754
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:345
Definition: AgoraBase.h:1653
virtual int setView(void *view)=0
virtual void onDataStreamWillStop()
Definition: NGIAgoraMediaNode.h:414
virtual int onFrame(const media::base::VideoFrame &videoFrame)=0
Definition: NGIAgoraMediaNode.h:445
virtual bool isExtensionFilter()
Definition: NGIAgoraMediaNode.h:357
virtual void printLog(commons::LOG_LEVEL level, const char *format,...)=0
print log to the SDK.
virtual const char * getName() const =0
@ LIGHTENING_CONTRAST_LOW
Definition: NGIAgoraMediaNode.h:707
virtual int postEvent(const char *key, const char *value)=0
Post an event and notify the end users.
float rednessLevel
Definition: NGIAgoraMediaNode.h:739
~IAudioFilter()
Definition: NGIAgoraMediaNode.h:135
Definition: NGIAgoraMediaNode.h:671
virtual int getProperty(const char *key, void *buf, size_t buf_size)
Definition: NGIAgoraMediaNode.h:204
virtual bool sendEncodedVideoImage(const uint8_t *imageBuffer, size_t length, const EncodedVideoFrameInfo &videoEncodedFrameInfo)=0
Definition: AgoraAtomicOps.h:21
virtual int removeVideoTrack(agora_refptr< IVideoTrack > track)=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 ...
virtual int getPreferredChannelNumbers()=0
LIGHTENING_CONTRAST_LEVEL
Definition: NGIAgoraMediaNode.h:703
Definition: NGIAgoraMediaNode.h:67
ProcessResult
Definition: NGIAgoraMediaNode.h:249
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
@ LIGHTENING_CONTRAST_NORMAL
Definition: NGIAgoraMediaNode.h:711
virtual bool onAudioFrame(const media::base::AudioPcmFrame &audioFrame)=0
~IVideoEncodedImageSender()
Definition: NGIAgoraMediaNode.h:688
OPTIONAL_ENUM_CLASS LOG_LEVEL
Definition: IAgoraLog.h:35
@ LIGHTENING_CONTRAST_HIGH
Definition: NGIAgoraMediaNode.h:715
BeautyOptions(LIGHTENING_CONTRAST_LEVEL contrastLevel, float lightening, float smoothness, float redness)
Definition: NGIAgoraMediaNode.h:741
Definition: NGIAgoraMediaNode.h:499
OPTIONAL_ENUM_CLASS Format
Definition: NGIAgoraVideoFrame.h:51
Definition: NGIAgoraMediaNode.h:478
virtual int setRenderMode(void *view, media::base::RENDER_MODE_TYPE renderMode)=0
static const int kDeviceIdSize
Definition: NGIAgoraMediaNode.h:843
virtual int setMirror(bool mirror)=0
Definition: NGIAgoraMediaNode.h:142
virtual bool onDataStreamWillStart()
Definition: NGIAgoraMediaNode.h:409
virtual bool isExternal()
Definition: NGIAgoraMediaNode.h:225
virtual int removeView(void *view)=0
Definition: NGIAgoraMediaNode.h:770
virtual bool isEnabled()
Definition: NGIAgoraMediaNode.h:182
LIGHTENING_CONTRAST_LEVEL lighteningContrastLevel
Definition: NGIAgoraMediaNode.h:722
~IAudioPcmDataSender()
Definition: NGIAgoraMediaNode.h:468
virtual int getPreferredSampleRate()
Definition: NGIAgoraMediaNode.h:122
@ kBypass
Definition: NGIAgoraMediaNode.h:251
@ kDrop
Definition: NGIAgoraMediaNode.h:252
Definition: NGIAgoraMediaNode.h:262
BYTES_PER_SAMPLE
Definition: AgoraMediaBase.h:93
float smoothnessLevel
Definition: NGIAgoraMediaNode.h:733
virtual bool getRotationApplied()
Definition: NGIAgoraMediaNode.h:354
virtual int setProperty(const char *key, const void *buf, int buf_size)=0
Definition: NGIAgoraMediaNode.h:625
Definition: NGIAgoraMediaNode.h:647
Definition: NGIAgoraMediaNode.h:242
BeautyOptions()
Definition: NGIAgoraMediaNode.h:748
virtual void onDataStreamWillStop()
Definition: NGIAgoraMediaNode.h:217
Definition: AgoraRefPtr.h:31
virtual int setMirror(void *view, bool mirror)=0
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...
virtual bool applyRotation()
Definition: NGIAgoraMediaNode.h:428
virtual bool onDataStreamWillStart()
Definition: NGIAgoraMediaNode.h:212
virtual bool adaptAudioFrame(const media::base::AudioPcmFrame &inAudioFrame, media::base::AudioPcmFrame &adaptedFrame)=0
virtual bool isEnabled() const =0
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 int getPreferredChannelNumbers()
Definition: NGIAgoraMediaNode.h:132
virtual bool adaptVideoFrame(const media::base::VideoFrame &capturedFrame, media::base::VideoFrame &adaptedFrame)=0
@ kSuccess
Definition: NGIAgoraMediaNode.h:250
virtual int sendVideoFrame(const media::base::ExternalVideoFrame &videoFrame)=0
virtual int setRenderMode(media::base::RENDER_MODE_TYPE renderMode)=0
float lighteningLevel
Definition: NGIAgoraMediaNode.h:727
virtual ~IAudioEncodedFrameReceiver()
Definition: NGIAgoraMediaNode.h:512
virtual void setEnabled(bool enable)=0
virtual bool onEncodedAudioFrameReceived(const uint8_t *packet, size_t length, const media::base::AudioEncodedFrameInfo &info)=0
@ ERR_NOT_SUPPORTED
Definition: AgoraBase.h:502
virtual int stop()=0
SDK will invoke this API when the data stream is about to stop. Filter can perform cleanup jobs in th...
virtual bool sendEncodedAudioFrame(const uint8_t *payload_data, size_t payload_size, const EncodedAudioFrameInfo &audioFrameInfo)=0
Definition: NGIAgoraMediaNode.h:166
Definition: NGIAgoraMediaNode.h:699
OPTIONAL_ENUM_CLASS Type
Definition: NGIAgoraVideoFrame.h:158
virtual bool adaptVideoFrame(const media::base::VideoFrame &capturedFrame, media::base::VideoFrame &adaptedFrame)
Definition: NGIAgoraMediaNode.h:358
ProcessMode
Definition: NGIAgoraMediaNode.h:244