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

Public Member Functions
void	setVideoResolution (NvsVideoResolution resolution)
	Set the sticker's video resolution. 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...

int	getRoleInTheme ()
	The role of caption in the theme. More...

int	getCategory ()
	Gets the type of caption. More...

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

String	getModularCaptionContextPackageId ()
	Gets the modular caption context style package ID. More...

String	getModularCaptionRendererPackageId ()
	Gets the modular caption render style package ID. More...

String	getModularCaptionAnimationPackageId ()
	Gets the modular caption animation style package ID. More...

String	getModularCaptionInAnimationPackageId ()
	Gets the modular caption in-animation style package ID. More...

String	getModularCaptionOutAnimationPackageId ()
	Gets the modular caption out-animation style package ID. More...

boolean	applyCaptionStyle (String captionStylePackageId)
	Applys caption style. More...

boolean	applyCaptionStyle (String captionStylePackageId, int isUseDefaultAssetParam)
	Applys caption style. More...

boolean	applyModularCaptionContext (String captionContextPackageId)
	Applys modular caption context style. More...

boolean	applyModularCaptionRenderer (String captionRendererPackageId)
	Applys modular caption render style. More...

boolean	applyModularCaptionAnimation (String captionAnimationPackageId)
	Applys modular caption loop-animation style. More...

boolean	applyModularCaptionInAnimation (String captionInAnimationPackageId)
	Applys modular caption in-animation style. Notes：please set loop-Animation to null before you set in-animation, otherwise it will NOT works. More...

boolean	applyModularCaptionOutAnimation (String captionOutAnimationPackageId)
	Applys modular caption out-animation style.Notes：please set loop-Animation to null before you set out-animation, otherwise it will NOT works. More...

void	setModularCaptionAnimationPeroid (int periodInMS)
	Set modular caption Animation Peroid. More...

int	getModularCaptionAnimationPeroid ()
	Get modular caption Animation Peroid. More...

void	setModularCaptionInAnimationDuration (int inAnimationDurationInMS)
	Set modular caption in-animation duration. More...

int	getModularCaptionInAnimationDuration ()
	Get modular caption in-animation duration. More...

void	setModularCaptionOutAnimationDuration (int outAnimationDurationInMS)
	Set modular caption out-animation duration. More...

int	getModularCaptionOutAnimationDuration ()
	Get modular caption out-animation duration. More...

void	setText (String text)
	Sets caption text. More...

String	getText ()
	Gets caption text. More...

void	setVerticalLayout (boolean verticalLayout)
	Sets whether to layout text vertically. More...

boolean	getVerticalLayout ()
	Gets whether to layout text vertically. More...

void	setTextAlignment (int textAlign)
	Sets caption horizontal alignment style. More...

int	getTextAlignment ()
	Gets caption horizontal alignment style. More...

void	setTextVerticalAlignment (int verticalTextAlign)
	Sets caption vertical alignment style. More...

int	getTextVerticalAlignment ()
	Gets caption vertical alignment style. More...

void	setBold (boolean bold)
	Sets caption font bold. More...

boolean	getBold ()
	Gets the caption font bold state. More...

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

int	getWeight ()
	Gets the caption weight. More...

void	setItalic (boolean italic)
	Sets caption font italic. More...

boolean	getItalic ()
	Gets the caption italic state. More...

void	setUnderline (boolean underline)
	Sets caption under line. More...

boolean	getUnderline ()
	Gets the caption under line. More...

void	setLetterSpacingType (int letterSpacingType)
	Sets caption word spacing type. More...

int	getLetterSpacingType ()
	Gets caption word spacing type. More...

void	setLetterSpacing (float letterSpacing)
	Sets caption word spacing. More...

float	getLetterSpacing ()
	Gets caption word spacing. More...

void	setLineSpacing (float lineSpacing)
	Sets caption line spacing. More...

float	getLineSpacing ()
	Gets caption line spacing. More...

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

NvsColor	getTextColor ()
	Gets the current color value of the caption font. More...

void	setDrawOutline (boolean drawOutline)
	Sets caption stroke. More...

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

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

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

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

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

void	setDrawShadow (boolean drawShadow)
	Sets caption shadows. More...

boolean	getDrawShadow ()
	Gets the current caption shadow status. More...

void	setShadowColor (NvsColor shadowColor)
	Sets the color of the caption shadow. More...

NvsColor	getShadowColor ()
	Gets the color of the caption shadow. More...

void	setShadowOffset (PointF shadowOffset)
	Sets the offset of the caption shadow. More...

PointF	getShadowOffset ()
	Gets the offset of the current caption shadow. More...

void	setShadowFeather (float feather)
	Sets the feathering degree of the caption shadow. More...

float	getShadowFeather ()
	Gets the feathering degree of the caption shadow. More...

void	setFontSize (float fontSize)
	Sets the caption font size. More...

float	getFontSize ()
	Gets the font size of the current caption. More...

void	setFontByFilePath (String filePath)
	Sets caption font. More...

String	getFontFilePath ()
	Gets the file path of the caption font. More...

void	setFontFamily (String family)
	Sets caption font. More...

String	getFontFamily ()
	Get the name of caption font. 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)
	Caption translation. 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	rotateCaption (float angle)
	Rotates caption with the caption center point as the anchor point. More...

RectF	getTextBoundingRect (boolean actualBoundingRect)
	Gets caption text rectangle. More...

void	setTextFrameOriginRect (RectF rc)
	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. More...

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

void	setSecondaryColor (NvsColor color)
	Sets caption secondary color. it is only used in karaoke subtitles now. More...

NvsColor	getSecondaryColor ()
	Gets the current color value of the caption. More...

