MeiCam SDK For Web
3.12.1
|
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...
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... | |
![]() | |
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... | |
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.
|
inline |
Clear the value of the defined parameter in the expression and set it to the default value of 0.
|
inline |
Clear all parameter values defined in the expression and set them to the default value of 0.
|
inline |
Get key frame at a specified time point.
{String} | fxParam The type of custom data parameter for the effect. |
{Number} | time Time point (In microseconds). |
{Number} | flags Flag of finding mode |
|
inline |
Get the arbitrary value of fx.
{String} | fxParam Name of the fx parameter |
|
inline |
Get arbitrary value of fx at time.
{String} | fxParam Name of the fx parameter |
{Number} | time The time. |
|
inline |
Get the manipulate of ARScene.
|
inline |
Get the boolean parameter of NvsFx.Return the boolean value.
{String} | fxParam The type of the NvsFx's boolean parameter. |
|
inline |
|
inline |
|
inline |
|
inline |
Get description of Fx.Return the NvsFxDescription object.
|
inline |
Get the object(e.g. color) value of the defined parameter in the expression.
{String} | varName The parameters defined in the expression |
|
inline |
Get the value of the defined parameter in the expression.
{String} | varName The parameters defined in the expression |
|
inline |
Get the intensity of the filter.
|
inline |
get float value
{String} | fxParam name of parameter |
|
inline |
|
inline |
Get whether the regional filter ignores background.
|
inline |
Get key frame at a specified time point.
{String} | fxParam The type of custom data parameter for the effect. |
{Number} | time The time |
|
inline |
Get the integer parameter of NvsFx.Return the integer value.
{String} | fxParam The type of the NvsFx's integer parameter. |
|
inline |
|
inline |
Get whether the regional filter inverses region.
|
inline |
|
inline |
|
inline |
Get key frame at a specified time point.
{String} | fxParam The type of custom data parameter for the effect. |
{Number} | time The time |
|
inline |
Get key frame parameters.
{String} | fxParam The type of custom data parameter for the effect. |
|
inline |
Get the particle effect context object.
|
inline |
Get whether the filter is regional.
|
inline |
Get the feather width of the regional filter.
|
inline |
Get the mask region informations of the regional filter.
|
inline |
Get the mask region informations of the regional filter at a specified time.
{Number} | time The time. |
|
inline |
Get the string parameter of NvsFx.Return the string value.
{String} | fxParam The type of the NvsFx's string parameter. |
|
inline |
|
inline |
Check whether the parameter has key frame list or not.
{String} | fxParam The type of custom data parameter for the effect. |
|
inline |
remove Remove all key frames from key frame list.
{String} | fxParam The type of custom data parameter for the effect. |
|
inline |
remove Remove key frame at a specified time point from key frame list.
{String} | fxParam The type of custom data parameter for the effect. |
{Number} | time time point (In microseconds). |
|
inline |
Set arbitrary value of fx.
{String} | fxParam Name of the fx parameter |
{NvsRegionInfo} | val Only support the value of NvsRegionInfo type now |
|
inline |
Set arbitrary value of fx at time.
{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 特效参数名称 |
设置特效某时间点不定类型的值
|
inline |
|
inline |
Set the NvsFx’s boolean parameter at a specified time point.
{String} | fxParam The type of the NvsFx's boolean parameter. |
{Boolean} | val boolean value. |
{Number} | time time point (In microseconds). |
|
inline |
|
inline |
|
inline |
set ellipse region
{NvsPointF} | center center point |
{Number} | a Long semiaxis of ellipse |
{Number} | b short semiaxis of ellipse |
{Number} | angle angle |
|
inline |
set ellipse region at certain time
{NvsPointF} | center center point |
{Number} | a Long semiaxis of ellipse |
{Number} | b short semiaxis of ellipse |
{Number} | angle angle |
{Number} | time time |
|
inline |
Set the object(e.g. color) value of the defined parameter in the expression.
{String} | varName The parameters defined in the expression |
{Number} | varValue The value of a parameter in the expression |
|
inline |
Set the value of the defined parameter in the expression.
{String} | varName The parameters defined in the expression |
{Number} | varValue The value of a parameter in the expression |
|
inline |
Set the intensity of the filter.
{Number} | intensity The filter intensity value, the value range is generally [0,1]. 0 means no effect, while 1 indicates the default effect. |
|
inline |
set float value
{String} | fxParam name of parameter |
{Number} | val value |
|
inline |
Set the NvsFx's float parameter at a specified time point.
{String} | fxParam name of parameter |
{Number} | val value |
{Number} | time time |
|
inline |
Set whether the regional filter ignores background.
{Boolean} | isIgnoreBackground Whether the regional filter ignores background. True means ignored, false means the opposite. |
|
inline |
Set the integer parameter of NvsFx.The type of the NvsFx's integer parameter.
{String} | fxParam name of parameter |
{Number} | val value |
|
inline |
|
inline |
Set whether the regional filter inverses region.
{Boolean} | isInverseRegion Whether the regional filter inverses region. True means inversed, false means the opposite. |
|
inline |
|
inline |
Set the NvsFx's menu parameter at a specified time point.
{String} | fxParam name of parameter |
{String} | val value |
{Number} | time time |
|
inline |
Set key frame at a specified time point.
{String} | fxParam The type of custom data parameter for the effect. |
{Number} | time The time |
{NvsVectorVal} | keyframe |
|
inline |
Set key frame parameters.
{String} | fxParam The type of custom data parameter for the effect. |
{NvsVectorVal} | keyframes |
|
inline |
Set the region of this regional filter.
{Number[]} | region The effective region of this filter. It is composed with a series of points, which are in NDC coordinate system. |
|
inline |
Set whether the filter is regional.
{Boolean} | isRegional Whether the filter is regional. True means regional, false means the opposite. |
|
inline |
Set the feather width of the regional filter.
{Number} | featherWidth feather width of the regional filter |
|
inline |
set region at certain time
{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). |
|
inline |
Set region infos of fx.
{NvsVectorVal<NvsRegionInfo>} | regionInfos The vector of NvsRegionInfo object |
|
inline |
Set region infos of fx at time.
{NvsVectorVal<NvsRegionInfo>} | regionInfos The vector of NvsRegionInfo object |
{Number} | time The time. |
|
inline |
|
inline |