AgoraVideoEffectObject.h

Go to the documentation of this file.

//  AgoraVideoEffectObject.h
//  AgoraVideoEffect
//
//  Copyright (c) 2023 Agora. All rights reserved.
//
 
#import <Foundation/Foundation.h>
#import "AgoraObjects.h"
 
NS_ASSUME_NONNULL_BEGIN
 
@protocol AgoraVideoEffectObject <NSObject>
 
#pragma mark - Enumerations
 
typedef NS_ENUM(NSUInteger, AgoraVideoEffectNodeId) {
    AgoraVideoEffectNodeBeauty      = 1 << 0, 
    AgoraVideoEffectNodeStyleMakeup = 1 << 1, 
    AgoraVideoEffectNodeFilter      = 1 << 2,
    AgoraVideoEffectNodeSticker     = 1 << 3
};
 
typedef NS_ENUM(NSInteger, AgoraVideoEffectAction) {
    AgoraVideoEffectActionSave  = 1, 
    AgoraVideoEffectActionReset = 2  
};
 
#pragma mark - Core Operations
 
- (int)addOrUpdateVideoEffectWithNodeId:(NSUInteger)nodeId
                          templateName:(NSString *)templateName
NS_SWIFT_NAME(addOrUpdateVideoEffect(nodeId:templateName:));
 
- (int)removeVideoEffectWithNodeId:(NSUInteger)nodeId
NS_SWIFT_NAME(removeVideoEffect(nodeId:));
 
#pragma mark - Effect Operations
 
 
- (int)performVideoEffectActionWithNodeId:(NSUInteger)nodeId
                                actionId:(AgoraVideoEffectAction)actionId
NS_SWIFT_NAME(performVideoEffectAction(nodeId:actionId:));
 
#pragma mark - Parameter Configuration
 
- (int)setVideoEffectStringParamWithOption:(NSString *)option
                                       key:(NSString *)key
                               stringValue:(NSString *)stringValue
NS_SWIFT_NAME(setVideoEffectStringParam(option:key:stringValue:));
 
- (int)setVideoEffectFloatParamWithOption:(NSString *)option
                                    key:(NSString *)key
                              floatValue:(float)floatValue
NS_SWIFT_NAME(setVideoEffectFloatParam(option:key:floatValue:));
 
- (int)setVideoEffectIntParamWithOption:(NSString *)option
                                    key:(NSString *)key
                               intValue:(int)intValue
NS_SWIFT_NAME(setVideoEffectIntParam(option:key:intValue:));
 
- (int)setVideoEffectBoolParamWithOption:(NSString *)option
                                    key:(NSString *)key
                              boolValue:(BOOL)boolValue
NS_SWIFT_NAME(setVideoEffectBoolParam(option:key:boolValue:));
 
#pragma mark - Parameter Retrieval
 
- (float)getVideoEffectFloatParamWithOption:(NSString *)option
                                    key:(NSString *)key
NS_SWIFT_NAME(getVideoEffectFloatParam(option:key:));
 
- (int)getVideoEffectIntParamWithOption:(NSString *)option
                                    key:(NSString *)key
NS_SWIFT_NAME(getVideoEffectIntParam(option:key:));
 
- (BOOL)getVideoEffectBoolParamWithOption:(NSString *)option
                                    key:(NSString *)key
NS_SWIFT_NAME(getVideoEffectBoolParam(option:key:));
 
@end
 
NS_ASSUME_NONNULL_END