Timeline subtitles are custom text superimposed on the video. When editing video, you can add and remove timeline subtitles and adjust the subtitle position. After adding subtitles, you can also set styles, including font size, color, shadow, stroke, etc. More...

Inheritance diagram for NvsCaption:

Public Member Functions
	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

Timeline subtitles are custom text superimposed on the video. When editing video, you can add and remove timeline subtitles and adjust the subtitle position. After adding subtitles, you can also set styles, including font size, color, shadow, stroke, etc.

See also: NvsFx

Member Function Documentation

◆ applyCaptionStyle()

NvsCaption::applyCaptionStyle	(	captionStylePackageId,
		isUseDefaultAssetParam
	)

inline

Apply caption style.

Parameters

{String}	captionStylePackageId Caption style resource package ID.
{Number}	isUseDefaultAssetParam Whether to use the properties that come with the caption package.

Returns: {Boolean} Returns boolean value. True means a successful application, false means a failure.

◆ applyModularCaptionAnimation()

NvsCaption::applyModularCaptionAnimation ( captionAnimationPackageId )

inline

Applys modular caption loop-animation style.

Parameters

{String} captionAnimationPackageId caption animation package id

Returns: {Boolean} Returns boolean value. True means a successful application, false means a failure.

◆ applyModularCaptionContext()

NvsCaption::applyModularCaptionContext ( captionContextPackageId )

inline

Applys modular caption context style.

Parameters

{String} captionContextPackageId Modular caption context style resource package ID.

Returns: {Boolean} Returns boolean value. True means a successful application, false means a failure.

◆ applyModularCaptionInAnimation()

NvsCaption::applyModularCaptionInAnimation ( captionInAnimationPackageId )

inline

Applys modular caption in-animation style. Notes：please set loop-Animation to null before you set in-animation, otherwise it will NOT works.

Parameters

{String} captionInAnimationPackageId caption in animation package id

Returns: {Boolean} Returns boolean value. True means a successful application, false means a failure.

◆ applyModularCaptionOutAnimation()

NvsCaption::applyModularCaptionOutAnimation ( captionOutAnimationPackageId )

inline

Applys modular caption out-animation style.Notes：please set loop-Animation to null before you set out-animation, otherwise it will NOT works.

Parameters

{String} captionOutAnimationPackageId Modular caption out-animation style resource package ID.

Returns: {Boolean} Returns boolean value. True means a successful application, false means a failure.

◆ applyModularCaptionRenderer()

NvsCaption::applyModularCaptionRenderer ( captionRendererPackageId )

inline

Applys modular caption render style.

Parameters

{String} captionRendererPackageId Modular caption render style resource package ID.

Returns: {Boolean} Returns boolean value. True means a successful application, false means a failure.

◆ enableSpeed()

NvsCaption::enableSpeed ( enable )

inline

enable speed

Parameters

{Boolean} enable

Returns: {void}

◆ getAnchorPoint()

NvsCaption::getAnchorPoint ( )

inline

Get caption anchor.

Returns: {PointF} Returns caption anchor.

◆ getBackgroundColor()

NvsCaption::getBackgroundColor ( )

inline

Get the current text background color value.

Returns: {NvsColor} Returns the NvsColor object representing the current background color.

◆ getBackgroundRadius()

NvsCaption::getBackgroundRadius ( )

inline

Get text background rectangle's corner radius.

Returns: {Number} Returns corner radius value

◆ getBold()

NvsCaption::getBold ( )

inline

Get the caption font bold state.

Returns: {Boolean} Returns the caption font bold state. True means the font is bold, false means the font is not bold.

◆ getBoundingRectangleVertices()

NvsCaption::getBoundingRectangleVertices ( )

inline

Get the vertex position of the original enclosing rectangle of the caption after transformation.

Returns: {NvsVectorVal<NvsPointF>} Returns a NvsVectorVal<NvsPointF> object containing four vertex positions, which in turn correspond to the top left, bottom left, bottom right, and top right vertices of the original bounding rectangle.

◆ getCaptionBoundingVertices()

NvsCaption::getCaptionBoundingVertices ( boundingType )

inline

Get the transformed vertices position of the original caption bounding.

