com.meicam.sdk.NvsClipCompoundCaption Class Reference

Clip compound caption. More...

Inheritance diagram for com.meicam.sdk.NvsClipCompoundCaption:

Public Member Functions
long	getInPoint ()
	Get the in-point of the caption on the Clip. More...
long	getOutPoint ()
	The out-point of the caption on the Clip. More...
long	changeInPoint (long newInPoint)
	Changes the in-point of the caption on the Clip. More...
long	changeOutPoint (long newOutPoint)
	Changes the out-point of the caption on the Clip. More...
void	movePosition (long offset)
	Changes the display position of the caption on the Clip (the in and out points are offset from the offset value at the same time). More...
void	setAbsoluteTimeUsed (boolean enable)
	Set the caption in and out point to absolute time. More...
boolean	getAbsoluteTimeUsed ()
	Get whether the caption in and out point is absolute time. More...
Public Member Functions inherited from com.meicam.sdk.NvsCompoundCaption
int	getCaptionCount ()
	Gets number of sub-cpations in this compound caption. 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...
boolean	isFrameCaption (int captionIndex)
	Determine if the subtitle is a border subtitle. 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	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	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	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.sdk.NvsFx
NvsFxDescription	getDescription ()
	Get decription of Fx. More...
void	setIntVal (String fxParam, int val)
	Set the integer parameter of NvsFx. More...
int	getIntVal (String fxParam)
	Get the integer parameter of NvsFx. More...
void	setIntValAtTime (String fxParam, int val, long time)
	Set the NvsFx's integer parameter at a specified time point. More...
int	getIntValAtTime (String fxParam, long time)
	Get the NvsFx's integer parameter at a specified time point. More...
void	setFloatVal (String fxParam, double val)
	Set the float parameter of NvsFx. More...
double	getFloatVal (String fxParam)
	Get the float parameter of NvsFx. More...
void	setFloatValAtTime (String fxParam, double val, long time)
	Set the NvsFx's float parameter at a specified time point. More...
double	getFloatValAtTime (String fxParam, long time)
	Get the NvsFx's float parameter at a specified time point. More...
void	setBooleanVal (String fxParam, boolean val)
	Set the boolean parameter of NvsFx. More...
boolean	getBooleanVal (String fxParam)
	Get the boolean parameter of NvsFx. More...
void	setBooleanValAtTime (String fxParam, boolean val, long time)
	Set the NvsFx’s boolean parameter at a specified time point. More...
boolean	getBooleanValAtTime (String fxParam, long time)
	Get the NvsFx's boolean parameter at a specified time point. More...
void	setStringVal (String fxParam, String val)
	Set the string parameter of NvsFx. More...
String	getStringVal (String fxParam)
	Get the string parameter of NvsFx. More...
void	setStringValAtTime (String fxParam, String val, long time)
	Set the NvsFx's string parameter at a specified time point. More...
String	getStringValAtTime (String fxParam, long time, int flags)
	Get the NvsFx's string parameter at a specified time point. More...
void	setColorVal (String fxParam, NvsColor val)
	Set the color parameter of NvsFx. More...
NvsColor	getColorVal (String fxParam)
	Get the color parameter of NvsFx. More...
void	setColorValAtTime (String fxParam, NvsColor val, long time)
	Set the NvsFx's color parameter at a specified time point. More...
NvsColor	getColorValAtTime (String fxParam, long time)
	Get the NvsFx's color parameter at a specified time point. More...
void	setPosition2DVal (String fxParam, NvsPosition2D val)
	Set the two dimentional coordinates parameter of NvsFx. More...
NvsPosition2D	getPosition2DVal (String fxParam)
	Get the two dimentional coordinates parameter of NvsFx. More...
void	setPosition2DValAtTime (String fxParam, NvsPosition2D val, long time)
	Set the NvsFx's two dimentional coordinates parameter at a specified time point. More...
