MeiCam SDK For Android  1.0.0
Public Member Functions | List of all members
com.meicam.sdk.NvsFx Class Reference

Special effects. More...

Inheritance diagram for com.meicam.sdk.NvsFx:
com.meicam.sdk.NvsObject com.meicam.sdk.NvsAudioFx com.meicam.sdk.NvsAudioTransition com.meicam.sdk.NvsCaptureVideoFx com.meicam.sdk.NvsTimelineAnimatedSticker com.meicam.sdk.NvsTimelineCaption com.meicam.sdk.NvsTimelineVideoFx com.meicam.sdk.NvsVideoFx com.meicam.sdk.NvsVideoTransition

Public Member Functions

NvsFxDescription getDescription ()
 Gets decription of Fx. More...
 
void setIntVal (String fxParam, int val)
 Sets the integer parameter of NvsFx. More...
 
int getIntVal (String fxParam)
 Gets the integer parameter of NvsFx. More...
 
void setFloatVal (String fxParam, double val)
 Sets the float parameter of NvsFx. More...
 
double getFloatVal (String fxParam)
 Gets the float parameter of NvsFx. More...
 
void setBooleanVal (String fxParam, boolean val)
 Sets the boolean parameter of NvsFx. More...
 
boolean getBooleanVal (String fxParam)
 Gets the boolean parameter of NvsFx. More...
 
void setStringVal (String fxParam, String val)
 Sets the string parameter of NvsFx. More...
 
String getStringVal (String fxParam)
 Gets the string parameter of NvsFx. More...
 
void setColorVal (String fxParam, NvsColor val)
 Sets the color parameter of NvsFx. More...
 
NvsColor getColorVal (String fxParam)
 Gets the color parameter of NvsFx. More...
 
void setPosition2DVal (String fxParam, NvsPosition2D val)
 Sets the two dimentional coordinates parameter of NvsFx. More...
 
NvsPosition2D getPosition2DVal (String fxParam)
 Gets the two dimentional coordinates parameter of NvsFx. More...
 
void setPosition3DVal (String fxParam, NvsPosition3D val)
 Sets the three dimentional coordinates parameter of NvsFx. More...
 
NvsPosition3D getPosition3DVal (String fxParam)
 Gets the three dimentional coordinates parameter of NvsFx. More...
 
void setMenuVal (String fxParam, String val)
 Sets the menu parameter of NvsFx. More...
 
String getMenuVal (String fxParam)
 Gets the menu parameter of NvsFx. More...
 
void setFilterIntensity (float intensity)
 Sets the intensity of the filter. More...
 
float getFilterIntensity ()
 Gets the intensity of the filter. More...
 
NvsParticleSystemContext getParticleSystemContext ()
 
NvsARFaceContext getARFaceContext ()
 
NvsPaintingEffectContext getPaintingEffectContext ()
 
NvsARSceneManipulate getARSceneManipulate ()
 获得NvsARSceneManipulate接口 More...
 
- Public Member Functions inherited from com.meicam.sdk.NvsObject
void setAttachment (String key, Object value)
 Adds additional data to the NvsObject object to identify the NvsObject object or for other purpose. More...
 
Object getAttachment (String key)
 Gets an attachment to NvsObject. More...
 

Additional Inherited Members

- Protected Member Functions inherited from com.meicam.sdk.NvsObject
void setInternalObject (long internalObject)
 
long getInternalObject ()
 
- Protected Attributes inherited from com.meicam.sdk.NvsObject
long m_internalObject = 0
 

Detailed Description

Special effects.

Special effects class(NvsFx) is the base class of different special effects classes include video(Video Fx), audio(Audio Fx), audio transition and video transition. In the SDK framework, special effects are very important, as they are derived from the NvsFx class, with different kinds of effects. They can be added, removed or obtained from clips, timelines or tracks. Also, the Special effects class(NvsFx) provides different APIs to modify or obtain its parameters.

Warning
In the NvsFx class, all public APIs are used in UI thread!!!

Member Function Documentation

NvsARFaceContext com.meicam.sdk.NvsFx.getARFaceContext ( )
inline
NvsARSceneManipulate com.meicam.sdk.NvsFx.getARSceneManipulate ( )
inline

获得NvsARSceneManipulate接口

Returns
返回NvsARSceneManipulate接口
Since
2.7.0
boolean com.meicam.sdk.NvsFx.getBooleanVal ( String  fxParam)
inline

Gets the boolean parameter of NvsFx.

Parameters
fxParamThe type of the NvsFx's float parameter. Please refer to [PARAM_TYPE_BOOL].
Returns
Returns the boolean value.
See also
setBooleanVal
NvsColor com.meicam.sdk.NvsFx.getColorVal ( String  fxParam)
inline

Gets the color parameter of NvsFx.

Parameters
fxParamThe type of the NvsFx's color parameter. Please refer to [PARAM_TYPE_COLOR].
Returns
Returns the customized color object[NvsColor].
See also
setColorVal
NvsFxDescription com.meicam.sdk.NvsFx.getDescription ( )
inline

Gets decription of Fx.

Returns
Returns the NvsFxDescription object.
float com.meicam.sdk.NvsFx.getFilterIntensity ( )
inline

Gets the intensity of the filter.

Returns
Returns the degree of intensity of the filter.
See also
setFilterIntensity
Since
2.0.2
double com.meicam.sdk.NvsFx.getFloatVal ( String  fxParam)
inline