Parameters

{number} boundingType (NvsCaptionTextBoundingTypeEnum) Bounding type

Returns: {NvsVectorVal<NvsPointF>} Returns a NvsVectorVal<NvsPointF> object containing four vertices positions, which correspond to the top left, bottom left, bottom right, and top right vertices of the original bounding.

◆ getCaptionStylePackageId()

NvsCaption::getCaptionStylePackageId ( )

inline

Gets the caption style package ID.

Returns: {String} Returns the obtained caption style resource package ID.

◆ getCaptionTranslation()

NvsCaption::getCaptionTranslation ( )

inline

Get the amount of caption translation.

Returns: {PointF} Returns PointF object indicating the amount of caption translation obtained.

◆ getCategory()

NvsCaption::getCategory ( )

inline

Gets the type of caption.

Returns: {Number} Returns to the obtained Caption type.

◆ getDrawOutline()

NvsCaption::getDrawOutline ( )

inline

Get caption stroke.

Returns: {Boolean}

◆ getDrawShadow()

NvsCaption::getDrawShadow ( )

inline

Get caption shadows.

Returns: {Boolean}

◆ getFontCompoundFamilyName()

NvsCaption::getFontCompoundFamilyName ( )

inline

Get compound caption font family name.

Returns: {String} Returns the compound caption font family name of caption.

◆ getFontFamily()

NvsCaption::getFontFamily ( )

inline

Get caption font family.

Returns: {String} Returns font family of caption.

◆ getFontFilePath()

NvsCaption::getFontFilePath ( )

inline

Get caption font file path.

Returns: {String} Returns the file path of the caption font.

◆ getFontSize()

NvsCaption::getFontSize ( )

inline

Get caption font size.

Returns: {Number} Returns the obtained caption font size value.

◆ getItalic()

NvsCaption::getItalic ( )

inline

Get caption font italic.

Returns: {Boolean} Returns boolean value. True means it is italic font, false means it is not italic.

◆ getLetterSpacing()

NvsCaption::getLetterSpacing ( )

inline

Get caption letter spacing.

Returns: {Number} Returns the float value, the percentage value by default.

◆ getLetterSpacingType()

NvsCaption::getLetterSpacingType ( )

inline

Get caption word spacing type.

Returns: {Number} return letterSpacingType.

◆ getLineSpacing()

NvsCaption::getLineSpacing ( )

inline

Get line spacing.

Returns: {Number} return float value, line spacing is expressed in absolute value.

◆ getModularCaptionAnimationPackageId()

NvsCaption::getModularCaptionAnimationPackageId ( )

inline

Gets the modular caption animation style package ID.

Returns: {String} Returns the obtained modular caption animation style resource package ID.

◆ getModularCaptionAnimationPeroid()

NvsCaption::getModularCaptionAnimationPeroid ( )

inline

Get modular caption Animation Peroid.

Returns: {Number} Return animation peroid in millisecond

◆ getModularCaptionContextPackageId()

NvsCaption::getModularCaptionContextPackageId ( )

inline

Gets the modular caption context style package ID.

Returns: {String} Returns the obtained modular caption context style resource package ID.

◆ getModularCaptionInAnimationDuration()

NvsCaption::getModularCaptionInAnimationDuration ( )

inline

Get modular caption in-animation duration.

Returns: {Number} Return in-animation duration in millisecond

◆ getModularCaptionInAnimationPackageId()

NvsCaption::getModularCaptionInAnimationPackageId ( )

inline

Gets the modular caption in-animation style package ID.

Returns: {String} Returns the obtained modular caption in-animation style resource package ID.

◆ getModularCaptionOutAnimationDuration()

NvsCaption::getModularCaptionOutAnimationDuration ( )

inline

Get modular caption out-animation duration.

Returns: {Number} Return out-animation duration in millisecond

◆ getModularCaptionOutAnimationPackageId()

NvsCaption::getModularCaptionOutAnimationPackageId ( )

inline

Gets the modular caption out-animation style package ID.

Returns: {String} Returns the obtained modular caption out-animation style resource package ID.

◆ getModularCaptionRendererPackageId()

NvsCaption::getModularCaptionRendererPackageId ( )

