Class: NvsTimelineCaption

NvsTimelineCaption()

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.

Constructor

new NvsTimelineCaption()

Source:

Extends

Methods

applyCaptionStyle(captionStylePackageId, isUseDefaultAssetParam)

apply caption style
Parameters:
Name Type Description
captionStylePackageId caption style package id
isUseDefaultAssetParam use resource parameter of default
Source:
Returns:

applyModularCaptionAnimation(captionAnimationPackageId)

apply modular caption animation
Parameters:
Name Type Description
captionAnimationPackageId caption animation package id
Source:
Returns:

applyModularCaptionContext(captionContextPackageId)

apply modular caption context
Parameters:
Name Type Description
captionContextPackageId caption context package id
Source:
Returns:

applyModularCaptionInAnimation(captionInAnimationPackageId)

apply modular caption in animation
Parameters:
Name Type Description
captionInAnimationPackageId caption in animation package id
Source:
Returns:

applyModularCaptionOutAnimation(captionOutAnimationPackageId)

apply modular caption out animation
Parameters:
Name Type Description
captionOutAnimationPackageId caption out animation package id
Source:
Returns:

applyModularCaptionRenderer(captionRendererPackageId)

apply modular caption renderer
Parameters:
Name Type Description
captionRendererPackageId caption context package id
Source:
Returns:

changeInPoint(newInPoint) → {Number}

Changes the in-point of the caption on the timeline.
Parameters:
Name Type Description
newInPoint Number The new in-point of the caption on the timeline (in microseconds).
Source:
Returns:
Returns the in-point of the caption on the timeline (in microseconds).
Type
Number

changeOutPoint(newOutPoint) → {Number}

Changes the out-point of the caption on the timeline.
Parameters:
Name Type Description
newOutPoint Number The new out-point of the caption on the timeline (in microseconds).
Source:
Returns:
Returns the out-point of the caption on the timeline (in microseconds).
Type
Number

clearExprVar()

clear Expr value
Overrides:
Source:
Returns:

clearExprVarCtx()

clear all Expr value
Overrides:
Source:
Returns:

findKeyframeTime(fxParam, time, flags)

find key frame at certain time
Parameters:
Name Type Description
fxParam name of parameter
time time
flags flags
Overrides:
Source:
Returns:

getAnchorPoint()

Get caption anchor.
Source:
Returns:

getARSceneManipulate()

get ARScene operation
Overrides:
Source:
Returns:

getBackgroundColor()

Get text background color.
Source:
Returns:

getBackgroundRadius()

Get text background rectangle's corner radius.
Source:
Returns:

getBold()

Get the caption font bold state
Source:
Returns:

getBooleanVal(fxParam)

get boolean value
Parameters:
Name Type Description
fxParam name of parameter
Overrides:
Source:
Returns:

getBooleanValAtTime(fxParam, time)

get boolean value at certain time
Parameters:
Name Type Description
fxParam name of parameter
time time
Overrides:
Source:
Returns:

getBoundingRectangleVertices()

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

getCaptionBoundingVertices(boundingType)

Get the transformed vertices position of the original caption bounding.
Parameters:
Name Type Description
boundingType Bounding type
Source:
Returns:

getCaptionStylePackageId()

get caption style package id
Source:
Returns:

getCaptionTranslation()

Get the amount of caption translation.
Source:
Returns:

getCategory()

get category
Source:
Returns:

getColorVal(fxParam)

get color value
Parameters:
Name Type Description
fxParam name of parameter
Overrides:
Source:
Returns:

getColorValAtTime(fxParam, time)

get color value at certain time
Parameters:
Name Type Description
fxParam name of parameter
time time
Overrides:
Source:
Returns:

getDescription()

get description information
Overrides:
Source:
Returns:

getDrawOutline()

Get caption stroke.
Source:
Returns:

getDrawShadow()

Get caption shadows.
Source:
Returns:

getExprVar(varName)

