JSDoc: Class: NvsTimelineCompoundCaption

Constructor

new NvsTimelineCompoundCaption()

Source:

NvStreamingSdk_EN.js, line 4956

Extends

NvsFx

Methods

changeInPoint(newInPoint)

Change in point

Parameters:

Name	Type	Description
`newInPoint`		new in point

Source:

NvStreamingSdk_EN.js, line 4998

Returns:

changeOutPoint(newOutPoint)

Change out point

Parameters:

Name	Type	Description
`newOutPoint`		new point

Source:

NvStreamingSdk_EN.js, line 5008

Returns:

clearExprVar()

clear Expr value

Overrides:

NvsFx#clearExprVar

Source:

NvStreamingSdk_EN.js, line 3808

Returns:

clearExprVarCtx()

clear all Expr value

Overrides:

NvsFx#clearExprVarCtx

Source:

NvStreamingSdk_EN.js, line 3817

Returns:

findKeyframeTime(fxParam, time, flags)

find key frame at certain time

Parameters:

Name	Type	Description
`fxParam`		name of parameter
`time`		time
`flags`		flags

Overrides:

NvsFx#findKeyframeTime

Source:

NvStreamingSdk_EN.js, line 3600

Returns:

getAnchorPoint()

Get caption anchor.

Source:

NvStreamingSdk_EN.js, line 5131

Returns:

getARSceneManipulate()

get ARScene operation

Overrides:

NvsFx#getARSceneManipulate

Source:

NvStreamingSdk_EN.js, line 3780

Returns:

getBooleanVal(fxParam)

get boolean value

Parameters:

Name	Type	Description
`fxParam`		name of parameter

Overrides:

NvsFx#getBooleanVal

Source:

NvStreamingSdk_EN.js, line 3401

Returns:

getBooleanValAtTime(fxParam, time)

get boolean value at certain time

Parameters:

Name	Type	Description
`fxParam`		name of parameter
`time`		time

Overrides:

NvsFx#getBooleanValAtTime

Source:

NvStreamingSdk_EN.js, line 3424

Returns:

getCaptionBoundingVertices(captionIndex, boudingType, motionParams)

Get the transformed vertices position of the original caption bounding.

Parameters:

Name	Type	Description
`captionIndex`		sub-caption index
`boudingType`		bounding type
`motionParams`		motion parameter

Source:

NvStreamingSdk_EN.js, line 5245

Returns:

getCaptionCount()

Get number of sub-cpations in this compound caption.

Source:

NvStreamingSdk_EN.js, line 4970

Returns:

getCaptionStylePackageId()

Get the caption style package ID.

Source:

NvStreamingSdk_EN.js, line 5315

Returns:

getCaptionTranslation()

Get the amount of caption translation.

Source:

NvStreamingSdk_EN.js, line 5102

Returns:

getColorVal(fxParam)

get color value

Parameters:

Name	Type	Description
`fxParam`		name of parameter

Overrides:

NvsFx#getColorVal

Source:

NvStreamingSdk_EN.js, line 3534

Returns:

getColorValAtTime(fxParam, time)

get color value at certain time

Parameters:

Name	Type	Description
`fxParam`		name of parameter
`time`		time

Overrides:

NvsFx#getColorValAtTime

Source:

NvStreamingSdk_EN.js, line 3557

Returns:

getCompoundBoundingVertices(boudingType, motionParams)

Get the transformed vertices position of the original compound caption bounding.

Parameters:

Name	Type	Description
`boudingType`		bounding type
`motionParams`		motion parameter

Source:

NvStreamingSdk_EN.js, line 5256

Returns:

getDescription()

get description information

Overrides:

NvsFx#getDescription

Source:

NvStreamingSdk_EN.js, line 3291

Returns:

getExprVar(varName)

get Expr value

Parameters:

Name	Type	Description
`varName`		variable name

Overrides:

NvsFx#getExprVar

Source:

NvStreamingSdk_EN.js, line 3800

Returns:

getFilterIntensity()

get filter intensity

Overrides:

NvsFx#getFilterIntensity

Source:

NvStreamingSdk_EN.js, line 3619

Returns:

getFloatVal(fxParam)

get float value

Parameters:

Name	Type	Description
`fxParam`		name of parameter

Overrides:

NvsFx#getFloatVal

Source:

NvStreamingSdk_EN.js, line 3356

Returns:

getFloatValAtTime(fxParam, time)

get float value at certain time

Parameters:

Name	Type	Description
`fxParam`		name of parameter
`time`		time

Overrides:

NvsFx#getFloatValAtTime

Source:

NvStreamingSdk_EN.js, line 3379

Returns:

getFontFamily(captionIndex)

Get sub-caption font family with index

Parameters:

Name	Type	Description
`captionIndex`		sub-caption index

Source:

NvStreamingSdk_EN.js, line 5083

