compound caption. More...

Inheritance diagram for com.meicam.effect.sdk.NvsVideoEffectCompoundCaption:

Public Member Functions
int	getCaptionCount ()
	Gets number of sub-cpations in this compound caption. More...

long	getInPoint ()
	Get the in-point of the caption. More...

long	getOutPoint ()
	The out-point of the caption. More...

long	changeInPoint (long newInPoint)
	Changes the in-point of the caption. More...

long	changeOutPoint (long newOutPoint)
	Changes the out-point of the caption. More...

void	movePosition (long offset)
	Changes the display position of the caption (the in and out points are offset from the offset value at the same time). More...

void	setText (int captionIndex, String text)
	Sets caption text. More...

String	getText (int captionIndex)
	Get caption text. More...

void	setFontFamily (int captionIndex, String family)
	Sets caption font family. More...

String	getFontFamily (int captionIndex)
	Get the name of caption font. More...

void	setTextColor (int captionIndex, NvsColor textColor)
	Sets caption text color. More...

NvsColor	getTextColor (int captionIndex)
	Gets the color value of the caption. More...

void	setCaptionTranslation (PointF translation)
	Sets the amount of caption translation. More...

PointF	getCaptionTranslation ()
	Gets the amount of caption translation. More...

void	translateCaption (PointF translationOffset)
	Translate caption. More...

void	setAnchorPoint (PointF anchor)
	Sets caption anchor. More...

PointF	getAnchorPoint ()
	Gets caption anchor. More...

void	setScaleX (float scale)
	Sets horizontal scaling factor for caption. More...

float	getScaleX ()
	Gets caption horizontal scaling factor. More...

void	setScaleY (float scale)
	Sets vertical scaling factor for captions. More...

float	getScaleY ()
	Gets caption vertical scaling factor. More...

void	scaleCaption (float scaleFactor, PointF anchor)
	Zooms caption. More...

void	setRotationZ (float angle)
	Sets the rotation angle for the caption. More...

float	getRotationZ ()
	Gets caption rotation angle. More...

void	rotateCaption (float angle, PointF anchor)
	Rotates captions. More...

void	rotateCaptionAroundCenter (float angle, int boundingType)
	Rotates caption around center of the bounding. More...

List< PointF >	getCaptionBoundingVertices (int captionIndex, int boundingType)
	Gets the transformed vertices position of the original caption bounding. More...

List< PointF >	getCompoundBoundingVertices (int boundingType)
	Gets the transformed vertices position of the original compound caption bounding. More...

void	setZValue (float value)
	Sets caption Z value. More...

float	getZValue ()
	Gets caption Z value. More...

void	setOpacity (float opacity)
	Set the caption opacity. More...

float	getOpacity ()
	Get the caption opacity. More...

String	getCaptionStylePackageId ()
	Gets the caption style package ID. More...

void	setVideoResolution (NvsVideoResolution resolution)
	Set the caption's video resolution. More...

void	setDisableElegantTextHeight (int captionIndex, boolean disableElegantTextHeight)
	Due to historical factors, Meishe SDK uses the elegant text height feature in the horizontal text layout of the Android platform, which will cause the horizontal layout of the Android platform to be different from the line spacing of other platforms. Setting this property will disable the use of the elegant text height feature for Android horizontal layout. The default value is false. More...

boolean	getDisableElegantTextHeight (int captionIndex)
	Get is prohibit elegant text height. More...

void	setWeight (int captionIndex, int weight)
	Sets caption weight. More...

int	getWeight (int captionIndex)
	Get caption weight. More...

void	setItalic (int captionIndex, boolean italic)
	Sets caption italic. More...

boolean	getItalic (int captionIndex)
	Is set caption italic. More...

void	setDrawOutline (boolean drawOutline, int captionIndex)
	Sets caption stroke. More...

boolean	getDrawOutline (int captionIndex)
	Gets the caption stroke status. More...

void	setOutlineColor (NvsColor outlineColor, int captionIndex)
	Sets the color of the caption stroke. More...

NvsColor	getOutlineColor (int captionIndex)
	Gets the color value of the current caption stroke. More...

void	setOutlineWidth (float outlineWidth, int captionIndex)
	Sets the width of the caption stroke. More...

float	getOutlineWidth (int captionIndex)
	Gets the width of the current caption stroke. More...

void	setBackgroundColor (NvsColor backgroundColor, int captionIndex)
	Set text background color. More...

NvsColor	getBackgroundColor (int captionIndex)
	Get the current text background color value. More...

void	setCurrentKeyFrameTime (long time)
	Set the compound caption KeyFrameTime. More...

boolean	setControlPoint (String fxParam, NvsControlPointPair controlPointPair)
	Set the caption's control point pair. More...

NvsControlPointPair	getControlPoint (String fxParam)
	Get the caption's key frame control point pair. More...

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

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

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

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

void	setBold (int captionIndex, boolean bold)
	Sets whether the caption font is bold. More...

boolean	getBold (int captionIndex)
	Gets the state whether the caption font is bold. More...

Public Member Functions inherited from com.meicam.effect.sdk.NvsEffect
NvsFxDescription	getDescription ()
	Gets the description of the Effect. More...

void	setIntVal (String fxParam, int val)
	Sets the integer parameter value of the effect. More...

int	getIntVal (String fxParam)
	Gets the integer parameter value of the effect. More...

void	setIntValAtTime (String fxParam, int val, long time)
	Sets the integer parameter of NvsFx. More...

int	getIntValAtTime (String fxParam, long time)
	Gets the integer parameter of NvsFx. More...

void	setFloatVal (String fxParam, double val)
	Sets the float parameter value of the effect. More...

double	getFloatVal (String fxParam)
	Gets the float parameter value of the effect. More...

void	setFloatValAtTime (String fxParam, double val, long time)
	Sets the float parameter of NvsFx. More...

double	getFloatValAtTime (String fxParam, long time)
	Gets the float parameter of NvsFx. More...

void	setBooleanVal (String fxParam, boolean val)
	Sets the Boolean parameter value of the effect. More...

boolean	getBooleanVal (String fxParam)
	Gets the Boolean parameter value of the effect. More...

void	setBooleanValAtTime (String fxParam, boolean val, long time)
	Sets the boolean parameter of NvsFx. More...

boolean	getBooleanValAtTime (String fxParam, long time)
	Gets the boolean parameter of NvsFx. More...

void	setStringVal (String fxParam, String val)
	Sets the string parameter value of the effect. More...

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

void	setStringValAtTime (String fxParam, String val, long time)
	Sets the string parameter of NvsFx. More...

String	getStringValAtTime (String fxParam, long time)
	Gets the string parameter of NvsFx. More...

void	setColorVal (String fxParam, NvsColor val)
	Sets the color parameter value of the effect. More...

NvsColor	getColorVal (String fxParam)
	Gets the color parameter value of the effect. More...

void	setColorValAtTime (String fxParam, NvsColor val, long time)
	Sets the color parameter of NvsFx. More...

NvsColor	getColorValAtTime (String fxParam, long time)
	Gets the color parameter of NvsFx. More...

void	setPosition2DVal (String fxParam, NvsPosition2D val)
	Sets the 2D coordinates parameter value of the effect. More...

NvsPosition2D	getPosition2DVal (String fxParam)
	Gets the 2D coordinates parameter value of the effect. More...

void	setPosition2DValAtTime (String fxParam, NvsPosition2D val, long time)
	Sets the two dimentional coordinates parameter of NvsFx. More...

NvsPosition2D	getPosition2DValAtTime (String fxParam, long time)
	Gets the two dimentional coordinates parameter of NvsFx. More...

void	setPosition3DVal (String fxParam, NvsPosition3D val)
	Sets the 3D coordinates parameter value of the effect. More...

NvsPosition3D	getPosition3DVal (String fxParam)
	Gets the 3D coordinates parameter value of the effect. More...

void	setPosition3DValAtTime (String fxParam, NvsPosition3D val, long time)
	Sets the three dimentional coordinates parameter of NvsFx. More...

NvsPosition3D	getPosition3DValAtTime (String fxParam, long time)
	Gets the three dimentional coordinates parameter of NvsFx. More...

void	setMenuVal (String fxParam, String val)
	Sets the menu parameter value of the effect. More...

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

void	setMenuValAtTime (String fxParam, String val, long time)
	Sets the menu parameter of NvsFx. More...

String	getMenuValAtTime (String fxParam, long time)
	Gets the menu parameter of NvsFx. More...

void	setArbDataVal (String fxParam, NvsArbitraryData val)
	Sets custom data parameter value. More...

void	setArbDataValAtTime (String fxParam, NvsArbitraryData val, long time)
	Sets custom data parameter value. More...

boolean	setKeyFrameControlPoint (String fxParam, long time, NvsControlPointPair controlPointPair)
	Set key frame control point pair. More...

NvsControlPointPair	getKeyFrameControlPoint (String fxParam, long time)
	Get key frame control point pair. More...

boolean	setKeyFrameControlPointMode (String fxParam, long time, NvsControlPointModePair controlPointModePair)
	Set key frame control point mode pair. More...

NvsControlPointModePair	getKeyFrameControlPointMode (String fxParam, long time)
	Get key frame control point mode pair. More...

void	setFilterIntensity (float intensity)
	Sets the intensity of the filter. More...

float	getFilterIntensity ()
	Gets the intensity of the filter. More...

void	setRegional (boolean isRegional)
	Sets whether the filter is regional. More...

boolean	getRegional ()
	Gets whether the filter is regional. More...

void	setIgnoreBackground (boolean isIgnoreBackground)
	Sets whether the regional filter ignores Background. More...

boolean	getIgnoreBackground ()
	Gets whether the regional filter ignores Background. More...

void	setInverseRegion (boolean isInverseRegion)
	Sets whether the regional filter inverses region. More...

boolean	getInverseRegion ()
	Gets whether the regional filter inverses region. More...

void	setRegion (float[] region)
	Sets the region of this regional filter. More...

void	setRegionInfo (NvsMaskRegionInfo info)
	Sets the region of this regional filter. More...

void	setRegionInfoAtTime (NvsMaskRegionInfo info, long time)
	Sets the region of this regional filter at certain time. More...

void	setRegionalFeatherWidth (float featherWidth)
	Sets the feather width of this regional filter. More...

float	getRegionalFeatherWidth ()
	Gets the feather width of this regional filter. More...

void	setRegionCoordinateSystemType (int type)
	Sets the coordinate system of the region. More...

int	getRegionCoordinateSystemType ()
	Gets the coordinate system of the region. More...

void	setFilterMask (boolean useMask)
	Sets the mask of the filter. More...

boolean	getFilterMask ()
	Gets the usage of the filter's mask. More...

void	release ()
	Releases internal resources. More...

NvsParticleSystemContext	getParticleSystemContext ()

NvsPaintingEffectContext	getPaintingEffectContext ()

NvsARFaceContext	getARFaceContext ()
	Get face effect context. More...

NvsARSceneManipulate	getARSceneManipulate ()
	获得NvsARSceneManipulate接口 More...

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

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

Static Public Attributes
Bounding type

static final int	BOUNDING_TYPE_TEXT = 0
	The actual text bounding. More...

static final int	BOUNDING_TYPE_TEXT_FRAME = 1
	Text frame bounding. More...

static final int	BOUNDING_TYPE_FRAME = 2

Static Public Attributes inherited from com.meicam.effect.sdk.NvsEffect
static final int	KEY_FRAME_FIND_MODE_INPUT_TIME_BEFORE = 1
	find key frame before current time More...

static final int	KEY_FRAME_FIND_MODE_INPUT_TIME_AFTER = 2

static final int	REGION_COORDINATE_SYSTEM_TYPE_NDC = 0
	NDC coordinate system. More...

static final int	REGION_COORDINATE_SYSTEM_TYPE_TIMELINE = 1

static final int	FACE_WARP_EFFECT_STRATEGY_CUSTOM = 0x7FFFFFFF

Additional Inherited Members
Protected Member Functions inherited from com.meicam.effect.sdk.NvsEffect
void	setInternalObject (long internalObject)

long	getInternalObject ()

void	finalize () throws Throwable

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

Warning: In the NvsVideoEffectCompoundCaption class, all public APIs should be used in the UI thread!!!

Since: 2.20.0

Member Function Documentation

◆ changeInPoint()

long com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.changeInPoint ( long newInPoint )

inline

Changes the in-point of the caption.

Parameters

newInPoint The new in-point of the caption (in microseconds).

Returns: Returns the in-point of the caption (in microseconds).

See also: changeOutPoint; getInPoint; movePosition

◆ changeOutPoint()

long com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.changeOutPoint ( long newOutPoint )

inline

Changes the out-point of the caption.

Parameters

newOutPoint The new out-point of the caption (in microseconds).

Returns: Returns the out-point of the caption (in microseconds).

See also: changeInPoint; getOutPoint; movePosition

◆ findKeyframeTime()

long com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.findKeyframeTime	(	String	fxParam,
		long	time,
		int	flags
	)

inline

Get key frame at a specified time point.

Parameters

fxParam	The type of custom data parameter for the effect.
time	time point (In microseconds).
flags	flag of finding mode, Please refer to [KEY_FRAME_FIND_MODE].

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

Since: 3.7.3

Reimplemented from com.meicam.effect.sdk.NvsEffect.

◆ getAnchorPoint()

PointF com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.getAnchorPoint ( )

inline

Gets caption anchor.

Returns: Returns caption anchor.

See also: setAnchorPoint

◆ getBackgroundColor()

NvsColor com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.getBackgroundColor ( int captionIndex )

inline

Get the current text background color value.

Parameters

captionIndex caption index

Returns: Returns the NvsColor object representing the current background color.

See also: setBackgroundColor

Since: 3.7.3

◆ getBold()

boolean com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.getBold ( int captionIndex )

inline

Gets the state whether the caption font is bold.

Parameters

captionIndex caption index

Returns: Returns the state whether the caption font is bold. YES means it is bold, NO means it is not.

See also: setBold: captionIndex:

Since: 3.7.3

◆ getCaptionBoundingVertices()

List<PointF> com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.getCaptionBoundingVertices	(	int	captionIndex,
		int	boundingType
	)

inline

Gets the transformed vertices position of the original caption bounding.

Parameters

captionIndex	Caption index to get vertices positions
boundingType	Bounding type. Please refer to Bounding Type

Returns: Returns a List<PointF> object containing four vertices positions, which correspond to the top left, bottom left, bottom right, and top right vertices of the original bounding.

◆ getCaptionCount()

int com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.getCaptionCount ( )

inline

Gets number of sub-cpations in this compound caption.

Returns: Returns number of sub-cpations

◆ getCaptionStylePackageId()

String com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.getCaptionStylePackageId ( )

inline

Gets the caption style package ID.

Returns: Returns the obtained caption style resource package ID.

Since: 2.20.0

◆ getCaptionTranslation()

PointF com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.getCaptionTranslation ( )

inline

Gets the amount of caption translation.

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

See also: setCaptionTranslation

◆ getCompoundBoundingVertices()

List<PointF> com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.getCompoundBoundingVertices ( int boundingType )

inline

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

Parameters

boundingType Bounding type. Please refer to Bounding Type

Returns: Returns a List<PointF> object containing four vertices positions, which correspond to the top left, bottom left, bottom right, and top right vertices of the original bounding.

◆ getControlPoint()

NvsControlPointPair com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.getControlPoint ( String fxParam )

inline

Get the caption's key frame control point pair.

Parameters

fxParam The type of data parameter for the caption.

Returns: return control point data.NvsControlPointPair对象

See also: setControlPoint

Since: 3.7.3

◆ getDisableElegantTextHeight()

boolean com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.getDisableElegantTextHeight ( int captionIndex )

inline

Get is prohibit elegant text height.

Since: 3.5.2

◆ getDrawOutline()

boolean com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.getDrawOutline ( int captionIndex )

inline

Gets the caption stroke status.

Parameters

captionIndex caption index

Returns: Returns boolean value, true means it is stroked, and false means it is not stroked.

Since: 3.7.3

See also: setDrawOutline

◆ getFontFamily()

String com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.getFontFamily ( int captionIndex )

inline

Get the name of caption font.

Parameters

captionIndex caption index to get font family

Returns: Returns the name of caption font.

See also: setFontFamily

◆ getInPoint()

long com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.getInPoint ( )

inline

Get the in-point of the caption.

Returns: The in-point of the caption (in microseconds).

See also: getOutPoint; changeInPoint

◆ getItalic()

boolean com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.getItalic ( int captionIndex )

inline

Is set caption italic.

Parameters

captionIndex caption index

Returns: Is italic.

See also: setItalic

Since: 3.6.1

◆ getOpacity()

float com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.getOpacity ( )

inline

Get the caption opacity.

Returns: Return the caption opacity.

See also: setOpacity

Since: 2.20.0

◆ getOutlineColor()

NvsColor com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.getOutlineColor ( int captionIndex )

inline

Gets the color value of the current caption stroke.

Parameters

captionIndex caption index

Returns: Returns the NvsColor object representing the color of the resulting caption stroke.

Since: 3.7.3

See also: setOutlineColor

◆ getOutlineWidth()

float com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.getOutlineWidth ( int captionIndex )

inline

Gets the width of the current caption stroke.

Parameters

captionIndex caption index

Returns: Returns the width value of the obtained caption stroke.

Since: 3.7.3

See also: setOutlineWidth

◆ getOutPoint()

long com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.getOutPoint ( )

inline

The out-point of the caption.

Returns: The out-point of the caption (in microseconds).

See also: getInPoint; changeOutPoint

◆ getRotationZ()

float com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.getRotationZ ( )

inline

Gets caption rotation angle.

Returns: Returns caption rotation angle.

See also: setRotationZ

◆ getScaleX()

float com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.getScaleX ( )

inline

Gets caption horizontal scaling factor.

Returns: Returns caption horizontal scaling factor.

See also: setScaleX; getScaleY

◆ getScaleY()

float com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.getScaleY ( )

inline

Gets caption vertical scaling factor.

Returns: Returns caption vertical scaling factor.

See also: setScaleY; getScaleX

◆ getText()

String com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.getText ( int captionIndex )

inline

Get caption text.

Parameters

captionIndex caption index to get text

Returns: Returns caption text.

See also: setText

◆ getTextColor()

NvsColor com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.getTextColor ( int captionIndex )

inline

Gets the color value of the caption.

Parameters

captionIndex caption index to get text color

Returns: Return NvsColor object which is the text color

See also: setTextColor

◆ getWeight()

int com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.getWeight ( int captionIndex )

inline

Get caption weight.

Parameters

captionIndex caption index

Returns: weight the value in opentype weight integer.

See also: setWeight

Since: 3.5.2

◆ getZValue()

float com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.getZValue ( )

inline

Gets caption Z value.

Returns: Returns caption Z value.

◆ hasKeyframeList()

boolean com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.hasKeyframeList ( String fxParam )

inline

Check whether the parameter has key frame list or not.

Parameters

fxParam The type of custom data parameter for the effect.

Returns: Return exist or not.

Since: 3.7.3

Reimplemented from com.meicam.effect.sdk.NvsEffect.

◆ movePosition()

void com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.movePosition ( long offset )

inline

Changes the display position of the caption (the in and out points are offset from the offset value at the same time).

Parameters

offset Offset value for in and out points changes (in microseconds).

See also: changeInPoint; changeOutPoint

◆ removeAllKeyframe()

boolean com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.removeAllKeyframe ( String fxParam )

inline

Remove all key frames from key frame list.

Parameters

fxParam The type of custom data parameter for the effect.

Returns: Return success or not

Since: 3.7.3

Reimplemented from com.meicam.effect.sdk.NvsEffect.

◆ removeKeyframeAtTime()

boolean com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.removeKeyframeAtTime	(	String	fxParam,
		long	time
	)

inline

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

Parameters

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

Returns: Return success or not

Since: 3.7.3

Reimplemented from com.meicam.effect.sdk.NvsEffect.

◆ rotateCaption()

void com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.rotateCaption	(	float	angle,
		PointF	anchor
	)

inline

Rotates captions.

Parameters

angle	Angle of caption rotation.
anchor	Anchor of caption rotation.

◆ rotateCaptionAroundCenter()

void com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.rotateCaptionAroundCenter	(	float	angle,
		int	boundingType
	)

