Timeline video effect Timeline Video Effect is a video effect applied to a Timeline instance. Timeline video effects are divided into three types: built-in effects, packaged effects and custom effects. Built-in effects are integrated into the SDK and can be used without authorization. Packaged effects are the integration of effect resources into effect packages. Each effect package has its own license file and must be installed before it can be used. For details, please refer to Installation of effect package. Custom effects are effects that the user writes code to implement. Timeline video effect contains in-point and out-point, by which we can specify the position and duration of the effect on the timeline. The in-point must be smaller than the out-point, and they are both in microseconds. More...

Inheritance diagram for com.meicam.sdk.NvsTimelineVideoFx:

Public Member Functions
int	getTimelineVideoFxType ()
	Gets timeline video effect type. More...

String	getBuiltinTimelineVideoFxName ()
	Gets the built-in 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)
	Change the in-point of the timeline video effect on the timeline. When the new in-point does not conform to the established rules, the final return in-point may be different from the new in-point value. Such as the new in-point is less than 0, the new in-point value is greater than the timeline duration, or the new in-point is greater than the out-point. More...

long	changeOutPoint (long newOutPoint)
	Change the out-point of the timeline video effect on the timeline. When the new out-point does not conform to the established rules, the final return out-point may be different from the new out-point value. Such as the new out-point is less than 0, the new out-point value is greater than the timeline duration, or the new out-point is less than the in-point. More...

void	movePosition (long offset)
	Change the position of the timeline video effect on the timeline (the in and out points translate the offset value at the same time). More...

void	setZValue (float value)
	Set video effect Z value. The Z value determines the rendering order of the effects. The higher the Z value, the higher the effect is. More...

float	getZValue ()
	Get video effect Z value. More...

PointF	mapPointFromCanonicalToParticleSystem (PointF ptCononical)
	Convert timeline coordinates to particle system coordinates. More...

Public Member Functions inherited from com.meicam.sdk.NvsFx
NvsFxDescription	getDescription ()
	Get decription of Fx. More...

void	setIntVal (String fxParam, int val)
	Set the integer parameter of NvsFx. More...

int	getIntVal (String fxParam)
	Get the integer parameter of NvsFx. More...

void	setIntValAtTime (String fxParam, int val, long time)
	Set the NvsFx's integer parameter at a specified time point. More...

int	getIntValAtTime (String fxParam, long time)
	Get the NvsFx's integer parameter at a specified time point. More...

void	setFloatVal (String fxParam, double val)
	Set the float parameter of NvsFx. More...

double	getFloatVal (String fxParam)
	Get the float parameter of NvsFx. More...

void	setFloatValAtTime (String fxParam, double val, long time)
	Set the NvsFx's float parameter at a specified time point. More...

double	getFloatValAtTime (String fxParam, long time)
	Get the NvsFx's float parameter at a specified time point. More...

void	setBooleanVal (String fxParam, boolean val)
	Set the boolean parameter of NvsFx. More...

boolean	getBooleanVal (String fxParam)
	Get the boolean parameter of NvsFx. More...

void	setBooleanValAtTime (String fxParam, boolean val, long time)
	Set the NvsFx’s boolean parameter at a specified time point. More...

boolean	getBooleanValAtTime (String fxParam, long time)
	Get the NvsFx's boolean parameter at a specified time point. More...

void	setStringVal (String fxParam, String val)
	Set the string parameter of NvsFx. More...

String	getStringVal (String fxParam)
	Get the string parameter of NvsFx. More...

void	setStringValAtTime (String fxParam, String val, long time)
	Set the NvsFx's string parameter at a specified time point. More...

String	getStringValAtTime (String fxParam, long time, int flags)
	Get the NvsFx's string parameter at a specified time point. More...

void	setColorVal (String fxParam, NvsColor val)
	Set the color parameter of NvsFx. More...

NvsColor	getColorVal (String fxParam)
	Get the color parameter of NvsFx. More...

void	setColorValAtTime (String fxParam, NvsColor val, long time)
	Set the NvsFx's color parameter at a specified time point. More...

