|
Agora RTC Objective-C API Reference
Refactor
|
Go to the documentation of this file.
38 virtual int setProperty(
const char* key,
const void* buf,
int buf_size) = 0;
49 virtual int getProperty(
const char* key,
void* buf,
int buf_size)
const = 0;
92 virtual int postEvent(
const char* key,
const char* value) = 0;
153 virtual int postEvent(
const char* key,
const char* value) = 0;
253 virtual int postEvent(
const char* key,
const char* value) = 0;
284 virtual int setProperty(
const char* key,
const void* buf,
size_t buf_size) {
return -1; }
406 virtual int32_t
setRates(uint32_t bitrate_kbps, uint32_t framerate) = 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...
virtual int32_t releaseVideoEncoder()=0
@ kBypass
Definition: AgoraExtensions.h:242
uint32_t key_frame_interval
Definition: AgoraExtensions.h:302
virtual ~IExtensionEncoderCallback()
Definition: AgoraExtensions.h:348
@ kSync
Definition: AgoraExtensions.h:117
virtual void onDecodedFrame(agora_refptr< IVideoFrame > frame, const char *extended_info_json)=0
virtual void disableMe(int error, const char *msg)=0
Ask SDK to disable the current filter if a fatal error is detected.
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.
Definition: NGIAgoraMediaNode.h:27
Definition: AgoraRefPtr.h:44
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: AgoraExtensions.h:207
virtual void querySupportCodecDataFormat(media::base::VIDEO_PIXEL_FORMAT *data_format, int &size)=0
Definition: AgoraExtensions.h:326
Definition: AgoraExtensions.h:345
uint32_t height
Definition: AgoraExtensions.h:323
virtual agora::agora_refptr< IVideoFrameMemoryPool > getMemoryPool()=0
Filter can invoke this function to get the IVideoFrameMemoryPool object if a new IVideoFrame data obj...
Definition: NGIAgoraMediaNode.h:167
@ kAsync
Definition: AgoraExtensions.h:118
Definition: AgoraExtensions.h:296
@ kSuccess
Definition: AgoraExtensions.h:241
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: AgoraExtensions.h:215
VIDEO_FRAME_TYPE
Definition: AgoraBase.h:1051
uint32_t bitrate_kbps
Definition: AgoraExtensions.h:301
virtual bool isExtensionFilter()
Definition: AgoraExtensions.h:227
virtual void printLog(commons::LOG_LEVEL level, const char *format,...)=0
print log to the SDK.
virtual const char * getName() const =0
virtual int postEvent(const char *key, const char *value)=0
Post an event and notify the end users.
VideoEncoderSettings encoder_settings
Definition: AgoraExtensions.h:311
uint32_t pts_ms
Definition: AgoraExtensions.h:320
Definition: AgoraExtensions.h:238
~IAudioFilter()
Definition: AgoraExtensions.h:80
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: AgoraExtensions.h:291
virtual int initVideoEncoder(ExtensionVideoCodecSettings codec_settings)=0
virtual int32_t releaseVideoDecoder()=0
Definition: AgoraExtensions.h:12
virtual int postEvent(const char *key, const char *value)=0
Post an event and notify the end users.
virtual int decode(const ExtensionEncodedImage &data)=0
ProcessResult
Definition: AgoraExtensions.h:121
virtual int encode(agora_refptr< IVideoFrame > frame, VIDEO_FRAME_TYPE frame_type)=0
virtual int getAdvancedCodecProperty(const char *key, char *json_value, int &length) const =0
virtual void printLog(commons::LOG_LEVEL level, const char *format,...)=0
OPTIONAL_ENUM_CLASS LOG_LEVEL
Definition: IAgoraLog.h:33
virtual void onEncodedImage(const ExtensionEncodedImage *img, const char *extended_info_json)=0
@ kDrop
Definition: AgoraExtensions.h:243
@ VIDEO_FRAME_TYPE_DELTA_FRAME
Definition: AgoraBase.h:1057
Definition: AgoraExtensions.h:85
OPTIONAL_ENUM_CLASS Format
Definition: NGIAgoraVideoFrame.h:29
Definition: AgoraExtensions.h:235
uint32_t framerate
Definition: AgoraExtensions.h:300
virtual void printLog(commons::LOG_LEVEL level, const char *format,...)=0
print log to the SDK.
ProcessResult
Definition: AgoraExtensions.h:240
uint32_t width
Definition: AgoraExtensions.h:322
Definition: AgoraExtensions.h:315
virtual void printLog(commons::LOG_LEVEL level, const char *format,...)=0
VIDEO_FRAME_TYPE frame_type
Definition: AgoraExtensions.h:319
virtual void setExtensionControl(agora::agora_refptr< IAudioFilterV2::Control > control)=0
AgoraSDK set IAudioFilterV2::Control to filter.
Definition: AgoraExtensions.h:305
virtual int32_t setRates(uint32_t bitrate_kbps, uint32_t framerate)=0
VideoDecoderSettings decoder_settings
Definition: AgoraExtensions.h:312
virtual int initVideoDecoder(const ExtensionVideoCodecSettings &codec_settings)=0
virtual int getAdvancedCodecProperty(const char *key, char *json_value, int &length) const =0
virtual int setAdvancedCodecProperty(const char *key, const char *json_value)=0
virtual int getPreferredSampleRate()
Definition: AgoraExtensions.h:67
virtual int32_t registerDecoderCallback(IExtensionDecoderCallback *callback)=0
virtual int postEvent(const char *key, const char *value)=0
Post an event and notify the end users.
@ kBypass
Definition: AgoraExtensions.h:123
Definition: AgoraExtensions.h:83
@ kDrop
Definition: AgoraExtensions.h:124
Definition: AgoraExtensions.h:134
virtual void querySupportCodecDataFormat(media::base::VIDEO_PIXEL_FORMAT *data_format, int &size)=0
virtual bool getRotationApplied()
Definition: AgoraExtensions.h:224
virtual int32_t registerEncoderCallback(IExtensionEncoderCallback *callback)=0
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.
uint16_t height
Definition: AgoraExtensions.h:310
Definition: AgoraExtensions.h:114
uint8_t * buffer
Definition: AgoraExtensions.h:318
Definition: AgoraExtensions.h:299
Definition: AgoraRefPtr.h:31
media::base::VIDEO_PIXEL_FORMAT prefer_data_format
Definition: AgoraExtensions.h:306
uint32_t dts_ms
Definition: AgoraExtensions.h:321
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 isEnabled() const =0
size_t length
Definition: AgoraExtensions.h:317
virtual int setProperty(const char *key, const void *buf, size_t buf_size)
Definition: AgoraExtensions.h:284
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 setAdvancedCodecProperty(const char *key, const char *json_value)=0
virtual int getPreferredChannelNumbers()
Definition: AgoraExtensions.h:77
virtual void disableMe(int error, const char *msg)=0
Ask SDK to disable the current filter if a fatal error is detected.
uint16_t width
Definition: AgoraExtensions.h:309
Definition: AgoraExtensions.h:364
Definition: AgoraExtensions.h:246
@ kSuccess
Definition: AgoraExtensions.h:122
virtual int start(agora::agora_refptr< Control > control)=0
virtual void setEnabled(bool enable)=0
@ ERR_NOT_SUPPORTED
Definition: AgoraBase.h:481
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 ~IExtensionDecoderCallback()
Definition: AgoraExtensions.h:329
Definition: NGIAgoraMediaNode.h:94
OPTIONAL_ENUM_CLASS Type
Definition: NGIAgoraVideoFrame.h:94
virtual bool adaptVideoFrame(const media::base::VideoFrame &capturedFrame, media::base::VideoFrame &adaptedFrame)
Definition: AgoraExtensions.h:228
ProcessMode
Definition: AgoraExtensions.h:116
Definition: AgoraExtensions.h:437