Agora RTC Objective-C API Reference
Refactor
|
Inherits <NSObject>.
Instance Methods | |
(void) | - startExtensionControl: |
(int) | - stopVideoFilter |
(void) | - getProcessMode:isolated: |
(void) | - getVideoFormatWanted:pixelBufferFormat: |
(void) | - setEnabled: |
(BOOL) | - isEnabled |
(NSInteger) | - setPropertyWithKey:value: |
(NSInteger) | - getPropertyWithKey:value: |
(AgoraVideoFilterProcessResult) | - pendVideoFrame: |
(AgoraVideoFilterProcessResult) | - adaptVideoFrame:dstFrame: |
The AgoraVideoFilterDelegate protocol. This protocol is the intermediate node for video, which contains both the video source and the video sink. It reads video frames from the underlying video pipeline and writes video frames back after adaptation.
- (void) startExtensionControl: | (id< AgoraVideoFilterControlDelegate > __nullable) | control |
This function is invoked right before data stream starts. Custom filter can override this function for initialization.
- (int) stopVideoFilter |
This function is invoked right before data stream stops. Custom filter can override this function for deinitialization.
- (void) getProcessMode: | (AgoraVideoFilterProcessMode *_Nullable) | mode | |
isolated: | (BOOL *_Nullable) | isolated | |
Get Process Mode If getProcessMode:(AgoraVideoFilterProcessMode *)mode isolated:(BOOL *)isolated, mode is AgoraVideoFilterProcessModeSync you MUST implement adaptVideoFrame:dstFrame: else getProcessMode:(AgoraVideoFilterProcessMode *)mode isolated:(BOOL *)isolated, mode is AgoraVideoFilterProcessModeAsync you MUST implement pendVideoFrame
mode | AgoraVideoFilterProcessMode, inout param |
isolated | BOOL, inout param |
- (void) getVideoFormatWanted: | (AgoraVideoFilterFrameType *_Nullable) | type | |
pixelBufferFormat: | (AgoraMemPixelBufferFormatType *_Nullable) | format | |
Get Video Format If getProcessMode:(AgoraVideoFilterProcessMode *)mode isolated:(BOOL *)isolated, mode is AgoraVideoFilterProcessModeSync you MUST implement adaptVideoFrame:dstFrame: else getProcessMode:(AgoraVideoFilterProcessMode *)mode isolated:(BOOL *)isolated, mode is AgoraVideoFilterProcessModeAsync you MUST implement pendVideoFrame
type | AgoraVideoFilterFrameType, inout param |
format | AgoraMemPixelBufferFormatType, inout param |
- (void) setEnabled: | (BOOL) | enabled |
Enables or disables the video filter.
enable | Whether to enable the video filter:
|
- (BOOL) isEnabled |
Checks whether the video filter is enabled.
YES
: The video filter is enabled.NO
: The video filter is not enabled. - (NSInteger) setPropertyWithKey: | (NSString *__nonnull) | key | |
value: | (NSData *__nonnull) | value | |
Sets a private property in the IVideoFilter
class.
key | The pointer to the property name. |
value | The pointer to the buffer of this private property. |
- (NSInteger) getPropertyWithKey: | (NSString *__nonnull) | key | |
value: | (NSData *_Nullable *_Nullable) | value | |
Gets a private property in the IVideoFilter class.
key | The pointer to the property name. |
(in/out) | value The pointer to the buffer of this private property. |
|
optional |
Adapts the video frame.
srcFrame | The pointer to the captured video frame that you want to adapt. |
|
optional |
Adapts the video frame.
srcFrame | The pointer to the captured video frame that you want to adapt. |
dstFrame | The in/out pointer to the adapted video frame. |