时间线字幕更多...

类 com.meicam.sdk.NvsCaption 继承关系图:

Public 成员函数
int	getRoleInTheme ()
	字幕在主题中的角色更多...

int	getCategory ()
	获得字幕的种类更多...

String	getCaptionStylePackageId ()
	获得字幕样式包裹ID 更多...

String	getModularCaptionContextPackageId ()
	获得模块字幕环境样式包裹ID 更多...

String	getModularCaptionRendererPackageId ()
	获得模块字幕渲染样式包裹ID 更多...

String	getModularCaptionAnimationPackageId ()
	获得模块字幕循环动画样式包裹ID 更多...

String	getModularCaptionInAnimationPackageId ()
	获得模块字幕入动画样式包裹ID 更多...

String	getModularCaptionOutAnimationPackageId ()
	获得模块字幕出动画样式包裹ID 更多...

boolean	applyCaptionStyle (String captionStylePackageId)
	运用字幕样式更多...

boolean	applyCaptionStyle (String captionStylePackageId, int isUseDefaultAssetParam)
	运用字幕样式更多...

boolean	applyModularCaptionContext (String captionContextPackageId)
	运用模块字幕环境样式包更多...

boolean	applyModularCaptionRenderer (String captionRendererPackageId)
	运用模块字幕渲染样式包更多...

boolean	applyModularCaptionAnimation (String captionAnimationPackageId)
	运用模块字幕循环动画样式包更多...

boolean	applyModularCaptionInAnimation (String captionInAnimationPackageId)
	运用模块字幕入动画样式包。注意：如果已经应用了循环动画样式包，需要先把循环动画设置为null，否则不生效更多...

boolean	applyModularCaptionOutAnimation (String captionOutAnimationPackageId)
	运用模块字幕出动画样式包. 注意：如果已经应用了循环动画样式包，需要先把循环动画设置为null，否则不生效更多...

void	setModularCaptionAnimationPeroid (int periodInMS)
	设置模块字幕循环动画的周期更多...

int	getModularCaptionAnimationPeroid ()
	获取模块字幕循环动画的周期更多...

void	setModularCaptionInAnimationDuration (int inAnimationDurationInMS)
	设置模块字幕入动画的时长更多...

int	getModularCaptionInAnimationDuration ()
	获取模块字幕入动画的时长更多...

void	setModularCaptionOutAnimationDuration (int outAnimationDurationInMS)
	设置模块字幕出动画的时长更多...

int	getModularCaptionOutAnimationDuration ()
	获取模块字幕出动画的时长更多...

void	setText (String text)
	设置字幕文本更多...

String	getText ()
	获取字幕文本更多...

void	setVerticalLayout (boolean verticalLayout)
	设置字幕是否竖向排版更多...

boolean	getVerticalLayout ()
	获取字幕是否竖向排版更多...

void	setTextAlignment (int textAlign)
	设置字幕水平对齐方式更多...

int	getTextAlignment ()
	获取字幕水平对齐方式更多...

void	setTextVerticalAlignment (int verticalTextAlign)
	设置字幕垂直对齐方式，仅对边框型字幕有效更多...

int	getTextVerticalAlignment ()
	获取字幕垂直对齐方式，仅对边框型字幕有效更多...

void	setBold (boolean bold)
	设置字幕字体加粗更多...

boolean	getBold ()
	获取字幕字体加粗状态更多...

void	setWeight (int weight)
	设置字幕权重更多...

int	getWeight ()
	获取字幕权重值更多...

void	setItalic (boolean italic)
	设置字幕字体斜体更多...

boolean	getItalic ()
	获取字幕斜体状态更多...

void	setUnderline (boolean underline)
	设置字幕下划线更多...

boolean	getUnderline ()
	获取字幕下划线状态更多...

void	setLetterSpacingType (int letterSpacingType)
	设置字幕字间距类型更多...

int	getLetterSpacingType ()
	获取字幕字间距类型更多...

void	setLetterSpacing (float letterSpacing)
	设置字幕字间距更多...

float	getLetterSpacing ()
	获取字幕字间距更多...

void	setLineSpacing (float lineSpacing)
	设置字幕行间距更多...

float	getLineSpacing ()
	获取字幕行间距更多...

void	setTextColor (NvsColor textColor)
	设置字幕文本颜色更多...

void	resetTextColorState ()
	重置字幕文本颜色状态更多...

NvsColor	getTextColor ()
	获取字幕字体的当前颜色值更多...

void	setDrawOutline (boolean drawOutline)
	设置字幕描边更多...

boolean	getDrawOutline ()
	获取字幕描边状态更多...

void	setOutlineColor (NvsColor outlineColor)
	设置字幕描边的颜色更多...

NvsColor	getOutlineColor ()
	获取当前字幕描边的颜色值更多...

void	resetOutlineColorState ()
	重置字幕描边颜色状态更多...

void	setOutlineWidth (float outlineWidth)
	设置字幕描边的宽度更多...

float	getOutlineWidth ()
	获取当前字幕描边的宽度更多...

void	setDrawShadow (boolean drawShadow)
	设置字幕阴影更多...

boolean	getDrawShadow ()
	获取当前字幕阴影状态更多...

void	setShadowColor (NvsColor shadowColor)
	设置字幕阴影的颜色更多...

NvsColor	getShadowColor ()
	获取当前字幕阴影的颜色更多...

void	setShadowOffset (PointF shadowOffset)
	设置字幕阴影的偏移量更多...

PointF	getShadowOffset ()
	获取当前字幕阴影的偏移量更多...

void	setShadowFeather (float feather)
	设置字幕阴影的羽化程度更多...

float	getShadowFeather ()
	获取当前字幕阴影的羽化程度更多...

void	setFontSize (float fontSize)
	设置字幕字体大小更多...

float	getFontSize ()
	获取当前字幕的字体大小更多...

void	setFontByFilePath (String filePath)
	设置字幕字体更多...

String	getFontFilePath ()
	获取字幕字体的文件路径更多...

void	setFontFamily (String family)
	设置字幕字体更多...

String	getFontFamily ()
	获取字幕字体的名字更多...

void	setBoundaryPaddingRatio (float ratio)
	设置字幕边界扩展比率更多...

float	getBoundaryPaddingRatio ()
	获取字幕边界扩展比率更多...

void	setCaptionTranslation (PointF translation)
	设置字幕平移量更多...

PointF	getCaptionTranslation ()
	获取字幕的平移量更多...

void	translateCaption (PointF translationOffset)
	平移字幕更多...

void	setAnchorPoint (PointF anchor)
	设置字幕锚点更多...

PointF	getAnchorPoint ()
	获取字幕锚点更多...

void	setScaleX (float scale)
	对字幕设置水平缩放系数更多...

float	getScaleX ()
	获取字幕水平缩放系数更多...

void	setScaleY (float scale)
	对字幕设置垂直缩放系数更多...

