Class: NvsTimelineCaption

NvsTimelineCaption()

时间线字幕是视频上叠加的自定义文字。编辑视频时，可以添加和移除时间线字幕，并对字幕位置进行调整处理。添加完字幕，还可以进行样式设置，包括字体大小，颜色，阴影，描边等。

Constructor

new NvsTimelineCaption()

Source:

Extends

Methods

applyCaptionStyle(captionStylePackageId, isUseDefaultAssetParam)

应用字幕风格
Parameters:
Name Type Description
captionStylePackageId 字幕风格包ID
isUseDefaultAssetParam 使用默认的资源参数
Source:
Returns:

applyModularCaptionAnimation(captionAnimationPackageId)

应用模块字幕动画
Parameters:
Name Type Description
captionAnimationPackageId 字幕动画包ID
Source:
Returns:

applyModularCaptionContext(captionContextPackageId)

应用模块字幕上下文
Parameters:
Name Type Description
captionContextPackageId 字幕上下文包ID
Source:
Returns:

applyModularCaptionInAnimation(captionInAnimationPackageId)

应用模块字幕入动画
Parameters:
Name Type Description
captionInAnimationPackageId 字幕入动画包ID
Source:
Returns:

applyModularCaptionOutAnimation(captionOutAnimationPackageId)

应用模块字幕出动画
Parameters:
Name Type Description
captionOutAnimationPackageId 字幕出动画包ID
Source:
Returns:

applyModularCaptionRenderer(captionRendererPackageId)

应用模块字幕渲染
Parameters:
Name Type Description
captionRendererPackageId 字幕渲染包ID
Source:
Returns:

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:

getBackgroundColor()

获取背景颜色
Source:
Returns:

getBackgroundRadius()

获取背景半径
Source:
Returns:

getBold()

获取粗体
Source:
Returns:

getBooleanVal(fxParam)

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

getBooleanValAtTime(fxParam, time)

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

getBoundingRectangleVertices()

获取边界矩形顶点
Source:
Returns:

getCaptionBoundingVertices(boundingType)

获取字幕边界顶点
Parameters:
Name Type Description
boundingType 边界类型
Source:
Returns:

getCaptionStylePackageId()

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

getCaptionTranslation()

获取字幕转场
Source:
Returns:

getCategory()

获取分类
Source:
Returns:

getColorVal(fxParam)

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

getColorValAtTime(fxParam, time)

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

getDescription()

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

getDrawOutline()

获取绘制轮廓
Source:
Returns:

getDrawShadow()

获取绘制阴影
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()

获取字体家族
Source:
Returns:

getFontFilePath()

获取字体文件路径
Source:
Returns:

getFontSize()

获取字体大小
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:

getItalic()

获取斜体
Source:
Returns:

getLetterSpacing()

获取字符间距
Source:
Returns:

getLetterSpacingType()

获取字符间距类型
Source:
Returns:

getLineSpacing()

获取行距
Source:
Returns:

getMenuVal(fxParam)

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

getMenuValAtTime(fxParam, time)

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

getModularCaptionAnimationPackageId()

获取模块字幕动画包ID
Source:
Returns:

getModularCaptionAnimationPeroid()

获取模块字幕动画周期
Source:
Returns:

getModularCaptionContextPackageId()

获取模块化字幕上下文包 ID
Source:
Returns:

getModularCaptionInAnimationDuration()

设置模块字幕入动画时长
Source:
Returns:

getModularCaptionInAnimationPackageId()

获取模块字幕入动画包ID
Source:
Returns:

getModularCaptionOutAnimationDuration()

获取模块字幕出动画持续时长
Source:
Returns:

getModularCaptionOutAnimationPackageId()

获取模块字幕出动画包ID
Source:
Returns:

getModularCaptionRendererPackageId()

获取模块字幕渲染包ID
Source:
Returns:

getOpacity()

获取不透明度
Source:
Returns:

getOutlineColor()

获取轮廓颜色
Source:
Returns:

getOutlineWidth()

获取轮廓宽度
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:

getRoleInTheme()

获取主题角色
Source:
Returns:

getRotationZ()

获取Z方向旋转
Source:
Returns:

getScaleX()

获取X方向缩放
Source:
Returns:

getScaleY()

获取Y方向缩放
Source:
Returns:

getShadowColor()

获取阴影颜色
Source:
Returns:

getShadowFeather()

获取阴影羽化
Source:
Returns:

getShadowOffset()

获得阴影偏移
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()

获取字幕文本
Source:
Returns:

getTextAlignment()

获取文本对齐方式
Source:
Returns:

getTextBoundingRect()

获取文本边界矩形
Source:
Returns:

getTextColor()

获取文本颜色
Source:
Returns:

getUnderline()

获取下划线
Source:
Returns:

getWeight()

获取字重
Source:
Returns:

