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
17 @protocol AgoraVideoEffectObject <NSObject>
18
19 #pragma mark - Enumerations
20
25 typedef NS_ENUM(NSUInteger, AgoraVideoEffectNodeId) {
29 AgoraVideoEffectNodeBeauty = 1 << 0,
33 AgoraVideoEffectNodeStyleMakeup = 1 << 1,
37 AgoraVideoEffectNodeFilter = 1 << 2
38 };
39
45 typedef NS_ENUM(NSInteger, AgoraVideoEffectAction) {
49 AgoraVideoEffectActionSave = 1,
53 AgoraVideoEffectActionReset = 2
54 };
55
56 #pragma mark - Core Operations
57
84 - (int)addOrUpdateVideoEffectWithNodeId:(NSUInteger)nodeId
85 templateName:(NSString *)templateName
86 NS_SWIFT_NAME(addOrUpdateVideoEffect(nodeId:templateName:));
87
100 - (int)removeVideoEffectWithNodeId:(NSUInteger)nodeId
101 NS_SWIFT_NAME(removeVideoEffect(nodeId:));
102
103 #pragma mark - Effect Operations
104
105
118 - (int)performVideoEffectActionWithNodeId:(NSUInteger)nodeId
119 actionId:(AgoraVideoEffectAction)actionId
120 NS_SWIFT_NAME(performVideoEffectAction(nodeId:actionId:));
121
122 #pragma mark - Parameter Configuration
123
136 - (int)setVideoEffectFloatParamWithOption:(NSString *)option
137 key:(NSString *)key
138 floatValue:(float)floatValue
139 NS_SWIFT_NAME(setVideoEffectFloatParam(option:key:floatValue:));
140
154 - (int)setVideoEffectIntParamWithOption:(NSString *)option
155 key:(NSString *)key
156 intValue:(int)intValue
157 NS_SWIFT_NAME(setVideoEffectIntParam(option:key:intValue:));
158
174 - (int)setVideoEffectBoolParamWithOption:(NSString *)option
175 key:(NSString *)key
176 boolValue:(BOOL)boolValue
177 NS_SWIFT_NAME(setVideoEffectBoolParam(option:key:boolValue:));
178
179 #pragma mark - Parameter Retrieval
180
196 - (float)getVideoEffectFloatParamWithOption:(NSString *)option
197 key:(NSString *)key
198 NS_SWIFT_NAME(getVideoEffectFloatParam(option:key:));
199
215 - (int)getVideoEffectIntParamWithOption:(NSString *)option
216 key:(NSString *)key
217 NS_SWIFT_NAME(getVideoEffectIntParam(option:key:));
218
231 - (BOOL)getVideoEffectBoolParamWithOption:(NSString *)option
232 key:(NSString *)key
233 NS_SWIFT_NAME(getVideoEffectBoolParam(option:key:));
234
235 @end
236
237 NS_ASSUME_NONNULL_END
AgoraObjects.h