effect parameter information class, mainly the details of the effect parameters. More...

Public Member Functions
final int	getInteger (String name)
	Get the default value or range of values for the effect parameter of integer type. More...

final double	getFloat (String name)
	Get the default value or range of values for the effect parameter of float type. More...

final String	getString (String name)
	Get the string parameter and the default value or type of the effect parameter. More...

final Object	getObject (String name)
	Get the object of the menu parameter value. More...

final boolean	getBoolean (String name)
	Get the default value of the boolean type of the effect parameter. More...

Static Public Attributes
static final String	PARAM_NAME = "paramName"

static final String	PARAM_TYPE = "paramType"

static final String	PARAM_STRING_TYPE = "stringType"

static final String	PARAM_STRING_DEF = "stringDef"

static final String	PARAM_MENU_DEF_VAL = "menuDefVal"

static final String	PARAM_MENU_ARRAY = "menuArray"

Effect parameter type

static final String	PARAM_TYPE_INT = "INT"
	int type More...

static final String	PARAM_TYPE_FLOAT = "FLOAT"
	float type More...

static final String	PARAM_TYPE_BOOL = "BOOL"
	bool type More...

static final String	PARAM_TYPE_MENU = "MENU"
	menu type More...

static final String	PARAM_TYPE_STRING = "STRING"
	string type More...

static final String	PARAM_TYPE_COLOR = "COLOR"
	color type More...

static final String	PARAM_TYPE_POSITION2D = "POSITION2D"
	2D coordinates type More...

static final String	PARAM_TYPE_POSITION3D = "POSITION3D"
	3D coordinates type More...

static final String	PARAM_TYPE_ARBITRARY = "ARBITRARY"
	custom arbitrary data type More...

String parameter type

static final int	PARAM_STRING_TYPE_INVALID = -1
	Invalid. More...

static final int	PARAM_STRING_TYPE_SINGLELINE = 0
	Single line. More...

static final int	PARAM_STRING_TYPE_MULTILINE = 1
	Multi-line. More...

static final int	PARAM_STRING_TYPE_FILEPATH = 2
	File path. More...

static final int	PARAM_STRING_TYPE_DIRECTORYPATH = 3
	Directory path. More...

static final int	PARAM_STRING_TYPE_LABEL = 4
	Label. More...

The default value and value range of the effect parameter of integer type
static final String	PARAM_INT_DEF_VAL = "intDefVal"

static final String	PARAM_INT_MIN_VAL = "intMinVal"

static final String	PARAM_INT_MAX_VAL = "intMaxVal"

The effect's float type parameter default value and value range
static final String	PARAM_FLOAT_DEF_VAL = "floatDefVal"

static final String	PARAM_FLOAT_MIN_VAL = "floatMinVal"

static final String	PARAM_FLOAT_MAX_VAL = "floatMaxVal"

The effect's default boolean type parameter value
static final String	PARAM_BOOL_DEF_VAL = "boolDefVal"

The effect's color type parameter value
static final String	PARAM_COLOR_DEF_R = "colorDefR"

static final String	PARAM_COLOR_DEF_G = "colorDefG"

static final String	PARAM_COLOR_DEF_B = "colorDefB"

static final String	PARAM_COLOR_DEF_A = "colorDefA"

The effect's 2D coordinates type default value
static final String	PARAM_POSITION2D_DEF_X = "position2DDefX"

static final String	PARAM_POSITION2D_DEF_Y = "position2DDefY"

The effect's 3D coordinates type default value
static final String	PARAM_POSITION3D_DEF_X = "position3DDefX"

static final String	PARAM_POSITION3D_DEF_Y = "position3DDefY"

static final String	PARAM_POSITION3D_DEF_Z = "position3DDefZ"

Detailed Description

effect parameter information class, mainly the details of the effect parameters.

Member Function Documentation

◆ getBoolean()

final boolean com.meicam.sdk.NvsFxDescription.ParamInfoObject.getBoolean ( String name )

inline

Get the default value of the boolean type of the effect parameter.

Parameters

name	The definition of the default value of the boolean value to be obtained,please refer toPARAM_BOOL_DEF_VAL

Returns: Returns the default value of the boolean type of the effect parameter.

See also: com.meicam.sdk.NvsFx.setBooleanVal

◆ getFloat()

final double com.meicam.sdk.NvsFxDescription.ParamInfoObject.getFloat ( String name )

inline

Get the default value or range of values for the effect parameter of float type.

Parameters

name	The name of the default value or range of value for the effect parameter of float type to be obtained

