NvsTimelineVideoFx Class Reference

Timeline video effects timeline video effects are video effects that act on timeline instances. Timeline video effects are divided into three types: built-in effects, package effects and custom effects. The built-in special effects are integrated inside the SDK and can be used directly without authorization. Package special effect is to integrate special effect resources into special effect packages. Each special effect package has its one-to-one corresponding authorization file, and must be installed before use. For details, please refer to material package installation. Custom special effect is a special effect timeline realized by users through writing code. The video special effect package includes special effect entry and exit points. Through entry and exit points, we can specify the position and length of the special effect on the timeline, and the entry point should be less than the exit point, The unit is microseconds. Timeline video effects allow superposition, and the rendering order is controlled by the preset Z value. More...

Inheritance diagram for NvsTimelineVideoFx:

Public Member Functions
	constructor ()
	constructor
	getTimelineVideoFxType ()
	Get timeline video special effects type. More...
	getBuiltinTimelineVideoFxName ()
	Gets the built-in timeline video effect name. More...
	getTimelineVideoFxPackageId ()
	Gets timeline video effect resource package ID. More...
	getInPoint ()
	Timeline video effect in-point on the timeline. More...
	getOutPoint ()
	Timeline video effect out-point on the timeline. More...
	changeInPoint (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...
	changeOutPoint (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...
	movePosition (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...
	setZValue (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...
	getZValue ()
	Get video effect Z value. More...
	mapPointFromCanonicalToParticleSystem (ptCanonical)
	Convert timeline 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

Timeline video effects timeline video effects are video effects that act on timeline instances. Timeline video effects are divided into three types: built-in effects, package effects and custom effects. The built-in special effects are integrated inside the SDK and can be used directly without authorization. Package special effect is to integrate special effect resources into special effect packages. Each special effect package has its one-to-one corresponding authorization file, and must be installed before use. For details, please refer to material package installation. Custom special effect is a special effect timeline realized by users through writing code. The video special effect package includes special effect entry and exit points. Through entry and exit points, we can specify the position and length of the special effect on the timeline, and the entry point should be less than the exit point, The unit is microseconds. Timeline video effects allow superposition, and the rendering order is controlled by the preset Z value.

See also

NvsFx

Member Function Documentation

changeInPoint()

NvsTimelineVideoFx::changeInPoint (   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

{Number}

newInPoint The new in-point of the video effect on the timeline (in microseconds).

Returns

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

changeOutPoint()

NvsTimelineVideoFx::changeOutPoint (   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

{Number}

newOutPoint The new out-point of the animated sticker on the timeline (in microseconds).

Returns

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

getBuiltinTimelineVideoFxName()

NvsTimelineVideoFx::getBuiltinTimelineVideoFxName ( )

inline

Gets the built-in timeline video effect name.

Returns

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

getInPoint()

NvsTimelineVideoFx::getInPoint ( )

inline

Timeline video effect in-point on the timeline.

Returns

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

getOutPoint()

NvsTimelineVideoFx::getOutPoint ( )

inline

Timeline video effect out-point on the timeline.

Returns

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

getTimelineVideoFxPackageId()

NvsTimelineVideoFx::getTimelineVideoFxPackageId ( )

inline

Gets timeline video effect resource package ID.

Returns

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

getTimelineVideoFxType()

NvsTimelineVideoFx::getTimelineVideoFxType ( )

inline

Get timeline video special effects type.

Returns

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

getZValue()

NvsTimelineVideoFx::getZValue ( )

inline

Get video effect Z value.

Returns

{Number} Return video effect Z value.

mapPointFromCanonicalToParticleSystem()

NvsTimelineVideoFx::mapPointFromCanonicalToParticleSystem (   ptCanonical )

inline

Convert timeline coordinates to particle system coordinates.

Parameters

{PointF}

ptCanonical Timeline coordinates.

Returns

{PointF} Return the transformed particle system coordinates, PointF object.

movePosition()

NvsTimelineVideoFx::movePosition (   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

{Number}

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

Returns

{void}

setZValue()

NvsTimelineVideoFx::setZValue (   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

{Number}

value Z value

Returns

{void}

---

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

• src/js/NvStreamingSdk.js