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

Timeline video effect. More...

Inheritance diagram for com.meicam.sdk.NvsTimelineVideoFx:
com.meicam.sdk.NvsFx com.meicam.sdk.NvsObject

Public Member Functions

int getTimelineVideoFxType ()
 Gets timeline video effect type. More...
 
String getBuiltinTimelineVideoFxName ()
 Gets the embedded timeline video effect name. More...
 
String getTimelineVideoFxPackageId ()
 Gets timeline video effect resource package ID. More...
 
long getInPoint ()
 Timeline video effect in-point on the timeline. More...
 
long getOutPoint ()
 Timeline video effect out-point on the timeline. More...
 
long changeInPoint (long newInPoint)
 Changes the in-point of the timeline video effect on the timeline. More...
 
long changeOutPoint (long newOutPoint)
 Changes the out-point of the timeline video effect on the timeline. More...
 
void movePosition (long offset)
 Changes the position of the timeline video effect on the timeline (the in and out points translate the offset value at the same time). More...
 
PointF mapPointFromCanonicalToParticleSystem (PointF ptCononical)
 Converts timeline coordinates to particle system coordinates. More...
 
- Public Member Functions inherited from com.meicam.sdk.NvsFx
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...
 

Static Public Attributes

Timeline video effect type.

static final int TIMELINE_VIDEOFX_TYPE_BUILTIN = 0
 
static final int TIMELINE_VIDEOFX_TYPE_PACKAGE = 1
 
static final int TIMELINE_VIDEOFX_TYPE_CUSTOM = 2
 

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

Timeline video effect.

Note: The in-point and out-point units of the timeline video effect on the timeline are both microseconds.

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

Member Function Documentation

long com.meicam.sdk.NvsTimelineVideoFx.changeInPoint ( long  newInPoint)
inline

Changes the in-point of the timeline video effect on the timeline.

Parameters
newInPointThe new in-point of the animated sticker on the timeline (in microseconds).
Returns
Returns the final in-point value of the timeline video effect on the timeline (in microseconds).
Warning
This interface will cause the streaming engine state to jump to the engine stop state. For details, please refer to Engine Change.
See also
changeOutPoint
movePosition
long com.meicam.sdk.NvsTimelineVideoFx.changeOutPoint ( long  newOutPoint)
inline

Changes the out-point of the timeline video effect on the timeline.

Parameters
newOutPointThe new out-point of the animated sticker on the timeline (in microseconds).
Returns
Returns the final out-point value of the timeline video effect on the timeline (in microseconds).
Warning
This interface will cause the streaming engine state to jump to the engine stop state. For details, please refer to Engine Change.
See also
changeInPoint
movePosition
String com.meicam.sdk.NvsTimelineVideoFx.getBuiltinTimelineVideoFxName ( )
inline

Gets the embedded timeline video effect name.

Returns
Returns the name of the embedded timeline video effect. If it is not a built-in timeline video effect, it returns a null string.
Since
1.7.0
long com.meicam.sdk.NvsTimelineVideoFx.getInPoint ( )
inline

Timeline video effect in-point on the timeline.

Returns
The in-point of the timeline video effect on the timeline (in microseconds).
See also
getOutPoint
changeInPoint
long com.meicam.sdk.NvsTimelineVideoFx.getOutPoint ( )
inline

Timeline video effect out-point on the timeline.

Returns
The out-point of the timeline video effect on the timeline (in microseconds).
See also
getInPoint
changeOutPoint
String com.meicam.sdk.NvsTimelineVideoFx.getTimelineVideoFxPackageId ( )
inline

Gets timeline video effect resource package ID.

Returns
Returns the timeline video effect resource package ID. If it is not a resource package timeline video effect, it returns a null string.
Since
1.7.0
int com.meicam.sdk.NvsTimelineVideoFx.getTimelineVideoFxType ( )
inline

Gets timeline video effect type.

Returns
Returns the timeline video effect type. See [Timeline Video effect Type]. (TIMELINE_VIDEOFX_TYPE).
Since
1.7.0
PointF com.meicam.sdk.NvsTimelineVideoFx.mapPointFromCanonicalToParticleSystem ( PointF  ptCononical)
inline

Converts timeline coordinates to particle system coordinates.

Parameters
ptCononicalTimeline coordinates.
Returns
Returns the transformed particle system coordinates, PointF object.
Since
1.16.0
void com.meicam.sdk.NvsTimelineVideoFx.movePosition ( long  offset)
inline

Changes the position of the timeline video effect on the timeline (the in and out points translate the offset value at the same time).

Parameters
offsetOffset value for in and out points (in microseconds).
Warning
This interface will cause the streaming engine state to jump to the engine stop state. For details, please refer to Engine Change.
See also
changeInPoint
changeOutPoint

Member Data Documentation

final int com.meicam.sdk.NvsTimelineVideoFx.TIMELINE_VIDEOFX_TYPE_BUILTIN = 0
static
final int com.meicam.sdk.NvsTimelineVideoFx.TIMELINE_VIDEOFX_TYPE_CUSTOM = 2
static
final int com.meicam.sdk.NvsTimelineVideoFx.TIMELINE_VIDEOFX_TYPE_PACKAGE = 1
static

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