MeiCam SDK For Web  3.12.1
Public Member Functions | List of all members
NvsVideoTransition Class Reference

There are multiple clips on the track. The transition is the transition effect from one video clip to another, and no video transitions can be added between clips with gaps. Currently it supports multiple video transitions including fade, turning, swap, stretch in, page curl, lens flare, star, dip to black, dip to white,push to right, push to top, upper left into.Each video transition can be set and retrieved via video track (NvsVideoTrack). The default transition is fade. More...

Inheritance diagram for NvsVideoTransition:
NvsFx NvsProjObj

Public Member Functions

 constructor ()
 constructor
 
 getVideoTransitionType ()
 Get video transition type. More...
 
 getBuiltinVideoTransitionName ()
 Get built-in video transition name. More...
 
 getVideoTransitionPackageId ()
 Get the video transition resource package ID. More...
 
 setVideoTransitionDuration (duration, matchMode)
 Set video transition duration. More...
 
 getVideoTransitionDuration ()
 Get video transition duration. 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

There are multiple clips on the track. The transition is the transition effect from one video clip to another, and no video transitions can be added between clips with gaps. Currently it supports multiple video transitions including fade, turning, swap, stretch in, page curl, lens flare, star, dip to black, dip to white,push to right, push to top, upper left into.Each video transition can be set and retrieved via video track (NvsVideoTrack). The default transition is fade.

See also
NvsFx

Member Function Documentation

◆ getBuiltinVideoTransitionName()

NvsVideoTransition::getBuiltinVideoTransitionName ( )
inline

Get built-in video transition name.

Returns
{String} Returns the name of the built-in video transition. If it is not a built-in video transition, it will return a null string.

◆ getVideoTransitionDuration()

NvsVideoTransition::getVideoTransitionDuration ( )
inline

Get video transition duration.

Returns
{Number} Returns the video transition duration.

◆ getVideoTransitionPackageId()

NvsVideoTransition::getVideoTransitionPackageId ( )
inline

Get the video transition resource package ID.

Returns
{String} Returns the video transition resource package ID. If it is not a resource package video transition, it will return a null string.

◆ getVideoTransitionType()

NvsVideoTransition::getVideoTransitionType ( )
inline

Get video transition type.

Returns
{Number} Returns the video transition type.

◆ setVideoTransitionDuration()

NvsVideoTransition::setVideoTransitionDuration (   duration,
  matchMode 
)
inline

Set video transition duration.

Parameters
{Number}duration Video transition duration, min value 250000
{Number}matchMode Video transition duration scale mode
Returns
{void}

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