inline

Gets the modular caption context style package ID.

Returns: {String} Returns the obtained modular caption context style resource package ID.

◆ getOpacity()

NvsCaption::getOpacity ( )

inline

Get caption opacity.

Returns: {Number} Return the caption opacity.

◆ getOutlineColor()

NvsCaption::getOutlineColor ( )

inline

Get the color of the caption stroke.

Returns: {NvsColor} Returns the NvsColor object representing the color of the resulting caption stroke.

◆ getOutlineWidth()

NvsCaption::getOutlineWidth ( )

inline

Get the width of the caption stroke.

Returns: {Number} Returns the width value of the obtained caption stroke.

◆ getRoleInTheme()

NvsCaption::getRoleInTheme ( )

inline

The role of caption in the theme.

Returns: {Number} The role of caption in the theme.

◆ getRotationZ()

NvsCaption::getRotationZ ( )

inline

Get rotation angle for caption.

Returns: {Number} Returns caption rotation angle.

◆ getScaleX()

NvsCaption::getScaleX ( )

inline

Get horizontal scaling factor for caption.

Returns: {Number} Returns caption horizontal scaling factor.

◆ getScaleY()

NvsCaption::getScaleY ( )

inline

Get vertical scaling factor for caption.

Returns: {Number} Returns caption vertical scaling factor.

◆ getShadowColor()

NvsCaption::getShadowColor ( )

inline

Get caption shadow color.

Returns: {NvsColor} Returns the NvsColor object representing the caption shadow color value obtained.

◆ getShadowFeather()

NvsCaption::getShadowFeather ( )

inline

Get the feathering degree of the caption shadow.

Returns: {Number} Returns feathering degree

◆ getShadowOffset()

NvsCaption::getShadowOffset ( )

inline

Gets the offset of the current caption shadow.

Returns: {PointF} Returns a PointF object representing the caption shadow offset obtained.

◆ getText()

NvsCaption::getText ( )

inline

Gets caption text.

Returns: {String} Returns caption text obtained.

◆ getTextAlignment()

NvsCaption::getTextAlignment ( )

inline

Get caption horizontal alignment style.

Returns: {Number} Returns caption horizontal alignment style.

◆ getTextBoundingRect()

NvsCaption::getTextBoundingRect ( )

inline

Get caption text rectangle.

Returns: {NvsRectF} Returns RectF object representing the obtained caption text rectangle.

◆ getTextColor()

NvsCaption::getTextColor ( )

inline

Get caption text color.

Returns: {NvsColor} Returns the NvsColor object representing the color value obtained.

◆ getTextSpanList()

NvsCaption::getTextSpanList ( )

inline

Get layout attributes list of caption.

Returns: {NvsVectorVal<NvsCaptionSpan>} layout attributes list

◆ getTextVerticalAlignment()

NvsCaption::getTextVerticalAlignment ( )

inline

Gets caption vertical alignment style, valid for frame-caption only.

Returns: {Number} Returns caption vertical alignment style.

◆ getUnderline()

NvsCaption::getUnderline ( )

inline

Get caption underline.

Returns: {Boolean} Returns boolean value. True means it is under line, false means it is not.

◆ getVerticalLayout()

NvsCaption::getVerticalLayout ( )

inline

Gets whether to layout text vertically.

Returns: {Boolean}

◆ getWeight()

NvsCaption::getWeight ( )

inline

Get caption weight.

Returns: {Number} Returns the caption weight.

◆ getZValue()

NvsCaption::getZValue ( )

inline

Get caption Z value.

Returns: {Number} Returns caption Z value.

◆ isFrameCaption()

NvsCaption::isFrameCaption ( )

inline

Determine if it is a border caption.

Returns: {Boolean} A return value of true indicates a border caption

◆ isLyrics()

NvsCaption::isLyrics ( )

inline

Lyrics or not.

Returns: {Boolean}

◆ isModular()

NvsCaption::isModular ( )

inline

Determines whether the current caption is a modular caption.

Returns: {Boolean} If returns value is true, it is panorama caption.

◆ isSpeedEnabled()

NvsCaption::isSpeedEnabled ( )

inline

is Enable speed