NvsColor	getColorValAtTime (String fxParam, long time)
	Get the NvsFx's color parameter at a specified time point. More...

void	setPosition2DVal (String fxParam, NvsPosition2D val)
	Set the two dimentional coordinates parameter of NvsFx. More...

NvsPosition2D	getPosition2DVal (String fxParam)
	Get the two dimentional coordinates parameter of NvsFx. More...

void	setPosition2DValAtTime (String fxParam, NvsPosition2D val, long time)
	Set the NvsFx's two dimentional coordinates parameter at a specified time point. More...

NvsPosition2D	getPosition2DValAtTime (String fxParam, long time)
	Get the NvsFx's two dimentional coordinates parameter at a specified time point. More...

void	setPosition3DVal (String fxParam, NvsPosition3D val)
	Set the three dimentional coordinates parameter of NvsFx. More...

NvsPosition3D	getPosition3DVal (String fxParam)
	Get the three dimentional coordinates parameter of NvsFx. More...

void	setPosition3DValAtTime (String fxParam, NvsPosition3D val, long time)
	Set the NvsFx's three dimentional coordinates parameter at a specified time point. More...

NvsPosition3D	getPosition3DValAtTime (String fxParam, long time)
	Get the NvsFx's three dimentional coordinates parameter at a specified time point. More...

void	setMenuVal (String fxParam, String val)
	Set the menu parameter of NvsFx. More...

String	getMenuVal (String fxParam)
	Get the menu parameter of NvsFx. More...

void	setMenuValAtTime (String fxParam, String val, long time)
	Set the NvsFx's menu parameter at a specified time point. More...

String	getMenuValAtTime (String fxParam, long time)
	Get the NvsFx menu parameter at a specified time point. More...

void	setArbDataVal (String fxParam, NvsArbitraryData val)
	Set custom data parameter value. More...

NvsArbitraryData	getArbDataVal (String fxParam)
	Get custom data parameter value. More...

void	setArbDataValAtTime (String fxParam, NvsArbitraryData val, long time)
	Sets custom data parameter value. More...

NvsArbitraryData	getArbDataValAtTime (String fxParam, NvsArbitraryData val, long time)
	Get custom data parameter value at a specified time point. More...

boolean	removeKeyframeAtTime (String fxParam, long time)
	Remove key frame at a specified time point from key frame list. More...

boolean	removeAllKeyframe (String fxParam)
	Remove all key frames from key frame list. More...

boolean	hasKeyframeList (String fxParam)
	Check whether the parameter has key frame list or not. More...

long	findKeyframeTime (String fxParam, long time, int flags)
	Get key frame at a specified time point. More...

boolean	setKeyFrameControlPoint (String fxParam, long time, NvsControlPointPair controlPointPair)
	Set key frame control point pair. More...

NvsControlPointPair	getKeyFrameControlPoint (String fxParam, long time)
	Get key frame control point pair. More...

boolean	setKeyFrameControlPointMode (String fxParam, long time, NvsControlPointModePair controlPointModePair)
	Set key frame control point mode pair. More...

NvsControlPointModePair	getKeyFrameControlPointMode (String fxParam, long time)
	Get key frame control point mode pair. More...

void	setFilterIntensity (float intensity)
	Set the intensity of the filter. More...

float	getFilterIntensity ()
	Get the intensity of the filter. More...

void	setFilterMask (boolean useMask)
	Set the mask of the filter. More...

boolean	getFilterMask ()
	Get the usage of the filter's mask. More...

void	setRegional (boolean isRegional)
	Set whether the filter is regional. More...

boolean	getRegional ()
	Get whether the filter is regional. More...

void	setIgnoreBackground (boolean isIgnoreBackground)
	Set whether the regional filter ignores background. More...

boolean	getIgnoreBackground ()
	Get whether the regional filter ignores background. More...

void	setInverseRegion (boolean isInverseRegion)
	Set whether the regional filter inverses region. More...

boolean	getInverseRegion ()
	Get whether the regional filter inverses region. More...