get Expr value
Parameters:
Name Type Description
varName variable name
Overrides:
Source:
Returns:

getFilterIntensity()

get filter intensity
Overrides:
Source:
Returns:

getFloatVal(fxParam)

get float value
Parameters:
Name Type Description
fxParam name of parameter
Overrides:
Source:
Returns:

getFloatValAtTime(fxParam, time)

get float value at certain time
Parameters:
Name Type Description
fxParam name of parameter
time time
Overrides:
Source:
Returns:

getFontFamily()

Get caption font family
Source:
Returns:

getFontFilePath()

Get caption font file path
Source:
Returns:

getFontSize()

Get caption font size.
Source:
Returns:

getIgnoreBackground()

get ignore background
Overrides:
Source:
Returns:

getInPoint() → {Number}

Get the in-point of the caption on the timeline.
Source:
Returns:
The in-point of the caption on the timeline (in microseconds).
Type
Number

getInternalObject() → {Num}

get internal object
Overrides:
Source:
Returns:
Type
Num

getIntVal(fxParam)

get integer value
Parameters:
Name Type Description
fxParam name of parameter
Overrides:
Source:
Returns:

getIntValAtTime(fxParam, time)

get integer value at certain time
Parameters:
Name Type Description
fxParam name of parameter
time time
Overrides:
Source:
Returns:

getInverseRegion()

get region in reverse
Overrides:
Source:
Returns:

getItalic()

Get caption font italic.
Source:
Returns:

getLetterSpacing()

Get caption letter spacing
Source:
Returns:

getLetterSpacingType()

Get caption word spacing type.
Source:
Returns:

getLineSpacing()

Get line spacing
Source:
Returns:

getMenuVal(fxParam)

get menu value
Parameters:
Name Type Description
fxParam name of parameter
Overrides:
Source:
Returns:

getMenuValAtTime(fxParam, time)

get menu value at certain time
Parameters:
Name Type Description
fxParam name of parameter
time time
Overrides:
Source:
Returns:

getModularCaptionAnimationPackageId()

get modular caption animation package id
Source:
Returns:

getModularCaptionAnimationPeroid()

get modular caption animation period
Source:
Returns:

getModularCaptionContextPackageId()

get modular caption context package id
Source:
Returns:

getModularCaptionInAnimationDuration()

get modular caption in animation duration
Source:
Returns:

getModularCaptionInAnimationPackageId()

get modular caption in animation package id
Source:
Returns:

getModularCaptionOutAnimationDuration()

get modular caption out animation duration
Source:
Returns:

getModularCaptionOutAnimationPackageId()

get modular caption out animation package id
Source:
Returns:

getModularCaptionRendererPackageId()

get modular caption renderer package id
Source:
Returns:

getOpacity()

Get caption opacity.
Source:
Returns:

getOutlineColor()

Get the color of the caption stroke.
Source:
Returns:

getOutlineWidth()

Get the width of the caption stroke.
Source:
Returns:

getOutPoint() → {Number}

Get the out-point of the caption on the timeline.
Source:
Returns:
The out-point of the caption on the timeline (in microseconds).
Type
Number

getParticleSystemContext()

get particle system context
Overrides:
Source:
Returns:

getRegional()

get regional
Overrides:
Source:
Returns:

getRegionalFeatherWidth()

get regional feather width
Overrides:
Source:
Returns:

getRegionInfos()

get region
Overrides:
Source:
Returns:

getRegionInfosAtTime(time)

get region information at certain time
Parameters:
Name Type Description
time time
Overrides:
Source:
Returns:

getRoleInTheme()

get role in theme
Source:
Returns:

getRotationZ()

Get rotation angle for caption.
Source:
Returns:

getScaleX()

Get horizontal scaling factor for caption.
Source:
Returns:

getScaleY()

Get vertical scaling factor for caption.
Source:
Returns:

getShadowColor()

Get caption shadow color
Source:
Returns:

getShadowFeather()

Get the feathering degree of the caption shadow.
Source:
Returns:

