Class: NvsTimelineCompoundCaption

NvsTimelineCompoundCaption()

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

Constructor

new NvsTimelineCompoundCaption()

Source:

Extends

Methods

changeInPoint(newInPoint)

改变入点
Parameters:
Name Type Description
newInPoint 新入点
Source:
Returns:

changeOutPoint(newOutPoint)

改变出点
Parameters:
Name Type Description
newOutPoint 新出点
Source:
Returns:

clearExprVar()

清除Expr值
Overrides:
Source:
Returns:

clearExprVarCtx()

清空表达式中定义的全部参数的值，并设置为默认值0
Overrides:
Source:
Returns:

findKeyframeTime(fxParam, time, flags)

在某个时间查询关键帧
Parameters:
Name Type Description
fxParam 特效参数
time 时间点
flags 标识
Overrides:
Source:
Returns:

getAnchorPoint()

获取锚点
Source:
Returns:

getARSceneManipulate()

获取ARScene操作
Overrides:
Source:
Returns:

getBooleanVal(fxParam)

获取布尔值
Parameters:
Name Type Description
fxParam 特效参数
Overrides:
Source:
Returns:

getBooleanValAtTime(fxParam, time)

在某个时间获取布尔值
Parameters:
Name Type Description
fxParam 特效参数
time 时间
Overrides:
Source:
Returns:

getCaptionBoundingVertices(captionIndex, boudingType, motionParams)

获取字幕边界顶点
Parameters:
Name Type Description
captionIndex 字幕索引
boudingType 边界类型
motionParams 运动参数
Source:
Returns:

getCaptionCount()

获取字幕数量
Source:
Returns:

getCaptionStylePackageId()

获取字幕风格包ID
Source:
Returns:

getCaptionTranslation()

获取字幕平移
Source:
Returns:

getColorVal(fxParam)

获取颜色值
Parameters:
Name Type Description
fxParam 特效参数
Overrides:
Source:
Returns:

getColorValAtTime(fxParam, time)

在某个时间点获取颜色值
Parameters:
Name Type Description
fxParam 特效参数
time 时间点
Overrides:
Source:
Returns:

getCompoundBoundingVertices(boudingType, motionParams)

获取组合边界顶点
Parameters:
Name Type Description
boudingType 边界类型
motionParams 运动参数
Source:
Returns:

getDescription()

获取描述信息
Overrides:
Source:
Returns:

getExprVar(varName)

获取Expr值
Parameters:
Name Type Description
varName 变量名字
Overrides:
Source:
Returns:

getFilterIntensity()

获取滤镜强度
Overrides:
Source:
Returns:

getFloatVal(fxParam)

获取浮点值
Parameters:
Name Type Description
fxParam 特效参数
Overrides:
Source:
Returns:

getFloatValAtTime(fxParam, time)

在某个时间获取浮点值
Parameters:
Name Type Description
fxParam 特效参数
time 时间
Overrides:
Source:
Returns:

getFontFamily(captionIndex)

获取字体家族
Parameters:
Name Type Description
captionIndex 字幕索引
Source:
Returns:

getIgnoreBackground()

获取忽略背景
Overrides:
Source:
Returns:

getInPoint()

获取入点
Source:
Returns:

getInternalObject() → {Num}

获取内置对象
Overrides:
Source:
Returns:
Type
Num

getIntVal(fxParam)

获取整数值
Parameters:
Name Type Description
fxParam 特效参数
Overrides:
Source:
Returns:

getIntValAtTime(fxParam, time)

在某个时间获取整数值
Parameters:
Name Type Description
fxParam 特效参数
time 时间
Overrides:
Source:
Returns:

getInverseRegion()

获取反转区域
Overrides:
Source:
Returns:

getMenuVal(fxParam)

获取菜单值
Parameters:
Name Type Description
fxParam 特效参数
Overrides:
Source:
Returns:

getMenuValAtTime(fxParam, time)

在某个时间获取菜单值
Parameters:
Name Type Description
fxParam 特效参数
time 时间点
Overrides:
Source:
Returns:

getOpacity()

获取不透明度
Source:
Returns:

getOutPoint()

获取出点
Source:
Returns:

getParticleSystemContext()