void	setRegion (float[] region)
	Set the region of this regional filter. More...

float[]	getRegion ()
	Get the region of this regional filter. More...

void	setRegionInfo (NvsMaskRegionInfo info)
	Set the mask region informations of the regional filter. More...

NvsMaskRegionInfo	getRegionInfo ()
	Get the mask region informations of the regional filter. More...

void	setRegionInfoAtTime (NvsMaskRegionInfo info, long time)
	Set the regional filter's mask region informations at a specified time point. More...

NvsMaskRegionInfo	getRegionInfoAtTime (long time)
	Get the the regional filter's mask region informations at a specified time. More...

void	setRegionalFeatherWidth (float featherWidth)
	Set the feather width of the regional filter. More...

float	getRegionalFeatherWidth ()
	Get the feather width of the regional filter. More...

void	setRegionalFeatherWidthAtTime (float featherWidth, long time)
	Set the regional filter's feather width at a specified time point. More...

float	getRegionalFeatherWidthAtTime (long time)
	Get the regional filter's feather width at a specified time point. More...

void	setRegionCoordinateSystemType (int type)
	Set the coordinate system of the region. More...

int	getRegionCoordinateSystemType ()
	Get the coordinate system type of the region. More...

NvsParticleSystemContext	getParticleSystemContext ()
	Get the particle effect context object.Please refer to NvsParticleSystemContext. More...

NvsARFaceContext	getARFaceContext ()
	Get face effect context object.Please refer to NvsARFaceContext. More...

NvsPaintingEffectContext	getPaintingEffectContext ()
	Get the particle effect context object.Please refer to NvsPaintingEffectContext. More...

NvsARSceneManipulate	getARSceneManipulate ()
	Get the AR scene operation object.Please refer to NvsARSceneManipulate. More...

void	setExprVar (String varName, double varValue)
	Set the value of the defined parameter in the expression. More...

double	getExprVar (String varName)
	Get the value of the defined parameter in the expression. More...

void	setExprStringVar (String varName, String varValue)
	Set the value of the defined parameter in the expression. More...

String	getExprStringVar (String varName)
	Get the value of the defined parameter in the expression. More...

void	setExprObjectVar (String varName, Object varValue)
	Set the value of the defined parameter in the expression. More...

Object	getExprObjectVar (String varName)
	Get the value of the defined parameter in the expression. More...

void	clearExprVar (String varName)
	Clear the value of the defined parameter in the expression and set it to the default value of 0. More...

void	clearExprVarCtx ()
	Clear all parameter values defined in the expression and set them to the default value of 0. 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...

void	setTemplateAttachment (String key, String value)
	Adds additional template data to the NvsObject object to identify the NvsObject template object. More...

Object	getAttachment (String key)
	Gets an attachment to NvsObject. More...

String	getTemplateAttachment (String key)
	Gets an template attachment to NvsObject. More...

Static Public Attributes
Timeline video effect type.

static final int	TIMELINE_VIDEOFX_TYPE_BUILTIN = 0
	内建视频特效类型 More...

static final int	TIMELINE_VIDEOFX_TYPE_PACKAGE = 1
	包裹视频特效类型 More...

static final int	TIMELINE_VIDEOFX_TYPE_CUSTOM = 2

Static Public Attributes inherited from com.meicam.sdk.NvsFx
static final int	KEY_FRAME_FIND_MODE_INPUT_TIME_BEFORE = 1
	find key frame before current time More...

static final int	KEY_FRAME_FIND_MODE_INPUT_TIME_AFTER = 2

static final int	REGION_COORDINATE_SYSTEM_TYPE_NDC = 0
	NDC coordinate system. More...

static final int	REGION_COORDINATE_SYSTEM_TYPE_TIMELINE = 1

static final int	FACE_WARP_EFFECT_STRATEGY_CUSTOM = 0x7FFFFFFF

Static Public Attributes inherited from com.meicam.sdk.NvsObject
static final String	TEMPLATE_KEY_REPLACE_ID = "MSTemplate-ReplaceId"

