Agora RTC Objective-C API Reference Refactor

AgoraVideoFilterDelegate.h
Go to the documentation of this file.
1 //
2 // AgoraVideoFilterDelegate.h
3 // Agora SDK
4 //
5 // Created by LLF on 2021-3-9.
6 // Copyright (c) 2021 Agora. All rights reserved.
7 //
8
9 #import <Foundation/Foundation.h>
10 #import "AgoraExtObjects.h"
11
12 typedef NS_ENUM(NSInteger, AgoraVideoFilterProcessMode) {
13 AgoraVideoFilterProcessModeSync = 0,
14 AgoraVideoFilterProcessModeAsync = 1,
15 };
16
17 typedef NS_ENUM(NSInteger, AgoraVideoFilterProcessResult) {
18 AgoraVideoFilterProcessResultSuccess = 0,
19 AgoraVideoFilterProcessResultBypass = 1,
20 AgoraVideoFilterProcessResultDrop = 2,
21 };
22
23 @protocol AgoraVideoFilterControlDelegate <NSObject>
24
30 - (AgoraVideoFilterProcessResult)deliverVideoFrame:(AgoraVideoFilterFrame * _Nonnull)dstFrame NS_SWIFT_NAME(deliverVideoFrame(_:));
31
32 - (int)postEvent:(NSString * _Nonnull)key value:(NSString * _Nonnull)value NS_SWIFT_NAME(postEvent(_:value:));
33 - (void)disableMe:(int)error value:(NSString * _Nonnull)message NS_SWIFT_NAME(disableMe(_:value:));
34
35 @end
36
43 @protocol AgoraVideoFilterDelegate <NSObject>
44
49 - (void)startExtensionControl:(id<AgoraVideoFilterControlDelegate> _Nullable)control NS_SWIFT_NAME(startExtensionControl(_:));
50
55 - (int)stopVideoFilter NS_SWIFT_NAME(stopVideoFilter());
56
65 - (void)getProcessMode:(AgoraVideoFilterProcessMode * _Nullable)mode NS_SWIFT_NAME(getProcessMode(_:));
66
72 - (void)getVideoFormatWanted:(AgoraVideoFilterFrameType * _Nullable)type pixelBufferFormat:(AgoraMemPixelBufferFormatType * _Nullable)format NS_SWIFT_NAME(getVideoFormatWanted(_:pixelBufferFormat:));
73
81 - (void)setEnabled:(BOOL)enabled NS_SWIFT_NAME(setEnabled(_:));
82
89 - (BOOL)isEnabled NS_SWIFT_NAME(isEnabled());
90
100 - (NSInteger)setPropertyWithKey:(NSString * _Nonnull)key value:(NSData * _Nonnull)value NS_SWIFT_NAME(setPropertyWithKey(_:value:));
101
111 - (NSInteger)getPropertyWithKey:(NSString * _Nonnull)key value:(NSData *_Nullable* _Nullable)value NS_SWIFT_NAME(getPropertyWithKey(_:value:));
112
113 @optional
114
120 - (AgoraVideoFilterProcessResult)pendVideoFrame:(AgoraVideoFilterFrame * _Nonnull)sr NS_SWIFT_NAME(sr())cFrame NS_SWIFT_NAME(pendVideoFrame(_:));
121
130 - (AgoraVideoFilterProcessResult)adaptVideoFrame:(AgoraVideoFilterFrame * _Nonnull)srcFrame
131 dstFrame:(AgoraVideoFilterFrame *_Nullable* _Nullable)dstFrame NS_SWIFT_NAME(adaptVideoFrame(_:dstFrame:));
132
133 @end
AgoraVideoFilterFrame
Definition: AgoraExtObjects.h:68
AgoraExtObjects.h
AgoraVideoFilterProcessResultSuccess
@ AgoraVideoFilterProcessResultSuccess
Definition: AgoraVideoFilterDelegate.h:18
AgoraVideoFilterProcessMode
AgoraVideoFilterProcessMode
Definition: AgoraVideoFilterDelegate.h:12
AgoraVideoFilterProcessModeAsync
@ AgoraVideoFilterProcessModeAsync
Definition: AgoraVideoFilterDelegate.h:14
AgoraMemPixelBufferFormatType
AgoraMemPixelBufferFormatType
Definition: AgoraExtObjects.h:45
AgoraVideoFilterFrameType
AgoraVideoFilterFrameType
Definition: AgoraExtObjects.h:34
-[AgoraVideoFilterDelegate-p stopVideoFilter]
int stopVideoFilter()
AgoraVideoFilterProcessResultBypass
@ AgoraVideoFilterProcessResultBypass
Definition: AgoraVideoFilterDelegate.h:19
AgoraVideoFilterControlDelegate-p
Definition: AgoraVideoFilterDelegate.h:23
AgoraVideoFilterProcessResult
AgoraVideoFilterProcessResult
Definition: AgoraVideoFilterDelegate.h:17
AgoraVideoFilterProcessModeSync
@ AgoraVideoFilterProcessModeSync
Definition: AgoraVideoFilterDelegate.h:13
AgoraVideoFilterProcessResultDrop
@ AgoraVideoFilterProcessResultDrop
Definition: AgoraVideoFilterDelegate.h:20
-[AgoraVideoFilterDelegate-p isEnabled]
BOOL isEnabled()
AgoraVideoFilterDelegate-p
Definition: AgoraVideoFilterDelegate.h:43