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

Special effects. Special effects are the base classes of different types of special effects such as video FX, audio FX, audio transition and video transition. In the SDK framework, special effects are a key part. Each different type of special effects derived from nvsfx can be added, removed and obtained through clip instances, timeline instances or track instances. At the same time, different API interfaces are provided in the special effect class to set and obtain the special effect parameter types. More...

Inheritance diagram for NvsFx:
NvsProjObj NvsAnimatedSticker NvsAudioFx NvsAudioTransition NvsCaption NvsCompoundCaption NvsTimelineVideoFx NvsTrackVideoFx NvsVideoFx NvsVideoTransition

Public Member Functions

 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

Special effects. Special effects are the base classes of different types of special effects such as video FX, audio FX, audio transition and video transition. In the SDK framework, special effects are a key part. Each different type of special effects derived from nvsfx can be added, removed and obtained through clip instances, timeline instances or track instances. At the same time, different API interfaces are provided in the special effect class to set and obtain the special effect parameter types.

See also
NvsProjObj

Member Function Documentation

◆ clearExprVar()

NvsFx::clearExprVar ( )
inline

Clear the value of the defined parameter in the expression and set it to the default value of 0.

Returns
{}

◆ clearExprVarCtx()

NvsFx::clearExprVarCtx ( )
inline

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

Returns
{}

◆ findKeyframeTime()

NvsFx::findKeyframeTime (   fxParam,
  time,
  flags 
)
inline

Get key frame at a specified time point.

Parameters
{String}fxParam The type of custom data parameter for the effect.
{Number}time Time point (In microseconds).
{Number}flags Flag of finding mode
Returns
{Number} Return key frame time point near the specified time point, If there is no key frame near this time point, return - 1

◆ getArbitraryVal()

NvsFx::getArbitraryVal (   fxParam)
inline

Get the arbitrary value of fx.

Parameters
{String}fxParam Name of the fx parameter
Returns
{NvsRegionInfo} The NvsRegionInfo value
See also
NvsRegionInfo

◆ getArbitraryValAtTime()

NvsFx::getArbitraryValAtTime (   fxParam,
  time 
)
inline

Get arbitrary value of fx at time.

Parameters
{String}fxParam Name of the fx parameter
{Number}time The time.
Returns
{NvsRegionInfo} The NvsRegionInfo value
See also
NvsRegionInfo

◆ getARSceneManipulate()

NvsFx::getARSceneManipulate ( )
inline

Get the manipulate of ARScene.

Returns
{NvsARSceneManipulate} Return the manipulate of ARScene.

◆ getBooleanVal()

NvsFx::getBooleanVal (   fxParam)
inline

Get the boolean parameter of NvsFx.Return the boolean value.

Parameters
{String}fxParam The type of the NvsFx's boolean parameter.
Returns
{Boolean} Return the BOOL value.

◆ getBooleanValAtTime()

NvsFx::getBooleanValAtTime (   fxParam,
  time 
)
inline

Get the NvsFx's boolean parameter at a specified time point.

Parameters
{String}fxParam The type of the NvsFx's boolean parameter.
{Number}time time point (In microseconds).
Returns
{Boolean} Return the BOOL value.

◆ getColorVal()

NvsFx::getColorVal (   fxParam)
inline

Get the color parameter of NvsFx.

Parameters
{String}fxParam The type of the NvsFx's color parameter.
Returns
{NvsColor} Return the customized color object[NvsColor].
See also
NvsColor

◆ getColorValAtTime()

NvsFx::getColorValAtTime (   fxParam,
  time 
)
inline

get color value at certain time

Parameters
{String}fxParam Get the NvsFx's color parameter at a specified time point.
{Number}time point time (In microseconds).
Returns
{NvsColor} Return the customized color object[NvsColor].

◆ getDescription()

NvsFx::getDescription ( )
inline

Get description of Fx.Return the NvsFxDescription object.

Returns
{NvsFxDescription}
See also
NvsFxDescription

◆ getExprObjectVar()

NvsFx::getExprObjectVar (   varName)
inline

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

Parameters
{String}varName The parameters defined in the expression
Returns
{Number} Returns the value of the parameter defined in the expression

◆ getExprVar()

NvsFx::getExprVar (   varName)
inline

Get the value of the defined parameter in the expression.

Parameters
{String}varName The parameters defined in the expression
Returns
{Number} Returns the value of the parameter defined in the expression

◆ getFilterIntensity()

NvsFx::getFilterIntensity ( )
inline

Get the intensity of the filter.

Returns
{Number} Returns the intensity value of the filter.

◆ getFloatVal()

NvsFx::getFloatVal (   fxParam)
inline

get float value

Parameters
{String}fxParam name of parameter
Returns
{Number} Return the double value.

◆ getFloatValAtTime()

NvsFx::getFloatValAtTime (   fxParam,
  time 
)
inline

Get the NvsFx's float parameter at a specified time point.Return the double value.

Parameters
{String}fxParam The type of the NvsFx's float parameter.
{Number}time time point (In microseconds).
Returns
{Number} Return the double value.

◆ getIgnoreBackground()

NvsFx::getIgnoreBackground ( )
inline

Get whether the regional filter ignores background.

Returns
{Boolean} Return whether the regional filter ignores background or not.

◆ getIntpFxParamValsAtTime()

NvsFx::getIntpFxParamValsAtTime (   fxParam,
  time 
)
inline

Get key frame at a specified time point.

Parameters
{String}fxParam The type of custom data parameter for the effect.
{Number}time The time
Returns
{NvsVectorVal}
See also
NvsVectorVal

◆ getIntVal()

NvsFx::getIntVal (   fxParam)
inline

Get the integer parameter of NvsFx.Return the integer value.

Parameters
{String}fxParam The type of the NvsFx's integer parameter.
Returns
{Number} Return the integer value.

◆ getIntValAtTime()

NvsFx::getIntValAtTime (   fxParam,
  time 
)
inline

Get the NvsFx's integer parameter at a specified time point.Return the integer value.

Parameters
{String}fxParam The type of the NvsFx's integer parameter.
{Number}time time point (In microseconds).
Returns
{Number} Return the integer value.

◆ getInverseRegion()

NvsFx::getInverseRegion ( )
inline

Get whether the regional filter inverses region.

Returns
{Boolean} Return whether the regional filter inverses region or not.

◆ getMenuVal()

NvsFx::getMenuVal (   fxParam)
inline

Get the menu parameter of NvsFx.Return the menu value of NvsFx.

Parameters
{String}fxParam The type of the NvsFx's menu parameter.
Returns
{String} Return the menu value of NvsFx.

◆ getMenuValAtTime()

NvsFx::getMenuValAtTime (   fxParam,
  time 
)
inline

Get the NvsFx menu parameter at a specified time point.Return the menu value of NvsFx.

Parameters
{String}fxParam The type of the NvsFx's menu parameter.
{Number}time time point (In microseconds).
Returns
{String} Return the menu value of NvsFx.

◆ getParamKeyframeAtTime()

NvsFx::getParamKeyframeAtTime (   fxParam,
  time 
)
inline

Get key frame at a specified time point.

Parameters
{String}fxParam The type of custom data parameter for the effect.
{Number}time The time
Returns
{void}

◆ getParamKeyframes()

NvsFx::getParamKeyframes (   fxParam)
inline

Get key frame parameters.

Parameters
{String}fxParam The type of custom data parameter for the effect.
Returns
{NvsVectorVal}
See also
NvsVectorVal

◆ getParticleSystemContext()

NvsFx::getParticleSystemContext ( )
inline

Get the particle effect context object.

Returns
{NvsParticleSystemContext} Return a particle effect context object.

◆ getRegional()

NvsFx::getRegional ( )
inline

Get whether the filter is regional.

Returns
{Boolean} Return whether the filter is regional or not.

◆ getRegionalFeatherWidth()

NvsFx::getRegionalFeatherWidth ( )
inline

Get the feather width of the regional filter.

Returns
{Number} Return the feather width of the regional filter.

◆ getRegionInfos()

NvsFx::getRegionInfos ( )
inline

Get the mask region informations of the regional filter.

Returns
{NvsVectorVal<NvsRegionInfo>} Return a vector of the filter's region information. The region information object could be series of points or ellipse, which are in NDC coordinate system.
See also
NvsRegionInfo

◆ getRegionInfosAtTime()

NvsFx::getRegionInfosAtTime (   time)
inline

Get the mask region informations of the regional filter at a specified time.

Parameters
{Number}time The time.
Returns
{NvsVectorVal<NvsRegionInfo>} Return a vector of the filter's region information. The region information object could be series of points or ellipse, which are in NDC coordinate system.

◆ getStringVal()

NvsFx::getStringVal (   fxParam)
inline

Get the string parameter of NvsFx.Return the string value.

Parameters
{String}fxParam The type of the NvsFx's string parameter.
Returns
{String} Return the string value.

◆ getStringValAtTime()

NvsFx::getStringValAtTime (   fxParam,
  time 
)
inline

Get the NvsFx's string parameter at a specified time point.Return the string value.

Parameters
{String}fxParam The type of the NvsFx's string parameter.
{Number}time time point (In microseconds).
Returns
{String} Return the string value.

◆ hasKeyframeList()