static final String	TEMPLATE_KEY_FOOTAGE_CAN_REPLACE = "MSTemplate-FootageCanReplace"

static final String	TEMPLATE_KEY_FOOTAGE_ID = "MSTemplate-FootageId"

static final String	TEMPLATE_KEY_FOOTAGE_NAME = "MSTemplate-FootageName"

static final String	TEMPLATE_KEY_FOOTAGE_M3U8_NAME = "MSTemplate-FootageM3U8Name"

static final String	TEMPLATE_KEY_FOOTAGE_TAGS = "MSTemplate-FootageTags"

static final String	TEMPLATE_KEY_FOOTAGE_TYPE = "MSTemplate-FootageType"

static final String	TEMPLATE_KEY_FOOTAGE_NEED_REVERSE = "MSTemplate-FootageNeedReverse"

static final String	TEMPLATE_KEY_CLIP_RAW_WIDTH = "MSTemplate-ClipRawWidth"

static final String	TEMPLATE_KEY_CLIP_RAW_HEIGHT = "MSTemplate-ClipRawHeight"

static final String	TEMPLATE_KEY_VOLUME_TYPE = "MSTemplate-VolumeType"

static final String	TEMPLATE_KEY_FX_GROUP = "MSTemplate-FxGroup"

static final String	TEMPLATE_KEY_BEST_SEEK_TIME = "MSTemplate-BestSeekTime"

static final String	TEMPLATE_KEY_MASK_TYPE = "MSTemplate-MaskType"

static final String	TEMPLATE_VALUE_MASK_TYPE_LINE = "MSTemplate-MaskType-Line"

static final String	TEMPLATE_VALUE_MASK_TYPE_MIRROR = "MSTemplate-MaskType-Mirror"

static final String	TEMPLATE_VALUE_MASK_TYPE_CIRCLE = "MSTemplate-MaskType-Circle"

static final String	TEMPLATE_VALUE_MASK_TYPE_RECT = "MSTemplate-MaskType-Rect"

static final String	TEMPLATE_VALUE_MASK_TYPE_HEART = "MSTemplate-MaskType-Heart"

static final String	TEMPLATE_VALUE_MASK_TYPE_STAR = "MSTemplate-MaskType-Star"

static final String	TEMPLATE_KEY_TRANS_TYPE_CUT = "MSTemplate-TransType-Cut"

static final String	TEMPLATE_KEY_CURVE_SPEED_TYPE = "MSTemplate-CurveSpeedType"

static final String	TEMPLATE_VALUE_CURVE_SPEED_TYPE_CUSTOM = "MSTemplate-CurveSpeedType-Custom"

static final String	TEMPLATE_VALUE_CURVE_SPEED_TYPE_MONTAGE = "MSTemplate-CurveSpeedType-Montage"

static final String	TEMPLATE_VALUE_CURVE_SPEED_TYPE_HERO = "MSTemplate-CurveSpeedType-Hero"

static final String	TEMPLATE_VALUE_CURVE_SPEED_TYPE_BULLET = "MSTemplate-CurveSpeedType-bullet"

static final String	TEMPLATE_VALUE_CURVE_SPEED_TYPE_PLUS = "MSTemplate-CurveSpeedType-Plus"

static final String	TEMPLATE_VALUE_CURVE_SPEED_TYPE_IN = "MSTemplate-CurveSpeedType-In"

static final String	TEMPLATE_VALUE_CURVE_SPEED_TYPE_OUT = "MSTemplate-CurveSpeedType-Out"

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 Timeline Video Effect is a video effect applied to a Timeline instance. Timeline video effects are divided into three types: built-in effects, packaged effects and custom effects. Built-in effects are integrated into the SDK and can be used without authorization. Packaged effects are the integration of effect resources into effect packages. Each effect package has its own license file and must be installed before it can be used. For details, please refer to Installation of effect package. Custom effects are effects that the user writes code to implement. Timeline video effect contains in-point and out-point, by which we can specify the position and duration of the effect on the timeline. The in-point must be smaller than the out-point, and they are both in microseconds.

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