float	getScaleY ()
	获取字幕垂直缩放系数更多...

void	scaleCaption (float scaleFactor, PointF anchor)
	缩放字幕更多...

void	setRotationZ (float angle)
	对字幕设置旋转角度更多...

float	getRotationZ ()
	获取字幕旋转角度更多...

void	rotateCaption (float angle, PointF anchor)
	旋转字幕更多...

void	rotateCaption (float angle)
	以字幕中心点为锚点旋转字幕更多...

void	setTextFrameOriginRect (RectF rc)
	设置边框字幕的原始边框大小，如果当前字幕不是边框字幕，该函数没有效果. 可以通过getCaptionBoundingVertices中的BOUNDING_TYPE_TEXT_ORIGIN_FRAME获取原始边框大小更多...

RectF	getTextBoundingRect ()
	获取字幕文本矩形框更多...

List< PointF >	getBoundingRectangleVertices ()
	获取字幕的原始包围矩形框变换后的顶点位置更多...

List< PointF >	getCaptionBoundingVertices (int boundingType)
	获取字幕原始边框变换后的顶点位置更多...

void	setSecondaryColor (NvsColor color)
	设置字幕第二个颜色, 目前只应用在卡拉OK字幕上更多...

NvsColor	getSecondaryColor ()
	获取字幕字体的当前第二个颜色值更多...

void	setSecondaryOutlineColor (NvsColor color)
	设置字幕描边的第二个颜色, 目前只应用在卡拉OK字幕上更多...

NvsColor	getSecondaryOutlineColor ()
	获取字幕描边的第二个颜色值更多...

boolean	isPanoramic ()
	判断当前字幕是否为全景图字幕更多...

boolean	isModular ()
	判断当前字幕是否为模块字幕更多...

void	setCenterPolarAngle (float centerPolarAngle)
	对字幕设置中心点的极角。只对全景图字幕有效更多...

float	getCenterPolarAngle ()
	获取字幕中心点的极角。只对全景图字幕有效更多...

float	getTextCenterPolarAngle ()
	获取字幕文本中心点的极角。只对全景图字幕有效更多...

void	setCenterAzimuthAngle (float centerAzimuthAngle)
	对字幕设置中心点的方位角。只对全景图字幕有效更多...

float	getCenterAzimuthAngle ()
	获取字幕中心点的方位角。只对全景图字幕有效更多...

float	getTextCenterAzimuthAngle ()
	获取字幕文本中心点的方位角。只对全景图字幕有效更多...

void	setPolarAngleRange (float polarAngleRange)
	对字幕设置极角的张角。只对全景图字幕有效更多...

float	getPolarAngleRange ()
	获取字幕极角的张角。只对全景图字幕有效更多...

float	getOrthoAngleRange ()
	获取字幕与极角垂直的张角。只对全景图字幕有效更多...

float	getTextPolarAngleRange ()
	获取文本与极角垂直的张角。只对全景图字幕有效更多...

float	getTextOrthoAngleRange ()
	获取文本与极角垂直的张角。只对全景图字幕有效更多...

void	setPanoramicScaleX (float scaleX)
	对字幕设置水平缩放系数。只对全景图字幕有效更多...

float	getPanoramicScaleX ()
	获取字幕水平缩放系数。只对全景图字幕有效更多...

void	setPanoramicScaleY (float scaleY)
	对字幕设置垂直缩放系数。只对全景图字幕有效更多...

float	getPanoramicScaleY ()
	获取字幕垂直缩放系数。只对全景图字幕有效更多...

void	setPanoramicRotation (float rotationAngle)
	对字幕设置旋转角度。只对全景图字幕有效更多...

float	getPanoramicRotation ()
	获取字幕旋转角度。只对全景图字幕有效更多...

void	setZValue (float value)
	设置字幕Z值更多...

float	getZValue ()
	获取字幕Z值更多...

void	setRecordingUserOperation (boolean recordingUserOperation)
	设置字幕是否记录用户的操作更多...

boolean	isRecordingUserOperation ()
	默认为true 更多...

void	setOpacity (float opacity)
	设置字幕透明度更多...

float	getOpacity ()
	获取透明度更多...

void	setBackgroundColor (NvsColor backgroundColor)
	设置字幕文本的背景颜色更多...

NvsColor	getBackgroundColor ()
	获取字幕文本的当前背景颜色值更多...

void	setBackgroundRadius (float radius)
	设置字幕文本的背景框的圆角半径更多...

float	getBackgroundRadius ()
	获取字幕文本的当前背景框的圆角半径更多...

void	setCurrentKeyFrameTime (long time)
	设置字幕的关键帧时间更多...

boolean	setControlPoint (String fxParam, NvsControlPointPair controlPointPair)
	设置字幕的关键帧控制点对更多...

NvsControlPointPair	getControlPoint (String fxParam)
	返回关键帧控制点对更多...

boolean	isFrameCaption ()
	判断是否是边框字幕更多...

void	setFrameCaptionMaxFontSize (float maxFontSize)
	设置边框字幕的最大字号，只有边框字幕才可以使用此方法。更多...

void	setTextSpanList (List< NvsCaptionSpan > nvCaptionSpanList)
	用户可以指定字幕中位置从某一起始字符到某一结束字符之间，应用多种layout属性。更多...

List< NvsCaptionSpan >	getTextSpanList ()
	获取需要应用多种layout属性更多...

NvsCaptionTextLayout	getTextLayout ()
	获取字幕layout属性更多...

void	setDisableElegantTextHeight (boolean disableElegantTextHeight)
	由于历史遗留因素，美摄SDK在Android平台的水平文字排版时使用了elegant text height特性，这会导致Android平台的水平排版与其它平台的行间距有差别。设置这个属性会禁止Android水平排版使用elegant text height特性。默认值为false。更多...

boolean	getDisableElegantTextHeight ()
	获取是否禁止elegant text height特性更多...

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 成员函数继承自 com.meicam.sdk.NvsFx
NvsFxDescription	getDescription ()
	获取特效的描述更多...

void	setIntVal (String fxParam, int val)
	设置特效的整数参数值更多...

int	getIntVal (String fxParam)
	获得特效的整数参数值更多...

void	setIntValAtTime (String fxParam, int val, long time)
	设置指定时间点上特效的整数参数值更多...

int	getIntValAtTime (String fxParam, long time)
	获得指定时间点上特效的整数参数值更多...

void	setFloatVal (String fxParam, double val)
	设置特效的浮点数参数值更多...

double	getFloatVal (String fxParam)
	获得特效浮点数参数值更多...

void	setFloatValAtTime (String fxParam, double val, long time)
	设置指定时间点上特效的浮点数参数值更多...

double	getFloatValAtTime (String fxParam, long time)
	获得指定时间点上特效浮点数参数值更多...

void	setBooleanVal (String fxParam, boolean val)
	设置特效布尔值参数值更多...

boolean	getBooleanVal (String fxParam)
	获得特效的布尔值参数值更多...

void	setBooleanValAtTime (String fxParam, boolean val, long time)
	设置指点时间点上特效布尔值参数值更多...

boolean	getBooleanValAtTime (String fxParam, long time)
	获得特效的布尔值参数值更多...

void	setStringVal (String fxParam, String val)
	设置特效字符串参数值更多...

String	getStringVal (String fxParam)
	获得特效字符串参数值更多...

void	setStringValAtTime (String fxParam, String val, long time)
	设置指定时间点上特效字符串参数值更多...

String	getStringValAtTime (String fxParam, long time, int flags)
	获得指定时间点上特效字符串参数值更多...

void	setColorVal (String fxParam, NvsColor val)
	设置特效颜色值参数值更多...

NvsColor	getColorVal (String fxParam)
	获得特效颜色值参数值更多...

void	setColorValAtTime (String fxParam, NvsColor val, long time)
	设置特效颜色值参数值更多...

NvsColor	getColorValAtTime (String fxParam, long time)
	获得特效颜色值参数值更多...

void	setPosition2DVal (String fxParam, NvsPosition2D val)
	设置特效二维坐标参数值更多...

NvsPosition2D	getPosition2DVal (String fxParam)
	获得特效二维坐标参数值更多...

void	setPosition2DValAtTime (String fxParam, NvsPosition2D val, long time)
	设置特效二维坐标参数值更多...

NvsPosition2D	getPosition2DValAtTime (String fxParam, long time)
	获得特效二维坐标参数值更多...

void	setPosition3DVal (String fxParam, NvsPosition3D val)
	设置特效三维坐标参数值更多...

NvsPosition3D	getPosition3DVal (String fxParam)
	获得特效三维坐标参数值更多...

void	setPosition3DValAtTime (String fxParam, NvsPosition3D val, long time)
	设置特效三维坐标参数值更多...

NvsPosition3D	getPosition3DValAtTime (String fxParam, long time)
	获得特效三维坐标参数值更多...

void	setMenuVal (String fxParam, String val)
	设置特效菜单参数值更多...

String	getMenuVal (String fxParam)
	获得特效菜单参数值更多...

void	setMenuValAtTime (String fxParam, String val, long time)
	设置特效菜单参数值更多...

String	getMenuValAtTime (String fxParam, long time)
	获得特效菜单参数值更多...

void	setArbDataVal (String fxParam, NvsArbitraryData val)
	设置自定义数据参数值更多...

NvsArbitraryData	getArbDataVal (String fxParam)
	返回自定义数据参数值更多...

void	setArbDataValAtTime (String fxParam, NvsArbitraryData val, long time)
	设置自定义数据参数值更多...

NvsArbitraryData	getArbDataValAtTime (String fxParam, NvsArbitraryData val, long time)
	返回自定义数据参数值更多...

boolean	removeKeyframeAtTime (String fxParam, long time)
	删除参数指定时间点的关键帧更多...

boolean	removeAllKeyframe (String fxParam)
	删除参数的所有关键帧更多...

boolean	hasKeyframeList (String fxParam)
	当前参数是否有关键帧列表更多...

long	findKeyframeTime (String fxParam, long time, int flags)
	获取指定时间点附近的关键帧更多...

boolean	setKeyFrameControlPoint (String fxParam, long time, NvsControlPointPair controlPointPair)
	设置关键帧控制点对更多...

NvsControlPointPair	getKeyFrameControlPoint (String fxParam, long time)
	返回关键帧控制点对更多...

boolean	setKeyFrameControlPointMode (String fxParam, long time, NvsControlPointModePair controlPointModePair)
	设置关键帧控制点模式对更多...

NvsControlPointModePair	getKeyFrameControlPointMode (String fxParam, long time)
	返回关键帧控制点模式对更多...

void	setFilterIntensity (float intensity)
	设置滤镜的强度更多...

float	getFilterIntensity ()
	获得滤镜的强度更多...

void	setFilterMask (boolean useMask)
	设置滤镜遮罩更多...

boolean	getFilterMask ()
	获得是否使用滤镜遮罩更多...

void	setRegional (boolean isRegional)
	设置滤镜是否为局部滤镜更多...

boolean	getRegional ()
	获得滤镜是否为局部滤镜更多...

void	setIgnoreBackground (boolean isIgnoreBackground)
	设置局部滤镜是否消除背景更多...

boolean	getIgnoreBackground ()
	获得局部滤镜是否消除背景更多...

void	setInverseRegion (boolean isInverseRegion)
	设置局部滤镜是否反选区域更多...

boolean	getInverseRegion ()
	获得局部滤镜是否反选区域更多...

void	setRegion (float[] region)
	设置局部滤镜的控制范围更多...

float[]	getRegion ()
	获取局部滤镜的控制范围更多...

void	setRegionInfo (NvsMaskRegionInfo info)
	设置局部滤镜的蒙版区域信息更多...

NvsMaskRegionInfo	getRegionInfo ()
	获取局部滤镜的蒙版区域信息更多...

void	setRegionInfoAtTime (NvsMaskRegionInfo info, long time)
	设置指定时间点局部滤镜的蒙版区域信息更多...

NvsMaskRegionInfo	getRegionInfoAtTime (long time)
	获取指定时间点局部滤镜的模板区域信息更多...

void	setRegionalFeatherWidth (float featherWidth)
	设置局部滤镜的羽化宽度更多...

float	getRegionalFeatherWidth ()
	获得局部滤镜的羽化宽度更多...

void	setRegionalFeatherWidthAtTime (float featherWidth, long time)
	设置指定时间点局部滤镜的羽化宽度更多...

float	getRegionalFeatherWidthAtTime (long time)
	获得指定时间点局部滤镜的羽化宽度更多...

void	setRegionCoordinateSystemType (int type)
	设置局部滤镜所在坐标系类型，默认为NDC坐标系更多...

int	getRegionCoordinateSystemType ()
	获得局部滤镜所在坐标系类型更多...

NvsParticleSystemContext	getParticleSystemContext ()
	获得粒子特效上下文对象。请参见NvsParticleSystemContext 更多...

NvsARFaceContext	getARFaceContext ()
	获得人脸特效上下文对象。请参见NvsARFaceContext 更多...

NvsPaintingEffectContext	getPaintingEffectContext ()
	获得手绘特效上下文对象。请参见NvsPaintingEffectContext 更多...

NvsARSceneManipulate	getARSceneManipulate ()
	获得AR场景操作对象。请参见NvsARSceneManipulate 更多...

void	setExprVar (String varName, double varValue)
	设置表达式中定义参数的值更多...

double	getExprVar (String varName)
	获得表达式中定义参数的值更多...

void	setExprStringVar (String varName, String varValue)
	设置表达式中定义参数的值更多...

String	getExprStringVar (String varName)
	获得表达式中定义参数的值更多...

void	setExprObjectVar (String varName, Object varValue)
	设置表达式中定义参数的值更多...

Object	getExprObjectVar (String varName)
	获得表达式中定义参数的值更多...

void	clearExprVar (String varName)
	清空表达式中定义参数的值，并设置为默认值0 更多...

void	clearExprVarCtx ()
	清空表达式中定义的全部参数的值，并设置为默认值0 更多...

Public 成员函数继承自 com.meicam.sdk.NvsObject
void	setAttachment (String key, Object value)
	为NvsObject对象添加附加的数据，用来标识NvsObject的对象或者其他用途更多...

void	setTemplateAttachment (String key, String value)
	为NvsObject对象添加模板资源的附加数据，用来标识NvsObject的模板数据更多...

Object	getAttachment (String key)
	获取NvsObject的附件更多...

String	getTemplateAttachment (String key)
	获取NvsObject的模板资源附件更多...

静态 Public 属性
字幕种类

static final int	DEFAULT_CATEGORY = 0
	默认种类更多...

static final int	USER_CATEGORY = 1
	用户自定义种类更多...

static final int	THEME_CATEGORY = 2
	主题种类更多...

字幕在主题中的角色

static final int	ROLE_IN_THEME_GENERAL = 0
	通用更多...

static final int	ROLE_IN_THEME_TITLE = 1
	片头更多...

static final int	ROLE_IN_THEME_TRAILER = 2
	片尾更多...

字幕对齐方式

static final int	TEXT_ALIGNMENT_LEFT = 0
	居左对齐(垂直布局就是居上对齐) 更多...

static final int	TEXT_ALIGNMENT_CENTER = 1
	居中对齐更多...

static final int	TEXT_ALIGNMENT_RIGHT = 2
	居右对齐(垂直布局就是居下对齐) 更多...

static final int	TEXT_ALIGNMENT_TOP = 3
	居上对齐，仅边框字幕有效更多...

static final int	TEXT_ALIGNMENT_BOTTOM = 4
	居下对齐，仅边框字幕有效更多...

static final int	TEXT_ALIGNMENT_VCENTER = 5
	垂直居中对齐，仅边框字幕有效更多...

使用默认的字幕包属性

static final int	USE_ASSET_DEFAULT_PARAM = 0
	使用默认的字幕包属性更多...

static final int	NOT_USE_ASSET_DEFAULT_PARAM = 1
	不使用默认的字幕包属性更多...

边框类型

static final int	BOUNDING_TYPE_TEXT = 0
	文字的实际边框更多...

static final int	BOUNDING_TYPE_TEXT_FRAME = 1
	文字框的边框更多...

static final int	BOUNDING_TYPE_FRAME = 2
	包括装饰在内的整体边框更多...

static final int	BOUNDING_TYPE_TEXT_ORIGIN_FRAME = 3
	没有经过变换的文字框的边框更多...

static final int	BOUNDING_TYPE_TYPOGRAPHIC_TEXT = 4

字间距类型

static final int	LETTER_SPACING_TYPE_PERCENTAGE = 0
	文字字间距的类型是百分比更多...

static final int	LETTER_SPACING_TYPE_ABSOLUTE = 1

静态 Public 属性继承自 com.meicam.sdk.NvsFx
static final int	KEY_FRAME_FIND_MODE_INPUT_TIME_BEFORE = 1
	查找当前时间点之前的关键帧更多...

static final int	KEY_FRAME_FIND_MODE_INPUT_TIME_AFTER = 2

static final int	REGION_COORDINATE_SYSTEM_TYPE_NDC = 0
	NDC坐标系更多...

static final int	REGION_COORDINATE_SYSTEM_TYPE_TIMELINE = 1

static final int	FACE_WARP_EFFECT_STRATEGY_CUSTOM = 0x7FFFFFFF

静态 Public 属性继承自 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 成员函数继承自 com.meicam.sdk.NvsObject
void	setInternalObject (long internalObject)

long	getInternalObject ()

Protected 属性继承自 com.meicam.sdk.NvsObject
long	m_internalObject = 0

详细描述

时间线字幕

字幕是视频上叠加的自定义文字。编辑视频时，可以添加和移除字幕，并对字幕位置进行调整处理。添加完字幕，还可以进行样式设置，包括字体大小，颜色，阴影，描边等。

警告

成员函数说明

◆ applyCaptionStyle() [1/2]

boolean com.meicam.sdk.NvsCaption.applyCaptionStyle ( String captionStylePackageId )

inline

运用字幕样式

参数

captionStylePackageId 字幕样式资源包ID

返回: 返回boolean值。true表示成功运用字幕样式，false则运用失败

警告: 此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题

◆ applyCaptionStyle() [2/2]

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

inline

运用字幕样式

参数

captionStylePackageId	字幕样式资源包ID
isUseDefaultAssetParam	是否使用字幕包裹自带的属性。请参见使用默认的字幕包属性

返回: 返回boolean值。true表示成功运用字幕样式，false则运用失败

警告: 此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题

◆ applyModularCaptionAnimation()

boolean com.meicam.sdk.NvsCaption.applyModularCaptionAnimation ( String captionAnimationPackageId )

inline

运用模块字幕循环动画样式包

参数

captionAnimationPackageId 字幕循环动画样式资源包ID

返回: 返回boolean值。true表示成功运用，false则运用失败

警告: 此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题

参见: getModularCaptionAnimationPackageId

自从: 2.15.2

◆ applyModularCaptionContext()

boolean com.meicam.sdk.NvsCaption.applyModularCaptionContext ( String captionContextPackageId )

inline

运用模块字幕环境样式包

参数

captionContextPackageId 字幕环境样式资源包ID

返回: 返回boolean值。true表示成功运用，false则运用失败

警告: 此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题

参见: getModularCaptionContextPackageId

自从: 2.15.2

◆ applyModularCaptionInAnimation()

boolean com.meicam.sdk.NvsCaption.applyModularCaptionInAnimation ( String captionInAnimationPackageId )

inline

运用模块字幕入动画样式包。注意：如果已经应用了循环动画样式包，需要先把循环动画设置为null，否则不生效

参数

captionInAnimationPackageId 字幕入动画样式资源包ID

返回: 返回boolean值。true表示成功运用，false则运用失败

警告: 此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题

参见: getModularCaptionInAnimationPackageId

自从: 2.15.2

◆ applyModularCaptionOutAnimation()

boolean com.meicam.sdk.NvsCaption.applyModularCaptionOutAnimation ( String captionOutAnimationPackageId )

inline

运用模块字幕出动画样式包. 注意：如果已经应用了循环动画样式包，需要先把循环动画设置为null，否则不生效

参数

captionOutAnimationPackageId 字幕出动画样式资源包ID

返回: 返回boolean值。true表示成功运用，false则运用失败

警告: 此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题

参见: getModularCaptionOutAnimationPackageId

自从: 2.15.2

◆ applyModularCaptionRenderer()

boolean com.meicam.sdk.NvsCaption.applyModularCaptionRenderer ( String captionRendererPackageId )

inline

运用模块字幕渲染样式包

参数

captionRendererPackageId 字幕渲染样式资源包ID

返回: 返回boolean值。true表示成功运用，false则运用失败

警告: 此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题

参见: getModularCaptionRenderPackageId

自从: 2.15.2

◆ getAnchorPoint()

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

inline

获取字幕锚点

返回: 返回字幕锚点

自从: 1.15.0

参见: setAnchorPoint

◆ getBackgroundColor()

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

inline

获取字幕文本的当前背景颜色值

返回: 返回NvsColor对象，表示当前的文本背景颜色值

参见: setBackgroundColor

自从: 2.15.1

◆ getBackgroundRadius()

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

inline

获取字幕文本的当前背景框的圆角半径

返回: 返回圆角半径值

参见: setBackgroundRadius

自从: 2.15.1

◆ getBold()

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

inline

获取字幕字体加粗状态

返回: 返回字幕字体加粗状态。true表示字体已加粗，false则字体未加粗

参见: setBold

◆ getBoundaryPaddingRatio()

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

inline

获取字幕边界扩展比率

返回: 扩展比率

参见: setBoundaryPaddingRatio

◆ getBoundingRectangleVertices()

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

inline

获取字幕的原始包围矩形框变换后的顶点位置

返回: 返回List<PointF>对象，包含四个顶点位置，依次分别对应原始包围矩形框的左上，左下，右下，右上顶点

自从: 1.8.1

◆ getCaptionBoundingVertices()

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

inline

获取字幕原始边框变换后的顶点位置

参数

boundingType 边框类型。请参见边框类型

返回: 返回List<PointF>对象，包含四个顶点位置，依次分别对应原始边框的左上，左下，右下，右上顶点

自从: 2.9.0

◆ getCaptionStylePackageId()

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

inline

获得字幕样式包裹ID

返回: 返回获得的字幕样式资源包ID

◆ getCaptionTranslation()

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

inline

获取字幕的平移量

返回: 返回PointF对象，表示获得的字幕平移量

参见: setCaptionTranslation

◆ getCategory()

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

inline

获得字幕的种类

返回: 返回获得的字幕种类

◆ getCenterAzimuthAngle()

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

inline

获取字幕中心点的方位角。只对全景图字幕有效

返回: 返回字幕中心点的方位角，单位为角度

自从: 1.6.0

◆ getCenterPolarAngle()

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

inline

获取字幕中心点的极角。只对全景图字幕有效

返回: 返回字幕中心点的极角，单位为角度

自从: 1.6.0

◆ getComplexRenderLayerCount()

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

inline

获取复杂字幕层数

返回: 字幕层数。

自从: 3.8.2

◆ getComplexRenderLayerOpacity()

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

inline

获取复杂字幕某层字幕不透明度。

返回: 不透明度。

◆ getComplexRenderLayerOutlineColor()

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

inline

获取复杂字幕某层字幕描边颜色值。

返回: 描边颜色值

自从: 3.8.2

◆ getComplexRenderLayerOutlineWidth()

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

inline

获取复杂字幕某层字幕描边宽度。

返回: 描边宽度。

◆ getControlPoint()

NvsControlPointPair com.meicam.sdk.NvsCaption.getControlPoint ( String fxParam )

inline

返回关键帧控制点对

参数

fxParam 字幕参数的类型

返回: 返回获得的控制点信息, 如果控制点为{0, 0}说明当前控制点插值方式为线性插值

参见: setControlPoint

自从: 2.22.0

◆ getDisableElegantTextHeight()

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

inline

获取是否禁止elegant text height特性

自从: 3.5.2

◆ getDrawOutline()

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

inline

获取字幕描边状态

返回: 返回boolean值，true表示已描边，false则未描边

参见: setDrawOutline

◆ getDrawShadow()

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

inline

获取当前字幕阴影状态

返回: 返回boolean值，true表示有字幕阴影，false则没有字幕阴影

参见: setDrawShadow

◆ getFontFamily()

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

inline

获取字幕字体的名字

返回: 返回字幕字体的名字

自从: 2.4.2

参见: setFontFamily

◆ getFontFilePath()

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

inline

获取字幕字体的文件路径

返回: 返回字幕字体的文件路径

自从: 1.3.0

参见: setFontByFilePath

◆ getFontSize()

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

inline

获取当前字幕的字体大小

参见: setFontSize

◆ getItalic()

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

inline

获取字幕斜体状态

返回: 返回boolean值，true表示是斜体字体，false则不是斜体

参见: setItalic

◆ getLetterSpacing()

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

inline

获取字幕字间距

返回: 返回float值，类型默认百分比值。(LETTER_SPACING_TYPE)

参见: setLetterSpacing; setLetterSpacingType

自从: 1.16.0

◆ getLetterSpacingType()

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

inline

获取字幕字间距类型

返回: 返回字间距类型 (LETTER_SPACING_TYPE)

参见: setLetterSpacingType

自从: 2.15.1

◆ getLineSpacing()

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

inline

获取字幕行间距

返回: 返回float值，行间距，绝对值

参见: setLineSpacing

自从: 2.15.1

◆ getModularCaptionAnimationPackageId()

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

inline

获得模块字幕循环动画样式包裹ID

返回: 返回获得的模块字幕循环动画样式资源包ID

参见: isModular; applyModularCaptionAnimation

自从: 2.15.2

◆ getModularCaptionAnimationPeroid()

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

inline

获取模块字幕循环动画的周期

返回: 返回模块字幕的动画周期，注意：单位是毫秒

参见: setModularCaptionAnimationPeroid

自从: 2.15.2

◆ getModularCaptionContextPackageId()

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

inline

获得模块字幕环境样式包裹ID

返回: 返回获得的模块字幕环境样式资源包ID

参见: isModular; applyModularCaptionContext

自从: 2.15.2

◆ getModularCaptionInAnimationDuration()

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

inline

获取模块字幕入动画的时长

返回: 返回模块字幕入动画的时长，注意：单位是毫秒

参见: setModularCaptionInAnimationDuration

自从: 2.15.2

◆ getModularCaptionInAnimationPackageId()

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

inline

获得模块字幕入动画样式包裹ID

返回: 返回获得的模块字幕入动画样式资源包ID

参见: isModular; applyModularCaptionInAnimation

自从: 2.15.2

◆ getModularCaptionOutAnimationDuration()

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

inline

获取模块字幕出动画的时长

返回: 返回模块字幕出动画的时长，注意：单位是毫秒

参见: setModularCaptionOutAnimationDuration

自从: 2.15.2

◆ getModularCaptionOutAnimationPackageId()

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

inline

获得模块字幕出动画样式包裹ID

返回: 返回获得的模块字幕出动画样式资源包ID

参见: isModular; applyModularCaptionOutAnimation

自从: 2.15.2

◆ getModularCaptionRendererPackageId()

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

inline

获得模块字幕渲染样式包裹ID

返回: 返回获得的模块字幕渲染样式资源包ID

参见: isModular; applyModularCaptionRenderer

自从: 2.15.2

◆ getOpacity()

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

inline

获取透明度

返回: 返回获取的字幕透明度

参见: setOpacity

自从: 2.14.0

◆ getOrthoAngleRange()

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

inline

获取字幕与极角垂直的张角。只对全景图字幕有效

返回: 返字幕与极角垂直的张角，单位为角度

自从: 1.7.0

◆ getOutlineColor()

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

inline

获取当前字幕描边的颜色值

返回: 返回NvsColor对象，表示获得的字幕描边的颜色

参见: setOutlineColor

◆ getOutlineWidth()

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

inline

获取当前字幕描边的宽度

返回: 返回获得的字幕描边的宽度值

参见: setOutlineWidth

◆ getPanoramicRotation()

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

inline

获取字幕旋转角度。只对全景图字幕有效

返回: 返回字幕旋转角度

自从: 1.7.1

◆ getPanoramicScaleX()

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

inline

获取字幕水平缩放系数。只对全景图字幕有效

返回: 返回字幕水平缩放系数

自从: 1.6.0

◆ getPanoramicScaleY()

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

inline

获取字幕垂直缩放系数。只对全景图字幕有效

返回: 返回字幕垂直缩放系数

自从: 1.6.0

◆ getPolarAngleRange()

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

inline

获取字幕极角的张角。只对全景图字幕有效

返回: 返回字幕极角的张角，单位为角度

自从: 1.6.0

◆ getRoleInTheme()

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

inline

字幕在主题中的角色

返回: 返回字幕在主题中的角色

◆ getRotationZ()

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

inline

获取字幕旋转角度

返回: 返回字幕旋转角度

自从: 1.14.1

参见: setRotationZ

◆ getScaleX()

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

inline

获取字幕水平缩放系数

返回: 返回字幕水平缩放系数

自从: 1.14.1

参见: setScaleX; getScaleY

◆ getScaleY()

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

inline

获取字幕垂直缩放系数

返回: 返回字幕垂直缩放系数

自从: 1.14.1

参见: setScaleY; getScaleX

◆ getSecondaryColor()

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

inline

获取字幕字体的当前第二个颜色值

返回: 返回NvsColor对象，表示获得的颜色值

参见: setSecondaryColor

自从: 2.19.0

◆ getSecondaryOutlineColor()

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

inline

获取字幕描边的第二个颜色值

返回: 返回NvsColor对象，表示获得的颜色值

参见: setSecondaryOutlineColor

自从: 3.1.0

◆ getShadowColor()

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

inline

获取当前字幕阴影的颜色

返回: 返回NvsColor对象，表示获得的字幕阴影颜色值

参见: setShadowColor

◆ getShadowFeather()

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

inline

获取当前字幕阴影的羽化程度

返回: 返回羽化程度

参见: setShadowFeather

◆ getShadowOffset()

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

inline

获取当前字幕阴影的偏移量

返回: 返回PointF对象，表示获得的字幕阴影偏移量

参见: setShadowOffset

◆ getText()

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

inline

获取字幕文本

返回: 返回获取的字幕文本

参见: setText

◆ getTextAlignment()

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

inline

获取字幕水平对齐方式

返回: 返回字幕水平对齐方式。请参见字幕对齐方式

参见: setTextAlignment

自从: 1.10.0

◆ getTextBoundingRect()

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

inline

获取字幕文本矩形框

返回: 返回RectF对象，表示获得的字幕文本矩形框

◆ getTextCenterAzimuthAngle()

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

inline

获取字幕文本中心点的方位角。只对全景图字幕有效

返回: 返回字幕文本中心点的方位角，单位为角度

自从: 2.5.1

◆ getTextCenterPolarAngle()

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

inline

获取字幕文本中心点的极角。只对全景图字幕有效

返回: 返回字幕文本中心点的极角，单位为角度

自从: 2.5.1

◆ getTextColor()

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

inline

获取字幕字体的当前颜色值

返回: 返回NvsColor对象，表示获得的颜色值

参见: setTextColor

◆ getTextLayout()

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

inline

获取字幕layout属性

自从: 3.5.0

◆ getTextOrthoAngleRange()

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

inline

获取文本与极角垂直的张角。只对全景图字幕有效

返回: 返文本与极角垂直的张角，单位为角度

自从: 2.5.1

◆ getTextPolarAngleRange()

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

inline

获取文本与极角垂直的张角。只对全景图字幕有效

返回: 返回文本与极角垂直的张角，单位为角度

自从: 2.5.1

◆ getTextSpanList()

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

inline

获取需要应用多种layout属性

自从: 3.5.0

◆ getTextVerticalAlignment()

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

inline

获取字幕垂直对齐方式，仅对边框型字幕有效

返回: 返回字幕垂直对齐方式。请参见字幕对齐方式

参见: setTextVerticalAlignment

自从: 2.19.1

◆ getUnderline()

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

inline

获取字幕下划线状态

返回: 返回boolean值，true表示是下划线，false则不是下划线

参见: setUnderline

◆ getVerticalLayout()

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

inline

获取字幕是否竖向排版

返回: 返回字幕是否竖向排版

参见: setVerticalLayout

自从: 2.16.0

◆ getWeight()

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

inline

获取字幕权重值

返回: 字幕权重值

参见: setWeight

◆ getZValue()

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

inline

获取字幕Z值

返回: 返回字幕Z值

自从: 1.10.0

◆ hasOutlineLayerInComplexRender()

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

inline

判断当前字幕层是否存在描边

返回

自从: 3.8.2

◆ isFrameCaption()

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

inline

判断是否是边框字幕

返回: 返回值为true表示为边框字幕

自从: 2.19.1

◆ isModular()

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

inline

判断当前字幕是否为模块字幕

返回: 返回值为true表示为模块字幕

自从: 2.15.2

◆ isPanoramic()

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

inline

判断当前字幕是否为全景图字幕

返回: 返回值为true表示为全景图字幕

自从: 1.6.0

◆ isRecordingUserOperation()

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

inline

默认为true

返回: 返回是否记录用户操作

自从: 3.8.2

◆ resetOutlineColorState()

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

inline

重置字幕描边颜色状态

自从: 3.5.0

◆ resetTextColorState()

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

inline

重置字幕文本颜色状态

自从: 3.5.0

◆ rotateCaption() [1/2]

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

inline

以字幕中心点为锚点旋转字幕

参数

angle 字幕旋转的角度

自从: 1.8.1

◆ rotateCaption() [2/2]

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

inline

旋转字幕

参数

angle	字幕旋转的角度
anchor	字幕旋转的锚点

自从: 1.8.1

◆ scaleCaption()

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

inline

缩放字幕

参数

scaleFactor	字幕缩放的因子
anchor	字幕缩放的锚点

自从: 1.8.1

◆ setAnchorPoint()

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

inline

设置字幕锚点

参数

anchor 锚点

自从: 1.15.0

参见: getAnchorPoint

◆ setBackgroundColor()

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

inline

设置字幕文本的背景颜色

参数

backgroundColor 文本背景颜色值

参见: getBackgroundColor

自从: 2.15.1

◆ setBackgroundRadius()

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

inline

设置字幕文本的背景框的圆角半径

参数

radius 圆角半径值

参见: getBackgroundRadius

自从: 2.15.1

◆ setBold()

void com.meicam.sdk.NvsCaption.setBold ( boolean bold )

inline

设置字幕字体加粗

参数

bold	表示字幕字体是否加粗。true表示加粗，false则不加粗

参见: getBold

◆ setBoundaryPaddingRatio()

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

inline

设置字幕边界扩展比率

参数

ratio 扩展比率为字体大小的倍数，默认值为0.15

参见: getBoundaryPaddingRatio

◆ setCaptionTranslation()

void com.meicam.sdk.NvsCaption.setCaptionTranslation ( PointF translation )

inline

设置字幕平移量

参数

translation 字幕平移的水平和垂直的绝对平移值

参见: getCaptionTranslation

◆ setCenterAzimuthAngle()

void com.meicam.sdk.NvsCaption.setCenterAzimuthAngle ( float centerAzimuthAngle )

inline

对字幕设置中心点的方位角。只对全景图字幕有效

参数

centerAzimuthAngle 中心点的极角，单位为角度

自从: 1.6.0

◆ setCenterPolarAngle()

void com.meicam.sdk.NvsCaption.setCenterPolarAngle ( float centerPolarAngle )

inline

对字幕设置中心点的极角。只对全景图字幕有效

参数

centerPolarAngle 中心点的极角，单位为角度

自从: 1.6.0

◆ setComplexRenderLayerOpacity()

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

inline

设置复杂字幕某层字幕不透明度。

返回: 设置成功与否

◆ setComplexRenderLayerOutlineColor()

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

inline

获取复杂字幕某层字幕描边颜色值。

返回: 设置成功与否。

◆ setComplexRenderLayerOutlineWidth()

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

inline

获取复杂字幕某层字幕描边宽度。

返回: 设置成功与否

◆ setControlPoint()

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

inline

设置字幕的关键帧控制点对

参数

fxParam	字幕参数的类型
controlPointPair	控制点对，设置控制点为{0, 0}，即当前控制点为线性插值方式，否则为曲线插值方式

参见: getControlPoint

自从: 2.22.0

◆ setCurrentKeyFrameTime()

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

inline

设置字幕的关键帧时间

参见: setCurrentKeyFrameTime

自从: 2.15.0

◆ setDisableElegantTextHeight()

void com.meicam.sdk.NvsCaption.setDisableElegantTextHeight ( boolean disableElegantTextHeight )

inline

由于历史遗留因素，美摄SDK在Android平台的水平文字排版时使用了elegant text height特性，这会导致Android平台的水平排版与其它平台的行间距有差别。设置这个属性会禁止Android水平排版使用elegant text height特性。默认值为false。

参数

禁止开启Elegant Text Height

自从: 3.5.2

◆ setDrawOutline()

void com.meicam.sdk.NvsCaption.setDrawOutline ( boolean drawOutline )

inline

设置字幕描边

参数

drawOutline 是否对字幕描边。true表示对字幕进行描边，false则不描边

参见: getDrawOutline

◆ setDrawShadow()

void com.meicam.sdk.NvsCaption.setDrawShadow ( boolean drawShadow )

inline

设置字幕阴影

参数

drawShadow 是否设置字幕阴影。true表示设置字幕阴影，false则不设置

参见: getDrawShadow

◆ setFontByFilePath()

void com.meicam.sdk.NvsCaption.setFontByFilePath ( String filePath )

inline

设置字幕字体

参数

filePath 字幕字体的文件路径，若设为空字符串，则设为默认字体

自从: 1.3.0

参见: getFontFilePath

◆ setFontFamily()

void com.meicam.sdk.NvsCaption.setFontFamily ( String family )

inline

设置字幕字体

参数

family 字幕字体名字，若设为空字符串，则设为默认字体

自从: 2.4.2

参见: getFontFamily

◆ setFontSize()

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

inline

设置字幕字体大小

参数

fontSize 字幕字体大小值

参见: getFontSize

◆ setFrameCaptionMaxFontSize()

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

inline

设置边框字幕的最大字号，只有边框字幕才可以使用此方法。

自从: 2.19.1

◆ setItalic()

void com.meicam.sdk.NvsCaption.setItalic ( boolean italic )

inline

设置字幕字体斜体

参数

italic 是否设为斜体。true表示设置字幕字体为斜体，false则不设为斜体

参见: getItalic

◆ setLetterSpacing()

void com.meicam.sdk.NvsCaption.setLetterSpacing ( float letterSpacing )

inline

设置字幕字间距

参数

letterSpacing 字间距，类型默认百分比。(LETTER_SPACING_TYPE)

参见: getLetterSpacing; setLetterSpacingType

自从: 1.16.0

◆ setLetterSpacingType()

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

inline

设置字幕字间距类型

参数

letterSpacingType 字间距类型. (LETTER_SPACING_TYPE)

参见: getLetterSpacingType

自从: 2.15.1

◆ setLineSpacing()

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

inline

设置字幕行间距

参数

lineSpacing 行间距，绝对值

参见: getLineSpacing

自从: 2.15.1

◆ setModularCaptionAnimationPeroid()

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

inline

设置模块字幕循环动画的周期

参数

periodInMS 周期的时间，注意：单位是毫秒

参见: getModularCaptionAnimationPeroid

自从: 2.15.2

◆ setModularCaptionInAnimationDuration()

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

inline

设置模块字幕入动画的时长

参数

inAnimationDurationInMS 入动画的时长，注意：单位是毫秒

参见: getModularCaptionInAnimationDuration

自从: 2.15.2

◆ setModularCaptionOutAnimationDuration()

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

inline

设置模块字幕出动画的时长

参数

outAnimationDurationInMS 出动画的时长，注意：单位是毫秒

参见: getModularCaptionOutAnimationDuration

自从: 2.15.2

◆ setOpacity()

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

inline

设置字幕透明度

参数

opacity 字幕透明度

参见: getOpacity

自从: 2.14.0

◆ setOutlineColor()

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

inline

设置字幕描边的颜色

参数

outlineColor 字幕描边颜色值

参见: getOutlineColor

◆ setOutlineWidth()

void com.meicam.sdk.NvsCaption.setOutlineWidth ( float outlineWidth )

inline

设置字幕描边的宽度

参数

outlineWidth 字幕描边的宽度

参见: getOutlineWidth

◆ setPanoramicRotation()

void com.meicam.sdk.NvsCaption.setPanoramicRotation ( float rotationAngle )

inline

对字幕设置旋转角度。只对全景图字幕有效

参数

rotationAngle 旋转角度

自从: 1.7.1

◆ setPanoramicScaleX()

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

inline

对字幕设置水平缩放系数。只对全景图字幕有效

参数

scaleX 水平缩放系数

自从: 1.6.0

◆ setPanoramicScaleY()

void com.meicam.sdk.NvsCaption.setPanoramicScaleY ( float scaleY )

inline

对字幕设置垂直缩放系数。只对全景图字幕有效

参数

scaleY 垂直缩放系数

自从: 1.6.0

◆ setPolarAngleRange()

void com.meicam.sdk.NvsCaption.setPolarAngleRange ( float polarAngleRange )

inline

对字幕设置极角的张角。只对全景图字幕有效

参数

polarAngleRange 极角的张角，单位为角度

自从: 1.6.0

◆ setRecordingUserOperation()

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

inline

设置字幕是否记录用户的操作

参数

recordingUserOperation 字幕是否记录用户操作

自从: 2.11.0

◆ setRotationZ()

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

inline

对字幕设置旋转角度

参数

angle 旋转角度

自从: 1.14.1

参见: getRotationZ

◆ setScaleX()

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

inline

对字幕设置水平缩放系数

参数

scale 水平缩放系数

自从: 1.14.1

参见: getScaleX; setScaleY

◆ setScaleY()

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

inline

对字幕设置垂直缩放系数

参数

scale 垂直缩放系数

自从: 1.14.1

参见: getScaleY; setScaleX

◆ setSecondaryColor()

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

inline

设置字幕第二个颜色, 目前只应用在卡拉OK字幕上

参数

color 字幕颜色值

参见: getSecondaryColor

自从: 2.19.0

◆ setSecondaryOutlineColor()

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

inline

设置字幕描边的第二个颜色, 目前只应用在卡拉OK字幕上

参数

color 字幕描边颜色值

参见: getSecondaryOutlineColor

自从: 3.1.0

◆ setShadowColor()

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

inline

设置字幕阴影的颜色

参数

shadowColor 字幕阴影颜色值

参见: getShadowColor

◆ setShadowFeather()

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

inline

设置字幕阴影的羽化程度

参数

feather 羽化程度

参见: getShadowFeather

◆ setShadowOffset()

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

inline

设置字幕阴影的偏移量

参数

shadowOffset 字幕阴影的偏移量

参见: getShadowOffset

◆ setText()

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

inline

设置字幕文本

参数

text 字幕文本

参见: getText

◆ setTextAlignment()

void com.meicam.sdk.NvsCaption.setTextAlignment ( int textAlign )

inline

设置字幕水平对齐方式

参数

textAlign 表示字幕水平对齐方式。请参见字幕对齐方式

参见: getTextAlignment; setTextVerticalAlignment

自从: 1.10.0

◆ setTextColor()

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

inline

设置字幕文本颜色

参数

textColor 字幕文本颜色值

参见: getTextColor

◆ setTextFrameOriginRect()

void com.meicam.sdk.NvsCaption.setTextFrameOriginRect ( RectF rc )

inline

设置边框字幕的原始边框大小，如果当前字幕不是边框字幕，该函数没有效果. 可以通过getCaptionBoundingVertices中的BOUNDING_TYPE_TEXT_ORIGIN_FRAME获取原始边框大小

参数

rc 新的边框大小

参见: getCaptionBoundingVertices

自从: 2.19.0

◆ setTextSpanList()

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

inline

用户可以指定字幕中位置从某一起始字符到某一结束字符之间，应用多种layout属性。

返回: 是否成功设置。

自从: 3.5.0

◆ setTextVerticalAlignment()

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

inline

设置字幕垂直对齐方式，仅对边框型字幕有效

参数

verticalTextAlign 表示字幕垂直对齐方式。请参见字幕对齐方式

参见: getTextVerticalAlignment; setTextAlignment

自从: 2.19.1

◆ setUnderline()

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

inline

设置字幕下划线

参数

underline 是否设置下划线

参见: getUnderline

◆ setVerticalLayout()

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

inline

设置字幕是否竖向排版

参数

verticalLayout 字幕竖向排版

参见: getVerticalLayout

自从: 2.16.0

◆ setWeight()

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

inline

设置字幕权重

参数

weight opentype中的权重值

参见: getWeight

◆ setZValue()

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

inline

设置字幕Z值

参数

value z值

自从: 1.10.0

◆ translateCaption()

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

inline

平移字幕

参数

translationOffset 字幕平移的水平和垂直的偏移值

自从: 1.7.0

参见: setCaptionTranslation; getCaptionTranslation

类成员变量说明

◆ BOUNDING_TYPE_FRAME

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

static

包括装饰在内的整体边框

◆ BOUNDING_TYPE_TEXT

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

static

文字的实际边框

◆ BOUNDING_TYPE_TEXT_FRAME

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

static

文字框的边框

◆ BOUNDING_TYPE_TEXT_ORIGIN_FRAME

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

static

没有经过变换的文字框的边框

◆ BOUNDING_TYPE_TYPOGRAPHIC_TEXT

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

static

文字的排版边框

◆ DEFAULT_CATEGORY

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

static

默认种类

◆ LETTER_SPACING_TYPE_ABSOLUTE

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

static

文字字间距的类型是绝对值

◆ LETTER_SPACING_TYPE_PERCENTAGE

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

static

文字字间距的类型是百分比

◆ NOT_USE_ASSET_DEFAULT_PARAM

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

static

不使用默认的字幕包属性

◆ ROLE_IN_THEME_GENERAL

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

static

通用

◆ ROLE_IN_THEME_TITLE

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

static

片头

◆ ROLE_IN_THEME_TRAILER

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

static

片尾

◆ TEXT_ALIGNMENT_BOTTOM

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

static

居下对齐，仅边框字幕有效

◆ TEXT_ALIGNMENT_CENTER

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

static

居中对齐

◆ TEXT_ALIGNMENT_LEFT

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

static

居左对齐(垂直布局就是居上对齐)

◆ TEXT_ALIGNMENT_RIGHT

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

static

居右对齐(垂直布局就是居下对齐)

◆ TEXT_ALIGNMENT_TOP

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

static

居上对齐，仅边框字幕有效

◆ TEXT_ALIGNMENT_VCENTER

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

static

垂直居中对齐，仅边框字幕有效

◆ THEME_CATEGORY

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

static

主题种类

◆ USE_ASSET_DEFAULT_PARAM

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

static

使用默认的字幕包属性

◆ USER_CATEGORY

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

static

用户自定义种类

该类的文档由以下文件生成:

src/android/jar/com/meicam/sdk/NvsCaption.java

Public 成员函数

静态 Public 属性

额外继承的成员函数

详细描述

成员函数说明

◆ 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()