Gets the float parameter of NvsFx.

Parameters
fxParamThe type of the NvsFx's float parameter. Please refer to [PARAM_TYPE_FLOAT].
Returns
Returns the double value.
See also
setFloatVal
int com.meicam.sdk.NvsFx.getIntVal ( String  fxParam)
inline

Gets the integer parameter of NvsFx.

Parameters
fxParamThe type of the NvsFx's integer parameter. Please refer to [PARAM_TYPE_INT].
Returns
Returns the integer value.
See also
setIntVal
String com.meicam.sdk.NvsFx.getMenuVal ( String  fxParam)
inline

Gets the menu parameter of NvsFx.

Parameters
fxParamThe type of the NvsFx's menu parameter. Please refer to [PARAM_TYPE_MENU].
Returns
Returns the menu value of NvsFx.
See also
setMenuVal
NvsPaintingEffectContext com.meicam.sdk.NvsFx.getPaintingEffectContext ( )
inline
NvsParticleSystemContext com.meicam.sdk.NvsFx.getParticleSystemContext ( )
inline
NvsPosition2D com.meicam.sdk.NvsFx.getPosition2DVal ( String  fxParam)
inline

Gets the two dimentional coordinates parameter of NvsFx.

Parameters
fxParamThe type of the NvsFx's two dimentional coordinates parameter. Please refer to [PARAM_TYPE_POSITION2D].
Returns
Returns the two dimentional coordinates object[NvPosition2D].
See also
setPosition2DVal
getPosition3DVal
NvsPosition3D com.meicam.sdk.NvsFx.getPosition3DVal ( String  fxParam)
inline

Gets the three dimentional coordinates parameter of NvsFx.

Parameters
fxParamThe type of the NvsFx's three dimentional coordinates parameter. Please refer to [PARAM_TYPE_POSITION3D].
Returns
Returns the three dimentional coordinates object[NvPosition3D].
See also
setPosition3DVal
getPosition2DVal
String com.meicam.sdk.NvsFx.getStringVal ( String  fxParam)
inline

Gets the string parameter of NvsFx.

Parameters
fxParamThe type of the NvsFx's string parameter. Please refer to [PARAM_TYPE_STRING].
Returns
Returns the string value.
See also
setStringVal
void com.meicam.sdk.NvsFx.setBooleanVal ( String  fxParam,
boolean  val 
)
inline

Sets the boolean parameter of NvsFx.

Parameters
fxParamThe type of the NvsFx's float parameter. Please refer to [PARAM_TYPE_BOOL].
valA boolean value.
See also
getBooleanVal
void com.meicam.sdk.NvsFx.setColorVal ( String  fxParam,
NvsColor  val 
)
inline

Sets the color parameter of NvsFx.

Parameters
fxParamThe type of the NvsFx's color parameter. Please refer to [PARAM_TYPE_COLOR].
valNvsColor Customized color object.
See also
getColorVal
void com.meicam.sdk.NvsFx.setFilterIntensity ( float  intensity)
inline

Sets the intensity of the filter.

Parameters
intensityThe degree of intensity of the filter, ranging from 0 to 1, with 0 means no effects and 1 means the default effects.
See also
getFilterIntensity
Since
2.0.2
void com.meicam.sdk.NvsFx.setFloatVal ( String  fxParam,
double  val 
)
inline

Sets the float parameter of NvsFx.

Parameters
fxParamThe type of the NvsFx's float parameter. Please refer to [PARAM_TYPE_FLOAT].
valAn float value.
See also
getFloatVal
void com.meicam.sdk.NvsFx.setIntVal ( String  fxParam,
int  val 
)
inline

Sets the integer parameter of NvsFx.

Parameters
fxParamThe type of the NvsFx's integer parameter. Please refer to PARAM_TYPE_INT.
valAn integer value.
See also
getIntVal
void com.meicam.sdk.NvsFx.setMenuVal ( String  fxParam,
String  val 
)
inline

Sets the menu parameter of NvsFx.

Parameters
fxParamThe type of the NvsFx's menu parameter. Please refer to [PARAM_TYPE_MENU].
valA string value.
See also
getMenuVal
void com.meicam.sdk.NvsFx.setPosition2DVal ( String  fxParam,
NvsPosition2D  val 
)
inline

Sets the two dimentional coordinates parameter of NvsFx.

Parameters
fxParamThe type of the NvsFx's two dimentional coordinates parameter. Please refer to [PARAM_TYPE_POSITION2D].
valTwo dimentional coordinates object[NvsPosition2D].
See also
getPosition2DVal
setPosition3DVal
void com.meicam.sdk.NvsFx.setPosition3DVal ( String  fxParam,
NvsPosition3D  val 
)
inline

Sets the three dimentional coordinates parameter of NvsFx.

Parameters
fxParamThe type of the NvsFx's three dimentional coordinates parameter. Please refer to [PARAM_TYPE_POSITION3D].
valThree dimentional coordinates object[NvsPosition3D].
See also
getPosition3DVal
setPosition2DVal
void com.meicam.sdk.NvsFx.setStringVal ( String  fxParam,
String  val 
)
inline

Sets the string parameter of NvsFx.

Parameters
fxParamThe type of the NvsFx's string parameter. Please refer to [PARAM_TYPE_STRING].
valA string value.
See also
getStringVal

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