Returns:

getIgnoreBackground()

get ignore background

Overrides:

NvsFx#getIgnoreBackground

Source:

NvStreamingSdk_EN.js, line 3657

Returns:

getInPoint()

Get in point

Source:

NvStreamingSdk_EN.js, line 4979

Returns:

getInternalObject() → {Num}

get internal object

Overrides:

NvsFx#getInternalObject

Source:

NvStreamingSdk_EN.js, line 1098

Returns:

Type: Num

getIntVal(fxParam)

get integer value

Parameters:

Name	Type	Description
`fxParam`		name of parameter

Overrides:

NvsFx#getIntVal

Source:

NvStreamingSdk_EN.js, line 3312

Returns:

getIntValAtTime(fxParam, time)

get integer value at certain time

Parameters:

Name	Type	Description
`fxParam`		name of parameter
`time`		time

Overrides:

NvsFx#getIntValAtTime

Source:

NvStreamingSdk_EN.js, line 3335

Returns:

getInverseRegion()

get region in reverse

Overrides:

NvsFx#getInverseRegion

Source:

NvStreamingSdk_EN.js, line 3676

Returns:

getMenuVal(fxParam)

get menu value

Parameters:

Name	Type	Description
`fxParam`		name of parameter

Overrides:

NvsFx#getMenuVal

Source:

NvStreamingSdk_EN.js, line 3445

Returns:

getMenuValAtTime(fxParam, time)

get menu value at certain time

Parameters:

Name	Type	Description
`fxParam`		name of parameter
`time`		time

Overrides:

NvsFx#getMenuValAtTime

Source:

NvStreamingSdk_EN.js, line 3469

Returns:

getOpacity()

Get caption opacity

Source:

NvStreamingSdk_EN.js, line 5295

Returns:

getOutPoint()

Get out point

Source:

NvStreamingSdk_EN.js, line 4988

Returns:

getParticleSystemContext()

get particle system context

Overrides:

NvsFx#getParticleSystemContext

Source:

NvStreamingSdk_EN.js, line 3771

Returns:

getRegional()

get regional

Overrides:

NvsFx#getRegional

Source:

NvStreamingSdk_EN.js, line 3638

Returns:

getRegionalFeatherWidth()

get regional feather width

Overrides:

NvsFx#getRegionalFeatherWidth

Source:

NvStreamingSdk_EN.js, line 3762

Returns:

getRegionInfos()

get region

Overrides:

NvsFx#getRegionInfos

Source:

NvStreamingSdk_EN.js, line 3733

Returns:

getRegionInfosAtTime(time)

get region information at certain time

Parameters:

Name	Type	Description
`time`		time

Overrides:

NvsFx#getRegionInfosAtTime

Source:

NvStreamingSdk_EN.js, line 3743

Returns:

getRotationZ()

Get the rotation angle for the caption.

Source:

NvStreamingSdk_EN.js, line 5201

Returns:

getScaleX()

Get horizontal scaling factor for caption.

Source:

NvStreamingSdk_EN.js, line 5150

Returns:

getScaleY()

Get vertical scaling factor for captions.

Source:

NvStreamingSdk_EN.js, line 5170

Returns:

getStringVal(fxParam)

get character string

Parameters:

Name	Type	Description
`fxParam`		name of parameter

Overrides:

NvsFx#getStringVal

Source:

NvStreamingSdk_EN.js, line 3490

Returns:

getStringValAtTime(fxParam, time)

get string value at certain time

Parameters:

Name	Type	Description
`fxParam`		name of parameter
`time`		time

Overrides:

NvsFx#getStringValAtTime

Source:

NvStreamingSdk_EN.js, line 3513

Returns:

getTemplateAttachment(key) → {Num}

get template attachment according key

Parameters:

Name	Type	Description
`key`		key

Overrides:

NvsFx#getTemplateAttachment

Source:

NvStreamingSdk_EN.js, line 1120

Returns:

Type: Num

getText(captionIndex)

Get sub-caption text with index

Parameters:

Name	Type	Description
`captionIndex`		sub-caption index

Source:

NvStreamingSdk_EN.js, line 5039

Returns:

getTextColor(captionIndex)

Get sub-caption color with index

Parameters:

Name	Type	Description
`captionIndex`		sub-caption index

Source:

NvStreamingSdk_EN.js, line 5062

Returns:

getZValue()

Get caption Z value.

Source:

NvStreamingSdk_EN.js, line 5276

Returns:

hasKeyframeList(fxParam)

has key frame list or not

Parameters:

Name	Type	Description
`fxParam`		name of parameter

Overrides:

NvsFx#hasKeyframeList

Source:

NvStreamingSdk_EN.js, line 3588

Returns:

isFrameCaption(captionIndex)

Determine if it is a border caption.

Parameters:

Name	Type	Description
`captionIndex`		sub-caption index

Source:

NvStreamingSdk_EN.js, line 5305

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:

NvStreamingSdk_EN.js, line 5018

Returns:

removeAllKeyframe(fxParam)

remove all key frame

Parameters:

Name	Type	Description
`fxParam`		name of parameter

Overrides:

NvsFx#removeAllKeyframe

Source:

NvStreamingSdk_EN.js, line 3578

Returns:

removeKeyframeAtTime(fxParam, time)

remove key frame at certain time

Parameters:

Name	Type	Description
`fxParam`		name of parameter
`time`		time

Overrides:

NvsFx#removeKeyframeAtTime

Source:

NvStreamingSdk_EN.js, line 3568

Returns:

rotateCaption(angle, anchor)

Rotate catpion

Parameters:

Name	Type	Description
`angle`		angle
`anchor`		anchor

Source:

NvStreamingSdk_EN.js, line 5212

Returns:

rotateCaption2(angle)

Rotate catpion on center

Parameters:

Name	Type	Description
`angle`		angle

Source:

NvStreamingSdk_EN.js, line 5222

Returns:

scaleCaption(scaleFactor, anchor)

Scale caption

Parameters:

Name	Type	Description
`scaleFactor`		scale factor
`anchor`		anchor

Source:

NvStreamingSdk_EN.js, line 5181

Returns:

setAnchorPoint(anchor)

Set caption anchor.

Parameters:

Name	Type	Description
`anchor`		anchor

Source:

NvStreamingSdk_EN.js, line 5122

Returns:

setBooleanVal(fxParam, val)

set boolean value

Parameters:

Name	Type	Description
`fxParam`		name of parameter
`val`		value

Overrides:

NvsFx#setBooleanVal

Source:

NvStreamingSdk_EN.js, line 3390

Returns:

setBooleanValAtTime(fxParam, val, time)

set boolean value at certain time

Parameters:

Name	Type	Description
`fxParam`		name of parameter
`val`		value
`time`		time

Overrides:

NvsFx#setBooleanValAtTime

Source:

NvStreamingSdk_EN.js, line 3413

Returns:

setCaptionTranslation(translation)

Set the amount of caption translation.

Parameters:

Name	Type	Description
`translation`		The horizontal and vertical translation of the caption.

Source:

NvStreamingSdk_EN.js, line 5093

Returns:

setColorVal(fxParam, val)

set color value

Parameters:

Name	Type	Description
`fxParam`		name of parameter
`val`		value

Overrides:

NvsFx#setColorVal

Source:

NvStreamingSdk_EN.js, line 3524

Returns:

setColorValAtTime(fxParam, val, time)

set color value at certain time

Parameters:

Name	Type	Description
`fxParam`		name of parameter
`val`		value
`time`		time

Overrides:

NvsFx#setColorValAtTime

Source:

NvStreamingSdk_EN.js, line 3546

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:

NvsFx#setEllipseRegion

Source:

NvStreamingSdk_EN.js, line 3710

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:

NvsFx#setEllipseRegionAtTime

Source:

NvStreamingSdk_EN.js, line 3724

Returns:

setExprVar(varName, varValue)

set Expr value

Parameters:

Name	Type	Description
`varName`		variable name
`varValue`		variable value

Overrides:

NvsFx#setExprVar

Source:

NvStreamingSdk_EN.js, line 3791

Returns:

setFilterIntensity(intensity)

set filter intensity

Parameters:

Name	Type	Description
`intensity`		intensity

Overrides:

NvsFx#setFilterIntensity

Source:

NvStreamingSdk_EN.js, line 3610

Returns:

setFloatVal(fxParam, val)

set float value

Parameters:

Name	Type	Description
`fxParam`		name of parameter
`val`		value

Overrides:

NvsFx#setFloatVal

Source:

NvStreamingSdk_EN.js, line 3346

Returns:

setFloatValAtTime(fxParam, val, time)

set float value at certain time

Parameters:

Name	Type	Description
`fxParam`		name of parameter
`val`		value
`time`		time

Overrides:

NvsFx#setFloatValAtTime

Source:

NvStreamingSdk_EN.js, line 3368

Returns:

setFontFamily(captionIndex, family)

Set sub-caption font family with index

Parameters:

Name	Type	Description
`captionIndex`		sub-caption index
`family`		font family

Source:

NvStreamingSdk_EN.js, line 5073

Returns:

setIgnoreBackground(isIgnoreBackground)

set ignore background

Parameters:

Name	Type	Description
`isIgnoreBackground`		ignore background or not

Overrides:

NvsFx#setIgnoreBackground

Source:

NvStreamingSdk_EN.js, line 3648

Returns:

setInternalObject(obj)

set internal object

Parameters:

Name	Type	Description
`obj`		internal object

Overrides:

