NvsCaption类 参考

时间线字幕是叠加在视频上的自定义文本。编辑视频时，您可以添加和删除时间线字幕并调整字幕位置。添加字幕后，还可以设置样式，包括字体大小、颜色、阴影、描边等。 更多...

类 NvsCaption 继承关系图:

Public 成员函数
	constructor ()
	构造函数
	getRoleInTheme ()
	字幕在主题中的作用。 更多...
	getCategory ()
	获取字幕的类型。 更多...
	getCaptionStylePackageId ()
	获取字幕样式包 ID。 更多...
	getModularCaptionContextPackageId ()
	获取模块化字幕上下文样式包 ID。 更多...
	getModularCaptionRendererPackageId ()
	获取模块化字幕渲染样式包 ID。 更多...
	getModularCaptionAnimationPackageId ()
	获取模块化字幕动画样式包 ID。 更多...
	getModularCaptionInAnimationPackageId ()
	获取模块化字幕动画样式包 ID。 更多...
	getModularCaptionOutAnimationPackageId ()
	获取模块化字幕外动画样式包 ID。 更多...
	applyCaptionStyle (captionStylePackageId, isUseDefaultAssetParam)
	应用标题样式 更多...
	applyModularCaptionContext (captionContextPackageId)
	应用模块化标题上下文样式。 更多...
	applyModularCaptionRenderer (captionRendererPackageId)
	应用模块化字幕渲染样式。 更多...
	applyModularCaptionAnimation (captionAnimationPackageId)
	应用模块化字幕循环动画样式。 更多...
	applyModularCaptionInAnimation (captionInAnimationPackageId)
	在动画样式中应用模块化字幕。注意：设置in-animation前请先设置loop-Animation为null，否则无效。 更多...
	applyModularCaptionOutAnimation (captionOutAnimationPackageId)
	应用模块化字幕出动画样式。注意：请在设置出动画之前将loop-Animation设置为null，否则将不起作用。 更多...
	setModularCaptionAnimationPeroid (periodInMS)
	设置模块化字幕动画周期。 更多...
	getModularCaptionAnimationPeroid ()
	获取模块化字幕动画周期。 更多...
	setModularCaptionInAnimationDuration (inAnimationDurationInMS)
	设置模块化字幕动画持续时间。 更多...
	getModularCaptionInAnimationDuration ()
	获取动画中的模块化字幕持续时间。 更多...
	setModularCaptionOutAnimationDuration (outAnimationDurationInMS)
	设置模块化字幕动画持续时间。 更多...
	getModularCaptionOutAnimationDuration ()
	获取模块化字幕动画持续时间。 更多...
	setText (text)
	设置标题文本。 更多...
	getText ()
	获取字幕文本。 更多...
	setTextAlignment (textAlign)
	设置标题水平对齐样式 更多...
	getTextAlignment ()
	获取标题水平对齐样式 更多...
	setTextVerticalAlignment (textAlign)
	设置标题水平对齐样式 更多...
	getTextVerticalAlignment ()
	获取标题垂直对齐样式，仅对 frame-caption 有效。 更多...
	setVerticalLayout (verticalLayout)
	设置是否垂直布局文本。 更多...
	getVerticalLayout ()
	获取是否垂直布局文本。 更多...
	setBold (bold)
	设置标题字体粗体 更多...
	getBold ()
	获取字幕字体加粗状态 更多...
	setItalic (italic)
	设置标题字体斜体。 更多...
	getItalic ()
	获取标题字体斜体。 更多...
	setUnderline (underline)
	设置标题下划线 更多...
	getUnderline ()
	获取标题下划线 更多...
	setLetterSpacingType (letterSpacingType)
	设置标题字间距类型。 更多...
	getLetterSpacingType ()
	获取标题字间距类型。 更多...
	setLetterSpacing (letterSpacing)
	设置标题字母间距 更多...
	getLetterSpacing ()
	获取标题字母间距 更多...
	setLineSpacing (lineSpacing)
	设置行距 更多...
	getLineSpacing ()
	获取行距 更多...
	setWeight (weight)
	设置字幕权重 更多...
	getWeight ()
	获取字幕重量 更多...
	setTextColor (color)
	设置标题文字颜色 更多...
	getTextColor ()
	获取标题文本颜色 更多...
	setDrawOutline (drawOutline)
	设置字幕描边。 更多...
	getDrawOutline ()
	获取字幕描边。 更多...
	setOutlineWidth (outlineWidth)
	设置标题笔划的宽度。 更多...
	getOutlineWidth ()
	获取标题笔画的宽度。 更多...
	setOutlineColor (color)
	设置标题描边的颜色。 更多...
	getOutlineColor ()
	获取标题笔划的颜色。 更多...
	setDrawShadow (drawShadow)
	设置字幕阴影。 更多...
	getDrawShadow ()
	获取字幕阴影。 更多...
	setShadowOffset (offset)
	设置字幕阴影偏移 更多...
	getShadowOffset ()
	获取当前字幕阴影的偏移量。 更多...
	setShadowColor (color)
	设置字幕阴影颜色 更多...
	getShadowColor ()
	获取字幕阴影颜色 更多...
	setShadowFeather (feather)
	设置字幕阴影的羽化程度。 更多...
	getShadowFeather ()
	获取字幕阴影的羽化度。 更多...
	setFontSize (fontSize)
	设置字幕字体大小。 更多...
	getFontSize ()
	获取字幕字体大小。 更多...
	setFontByFilePath (filePath)
	按文件路径设置字幕字体 更多...
	getFontFilePath ()
	获取字幕字体文件路径 更多...
	setFontFamily (family)
	设置标题字体系列 更多...
	getFontFamily ()
	获取字体名称 更多...
	getFontCompoundFamilyName ()
	获取字体组合名称 更多...
	setCaptionTranslation (translation)
	设置字幕平移量。 更多...
	getCaptionTranslation ()
	获取字幕平移量。 更多...
	translateCaption (translationOffset)
	字幕平移。 更多...
	setAnchorPoint (anchor)
	设置字幕锚。 更多...
	getAnchorPoint ()
	获取字幕锚。 更多...
	setScaleX (scale)
	设置字幕的水平缩放系数。 更多...
	getScaleX ()
	获取标题的水平缩放系数。 更多...
	setScaleY (scale)
	设置标题的垂直比例系数。 更多...
	getScaleY ()
	获取标题的垂直比例系数。 更多...
	scaleCaption (scaleFactor, anchor)
	缩放字幕。 更多...
	scaleCaption2 (scaleFactor)
	在中心缩放标题 更多...
	setRotationZ (angle)
	设置字幕的旋转角度。 更多...
	getRotationZ ()
	获取标题的旋转角度。 更多...
	rotateCaption (angle, anchor)
	旋转字幕 更多...
	rotateCaption2 (angle)
	以字幕中心点为锚点旋转字幕。 更多...
	getTextBoundingRect ()
	获取标题文本矩形 更多...
	getBoundingRectangleVertices ()
	获取转换后字幕的原始包围矩形的顶点位置。 更多...
	getCaptionBoundingVertices (boundingType)
	获取原始字幕边界的变换顶点位置。 更多...
	setZValue (value)
	设置标题 Z 值。 更多...
	getZValue ()
	获取标题 Z 值。 更多...
	setRecordingUserOperation (recordingUserOperation)
	设置是否记录用户操作。 更多...
	setOpacity (opacity)
	设置字幕不透明度。 更多...
	getOpacity ()
	设置字幕不透明度。 更多...
	isFrameCaption ()
	确定它是否是边框标题。 更多...
	isTextColorChanged ()
	确定标题文本颜色是否改变。 更多...
	isModular ()
	确定当前标题是否为模块化标题。 更多...
	setBackgroundColor (backgroundColor)
	设置文本背景颜色。 更多...
	getBackgroundColor ()
	获取当前文本背景颜色值。 更多...
	setBackgroundRadius (radius)
	设置文本背景矩形的角半径。 更多...
	getBackgroundRadius ()
	获取文本背景矩形的角半径。 更多...
	setCurrentKeyFrameTime (time)
	设置标题 KeyFrameTime。 更多...
	setIsLyrics (isLyrics)
	设置字幕歌词类型 更多...
	isLyrics ()
	歌词与否 更多...
	enableSpeed (enable)
	开启变速 更多...
	isSpeedEnabled ()
	是否开启变速 更多...
	setFrameCaptionMaxFontSize (maxFontSize)
	设置边框标题的最大字体大小。只有边框标题可以使用此方法。 更多...
	setTextFrameOriginRect (rect)
	设置帧标题的原始帧大小。如果当前字幕不是帧字幕，则此功能无效。您可以获得原始帧大小。 更多...
	setTextSpanList (spanList)
	用户可以指定字幕中位置从某一起始字符到某一结束字符之间，应用多种layout属性 更多...
	getTextSpanList ()
	获取字幕layout属性列表 更多...
