Agora RTC Objective-C API Reference
Refactor
|
Go to the documentation of this file.
7 #include <api/aosl_ref.h>
9 #ifndef OPTIONAL_PROCESSRESULT_SPECIFIER
10 #if __cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1800)
11 #define OPTIONAL_PROCESSRESULT_SPECIFIER ProcessResult::
13 #define OPTIONAL_PROCESSRESULT_SPECIFIER
18 struct AudioFrameHandleInfo;
98 virtual int setProperty(
const char* key,
const void* buf,
int buf_size) = 0;
109 virtual int getProperty(
const char* key,
void* buf,
int buf_size)
const = 0;
152 virtual int postEvent(
const char* key,
const char* value) = 0;
224 virtual int setProperty(
const char* key,
const void* buf,
size_t buf_size) {
return -1; }
235 virtual int getProperty(
const char* key,
void* buf,
size_t buf_size) {
return -1; }
312 virtual int postEvent(
const char* key,
const char* value) = 0;
409 virtual int postEvent(
const char* key,
const char* value) = 0;
440 virtual int setProperty(
const char* key,
const void* buf,
size_t buf_size) {
return -1; }
467 virtual int setProperty(
const char* key,
const void* buf,
int buf_size) {
return -1; }
478 virtual int getProperty(
const char* key,
void* buf,
int buf_size) {
return -1; }
548 const void* audio_data, uint32_t capture_timestamp, int64_t presentation_ms,
549 const size_t samples_per_channel,
551 const size_t number_of_channels,
552 const uint32_t sample_rate, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
690 const uint8_t *packet,
691 size_t length, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
851 virtual int setBeautyEffectOptions(
bool enabled,
BeautyOptions options) = 0;
885 virtual int setMirror(
bool mirror, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
896 virtual int setMirror(
void* view,
bool mirror, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
904 virtual int setView(
void* view, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
913 virtual int addView(
void* view,
const Rectangle& cropArea, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
920 virtual int unsetView(aosl_ref_t ares = AOSL_REF_INVALID) = 0;
virtual int unsetView(aosl_ref_t ares=AOSL_REF_INVALID)=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:724
@ kBypass
Definition: NGIAgoraMediaNode.h:398
@ kSync
Definition: NGIAgoraMediaNode.h:276
Definition: AgoraBase.h:4787
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:748
virtual int getProperty(const char *key, void *buf, int buf_size)
Definition: NGIAgoraMediaNode.h:478
virtual int getProperty(const char *key, void *buf, int buf_size) const =0
virtual void printLog(commons::LOG_LEVEL level, const char *format,...)=0
print log to the SDK.
virtual void setEnabled(bool enable)
Definition: NGIAgoraMediaNode.h:206
virtual bool isExtensionFilter()
Definition: NGIAgoraMediaNode.h:264
~IAudioFilterBase()
Definition: NGIAgoraMediaNode.h:63
Definition: NGIAgoraMediaNode.h:781
Definition: NGIAgoraMediaNode.h:27
Definition: NGIAgoraVideoTrack.h:97
virtual int getTranscodingDelayMs()=0
unsigned int uid_t
Definition: AgoraMediaBase.h:28
Definition: AgoraRefPtr.h:44
Definition: NGIAgoraMediaNode.h:936
virtual int setProperty(const char *key, const void *buf, int buf_size)
Definition: NGIAgoraMediaNode.h:467
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:366
virtual int getPreferredSampleRate()=0
virtual bool isExternalSink()
Definition: NGIAgoraMediaNode.h:488
Definition: NGIAgoraMediaNode.h:17
virtual bool applyMirror()
Definition: NGIAgoraMediaNode.h:508
virtual int setProperty(const char *key, const void *buf, size_t buf_size)
Definition: NGIAgoraMediaNode.h:224
virtual int removeVideoTrack(agora_refptr< IVideoTrack > track, aosl_ref_t ares=AOSL_REF_INVALID)=0
Definition: AgoraBase.h:2217
virtual agora::agora_refptr< IVideoFrameMemoryPool > getMemoryPool()=0
Filter can invoke this function to get the IVideoFrameMemoryPool object if a new IVideoFrame data obj...
~IAudioEncodedFrameSender()
Definition: NGIAgoraMediaNode.h:583
Definition: NGIAgoraMediaNode.h:455
@ kAsync
Definition: NGIAgoraMediaNode.h:277
Definition: AgoraBase.h:1636
@ kSuccess
Definition: NGIAgoraMediaNode.h:397
virtual int addVideoTrack(agora_refptr< IVideoTrack > track, aosl_ref_t ares=AOSL_REF_INVALID)=0
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:374
Definition: AgoraBase.h:1475
virtual void onDataStreamWillStop()
Definition: NGIAgoraMediaNode.h:501
virtual int onFrame(const media::base::VideoFrame &videoFrame)=0
Definition: NGIAgoraMediaNode.h:532
virtual bool isExtensionFilter()
Definition: NGIAgoraMediaNode.h:386
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:794
virtual int postEvent(const char *key, const char *value)=0
Post an event and notify the end users.
float rednessLevel
Definition: NGIAgoraMediaNode.h:826
Definition: NGIAgoraMediaNode.h:394
Definition: AgoraMediaBase.h:41
~IAudioFilter()
Definition: NGIAgoraMediaNode.h:140
Definition: NGIAgoraMediaNode.h:758
virtual int getProperty(const char *key, void *buf, size_t buf_size)
Definition: NGIAgoraMediaNode.h:235
virtual void ReportCounter(int32_t counter_id, int32_t value)=0
report counter to the SDK.
Definition: AgoraAtomicOps.h:21
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 ProcessResult convertAudioFrameToFaceInfo(const agora::media::base::AudioPcmFrame &inAudioFrame, char *outFaceInfo)
Definition: NGIAgoraMediaNode.h:447
virtual int setView(void *view, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int getPreferredChannelNumbers()=0
LIGHTENING_CONTRAST_LEVEL
Definition: NGIAgoraMediaNode.h:790
Definition: NGIAgoraMediaNode.h:72
virtual int postEvent(const char *key, const char *value)=0
Post an event and notify the end users.
ProcessResult
Definition: NGIAgoraMediaNode.h:280
@ LIGHTENING_CONTRAST_NORMAL
Definition: NGIAgoraMediaNode.h:798
virtual bool onAudioFrame(const media::base::AudioPcmFrame &audioFrame)=0
~IVideoEncodedImageSender()
Definition: NGIAgoraMediaNode.h:775
OPTIONAL_ENUM_CLASS LOG_LEVEL
Definition: IAgoraLog.h:33
virtual int setMirror(bool mirror, aosl_ref_t ares=AOSL_REF_INVALID)=0
@ LIGHTENING_CONTRAST_HIGH
Definition: NGIAgoraMediaNode.h:802
@ kDrop
Definition: NGIAgoraMediaNode.h:399
BeautyOptions(LIGHTENING_CONTRAST_LEVEL contrastLevel, float lightening, float smoothness, float redness)
Definition: NGIAgoraMediaNode.h:828
Definition: NGIAgoraMediaNode.h:586
Definition: NGIAgoraMediaNode.h:145
OPTIONAL_ENUM_CLASS Format
Definition: NGIAgoraVideoFrame.h:52
Definition: NGIAgoraMediaNode.h:565
static const int kDeviceIdSize
Definition: NGIAgoraMediaNode.h:930
virtual void printLog(commons::LOG_LEVEL level, const char *format,...)=0
print log to the SDK.
virtual int sendVideoFrame(const media::base::ExternalVideoFrame &videoFrame, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int setRenderMode(void *view, media::base::RENDER_MODE_TYPE renderMode, aosl_ref_t ares=AOSL_REF_INVALID)=0
ProcessResult
Definition: NGIAgoraMediaNode.h:396
Definition: NGIAgoraMediaNode.h:173
virtual int addView(void *view, const Rectangle &cropArea, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual bool onDataStreamWillStart()
Definition: NGIAgoraMediaNode.h:496
virtual bool isExternal()
Definition: NGIAgoraMediaNode.h:256
virtual int removeView(void *view)=0
Definition: NGIAgoraMediaNode.h:857
virtual bool isEnabled()
Definition: NGIAgoraMediaNode.h:213
virtual void setExtensionControl(agora::agora_refptr< IAudioFilterV2::Control > control)=0
AgoraSDK set IAudioFilterV2::Control to filter.
LIGHTENING_CONTRAST_LEVEL lighteningContrastLevel
Definition: NGIAgoraMediaNode.h:809
virtual int sendAudioPcmData(const void *audio_data, uint32_t capture_timestamp, int64_t presentation_ms, 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, aosl_ref_t ares=AOSL_REF_INVALID)=0
~IAudioPcmDataSender()
Definition: NGIAgoraMediaNode.h:555
virtual int setMirror(void *view, bool mirror, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int getPreferredSampleRate()
Definition: NGIAgoraMediaNode.h:127
virtual int postEvent(const char *key, const char *value)=0
Post an event and notify the end users.
@ kBypass
Definition: NGIAgoraMediaNode.h:282
Definition: NGIAgoraMediaNode.h:143
@ kDrop
Definition: NGIAgoraMediaNode.h:283
Definition: NGIAgoraMediaNode.h:293
BYTES_PER_SAMPLE
Definition: AgoraMediaBase.h:210
float smoothnessLevel
Definition: NGIAgoraMediaNode.h:820
virtual bool getRotationApplied()
Definition: NGIAgoraMediaNode.h:383
virtual int setProperty(const char *key, const void *buf, int buf_size)=0
virtual int GetStats(int32_t counter_id)=0
get stats to the SDK.
Definition: NGIAgoraMediaNode.h:712
virtual bool sendEncodedVideoImage(const uint8_t *imageBuffer, size_t length, const EncodedVideoFrameInfo &videoEncodedFrameInfo, aosl_ref_t ares=AOSL_REF_INVALID)=0
Definition: NGIAgoraMediaNode.h:734
Definition: NGIAgoraMediaNode.h:273
BeautyOptions()
Definition: NGIAgoraMediaNode.h:835
virtual void onDataStreamWillStop()
Definition: NGIAgoraMediaNode.h:248
Definition: AgoraRefPtr.h:31
virtual int setRenderMode(media::base::RENDER_MODE_TYPE renderMode, aosl_ref_t ares=AOSL_REF_INVALID)=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.
virtual bool applyRotation()
Definition: NGIAgoraMediaNode.h:515
virtual bool onDataStreamWillStart()
Definition: NGIAgoraMediaNode.h:243
virtual bool adaptAudioFrame(const media::base::AudioPcmFrame &inAudioFrame, media::base::AudioPcmFrame &adaptedFrame)=0
virtual bool isEnabled() const =0
virtual int setProperty(const char *key, const void *buf, size_t buf_size)
Definition: NGIAgoraMediaNode.h:440
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:137
virtual void disableMe(int error, const char *msg)=0
Ask SDK to disable the current filter if a fatal error is detected.
virtual bool adaptVideoFrame(const media::base::VideoFrame &capturedFrame, media::base::VideoFrame &adaptedFrame)=0
Definition: NGIAgoraMediaNode.h:402
@ kSuccess
Definition: NGIAgoraMediaNode.h:281
virtual int start(agora::agora_refptr< Control > control)=0
float lighteningLevel
Definition: NGIAgoraMediaNode.h:814
virtual ~IAudioEncodedFrameReceiver()
Definition: NGIAgoraMediaNode.h:599
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:477
virtual int stop()=0
SDK will invoke this API when the data stream is about to stop. Filter can perform cleanup jobs in th...
Definition: NGIAgoraMediaNode.h:197
virtual bool sendEncodedAudioFrame(const uint8_t *payload_data, size_t payload_size, const EncodedAudioFrameInfo &audioFrameInfo, aosl_ref_t ares=AOSL_REF_INVALID)=0
Definition: NGIAgoraMediaNode.h:786
OPTIONAL_ENUM_CLASS Type
Definition: NGIAgoraVideoFrame.h:82
virtual bool adaptVideoFrame(const media::base::VideoFrame &capturedFrame, media::base::VideoFrame &adaptedFrame)
Definition: NGIAgoraMediaNode.h:387
ProcessMode
Definition: NGIAgoraMediaNode.h:275