Agora RTC Objective-C API Reference Refactor

AgoraVideoEffectObject.h
Go to the documentation of this file.
1 // AgoraVideoEffectObject.h
2 // AgoraVideoEffect
3 //
4 // Copyright (c) 2023 Agora. All rights reserved.
5 //
6
7 #import <Foundation/Foundation.h>
8 #import "AgoraObjects.h"
9
10 NS_ASSUME_NONNULL_BEGIN
11
12 @protocol AgoraVideoEffectObject <NSObject>
13
14 #pragma mark - Enumerations
15
20 typedef NS_ENUM(NSUInteger, AgoraVideoEffectNodeId) {
22 AgoraVideoEffectNodeBeauty = 1 << 0,
24 AgoraVideoEffectNodeStyleMakeup = 1 << 1,
26 AgoraVideoEffectNodeFilter = 1 << 2,
28 AgoraVideoEffectNodeSticker = 1 << 3
29 };
30
36 typedef NS_ENUM(NSInteger, AgoraVideoEffectAction) {
38 AgoraVideoEffectActionSave = 1,
40 AgoraVideoEffectActionReset = 2
41 };
42
43 #pragma mark - Core Operations
44
65 - (int)addOrUpdateVideoEffectWithNodeId:(NSUInteger)nodeId
66 templateName:(NSString *)templateName
67 NS_SWIFT_NAME(addOrUpdateVideoEffect(nodeId:templateName:));
68
80 - (int)removeVideoEffectWithNodeId:(NSUInteger)nodeId
81 NS_SWIFT_NAME(removeVideoEffect(nodeId:));
82
83 #pragma mark - Effect Operations
84
85
98 - (int)performVideoEffectActionWithNodeId:(NSUInteger)nodeId
99 actionId:(AgoraVideoEffectAction)actionId
100 NS_SWIFT_NAME(performVideoEffectAction(nodeId:actionId:));
101
102 #pragma mark - Parameter Configuration
103
116 - (int)setVideoEffectStringParamWithOption:(NSString *)option
117 key:(NSString *)key
118 stringValue:(NSString *)stringValue
119 NS_SWIFT_NAME(setVideoEffectStringParam(option:key:stringValue:));
120
134 - (int)setVideoEffectFloatParamWithOption:(NSString *)option
135 key:(NSString *)key
136 floatValue:(float)floatValue
137 NS_SWIFT_NAME(setVideoEffectFloatParam(option:key:floatValue:));
138
152 - (int)setVideoEffectIntParamWithOption:(NSString *)option
153 key:(NSString *)key
154 intValue:(int)intValue
155 NS_SWIFT_NAME(setVideoEffectIntParam(option:key:intValue:));
156
169 - (int)setVideoEffectBoolParamWithOption:(NSString *)option
170 key:(NSString *)key
171 boolValue:(BOOL)boolValue
172 NS_SWIFT_NAME(setVideoEffectBoolParam(option:key:boolValue:));
173
174 #pragma mark - Parameter Retrieval
175
187 - (float)getVideoEffectFloatParamWithOption:(NSString *)option
188 key:(NSString *)key
189 NS_SWIFT_NAME(getVideoEffectFloatParam(option:key:));
190
202 - (int)getVideoEffectIntParamWithOption:(NSString *)option
203 key:(NSString *)key
204 NS_SWIFT_NAME(getVideoEffectIntParam(option:key:));
205
217 - (BOOL)getVideoEffectBoolParamWithOption:(NSString *)option
218 key:(NSString *)key
219 NS_SWIFT_NAME(getVideoEffectBoolParam(option:key:));
220
221 @end
222
223 NS_ASSUME_NONNULL_END
AgoraObjects.h