NvsTimelineCompoundCaption Class Reference

Timeline compound caption. More...

Inheritance diagram for NvsTimelineCompoundCaption:

Public Member Functions
	constructor ()
	getInPoint ()
	Get the in-point of the caption on the timeline. More...
	getOutPoint ()
	The out-point of the caption on the timeline. More...
	changeInPoint (newInPoint)
	Changes the in-point of the caption on the timeline. More...
	changeOutPoint (newOutPoint)
	Changes the out-point of the caption on the timeline. More...
	movePosition (offset)
	Changes the display position of the caption on the timeline (the in and out points are offset from the offset value at the same time). More...
Public Member Functions inherited from NvsCompoundCaption
	constructor ()
	getCaptionCount ()
	Get number of sub-cpations in this compound caption. More...
	setText (captionIndex, text)
	Set sub-caption text with index. More...
	getText (captionIndex)
	Get sub-caption text with index. More...
	setTextColor (captionIndex, color)
	Set sub-caption color with index. More...
	getTextColor (captionIndex)
	Get sub-caption color with index. More...
	setFontFamily (captionIndex, family)
	Set sub-caption font family with index. More...
	getFontFamily (captionIndex)
	Get sub-caption font family with index. More...
	setCaptionTranslation (translation)
	Set the amount of caption translation. More...
	getCaptionTranslation ()
	Get the amount of caption translation. More...
	translateCaption (translationOffset)
	Translate caption. More...
	setAnchorPoint (anchor)
	Set caption anchor. More...
	getAnchorPoint ()
	Get caption anchor. More...
	setScaleX (scale)
	Set horizontal scaling factor for caption. More...
	getScaleX ()
	Get horizontal scaling factor for caption. More...
	setScaleY (scale)
	Set vertical scaling factor for captions. More...
	getScaleY ()
	Get vertical scaling factor for captions. More...
	scaleCaption (scaleFactor, anchor)
	Scale caption. More...
	setRotationZ (angle)
	Set the rotation angle for the caption. More...
	getRotationZ ()
	Get the rotation angle for the caption. More...
	rotateCaption (angle, anchor)
	Rotate caption. More...
	rotateCaption2 (angle)
	Rotate catpion on center. More...
	getCaptionBoundingVertices (captionIndex, boudingType, motionParams)
	Get the transformed vertices position of the original caption bounding. More...
	getCompoundBoundingVertices (boudingType, motionParams)
	Get the transformed vertices position of the original compound caption bounding. More...
	setZValue (value)
	Set caption Z value. More...
	getZValue ()
	Get caption Z value. More...
	setOpacity (value)
	Set caption opacity. More...
	getOpacity ()
	Get caption opacity. More...
	isFrameCaption (captionIndex)
	Determine if it is a border caption. More...
	getCaptionStylePackageId ()
	Get the caption style package ID. 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 compound caption.

Member Function Documentation

changeInPoint()

NvsTimelineCompoundCaption::changeInPoint (   newInPoint )

inline

Changes the in-point of the caption on the timeline.

Parameters

{Number}

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

Returns

{Number} Returns the in-point of the caption on the timeline (in microseconds).

changeOutPoint()

NvsTimelineCompoundCaption::changeOutPoint (   newOutPoint )

inline

Changes the out-point of the caption on the timeline.

Parameters

{Number}

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

Returns

{Number} Returns the out-point of the caption on the timeline (in microseconds).

getInPoint()

NvsTimelineCompoundCaption::getInPoint ( )

inline

Get the in-point of the caption on the timeline.

Returns

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

getOutPoint()

NvsTimelineCompoundCaption::getOutPoint ( )

inline

The out-point of the caption on the timeline.

Returns

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

movePosition()

NvsTimelineCompoundCaption::movePosition (   offset )

inline

Changes the display position of the caption on the timeline (the in and out points are offset from the offset value at the same time).

Parameters

{Number}

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

Returns

{void}

---

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

• src/js/NvStreamingSdk.js