获取粒子系统上下文
Overrides:
Source:
Returns:

getRegional()

获取区域范围
Overrides:
Source:
Returns:

getRegionalFeatherWidth()

获取区域羽化宽度
Overrides:
Source:
Returns:

getRegionInfos()

获取区域信息
Overrides:
Source:
Returns:

getRegionInfosAtTime(time)

在某个时间点获取区域信息
Parameters:
Name Type Description
time 时间点
Overrides:
Source:
Returns:

getRotationZ()

获取Z方向旋转
Source:
Returns:

getScaleX()

获取X方向缩放
Source:
Returns:

getScaleY()

获取Y方向缩放
Source:
Returns:

getStringVal(fxParam)

获取字符串值
Parameters:
Name Type Description
fxParam 特效参数
Overrides:
Source:
Returns:

getStringValAtTime(fxParam, time)

在某个时间获取字符串值
Parameters:
Name Type Description
fxParam 特效参数
time 时间点
Overrides:
Source:
Returns:

getTemplateAttachment(key) → {Num}

根据键，获取模板属性值
Parameters:
Name Type Description
key 键
Overrides:
Source:
Returns:
Type
Num

getText(captionIndex)

获取文本
Parameters:
Name Type Description
captionIndex 字幕索引
Source:
Returns:

getTextColor(captionIndex)

获取文本颜色
Parameters:
Name Type Description
captionIndex 字幕索引
Source:
Returns:

getZValue()

获取Z值
Source:
Returns:

hasKeyframeList(fxParam)

是否有关键帧列表
Parameters:
Name Type Description
fxParam 特效参数
Overrides:
Source:
Returns:

isFrameCaption(captionIndex)

是否帧字幕
Parameters:
Name Type Description
captionIndex 字幕索引
Source:
Returns:

movePosition(offset)

移动位置
Parameters:
Name Type Description
offset 偏移量
Source:
Returns:

removeAllKeyframe(fxParam)

删除所有关键帧
Parameters:
Name Type Description
fxParam 特效参数
Overrides:
Source:
Returns:

removeKeyframeAtTime(fxParam, time)

在某个时间删除关键帧
Parameters:
Name Type Description
fxParam 特效参数
time 时间点
Overrides:
Source:
Returns:

rotateCaption(angle, anchor)

旋转字幕
Parameters:
Name Type Description
angle 角度
anchor 锚点
Source:
Returns:

rotateCaption2(angle)

旋转字幕
Parameters:
Name Type Description
angle 角度
Source:
Returns:

scaleCaption(scaleFactor, anchor)

缩放字幕
Parameters:
Name Type Description
scaleFactor 缩放因子
anchor 锚点
Source:
Returns:

setAnchorPoint(anchor)

设置锚点
Parameters:
Name Type Description
anchor 锚点
Source:
Returns:

setBooleanVal(fxParam, val)

设置布尔值
Parameters:
Name Type Description
fxParam 特效参数
val 具体值
Overrides:
Source:
Returns:

setBooleanValAtTime(fxParam, val, time)

在某个时间设置布尔值
Parameters:
Name Type Description
fxParam 特效参数
val 具体值
time 时间
Overrides:
Source:
Returns:

setCaptionTranslation(translation)

设置字幕平移
Parameters:
Name Type Description
translation 转场
Source:
Returns:

setColorVal(fxParam, val)

设置颜色值
Parameters:
Name Type Description
fxParam 特效参数
val 颜色值
Overrides:
Source:
Returns:

setColorValAtTime(fxParam, val, time)

在某个时间设置颜色
Parameters:
Name Type Description
fxParam 特效参数
val 颜色值
time 时间点
Overrides:
Source:
Returns:

setEllipseRegion(center, a, b, angle)

设置椭圆区域
Parameters:
Name Type Description
center 居中
a 长半轴
b 短半轴
angle 角度
Overrides:
Source:
Returns:

setEllipseRegionAtTime(center, a, b, angle, time)

在某个时间点设置椭圆区域
Parameters:
Name Type Description
center 居中
a 长半轴
b 短半轴
angle 角度
time 时间
Overrides:
Source:
Returns:

setExprVar(varName, varValue)