For instance, setting PARAM_FLOAT_DEF_VAL means to obtain the default value of effect parameter of float type. PARAM_FLOAT_MIN_VAL indicates the minimum value of effect parameter of float type. PARAM_FLOAT_MAX_VAL indicates the maximum value of effect parameter of float type. When using the setFloatVal to set the effect parameter of float type, users need to set the value between the minimum and maximum values that obtained.

The default values of effect parameters of color, 2D coordinates, and 3D coordinates type can also be obtained via this method. Example: Sets PARAM_COLOR_DEF_R to get the value of the red attribute of color. Sets PARAM_POSITION2D_DEF_X to get the X value of 2D coordinates. Sets PARAM_POSITION3D_DEF_X to get the X value of 3D coordinates.

Returns: Return the default or range of values of effect parameter of float type.

See also: com.meicam.sdk.NvsFx.setFloatVal

◆ getInteger()

final int com.meicam.sdk.NvsFxDescription.ParamInfoObject.getInteger ( String name )

inline

Get the default value or range of values for the effect parameter of integer type.

Parameters

name	The name of the range of values for the effect parameter of integer type to be obtained

For instance, setting PARAM_INT_DEF_VAL means to get the default value of effect parameter of integer type. PARAM_INT_MIN_VAL indicates the minimum value of effect parameter of integer type. PARAM_INT_MAX_VAL indicates the maximum value of effect parameter of integer type. When using the method setIntVal to get the integer value of the effect parameter, users need to set the integer value between the minimum and maximum values that obtained.

Returns: Return the default or range of values for effect parameter of integer type.

See also: com.meicam.sdk.NvsFx.setIntVal

◆ getObject()

final Object com.meicam.sdk.NvsFxDescription.ParamInfoObject.getObject ( String name )

inline

Get the object of the menu parameter value.

Parameters

name	The definition of the menu parameter object to get,please refer toPARAM_MENU_ARRAY.

Returns: Return the obtained menu parameter object

◆ getString()

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.getString ( String name )

inline

Get the string parameter and the default value or type of the effect parameter.

Parameters

name	The default value or type definition of the string parameter to be obtained

Set PARAM_STRING_TYPE to get the type of the string parameter (type includesPARAM_STRING_TYPE_*). PARAM_STRING_DEF is the default value for getting string parameter. PARAM_MENU_DEF_VAL is the default value for getting menu parameter. PARAM_TYPE is the type of the effect parameter(type includesPARAM_TYPE_*). PARAM_NAME is the name of the effect parameter.

Returns: Returns the obtained string parameter and the default value or type of the effect parameter.

See also: com.meicam.sdk.NvsFx.setStringVal; com.meicam.sdk.NvsFx.setColorVal; com.meicam.sdk.NvsFx.setPosition2DVal

Member Data Documentation

◆ PARAM_BOOL_DEF_VAL

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_BOOL_DEF_VAL = "boolDefVal"

static

◆ PARAM_COLOR_DEF_A

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_COLOR_DEF_A = "colorDefA"

static

◆ PARAM_COLOR_DEF_B

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_COLOR_DEF_B = "colorDefB"

static

◆ PARAM_COLOR_DEF_G

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_COLOR_DEF_G = "colorDefG"

static

◆ PARAM_COLOR_DEF_R

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_COLOR_DEF_R = "colorDefR"

static

◆ PARAM_FLOAT_DEF_VAL

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_FLOAT_DEF_VAL = "floatDefVal"

static

◆ PARAM_FLOAT_MAX_VAL

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_FLOAT_MAX_VAL = "floatMaxVal"

static

◆ PARAM_FLOAT_MIN_VAL

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_FLOAT_MIN_VAL = "floatMinVal"

static

◆ PARAM_INT_DEF_VAL

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_INT_DEF_VAL = "intDefVal"

static

◆ PARAM_INT_MAX_VAL

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_INT_MAX_VAL = "intMaxVal"

static

◆ PARAM_INT_MIN_VAL

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_INT_MIN_VAL = "intMinVal"

static

◆ PARAM_MENU_ARRAY

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_MENU_ARRAY = "menuArray"

static

◆ PARAM_MENU_DEF_VAL

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_MENU_DEF_VAL = "menuDefVal"

static

◆ PARAM_NAME

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_NAME = "paramName"

static

◆ PARAM_POSITION2D_DEF_X

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_POSITION2D_DEF_X = "position2DDefX"

static

◆ PARAM_POSITION2D_DEF_Y

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_POSITION2D_DEF_Y = "position2DDefY"

static

◆ PARAM_POSITION3D_DEF_X

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_POSITION3D_DEF_X = "position3DDefX"