getZValue()

获取Z值
Source:
Returns:

hasKeyframeList(fxParam)

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

isFrameCaption()

是否帧字幕
Source:
Returns:

isLyrics()

是否是歌词
Source:
Returns:

isModular()

是否是模块化
Source:
Returns:

isTextColorChanged()

是否文本颜色改变
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:

scaleCaption2(scaleFactor)

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

setAnchorPoint(anchor)

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

setBackgroundColor(backgroundColor)

设置背景颜色
Parameters:
Name Type Description
backgroundColor 背景颜色
Source:
Returns:

setBackgroundRadius(radius)

设置背景半径
Parameters:
Name Type Description
radius 半径
Source:
Returns:

setBold(bold)

设置粗体
Parameters:
Name Type Description
bold 粗体
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:

setCurrentKeyFrameTime(time)

设置当前关键帧时间
Parameters:
Name Type Description
time 时间
Source:
Returns:

setDrawOutline(drawOutline)

设置绘制轮廓
Parameters:
Name Type Description
drawOutline 下划线
Source:
Returns:

setDrawShadow(drawShadow)

设置绘制阴影
Parameters:
Name Type Description
drawShadow 绘制阴影
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:

setFontByFilePath(filePath)

根据文件路径设置字体
Parameters:
Name Type Description
filePath 文件路径
Source:
Returns:

setFontFamily(family)

设置字体家族
Parameters:
Name Type Description
family 字体家族
Source:
Returns:

setFontSize(fontSize)

设置字体大小
Parameters:
Name Type Description
fontSize 字体大小
Source:
Returns:

setFrameCaptionMaxFontSize(maxFontSize)

设置帧字幕最大字体大小
Parameters:
Name Type Description
maxFontSize 最大字体大小
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:

setIsLyrics(isLyrics)

设置是否是歌词
Parameters:
Name Type Description
isLyrics 是否是歌词
Source:
Returns:

setItalic(italic)

设置斜体
Parameters:
Name Type Description
italic 斜体
Source:
Returns:

setLetterSpacing(letterSpacing)

设置字符间距
Parameters:
Name Type Description
letterSpacing 字符间距
Source:
Returns:

setLetterSpacingType(letterSpacingType)

设置字符间距类型
Parameters:
Name Type Description
letterSpacingType 类型标识
Source:
Returns:

setLineSpacing(lineSpacing)

设置行距
Parameters:
Name Type Description
lineSpacing 行间距
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:

setModularCaptionAnimationPeroid(periodInMS)

设置模块字幕动画周期
Parameters:
Name Type Description
periodInMS 周期时间，毫秒计数
Source:
Returns:

setModularCaptionInAnimationDuration(inAnimationDurationInMS)

设置模块字幕入动画时长
Parameters:
Name Type Description
inAnimationDurationInMS 入动画时长，毫秒计数
Source:
Returns:

setModularCaptionOutAnimationDuration(outAnimationDurationInMS)

设置模块字幕出动画时长
Parameters:
Name Type Description
outAnimationDurationInMS 出动画时长，毫秒计数
Source:
Returns:

setOpacity(opacity)

设置不透明度
Parameters:
Name Type Description
opacity 不透明度
Source:
Returns:

setOutlineColor(color)

设置轮廓颜色
Parameters:
Name Type Description
color 颜色
Source:
Returns:

setOutlineWidth(outlineWidth)

设置轮廓宽度
Parameters:
Name Type Description
outlineWidth 轮廓宽度
Source:
Returns:

setRecordingUserOperation(recordingUserOperation)

设置录制用户操作
Parameters:
Name Type Description
recordingUserOperation 记录用户操作
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:

setShadowColor(color)

设置阴影颜色
Parameters:
Name Type Description
color 背景颜色
Source:
Returns:

setShadowFeather(feather)

设置阴影羽化
Parameters:
Name Type Description
feather 羽化
Source:
Returns:

setShadowOffset(offset)

设置阴影偏移
Parameters:
Name Type Description
offset 偏移量
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(text)

设置字幕文本
Parameters:
Name Type Description
text 文本字符串
Source:
Returns:
text

setTextAlignment(textAlign)

设置文本对齐方式
Parameters:
Name Type Description
textAlign 对齐方式
Source:
Returns:

setTextColor(color)

设置文本颜色
Parameters:
Name Type Description
color 文字颜色
Source:
Returns:

setTextFrameOriginRect(rect)

设置文本框原点矩形
Parameters:
Name Type Description
rect 矩形
Source:
Returns:

setUnderline(underline)

设置下划线
Parameters:
Name Type Description
underline 下划线
Source:
Returns:

setWeight(weight)

设置字重
Parameters:
Name Type Description
weight 字重
Source:
Returns:

setZValue(value)

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

translateCaption(translationOffset)

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