Member Function Documentation

◆ changeInPoint()

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

inline

Change the in-point of the timeline video effect on the timeline. When the new in-point does not conform to the established rules, the final return in-point may be different from the new in-point value. Such as the new in-point is less than 0, the new in-point value is greater than the timeline duration, or the new in-point is greater than the out-point.

Parameters

newInPoint The new in-point of the video effect 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

◆ changeOutPoint()

long com.meicam.sdk.NvsTimelineVideoFx.changeOutPoint ( long newOutPoint )

inline

Change the out-point of the timeline video effect on the timeline. When the new out-point does not conform to the established rules, the final return out-point may be different from the new out-point value. Such as the new out-point is less than 0, the new out-point value is greater than the timeline duration, or the new out-point is less than the in-point.

Parameters

newOutPoint The 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

◆ getBuiltinTimelineVideoFxName()

String com.meicam.sdk.NvsTimelineVideoFx.getBuiltinTimelineVideoFxName ( )

inline

Gets the built-in timeline video effect name.

Returns: Returns the name of the built-in timeline video effect. It will return null when it is not a built-in effect.

Since: 1.7.0

◆ getInPoint()

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

◆ getOutPoint()

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

◆ getTimelineVideoFxPackageId()

String com.meicam.sdk.NvsTimelineVideoFx.getTimelineVideoFxPackageId ( )

inline

Gets timeline video effect resource package ID.

Returns: Returns the timeline video effect resource package ID. It will return null when it is not a packaged effect.

Since: 1.7.0

◆ getTimelineVideoFxType()

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

◆ getZValue()

float com.meicam.sdk.NvsTimelineVideoFx.getZValue ( )

inline

Get video effect Z value.

Returns: Return video effect Z value.

Since: 2.17.0

◆ mapPointFromCanonicalToParticleSystem()

PointF com.meicam.sdk.NvsTimelineVideoFx.mapPointFromCanonicalToParticleSystem ( PointF ptCononical )

inline

Convert timeline coordinates to particle system coordinates.

Parameters

ptCononical Timeline coordinates.

Returns: Return the transformed particle system coordinates, PointF object.

Since: 1.16.0

◆ movePosition()

void com.meicam.sdk.NvsTimelineVideoFx.movePosition ( long offset )

inline

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

Parameters

offset Offset 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

◆ setZValue()

void com.meicam.sdk.NvsTimelineVideoFx.setZValue ( float value )

inline

Set video effect Z value. The Z value determines the rendering order of the effects. The higher the Z value, the higher the effect is.

Parameters

value Z value

Since: 2.17.0

Member Data Documentation

◆ TIMELINE_VIDEOFX_TYPE_BUILTIN

final int com.meicam.sdk.NvsTimelineVideoFx.TIMELINE_VIDEOFX_TYPE_BUILTIN = 0

static

内建视频特效类型

◆ TIMELINE_VIDEOFX_TYPE_CUSTOM

final int com.meicam.sdk.NvsTimelineVideoFx.TIMELINE_VIDEOFX_TYPE_CUSTOM = 2

static

自定义视频特效类型

◆ TIMELINE_VIDEOFX_TYPE_PACKAGE

final int com.meicam.sdk.NvsTimelineVideoFx.TIMELINE_VIDEOFX_TYPE_PACKAGE = 1

static

包裹视频特效类型

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

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

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ changeInPoint()

◆ changeOutPoint()

◆ getBuiltinTimelineVideoFxName()

◆ getInPoint()

◆ getOutPoint()

◆ getTimelineVideoFxPackageId()

◆ getTimelineVideoFxType()

◆ getZValue()

◆ mapPointFromCanonicalToParticleSystem()

◆ movePosition()

◆ setZValue()

Member Data Documentation

◆ TIMELINE_VIDEOFX_TYPE_BUILTIN

◆ TIMELINE_VIDEOFX_TYPE_CUSTOM

◆ TIMELINE_VIDEOFX_TYPE_PACKAGE