static

◆ PARAM_POSITION3D_DEF_Y

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_POSITION3D_DEF_Y = "position3DDefY"

static

◆ PARAM_POSITION3D_DEF_Z

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_POSITION3D_DEF_Z = "position3DDefZ"

static

◆ PARAM_STRING_DEF

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_STRING_DEF = "stringDef"

static

◆ PARAM_STRING_TYPE

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_STRING_TYPE = "stringType"

static

◆ PARAM_STRING_TYPE_DIRECTORYPATH

final int com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_STRING_TYPE_DIRECTORYPATH = 3

static

Directory path.

◆ PARAM_STRING_TYPE_FILEPATH

final int com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_STRING_TYPE_FILEPATH = 2

static

File path.

◆ PARAM_STRING_TYPE_INVALID

final int com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_STRING_TYPE_INVALID = -1

static

Invalid.

◆ PARAM_STRING_TYPE_LABEL

final int com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_STRING_TYPE_LABEL = 4

static

Label.

◆ PARAM_STRING_TYPE_MULTILINE

final int com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_STRING_TYPE_MULTILINE = 1

static

Multi-line.

◆ PARAM_STRING_TYPE_SINGLELINE

final int com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_STRING_TYPE_SINGLELINE = 0

static

Single line.

◆ PARAM_TYPE

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_TYPE = "paramType"

static

◆ PARAM_TYPE_ARBITRARY

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_TYPE_ARBITRARY = "ARBITRARY"

static

custom arbitrary data type

◆ PARAM_TYPE_BOOL

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_TYPE_BOOL = "BOOL"

static

bool type

◆ PARAM_TYPE_COLOR

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_TYPE_COLOR = "COLOR"

static

color type

◆ PARAM_TYPE_FLOAT

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_TYPE_FLOAT = "FLOAT"

static

float type

◆ PARAM_TYPE_INT

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_TYPE_INT = "INT"

static

int type

◆ PARAM_TYPE_MENU

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_TYPE_MENU = "MENU"

static

menu type

◆ PARAM_TYPE_POSITION2D

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_TYPE_POSITION2D = "POSITION2D"

static

2D coordinates type

◆ PARAM_TYPE_POSITION3D

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_TYPE_POSITION3D = "POSITION3D"

static

3D coordinates type

◆ PARAM_TYPE_STRING

final String com.meicam.sdk.NvsFxDescription.ParamInfoObject.PARAM_TYPE_STRING = "STRING"

static

string type

The documentation for this class was generated from the following file:

src/android/jar/com/meicam/sdk/NvsFxDescription.java

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ getBoolean()

◆ getFloat()

◆ getInteger()

◆ getObject()

◆ getString()

Member Data Documentation

◆ PARAM_BOOL_DEF_VAL

◆ PARAM_COLOR_DEF_A

◆ PARAM_COLOR_DEF_B

◆ PARAM_COLOR_DEF_G

◆ PARAM_COLOR_DEF_R

◆ PARAM_FLOAT_DEF_VAL

◆ PARAM_FLOAT_MAX_VAL

◆ PARAM_FLOAT_MIN_VAL

◆ PARAM_INT_DEF_VAL

◆ PARAM_INT_MAX_VAL

◆ PARAM_INT_MIN_VAL

◆ PARAM_MENU_ARRAY

◆ PARAM_MENU_DEF_VAL

◆ PARAM_NAME

◆ PARAM_POSITION2D_DEF_X

◆ PARAM_POSITION2D_DEF_Y

◆ PARAM_POSITION3D_DEF_X

◆ PARAM_POSITION3D_DEF_Y

◆ PARAM_POSITION3D_DEF_Z

◆ PARAM_STRING_DEF

◆ PARAM_STRING_TYPE

◆ PARAM_STRING_TYPE_DIRECTORYPATH

◆ PARAM_STRING_TYPE_FILEPATH

◆ PARAM_STRING_TYPE_INVALID

◆ PARAM_STRING_TYPE_LABEL

◆ PARAM_STRING_TYPE_MULTILINE

◆ PARAM_STRING_TYPE_SINGLELINE

◆ PARAM_TYPE

◆ PARAM_TYPE_ARBITRARY

◆ PARAM_TYPE_BOOL

◆ PARAM_TYPE_COLOR

◆ PARAM_TYPE_FLOAT

◆ PARAM_TYPE_INT

◆ PARAM_TYPE_MENU

◆ PARAM_TYPE_POSITION2D

◆ PARAM_TYPE_POSITION3D

◆ PARAM_TYPE_STRING