NvsFx::hasKeyframeList (   fxParam)
inline

Check whether the parameter has key frame list or not.

Parameters
{String}fxParam The type of custom data parameter for the effect.
Returns
{Boolean} Return exist or not.

◆ removeAllKeyframe()

NvsFx::removeAllKeyframe (   fxParam)
inline

remove Remove all key frames from key frame list.

Parameters
{String}fxParam The type of custom data parameter for the effect.
Returns
{Boolean} Return success or not.

◆ removeKeyframeAtTime()

NvsFx::removeKeyframeAtTime (   fxParam,
  time 
)
inline

remove Remove key frame at a specified time point from key frame list.

Parameters
{String}fxParam The type of custom data parameter for the effect.
{Number}time time point (In microseconds).
Returns
{Boolean} Return success or not.

◆ setArbitraryVal()

NvsFx::setArbitraryVal (   fxParam,
  val 
)
inline

Set arbitrary value of fx.

Parameters
{String}fxParam Name of the fx parameter
{NvsRegionInfo}val Only support the value of NvsRegionInfo type now
See also
NvsRegionInfo

◆ setArbitraryValAtTime()

NvsFx::setArbitraryValAtTime (   fxParam,
  val,
  time 
)
inline

Set arbitrary value of fx at time.

Parameters
{Number}time The time
{Number}time 时间点
{NvsRegionInfo}val Only support the value of NvsRegionInfo type now
{NvsRegionInfo}val 目前只支持NvsRegionInfo类型的值
{String}fxParam Name of the effect parameter
{String}fxParam 特效参数名称
See also
NvsRegionInfo
NvsRegionInfo

设置特效某时间点不定类型的值

◆ setBooleanVal()

NvsFx::setBooleanVal (   fxParam,
  val 
)
inline

Set the boolean parameter of NvsFx.

Parameters
{String}fxParam The type of the NvsFx's float parameter.
{Boolean}val boolean value.
Returns
{void}

◆ setBooleanValAtTime()

NvsFx::setBooleanValAtTime (   fxParam,
  val,
  time 
)
inline

Set the NvsFx’s boolean parameter at a specified time point.

Parameters
{String}fxParam The type of the NvsFx's boolean parameter.
{Boolean}val boolean value.
{Number}time time point (In microseconds).
Returns
{void}

◆ setColorVal()

NvsFx::setColorVal (   fxParam,
  val 
)
inline

Set the color parameter of NvsFx.

Parameters
{String}fxParam The type of the NvsFx's color parameter.
{NvsColor}val NvsColor Customized color object.
Returns
{viod}
See also
NvsColor

◆ setColorValAtTime()

NvsFx::setColorValAtTime (   fxParam,
  val,
  time 
)
inline

Set the NvsFx's color parameter at a specified time point.

Parameters
{String}fxParam The type of the NvsFx's color parameter.
{NvsColor}val Customized color object.
{Number}time point time (In microseconds).
Returns
{void}

◆ setEllipseRegion()

NvsFx::setEllipseRegion (   center,
  a,
  b,
  angle 
)
inline

set ellipse region

Parameters
{NvsPointF}center center point
{Number}a Long semiaxis of ellipse
{Number}b short semiaxis of ellipse
{Number}angle angle
Returns
{void}

◆ setEllipseRegionAtTime()

NvsFx::setEllipseRegionAtTime (   center,
  a,
  b,
  angle,
  time 
)
inline

set ellipse region at certain time

Parameters
{NvsPointF}center center point
{Number}a Long semiaxis of ellipse
{Number}b short semiaxis of ellipse
{Number}angle angle
{Number}time time
Returns
{void}

◆ setExprObjectVar()

NvsFx::setExprObjectVar (   varName,
  varValue 
)
inline

Set the object(e.g. color) value of the defined parameter in the expression.

Parameters
{String}varName The parameters defined in the expression
{Number}varValue The value of a parameter in the expression
Returns
{void}

◆ setExprVar()

NvsFx::setExprVar (   varName,
  varValue 
)
inline

Set the value of the defined parameter in the expression.

Parameters
{String}varName The parameters defined in the expression
{Number}varValue The value of a parameter in the expression
Returns
{void}

◆ setFilterIntensity()

NvsFx::setFilterIntensity (   intensity)
inline

Set the intensity of the filter.

Parameters
{Number}intensity The filter intensity value, the value range is generally [0,1]. 0 means no effect, while 1 indicates the default effect.

◆ setFloatVal()

NvsFx::setFloatVal (   fxParam,
  val 
)
inline

set float value

Parameters
{String}fxParam name of parameter
{Number}val value
Returns
{void}

◆ setFloatValAtTime()