Public 成员函数 继承自 NvsFx
	constructor ()
	特效类。构造器
	getDescription ()
	获取特效的描述。返回 NvsFxDescription 对象 更多...
	setIntVal (fxParam, val)
	设置整数值 更多...
	getIntVal (fxParam)
	获取整数值 更多...
	setIntValAtTime (fxParam, val, time)
	在某个时间设置整数值 更多...
	getIntValAtTime (fxParam, time)
	在某个时间获取整数值 更多...
	setFloatVal (fxParam, val)
	设置浮点值 更多...
	getFloatVal (fxParam)
	获取浮点值 更多...
	setFloatValAtTime (fxParam, val, time)
	在某个时间设置浮点值 更多...
	getFloatValAtTime (fxParam, time)
	在某个时间获取浮点值 更多...
	setBooleanVal (fxParam, val)
	设置布尔值 更多...
	getBooleanVal (fxParam)
	获取布尔值 更多...
	setBooleanValAtTime (fxParam, val, time)
	在某个时间设置布尔值 更多...
	getBooleanValAtTime (fxParam, time)
	在某个时间获取布尔值 更多...
	setMenuVal (fxParam, val)
	设置菜单值 更多...
	getMenuVal (fxParam)
	设置菜单值 更多...
	setMenuValAtTime (fxParam, val, time)
	在某个时间设置菜单值 更多...
	getMenuValAtTime (fxParam, time)
	在某个时间获取菜单值 更多...
	setStringVal (fxParam, val)
	设置字符串值 更多...
	getStringVal (fxParam)
	获取字符串值 更多...
	setStringValAtTime (fxParam, val, time)
	在某个时间点设置字符串值 更多...
	getStringValAtTime (fxParam, time)
	在某个时间获取字符串值 更多...
	setColorVal (fxParam, val)
	设置颜色值 更多...
	getColorVal (fxParam)
	设置颜色值 更多...
	setColorValAtTime (fxParam, val, time)
	在某个时间设置颜色 更多...
	getColorValAtTime (fxParam, time)
	在某个时间点获取颜色值 更多...
	removeKeyframeAtTime (fxParam, time)
	在某个时间删除关键帧 更多...
	removeAllKeyframe (fxParam)
	删除所有关键帧 更多...
	hasKeyframeList (fxParam)
	是否有关键帧列表 更多...
	findKeyframeTime (fxParam, time, flags)
	在某个时间查询关键帧 更多...
	setParamKeyframes (fxParam, keyframes)
	设置关键帧参数 更多...
	getParamKeyframes (fxParam)
	获取关键帧参数 更多...
	setParamKeyframeAtTime (fxParam, time, keyframe)
	在某个时间设置关键帧参数 更多...
	getParamKeyframeAtTime (fxParam, time)
	在某个时间获取关键帧参数 更多...
	getIntpFxParamValsAtTime (fxParam, time)
	在某个时间获取关键帧参数 更多...
	setFilterIntensity (intensity)
	设置滤镜强度 更多...
	getFilterIntensity ()
	获取滤镜强度 更多...
	setRegional (isRegional)
	设置区域 更多...
	getRegional ()
	获取区域范围 更多...
	setIgnoreBackground (isIgnoreBackground)
	设置忽略背景 更多...
	getIgnoreBackground ()
	获取忽略背景 更多...
	setInverseRegion (isInverseRegion)
	设置反转区域 更多...
	getInverseRegion ()
	获取反转区域 更多...
	setRegion (region)
	设置区域 更多...
	setRegionAtTime (region, time)
	在某个时间设置区域 更多...
	setEllipseRegion (center, a, b, angle)
	设置椭圆区域 更多...
	setEllipseRegionAtTime (center, a, b, angle, time)
	在某个时间点设置椭圆区域 更多...
	getRegionInfos ()
	获取特效区域信息 更多...
	getRegionInfosAtTime (time)
	获取特效在某个时间点的区域信息 更多...
	setRegionalFeatherWidth (featherWidth)
	设置区域羽化宽度 更多...
	getRegionalFeatherWidth ()
	获取区域羽化宽度 更多...
	getParticleSystemContext ()
	获取粒子特效上下文 更多...
	getARSceneManipulate ()
	获取ARScene操作 更多...
	setExprVar (varName, varValue)
	设置表达式变量 更多...
	getExprVar (varName)
	获取表达式变量 更多...
	setExprObjectVar (varName, varValue)
	设置对象(例如:颜色)表达式变量 更多...
	getExprObjectVar (varName)
	获取对象(例如:颜色)表达式变量 更多...
	clearExprVar ()
	清除Expr值 更多...
	clearExprVarCtx ()
	清空表达式中定义的全部参数的值，并设置为默认值0 更多...
	setArbitraryVal (fxParam, val)
	设置特效不定类型的值 更多...
	getArbitraryVal (fxParam)
	获取特效不定类型的值 更多...
	setArbitraryValAtTime (fxParam, val, time)
	getArbitraryValAtTime (fxParam, time)
	获取特效某时间点不定类型的值 更多...
	setRegionInfos (regionInfos)
	设置多个区域信息 更多...
	setRegionInfosAtTime (regionInfos, time)
	设置某个时间点的多个区域信息 更多...
