时间线复合字幕。时间线复合字幕是视频上叠加的组合型文字，每个复合字幕包含若干个子字幕。编辑视频时，可以添加和移除时间线复合字幕，并对字幕位置进行调整处理，还可以对字体，颜色属性进行修改。更多...

类 NvsCompoundCaption 继承关系图:

Public 成员函数
	constructor ()

	getCaptionCount ()
	获取字幕数量更多...

	setText (captionIndex, text)
	设置文本更多...

	getText (captionIndex)
	获取文本更多...

	setTextColor (captionIndex, color)
	设置文本颜色更多...

	getTextColor (captionIndex)
	获取文本颜色更多...

	setFontFamily (captionIndex, family)
	设置字体家族更多...

	getFontFamily (captionIndex)
	获取字体家族更多...

	setCaptionTranslation (translation)
	设置字幕平移更多...

	getCaptionTranslation ()
	获取字幕平移更多...

	translateCaption (translationOffset)
	平移字幕更多...

	setAnchorPoint (anchor)
	设置锚点更多...

	getAnchorPoint ()
	获取锚点更多...

	setScaleX (scale)
	设置X方向缩放更多...

	getScaleX ()
	获取X方向缩放更多...

	setScaleY (scale)
	设置Y方向缩放更多...

	getScaleY ()
	获取Y方向缩放更多...

	scaleCaption (scaleFactor, anchor)
	缩放字幕更多...

	setRotationZ (angle)
	设置Z方向旋转更多...

	getRotationZ ()
	获取Z方向旋转更多...

	rotateCaption (angle, anchor)
	旋转字幕更多...

	rotateCaption2 (angle)
	旋转字幕更多...

	getCaptionBoundingVertices (captionIndex, boudingType, motionParams)
	获取字幕边界顶点更多...

	getCompoundBoundingVertices (boudingType, motionParams)
	获取组合边界顶点更多...

	setZValue (value)
	设置Z值更多...

	getZValue ()
	获取Z值更多...

	setOpacity (value)
	设置不透明度更多...

	getOpacity ()
	获取不透明度更多...

	isFrameCaption (captionIndex)
	是否帧字幕更多...

	getCaptionStylePackageId ()
	获取字幕风格包ID 更多...

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

成员函数说明

◆ constructor()

NvsCompoundCaption::constructor ( )

inline

@constructor

◆ getAnchorPoint()

NvsCompoundCaption::getAnchorPoint ( )

inline

获取锚点

返回: {PointF} 返回字幕锚。

◆ getCaptionBoundingVertices()

NvsCompoundCaption::getCaptionBoundingVertices	(	captionIndex,
		boudingType,
		motionParams
	)

inline

获取字幕边界顶点

参数

{Number}	captionIndex 字幕索引
{Number}	boundingType 边界类型
{NvsMotionParameters}	motionParams 运动参数

返回: {NvsVectorVal} 返回NSArray对象，对象类型为NSValue，实际数据类型为CGPoint，分别对应原始边界的左上、左下、右下、右上顶点。

参见: NvsMotionParameters; NvsVectorVal

◆ getCaptionCount()

NvsCompoundCaption::getCaptionCount ( )

inline

获取字幕数量

返回: {Number} 返回字幕的数量

◆ getCaptionStylePackageId()

NvsCompoundCaption::getCaptionStylePackageId ( )

inline

获取字幕风格包ID

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

◆ getCaptionTranslation()

NvsCompoundCaption::getCaptionTranslation ( )

inline

获取字幕平移

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

◆ getCompoundBoundingVertices()

NvsCompoundCaption::getCompoundBoundingVertices	(	boudingType,
		motionParams
	)

inline

获取组合边界顶点

参数

{Number}	boudingType 边界类型
{NvsMotionParameters}	motionParams 运动参数

返回: {NvsVectorVal} 返回NSArray对象，对象类型为NSValue，实际数据类型为CGPoint，分别对应原始边界的左上、左下、右下、右上顶点。

参见: NvsVectorVal

◆ getFontFamily()

NvsCompoundCaption::getFontFamily ( captionIndex )

inline

获取字体家族

参数

{Number} captionIndex 字幕索引

返回: {String}

◆ getOpacity()

NvsCompoundCaption::getOpacity ( )

inline

获取不透明度

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

◆ getRotationZ()

NvsCompoundCaption::getRotationZ ( )

inline

获取Z方向旋转

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

◆ getScaleX()

NvsCompoundCaption::getScaleX ( )

inline

获取X方向缩放

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

◆ getScaleY()

NvsCompoundCaption::getScaleY ( )

inline

获取Y方向缩放

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

◆ getText()

NvsCompoundCaption::getText ( captionIndex )

inline

获取文本

参数

{Number} captionIndex 字幕索引

返回: {String} 返回字幕文本。

◆ getTextColor()

NvsCompoundCaption::getTextColor ( captionIndex )

inline

获取文本颜色

参数

{Number} captionIndex 字幕索引

返回: {NvsColor} 返回 NvsColor 对象，它是文本颜色

◆ getZValue()

NvsCompoundCaption::getZValue ( )

inline

获取Z值

返回: {Number}

◆ isFrameCaption()

NvsCompoundCaption::isFrameCaption ( captionIndex )

inline

是否帧字幕

参数

{Number} captionIndex 字幕索引

返回: {Boolean} 返回值为 true 表示边框字幕

◆ rotateCaption()

NvsCompoundCaption::rotateCaption	(	angle,
		anchor
	)

inline

旋转字幕

参数

{Number}	angle 角度
{PointF}	anchor 锚点

返回: {void}

◆ rotateCaption2()

NvsCompoundCaption::rotateCaption2 ( angle )

inline

旋转字幕

参数

{Number} angle 角度

返回: {void}

◆ scaleCaption()

NvsCompoundCaption::scaleCaption	(	scaleFactor,
		anchor
	)

inline

缩放字幕

参数

{Number}	scaleFactor 缩放系数
{PointF}	anchor 锚点

返回: {void}

◆ setAnchorPoint()

NvsCompoundCaption::setAnchorPoint ( anchor )

inline

设置锚点

参数

{PointF} anchor 锚点

返回: {void}

◆ setCaptionTranslation()

NvsCompoundCaption::setCaptionTranslation ( translation )

inline

设置字幕平移

参数

{PointF} translation 转场

返回: {void}

◆ setFontFamily()

NvsCompoundCaption::setFontFamily	(	captionIndex,
		family
	)

inline

设置字体家族

参数

{Number}	captionIndex 字幕索引
{String}	family 字体家族

返回: {void}

◆ setOpacity()

NvsCompoundCaption::setOpacity ( value )

inline

设置不透明度

参数

{Number} value 不透明度大小

返回: {void}

◆ setRotationZ()

NvsCompoundCaption::setRotationZ ( angle )

inline

设置Z方向旋转

参数

{Number} angle 角度

返回: {void}

◆ setScaleX()

NvsCompoundCaption::setScaleX ( scale )

inline

设置X方向缩放

参数

{Number} scale 缩放

返回: {void}

◆ setScaleY()

NvsCompoundCaption::setScaleY ( scale )

inline

设置Y方向缩放

参数

{Number} scale 缩放

返回: {void}

◆ setText()

NvsCompoundCaption::setText	(	captionIndex,
		text
	)

inline

设置文本

参数

{Number}	captionIndex 字幕索引
{String}	text 文本

返回: {void} 文字内容

◆ setTextColor()

NvsCompoundCaption::setTextColor	(	captionIndex,
		color
	)

inline

设置文本颜色

参数

{Number}	captionIndex 字幕索引
{NvsColor}	color 颜色

返回: {void}

◆ setZValue()

NvsCompoundCaption::setZValue ( value )

inline

设置Z值

参数

{Number} value Z值大小

返回: {void}

◆ translateCaption()

NvsCompoundCaption::translateCaption ( translationOffset )

inline

平移字幕

参数

{PointF} translationOffset 转场偏移

返回: {void}

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

src/js/NvStreamingSdk.js

Public 成员函数

详细描述

成员函数说明

◆ constructor()

◆ getAnchorPoint()

◆ getCaptionBoundingVertices()

◆ getCaptionCount()

◆ getCaptionStylePackageId()

◆ getCaptionTranslation()

◆ getCompoundBoundingVertices()

◆ getFontFamily()

◆ getOpacity()

◆ getRotationZ()

◆ getScaleX()

◆ getScaleY()

◆ getText()

◆ getTextColor()

◆ getZValue()

◆ isFrameCaption()

◆ rotateCaption()

◆ rotateCaption2()

◆ scaleCaption()

◆ setAnchorPoint()

◆ setCaptionTranslation()

◆ setFontFamily()

◆ setOpacity()

◆ setRotationZ()

◆ setScaleX()

◆ setScaleY()

◆ setText()

◆ setTextColor()

◆ setZValue()

◆ translateCaption()