boolean	isPanoramic ()
	Determines whether the current caption is a panorama caption. More...

boolean	isModular ()
	Determines whether the current caption is a modular caption. More...

void	setCenterPolarAngle (float centerPolarAngle)
	Sets the polar angle of the center point for the caption. It is only valid for panorama captions. More...

float	getCenterPolarAngle ()
	Gets the polar angle of the center point for the caption. It is only valid for panorama captions. More...

float	getTextCenterPolarAngle ()
	Gets the polar angle of the center point for the caption. It is only valid for panorama captions. More...

void	setCenterAzimuthAngle (float centerAzimuthAngle)
	Sets the azimuth of the center point for the caption. It is only valid for panorama captions. More...

float	getCenterAzimuthAngle ()
	Gets the azimuth of the center point for the caption. It is only valid for panorama captions. More...

float	getTextCenterAzimuthAngle ()
	Gets the azimuth of the center point for the caption. It is only valid for panorama captions. More...

void	setPolarAngleRange (float polarAngleRange)
	Sets the caption's field angle, which is coplanar with the polar angle. It is only valid for panorama captions. More...

float	getPolarAngleRange ()
	Gets the caption's field angle, which is coplanar with the polar angle. It is only valid for panorama captions. More...

float	getOrthoAngleRange ()
	Gets the caption's field angle which is perpendicular to the polar angle. It is only valid for panorama captions. More...

float	getTextPolarAngleRange ()
	Gets the text's field angle which is perpendicular to the polar angle. It is only valid for panorama captions. More...

float	getTextOrthoAngleRange ()
	Gets the text's field angle which is perpendicular to the polar angle. It is only valid for panorama captions. More...

void	setPanoramicScaleX (float scaleX)
	Sets the horizontal scaling factor for the caption. It is only valid for panorama captions. More...

float	getPanoramicScaleX ()
	Gets the horizontal scaling factor for the caption. It is only valid for panorama captions. More...

void	setPanoramicScaleY (float scaleY)
	Sets the vertical scaling factor for the caption. It is only valid for panorama captions. More...

float	getPanoramicScaleY ()
	Gets the vertical scaling factor for the caption. It is only valid for panorama captions. More...

void	setPanoramicRotation (float rotationAngle)
	Sets the rotation angle for the caption. It is only valid for panorama captions. More...

float	getPanoramicRotation ()
	Gets the rotation angle for the caption. It is only valid for panorama captions. More...

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

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

void	setRecordingUserOperation (boolean recordingUserOperation)
	Sets whether to record user actions. More...

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

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

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

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

void	setBackgroundRadius (float radius)
	Set text background rectangle's corner radius. More...

float	getBackgroundRadius ()
	Get the current text background rectangle's corner radius value. More...

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

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

void	setFrameCaptionMaxFontSize (float maxFontSize)
	Sets the max font size for border caption. Only border caption can use this method. 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	removeKeyframeAtTime (String fxParam, long time)
	Remove key frame at time from key frame list. More...

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

boolean	hasKeyframeList (String fxParam)
	Check has key frame list of param. More...

long	findKeyframeTime (String fxParam, long time, int flags)
	Get key frame in list at current time. 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
Caption type

static final int	DEFAULT_CATEGORY = 0
	Default category. More...

static final int	USER_CATEGORY = 1
	Customized category. More...

static final int	THEME_CATEGORY = 2
	Theme category. More...

The role of caption in the theme

static final int	ROLE_IN_THEME_GENERAL = 0
	General. More...

static final int	ROLE_IN_THEME_TITLE = 1
	Title. More...

static final int	ROLE_IN_THEME_TRAILER = 2
	Trailer. More...

Caption alignment

static final int	TEXT_ALIGNMENT_LEFT = 0
	Left alignment. More...

static final int	TEXT_ALIGNMENT_CENTER = 1
	Center alignment. More...

static final int	TEXT_ALIGNMENT_RIGHT = 2
	Right alignment. More...

static final int	TEXT_ALIGNMENT_TOP = 3
	Right alignment. More...

static final int	TEXT_ALIGNMENT_BOTTOM = 4
	Right alignment. More...

static final int	TEXT_ALIGNMENT_VCENTER = 5
	Right alignment. More...

Uses the default caption package properties

static final int	USE_ASSET_DEFAULT_PARAM = 0
	Uses the default caption package properties. More...

static final int	NOT_USE_ASSET_DEFAULT_PARAM = 1
	Do not use the default caption package properties. More...

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
	The whole bounding including decoration. More...

static final int	BOUNDING_TYPE_TEXT_ORIGIN_FRAME = 3

Letter spacing type

static final int	LETTER_SPACING_TYPE_PERCENTAGE = 0
	letter spacing type is percentage More...

static final int	LETTER_SPACING_TYPE_ABSOLUTE = 1

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

captions.

captions are custom text that is superimposed on the video. When editing a video, users can create and remove captions and adjust the captions position. After adding captions, user can also set the style, including font size, color, shadow, stroke, etc.

Warning: In the NvsVideoEffectCaption class, all public APIs are used in the UI thread! ! !

Since: 2.20.0

Member Function Documentation

◆ applyCaptionStyle() [1/2]

boolean com.meicam.effect.sdk.NvsVideoEffectCaption.applyCaptionStyle ( String captionStylePackageId )

inline

Applys caption style.

Parameters

captionStylePackageId Caption style resource package ID.

Returns: Returns boolean value. True means a successful application, false means a failure.

Warning: This interface will cause the streaming engine state to jump to the engine stop state. For details, please refer to Engine Change.

◆ applyCaptionStyle() [2/2]