Public 成员函数 继承自 NvsProjObj
	constructor ()
	setInternalObject (obj)
	设置内置对象 更多...
	getInternalObject ()
	获取内置对象 更多...
	setTemplateAttachment (key, value)
	设置模板附件 更多...
	getTemplateAttachment (key)
	根据键，获取模板属性值 更多...

详细描述

时间线字幕是叠加在视频上的自定义文本。编辑视频时，您可以添加和删除时间线字幕并调整字幕位置。添加字幕后，还可以设置样式，包括字体大小、颜色、阴影、描边等。

参见

NvsFx

成员函数说明

applyCaptionStyle()

NvsCaption::applyCaptionStyle (   captionStylePackageId,   isUseDefaultAssetParam  )

inline

应用标题样式

参数

{String}	captionStylePackageId 字幕样式资源包 ID。
{Number}	isUseDefaultAssetParam 是否使用字幕包自带的属性。

返回

{Boolean} 返回布尔值。 true 表示申请成功，false 表示失败。

applyModularCaptionAnimation()

NvsCaption::applyModularCaptionAnimation (   captionAnimationPackageId )

inline

应用模块化字幕循环动画样式。

参数

{String}

captionAnimationPackageId 字幕动画包ID

返回

{Boolean} 返回布尔值。 true 表示申请成功，false 表示失败。

applyModularCaptionContext()

NvsCaption::applyModularCaptionContext (   captionContextPackageId )

inline

应用模块化标题上下文样式。

参数

{String}

captionContextPackageId 模块化字幕上下文样式资源包 ID。

返回

{Boolean} 返回布尔值。 true 表示申请成功，false 表示失败。

applyModularCaptionInAnimation()

NvsCaption::applyModularCaptionInAnimation (   captionInAnimationPackageId )

inline

在动画样式中应用模块化字幕。注意：设置in-animation前请先设置loop-Animation为null，否则无效。

参数

{String}

captionInAnimationPackageId 动画包 ID 中的字幕

返回

{Boolean} 返回布尔值。 true 表示申请成功，false 表示失败。

applyModularCaptionOutAnimation()

NvsCaption::applyModularCaptionOutAnimation (   captionOutAnimationPackageId )

inline

应用模块化字幕出动画样式。注意：请在设置出动画之前将loop-Animation设置为null，否则将不起作用。

参数

{String}

captionOutAnimationPackageId 模块化字幕出动画样式资源包 ID。

返回

{Boolean} 返回布尔值。 true 表示申请成功，false 表示失败。

applyModularCaptionRenderer()

NvsCaption::applyModularCaptionRenderer (   captionRendererPackageId )

inline

应用模块化字幕渲染样式。

参数

{String}

captionRendererPackageId 模块化字幕渲染样式资源包 ID。

返回

{Boolean} 返回布尔值。 true 表示申请成功，false 表示失败。

enableSpeed()

NvsCaption::enableSpeed (   enable )

inline

开启变速

参数

{Boolean}

enable

返回

{void}

getAnchorPoint()

NvsCaption::getAnchorPoint ( )

inline

获取字幕锚。

返回

{PointF} 返回字幕锚。

getBackgroundColor()

NvsCaption::getBackgroundColor ( )

inline

获取当前文本背景颜色值。

返回

{NvsColor} 返回表示当前背景颜色的 NvsColor 对象。

getBackgroundRadius()

NvsCaption::getBackgroundRadius ( )

inline

获取文本背景矩形的角半径。

返回

{Number} 返回角半径值

getBold()

NvsCaption::getBold ( )

inline

获取字幕字体加粗状态

返回

{Boolean} 返回字幕字体粗体状态。 true 表示字体是粗体，false 表示字体不是粗体。

getBoundingRectangleVertices()

NvsCaption::getBoundingRectangleVertices ( )

inline

获取转换后字幕的原始包围矩形的顶点位置。

返回

{NvsVectorVal<NvsPointF>} 返回一个包含四个顶点位置的 NvsVectorVal<NvsPointF> 对象，这些位置依次对应于原始边界矩形的左上角、左下角、右下角和右上角顶点。

getCaptionBoundingVertices()

NvsCaption::getCaptionBoundingVertices (   boundingType )

inline

获取原始字幕边界的变换顶点位置。

参数

{number}

boundingType(NvsCaptionTextBoundingTypeEnum) B起始类型

返回

{NvsVectorVal<NvsPointF>} 返回一个 NvsVectorVal<NvsPointF> 对象，其中包含四个顶点位置，分别对应于原始边界的左上角、左下角、右下角和右上角顶点。

getCaptionStylePackageId()

NvsCaption::getCaptionStylePackageId ( )

inline

获取字幕样式包 ID。

返回

{String} 返回获取到的字幕样式资源包ID。

getCaptionTranslation()

NvsCaption::getCaptionTranslation ( )

inline

获取字幕平移量。

返回

{PointF} 返回 PointF 对象，指示获得的字幕平移量。

getCategory()

NvsCaption::getCategory ( )

inline

获取字幕的类型。

返回

{Number} 返回获取到的 Caption 类型。

getDrawOutline()

NvsCaption::getDrawOutline ( )

inline

获取字幕描边。

返回

{Boolean}

getDrawShadow()

NvsCaption::getDrawShadow ( )

inline

获取字幕阴影。

返回

{Boolean}

getFontCompoundFamilyName()

NvsCaption::getFontCompoundFamilyName ( )

inline

获取字体组合名称

返回

{String} 返回字体组合名称。

getFontFamily()

NvsCaption::getFontFamily ( )

inline

获取字体名称

返回

{String} 返回字体名称。

getFontFilePath()

NvsCaption::getFontFilePath ( )

inline

获取字幕字体文件路径

返回

{String} 返回字幕字体的文件路径。

getFontSize()

NvsCaption::getFontSize ( )

inline

获取字幕字体大小。

返回

{Number} 返回获取的字幕字体大小值。

getItalic()

NvsCaption::getItalic ( )

inline

获取标题字体斜体。

返回

{Boolean} 返回布尔值。 true 表示它是斜体字体，false 表示它不是斜体。

getLetterSpacing()

NvsCaption::getLetterSpacing ( )

inline

获取标题字母间距

返回

{Number} 返回浮点值，默认为百分比值。

getLetterSpacingType()

NvsCaption::getLetterSpacingType ( )

inline

获取标题字间距类型。

返回

{Number} 返回字母SpacingType。

getLineSpacing()

NvsCaption::getLineSpacing ( )

inline

获取行距

返回

{Number} 返回浮点值，行距以绝对值表示。

getModularCaptionAnimationPackageId()

NvsCaption::getModularCaptionAnimationPackageId ( )

inline

获取模块化字幕动画样式包 ID。

返回

{String} 返回获取到的模块化字幕动画样式资源包ID。

getModularCaptionAnimationPeroid()

NvsCaption::getModularCaptionAnimationPeroid ( )

inline

获取模块化字幕动画周期。

返回

{Number} 返回动画周期（毫秒）

getModularCaptionContextPackageId()

NvsCaption::getModularCaptionContextPackageId ( )

inline

获取模块化字幕上下文样式包 ID。

返回

{String} 返回获取的模块化字幕上下文样式资源包ID。

getModularCaptionInAnimationDuration()

NvsCaption::getModularCaptionInAnimationDuration ( )

inline

获取动画中的模块化字幕持续时间。

返回

{Number} 以毫秒为单位返回动画持续时间

getModularCaptionInAnimationPackageId()

NvsCaption::getModularCaptionInAnimationPackageId ( )

inline

获取模块化字幕动画样式包 ID。

返回

{String} 返回获取的模块化字幕动画样式资源包ID。

getModularCaptionOutAnimationDuration()

NvsCaption::getModularCaptionOutAnimationDuration ( )

inline

获取模块化字幕动画持续时间。

返回

{Number} 以毫秒为单位返回动画持续时间

getModularCaptionOutAnimationPackageId()

NvsCaption::getModularCaptionOutAnimationPackageId ( )

inline

获取模块化字幕外动画样式包 ID。

返回

{String} 返回获取的模块化字幕外动画样式资源包ID。

getModularCaptionRendererPackageId()

NvsCaption::getModularCaptionRendererPackageId ( )

inline

获取模块化字幕渲染样式包 ID。

返回