NvsPosition2D	getPosition2DValAtTime (String fxParam, long time)
	Get the NvsFx's two dimentional coordinates parameter at a specified time point. More...
void	setPosition3DVal (String fxParam, NvsPosition3D val)
	Set the three dimentional coordinates parameter of NvsFx. More...
NvsPosition3D	getPosition3DVal (String fxParam)
	Get the three dimentional coordinates parameter of NvsFx. More...
void	setPosition3DValAtTime (String fxParam, NvsPosition3D val, long time)
	Set the NvsFx's three dimentional coordinates parameter at a specified time point. More...
NvsPosition3D	getPosition3DValAtTime (String fxParam, long time)
	Get the NvsFx's three dimentional coordinates parameter at a specified time point. More...
void	setMenuVal (String fxParam, String val)
	Set the menu parameter of NvsFx. More...
String	getMenuVal (String fxParam)
	Get the menu parameter of NvsFx. More...
void	setMenuValAtTime (String fxParam, String val, long time)
	Set the NvsFx's menu parameter at a specified time point. More...
String	getMenuValAtTime (String fxParam, long time)
	Get the NvsFx menu parameter at a specified time point. More...
void	setArbDataVal (String fxParam, NvsArbitraryData val)
	Set custom data parameter value. More...
NvsArbitraryData	getArbDataVal (String fxParam)
	Get custom data parameter value. More...
void	setArbDataValAtTime (String fxParam, NvsArbitraryData val, long time)
	Sets custom data parameter value. More...
NvsArbitraryData	getArbDataValAtTime (String fxParam, NvsArbitraryData val, long time)
	Get custom data parameter value at a specified time point. 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)
	Set the intensity of the filter. More...
float	getFilterIntensity ()
	Get the intensity of the filter. More...
void	setFilterMask (boolean useMask)
	Set the mask of the filter. More...
boolean	getFilterMask ()
	Get the usage of the filter's mask. More...
void	setRegional (boolean isRegional)
	Set whether the filter is regional. More...
boolean	getRegional ()
	Get whether the filter is regional. More...
void	setIgnoreBackground (boolean isIgnoreBackground)
	Set whether the regional filter ignores background. More...
boolean	getIgnoreBackground ()
	Get whether the regional filter ignores background. More...
void	setInverseRegion (boolean isInverseRegion)
	Set whether the regional filter inverses region. More...
boolean	getInverseRegion ()
	Get whether the regional filter inverses region. More...
void	setRegion (float[] region)
	Set the region of this regional filter. More...
float[]	getRegion ()
	Get the region of this regional filter. More...
void	setRegionInfo (NvsMaskRegionInfo info)
	Set the mask region informations of the regional filter. More...
NvsMaskRegionInfo	getRegionInfo ()
	Get the mask region informations of the regional filter. More...
void	setRegionInfoAtTime (NvsMaskRegionInfo info, long time)
	Set the regional filter's mask region informations at a specified time point. More...
NvsMaskRegionInfo	getRegionInfoAtTime (long time)
	Get the the regional filter's mask region informations at a specified time. More...
void	setRegionalFeatherWidth (float featherWidth)
	Set the feather width of the regional filter. More...
float	getRegionalFeatherWidth ()
	Get the feather width of the regional filter. More...
void	setRegionalFeatherWidthAtTime (float featherWidth, long time)
	Set the regional filter's feather width at a specified time point. More...
float	getRegionalFeatherWidthAtTime (long time)
	Get the regional filter's feather width at a specified time point. More...
void	setRegionCoordinateSystemType (int type)
	Set the coordinate system of the region. More...
int	getRegionCoordinateSystemType ()
	Get the coordinate system type of the region. More...
NvsParticleSystemContext	getParticleSystemContext ()
	Get the particle effect context object.Please refer to NvsParticleSystemContext. More...
NvsARFaceContext	getARFaceContext ()
	Get face effect context object.Please refer to NvsARFaceContext. More...
NvsPaintingEffectContext	getPaintingEffectContext ()
	Get the particle effect context object.Please refer to NvsPaintingEffectContext. More...
NvsARSceneManipulate	getARSceneManipulate ()
	Get the AR scene operation object.Please refer to 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...
void	setExprStringVar (String varName, String varValue)
	Set the value of the defined parameter in the expression. More...
String	getExprStringVar (String varName)
	Get the value of the defined parameter in the expression. More...
void	setExprObjectVar (String varName, Object varValue)
	Set the value of the defined parameter in the expression. More...
Object	getExprObjectVar (String varName)
	Get the value of the defined parameter in the expression. More...
void	clearExprVar (String varName)
	Clear the value of the defined parameter in the expression and set it to the default value of 0. More...
void	clearExprVarCtx ()
	Clear all parameter values defined in the expression and set them to the default value of 0. More...
Public Member Functions inherited from com.meicam.sdk.NvsObject
void	setAttachment (String key, Object value)
	Adds additional data to the NvsObject object to identify the NvsObject object or for other purpose. More...
void	setTemplateAttachment (String key, String value)
	Adds additional template data to the NvsObject object to identify the NvsObject template object. More...
Object	getAttachment (String key)
	Gets an attachment to NvsObject. More...
String	getTemplateAttachment (String key)
	Gets an template attachment to NvsObject. More...

Additional Inherited Members
Static Public Attributes inherited from com.meicam.sdk.NvsCompoundCaption
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.sdk.NvsFx
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
Static Public Attributes inherited from com.meicam.sdk.NvsObject
static final String	TEMPLATE_KEY_REPLACE_ID = "MSTemplate-ReplaceId"
static final String	TEMPLATE_KEY_FOOTAGE_CAN_REPLACE = "MSTemplate-FootageCanReplace"
static final String	TEMPLATE_KEY_FOOTAGE_ID = "MSTemplate-FootageId"
static final String	TEMPLATE_KEY_FOOTAGE_NAME = "MSTemplate-FootageName"
static final String	TEMPLATE_KEY_FOOTAGE_M3U8_NAME = "MSTemplate-FootageM3U8Name"
static final String	TEMPLATE_KEY_FOOTAGE_TAGS = "MSTemplate-FootageTags"
static final String	TEMPLATE_KEY_FOOTAGE_TYPE = "MSTemplate-FootageType"
static final String	TEMPLATE_KEY_FOOTAGE_NEED_REVERSE = "MSTemplate-FootageNeedReverse"
static final String	TEMPLATE_KEY_CLIP_RAW_WIDTH = "MSTemplate-ClipRawWidth"
static final String	TEMPLATE_KEY_CLIP_RAW_HEIGHT = "MSTemplate-ClipRawHeight"
static final String	TEMPLATE_KEY_VOLUME_TYPE = "MSTemplate-VolumeType"
static final String	TEMPLATE_KEY_FX_GROUP = "MSTemplate-FxGroup"
static final String	TEMPLATE_KEY_BEST_SEEK_TIME = "MSTemplate-BestSeekTime"
static final String	TEMPLATE_KEY_MASK_TYPE = "MSTemplate-MaskType"
static final String	TEMPLATE_VALUE_MASK_TYPE_LINE = "MSTemplate-MaskType-Line"
static final String	TEMPLATE_VALUE_MASK_TYPE_MIRROR = "MSTemplate-MaskType-Mirror"
static final String	TEMPLATE_VALUE_MASK_TYPE_CIRCLE = "MSTemplate-MaskType-Circle"
static final String	TEMPLATE_VALUE_MASK_TYPE_RECT = "MSTemplate-MaskType-Rect"
static final String	TEMPLATE_VALUE_MASK_TYPE_HEART = "MSTemplate-MaskType-Heart"
static final String	TEMPLATE_VALUE_MASK_TYPE_STAR = "MSTemplate-MaskType-Star"
static final String	TEMPLATE_KEY_TRANS_TYPE_CUT = "MSTemplate-TransType-Cut"
static final String	TEMPLATE_KEY_CURVE_SPEED_TYPE = "MSTemplate-CurveSpeedType"
static final String	TEMPLATE_VALUE_CURVE_SPEED_TYPE_CUSTOM = "MSTemplate-CurveSpeedType-Custom"
static final String	TEMPLATE_VALUE_CURVE_SPEED_TYPE_MONTAGE = "MSTemplate-CurveSpeedType-Montage"
static final String	TEMPLATE_VALUE_CURVE_SPEED_TYPE_HERO = "MSTemplate-CurveSpeedType-Hero"
static final String	TEMPLATE_VALUE_CURVE_SPEED_TYPE_BULLET = "MSTemplate-CurveSpeedType-bullet"
static final String	TEMPLATE_VALUE_CURVE_SPEED_TYPE_PLUS = "MSTemplate-CurveSpeedType-Plus"
static final String	TEMPLATE_VALUE_CURVE_SPEED_TYPE_IN = "MSTemplate-CurveSpeedType-In"
static final String	TEMPLATE_VALUE_CURVE_SPEED_TYPE_OUT = "MSTemplate-CurveSpeedType-Out"
Protected Member Functions inherited from com.meicam.sdk.NvsObject
void	setInternalObject (long internalObject)
long	getInternalObject ()
Protected Attributes inherited from com.meicam.sdk.NvsObject
long	m_internalObject = 0

Detailed Description

Clip compound caption.

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

Warning

In the NvsClipCompoundCaption class, all public APIs should be used in the UI thread!!!

Since

3.0.1

Member Function Documentation

changeInPoint()

long com.meicam.sdk.NvsClipCompoundCaption.changeInPoint ( long  newInPoint )

inline

Changes the in-point of the caption on the Clip.

Parameters

newInPoint

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

Returns

Returns the in-point of the caption on the Clip (in microseconds).

See also

changeOutPoint

getInPoint

movePosition

Since

3.0.1

changeOutPoint()

long com.meicam.sdk.NvsClipCompoundCaption.changeOutPoint ( long  newOutPoint )

inline

Changes the out-point of the caption on the Clip.

Parameters

newOutPoint

The new out-point of the caption on the Clip (in microseconds), -1 indicates that the whole clip is covered.

Returns

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

See also

changeInPoint

getOutPoint

movePosition

Since

3.0.1

getAbsoluteTimeUsed()

boolean com.meicam.sdk.NvsClipCompoundCaption.getAbsoluteTimeUsed ( )

inline

Get whether the caption in and out point is absolute time.

Returns

Returns a boolean value. true for yes, false for no.

Since

3.0.2

getInPoint()

long com.meicam.sdk.NvsClipCompoundCaption.getInPoint ( )

inline

Get the in-point of the caption on the Clip.

Returns

The in-point of the caption on the Clip (in microseconds).

See also

getOutPoint

changeInPoint

Since

3.0.1

getOutPoint()

long com.meicam.sdk.NvsClipCompoundCaption.getOutPoint ( )

inline

The out-point of the caption on the Clip.

Returns

The out-point of the caption on the Clip (in microseconds).

See also

getInPoint

changeOutPoint

Since

3.0.1

movePosition()

void com.meicam.sdk.NvsClipCompoundCaption.movePosition ( long  offset )

inline

Changes the display position of the caption on the Clip (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

Since

3.0.1

setAbsoluteTimeUsed()

void com.meicam.sdk.NvsClipCompoundCaption.setAbsoluteTimeUsed ( boolean  enable )

inline

Set the caption in and out point to absolute time.

Parameters

enable

switch checker

Since

3.0.2

---

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

• src/android/jar/com/meicam/sdk/NvsClipCompoundCaption.java