Effect parameter description class in effect sdk. More...
#import <NvsEffectDescription.h>
Instance Methods | |
| (NSArray *) | - getAllParamsInfo |
| Gets all the effect parameter information. More... | |
Properties | |
| NSString * | name |
| Effect name. More... | |
Detailed Description
Effect parameter description class in effect sdk.
A variety of different parameter types of effect are set during capturing and editing. The effect parameter description class is used to obtain various effect parameter values.
- Warning
- In the NvsFxDescription class, all public APIs are used in the UI thread! ! !
Method Documentation
◆ getAllParamsInfo
| - (NSArray *) getAllParamsInfo |
Gets all the effect parameter information.
- Return values
-
(NSArray *) Returns an array object containing a list of all effect parameters.
Detailed description: return type(NSArray *) {(NSDictionary *), ...}
NSDictionary* Internal structure:
{ NVS_PARAM_NAME: (NSString *) NVS_PARAM_TYPE: (NSString *) NVS_PARAM_INT_DEF_VAL: (NSNumber) NVS_PARAM_INT_MIN_VAL: (NSNumber) NVS_PARAM_INT_MAX_VAL: (NSNumber) NVS_PARAM_FLOAT_DEF_VAL: (NSNumber) NVS_PARAM_INT_MIN_VAL: (NSNumber) NVS_PARAM_INT_MAX_VAL: (NSNumber) NVS_PARAM_BOOL_DEF_VAL: (NSNumber) NVS_PARAM_COLOR_DEF_R: (NSNumber) NVS_PARAM_COLOR_DEF_G: (NSNumber) NVS_PARAM_COLOR_DEF_B: (NSNumber) NVS_PARAM_COLOR_DEF_A: (NSNumber) NVS_PARAM_POSITION2D_DEF_X: (NSNumber) NVS_PARAM_POSITION2D_DEF_Y: (NSNumber) NVS_PARAM_POSITION3D_DEF_X: (NSNumber) NVS_PARAM_POSITION3D_DEF_Y: (NSNumber) NVS_PARAM_POSITION3D_DEF_Z: (NSNumber) NVS_PARAM_STRING_TYPE: (NSNumber) NVS_PARAM_STRING_DEF: (NSString *) NVS_PARAM_MENU_DEF_VAL: (NSString *) NVS_PARAM_MENU_ARRAY: (NSArray *) {(NSString *), ...} }
Property Documentation
◆ name
|
readatomicassign |
Effect name.
The documentation for this class was generated from the following file:
- include/sdkcore/ios/NvsEffectDescription.h