boolean com.meicam.effect.sdk.NvsVideoEffectCaption.applyCaptionStyle	(	String	captionStylePackageId,
		int	isUseDefaultAssetParam
	)

inline

Applys caption style.

Parameters

captionStylePackageId	Caption style resource package ID.
isUseDefaultAssetParam	Whether to use the properties that come with the caption package. Please refer to Uses the default caption package properties.

Returns: Returns boolean value. True means a successful application, false means a failure.

Warning: This interface will cause the streaming engine state to jump to the engine stop state. For details, please refer to Engine Change.

◆ applyModularCaptionAnimation()

boolean com.meicam.effect.sdk.NvsVideoEffectCaption.applyModularCaptionAnimation ( String captionAnimationPackageId )

inline

Applys modular caption loop-animation style.

Parameters

captionAnimationPackageId Modular caption loop-animation style resource package ID.

Returns: Returns boolean value. True means a successful application, false means a failure.

Warning: This interface will cause the streaming engine state to jump to the engine stop state. For details, please refer to Engine Change.

See also: getModularCaptionAnimationPackageId

◆ applyModularCaptionContext()

boolean com.meicam.effect.sdk.NvsVideoEffectCaption.applyModularCaptionContext ( String captionContextPackageId )

inline

Applys modular caption context style.

Parameters

captionContextPackageId Modular caption context style resource package ID.

Returns: Returns boolean value. True means a successful application, false means a failure.

Warning: This interface will cause the streaming engine state to jump to the engine stop state. For details, please refer to Engine Change.

See also: getModularCaptionContextPackageId

◆ applyModularCaptionInAnimation()

boolean com.meicam.effect.sdk.NvsVideoEffectCaption.applyModularCaptionInAnimation ( String captionInAnimationPackageId )

inline

Applys modular caption in-animation style. Notes：please set loop-Animation to null before you set in-animation, otherwise it will NOT works.

Parameters

captionInAnimationPackageId Modular caption in-animation style resource package ID.

Returns: Returns boolean value. True means a successful application, false means a failure.

Warning: This interface will cause the streaming engine state to jump to the engine stop state. For details, please refer to Engine Change.

See also: getModularCaptionInAnimationPackageId

◆ applyModularCaptionOutAnimation()

boolean com.meicam.effect.sdk.NvsVideoEffectCaption.applyModularCaptionOutAnimation ( String captionOutAnimationPackageId )

inline

Applys modular caption out-animation style.Notes：please set loop-Animation to null before you set out-animation, otherwise it will NOT works.

Parameters

captionOutAnimationPackageId Modular caption out-animation style resource package ID.

Returns: Returns boolean value. True means a successful application, false means a failure.

Warning: This interface will cause the streaming engine state to jump to the engine stop state. For details, please refer to Engine Change.

See also: getModularCaptionOutAnimationPackageId

◆ applyModularCaptionRenderer()

boolean com.meicam.effect.sdk.NvsVideoEffectCaption.applyModularCaptionRenderer ( String captionRendererPackageId )

inline

Applys modular caption render style.

Parameters

captionRendererPackageId Modular caption render style resource package ID.

Returns: Returns boolean value. True means a successful application, false means a failure.

Warning: This interface will cause the streaming engine state to jump to the engine stop state. For details, please refer to Engine Change.

See also: getModularCaptionRenderPackageId

◆ changeInPoint()

long com.meicam.effect.sdk.NvsVideoEffectCaption.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.NvsVideoEffectCaption.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

◆ getAnchorPoint()

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

inline

Gets caption anchor.

Returns: Returns caption anchor.

See also: setAnchorPoint

◆ getBackgroundColor()

NvsColor com.meicam.effect.sdk.NvsVideoEffectCaption.getBackgroundColor ( )

inline

Get the current text background color value.

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

See also: setBackgroundColor

◆ getBackgroundRadius()

float com.meicam.effect.sdk.NvsVideoEffectCaption.getBackgroundRadius ( )

inline

Get the current text background rectangle's corner radius value.

Returns: Returns corner radius value

See also: setBackgroundRadius

◆ getBold()

boolean com.meicam.effect.sdk.NvsVideoEffectCaption.getBold ( )

inline

Gets the caption font bold state.

Returns: Returns the caption font bold state. True means the font is bold, false means the font is not bold.

See also: setBold

◆ getCaptionBoundingVertices()

List<PointF> com.meicam.effect.sdk.NvsVideoEffectCaption.getCaptionBoundingVertices ( int boundingType )

inline

Gets the transformed vertices position of the original 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.

◆ getCaptionStylePackageId()

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

inline

Gets the caption style package ID.

Returns: Returns the obtained caption style resource package ID.

◆ getCaptionTranslation()

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

inline

Gets the amount of caption translation.

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

See also: setCaptionTranslation

◆ getCategory()

int com.meicam.effect.sdk.NvsVideoEffectCaption.getCategory ( )

inline

Gets the type of caption.

Returns: Returns to the obtained Caption type.

◆ getCenterAzimuthAngle()

float com.meicam.effect.sdk.NvsVideoEffectCaption.getCenterAzimuthAngle ( )

inline

Gets the azimuth of the center point for the caption. It is only valid for panorama captions.

Returns: Returns the polar angle of the center point in degrees.

◆ getCenterPolarAngle()

float com.meicam.effect.sdk.NvsVideoEffectCaption.getCenterPolarAngle ( )

inline

Gets the polar angle of the center point for the caption. It is only valid for panorama captions.

Returns: Returns the polar angle of the center point in degrees.

◆ getDrawOutline()

boolean com.meicam.effect.sdk.NvsVideoEffectCaption.getDrawOutline ( )

inline

Gets the caption stroke status.

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

See also: setDrawOutline

◆ getDrawShadow()

boolean com.meicam.effect.sdk.NvsVideoEffectCaption.getDrawShadow ( )

inline

Gets the current caption shadow status.

Returns: Returns boolean value. True means there is caption shadow, false means there is no caption shadow.

See also: setDrawShadow

◆ getFontFamily()

String com.meicam.effect.sdk.NvsVideoEffectCaption.getFontFamily ( )

inline

Get the name of caption font.

Returns: Returns the name of caption font.

See also: setFontFamily

◆ getFontFilePath()

String com.meicam.effect.sdk.NvsVideoEffectCaption.getFontFilePath ( )

inline

Gets the file path of the caption font.

Returns: Returns the file path of the caption font.

See also: setFontByFilePath

◆ getFontSize()

float com.meicam.effect.sdk.NvsVideoEffectCaption.getFontSize ( )

inline

Gets the font size of the current caption.

Returns: Returns the obtained caption font size value.

See also: setFontSize

◆ getInPoint()

long com.meicam.effect.sdk.NvsVideoEffectCaption.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.NvsVideoEffectCaption.getItalic ( )

inline

Gets the caption italic state.

Returns: Returns boolean value. True means it is italic font, false means it is not italic.

See also: setItalic

◆ getLetterSpacing()

float com.meicam.effect.sdk.NvsVideoEffectCaption.getLetterSpacing ( )

inline

Gets caption word spacing.

Returns: Returns the float value, the percentage value by default.(LETTER_SPACING_TYPE)

See also: setLetterSpacing; setLetterSpacingType

◆ getLetterSpacingType()

int com.meicam.effect.sdk.NvsVideoEffectCaption.getLetterSpacingType ( )

inline

Gets caption word spacing type.

Returns: return letterSpacingType.(LETTER_SPACING_TYPE)

See also: setLetterSpacingType

◆ getLineSpacing()

float com.meicam.effect.sdk.NvsVideoEffectCaption.getLineSpacing ( )

inline

Gets caption line spacing.

Returns: return float value, line spacing is expressed in absolute value.

See also: setLineSpacing

◆ getModularCaptionAnimationPackageId()

String com.meicam.effect.sdk.NvsVideoEffectCaption.getModularCaptionAnimationPackageId ( )

inline

Gets the modular caption animation style package ID.

Returns: Returns the obtained modular caption animation style resource package ID.

See also: isModular; applyModularCaptionAnimation

◆ getModularCaptionAnimationPeroid()

int com.meicam.effect.sdk.NvsVideoEffectCaption.getModularCaptionAnimationPeroid ( )

inline

Get modular caption Animation Peroid.

Returns: Return animation peroid in million second

See also: setModularCaptionAnimationPeroid

◆ getModularCaptionContextPackageId()

String com.meicam.effect.sdk.NvsVideoEffectCaption.getModularCaptionContextPackageId ( )

inline

Gets the modular caption context style package ID.

Returns: Returns the obtained modular caption context style resource package ID.

See also: isModular; applyModularCaptionContext

◆ getModularCaptionInAnimationDuration()

int com.meicam.effect.sdk.NvsVideoEffectCaption.getModularCaptionInAnimationDuration ( )

inline

Get modular caption in-animation duration.

Returns: Return in-animation duration in million second

See also: setModularCaptionInAnimationDuration

◆ getModularCaptionInAnimationPackageId()

String com.meicam.effect.sdk.NvsVideoEffectCaption.getModularCaptionInAnimationPackageId ( )

inline

Gets the modular caption in-animation style package ID.

Returns: Returns the obtained modular caption in-animation style resource package ID.

See also: isModular; applyModularCaptionInAnimation

◆ getModularCaptionOutAnimationDuration()

int com.meicam.effect.sdk.NvsVideoEffectCaption.getModularCaptionOutAnimationDuration ( )

inline

Get modular caption out-animation duration.

Returns: Return out-animation duration in million second

See also: setModularCaptionOutAnimationDuration

◆ getModularCaptionOutAnimationPackageId()

String com.meicam.effect.sdk.NvsVideoEffectCaption.getModularCaptionOutAnimationPackageId ( )

inline

Gets the modular caption out-animation style package ID.

Returns: Returns the obtained modular caption out-animation style resource package ID.

See also: isModular; applyModularCaptionOutAnimation

◆ getModularCaptionRendererPackageId()

String com.meicam.effect.sdk.NvsVideoEffectCaption.getModularCaptionRendererPackageId ( )

inline

Gets the modular caption render style package ID.

Returns: Returns the obtained modular caption render style resource package ID.

See also: isModular; applyModularCaptionRenderer

◆ getOpacity()

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

inline

Get the caption opacity.

Returns: Return the caption opacity.

See also: setOpacity

◆ getOrthoAngleRange()

float com.meicam.effect.sdk.NvsVideoEffectCaption.getOrthoAngleRange ( )

inline

Gets the caption's field angle which is perpendicular to the polar angle. It is only valid for panorama captions.

Returns: Returns caption's field angle which is perpendicular to the polar angle, in degrees.

◆ getOutlineColor()

NvsColor com.meicam.effect.sdk.NvsVideoEffectCaption.getOutlineColor ( )

inline

Gets the color value of the current caption stroke.

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

See also: setOutlineColor

◆ getOutlineWidth()

float com.meicam.effect.sdk.NvsVideoEffectCaption.getOutlineWidth ( )

inline

Gets the width of the current caption stroke.

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

See also: setOutlineWidth

◆ getOutPoint()

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

inline

The out-point of the caption .

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

See also: getInPoint; changeOutPoint

◆ getPanoramicRotation()

float com.meicam.effect.sdk.NvsVideoEffectCaption.getPanoramicRotation ( )

inline

Gets the rotation angle for the caption. It is only valid for panorama captions.

Returns: Returns the rotation angle of caption.

◆ getPanoramicScaleX()

float com.meicam.effect.sdk.NvsVideoEffectCaption.getPanoramicScaleX ( )

inline

Gets the horizontal scaling factor for the caption. It is only valid for panorama captions.

Returns: Returns horizontal scaling factor.

◆ getPanoramicScaleY()

float com.meicam.effect.sdk.NvsVideoEffectCaption.getPanoramicScaleY ( )

inline

Gets the vertical scaling factor for the caption. It is only valid for panorama captions.

Returns: Returns the vertical scaling factor.

◆ getPolarAngleRange()

float com.meicam.effect.sdk.NvsVideoEffectCaption.getPolarAngleRange ( )

inline

Gets the caption's field angle, which is coplanar with the polar angle. It is only valid for panorama captions.

Returns: Returns field angle coplanar with the polar angle, in degrees.

◆ getRoleInTheme()

int com.meicam.effect.sdk.NvsVideoEffectCaption.getRoleInTheme ( )

inline

The role of caption in the theme.

Returns: Returns The role of caption in the theme.

◆ getRotationZ()

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

inline

Gets caption rotation angle.

Returns: Returns caption rotation angle.

See also: setRotationZ

◆ getScaleX()

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

inline

Gets caption horizontal scaling factor.

Returns: Returns caption horizontal scaling factor.

See also: setScaleX; getScaleY

◆ getScaleY()

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

inline

Gets caption vertical scaling factor.

Returns: Returns caption vertical scaling factor.

See also: setScaleY; getScaleX

◆ getSecondaryColor()

NvsColor com.meicam.effect.sdk.NvsVideoEffectCaption.getSecondaryColor ( )

inline

Gets the current color value of the caption.

Returns: Returns the NvsColor object representing the color value obtained.

See also: setSecondaryColor

◆ getShadowColor()

NvsColor com.meicam.effect.sdk.NvsVideoEffectCaption.getShadowColor ( )

inline

Gets the color of the caption shadow.

Returns: Returns the NvsColor object representing the caption shadow color value obtained.

See also: setShadowColor

◆ getShadowFeather()

float com.meicam.effect.sdk.NvsVideoEffectCaption.getShadowFeather ( )

inline

Gets the feathering degree of the caption shadow.

Returns: Returns feathering degree

See also: setShadowFeather

◆ getShadowOffset()

PointF com.meicam.effect.sdk.NvsVideoEffectCaption.getShadowOffset ( )

inline

Gets the offset of the current caption shadow.

Returns: Returns a PointF object representing the caption shadow offset obtained.

See also: setShadowOffset

◆ getText()

String com.meicam.effect.sdk.NvsVideoEffectCaption.getText ( )

inline

Gets caption text.

Returns: Returns caption text obtained.

See also: setText

◆ getTextAlignment()

int com.meicam.effect.sdk.NvsVideoEffectCaption.getTextAlignment ( )

inline

Gets caption horizontal alignment style.

Returns: Returns caption horizontal alignment style.

See also: setTextAlignment

◆ getTextBoundingRect()

RectF com.meicam.effect.sdk.NvsVideoEffectCaption.getTextBoundingRect ( boolean actualBoundingRect )

inline

Gets caption text rectangle.

Returns: Returns RectF object representing the obtained caption text rectangle.

◆ getTextCenterAzimuthAngle()

float com.meicam.effect.sdk.NvsVideoEffectCaption.getTextCenterAzimuthAngle ( )

inline

Gets the azimuth of the center point for the caption. It is only valid for panorama captions.

Returns: Returns the polar angle of the center point in degrees.

◆ getTextCenterPolarAngle()

float com.meicam.effect.sdk.NvsVideoEffectCaption.getTextCenterPolarAngle ( )

inline

Gets the polar angle of the center point for the caption. It is only valid for panorama captions.

Returns: Returns the polar angle of the center point in degrees.

◆ getTextColor()

NvsColor com.meicam.effect.sdk.NvsVideoEffectCaption.getTextColor ( )

inline

Gets the current color value of the caption font.

Returns: Returns the NvsColor object representing the color value obtained.

See also: setTextColor

◆ getTextOrthoAngleRange()

float com.meicam.effect.sdk.NvsVideoEffectCaption.getTextOrthoAngleRange ( )

inline

Gets the text's field angle which is perpendicular to the polar angle. It is only valid for panorama captions.

Returns: Returns text's field angle which is perpendicular to the polar angle, in degrees.

◆ getTextPolarAngleRange()

float com.meicam.effect.sdk.NvsVideoEffectCaption.getTextPolarAngleRange ( )

inline

Gets the text's field angle which is perpendicular to the polar angle. It is only valid for panorama captions.

Returns: Returns the text's field angle which is perpendicular to the polar angle, in degrees.

◆ getTextVerticalAlignment()

int com.meicam.effect.sdk.NvsVideoEffectCaption.getTextVerticalAlignment ( )

inline

Gets caption vertical alignment style.

Returns: Returns caption vertical alignment style.

See also: setTextVerticalAlignment

◆ getUnderline()

boolean com.meicam.effect.sdk.NvsVideoEffectCaption.getUnderline ( )

inline

Gets the caption under line.

Returns: Returns boolean value. True means it is under line, false means it is not.

See also: setUnderline

◆ getVerticalLayout()

boolean com.meicam.effect.sdk.NvsVideoEffectCaption.getVerticalLayout ( )

inline

Gets whether to layout text vertically.

Returns: Returns whether to layout text vertically

See also: setVerticalLayout

◆ getWeight()

int com.meicam.effect.sdk.NvsVideoEffectCaption.getWeight ( )

inline

Gets the caption weight.

Returns: Returns the caption weight.

See also: setWeight

◆ getZValue()

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

inline

Gets caption Z value.

Returns: Returns caption Z value.

◆ isFrameCaption()

boolean com.meicam.effect.sdk.NvsVideoEffectCaption.isFrameCaption ( )

inline

Determine if it is a border caption.

Returns: A return value of true indicates a border caption

◆ isModular()

boolean com.meicam.effect.sdk.NvsVideoEffectCaption.isModular ( )

inline

Determines whether the current caption is a modular caption.

Returns: If returns value is true, it is modular caption.

◆ isPanoramic()

boolean com.meicam.effect.sdk.NvsVideoEffectCaption.isPanoramic ( )

inline

Determines whether the current caption is a panorama caption.

Returns: If returns value is true, it is panorama caption.

◆ movePosition()

void com.meicam.effect.sdk.NvsVideoEffectCaption.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

◆ rotateCaption() [1/2]

void com.meicam.effect.sdk.NvsVideoEffectCaption.rotateCaption ( float angle )

inline

Rotates caption with the caption center point as the anchor point.

Parameters

angle Angle of caption rotation.

◆ rotateCaption() [2/2]

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

inline

Rotates captions.

Parameters

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

◆ scaleCaption()

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

inline

Zooms caption.

Parameters

scaleFactor	Caption scaling factor.
anchor	Caption zoom anchor.

◆ setAnchorPoint()

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

inline

Sets caption anchor.

Parameters

anchor Anchor.

See also: getAnchorPoint

◆ setBackgroundColor()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setBackgroundColor ( NvsColor backgroundColor )

inline

Set text background color.

Parameters

backgroundColor Background color value.

See also: getBackgroundColor

◆ setBackgroundRadius()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setBackgroundRadius ( float radius )

inline

Set text background rectangle's corner radius.

Parameters

radius Corner radius value

See also: getBackgroundRadius

◆ setBold()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setBold ( boolean bold )

inline

Sets caption font bold.

Parameters

bold	Indicates whether the caption font is bold. True means the font is bold, false means the font is not bold.

See also: getBold

◆ setCaptionTranslation()

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

inline

Sets the amount of caption translation.

Parameters

translation The horizontal and vertical absolute translation of the caption.

See also: getCaptionTranslation

◆ setCenterAzimuthAngle()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setCenterAzimuthAngle ( float centerAzimuthAngle )

inline

Sets the azimuth of the center point for the caption. It is only valid for panorama captions.

Parameters

centerAzimuthAngle The polar angle of the center point in degrees.

◆ setCenterPolarAngle()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setCenterPolarAngle ( float centerPolarAngle )

inline

Sets the polar angle of the center point for the caption. It is only valid for panorama captions.

Parameters

centerPolarAngle The polar angle of the center point in degrees.

◆ setCurrentKeyFrameTime()

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

inline

Set the caption KeyFrameTime.

See also: setCurrentKeyFrameTime

◆ setDrawOutline()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setDrawOutline ( boolean drawOutline )

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.

See also: getDrawOutline

◆ setDrawShadow()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setDrawShadow ( boolean drawShadow )

inline

Sets caption shadows.

Parameters

drawShadow Whether to set the caption shadow. True means to set the caption shadow, false means to not set.

See also: getDrawShadow

◆ setFontByFilePath()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setFontByFilePath ( String filePath )

inline

Sets caption font.

Parameters

filePath The file path of the caption font. If it is set to a null string, it is set as the default font.

See also: getFontFilePath

◆ setFontFamily()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setFontFamily ( String family )

inline

Sets caption font.

Parameters

family Caption font name. It will be set to default font if a null string which is given.

See also: getFontFamily

◆ setFontSize()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setFontSize ( float fontSize )

inline

Sets the caption font size.

Parameters

fontSize Caption font size value

See also: getFontSize

◆ setFrameCaptionMaxFontSize()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setFrameCaptionMaxFontSize ( float maxFontSize )

inline

Sets the max font size for border caption. Only border caption can use this method.

◆ setItalic()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setItalic ( boolean italic )

inline

Sets caption font italic.

Parameters

italic Whether it is set to italic. True means that the caption font is set to italic, and false means the caption font is not set to italic.

See also: getItalic

◆ setLetterSpacing()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setLetterSpacing ( float letterSpacing )

inline

Sets caption word spacing.

Parameters

letterSpacing Word spacing is expressed in percentage value by default. (LETTER_SPACING_TYPE)

See also: getLetterSpacing; setLetterSpacingType

◆ setLetterSpacingType()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setLetterSpacingType ( int letterSpacingType )

inline

Sets caption word spacing type.

Parameters

letterSpacingType Word spacing type.(LETTER_SPACING_TYPE)

See also: getLetterSpacingType

◆ setLineSpacing()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setLineSpacing ( float lineSpacing )

inline

Sets caption line spacing.

Parameters

lineSpacing line spacing is expressed in absolute value.

See also: getLineSpacing

◆ setModularCaptionAnimationPeroid()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setModularCaptionAnimationPeroid ( int periodInMS )

inline

Set modular caption Animation Peroid.

Parameters

periodInMS Animation peroid in million second

See also: getModularCaptionAnimationPeroid

◆ setModularCaptionInAnimationDuration()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setModularCaptionInAnimationDuration ( int inAnimationDurationInMS )

inline

Set modular caption in-animation duration.

Parameters

inAnimationDurationInMS in-animation duration in million second

See also: getModularCaptionInAnimationDuration

◆ setModularCaptionOutAnimationDuration()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setModularCaptionOutAnimationDuration ( int outAnimationDurationInMS )

inline

Set modular caption out-animation duration.

Parameters

outAnimationDurationInMS out-animation duration in million second

See also: getModularCaptionOutAnimationDuration

◆ setOpacity()

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

inline

Set the caption opacity.

Parameters

opacity caption opacity.

See also: getOpacity

◆ setOutlineColor()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setOutlineColor ( NvsColor outlineColor )

inline

Sets the color of the caption stroke.

Parameters

outlineColor Caption stroke color value.

See also: getOutlineColor

◆ setOutlineWidth()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setOutlineWidth ( float outlineWidth )

inline

Sets the width of the caption stroke.

Parameters

outlineWidth The width of the caption stroke.

See also: getOutlineWidth

◆ setPanoramicRotation()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setPanoramicRotation ( float rotationAngle )

inline

Sets the rotation angle for the caption. It is only valid for panorama captions.

Parameters

rotationAngle The rotation angle.

◆ setPanoramicScaleX()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setPanoramicScaleX ( float scaleX )

inline

Sets the horizontal scaling factor for the caption. It is only valid for panorama captions.

Parameters

scaleX Horizontal scaling factor.

◆ setPanoramicScaleY()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setPanoramicScaleY ( float scaleY )

inline

Sets the vertical scaling factor for the caption. It is only valid for panorama captions.

Parameters

scaleY The vertical scaling factor.

◆ setPolarAngleRange()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setPolarAngleRange ( float polarAngleRange )

inline

Sets the caption's field angle, which is coplanar with the polar angle. It is only valid for panorama captions.

Parameters

polarAngleRange The field angle coplanar with the polar angle, in degrees.

◆ setRecordingUserOperation()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setRecordingUserOperation ( boolean recordingUserOperation )

inline

Sets whether to record user actions.

Parameters

recordingUserOperation

◆ setRotationZ()

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

inline

Sets the rotation angle for the caption.

Parameters

angle Rotation angle.

See also: getRotationZ

◆ setScaleX()

void com.meicam.effect.sdk.NvsVideoEffectCaption.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.NvsVideoEffectCaption.setScaleY ( float scale )

inline

Sets vertical scaling factor for captions.

Parameters

scale Vertical scaling factor.

See also: getScaleY; setScaleX

◆ setSecondaryColor()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setSecondaryColor ( NvsColor color )

inline

Sets caption secondary color. it is only used in karaoke subtitles now.

Parameters

textColor Caption color value.

See also: getSecondaryColor

◆ setShadowColor()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setShadowColor ( NvsColor shadowColor )

inline

Sets the color of the caption shadow.

Parameters

shadowColor Caption shadow color value.

See also: getShadowColor

◆ setShadowFeather()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setShadowFeather ( float feather )

inline

Sets the feathering degree of the caption shadow.

Parameters

feather feathering degree

See also: getShadowFeather

◆ setShadowOffset()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setShadowOffset ( PointF shadowOffset )

inline

Sets the offset of the caption shadow.

Parameters

shadowOffset Caption shadow offset.

See also: getShadowOffset

◆ setText()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setText ( String text )

inline

Sets caption text.

Parameters

text	Caption text

See also: getText

◆ setTextAlignment()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setTextAlignment ( int textAlign )

inline

Sets caption horizontal alignment style.

Parameters

textAlign Indicates the caption horizontal alignment style. Please refer to Caption alignment.

See also: getTextAlignment; setTextVerticalAlignment

◆ setTextColor()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setTextColor ( NvsColor textColor )

inline

Sets caption text color.

Parameters

textColor Caption text color value.

See also: getTextColor

◆ setTextFrameOriginRect()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setTextFrameOriginRect ( RectF rc )

inline

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

rc	New frame size.

See also: getCaptionBoundingVertices

◆ setTextVerticalAlignment()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setTextVerticalAlignment ( int verticalTextAlign )

inline

Sets caption vertical alignment style.

Parameters

textAlign Indicates the caption vertical alignment style. Please refer to Caption alignment.

See also: getTextVerticalAlignment; setTextAlignment

◆ setUnderline()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setUnderline ( boolean underline )

inline

Sets caption under line.

Parameters

underline Whether it is set to under line.

See also: getUnderline

◆ setVerticalLayout()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setVerticalLayout ( boolean verticalLayout )

inline

Sets whether to layout text vertically.

Parameters

verticalLayout whether to layout text vertically

See also: getVerticalLayout

◆ setVideoResolution()

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

inline

Set the sticker's video resolution.

Parameters

resolution The sticker's video resolution

Since: 2.20.0

◆ setWeight()

void com.meicam.effect.sdk.NvsVideoEffectCaption.setWeight ( int weight )

inline

Sets caption weight.

Parameters

weight the value in opentype weight integer.

See also: getWeight

◆ setZValue()

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

inline

Sets caption Z value.

Parameters

value Z value

◆ translateCaption()

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

inline

Caption translation.

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.NvsVideoEffectCaption.BOUNDING_TYPE_FRAME = 2

static

The whole bounding including decoration.

◆ BOUNDING_TYPE_TEXT

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

static

The actual text bounding.

◆ BOUNDING_TYPE_TEXT_FRAME

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

static

Text frame bounding.

◆ BOUNDING_TYPE_TEXT_ORIGIN_FRAME

final int com.meicam.effect.sdk.NvsVideoEffectCaption.BOUNDING_TYPE_TEXT_ORIGIN_FRAME = 3

static

Text frame bounding that has not been transformed

◆ DEFAULT_CATEGORY

final int com.meicam.effect.sdk.NvsVideoEffectCaption.DEFAULT_CATEGORY = 0

static

Default category.

◆ LETTER_SPACING_TYPE_ABSOLUTE

final int com.meicam.effect.sdk.NvsVideoEffectCaption.LETTER_SPACING_TYPE_ABSOLUTE = 1

static

letter spacing type is absolute

◆ LETTER_SPACING_TYPE_PERCENTAGE

final int com.meicam.effect.sdk.NvsVideoEffectCaption.LETTER_SPACING_TYPE_PERCENTAGE = 0

static

letter spacing type is percentage

◆ NOT_USE_ASSET_DEFAULT_PARAM

final int com.meicam.effect.sdk.NvsVideoEffectCaption.NOT_USE_ASSET_DEFAULT_PARAM = 1

static

Do not use the default caption package properties.

◆ ROLE_IN_THEME_GENERAL

final int com.meicam.effect.sdk.NvsVideoEffectCaption.ROLE_IN_THEME_GENERAL = 0

static

General.

◆ ROLE_IN_THEME_TITLE

final int com.meicam.effect.sdk.NvsVideoEffectCaption.ROLE_IN_THEME_TITLE = 1

static

Title.

◆ ROLE_IN_THEME_TRAILER

final int com.meicam.effect.sdk.NvsVideoEffectCaption.ROLE_IN_THEME_TRAILER = 2

static

Trailer.

◆ TEXT_ALIGNMENT_BOTTOM

final int com.meicam.effect.sdk.NvsVideoEffectCaption.TEXT_ALIGNMENT_BOTTOM = 4

static

Right alignment.

◆ TEXT_ALIGNMENT_CENTER

final int com.meicam.effect.sdk.NvsVideoEffectCaption.TEXT_ALIGNMENT_CENTER = 1

static

Center alignment.

◆ TEXT_ALIGNMENT_LEFT

final int com.meicam.effect.sdk.NvsVideoEffectCaption.TEXT_ALIGNMENT_LEFT = 0

static

Left alignment.

◆ TEXT_ALIGNMENT_RIGHT

final int com.meicam.effect.sdk.NvsVideoEffectCaption.TEXT_ALIGNMENT_RIGHT = 2

static

Right alignment.

◆ TEXT_ALIGNMENT_TOP

final int com.meicam.effect.sdk.NvsVideoEffectCaption.TEXT_ALIGNMENT_TOP = 3

static

Right alignment.

◆ TEXT_ALIGNMENT_VCENTER

final int com.meicam.effect.sdk.NvsVideoEffectCaption.TEXT_ALIGNMENT_VCENTER = 5

static

Right alignment.

◆ THEME_CATEGORY

final int com.meicam.effect.sdk.NvsVideoEffectCaption.THEME_CATEGORY = 2

static

Theme category.

◆ USE_ASSET_DEFAULT_PARAM

final int com.meicam.effect.sdk.NvsVideoEffectCaption.USE_ASSET_DEFAULT_PARAM = 0

static

Uses the default caption package properties.

◆ USER_CATEGORY

final int com.meicam.effect.sdk.NvsVideoEffectCaption.USER_CATEGORY = 1

static

Customized category.

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

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

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ applyCaptionStyle() [1/2]

◆ applyCaptionStyle() [2/2]

◆ applyModularCaptionAnimation()

◆ applyModularCaptionContext()

◆ applyModularCaptionInAnimation()

◆ applyModularCaptionOutAnimation()

◆ applyModularCaptionRenderer()

◆ changeInPoint()

◆ changeOutPoint()

◆ getAnchorPoint()

◆ getBackgroundColor()

◆ getBackgroundRadius()

◆ getBold()

◆ getCaptionBoundingVertices()

◆ getCaptionStylePackageId()

◆ getCaptionTranslation()

◆ getCategory()

◆ getCenterAzimuthAngle()

◆ getCenterPolarAngle()

◆ getDrawOutline()

◆ getDrawShadow()

◆ getFontFamily()

◆ getFontFilePath()

◆ getFontSize()

◆ getInPoint()

◆ getItalic()

◆ getLetterSpacing()

◆ getLetterSpacingType()

◆ getLineSpacing()

◆ getModularCaptionAnimationPackageId()

◆ getModularCaptionAnimationPeroid()

◆ getModularCaptionContextPackageId()

◆ getModularCaptionInAnimationDuration()

◆ getModularCaptionInAnimationPackageId()

◆ getModularCaptionOutAnimationDuration()

◆ getModularCaptionOutAnimationPackageId()

◆ getModularCaptionRendererPackageId()

◆ getOpacity()

◆ getOrthoAngleRange()

◆ getOutlineColor()

◆ getOutlineWidth()

◆ getOutPoint()

◆ getPanoramicRotation()

◆ getPanoramicScaleX()

◆ getPanoramicScaleY()

◆ getPolarAngleRange()

◆ getRoleInTheme()

◆ getRotationZ()

◆ getScaleX()

◆ getScaleY()

◆ getSecondaryColor()

◆ getShadowColor()

◆ getShadowFeather()

◆ getShadowOffset()

◆ getText()

◆ getTextAlignment()

◆ getTextBoundingRect()

◆ getTextCenterAzimuthAngle()

◆ getTextCenterPolarAngle()

◆ getTextColor()

◆ getTextOrthoAngleRange()

◆ getTextPolarAngleRange()

◆ getTextVerticalAlignment()

◆ getUnderline()

◆ getVerticalLayout()

◆ getWeight()

◆ getZValue()

◆ isFrameCaption()

◆ isModular()

◆ isPanoramic()

◆ movePosition()

◆ rotateCaption() [1/2]

◆ rotateCaption() [2/2]

◆ scaleCaption()

◆ setAnchorPoint()