{String} 返回获取的模块化字幕渲染样式资源包ID。

getOpacity()

NvsCaption::getOpacity ( )

inline

设置字幕不透明度。

返回

{Number} 返回标题不透明度。

getOutlineColor()

NvsCaption::getOutlineColor ( )

inline

获取标题笔划的颜色。

返回

{NvsColor} 返回 NvsColor 对象，该对象表示生成的标题笔划的颜色。

getOutlineWidth()

NvsCaption::getOutlineWidth ( )

inline

获取标题笔画的宽度。

返回

{Number} 返回获取的标题笔画的宽度值。

getRoleInTheme()

NvsCaption::getRoleInTheme ( )

inline

字幕在主题中的作用。

返回

{Number} 字幕在主题中的作用

getRotationZ()

NvsCaption::getRotationZ ( )

inline

获取标题的旋转角度。

返回

{Number} 返回字幕旋转角度。

getScaleX()

NvsCaption::getScaleX ( )

inline

获取标题的水平缩放系数。

返回

{Number} 返回字幕水平缩放系数。

getScaleY()

NvsCaption::getScaleY ( )

inline

获取标题的垂直比例系数。

返回

{Number} 返回字幕垂直比例系数。

getShadowColor()

NvsCaption::getShadowColor ( )

inline

获取字幕阴影颜色

返回

{NvsColor} 返回表示获得的字幕阴影颜色值的 NvsColor 对象。

getShadowFeather()

NvsCaption::getShadowFeather ( )

inline

获取字幕阴影的羽化度。

返回

{Number} 返回羽化度

getShadowOffset()

NvsCaption::getShadowOffset ( )

inline

获取当前字幕阴影的偏移量。

返回

{PointF} 返回一个 PointF 对象，表示获得的字幕阴影偏移。

getText()

NvsCaption::getText ( )

inline

获取字幕文本。

返回

{String} 返回获得的字幕文本。

getTextAlignment()

NvsCaption::getTextAlignment ( )

inline

获取标题水平对齐样式

返回

{Number} 返回标题水平对齐样式。

getTextBoundingRect()

NvsCaption::getTextBoundingRect ( )

inline

获取标题文本矩形

返回

{RectF} 返回表示获得的标题文本矩形的 RectF 对象。

getTextColor()

NvsCaption::getTextColor ( )

inline

获取标题文本颜色

返回

{NvsColor} 返回表示获得的颜色值的 NvsColor 对象。

getTextSpanList()

NvsCaption::getTextSpanList ( )

inline

获取字幕layout属性列表

返回

{NvsVectorVal<NvsCaptionSpan>} layout属性列表

getTextVerticalAlignment()

NvsCaption::getTextVerticalAlignment ( )

inline

获取标题垂直对齐样式，仅对 frame-caption 有效。

返回

{Number} 返回标题垂直对齐样式。

getUnderline()

NvsCaption::getUnderline ( )

inline

获取标题下划线

返回

{Boolean} 返回布尔值。 true 表示在线下，false 表示不在线下。

getVerticalLayout()

NvsCaption::getVerticalLayout ( )

inline

获取是否垂直布局文本。

返回

{Boolean}

getWeight()

NvsCaption::getWeight ( )

inline

获取字幕重量

返回

{Number} 返回字幕权重。

getZValue()

NvsCaption::getZValue ( )

inline

获取标题 Z 值。

返回

{Number} 返回标题 Z值。

isFrameCaption()

NvsCaption::isFrameCaption ( )

inline

确定它是否是边框标题。

返回

{Boolean} 返回值为 true 表示边框标题

isLyrics()

NvsCaption::isLyrics ( )

inline

歌词与否

返回

{Boolean}

isModular()

NvsCaption::isModular ( )

inline

确定当前标题是否为模块化标题。

返回

{Boolean} 如果返回值为真，则为全景字幕。

isSpeedEnabled()

NvsCaption::isSpeedEnabled ( )

inline

是否开启变速

返回

{Boolean}

isTextColorChanged()

NvsCaption::isTextColorChanged ( )

inline

确定标题文本颜色是否改变。

返回

{void}

rotateCaption()

NvsCaption::rotateCaption (   angle,   anchor  )

inline

旋转字幕

参数

{Number}	angle 字幕旋转的角度。
{PointF}	anchor 字幕旋转的锚点。

返回

{void}

rotateCaption2()

NvsCaption::rotateCaption2 (   angle )

inline

以字幕中心点为锚点旋转字幕。

参数

{Number}

angle 字幕旋转的角度。

返回

{void}

scaleCaption()

NvsCaption::scaleCaption (   scaleFactor,   anchor  )

inline

缩放字幕。

参数

{Number}	scaleFactor 字幕比例系数。
{PointF}	anchor 字幕缩放锚。

返回

{void}

scaleCaption2()

NvsCaption::scaleCaption2 (   scaleFactor )

inline

在中心缩放标题

参数

{Number}

scaleFactor 比例系数

返回

{void}

setAnchorPoint()

NvsCaption::setAnchorPoint (   anchor )

inline

设置字幕锚。

参数

{PointF}

anchor 锚

返回

{void}

setBackgroundColor()

NvsCaption::setBackgroundColor (   backgroundColor )

inline

设置文本背景颜色。

参数

{NvsColor}

backgroundColor 背景颜色值。

返回

{void}

setBackgroundRadius()

NvsCaption::setBackgroundRadius (   radius )

inline

设置文本背景矩形的角半径。

参数

{Number}

radius 圆角半径值

返回

{void}

setBold()

NvsCaption::setBold (   bold )

inline

设置标题字体粗体

参数

{Boolean}

bold 指示标题字体是否为粗体。 true 表示字体是粗体，false 表示字体不是粗体。

返回

{void}

setCaptionTranslation()

NvsCaption::setCaptionTranslation (   translation )

inline

设置字幕平移量。

参数

{PointF}

translation 字幕的水平和垂直平移量绝对值。

返回

{void}

setCurrentKeyFrameTime()

NvsCaption::setCurrentKeyFrameTime (   time )

inline

设置标题 KeyFrameTime。

参数

{Number}

time 时间

返回

{void}

setDrawOutline()

NvsCaption::setDrawOutline (   drawOutline )

inline

设置字幕描边。

参数

{Boolean}

drawOutline 是否描边字幕。 True 表示描边标题。 False 表示不描边。

返回

{void}

setDrawShadow()

NvsCaption::setDrawShadow (   drawShadow )

inline

设置字幕阴影。

参数

{Boolean}

drawShadow 是否设置字幕阴影。 true 表示设置字幕阴影，false 表示不设置。

返回

{void}

setFontByFilePath()

NvsCaption::setFontByFilePath (   filePath )

inline

按文件路径设置字幕字体

参数

{String}

filePath 字幕字体的文件路径。如果设置为空字符串，则设置为默认字体。

返回

{void}

setFontFamily()

NvsCaption::setFontFamily (   family )

inline

设置标题字体系列

参数

{String}

family Caption font name. 如果给出一个空字符串，它将被设置为默认字体。

返回

{void}

setFontSize()

NvsCaption::setFontSize (   fontSize )

inline

设置字幕字体大小。

参数

{Number}

fontSize 字幕字体大小值

返回

{void}

setFrameCaptionMaxFontSize()

NvsCaption::setFrameCaptionMaxFontSize (   maxFontSize )

inline

设置边框标题的最大字体大小。只有边框标题可以使用此方法。

参数

{Number}

maxFontSize 最大字体大小

返回

{void}

setIsLyrics()

NvsCaption::setIsLyrics (   isLyrics )

inline

设置字幕歌词类型

参数

{Boolean}

isLyrics 是否歌词

返回

{void}

setItalic()

NvsCaption::setItalic (   italic )

inline

设置标题字体斜体。

参数

{Boolean}

italic 是否设置为斜体。 True 表示字幕字体设置为斜体，false 表示字幕字体未设置为斜体。

返回

{void}

setLetterSpacing()

NvsCaption::setLetterSpacing (   letterSpacing )

inline

设置标题字母间距

参数

{Number}

letterSpacing 字间距默认以百分比值表示。

返回

{void}

setLetterSpacingType()

NvsCaption::setLetterSpacingType (   letterSpacingType )

inline

设置标题字间距类型。

参数

{Number}

letterSpacingType 字间距类型。

返回

{void}

setLineSpacing()

NvsCaption::setLineSpacing (   lineSpacing )

inline

设置行距

参数

{Number}

lineSpacing 行间距以绝对值表示。

返回

{void}

setModularCaptionAnimationPeroid()

NvsCaption::setModularCaptionAnimationPeroid (   periodInMS )

inline

设置模块化字幕动画周期。

参数

{Number}

periodInMS 动画周期（毫秒）

返回

{void}

setModularCaptionInAnimationDuration()

NvsCaption::setModularCaptionInAnimationDuration (   inAnimationDurationInMS )

inline

设置模块化字幕动画持续时间。

参数

{Number}