getShadowOffset()

Get caption shadow offset
Source:
Returns:

getStringVal(fxParam)

get character string
Parameters:
Name Type Description
fxParam name of parameter
Overrides:
Source:
Returns:

getStringValAtTime(fxParam, time)

get string value at certain time
Parameters:
Name Type Description
fxParam name of parameter
time time
Overrides:
Source:
Returns:

getTemplateAttachment(key) → {Num}

get template attachment according key
Parameters:
Name Type Description
key key
Overrides:
Source:
Returns:
Type
Num

getText()

get caption text
Source:
Returns:

getTextAlignment()

Get caption horizontal alignment style
Source:
Returns:

getTextBoundingRect()

Get caption text rectangle
Source:
Returns:

getTextColor()

Get caption text color
Source:
Returns:

getUnderline()

Get caption underline
Source:
Returns:

getWeight()

Get caption weight
Source:
Returns:

getZValue()

Get caption Z value.
Source:
Returns:

hasKeyframeList(fxParam)

has key frame list or not
Parameters:
Name Type Description
fxParam name of parameter
Overrides:
Source:
Returns:

isFrameCaption()

Determine if it is a border caption.
Source:
Returns:

isLyrics()

Lyrics or not
Source:
Returns:

isModular()

Determines whether the current caption is a modular caption.
Source:
Returns:

isTextColorChanged()

Determine if caption text color changed.
Source:
Returns:

movePosition(offset)

Changes the display position of the caption on the timeline (the in and out points are offset from the offset value at the same time).
Parameters:
Name Type Description
offset Offset value for in and out points changes (in microseconds).
Source:

removeAllKeyframe(fxParam)

remove all key frame
Parameters:
Name Type Description
fxParam name of parameter
Overrides:
Source:
Returns:

removeKeyframeAtTime(fxParam, time)

remove key frame at certain time
Parameters:
Name Type Description
fxParam name of parameter
time time
Overrides:
Source:
Returns:

rotateCaption(angle, anchor)

Rotate caption
Parameters:
Name Type Description
angle angle
anchor anchor
Source:
Returns:

rotateCaption2(angle)

Rotate caption on center
Parameters:
Name Type Description
angle angle
Source:
Returns:

scaleCaption(scaleFactor, anchor)

Scale caption.
Parameters:
Name Type Description
scaleFactor scale factor
anchor anchor
Source:
Returns:

scaleCaption2(scaleFactor)

Scale caption on center
Parameters:
Name Type Description
scaleFactor scale factor
Source:
Returns:

setAnchorPoint(anchor)

Set caption anchor.
Parameters:
Name Type Description
anchor anchor
Source:
Returns:

setBackgroundColor(backgroundColor)

Set text background color.
Parameters:
Name Type Description
backgroundColor background color
Source:
Returns:

setBackgroundRadius(radius)

Set text background rectangle's corner radius.
Parameters:
Name Type Description
radius radius
Source:
Returns:

setBold(bold)

Set caption font bold
Parameters:
Name Type Description
bold Indicates whether the caption font is bold.
Source:
Returns:

setBooleanVal(fxParam, val)

set boolean value
Parameters:
Name Type Description
fxParam name of parameter
val value
Overrides:
Source:
Returns:

setBooleanValAtTime(fxParam, val, time)

set boolean value at certain time
Parameters:
Name Type Description
fxParam name of parameter
val value
time time
Overrides:
Source:
Returns:

setCaptionTranslation(translation)

Set the amount of caption translation.
Parameters:
Name Type Description
translation The horizontal and vertical absolute translation of the caption.
Source:
Returns:

setColorVal(fxParam, val)

set color value
Parameters:
Name Type Description
fxParam name of parameter
val value
Overrides:
Source:
Returns:

setColorValAtTime(fxParam, val, time)

set color value at certain time
Parameters:
Name Type Description
fxParam name of parameter
val value
time time
Overrides:
Source:
Returns:

setCurrentKeyFrameTime(time)

