Track videoFx. More...

Inheritance diagram for NvsTrackVideoFx:

Public Member Functions
	constructor ()

	getTrackVideoFxType ()
	Gets track video effect type. More...

	getBuiltinTrackVideoFxName ()
	Gets the embedded track video effect name. More...

	getTrackVideoFxPackageId ()
	Gets track video effect resource package ID. More...

	getInPoint ()
	Track video effect in-point on the track. More...

	getOutPoint ()
	Track video effect out-point on the track. More...

	changeInPoint (newInPoint)
	Changes the in-point of the track video effect on the track. More...

	changeOutPoint (newOutPoint)
	Changes the out-point of the track video effect on the track. More...

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

	setZValue (value)
	Sets track filter Z value. More...

	getZValue ()
	Gets track filter Z value. More...

	mapPointFromCanonicalToParticleSystem (ptCanonical)
	Converts track coordinates to particle system coordinates. More...

Public Member Functions inherited from NvsFx
	constructor ()
	NvsFx constructor.

	getDescription ()
	Get description of Fx.Return the NvsFxDescription object. More...

	setIntVal (fxParam, val)
	Set the integer parameter of NvsFx.The type of the NvsFx's integer parameter. More...

	getIntVal (fxParam)
	Get the integer parameter of NvsFx.Return the integer value. More...

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

	getIntValAtTime (fxParam, time)
	Get the NvsFx's integer parameter at a specified time point.Return the integer value. More...

	setFloatVal (fxParam, val)
	set float value More...

	getFloatVal (fxParam)
	get float value More...

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

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

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

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

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

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

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

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

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

	getMenuValAtTime (fxParam, time)
	Get the NvsFx menu parameter at a specified time point.Return the menu value of NvsFx. More...

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

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

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

	getStringValAtTime (fxParam, time)
	Get the NvsFx's string parameter at a specified time point.Return the string value. More...

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

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

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

	getColorValAtTime (fxParam, time)
	get color value at certain time More...

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

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

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

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

	setParamKeyframes (fxParam, keyframes)
	Set key frame parameters. More...

	getParamKeyframes (fxParam)
	Get key frame parameters. More...

	setParamKeyframeAtTime (fxParam, time, keyframe)
	Set key frame at a specified time point. More...

	getParamKeyframeAtTime (fxParam, time)
	Get key frame at a specified time point. More...

	getIntpFxParamValsAtTime (fxParam, time)
	Get key frame at a specified time point. More...

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

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

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

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

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

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

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

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

	setRegion (region)
	Set the region of this regional filter. More...

	setRegionAtTime (region, time)
	set region at certain time More...

	setEllipseRegion (center, a, b, angle)
	set ellipse region More...

	setEllipseRegionAtTime (center, a, b, angle, time)
	set ellipse region at certain time More...

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

	getRegionInfosAtTime (time)
	Get the mask region informations of the regional filter at a specified time. More...

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

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

	getParticleSystemContext ()
	Get the particle effect context object. More...

	getARSceneManipulate ()
	Get the manipulate of ARScene. More...

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

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

	setExprObjectVar (varName, varValue)
	Set the object(e.g. color) value of the defined parameter in the expression. More...

	getExprObjectVar (varName)
	Get the object(e.g. color) value of the defined parameter in the expression. More...

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

	clearExprVarCtx ()
	Clear all parameter values defined in the expression and set them to the default value of 0. More...

	setArbitraryVal (fxParam, val)
	Set arbitrary value of fx. More...

	getArbitraryVal (fxParam)
	Get the arbitrary value of fx. More...

	setArbitraryValAtTime (fxParam, val, time)
	Set arbitrary value of fx at time. More...

	getArbitraryValAtTime (fxParam, time)
	Get arbitrary value of fx at time. More...

	setRegionInfos (regionInfos)
	Set region infos of fx. More...

	setRegionInfosAtTime (regionInfos, time)
	Set region infos of fx at time. More...

Public Member Functions inherited from NvsProjObj
	constructor ()

	setInternalObject (obj)
	set internal object More...

	getInternalObject ()
	get internal object More...

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

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

Detailed Description

Track videoFx.

Member Function Documentation

◆ changeInPoint()

NvsTrackVideoFx::changeInPoint ( newInPoint )

inline

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

Parameters

{Number} newInPoint The new in-point of the animated sticker on the track (in microseconds).

Returns: {Number} Returns the final in-point value of the track video effect on the track (in microseconds).

◆ changeOutPoint()

NvsTrackVideoFx::changeOutPoint ( newOutPoint )

inline

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

Parameters

{Number} newOutPoint The new out-point of the animated sticker on the track (in microseconds).

Returns: {Number} Returns the final out-point value of the track video effect on the track (in microseconds).

◆ constructor()

NvsTrackVideoFx::constructor ( )

inline

@constructor

◆ getBuiltinTrackVideoFxName()

NvsTrackVideoFx::getBuiltinTrackVideoFxName ( )

inline

Gets the embedded track video effect name.

Returns: {String} Returns the name of the embedded track video effect. If it is not a built-in track video effect, it returns a null string.

◆ getInPoint()

NvsTrackVideoFx::getInPoint ( )

inline

Track video effect in-point on the track.

Returns: {Number} The in-point of the track video effect on the track (in microseconds).

◆ getOutPoint()

NvsTrackVideoFx::getOutPoint ( )

inline

Track video effect out-point on the track.

Returns: {Number} The out-point of the track video effect on the track (in microseconds).

◆ getTrackVideoFxPackageId()

NvsTrackVideoFx::getTrackVideoFxPackageId ( )

inline

Gets track video effect resource package ID.

Returns: {String} Returns the track video effect resource package ID. If it is not a resource package track video effect, it returns a null string.

◆ getTrackVideoFxType()

NvsTrackVideoFx::getTrackVideoFxType ( )

inline

Gets track video effect type.

Returns: {Number} Returns the timeline video effect type. See [Timeline Video effect Type]. (TIMELINE_VIDEOFX_TYPE).

◆ getZValue()

NvsTrackVideoFx::getZValue ( )

inline

Gets track filter Z value.

Returns: {Number} Returns track filter Z value.

◆ mapPointFromCanonicalToParticleSystem()

NvsTrackVideoFx::mapPointFromCanonicalToParticleSystem ( ptCanonical )

inline

Converts track coordinates to particle system coordinates.

Parameters

{PointF} ptCanonical The new in-point of the animated sticker on the track (in microseconds).

Returns: {Number} Returns the transformed particle system coordinates, PointF object.

◆ movePosition()

NvsTrackVideoFx::movePosition ( offset )

inline

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

Parameters

{Number} offset Offset value for in and out points (in microseconds).

◆ setZValue()

NvsTrackVideoFx::setZValue ( value )

inline

Sets track filter Z value.

Parameters

{Number} value Sets track filter Z value.

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

src/js/NvStreamingSdk.js

Public Member Functions

Detailed Description

Member Function Documentation

◆ changeInPoint()

◆ changeOutPoint()

◆ constructor()

◆ getBuiltinTrackVideoFxName()

◆ getInPoint()

◆ getOutPoint()

◆ getTrackVideoFxPackageId()

◆ getTrackVideoFxType()

◆ getZValue()

◆ mapPointFromCanonicalToParticleSystem()

◆ movePosition()

◆ setZValue()