Timeline compound caption. Timeline compound captions are compound caption that is superimposed on the video, each compound caption may composed of several sub-captions. When editing a video, users can add or remove timeline compound captions and adjust the captions position. User can also set its properties such as font family, text color, etc. More...

Inheritance diagram for NvsCompoundCaption:

Public Member Functions
	constructor ()

	getCaptionCount ()
	Get number of sub-cpations in this compound caption. More...

	setText (captionIndex, text)
	Set sub-caption text with index. More...

	getText (captionIndex)
	Get sub-caption text with index. More...

	setTextColor (captionIndex, color)
	Set sub-caption color with index. More...

	getTextColor (captionIndex)
	Get sub-caption color with index. More...

	setFontFamily (captionIndex, family)
	Set sub-caption font family with index. More...

	getFontFamily (captionIndex)
	Get sub-caption font family with index. More...

	setCaptionTranslation (translation)
	Set the amount of caption translation. More...

	getCaptionTranslation ()
	Get the amount of caption translation. More...

	translateCaption (translationOffset)
	Translate caption. More...

	setAnchorPoint (anchor)
	Set caption anchor. More...

	getAnchorPoint ()
	Get caption anchor. More...

	setScaleX (scale)
	Set horizontal scaling factor for caption. More...

	getScaleX ()
	Get horizontal scaling factor for caption. More...

	setScaleY (scale)
	Set vertical scaling factor for captions. More...

	getScaleY ()
	Get vertical scaling factor for captions. More...

	scaleCaption (scaleFactor, anchor)
	Scale caption. More...

	setRotationZ (angle)
	Set the rotation angle for the caption. More...

	getRotationZ ()
	Get the rotation angle for the caption. More...

	rotateCaption (angle, anchor)
	Rotate caption. More...

	rotateCaption2 (angle)
	Rotate catpion on center. More...

	getCaptionBoundingVertices (captionIndex, boudingType, motionParams)
	Get the transformed vertices position of the original caption bounding. More...

	getCompoundBoundingVertices (boudingType, motionParams)
	Get the transformed vertices position of the original compound caption bounding. More...

	setZValue (value)
	Set caption Z value. More...

	getZValue ()
	Get caption Z value. More...

	setOpacity (value)
	Set caption opacity. More...

	getOpacity ()
	Get caption opacity. More...

	isFrameCaption (captionIndex)
	Determine if it is a border caption. More...

	getCaptionStylePackageId ()
	Get the caption style package ID. More...

	setCurrentKeyFrameTime (time)
	Set the compound caption current time values as key frame. More...

	removeKeyframeAtTime (fxParam, time)
	remove Remove key frame at a specified time point from key frame list. More...

	removeAllKeyframe (fxParam)
	remove Remove all key frames from key frame list. More...

	hasKeyframeList (fxParam)
	Check whether the parameter has key frame list or not. More...

	findKeyframeTime (fxParam, time, flags)
	Get key frame at a specified time point. More...