Set the caption KeyFrameTime.
Parameters:
Name Type Description
time time
Source:
Returns:

setDrawOutline(drawOutline)

Set caption stroke.
Parameters:
Name Type Description
drawOutline Whether to stroke the captions.
Source:
Returns:

setDrawShadow(drawShadow)

Set caption shadows.
Parameters:
Name Type Description
drawShadow Whether to set the caption shadow
Source:
Returns:

setEllipseRegion(center, a, b, angle)

set ellipse region
Parameters:
Name Type Description
center center point
a Long semiaxis of ellipse
b short semiaxis of ellipse
angle angle
Overrides:
Source:
Returns:

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

set ellipse region at certain time
Parameters:
Name Type Description
center center point
a Long semiaxis of ellipse
b short semiaxis of ellipse
angle angle
time time
Overrides:
Source:
Returns:

setExprVar(varName, varValue)

set Expr value
Parameters:
Name Type Description
varName variable name
varValue variable value
Overrides:
Source:
Returns:

setFilterIntensity(intensity)

set filter intensity
Parameters:
Name Type Description
intensity intensity
Overrides:
Source:
Returns:

setFloatVal(fxParam, val)

set float value
Parameters:
Name Type Description
fxParam name of parameter
val value
Overrides:
Source:
Returns:

setFloatValAtTime(fxParam, val, time)

set float value at certain time
Parameters:
Name Type Description
fxParam name of parameter
val value
time time
Overrides:
Source:
Returns:

setFontByFilePath(filePath)

Set caption font by file path
Parameters:
Name Type Description
filePath font file path
Source:
Returns:

setFontFamily(family)

Set caption font family
Parameters:
Name Type Description
family font family
Source:
Returns:

setFontSize(fontSize)

Set caption font size.
Parameters:
Name Type Description
fontSize font size
Source:
Returns:

setFrameCaptionMaxFontSize(maxFontSize)

Set the max font size for border caption. Only border caption can use this method.
Parameters:
Name Type Description
maxFontSize max font size
Source:
Returns:

setIgnoreBackground(isIgnoreBackground)

set ignore background
Parameters:
Name Type Description
isIgnoreBackground ignore background or not
Overrides:
Source:
Returns:

setInternalObject(obj)

set internal object
Parameters:
Name Type Description
obj internal object
Overrides:
Source:
Returns:

setIntVal(fxParam, val)

set integer value
Parameters:
Name Type Description
fxParam name of parameter
val value
Overrides:
Source:
Returns:

setIntValAtTime(fxParam, val, time)

set integer value at certain time
Parameters:
Name Type Description
fxParam name of parameter
val value
time time
Overrides:
Source:
Returns:

setInverseRegion(isInverseRegion)

set region in reverse
Parameters:
Name Type Description
isInverseRegion inverse region or not
Overrides:
Source:
Returns:

setIsLyrics(isLyrics)

Set caption lyrics type
Parameters:
Name Type Description
isLyrics lyrics
Source:
Returns:

setItalic(italic)

Set caption font italic.
Parameters:
Name Type Description
italic Italic or not
Source:
Returns:

setLetterSpacing(letterSpacing)

Set caption letter spacing
Parameters:
Name Type Description
letterSpacing Letter spacing
Source:
Returns:

setLetterSpacingType(letterSpacingType)

Set caption word spacing type.
Parameters:
Name Type Description
letterSpacingType Word spacing type.
Source:
Returns:

setLineSpacing(lineSpacing)

Set line spacing
Parameters:
Name Type Description
lineSpacing Line spacing
Source:
Returns:

setMenuVal(fxParam, val)

set menu value
Parameters:
Name Type Description
fxParam name of parameter
val value
Overrides:
Source:
Returns:

setMenuValAtTime(fxParam, val, time)

set menu value at certain time
Parameters:
Name Type Description
fxParam name of parameter
val value
time time
Overrides:
Source:
Returns:

setModularCaptionAnimationPeroid(periodInMS)