inAnimationDurationInMS 动画持续时间（以毫秒为单位）

返回

{void}

setModularCaptionOutAnimationDuration()

NvsCaption::setModularCaptionOutAnimationDuration (   outAnimationDurationInMS )

inline

设置模块化字幕动画持续时间。

参数

{Number}

outAnimationDurationInMS 以毫秒为单位的动画持续时间

返回

{void}

setOpacity()

NvsCaption::setOpacity (   opacity )

inline

设置字幕不透明度。

参数

{Number}

opacity 字幕不透明度。

返回

{void}

setOutlineColor()

NvsCaption::setOutlineColor (   color )

inline

设置标题描边的颜色。

参数

{NvsColor}

color 字幕描边颜色值。

返回

{void}

参见

NvsColor

setOutlineWidth()

NvsCaption::setOutlineWidth (   outlineWidth )

inline

设置标题笔划的宽度。

参数

{Number}

outlineWidth 标题笔划的宽度。

返回

{void}

setRecordingUserOperation()

NvsCaption::setRecordingUserOperation (   recordingUserOperation )

inline

设置是否记录用户操作。

参数

{Boolean}

recordingUserOperation 是否记录用户操作

返回

{}

setRotationZ()

NvsCaption::setRotationZ (   angle )

inline

设置字幕的旋转角度。

参数

{Number}

angle 旋转角度。

返回

{void}

setScaleX()

NvsCaption::setScaleX (   scale )

inline

设置字幕的水平缩放系数。

参数

{Number}

scale 水平比例系数。

返回

{void}

setScaleY()

NvsCaption::setScaleY (   scale )

inline

设置标题的垂直比例系数。

参数

{Number}

scale 垂直比例系数。

返回

{void}

setShadowColor()

NvsCaption::setShadowColor (   color )

inline

设置字幕阴影颜色

参数

{NvsColor}

shadowColor 字幕阴影颜色值。

返回

{void}

setShadowFeather()

NvsCaption::setShadowFeather (   feather )

inline

设置字幕阴影的羽化程度。

参数

{Number}

feather 羽化度

返回

{void}

setShadowOffset()

NvsCaption::setShadowOffset (   offset )

inline

设置字幕阴影偏移

参数

{PointF}

offset 字幕阴影偏移。

返回

{void}

setText()

NvsCaption::setText (   text )

inline

设置标题文本。

参数

{String}

text 字幕文本

返回

{void}

setTextAlignment()

NvsCaption::setTextAlignment (   textAlign )

inline

设置标题水平对齐样式

参数

{Number}

textAlign 指示标题水平对齐方式

返回

{void}

setTextColor()

NvsCaption::setTextColor (   color )

inline

设置标题文字颜色

返回

{void}

参数

{NvsColor}

color 字幕文本颜色值。

返回

{void}

setTextFrameOriginRect()

NvsCaption::setTextFrameOriginRect (   rect )

inline

设置帧标题的原始帧大小。如果当前字幕不是帧字幕，则此功能无效。您可以获得原始帧大小。

参数

{NvsRectF}

rect 新的帧尺寸。

返回

{Number}

setTextSpanList()

NvsCaption::setTextSpanList (   spanList )

inline

用户可以指定字幕中位置从某一起始字符到某一结束字符之间，应用多种layout属性

参数

{NvsVectorVal<NvsCaptionSpan>}

spanList layout属性列表

返回

{void}

setTextVerticalAlignment()

NvsCaption::setTextVerticalAlignment (   textAlign )

inline

设置标题水平对齐样式

参数

{Number}

textAlign 指示标题水平对齐方式

返回

{void}

setUnderline()

NvsCaption::setUnderline (   underline )

inline

设置标题下划线

参数

{Boolean}

underline 是否设置为下划线。

返回

{void}

setVerticalLayout()

NvsCaption::setVerticalLayout (   verticalLayout )

inline

设置是否垂直布局文本。

参数

{Boolean}

verticalLayout 是否垂直布局文本

返回

{void}

setWeight()

NvsCaption::setWeight (   weight )

inline

设置字幕权重

参数

{Number}

weight opentype 权重整数中的值。

返回

{void}

setZValue()

NvsCaption::setZValue (   value )

inline

设置标题 Z 值。

参数

{Number}

value Z值

返回

{void}

translateCaption()

NvsCaption::translateCaption (   translationOffset )

inline

字幕平移。

参数

{PointF}

translationOffset 字幕的水平和垂直偏移值.

返回

{void}

---

该类的文档由以下文件生成:

• src/js/NvStreamingSdk.js