Public Member Functions inherited from NvsFx
	constructor ()
	NvsFx constructor.

	getDescription ()
	Get description of Fx.Return the NvsFxDescription object. More...

	setIntVal (fxParam, val)
	Set the integer parameter of NvsFx.The type of the NvsFx's integer parameter. More...

	getIntVal (fxParam)
	Get the integer parameter of NvsFx.Return the integer value. More...

	setIntValAtTime (fxParam, val, time)
	Set the NvsFx's integer parameter at a specified time point. More...

	getIntValAtTime (fxParam, time)
	Get the NvsFx's integer parameter at a specified time point.Return the integer value. More...

	setFloatVal (fxParam, val)
	set float value More...

	getFloatVal (fxParam)
	get float value More...

	setFloatValAtTime (fxParam, val, time)
	Set the NvsFx's float parameter at a specified time point. More...

	getFloatValAtTime (fxParam, time)
	Get the NvsFx's float parameter at a specified time point.Return the double value. More...

	setBooleanVal (fxParam, val)
	Set the boolean parameter of NvsFx. More...

	getBooleanVal (fxParam)
	Get the boolean parameter of NvsFx.Return the boolean value. More...

	setBooleanValAtTime (fxParam, val, time)
	Set the NvsFx’s boolean parameter at a specified time point. More...

	getBooleanValAtTime (fxParam, time)
	Get the NvsFx's boolean parameter at a specified time point. More...

	setMenuVal (fxParam, val)
	Set the menu parameter of NvsFx. More...

	getMenuVal (fxParam)
	Get the menu parameter of NvsFx.Return the menu value of NvsFx. More...

	setMenuValAtTime (fxParam, val, time)
	Set the NvsFx's menu parameter at a specified time point. More...

	getMenuValAtTime (fxParam, time)
	Get the NvsFx menu parameter at a specified time point.Return the menu value of NvsFx. More...

	setStringVal (fxParam, val)
	Set the string parameter of NvsFx. More...

	getStringVal (fxParam)
	Get the string parameter of NvsFx.Return the string value. More...

	setStringValAtTime (fxParam, val, time)
	Set the NvsFx's string parameter at a specified time point. More...

	getStringValAtTime (fxParam, time)
	Get the NvsFx's string parameter at a specified time point.Return the string value. More...

	setColorVal (fxParam, val)
	Set the color parameter of NvsFx. More...

	getColorVal (fxParam)
	Get the color parameter of NvsFx. More...

	setColorValAtTime (fxParam, val, time)
	Set the NvsFx's color parameter at a specified time point. More...

	getColorValAtTime (fxParam, time)
	get color value at certain time More...

	removeKeyframeAtTime (fxParam, time)
	remove Remove key frame at a specified time point from key frame list. More...

	removeAllKeyframe (fxParam)
	remove Remove all key frames from key frame list. More...

	hasKeyframeList (fxParam)
	Check whether the parameter has key frame list or not. More...

	findKeyframeTime (fxParam, time, flags)
	Get key frame at a specified time point. More...

	setParamKeyframes (fxParam, keyframes)
	Set key frame parameters. More...

	getParamKeyframes (fxParam)
	Get key frame parameters. More...

	setParamKeyframeAtTime (fxParam, time, keyframe)
	Set key frame at a specified time point. More...

	getParamKeyframeAtTime (fxParam, time)
	Get key frame at a specified time point. More...

	getIntpFxParamValsAtTime (fxParam, time)
	Get key frame at a specified time point. More...

	setFilterIntensity (intensity)
	Set the intensity of the filter. More...

	getFilterIntensity ()
	Get the intensity of the filter. More...

	setRegional (isRegional)
	Set whether the filter is regional. More...

	getRegional ()
	Get whether the filter is regional. More...

	setIgnoreBackground (isIgnoreBackground)
	Set whether the regional filter ignores background. More...

	getIgnoreBackground ()
	Get whether the regional filter ignores background. More...

	setInverseRegion (isInverseRegion)
	Set whether the regional filter inverses region. More...

	getInverseRegion ()
	Get whether the regional filter inverses region. More...

	setRegion (region)
	Set the region of this regional filter. More...

	setRegionAtTime (region, time)
	set region at certain time More...

	setEllipseRegion (center, a, b, angle)
	set ellipse region More...

	setEllipseRegionAtTime (center, a, b, angle, time)
	set ellipse region at certain time More...

	getRegionInfos ()
	Get the mask region informations of the regional filter. More...

	getRegionInfosAtTime (time)
	Get the mask region informations of the regional filter at a specified time. More...

	setRegionalFeatherWidth (featherWidth)
	Set the feather width of the regional filter. More...

	getRegionalFeatherWidth ()
	Get the feather width of the regional filter. More...

	getParticleSystemContext ()
	Get the particle effect context object. More...

	getARSceneManipulate ()
	Get the manipulate of ARScene. More...

	setExprVar (varName, varValue)
	Set the value of the defined parameter in the expression. More...

	getExprVar (varName)
	Get the value of the defined parameter in the expression. More...

	setExprObjectVar (varName, varValue)
	Set the object(e.g. color) value of the defined parameter in the expression. More...

	getExprObjectVar (varName)
	Get the object(e.g. color) value of the defined parameter in the expression. More...

	clearExprVar ()
	Clear the value of the defined parameter in the expression and set it to the default value of 0. More...

	clearExprVarCtx ()
	Clear all parameter values defined in the expression and set them to the default value of 0. More...

	setArbitraryVal (fxParam, val)
	Set arbitrary value of fx. More...

	getArbitraryVal (fxParam)
	Get the arbitrary value of fx. More...

	setArbitraryValAtTime (fxParam, val, time)
	Set arbitrary value of fx at time. More...

	getArbitraryValAtTime (fxParam, time)
	Get arbitrary value of fx at time. More...

	setRegionInfos (regionInfos)
	Set region infos of fx. More...

	setRegionInfosAtTime (regionInfos, time)
	Set region infos of fx at time. More...

Public Member Functions inherited from NvsProjObj
	constructor ()

	setInternalObject (obj)
	set internal object More...

	getInternalObject ()
	get internal object More...

	setTemplateAttachment (key, value)
	Adds additional template data to the NvsObject object to identify the NvsObject template object. More...

	getTemplateAttachment (key)
	Gets an template attachment to NvsObject. More...

Detailed Description

Timeline compound caption. Timeline compound captions are compound caption that is superimposed on the video, each compound caption may composed of several sub-captions. When editing a video, users can add or remove timeline compound captions and adjust the captions position. User can also set its properties such as font family, text color, etc.

See also: NvsFx

Member Function Documentation

◆ constructor()

NvsCompoundCaption::constructor ( )

inline

@constructor

◆ findKeyframeTime()

NvsCompoundCaption::findKeyframeTime	(	fxParam,
		time,
		flags
	)

inline

Get key frame at a specified time point.

Parameters

{String}	fxParam The type of custom data parameter for the effect.
{Number}	time Time point (In microseconds).
{Number}	flags Flag of finding mode

Returns: {Number} Return key frame time point near the specified time point, If there is no key frame near this time point, return - 1

◆ getAnchorPoint()

NvsCompoundCaption::getAnchorPoint ( )

inline

Get caption anchor.

Returns: {PointF} Returns caption anchor.

◆ getCaptionBoundingVertices()

NvsCompoundCaption::getCaptionBoundingVertices	(	captionIndex,
		boudingType,
		motionParams
	)

inline

Get the transformed vertices position of the original caption bounding.

Parameters

{Number}	captionIndex sub-caption index
{Number}	boundingType bounding type
{NvsMotionParameters}	motionParams motion parameter

Returns: {NvsVectorVal} Returns the NSArray object, the object type is NSValue, and the actual data type is CGPoint, which correspond to the top left, bottom left, bottom right, and top right vertices of the original bounding.

See also: NvsMotionParameters; NvsVectorVal

◆ getCaptionCount()

NvsCompoundCaption::getCaptionCount ( )

inline

Get number of sub-cpations in this compound caption.

Returns: {Number} Returns number of sub-cpations

◆ getCaptionStylePackageId()

NvsCompoundCaption::getCaptionStylePackageId ( )

inline

Get the caption style package ID.

Returns: {String} Returns the obtained caption style resource package ID.

◆ getCaptionTranslation()

NvsCompoundCaption::getCaptionTranslation ( )

inline

Get the amount of caption translation.

Returns: {PointF} Returns PointF object indicating the amount of caption translation obtained.

◆ getCompoundBoundingVertices()

NvsCompoundCaption::getCompoundBoundingVertices	(	boudingType,
		motionParams
	)

inline

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

Parameters

{Number}	boundingType Bounding type.
{NvsMotionParameters}	motionParams motion parameter

Returns: {NvsVectorVal} Returns the NSArray object, the object type is NSValue, and the actual data type is CGPoint, which correspond to the top left, bottom left, bottom right, and top right vertices of the original bounding.

See also: NvsVectorVal

◆ getFontFamily()

NvsCompoundCaption::getFontFamily ( captionIndex )

inline

Get sub-caption font family with index.

Parameters

{Number} captionIndex sub-caption index

Returns: {String}

◆ getOpacity()

NvsCompoundCaption::getOpacity ( )

inline

Get caption opacity.

Returns: {Number} Return the caption opacity.

◆ getRotationZ()

NvsCompoundCaption::getRotationZ ( )

inline

Get the rotation angle for the caption.

Returns: {Number} Returns caption rotation angle.

◆ getScaleX()

NvsCompoundCaption::getScaleX ( )

inline

Get horizontal scaling factor for caption.

Returns: {Number} Returns caption horizontal scaling factor.

◆ getScaleY()

NvsCompoundCaption::getScaleY ( )

inline

Get vertical scaling factor for captions.

Returns: {Number} Returns caption vertical scaling factor.

◆ getText()

NvsCompoundCaption::getText ( captionIndex )

inline

Get sub-caption text with index.

Parameters

{Number} captionIndex caption index to get text

Returns: {String} Returns caption text.

◆ getTextColor()

NvsCompoundCaption::getTextColor ( captionIndex )

inline

Get sub-caption color with index.

Parameters

{Number} captionIndex caption index to get text color

Returns: {NvsColor} Return NvsColor object which is the text color

◆ getZValue()

NvsCompoundCaption::getZValue ( )

inline

Get caption Z value.

Returns: {Number}

◆ hasKeyframeList()

NvsCompoundCaption::hasKeyframeList ( fxParam )

inline

Check whether the parameter has key frame list or not.

Parameters

{String} fxParam The type of custom data parameter for the effect.

Returns: {Boolean} Return exist or not.

◆ isFrameCaption()

NvsCompoundCaption::isFrameCaption ( captionIndex )

inline

Determine if it is a border caption.

Parameters

{Number} captionIndex sub-caption index

Returns: {Boolean} A return value of true indicates a border caption

◆ removeAllKeyframe()

NvsCompoundCaption::removeAllKeyframe ( fxParam )

inline

remove Remove all key frames from key frame list.

Parameters

{String} fxParam The type of custom data parameter for the effect.

Returns: {Boolean} Return success or not.

◆ removeKeyframeAtTime()

NvsCompoundCaption::removeKeyframeAtTime	(	fxParam,
		time
	)

inline

remove Remove key frame at a specified time point from key frame list.

Parameters

{String}	fxParam The type of custom data parameter for the effect.
{Number}	time time point (In microseconds).

Returns: {Boolean} Return success or not.

◆ rotateCaption()

NvsCompoundCaption::rotateCaption	(	angle,
		anchor
	)

inline

Rotate caption.

Parameters

{Number}	angle angle
{PointF}	anchor anchor

Returns: {void}

◆ rotateCaption2()

NvsCompoundCaption::rotateCaption2 ( angle )

inline

Rotate catpion on center.

Parameters

{Number} angle angle

Returns: {void}

◆ scaleCaption()

NvsCompoundCaption::scaleCaption	(	scaleFactor,
		anchor
	)

inline

Scale caption.

Parameters

{Number}	scaleFactor Caption scaling factor.
{PointF}	anchor Caption zoom anchor.

Returns: {void}

◆ setAnchorPoint()

NvsCompoundCaption::setAnchorPoint ( anchor )

inline

Set caption anchor.

Parameters

{PointF} anchor Anchor

Returns: {viod}

◆ setCaptionTranslation()

NvsCompoundCaption::setCaptionTranslation ( translation )

inline

Set the amount of caption translation.

Parameters

{PointF} translation The horizontal and vertical translation of the caption.

Returns: {void}

◆ setCurrentKeyFrameTime()

NvsCompoundCaption::setCurrentKeyFrameTime ( time )

inline

Set the compound caption current time values as key frame.

Parameters

{Number} time time

Returns: {void}

◆ setFontFamily()

NvsCompoundCaption::setFontFamily	(	captionIndex,
		family
	)

inline

Set sub-caption font family with index.

Parameters

{Number}	captionIndex Caption index to set font family
{String}	family Caption font family name. It will be set to default font if family is an empty string

Returns: {void}

◆ setOpacity()

NvsCompoundCaption::setOpacity ( value )

inline

Set caption opacity.

Parameters

{Number} value opacity

Returns: {void}

◆ setRotationZ()

NvsCompoundCaption::setRotationZ ( angle )

inline

Set the rotation angle for the caption.

Parameters

{Number} angle Rotation angle.

Returns: {void}

◆ setScaleX()

NvsCompoundCaption::setScaleX ( scale )

inline

Set horizontal scaling factor for caption.

Parameters

{Number} scale Horizontal scaling factor.

Returns: {void}

◆ setScaleY()

NvsCompoundCaption::setScaleY ( scale )

inline

Set vertical scaling factor for captions.

Parameters

{Number} scale Vertical scaling factor.

Returns: {void}

◆ setText()

NvsCompoundCaption::setText	(	captionIndex,
		text
	)

inline

Set sub-caption text with index.

Parameters

{Number}	captionIndex caption index to set text
{String}	text Caption text

Returns: {void}

◆ setTextColor()

NvsCompoundCaption::setTextColor	(	captionIndex,
		color
	)

inline

Set sub-caption color with index.

Parameters

{Number}	captionIndex Caption index to set text color
{NvsColor}	color Caption text color value.

Returns: {void}

◆ setZValue()

NvsCompoundCaption::setZValue ( value )

inline

Set caption Z value.

Parameters

{Number} value Z value

Returns: {void}

◆ translateCaption()

NvsCompoundCaption::translateCaption ( translationOffset )

inline

Translate caption.

Parameters

{PointF} translationOffset Horizontal and vertical offset values for caption.

Returns: {void}

The documentation for this class was generated from the following file:

src/js/NvStreamingSdk.js

Public Member Functions

Detailed Description

Member Function Documentation

◆ constructor()

◆ findKeyframeTime()

◆ getAnchorPoint()

◆ getCaptionBoundingVertices()

◆ getCaptionCount()

◆ getCaptionStylePackageId()

◆ getCaptionTranslation()

◆ getCompoundBoundingVertices()

◆ getFontFamily()

◆ getOpacity()

◆ getRotationZ()

◆ getScaleX()

◆ getScaleY()

◆ getText()

◆ getTextColor()

◆ getZValue()

◆ hasKeyframeList()

◆ isFrameCaption()

◆ removeAllKeyframe()

◆ removeKeyframeAtTime()

◆ rotateCaption()

◆ rotateCaption2()

◆ scaleCaption()

◆ setAnchorPoint()

◆ setCaptionTranslation()

◆ setCurrentKeyFrameTime()

◆ setFontFamily()

◆ setOpacity()

◆ setRotationZ()

◆ setScaleX()

◆ setScaleY()

◆ setText()

◆ setTextColor()

◆ setZValue()

◆ translateCaption()