Returns: {Boolean}

◆ isTextColorChanged()

NvsCaption::isTextColorChanged ( )

inline

Determine if caption text color changed.

Returns: {void}

◆ rotateCaption()

NvsCaption::rotateCaption	(	angle,
		anchor
	)

inline

Rotate caption.

Parameters

{Number}	angle Angle of caption rotation.
{PointF}	anchor Anchor of caption rotation.

Returns: {void}

◆ rotateCaption2()

NvsCaption::rotateCaption2 ( angle )

inline

Rotates caption with the caption center point as the anchor point.

Parameters

{Number} angle Angle of caption rotation.

Returns: {void}

◆ scaleCaption()

NvsCaption::scaleCaption	(	scaleFactor,
		anchor
	)

inline

Zooms caption.

Parameters

{Number}	scaleFactor Caption scaling factor.
{PointF}	anchor Caption zoom anchor.

Returns: {void}

◆ scaleCaption2()

NvsCaption::scaleCaption2 ( scaleFactor )

inline

Scale caption on center.

Parameters

{Number} scaleFactor scale factor

Returns: {void}

◆ setAnchorPoint()

NvsCaption::setAnchorPoint ( anchor )

inline

Set caption anchor.

Parameters

{PointF} anchor Anchor

Returns: {void}

◆ setBackgroundColor()

NvsCaption::setBackgroundColor ( backgroundColor )

inline

Set text background color.

Parameters

{NvsColor} backgroundColor Background color value.

Returns: {void}

◆ setBackgroundRadius()

NvsCaption::setBackgroundRadius ( radius )

inline

Set text background rectangle's corner radius.

Parameters

{Number} radius Corner radius value

Returns: {void}

◆ setBold()

NvsCaption::setBold ( bold )

inline

Set caption font bold.

Parameters

{Boolean} bold Indicates whether the caption font is bold. True means the font is bold, false means the font is not bold.

Returns: {void}

◆ setCaptionTranslation()

NvsCaption::setCaptionTranslation ( translation )

inline

Set the amount of caption translation.

Parameters

{PointF} translation The horizontal and vertical absolute translation of the caption.

Returns: {void}

◆ setCurrentKeyFrameTime()

NvsCaption::setCurrentKeyFrameTime ( time )

inline

Set the caption KeyFrameTime.

Parameters

{Number} time time

Returns: {void}

◆ setDrawOutline()

NvsCaption::setDrawOutline ( drawOutline )

inline

Set caption stroke.

Parameters

{Boolean} drawOutline Whether to stroke the captions. True means it strokes the caption. False means it does not stroke the edges.

Returns: {void}

◆ setDrawShadow()

NvsCaption::setDrawShadow ( drawShadow )

inline

Set caption shadows.

Parameters

{Boolean} drawShadow Whether to set the caption shadow. True means to set the caption shadow, false means to not set.

Returns: {void}

◆ setFontByFilePath()

NvsCaption::setFontByFilePath ( filePath )

inline

Set caption font by file path.

Parameters

{String} filePath The file path of the caption font. If it is set to a null string, it is set as the default font.

Returns: {void}

◆ setFontFamily()

NvsCaption::setFontFamily ( family )

inline

Set caption font family.

Parameters

{String} family Caption font name. It will be set to default font if a null string which is given.

Returns: {void}

◆ setFontSize()

NvsCaption::setFontSize ( fontSize )

inline

Set caption font size.

Parameters

{Number} fontSize Caption font size value

Returns: {void}

◆ setFrameCaptionMaxFontSize()

NvsCaption::setFrameCaptionMaxFontSize ( maxFontSize )

inline

Set the max font size for border caption. Only border caption can use this method.

Parameters

{Number} maxFontSize max font size

Returns: {void}

◆ setIsLyrics()

NvsCaption::setIsLyrics ( isLyrics )

inline

Set caption lyrics type.

Parameters

{Boolean} isLyrics lyrics

Returns: {void}

◆ setItalic()

NvsCaption::setItalic ( italic )

inline

Set caption font italic.

Parameters

{Boolean} italic Whether it is set to italic. True means that the caption font is set to italic, and false means the caption font is not set to italic.

