Inheritance diagram for com.meicam.sdk.NvsCaption:

Public Member Functions
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, valid for frame-caption only. More...

int	getTextVerticalAlignment ()
	Gets caption vertical alignment style, valid for frame-caption only. 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...

void	resetTextColorState ()
	reset caption text color state. 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	resetOutlineColorState ()
	reset caption text color state. 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	setBoundaryPaddingRatio (float ratio)
	Sets the caption boundary padding ratio. More...

float	getBoundaryPaddingRatio ()
	Gets the caption boundary padding ratio. 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...

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

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

List< PointF >	getBoundingRectangleVertices ()
	Gets the vertex position of the original enclosing rectangle of the caption after transformation. 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...

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

NvsColor	getSecondaryOutlineColor ()
	Gets the current outline sencondary 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...

boolean	isRecordingUserOperation ()
	Default is true. 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	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	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...

void	setTextSpanList (List< NvsCaptionSpan > nvCaptionSpanList)

List< NvsCaptionSpan >	getTextSpanList ()

NvsCaptionTextLayout	getTextLayout ()

void	setDisableElegantTextHeight (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 ()
	Get is prohibit elegant text height. More...

int	getComplexRenderLayerCount ()

boolean	hasOutlineLayerInComplexRender (int layerIndex)

NvsColor	getComplexRenderLayerOutlineColor (int layerIndex)

boolean	setComplexRenderLayerOutlineColor (int layerIndex, NvsColor color)

float	getComplexRenderLayerOutlineWidth (int layerIndex)

boolean	setComplexRenderLayerOutlineWidth (int layerIndex, float width)

float	getComplexRenderLayerOpacity (int layerIndex)

boolean	setComplexRenderLayerOpacity (int layerIndex, float opacity)

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

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

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(Top alignment for vertical layout) More...

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

static final int	TEXT_ALIGNMENT_RIGHT = 2
	Right alignment(Bottom alignment for vertical layout) More...

static final int	TEXT_ALIGNMENT_TOP = 3
	Top alignment, valid for frame-caption only. More...

static final int	TEXT_ALIGNMENT_BOTTOM = 4
	Bottom alignment, valid for frame-caption only. More...

static final int	TEXT_ALIGNMENT_VCENTER = 5
	Vertical center alignment, valid for frame-caption only. 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
	Text frame bounding that has not been transformed. More...

static final int	BOUNDING_TYPE_TYPOGRAPHIC_TEXT = 4

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

Additional Inherited Members
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

captions.

captions are custom text that is superimposed on the video. When editing a video, users can add and remove timeline 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 NvsCaption class, all public APIs are used in the UI thread! ! !

Member Function Documentation

◆ applyCaptionStyle() [1/2]

boolean com.meicam.sdk.NvsCaption.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.sdk.NvsCaption.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.sdk.NvsCaption.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

Since: 2.15.2

◆ applyModularCaptionContext()

boolean com.meicam.sdk.NvsCaption.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

Since: 2.15.2

◆ applyModularCaptionInAnimation()

boolean com.meicam.sdk.NvsCaption.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

Since: 2.15.2

◆ applyModularCaptionOutAnimation()

boolean com.meicam.sdk.NvsCaption.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

Since: 2.15.2

◆ applyModularCaptionRenderer()

boolean com.meicam.sdk.NvsCaption.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

Since: 2.15.2

◆ getAnchorPoint()

PointF com.meicam.sdk.NvsCaption.getAnchorPoint ( )

inline

Gets caption anchor.

Returns: Returns caption anchor.

Since: 1.15.0

See also: setAnchorPoint

◆ getBackgroundColor()

NvsColor com.meicam.sdk.NvsCaption.getBackgroundColor ( )

inline

Get the current text background color value.

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

See also: setBackgroundColor

Since: 2.15.1

◆ getBackgroundRadius()

float com.meicam.sdk.NvsCaption.getBackgroundRadius ( )

inline

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

Returns: Returns corner radius value

See also: setBackgroundRadius

Since: 2.15.1

◆ getBold()

boolean com.meicam.sdk.NvsCaption.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

◆ getBoundaryPaddingRatio()

float com.meicam.sdk.NvsCaption.getBoundaryPaddingRatio ( )

inline

Gets the caption boundary padding ratio.

Returns: Returns padding ratio.

See also: setBoundaryPaddingRatio

◆ getBoundingRectangleVertices()

List<PointF> com.meicam.sdk.NvsCaption.getBoundingRectangleVertices ( )

inline

Gets the vertex position of the original enclosing rectangle of the caption after transformation.

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

Since: 1.8.1

◆ getCaptionBoundingVertices()

List<PointF> com.meicam.sdk.NvsCaption.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.

Since: 2.9.0

◆ getCaptionStylePackageId()

String com.meicam.sdk.NvsCaption.getCaptionStylePackageId ( )

inline

Gets the caption style package ID.

Returns: Returns the obtained caption style resource package ID.

◆ getCaptionTranslation()

PointF com.meicam.sdk.NvsCaption.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.sdk.NvsCaption.getCategory ( )

inline

Gets the type of caption.

Returns: Returns to the obtained Caption type.

◆ getCenterAzimuthAngle()

float com.meicam.sdk.NvsCaption.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.

Since: 1.6.0

◆ getCenterPolarAngle()

float com.meicam.sdk.NvsCaption.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.

Since: 1.6.0

◆ getComplexRenderLayerCount()

int com.meicam.sdk.NvsCaption.getComplexRenderLayerCount ( )

inline

Parameters

◆ getComplexRenderLayerOpacity()

float com.meicam.sdk.NvsCaption.getComplexRenderLayerOpacity ( int layerIndex )

inline

Parameters

◆ getComplexRenderLayerOutlineColor()

NvsColor com.meicam.sdk.NvsCaption.getComplexRenderLayerOutlineColor ( int layerIndex )

inline

Parameters

◆ getComplexRenderLayerOutlineWidth()

float com.meicam.sdk.NvsCaption.getComplexRenderLayerOutlineWidth ( int layerIndex )

inline

Parameters

◆ getControlPoint()

NvsControlPointPair com.meicam.sdk.NvsCaption.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.If the control point is {0, 0},the current control point interpolation method is linear interpolation.NvsControlPointPair对象

See also: setControlPoint

Since: 2.22.0

◆ getDisableElegantTextHeight()

boolean com.meicam.sdk.NvsCaption.getDisableElegantTextHeight ( )

inline

Get is prohibit elegant text height.

Since: 3.5.2

◆ getDrawOutline()

boolean com.meicam.sdk.NvsCaption.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.sdk.NvsCaption.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.sdk.NvsCaption.getFontFamily ( )

inline

Get the name of caption font.

Returns: Returns the name of caption font.

Since: 2.4.2

See also: setFontFamily

◆ getFontFilePath()

String com.meicam.sdk.NvsCaption.getFontFilePath ( )

inline

Gets the file path of the caption font.

Returns: Returns the file path of the caption font.

Since: 1.3.0

See also: setFontByFilePath

◆ getFontSize()

float com.meicam.sdk.NvsCaption.getFontSize ( )

inline

Gets the font size of the current caption.

Returns: Returns the obtained caption font size value.

See also: setFontSize

◆ getItalic()

boolean com.meicam.sdk.NvsCaption.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.sdk.NvsCaption.getLetterSpacing ( )

inline

Gets caption word spacing.

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

See also: setLetterSpacing; setLetterSpacingType

Since: 1.16.0

◆ getLetterSpacingType()

int com.meicam.sdk.NvsCaption.getLetterSpacingType ( )

inline

Gets caption word spacing type.

Returns: return letterSpacingType.(LETTER_SPACING_TYPE)

See also: setLetterSpacingType

Since: 2.15.1

◆ getLineSpacing()

float com.meicam.sdk.NvsCaption.getLineSpacing ( )

inline

Gets caption line spacing.

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

See also: setLineSpacing

Since: 2.15.1

◆ getModularCaptionAnimationPackageId()

String com.meicam.sdk.NvsCaption.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

Since: 2.15.2

◆ getModularCaptionAnimationPeroid()

int com.meicam.sdk.NvsCaption.getModularCaptionAnimationPeroid ( )

inline

Get modular caption Animation Peroid.

Returns: Return animation peroid in million second

See also: setModularCaptionAnimationPeroid

Since: 2.15.2

◆ getModularCaptionContextPackageId()

String com.meicam.sdk.NvsCaption.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

Since: 2.15.2

◆ getModularCaptionInAnimationDuration()

int com.meicam.sdk.NvsCaption.getModularCaptionInAnimationDuration ( )

inline

Get modular caption in-animation duration.

Returns: Return in-animation duration in million second

See also: setModularCaptionInAnimationDuration

Since: 2.15.2

◆ getModularCaptionInAnimationPackageId()

String com.meicam.sdk.NvsCaption.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

Since: 2.15.2

◆ getModularCaptionOutAnimationDuration()

int com.meicam.sdk.NvsCaption.getModularCaptionOutAnimationDuration ( )

inline

Get modular caption out-animation duration.

Returns: Return out-animation duration in million second

See also: setModularCaptionOutAnimationDuration

Since: 2.15.2

◆ getModularCaptionOutAnimationPackageId()

String com.meicam.sdk.NvsCaption.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

Since: 2.15.2

◆ getModularCaptionRendererPackageId()

String com.meicam.sdk.NvsCaption.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

Since: 2.15.2

◆ getOpacity()

float com.meicam.sdk.NvsCaption.getOpacity ( )

inline

Get the caption opacity.

Returns: Return the caption opacity.

See also: setOpacity

Since: 2.14.0

◆ getOrthoAngleRange()

float com.meicam.sdk.NvsCaption.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.

Since: 1.7.0

◆ getOutlineColor()

NvsColor com.meicam.sdk.NvsCaption.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.sdk.NvsCaption.getOutlineWidth ( )

inline

Gets the width of the current caption stroke.

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

See also: setOutlineWidth

◆ getPanoramicRotation()

float com.meicam.sdk.NvsCaption.getPanoramicRotation ( )

inline

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

Returns: Returns the rotation angle of caption.

Since: 1.7.1

◆ getPanoramicScaleX()

float com.meicam.sdk.NvsCaption.getPanoramicScaleX ( )

inline

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

Returns: Returns horizontal scaling factor.

Since: 1.6.0

◆ getPanoramicScaleY()

float com.meicam.sdk.NvsCaption.getPanoramicScaleY ( )

inline

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

Returns: Returns the vertical scaling factor.

Since: 1.6.0

◆ getPolarAngleRange()

float com.meicam.sdk.NvsCaption.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.

Since: 1.6.0

◆ getRoleInTheme()

int com.meicam.sdk.NvsCaption.getRoleInTheme ( )

inline

The role of caption in the theme.

Returns: Returns The role of caption in the theme.

◆ getRotationZ()

float com.meicam.sdk.NvsCaption.getRotationZ ( )

inline

Gets caption rotation angle.

Returns: Returns caption rotation angle.

Since: 1.14.1

See also: setRotationZ

◆ getScaleX()

float com.meicam.sdk.NvsCaption.getScaleX ( )

inline

Gets caption horizontal scaling factor.

Returns: Returns caption horizontal scaling factor.

Since: 1.14.1

See also: setScaleX; getScaleY

◆ getScaleY()

float com.meicam.sdk.NvsCaption.getScaleY ( )

inline

Gets caption vertical scaling factor.

Returns: Returns caption vertical scaling factor.

Since: 1.14.1

See also: setScaleY; getScaleX

◆ getSecondaryColor()

NvsColor com.meicam.sdk.NvsCaption.getSecondaryColor ( )

inline

Gets the current color value of the caption.

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

See also: setSecondaryColor

Since: 2.19.0

◆ getSecondaryOutlineColor()

NvsColor com.meicam.sdk.NvsCaption.getSecondaryOutlineColor ( )

inline

Gets the current outline sencondary color value of the caption.

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

See also: setSecondaryOutlineColor

Since: 3.1.0

◆ getShadowColor()

NvsColor com.meicam.sdk.NvsCaption.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.sdk.NvsCaption.getShadowFeather ( )

inline

Gets the feathering degree of the caption shadow.

Returns: Returns feathering degree

See also: setShadowFeather

◆ getShadowOffset()

PointF com.meicam.sdk.NvsCaption.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.sdk.NvsCaption.getText ( )

inline

Gets caption text.

Returns: Returns caption text obtained.

See also: setText

◆ getTextAlignment()

int com.meicam.sdk.NvsCaption.getTextAlignment ( )

inline

Gets caption horizontal alignment style.

Returns: Returns caption horizontal alignment style.

See also: setTextAlignment

Since: 1.10.0

◆ getTextBoundingRect()

RectF com.meicam.sdk.NvsCaption.getTextBoundingRect ( )

inline

Gets caption text rectangle.

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

◆ getTextCenterAzimuthAngle()

float com.meicam.sdk.NvsCaption.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.

Since: 2.5.1

◆ getTextCenterPolarAngle()

float com.meicam.sdk.NvsCaption.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.

Since: 2.5.1

◆ getTextColor()

NvsColor com.meicam.sdk.NvsCaption.getTextColor ( )

inline

Gets the current color value of the caption font.

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

See also: setTextColor

◆ getTextLayout()

NvsCaptionTextLayout com.meicam.sdk.NvsCaption.getTextLayout ( )

inline

Parameters

◆ getTextOrthoAngleRange()

float com.meicam.sdk.NvsCaption.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.

Since: 2.5.1

◆ getTextPolarAngleRange()

float com.meicam.sdk.NvsCaption.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.

Since: 2.5.1

◆ getTextSpanList()

List<NvsCaptionSpan> com.meicam.sdk.NvsCaption.getTextSpanList ( )

inline

Parameters

◆ getTextVerticalAlignment()

int com.meicam.sdk.NvsCaption.getTextVerticalAlignment ( )

inline

Gets caption vertical alignment style, valid for frame-caption only.

Returns: Returns caption vertical alignment style.

See also: setTextVerticalAlignment

Since: 2.19.1

◆ getUnderline()

boolean com.meicam.sdk.NvsCaption.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.sdk.NvsCaption.getVerticalLayout ( )

inline

Gets whether to layout text vertically.

Returns: Returns whether to layout text vertically

See also: setVerticalLayout

Since: 2.16.0

◆ getWeight()

int com.meicam.sdk.NvsCaption.getWeight ( )

inline

Gets the caption weight.

Returns: Returns the caption weight.

See also: setWeight

◆ getZValue()

float com.meicam.sdk.NvsCaption.getZValue ( )

inline

Gets caption Z value.

Returns: Returns caption Z value.

Since: 1.10.0

◆ hasOutlineLayerInComplexRender()

boolean com.meicam.sdk.NvsCaption.hasOutlineLayerInComplexRender ( int layerIndex )

inline

Parameters

◆ isFrameCaption()

boolean com.meicam.sdk.NvsCaption.isFrameCaption ( )

inline

Determine if it is a border caption.

Returns: A return value of true indicates a border caption

Since: 2.19.1

◆ isModular()

boolean com.meicam.sdk.NvsCaption.isModular ( )

inline

Determines whether the current caption is a modular caption.

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

Since: 2.15.2

◆ isPanoramic()

boolean com.meicam.sdk.NvsCaption.isPanoramic ( )

inline

Determines whether the current caption is a panorama caption.

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

Since: 1.6.0

◆ isRecordingUserOperation()

boolean com.meicam.sdk.NvsCaption.isRecordingUserOperation ( )

inline

Default is true.

Returns: Whether to record user actions

Since: 3.8.2

◆ resetOutlineColorState()

void com.meicam.sdk.NvsCaption.resetOutlineColorState ( )

inline

reset caption text color state.

Since: 3.5.0

◆ resetTextColorState()

void com.meicam.sdk.NvsCaption.resetTextColorState ( )

inline

reset caption text color state.

Since: 3.5.0

◆ rotateCaption() [1/2]

void com.meicam.sdk.NvsCaption.rotateCaption ( float angle )

inline

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

Parameters

angle Angle of caption rotation.

Since: 1.8.1

◆ rotateCaption() [2/2]

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

inline

Rotates captions.

Parameters

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

Since: 1.8.1

◆ scaleCaption()

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

inline

Zooms caption.

Parameters

scaleFactor	Caption scaling factor.
anchor	Caption zoom anchor.

Since: 1.8.1

◆ setAnchorPoint()

void com.meicam.sdk.NvsCaption.setAnchorPoint ( PointF anchor )

inline

Sets caption anchor.

Parameters

anchor Anchor.

Since: 1.15.0

See also: getAnchorPoint

◆ setBackgroundColor()

void com.meicam.sdk.NvsCaption.setBackgroundColor ( NvsColor backgroundColor )

inline

Set text background color.

Parameters

backgroundColor Background color value.

See also: getBackgroundColor

Since: 2.15.1

◆ setBackgroundRadius()

void com.meicam.sdk.NvsCaption.setBackgroundRadius ( float radius )

inline

Set text background rectangle's corner radius.

Parameters

radius Corner radius value

See also: getBackgroundRadius

Since: 2.15.1

◆ setBold()

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

◆ setBoundaryPaddingRatio()

void com.meicam.sdk.NvsCaption.setBoundaryPaddingRatio ( float ratio )

inline

Sets the caption boundary padding ratio.

Parameters

ratio The padding ratio is a multiple of the font size, default is 0.15

See also: getBoundaryPaddingRatio

◆ setCaptionTranslation()

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

Since: 1.6.0

◆ setCenterPolarAngle()

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

Since: 1.6.0

◆ setComplexRenderLayerOpacity()

boolean com.meicam.sdk.NvsCaption.setComplexRenderLayerOpacity	(	int	layerIndex,
		float	opacity
	)

inline

Parameters

◆ setComplexRenderLayerOutlineColor()

boolean com.meicam.sdk.NvsCaption.setComplexRenderLayerOutlineColor	(	int	layerIndex,
		NvsColor	color
	)

inline

Parameters

◆ setComplexRenderLayerOutlineWidth()

boolean com.meicam.sdk.NvsCaption.setComplexRenderLayerOutlineWidth	(	int	layerIndex,
		float	width
	)

inline

Parameters

◆ setControlPoint()

boolean com.meicam.sdk.NvsCaption.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.Set the control point to {0, 0}, that is, the current control point is linear interpolation, otherwise it is curve interpolation.

See also: getControlPoint

Since: 2.22.0

◆ setCurrentKeyFrameTime()

void com.meicam.sdk.NvsCaption.setCurrentKeyFrameTime ( long time )

inline

Set the caption KeyFrameTime.

See also: setCurrentKeyFrameTime

Since: 2.15.0

◆ setDisableElegantTextHeight()

void com.meicam.sdk.NvsCaption.setDisableElegantTextHeight ( 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.sdk.NvsCaption.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.sdk.NvsCaption.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.sdk.NvsCaption.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.

Since: 1.3.0

See also: getFontFilePath

◆ setFontFamily()

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

Since: 2.4.2

See also: getFontFamily

◆ setFontSize()

void com.meicam.sdk.NvsCaption.setFontSize ( float fontSize )

inline

Sets the caption font size.

Parameters

fontSize Caption font size value

See also: getFontSize

◆ setFrameCaptionMaxFontSize()

void com.meicam.sdk.NvsCaption.setFrameCaptionMaxFontSize ( float maxFontSize )

inline

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

Since: 2.19.1

◆ setItalic()

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

Since: 1.16.0

◆ setLetterSpacingType()

void com.meicam.sdk.NvsCaption.setLetterSpacingType ( int letterSpacingType )

inline

Sets caption word spacing type.

Parameters

letterSpacingType Word spacing type.(LETTER_SPACING_TYPE)

See also: getLetterSpacingType

Since: 2.15.1

◆ setLineSpacing()

void com.meicam.sdk.NvsCaption.setLineSpacing ( float lineSpacing )

inline

Sets caption line spacing.

Parameters

lineSpacing line spacing is expressed in absolute value.

See also: getLineSpacing

Since: 2.15.1

◆ setModularCaptionAnimationPeroid()

void com.meicam.sdk.NvsCaption.setModularCaptionAnimationPeroid ( int periodInMS )

inline

Set modular caption Animation Peroid.

Parameters

periodInMS Animation peroid in million second

See also: getModularCaptionAnimationPeroid

Since: 2.15.2

◆ setModularCaptionInAnimationDuration()

void com.meicam.sdk.NvsCaption.setModularCaptionInAnimationDuration ( int inAnimationDurationInMS )

inline

Set modular caption in-animation duration.

Parameters

inAnimationDurationInMS in-animation duration in million second

See also: getModularCaptionInAnimationDuration

Since: 2.15.2

◆ setModularCaptionOutAnimationDuration()

void com.meicam.sdk.NvsCaption.setModularCaptionOutAnimationDuration ( int outAnimationDurationInMS )

inline

Set modular caption out-animation duration.

Parameters

outAnimationDurationInMS out-animation duration in million second

See also: getModularCaptionOutAnimationDuration

Since: 2.15.2

◆ setOpacity()

void com.meicam.sdk.NvsCaption.setOpacity ( float opacity )

inline

Set the caption opacity.

Parameters

opacity caption opacity.

See also: getOpacity

Since: 2.14.0

◆ setOutlineColor()

void com.meicam.sdk.NvsCaption.setOutlineColor ( NvsColor outlineColor )

inline

Sets the color of the caption stroke.

Parameters

outlineColor Caption stroke color value.

See also: getOutlineColor

◆ setOutlineWidth()

void com.meicam.sdk.NvsCaption.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.sdk.NvsCaption.setPanoramicRotation ( float rotationAngle )

inline

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

Parameters

rotationAngle The rotation angle.

Since: 1.7.1

◆ setPanoramicScaleX()

void com.meicam.sdk.NvsCaption.setPanoramicScaleX ( float scaleX )

inline

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

Parameters

scaleX Horizontal scaling factor.

Since: 1.6.0

◆ setPanoramicScaleY()

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

Since: 1.6.0

◆ setPolarAngleRange()

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

Since: 1.6.0

◆ setRecordingUserOperation()

void com.meicam.sdk.NvsCaption.setRecordingUserOperation ( boolean recordingUserOperation )

inline

Sets whether to record user actions.

Parameters

recordingUserOperation

Since: 2.11.0

◆ setRotationZ()

void com.meicam.sdk.NvsCaption.setRotationZ ( float angle )

inline

Sets the rotation angle for the caption.

Parameters

angle Rotation angle.

Since: 1.14.1

See also: getRotationZ

◆ setScaleX()

void com.meicam.sdk.NvsCaption.setScaleX ( float scale )

inline

Sets horizontal scaling factor for caption.

Parameters

scale Horizontal scaling factor.

Since: 1.14.1

See also: getScaleX; setScaleY

◆ setScaleY()

void com.meicam.sdk.NvsCaption.setScaleY ( float scale )

inline

Sets vertical scaling factor for captions.

Parameters

scale Vertical scaling factor.

Since: 1.14.1

See also: getScaleY; setScaleX

◆ setSecondaryColor()

void com.meicam.sdk.NvsCaption.setSecondaryColor ( NvsColor color )

inline

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

Parameters

textColor Caption color value.

See also: getSecondaryColor

Since: 2.19.0

◆ setSecondaryOutlineColor()

void com.meicam.sdk.NvsCaption.setSecondaryOutlineColor ( NvsColor color )

inline

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

Parameters

color Caption outline color value.

See also: getSecondaryOutlineColor

Since: 3.1.0

◆ setShadowColor()

void com.meicam.sdk.NvsCaption.setShadowColor ( NvsColor shadowColor )

inline

Sets the color of the caption shadow.

Parameters

shadowColor Caption shadow color value.

See also: getShadowColor

◆ setShadowFeather()

void com.meicam.sdk.NvsCaption.setShadowFeather ( float feather )

inline

Sets the feathering degree of the caption shadow.

Parameters

feather feathering degree

See also: getShadowFeather

◆ setShadowOffset()

void com.meicam.sdk.NvsCaption.setShadowOffset ( PointF shadowOffset )

inline

Sets the offset of the caption shadow.

Parameters

shadowOffset Caption shadow offset.

See also: getShadowOffset

◆ setText()

void com.meicam.sdk.NvsCaption.setText ( String text )

inline

Sets caption text.

Parameters

text	Caption text

See also: getText

◆ setTextAlignment()

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

Since: 1.10.0

◆ setTextColor()

void com.meicam.sdk.NvsCaption.setTextColor ( NvsColor textColor )

inline

Sets caption text color.

Parameters

textColor Caption text color value.

See also: getTextColor

◆ setTextFrameOriginRect()

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

Since: 2.19.0

◆ setTextSpanList()

void com.meicam.sdk.NvsCaption.setTextSpanList ( List< NvsCaptionSpan > nvCaptionSpanList )

inline

Parameters

◆ setTextVerticalAlignment()

void com.meicam.sdk.NvsCaption.setTextVerticalAlignment ( int verticalTextAlign )

inline

Sets caption vertical alignment style, valid for frame-caption only.

Parameters

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

See also: getTextVerticalAlignment; setTextAlignment

Since: 2.19.1

◆ setUnderline()

void com.meicam.sdk.NvsCaption.setUnderline ( boolean underline )

inline

Sets caption under line.

Parameters

underline Whether it is set to under line.

See also: getUnderline

◆ setVerticalLayout()

void com.meicam.sdk.NvsCaption.setVerticalLayout ( boolean verticalLayout )

inline

Sets whether to layout text vertically.

Parameters

verticalLayout whether to layout text vertically

See also: getVerticalLayout

Since: 2.16.0

◆ setWeight()

void com.meicam.sdk.NvsCaption.setWeight ( int weight )

inline

Sets caption weight.

Parameters

weight the value in opentype weight integer.

See also: getWeight

◆ setZValue()

void com.meicam.sdk.NvsCaption.setZValue ( float value )

inline

Sets caption Z value.

Parameters

value Z value

Since: 1.10.0

◆ translateCaption()

void com.meicam.sdk.NvsCaption.translateCaption ( PointF translationOffset )

inline

Caption translation.

Parameters

translationOffset Horizontal and vertical offset values for caption.

Since: 1.7.0

See also: setCaptionTranslation; getCaptionTranslation

Member Data Documentation

◆ BOUNDING_TYPE_FRAME

final int com.meicam.sdk.NvsCaption.BOUNDING_TYPE_FRAME = 2

static

The whole bounding including decoration.

◆ BOUNDING_TYPE_TEXT

final int com.meicam.sdk.NvsCaption.BOUNDING_TYPE_TEXT = 0

static

The actual text bounding.

◆ BOUNDING_TYPE_TEXT_FRAME

final int com.meicam.sdk.NvsCaption.BOUNDING_TYPE_TEXT_FRAME = 1

static

Text frame bounding.

◆ BOUNDING_TYPE_TEXT_ORIGIN_FRAME

final int com.meicam.sdk.NvsCaption.BOUNDING_TYPE_TEXT_ORIGIN_FRAME = 3

static

Text frame bounding that has not been transformed.

◆ BOUNDING_TYPE_TYPOGRAPHIC_TEXT

final int com.meicam.sdk.NvsCaption.BOUNDING_TYPE_TYPOGRAPHIC_TEXT = 4

static

The typographic text bounding

◆ DEFAULT_CATEGORY

final int com.meicam.sdk.NvsCaption.DEFAULT_CATEGORY = 0

static

Default category.

◆ LETTER_SPACING_TYPE_ABSOLUTE

final int com.meicam.sdk.NvsCaption.LETTER_SPACING_TYPE_ABSOLUTE = 1

static

letter spacing type is absolute

◆ LETTER_SPACING_TYPE_PERCENTAGE

final int com.meicam.sdk.NvsCaption.LETTER_SPACING_TYPE_PERCENTAGE = 0

static

letter spacing type is percentage

◆ NOT_USE_ASSET_DEFAULT_PARAM

final int com.meicam.sdk.NvsCaption.NOT_USE_ASSET_DEFAULT_PARAM = 1

static

Do not use the default caption package properties.

◆ ROLE_IN_THEME_GENERAL

final int com.meicam.sdk.NvsCaption.ROLE_IN_THEME_GENERAL = 0

static

General.

◆ ROLE_IN_THEME_TITLE

final int com.meicam.sdk.NvsCaption.ROLE_IN_THEME_TITLE = 1

static

Title.

◆ ROLE_IN_THEME_TRAILER

final int com.meicam.sdk.NvsCaption.ROLE_IN_THEME_TRAILER = 2

static

Trailer.

◆ TEXT_ALIGNMENT_BOTTOM

final int com.meicam.sdk.NvsCaption.TEXT_ALIGNMENT_BOTTOM = 4

static

Bottom alignment, valid for frame-caption only.

◆ TEXT_ALIGNMENT_CENTER

final int com.meicam.sdk.NvsCaption.TEXT_ALIGNMENT_CENTER = 1

static

Center alignment.

◆ TEXT_ALIGNMENT_LEFT

final int com.meicam.sdk.NvsCaption.TEXT_ALIGNMENT_LEFT = 0

static

Left alignment(Top alignment for vertical layout)

◆ TEXT_ALIGNMENT_RIGHT

final int com.meicam.sdk.NvsCaption.TEXT_ALIGNMENT_RIGHT = 2

static

Right alignment(Bottom alignment for vertical layout)

◆ TEXT_ALIGNMENT_TOP

final int com.meicam.sdk.NvsCaption.TEXT_ALIGNMENT_TOP = 3

static

Top alignment, valid for frame-caption only.

◆ TEXT_ALIGNMENT_VCENTER

final int com.meicam.sdk.NvsCaption.TEXT_ALIGNMENT_VCENTER = 5

static

Vertical center alignment, valid for frame-caption only.

◆ THEME_CATEGORY

final int com.meicam.sdk.NvsCaption.THEME_CATEGORY = 2

static

Theme category.

◆ USE_ASSET_DEFAULT_PARAM

final int com.meicam.sdk.NvsCaption.USE_ASSET_DEFAULT_PARAM = 0

static

Uses the default caption package properties.

◆ USER_CATEGORY

final int com.meicam.sdk.NvsCaption.USER_CATEGORY = 1

static

Customized category.

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

src/android/jar/com/meicam/sdk/NvsCaption.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()

◆ getAnchorPoint()

◆ getBackgroundColor()

◆ getBackgroundRadius()

◆ getBold()

◆ getBoundaryPaddingRatio()

◆ getBoundingRectangleVertices()

◆ getCaptionBoundingVertices()

◆ getCaptionStylePackageId()

◆ getCaptionTranslation()

◆ getCategory()

◆ getCenterAzimuthAngle()

◆ getCenterPolarAngle()

◆ getComplexRenderLayerCount()

◆ getComplexRenderLayerOpacity()

◆ getComplexRenderLayerOutlineColor()

◆ getComplexRenderLayerOutlineWidth()

◆ getControlPoint()

◆ getDisableElegantTextHeight()

◆ getDrawOutline()

◆ getDrawShadow()

◆ getFontFamily()

◆ getFontFilePath()

◆ getFontSize()

◆ getItalic()

◆ getLetterSpacing()

◆ getLetterSpacingType()

◆ getLineSpacing()

◆ getModularCaptionAnimationPackageId()

◆ getModularCaptionAnimationPeroid()

◆ getModularCaptionContextPackageId()

◆ getModularCaptionInAnimationDuration()

◆ getModularCaptionInAnimationPackageId()

◆ getModularCaptionOutAnimationDuration()

◆ getModularCaptionOutAnimationPackageId()

◆ getModularCaptionRendererPackageId()

◆ getOpacity()

◆ getOrthoAngleRange()

◆ getOutlineColor()

◆ getOutlineWidth()

◆ getPanoramicRotation()

◆ getPanoramicScaleX()

◆ getPanoramicScaleY()

◆ getPolarAngleRange()

◆ getRoleInTheme()

◆ getRotationZ()

◆ getScaleX()

◆ getScaleY()

◆ getSecondaryColor()

◆ getSecondaryOutlineColor()

◆ getShadowColor()

◆ getShadowFeather()

◆ getShadowOffset()

◆ getText()

◆ getTextAlignment()

◆ getTextBoundingRect()

◆ getTextCenterAzimuthAngle()

◆ getTextCenterPolarAngle()

◆ getTextColor()

◆ getTextLayout()

◆ getTextOrthoAngleRange()

◆ getTextPolarAngleRange()

◆ getTextSpanList()

◆ getTextVerticalAlignment()

◆ getUnderline()

◆ getVerticalLayout()

◆ getWeight()

◆ getZValue()

◆ hasOutlineLayerInComplexRender()