设置Expr变量
Parameters:
Name Type Description
varName 变量名字
varValue 变量值
Overrides:
Source:
Returns:

setFilterIntensity(intensity)

设置滤镜强度
Parameters:
Name Type Description
intensity 强度值
Overrides:
Source:
Returns:

setFloatVal(fxParam, val)

设置浮点值
Parameters:
Name Type Description
fxParam 特效参数
val 值
Overrides:
Source:
Returns:

setFloatValAtTime(fxParam, val, time)

在某个时间设置浮点值
Parameters:
Name Type Description
fxParam 特效参数值
val 值
time 时间点
Overrides:
Source:
Returns:

setFontFamily(captionIndex, family)

设置字体家族
Parameters:
Name Type Description
captionIndex 字幕索引
family 字体家族
Source:
Returns:

setIgnoreBackground(isIgnoreBackground)

设置忽略背景
Parameters:
Name Type Description
isIgnoreBackground 是否忽略背景
Overrides:
Source:
Returns:

setInternalObject(obj) → {Num}

设置内置对象
Parameters:
Name Type Description
obj
Overrides:
Source:
Returns:
Type
Num

setIntVal(fxParam, val)

设置整数值
Parameters:
Name Type Description
fxParam 特效参数
val 值
Overrides:
Source:
Returns:

setIntValAtTime(fxParam, val, time)

在某个时间设置整数值
Parameters:
Name Type Description
fxParam 特效参数
val 值
time 时间
Overrides:
Source:
Returns:

setInverseRegion(isInverseRegion)

设置反转区域
Parameters:
Name Type Description
isInverseRegion 是否反转区域
Overrides:
Source:
Returns:

setMenuVal(fxParam, val)

设置菜单值
Parameters:
Name Type Description
fxParam 特效参数
val 菜单值
Overrides:
Source:
Returns:

setMenuValAtTime(fxParam, val, time)

在某个时间设置菜单值
Parameters:
Name Type Description
fxParam 特效参数
val 值
time 时间点
Overrides:
Source:
Returns:

setOpacity(value)

设置不透明度
Parameters:
Name Type Description
value 不透明度大小
Source:
Returns:

setRegion(region)

设置区域
Parameters:
Name Type Description
region 区域对象
Overrides:
Source:
Returns:

setRegional(isRegional)

设置区域
Parameters:
Name Type Description
isRegional 是区域的
Overrides:
Source:
Returns:

setRegionalFeatherWidth(featherWidth)

设置区域羽化宽度
Parameters:
Name Type Description
featherWidth 宽度值
Overrides:
Source:
Returns:

setRegionAtTime(region, time)

在某个时间设置区域
Parameters:
Name Type Description
region 区域对象
time 时间点
Overrides:
Source:
Returns:

setRotationZ(angle)

设置Z方向旋转
Parameters:
Name Type Description
angle 角度
Source:
Returns:

setScaleX(scale)

设置X方向缩放
Parameters:
Name Type Description
scale 缩放
Source:
Returns:

setScaleY(scale)

设置Y方向缩放
Parameters:
Name Type Description
scale 缩放
Source:
Returns:

setStringVal(fxParam, val)

设置字符串值
Parameters:
Name Type Description
fxParam 特效参数
val 字符串值
Overrides:
Source:
Returns:

setStringValAtTime(fxParam, val, time)

在某个时间点设置字符串值
Parameters:
Name Type Description
fxParam 特效参数
val 字符串值
time 时间点
Overrides:
Source:
Returns:

setTemplateAttachment(key, value) → {Num}

设置模板附件
Parameters:
Name Type Description
key 键
value 值
Overrides:
Source:
Returns:
Type
Num

setText(captionIndex, text)

设置文本
Parameters:
Name Type Description
captionIndex 字幕索引
text 文本
Source:
Returns:

setTextColor(captionIndex, color)

设置文本颜色
Parameters:
Name Type Description
captionIndex 字幕索引
color 颜色
Source:
Returns:

setZValue(value)

设置Z值
Parameters:
Name Type Description
value Z值大小
Source:
Returns:

translateCaption(translationOffset)

平移字幕
Parameters:
Name Type Description
translationOffset 转场偏移
Source:
Returns: