NvsTrackCaption Class Reference

Track captions. More...

Inheritance diagram for NvsTrackCaption:

Public Member Functions
	constructor ()
	getInPoint ()
	The in-point of the caption on the track (in microseconds). More...
	getOutPoint ()
	The out-point of the caption on the track. More...
	changeInPoint (newInPoint)
	Changes the in-point of the caption on the track. More...
	changeOutPoint (newOutPoint)
	Changes the out-point of the caption on the track. More...
	movePosition (offset)
	Changes the display position of the caption on the track (the in and out points are offset from the offset value at the same time). More...
Public Member Functions inherited from NvsCaption
	constructor ()
	constructor
	getRoleInTheme ()
	The role of caption in the theme. More...
	getCategory ()
	Gets the type of caption. More...
	getCaptionStylePackageId ()
	Gets the caption style package ID. More...
	getModularCaptionContextPackageId ()
	Gets the modular caption context style package ID. More...
	getModularCaptionRendererPackageId ()
	Gets the modular caption context style package ID. More...
	getModularCaptionAnimationPackageId ()
	Gets the modular caption animation style package ID. More...
	getModularCaptionInAnimationPackageId ()
	Gets the modular caption in-animation style package ID. More...
	getModularCaptionOutAnimationPackageId ()
	Gets the modular caption out-animation style package ID. More...
	applyCaptionStyle (captionStylePackageId, isUseDefaultAssetParam)
	Apply caption style. More...
	applyModularCaptionContext (captionContextPackageId)
	Applys modular caption context style. More...
	applyModularCaptionRenderer (captionRendererPackageId)
	Applys modular caption render style. More...
	applyModularCaptionAnimation (captionAnimationPackageId)
	Applys modular caption loop-animation style. More...
	applyModularCaptionInAnimation (captionInAnimationPackageId)
	Applys modular caption in-animation style. Notes：please set loop-Animation to null before you set in-animation, otherwise it will NOT works. More...
	applyModularCaptionOutAnimation (captionOutAnimationPackageId)
	Applys modular caption out-animation style.Notes：please set loop-Animation to null before you set out-animation, otherwise it will NOT works. More...
	setModularCaptionAnimationPeroid (periodInMS)
	Set modular caption Animation Peroid. More...
	getModularCaptionAnimationPeroid ()
	Get modular caption Animation Peroid. More...
	setModularCaptionInAnimationDuration (inAnimationDurationInMS)
	Set modular caption in-animation duration. More...
	getModularCaptionInAnimationDuration ()
	Get modular caption in-animation duration. More...
	setModularCaptionOutAnimationDuration (outAnimationDurationInMS)
	Set modular caption out-animation duration. More...
	getModularCaptionOutAnimationDuration ()
	Get modular caption out-animation duration. More...
	setText (text)
	Sets caption text. More...
	getText ()
	Gets caption text. More...
	setTextAlignment (textAlign)
	Set caption horizontal alignment style. More...
	getTextAlignment ()
	Get caption horizontal alignment style. More...
	setTextVerticalAlignment (textAlign)
	Set caption horizontal alignment style. More...
	getTextVerticalAlignment ()
	Gets caption vertical alignment style, valid for frame-caption only. More...
	setVerticalLayout (verticalLayout)
	Sets whether to layout text vertically. More...
	getVerticalLayout ()
	Gets whether to layout text vertically. More...
	setBold (bold)
	Set caption font bold. More...
	getBold ()
	Get the caption font bold state. More...
	setItalic (italic)
	Set caption font italic. More...
	getItalic ()
	Get caption font italic. More...
	setUnderline (underline)
	Set caption underline. More...
	getUnderline ()
	Get caption underline. More...
	setLetterSpacingType (letterSpacingType)
	Set caption word spacing type. More...
	getLetterSpacingType ()
	Get caption word spacing type. More...
	setLetterSpacing (letterSpacing)
	Set caption letter spacing. More...
	getLetterSpacing ()
	Get caption letter spacing. More...
	setLineSpacing (lineSpacing)
	Set line spacing. More...
	getLineSpacing ()
	Get line spacing. More...
	setWeight (weight)
	Set caption weight. More...
	getWeight ()
	Get caption weight. More...
	setTextColor (color)
	Set caption text color. More...
	getTextColor ()
	Get caption text color. More...
	setDrawOutline (drawOutline)
	Set caption stroke. More...
	getDrawOutline ()
	Get caption stroke. More...
	setOutlineWidth (outlineWidth)
	Set the width of the caption stroke. More...
	getOutlineWidth ()
	Get the width of the caption stroke. More...
	setOutlineColor (color)
	Set the color of the caption stroke. More...
	getOutlineColor ()
	Get the color of the caption stroke. More...
	setDrawShadow (drawShadow)
	Set caption shadows. More...
	getDrawShadow ()
	Get caption shadows. More...
	setShadowOffset (offset)
	Set caption shadow offset. More...
	getShadowOffset ()
	Gets the offset of the current caption shadow. More...
	setShadowColor (color)
	Set caption shadow color. More...
	getShadowColor ()
	Get caption shadow color. More...
	setShadowFeather (feather)
	Set the feathering degree of the caption shadow. More...
	getShadowFeather ()
	Get the feathering degree of the caption shadow. More...
	setFontSize (fontSize)
	Set caption font size. More...
	getFontSize ()
	Get caption font size. More...
	setFontByFilePath (filePath)
	Set caption font by file path. More...
	getFontFilePath ()
	Get caption font file path. More...
	setFontFamily (family)
	Set caption font family. More...
	getFontFamily ()
	Get caption font family. More...
	getFontCompoundFamilyName ()
	Get compound caption font family name. More...
	setCaptionTranslation (translation)
	Set the amount of caption translation. More...
	getCaptionTranslation ()
	Get the amount of caption translation. More...
	translateCaption (translationOffset)
	Caption translation. 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 caption. More...
	getScaleY ()
	Get vertical scaling factor for caption. More...
	scaleCaption (scaleFactor, anchor)
	Zooms caption. More...
	scaleCaption2 (scaleFactor)
	Scale caption on center. More...
	setRotationZ (angle)
	Set rotation angle for caption. More...
	getRotationZ ()
	Get rotation angle for caption. More...
	rotateCaption (angle, anchor)
	Rotate caption. More...
	rotateCaption2 (angle)
	Rotates caption with the caption center point as the anchor point. More...
	getTextBoundingRect ()
	Get caption text rectangle. More...
	getBoundingRectangleVertices ()
	Get the vertex position of the original enclosing rectangle of the caption after transformation. More...
	getCaptionBoundingVertices (boundingType)
	Get the transformed vertices position of the original caption bounding. More...
	setZValue (value)
	Set caption Z value. More...
	getZValue ()
	Get caption Z value. More...
	setRecordingUserOperation (recordingUserOperation)
	Set whether to record user actions. More...
	setOpacity (opacity)
	Set caption opacity. More...
	getOpacity ()
	Get caption opacity. More...
	isFrameCaption ()
	Determine if it is a border caption. More...
	isTextColorChanged ()
	Determine if caption text color changed. More...
	isModular ()
	Determines whether the current caption is a modular caption. More...
	setBackgroundColor (backgroundColor)
	Set text background color. More...
	getBackgroundColor ()
	Get the current text background color value. More...
	setBackgroundRadius (radius)
	Set text background rectangle's corner radius. More...
	getBackgroundRadius ()
	Get text background rectangle's corner radius. More...
	setCurrentKeyFrameTime (time)
	Set the caption KeyFrameTime. More...
	setIsLyrics (isLyrics)
	Set caption lyrics type. More...
	isLyrics ()
	Lyrics or not. More...
	enableSpeed (enable)
	enable speed More...
	isSpeedEnabled ()
	is Enable speed More...
	setFrameCaptionMaxFontSize (maxFontSize)
	Set the max font size for border caption. Only border caption can use this method. More...
	setTextFrameOriginRect (rect)
	Set the original frame size of the frame caption. If the current caption is not a frame caption, this function has no effect. You can get origin frame size. More...
	setTextSpanList (spanList)
	Set layout attributes from the start character to the end character of caption in list. More...
	getTextSpanList ()
	Get layout attributes list of caption. 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

Track captions.

Member Function Documentation

changeInPoint()

NvsTrackCaption::changeInPoint (   newInPoint )

inline

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

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 track (in microseconds).

changeOutPoint()

NvsTrackCaption::changeOutPoint (   newOutPoint )

inline

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

Parameters

{Number}

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

Returns

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

constructor()

NvsTrackCaption::constructor ( )

inline

@constructor

getInPoint()

NvsTrackCaption::getInPoint ( )

inline

The in-point of the caption on the track (in microseconds).

Returns

{Number} Get the in-point of the caption on the track.

getOutPoint()

NvsTrackCaption::getOutPoint ( )

inline

The out-point of the caption on the track.

Returns

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

movePosition()

NvsTrackCaption::movePosition (   offset )

inline

Changes the display position of the caption on the track (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).

---

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

• src/js/NvStreamingSdk.js