Returns: {void}

◆ setLetterSpacing()

NvsCaption::setLetterSpacing ( letterSpacing )

inline

Set caption letter spacing.

Parameters

{Number} letterSpacing Word spacing is expressed in percentage value by default.

Returns: {void}

◆ setLetterSpacingType()

NvsCaption::setLetterSpacingType ( letterSpacingType )

inline

Set caption word spacing type.

Parameters

{Number} letterSpacingType Word spacing type.

Returns: {void}

◆ setLineSpacing()

NvsCaption::setLineSpacing ( lineSpacing )

inline

Set line spacing.

Parameters

{}	lineSpacing line spacing is expressed in absolute value.

Returns: {void}

◆ setModularCaptionAnimationPeroid()

NvsCaption::setModularCaptionAnimationPeroid ( periodInMS )

inline

Set modular caption Animation Peroid.

Parameters

{Number} periodInMS Animation peroid in millisecond

Returns: {void}

◆ setModularCaptionInAnimationDuration()

NvsCaption::setModularCaptionInAnimationDuration ( inAnimationDurationInMS )

inline

Set modular caption in-animation duration.

Parameters

{Number} inAnimationDurationInMS in-animation duration in millisecond

Returns: {void}

◆ setModularCaptionOutAnimationDuration()

NvsCaption::setModularCaptionOutAnimationDuration ( outAnimationDurationInMS )

inline

Set modular caption out-animation duration.

Parameters

{Number} outAnimationDurationInMS out-animation duration in millisecond

Returns: {void}

◆ setOpacity()

NvsCaption::setOpacity ( opacity )

inline

Set caption opacity.

Parameters

{Number} opacity caption opacity.

Returns: {void}

◆ setOutlineColor()

NvsCaption::setOutlineColor ( color )

inline

Set the color of the caption stroke.

Parameters

{NvsColor} color Caption stroke color value.

Returns: {void}

See also: NvsColor

◆ setOutlineWidth()

NvsCaption::setOutlineWidth ( outlineWidth )

inline

Set the width of the caption stroke.

Parameters

{Number} outlineWidth The width of the caption stroke.

Returns: {void}

◆ setRecordingUserOperation()

NvsCaption::setRecordingUserOperation ( recordingUserOperation )

inline

Set whether to record user actions.

Parameters

{Boolean} recordingUserOperation Record user actions or not

Returns: {void}

◆ setRotationZ()

NvsCaption::setRotationZ ( angle )

inline

Set rotation angle for caption.

Parameters

{Number} angle Rotation angle.

Returns: {void}

◆ setScaleX()

NvsCaption::setScaleX ( scale )

inline

Set horizontal scaling factor for caption.

Parameters

{Number} scale Horizontal scaling factor.

Returns: {void}

◆ setScaleY()

NvsCaption::setScaleY ( scale )

inline

Set vertical scaling factor for caption.

Parameters

{Number} scale Vertical scaling factor.

Returns: {void}

◆ setShadowColor()

NvsCaption::setShadowColor ( color )

inline

Set caption shadow color.

Parameters

{NvsColor} shadowColor Caption shadow color value.

Returns: {void}

◆ setShadowFeather()

NvsCaption::setShadowFeather ( feather )

inline

Set the feathering degree of the caption shadow.

Parameters

{Number} feather feathering degree

Returns: {void}

◆ setShadowOffset()

NvsCaption::setShadowOffset ( offset )

inline

Set caption shadow offset.

Parameters

{PointF} offset Caption shadow offset.

Returns: {void}

◆ setText()

NvsCaption::setText ( text )

inline

Sets caption text.

Parameters

{String} text Caption text

Returns: {void}

◆ setTextAlignment()

NvsCaption::setTextAlignment ( textAlign )

inline

Set caption horizontal alignment style.

Parameters

{Number} textAlign Indicates the caption horizontal alignment style

Returns: {void}

◆ setTextColor()

NvsCaption::setTextColor ( color )

inline

Set caption text color.

Parameters

{NvsColor} color Caption text color value.

◆ setTextFrameOriginRect()

NvsCaption::setTextFrameOriginRect ( rect )

inline

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.

Parameters

{NvsRectF} rect New frame size.

Returns: {void}

◆ setTextSpanList()

NvsCaption::setTextSpanList ( spanList )

inline

Set layout attributes from the start character to the end character of caption in list.

Parameters

{NvsVectorVal<NvsCaptionSpan>} spanList layout attributes list

Returns: {void}

◆ setTextVerticalAlignment()

NvsCaption::setTextVerticalAlignment ( textAlign )

inline

Set caption horizontal alignment style.

Parameters

{Number} textAlign Indicates the caption horizontal alignment style

Returns: {void}

◆ setUnderline()

NvsCaption::setUnderline ( underline )

inline

Set caption underline.

Parameters

{Boolean} underline Whether it is set to under line.

Returns: {void}

◆ setVerticalLayout()

NvsCaption::setVerticalLayout ( verticalLayout )

inline

Sets whether to layout text vertically.

Parameters

{Boolean} verticalLayout whether to layout text vertically

Returns: {void}

◆ setWeight()

NvsCaption::setWeight ( weight )

inline

Set caption weight.

Parameters

{Number} weight the value in opentype weight integer.

Returns: {void}

◆ setZValue()

NvsCaption::setZValue ( value )

inline

Set caption Z value.

Parameters

{Number} value Z value

Returns: {void}

◆ translateCaption()

NvsCaption::translateCaption ( translationOffset )

inline

Caption translation.

Parameters

{PointF} translationOffset Horizontal and vertical offset values for caption.

Returns: {void}

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

src/js/NvStreamingSdk.js

Public Member Functions

Detailed Description

Member Function Documentation

◆ applyCaptionStyle()

◆ applyModularCaptionAnimation()

◆ applyModularCaptionContext()

◆ applyModularCaptionInAnimation()

◆ applyModularCaptionOutAnimation()

◆ applyModularCaptionRenderer()

◆ enableSpeed()

◆ getAnchorPoint()

◆ getBackgroundColor()

◆ getBackgroundRadius()

◆ getBold()

◆ getBoundingRectangleVertices()

◆ getCaptionBoundingVertices()

◆ getCaptionStylePackageId()

◆ getCaptionTranslation()

◆ getCategory()

◆ getDrawOutline()

◆ getDrawShadow()

◆ getFontCompoundFamilyName()

◆ getFontFamily()

◆ getFontFilePath()

◆ getFontSize()

◆ getItalic()

◆ getLetterSpacing()

◆ getLetterSpacingType()

◆ getLineSpacing()

◆ getModularCaptionAnimationPackageId()

◆ getModularCaptionAnimationPeroid()

◆ getModularCaptionContextPackageId()

◆ getModularCaptionInAnimationDuration()

◆ getModularCaptionInAnimationPackageId()

◆ getModularCaptionOutAnimationDuration()

◆ getModularCaptionOutAnimationPackageId()

◆ getModularCaptionRendererPackageId()

◆ getOpacity()

◆ getOutlineColor()

◆ getOutlineWidth()

◆ getRoleInTheme()

◆ getRotationZ()

◆ getScaleX()

◆ getScaleY()

◆ getShadowColor()

◆ getShadowFeather()

◆ getShadowOffset()

◆ getText()

◆ getTextAlignment()

◆ getTextBoundingRect()

◆ getTextColor()

◆ getTextSpanList()

◆ getTextVerticalAlignment()

◆ getUnderline()

◆ getVerticalLayout()

◆ getWeight()

◆ getZValue()

◆ isFrameCaption()

◆ isLyrics()

◆ isModular()

◆ isSpeedEnabled()

◆ isTextColorChanged()

◆ rotateCaption()

◆ rotateCaption2()

◆ scaleCaption()

◆ scaleCaption2()

◆ setAnchorPoint()

◆ setBackgroundColor()

◆ setBackgroundRadius()

◆ setBold()

◆ setCaptionTranslation()

◆ setCurrentKeyFrameTime()

◆ setDrawOutline()

◆ setDrawShadow()

◆ setFontByFilePath()

◆ setFontFamily()

◆ setFontSize()

◆ setFrameCaptionMaxFontSize()

◆ setIsLyrics()

◆ setItalic()