NvsFx#setInternalObject

Source:

NvStreamingSdk_EN.js, line 1089

Returns:

setIntVal(fxParam, val)

set integer value

Parameters:

Name	Type	Description
`fxParam`		name of parameter
`val`		value

Overrides:

NvsFx#setIntVal

Source:

NvStreamingSdk_EN.js, line 3302

Returns:

setIntValAtTime(fxParam, val, time)

set integer value at certain time

Parameters:

Name	Type	Description
`fxParam`		name of parameter
`val`		value
`time`		time

Overrides:

NvsFx#setIntValAtTime

Source:

NvStreamingSdk_EN.js, line 3324

Returns:

setInverseRegion(isInverseRegion)

set region in reverse

Parameters:

Name	Type	Description
`isInverseRegion`		inverse region or not

Overrides:

NvsFx#setInverseRegion

Source:

NvStreamingSdk_EN.js, line 3667

Returns:

setMenuVal(fxParam, val)

set menu value

Parameters:

Name	Type	Description
`fxParam`		name of parameter
`val`		value

Overrides:

NvsFx#setMenuVal

Source:

NvStreamingSdk_EN.js, line 3435

Returns:

setMenuValAtTime(fxParam, val, time)

set menu value at certain time

Parameters:

Name	Type	Description
`fxParam`		name of parameter
`val`		value
`time`		time

Overrides:

NvsFx#setMenuValAtTime

Source:

NvStreamingSdk_EN.js, line 3458

Returns:

setOpacity(value)

Set caption opacity

Parameters:

Name	Type	Description
`value`		opacity

Source:

NvStreamingSdk_EN.js, line 5286

Returns:

setRegion(region)

set region

Parameters:

Name	Type	Description
`region`		region

Overrides:

NvsFx#setRegion

Source:

NvStreamingSdk_EN.js, line 3686

Returns:

setRegional(isRegional)

set regional

Parameters:

Name	Type	Description
`isRegional`		regional or not

Overrides:

NvsFx#setRegional

Source:

NvStreamingSdk_EN.js, line 3629

Returns:

setRegionalFeatherWidth(featherWidth)

set region feather width

Parameters:

Name	Type	Description
`featherWidth`		feather width

Overrides:

NvsFx#setRegionalFeatherWidth

Source:

NvStreamingSdk_EN.js, line 3753

Returns:

setRegionAtTime(region, time)

set region at certain time

Parameters:

Name	Type	Description
`region`		region
`time`		time

Overrides:

NvsFx#setRegionAtTime

Source:

NvStreamingSdk_EN.js, line 3697

Returns:

setRotationZ(angle)

Set the rotation angle for the caption.

Parameters:

Name	Type	Description
`angle`		angle

Source:

NvStreamingSdk_EN.js, line 5191

Returns:

setScaleX(scale)

Set horizontal scaling factor for caption.

Parameters:

Name	Type	Description
`scale`		Horizontal scaling factor.

Source:

NvStreamingSdk_EN.js, line 5141

Returns:

setScaleY(scale)

Set vertical scaling factor for captions.

Parameters:

Name	Type	Description
`scale`		Vertical scaling factor.

Source:

NvStreamingSdk_EN.js, line 5161

Returns:

setStringVal(fxParam, val)

set string value

Parameters:

Name	Type	Description
`fxParam`		name of parameter
`val`		value

Overrides:

NvsFx#setStringVal

Source:

NvStreamingSdk_EN.js, line 3480

Returns:

setStringValAtTime(fxParam, val, time)

set character string at certain time

Parameters:

Name	Type	Description
`fxParam`		name of parameter
`val`		value
`time`		time

Overrides:

NvsFx#setStringValAtTime

Source:

NvStreamingSdk_EN.js, line 3502

Returns:

setTemplateAttachment(key, value)

get template attachment

Parameters:

Name	Type	Description
`key`		key
`value`		value

Overrides:

NvsFx#setTemplateAttachment

Source:

NvStreamingSdk_EN.js, line 1109

Returns:

setText(captionIndex, text)

Set sub-caption text with index

Parameters:

Name	Type	Description
`captionIndex`		sub-caption index
`text`		text

Source:

NvStreamingSdk_EN.js, line 5029

Returns:

setTextColor(captionIndex, color)

Set sub-caption color with index

Parameters:

Name	Type	Description
`captionIndex`		sub-caption index
`color`		color

Source:

NvStreamingSdk_EN.js, line 5050

Returns:

setZValue(value)

Set caption Z value.

Parameters:

Name	Type	Description
`value`		Z value

Source:

NvStreamingSdk_EN.js, line 5267

Returns:

translateCaption(translationOffset)

Translate caption.

Parameters:

Name	Type	Description
`translationOffset`		Horizontal and vertical offset values for caption.

Source:

NvStreamingSdk_EN.js, line 5112