Compound caption. 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 and adjust the captions position. User can also set its properties such as font family, text color, etc. More...

Inheritance diagram for NveCompoundCaption:

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...

	scaleCaption2 (scaleFactor)
	Scale caption on center. 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...

Public Member Functions inherited from NveEffectInstance
	constructor ()
	The constructor of NveEffectInstance.

	release ()
	Release the instance of effect You must call release() if you won't use this effect instance object anymore, otherwise there will be severe internal resources leak!

	setIntVal (fxParam, val)
	Set the integer parameter value of the effect. More...

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

	setFloatVal (fxParam, val)
	Set the float parameter value of the effect. More...

	getFloatVal (fxParam)
	Get the float parameter value of the effect. More...

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

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

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

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

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

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

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

	getColorVal (fxParam)
	Get the color parameter value of the effect. More...

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

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

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

	getInPoint ()
	Get in-point of effect. More...

	getOutPoint ()
	Get out point of effect. More...

	changeInPoint (newInPoint)
	Changes in-point of effect. More...

	changeOutPoint (newOutPoint)
	Changes out-point of effect. More...

Detailed Description

Compound caption. 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 and adjust the captions position. User can also set its properties such as font family, text color, etc.

See also: NveEffectInstance

Member Function Documentation

◆ constructor()

NveCompoundCaption::constructor ( )

inline

@constructor

◆ getAnchorPoint()

NveCompoundCaption::getAnchorPoint ( )

inline

Get caption anchor.

Returns: {NvePointF} Returns caption anchor.

◆ getCaptionBoundingVertices()

NveCompoundCaption::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
{NveMotionParameters}	motionParams motion parameter

Returns: {NveVectorVal} 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: NveMotionParameters; NveVectorVal

◆ getCaptionCount()

NveCompoundCaption::getCaptionCount ( )

inline

Get number of sub-cpations in this compound caption.

Returns: {Number} Returns number of sub-cpations

◆ getCaptionStylePackageId()

NveCompoundCaption::getCaptionStylePackageId ( )

inline

Get the caption style package ID.

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

◆ getCaptionTranslation()

NveCompoundCaption::getCaptionTranslation ( )

inline

Get the amount of caption translation.

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

◆ getCompoundBoundingVertices()

NveCompoundCaption::getCompoundBoundingVertices	(	boudingType,
		motionParams
	)

inline

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

Parameters

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

Returns: {NveVectorVal} 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: NveVectorVal

◆ getFontFamily()

NveCompoundCaption::getFontFamily ( captionIndex )

inline

Get sub-caption font family with index.

Parameters

{Number} captionIndex sub-caption index

Returns: {String}

◆ getOpacity()

NveCompoundCaption::getOpacity ( )

inline

Get caption opacity.

Returns: {Number} Return the caption opacity.

◆ getRotationZ()

NveCompoundCaption::getRotationZ ( )

inline

Get the rotation angle for the caption.

Returns: {Number} Returns caption rotation angle.

◆ getScaleX()

NveCompoundCaption::getScaleX ( )

inline

Get horizontal scaling factor for caption.

Returns: {Number} Returns caption horizontal scaling factor.

◆ getScaleY()

NveCompoundCaption::getScaleY ( )

inline

Get vertical scaling factor for captions.

Returns: {Number} Returns caption vertical scaling factor.

◆ getText()

NveCompoundCaption::getText ( captionIndex )

inline

Get sub-caption text with index.

Parameters

{Number} captionIndex caption index to get text

Returns: {String} Returns caption text.

◆ getTextColor()

NveCompoundCaption::getTextColor ( captionIndex )

inline

Get sub-caption color with index.

Parameters

{Number} captionIndex caption index to get text color

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

◆ getZValue()

NveCompoundCaption::getZValue ( )

inline

Get caption Z value.

Returns: {Number}

◆ isFrameCaption()

NveCompoundCaption::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

◆ rotateCaption()

NveCompoundCaption::rotateCaption	(	angle,
		anchor
	)

inline

Rotate caption.

Parameters

{Number}	angle angle
{NvePointF}	anchor anchor

Returns: {void}

◆ rotateCaption2()

NveCompoundCaption::rotateCaption2 ( angle )

inline

Rotate catpion on center.

Parameters

{Number} angle angle

Returns: {void}

◆ scaleCaption()

NveCompoundCaption::scaleCaption	(	scaleFactor,
		anchor
	)

inline

Scale caption.

Parameters

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

Returns: {void}

◆ scaleCaption2()

NveCompoundCaption::scaleCaption2 ( scaleFactor )

inline

Scale caption on center.

Parameters

{Number} scaleFactor scale factor

Returns: {void}

◆ setAnchorPoint()

NveCompoundCaption::setAnchorPoint ( anchor )

inline

Set caption anchor.

Parameters

{NvePointF} anchor Anchor

Returns: {viod}

◆ setCaptionTranslation()

NveCompoundCaption::setCaptionTranslation ( translation )

inline

Set the amount of caption translation.

Parameters

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

Returns: {void}

◆ setFontFamily()

NveCompoundCaption::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()

NveCompoundCaption::setOpacity ( value )

inline

Set caption opacity.

Parameters

{Number} value opacity

Returns: {void}

◆ setRotationZ()

NveCompoundCaption::setRotationZ ( angle )

inline

Set the rotation angle for the caption.

Parameters

{Number} angle Rotation angle.

Returns: {void}

◆ setScaleX()

NveCompoundCaption::setScaleX ( scale )

inline

Set horizontal scaling factor for caption.

Parameters

{Number} scale Horizontal scaling factor.

Returns: {void}

◆ setScaleY()

NveCompoundCaption::setScaleY ( scale )

inline

Set vertical scaling factor for captions.

Parameters

{Number} scale Vertical scaling factor.

Returns: {void}

◆ setText()

NveCompoundCaption::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()

NveCompoundCaption::setTextColor	(	captionIndex,
		color
	)

inline

Set sub-caption color with index.

Parameters

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

Returns: {void}

◆ setZValue()

NveCompoundCaption::setZValue ( value )

inline

Set caption Z value.

Parameters

{Number} value Z value

Returns: {void}

◆ translateCaption()

NveCompoundCaption::translateCaption ( translationOffset )

inline

Translate caption.

Parameters

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

Returns: {void}

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

src/js/NvEffectSdk.js

Public Member Functions

Detailed Description

Member Function Documentation

◆ constructor()

◆ getAnchorPoint()

◆ getCaptionBoundingVertices()

◆ getCaptionCount()

◆ getCaptionStylePackageId()

◆ getCaptionTranslation()

◆ getCompoundBoundingVertices()

◆ getFontFamily()

◆ getOpacity()

◆ getRotationZ()

◆ getScaleX()

◆ getScaleY()

◆ getText()

◆ getTextColor()

◆ getZValue()

◆ isFrameCaption()

◆ rotateCaption()

◆ rotateCaption2()

◆ scaleCaption()

◆ scaleCaption2()

◆ setAnchorPoint()

◆ setCaptionTranslation()

◆ setFontFamily()

◆ setOpacity()

◆ setRotationZ()

◆ setScaleX()

◆ setScaleY()

◆ setText()

◆ setTextColor()

◆ setZValue()

◆ translateCaption()