inline

Rotates caption around center of the bounding.

Parameters

angle	Angle of rotation, in degree
boundingType	Bounding type to calculate center point. Please refer to Bounding Type

◆ scaleCaption()

void com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.scaleCaption	(	float	scaleFactor,
		PointF	anchor
	)

inline

Zooms caption.

Parameters

scaleFactor	Caption scaling factor.
anchor	Caption zoom anchor.

◆ setAnchorPoint()

void com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.setAnchorPoint ( PointF anchor )

inline

Sets caption anchor.

Parameters

anchor Anchor.

See also: getAnchorPoint

◆ setBackgroundColor()

void com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.setBackgroundColor	(	NvsColor	backgroundColor,
		int	captionIndex
	)

inline

Set text background color.

Parameters

backgroundColor	Background color value.
captionIndex	caption index

See also: getBackgroundColor

Since: 3.7.3

◆ setBold()

void com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.setBold	(	int	captionIndex,
		boolean	bold
	)

inline

Sets whether the caption font is bold.

Parameters

captionIndex	caption index
bold	Indicates whether the caption font is bold.YES means it is bold, NO means it is not.

See also: getBold:

Since: 3.7.3

◆ setCaptionTranslation()

void com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.setCaptionTranslation ( PointF translation )

inline

Sets the amount of caption translation.

Parameters

translation The horizontal and vertical translation of the caption.

See also: getCaptionTranslation

◆ setControlPoint()

boolean com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.setControlPoint	(	String	fxParam,
		NvsControlPointPair	controlPointPair
	)

inline

Set the caption's control point pair.

Parameters

fxParam	The type of data parameter for the caption.
controlPointPair	control point pair.

See also: getControlPoint

Since: 3.7.3

◆ setCurrentKeyFrameTime()

void com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.setCurrentKeyFrameTime ( long time )

inline

Set the compound caption KeyFrameTime.

See also: setCurrentKeyFrameTime

Since: 3.7.3

◆ setDisableElegantTextHeight()

void com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.setDisableElegantTextHeight	(	int	captionIndex,
		boolean	disableElegantTextHeight
	)

inline

Due to historical factors, Meishe SDK uses the elegant text height feature in the horizontal text layout of the Android platform, which will cause the horizontal layout of the Android platform to be different from the line spacing of other platforms. Setting this property will disable the use of the elegant text height feature for Android horizontal layout. The default value is false.

Parameters

disableElegantTextHeight

Since: 3.5.2

◆ setDrawOutline()

void com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.setDrawOutline	(	boolean	drawOutline,
		int	captionIndex
	)

inline

Sets caption stroke.

Parameters

drawOutline	Whether to stroke the captions. True means it strokes the caption. False means it does not stroke the edges.
captionIndex	caption index to set text

Since: 3.7.3

See also: getDrawOutline

◆ setFontFamily()

void com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.setFontFamily	(	int	captionIndex,
		String	family
	)

inline

Sets caption font family.

Parameters

captionIndex	caption index to set font family
family	Caption font family name. It will be set to default font if family is an empty string

See also: getFontFamily

◆ setItalic()

void com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.setItalic	(	int	captionIndex,
		boolean	italic
	)

inline

Sets caption italic.

Parameters

captionIndex	caption index
Is	italic.

See also: getItalic

Since: 3.6.1

◆ setOpacity()

void com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.setOpacity ( float opacity )

inline

Set the caption opacity.

Parameters

opacity caption opacity.

See also: getOpacity

Since: 2.20.0

◆ setOutlineColor()

void com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.setOutlineColor	(	NvsColor	outlineColor,
		int	captionIndex
	)

inline

Sets the color of the caption stroke.

Parameters

outlineColor	Caption stroke color value.
captionIndex	caption index

Since: 3.7.3

See also: getOutlineColor

◆ setOutlineWidth()

void com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.setOutlineWidth	(	float	outlineWidth,
		int	captionIndex
	)

inline

Sets the width of the caption stroke.

Parameters

outlineWidth	The width of the caption stroke.
captionIndex	caption index

Since: 3.7.3

See also: getOutlineWidth

◆ setRotationZ()

void com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.setRotationZ ( float angle )

inline

Sets the rotation angle for the caption.

Parameters

angle Rotation angle.

See also: getRotationZ

◆ setScaleX()

void com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.setScaleX ( float scale )

inline

Sets horizontal scaling factor for caption.

Parameters

scale Horizontal scaling factor.

See also: getScaleX; setScaleY

◆ setScaleY()

void com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.setScaleY ( float scale )

inline

Sets vertical scaling factor for captions.

Parameters

scale Vertical scaling factor.

See also: getScaleY; setScaleX

◆ setText()

void com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.setText	(	int	captionIndex,
		String	text
	)

inline

Sets caption text.

Parameters

captionIndex	caption index to set text
text	Caption text

See also: getText

◆ setTextColor()

void com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.setTextColor	(	int	captionIndex,
		NvsColor	textColor
	)

inline

Sets caption text color.

Parameters

captionIndex	caption index to set text color
textColor	Caption text color value.

See also: getTextColor

◆ setVideoResolution()

void com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.setVideoResolution ( NvsVideoResolution resolution )

inline

Set the caption's video resolution.

Parameters

resolution The caption's video resolution

Since: 2.20.0

◆ setWeight()

void com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.setWeight	(	int	captionIndex,
		int	weight
	)

inline

Sets caption weight.

Parameters

captionIndex	caption index
weight	the value in opentype weight integer.

See also: getWeight

Since: 3.5.2

◆ setZValue()

void com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.setZValue ( float value )

inline

Sets caption Z value.

Parameters

value Z value

◆ translateCaption()

void com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.translateCaption ( PointF translationOffset )

inline

Translate caption.

Parameters

translationOffset Horizontal and vertical offset values for caption.

See also: setCaptionTranslation; getCaptionTranslation

Member Data Documentation

◆ BOUNDING_TYPE_FRAME

final int com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.BOUNDING_TYPE_FRAME = 2

static

The whole bounding including decoration

◆ BOUNDING_TYPE_TEXT

final int com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.BOUNDING_TYPE_TEXT = 0

static

The actual text bounding.

◆ BOUNDING_TYPE_TEXT_FRAME

final int com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.BOUNDING_TYPE_TEXT_FRAME = 1

static

Text frame bounding.

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

src/android/jar/com/meicam/effect/sdk/NvsVideoEffectCompoundCaption.java

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ changeInPoint()

◆ changeOutPoint()

◆ findKeyframeTime()

◆ getAnchorPoint()

◆ getBackgroundColor()

◆ getBold()

◆ getCaptionBoundingVertices()

◆ getCaptionCount()

◆ getCaptionStylePackageId()

◆ getCaptionTranslation()

◆ getCompoundBoundingVertices()

◆ getControlPoint()

◆ getDisableElegantTextHeight()

◆ getDrawOutline()

◆ getFontFamily()

◆ getInPoint()

◆ getItalic()

◆ getOpacity()

◆ getOutlineColor()

◆ getOutlineWidth()

◆ getOutPoint()

◆ getRotationZ()

◆ getScaleX()

◆ getScaleY()

◆ getText()

◆ getTextColor()

◆ getWeight()

◆ getZValue()

◆ hasKeyframeList()

◆ movePosition()

◆ removeAllKeyframe()

◆ removeKeyframeAtTime()

◆ rotateCaption()

◆ rotateCaptionAroundCenter()

◆ scaleCaption()

◆ setAnchorPoint()

◆ setBackgroundColor()

◆ setBold()

◆ setCaptionTranslation()

◆ setControlPoint()

◆ setCurrentKeyFrameTime()

◆ setDisableElegantTextHeight()

◆ setDrawOutline()

◆ setFontFamily()

◆ setItalic()

◆ setOpacity()

◆ setOutlineColor()

◆ setOutlineWidth()

◆ setRotationZ()

◆ setScaleX()

◆ setScaleY()

◆ setText()

◆ setTextColor()

◆ setVideoResolution()

◆ setWeight()

◆ setZValue()

◆ translateCaption()

Member Data Documentation

◆ BOUNDING_TYPE_FRAME

◆ BOUNDING_TYPE_TEXT

◆ BOUNDING_TYPE_TEXT_FRAME