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

Video effect. More...

Inheritance diagram for com.meicam.effect.sdk.NvsVideoEffect:
com.meicam.effect.sdk.NvsEffect

Public Member Functions

int getVideoFxType ()
 Gets video special effect type. More...
 
String getBuiltinVideoFxName ()
 Gets built-in video effect's name. More...
 
String getVideoFxPackageId ()
 Gets the video effect resource package ID. More...
 
PointF mapPointFromCanonicalToParticleSystem (NvsVideoResolution videoRes, PointF ptCononical)
 Converts canonical coordinates to particle system coordinates. More...
 
- Public Member Functions inherited from com.meicam.effect.sdk.NvsEffect
NvsFxDescription getDescription ()
 Gets the description of the Effect. More...
 
void setIntVal (String fxParam, int val)
 Sets the integer parameter value of the effect. More...
 
int getIntVal (String fxParam)
 Gets the integer parameter value of the effect. More...
 
void setFloatVal (String fxParam, double val)
 Sets the float parameter value of the effect. More...
 
double getFloatVal (String fxParam)
 Gets the float parameter value of the effect. More...
 
void setBooleanVal (String fxParam, boolean val)
 Sets the Boolean parameter value of the effect. More...
 
boolean getBooleanVal (String fxParam)
 Gets the Boolean parameter value of the effect. More...
 
void setStringVal (String fxParam, String val)
 Sets the string parameter value of the effect. More...
 
String getStringVal (String fxParam)
 Gets the string parameter value of the effect. More...
 
void setColorVal (String fxParam, NvsColor val)
 Sets the color parameter value of the effect. More...
 
NvsColor getColorVal (String fxParam)
 Gets the color parameter value of the effect. More...
 
void setPosition2DVal (String fxParam, NvsPosition2D val)
 Sets the 2D coordinates parameter value of the effect. More...
 
NvsPosition2D getPosition2DVal (String fxParam)
 Gets the 2D coordinates parameter value of the effect. More...
 
void setPosition3DVal (String fxParam, NvsPosition3D val)
 Sets the 3D coordinates parameter value of the effect. More...
 
NvsPosition3D getPosition3DVal (String fxParam)
 Gets the 3D coordinates parameter value of the effect. More...
 
void setMenuVal (String fxParam, String val)
 Sets the menu parameter value of the effect. More...
 
String getMenuVal (String fxParam)
 Gets the menu parameter value of the effect. More...
 
void setArbDataVal (String fxParam, NvsArbitraryData val)
 Sets custom data parameter value. More...
 
void setFilterIntensity (float intensity)
 Sets the intensity of the filter. More...
 
float getFilterIntensity ()
 Gets the intensity of the filter. More...
 
void release ()
 Releases internal resources. More...
 
NvsParticleSystemContext getParticleSystemContext ()
 
NvsPaintingEffectContext getPaintingEffectContext ()
 

Static Public Attributes

Video effect type

static final int VIDEOFX_TYPE_BUILTIN = 0
 
static final int VIDEOFX_TYPE_PACKAGE = 1
 
static final int VIDEOFX_TYPE_CUSTOM = 2
 

Additional Inherited Members

- Protected Member Functions inherited from com.meicam.effect.sdk.NvsEffect
void setInternalObject (long internalObject)
 
long getInternalObject ()
 
void finalize () throws Throwable
 

Detailed Description

Video effect.

Video effect is the special effect on the video clips, which can change the overall or partial color, brightness, transparency, etc. of the video frame, so that the video can show a special effect. On video clips, users can add, remove, and get multiple video effects.

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

Member Function Documentation

String com.meicam.effect.sdk.NvsVideoEffect.getBuiltinVideoFxName ( )
inline

Gets built-in video effect's name.

Returns
Returns the name of the built-in video effect. If it is not a built-in video effect, a null string value is returned.
Since
2.3.0
String com.meicam.effect.sdk.NvsVideoEffect.getVideoFxPackageId ( )
inline

Gets the video effect resource package ID.

Returns
Returns the video effect resource package ID. If it is not a resource package video effect, a null string value is returned.
Since
2.3.0
int com.meicam.effect.sdk.NvsVideoEffect.getVideoFxType ( )
inline

Gets video special effect type.

Returns
Returns the video effect type. Please refer to Video Effects Type.
Since
2.3.0
PointF com.meicam.effect.sdk.NvsVideoEffect.mapPointFromCanonicalToParticleSystem ( NvsVideoResolution  videoRes,
PointF  ptCononical 
)
inline

Converts canonical coordinates to particle system coordinates.

Parameters
videoResResolution of video
ptCononicalTimeline coordinates
Returns
Returns the transformed PointF object in particle system coordinates.
Since
2.3.0

Member Data Documentation

final int com.meicam.effect.sdk.NvsVideoEffect.VIDEOFX_TYPE_BUILTIN = 0
static
final int com.meicam.effect.sdk.NvsVideoEffect.VIDEOFX_TYPE_CUSTOM = 2
static
final int com.meicam.effect.sdk.NvsVideoEffect.VIDEOFX_TYPE_PACKAGE = 1
static

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