NvsFx::setFloatValAtTime (   fxParam,
  val,
  time 
)
inline

Set the NvsFx's float parameter at a specified time point.

Parameters
{String}fxParam name of parameter
{Number}val value
{Number}time time
Returns
{void}

◆ setIgnoreBackground()

NvsFx::setIgnoreBackground (   isIgnoreBackground)
inline

Set whether the regional filter ignores background.

Parameters
{Boolean}isIgnoreBackground Whether the regional filter ignores background. True means ignored, false means the opposite.
Returns
{void}

◆ setIntVal()

NvsFx::setIntVal (   fxParam,
  val 
)
inline

Set the integer parameter of NvsFx.The type of the NvsFx's integer parameter.

Parameters
{String}fxParam name of parameter
{Number}val value
Returns
{void}

◆ setIntValAtTime()

NvsFx::setIntValAtTime (   fxParam,
  val,
  time 
)
inline

Set the NvsFx's integer parameter at a specified time point.

Parameters
{String}fxParam The type of the NvsFx's integer parameter.
{Number}val integer value.
{Number}time time point (In microseconds).
Returns
{void}

◆ setInverseRegion()

NvsFx::setInverseRegion (   isInverseRegion)
inline

Set whether the regional filter inverses region.

Parameters
{Boolean}isInverseRegion Whether the regional filter inverses region. True means inversed, false means the opposite.
Returns
{void}

◆ setMenuVal()

NvsFx::setMenuVal (   fxParam,
  val 
)
inline

Set the menu parameter of NvsFx.

Parameters
{String}fxParam The type of the NvsFx's menu parameter.
{String}val A string value.
Returns
{void}

◆ setMenuValAtTime()

NvsFx::setMenuValAtTime (   fxParam,
  val,
  time 
)
inline

Set the NvsFx's menu parameter at a specified time point.

Parameters
{String}fxParam name of parameter
{String}val value
{Number}time time
Returns
{String}

◆ setParamKeyframeAtTime()

NvsFx::setParamKeyframeAtTime (   fxParam,
  time,
  keyframe 
)
inline

Set key frame at a specified time point.

Parameters
{String}fxParam The type of custom data parameter for the effect.
{Number}time The time
{NvsVectorVal}keyframe
Returns
{Boolean} Whether the Settings are successful

◆ setParamKeyframes()

NvsFx::setParamKeyframes (   fxParam,
  keyframes 
)
inline

Set key frame parameters.

Parameters
{String}fxParam The type of custom data parameter for the effect.
{NvsVectorVal}keyframes
Returns
{Boolean}

◆ setRegion()

NvsFx::setRegion (   region)
inline

Set the region of this regional filter.

Parameters
{Number[]}region The effective region of this filter. It is composed with a series of points, which are in NDC coordinate system.
Returns
{void}

◆ setRegional()

NvsFx::setRegional (   isRegional)
inline

Set whether the filter is regional.

Parameters
{Boolean}isRegional Whether the filter is regional. True means regional, false means the opposite.
Returns
{void}

◆ setRegionalFeatherWidth()

NvsFx::setRegionalFeatherWidth (   featherWidth)
inline

Set the feather width of the regional filter.

Parameters
{Number}featherWidth feather width of the regional filter
Returns
{}

◆ setRegionAtTime()

NvsFx::setRegionAtTime (   region,
  time 
)
inline

set region at certain time

Parameters
{Number[]}region The effective region of this filter. It is composed with a series of points, which are in NDC coordinate system.
{Number}time Time point (In microseconds).
Returns
{void}

◆ setRegionInfos()

NvsFx::setRegionInfos (   regionInfos)
inline

Set region infos of fx.

Parameters
{NvsVectorVal<NvsRegionInfo>}regionInfos The vector of NvsRegionInfo object
See also
NvsRegionInfo

◆ setRegionInfosAtTime()

NvsFx::setRegionInfosAtTime (   regionInfos,
  time 
)
inline

Set region infos of fx at time.

Parameters
{NvsVectorVal<NvsRegionInfo>}regionInfos The vector of NvsRegionInfo object
{Number}time The time.
See also
NvsRegionInfo

◆ setStringVal()

NvsFx::setStringVal (   fxParam,
  val 
)
inline

Set the string parameter of NvsFx.

Parameters
{String}fxParam The type of the NvsFx's string parameter.
{String}val string value.
Returns
{void}

◆ setStringValAtTime()

NvsFx::setStringValAtTime (   fxParam,
  val,
  time 
)
inline

Set the NvsFx's string parameter at a specified time point.

Parameters
{String}fxParam The type of the NvsFx's string parameter.
{String}val string value.
{Number}time time point (In microseconds).
Returns
{void}

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