set modular caption animation period
Parameters:
Name Type Description
periodInMS period(milliseconds)
Source:
Returns:

setModularCaptionInAnimationDuration(inAnimationDurationInMS)

set modular caption in animation duration
Parameters:
Name Type Description
inAnimationDurationInMS in animation duration(milliseconds)
Source:
Returns:

setModularCaptionOutAnimationDuration(outAnimationDurationInMS)

set modular caption out animation duration
Parameters:
Name Type Description
outAnimationDurationInMS out animation duration(milliseconds)
Source:
Returns:

setOpacity(opacity)

Set caption opacity.
Parameters:
Name Type Description
opacity opacity
Source:
Returns:

setOutlineColor(color)

Set the color of the caption stroke.
Parameters:
Name Type Description
color Caption stroke color value
Source:
Returns:

setOutlineWidth(outlineWidth)

Set the width of the caption stroke.
Parameters:
Name Type Description
outlineWidth The width of the caption stroke.
Source:
Returns:

setRecordingUserOperation(recordingUserOperation)

Set whether to record user actions.
Parameters:
Name Type Description
recordingUserOperation Record user actions or not
Source:
Returns:

setRegion(region)

set region
Parameters:
Name Type Description
region region
Overrides:
Source:
Returns:

setRegional(isRegional)

set regional
Parameters:
Name Type Description
isRegional regional or not
Overrides:
Source:
Returns:

setRegionalFeatherWidth(featherWidth)

set region feather width
Parameters:
Name Type Description
featherWidth feather width
Overrides:
Source:
Returns:

setRegionAtTime(region, time)

set region at certain time
Parameters:
Name Type Description
region region
time time
Overrides:
Source:
Returns:

setRotationZ(angle)

Set rotation angle for caption.
Parameters:
Name Type Description
angle angle
Source:
Returns:

setScaleX(scale)

Set horizontal scaling factor for caption.
Parameters:
Name Type Description
scale Horizontal scaling factor.
Source:
Returns:

setScaleY(scale)

Set vertical scaling factor for caption.
Parameters:
Name Type Description
scale Vertical scaling factor.
Source:
Returns:

setShadowColor(color)

Set caption shadow color
Parameters:
Name Type Description
color Shadow color
Source:
Returns:

setShadowFeather(feather)

Set the feathering degree of the caption shadow.
Parameters:
Name Type Description
feather feathering degree
Source:
Returns:

setShadowOffset(offset)

Set caption shadow offset
Parameters:
Name Type Description
offset offset
Source:
Returns:

setStringVal(fxParam, val)

set string value
Parameters:
Name Type Description
fxParam name of parameter
val value
Overrides:
Source:
Returns:

setStringValAtTime(fxParam, val, time)

set character string at certain time
Parameters:
Name Type Description
fxParam name of parameter
val value
time time
Overrides:
Source:
Returns:

setTemplateAttachment(key, value)

get template attachment
Parameters:
Name Type Description
key key
value value
Overrides:
Source:
Returns:

setText(text)

set caption text
Parameters:
Name Type Description
text text
Source:
Returns:

setTextAlignment(textAlign)

Set caption horizontal alignment style
Parameters:
Name Type Description
textAlign Indicates the caption horizontal alignment style
Source:
Returns:

setTextColor(color)

Set caption text color
Parameters:
Name Type Description
color Text color
Source:
Returns:

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.
Parameters:
Name Type Description
rect rectangle
Source:
Returns:

setUnderline(underline)

Set caption underline
Parameters:
Name Type Description
underline Underline or not
Source:
Returns:

setWeight(weight)

Set caption weight
Parameters:
Name Type Description
weight Weight
Source:
Returns:

setZValue(value)

Set caption Z value.
Parameters:
Name Type Description
value Z value
Source:
Returns:

translateCaption(translationOffset)

Caption translation.
Parameters:
Name Type Description
translationOffset Horizontal and vertical offset values for caption.
Source:
Returns: