美摄Web端SDK  3.12.1
Public 成员函数 | 所有成员列表
NvsClipCaption类 参考

片段字幕 更多...

类 NvsClipCaption 继承关系图:
NvsCaption NvsFx NvsProjObj

Public 成员函数

 constructor ()
 构造函数
 
 setAbsoluteTimeUsed (used)
 设置是否使用绝对时间线渲染特效 更多...
 
 getAbsoluteTimeUsed ()
 获取是否使用绝对时间线渲染特效 更多...
 
- Public 成员函数 继承自 NvsCaption
 constructor ()
 构造函数
 
 getRoleInTheme ()
 字幕在主题中的作用。 更多...
 
 getCategory ()
 获取字幕的类型。 更多...
 
 getCaptionStylePackageId ()
 获取字幕样式包 ID。 更多...
 
 getModularCaptionContextPackageId ()
 获取模块化字幕上下文样式包 ID。 更多...
 
 getModularCaptionRendererPackageId ()
 获取模块化字幕渲染样式包 ID。 更多...
 
 getModularCaptionAnimationPackageId ()
 获取模块化字幕动画样式包 ID。 更多...
 
 getModularCaptionInAnimationPackageId ()
 获取模块化字幕动画样式包 ID。 更多...
 
 getModularCaptionOutAnimationPackageId ()
 获取模块化字幕外动画样式包 ID。 更多...
 
 applyCaptionStyle (captionStylePackageId, isUseDefaultAssetParam)
 应用标题样式 更多...
 
 applyModularCaptionContext (captionContextPackageId)
 应用模块化标题上下文样式。 更多...
 
 applyModularCaptionRenderer (captionRendererPackageId)
 应用模块化字幕渲染样式。 更多...
 
 applyModularCaptionAnimation (captionAnimationPackageId)
 应用模块化字幕循环动画样式。 更多...
 
 applyModularCaptionInAnimation (captionInAnimationPackageId)
 在动画样式中应用模块化字幕。注意:设置in-animation前请先设置loop-Animation为null,否则无效。 更多...
 
 applyModularCaptionOutAnimation (captionOutAnimationPackageId)
 应用模块化字幕出动画样式。注意:请在设置出动画之前将loop-Animation设置为null,否则将不起作用。 更多...
 
 setModularCaptionAnimationPeroid (periodInMS)
 设置模块化字幕动画周期。 更多...
 
 getModularCaptionAnimationPeroid ()
 获取模块化字幕动画周期。 更多...
 
 setModularCaptionInAnimationDuration (inAnimationDurationInMS)
 设置模块化字幕动画持续时间。 更多...
 
 getModularCaptionInAnimationDuration ()
 获取动画中的模块化字幕持续时间。 更多...
 
 setModularCaptionOutAnimationDuration (outAnimationDurationInMS)
 设置模块化字幕动画持续时间。 更多...
 
 getModularCaptionOutAnimationDuration ()
 获取模块化字幕动画持续时间。 更多...
 
 setText (text)
 设置标题文本。 更多...
 
 getText ()
 获取字幕文本。 更多...
 
 setTextAlignment (textAlign)
 设置标题水平对齐样式 更多...
 
 getTextAlignment ()
 获取标题水平对齐样式 更多...
 
 setTextVerticalAlignment (textAlign)
 设置标题水平对齐样式 更多...
 
 getTextVerticalAlignment ()
 获取标题垂直对齐样式,仅对 frame-caption 有效。 更多...
 
 setVerticalLayout (verticalLayout)
 设置是否垂直布局文本。 更多...
 
 getVerticalLayout ()
 获取是否垂直布局文本。 更多...
 
 setBold (bold)
 设置标题字体粗体 更多...
 
 getBold ()
 获取字幕字体加粗状态 更多...
 
 setItalic (italic)
 设置标题字体斜体。 更多...
 
 getItalic ()
 获取标题字体斜体。 更多...
 
 setUnderline (underline)
 设置标题下划线 更多...
 
 getUnderline ()
 获取标题下划线 更多...
 
 setLetterSpacingType (letterSpacingType)
 设置标题字间距类型。 更多...
 
 getLetterSpacingType ()
 获取标题字间距类型。 更多...
 
 setLetterSpacing (letterSpacing)
 设置标题字母间距 更多...
 
 getLetterSpacing ()
 获取标题字母间距 更多...
 
 setLineSpacing (lineSpacing)
 设置行距 更多...
 
 getLineSpacing ()
 获取行距 更多...
 
 setWeight (weight)
 设置字幕权重 更多...
 
 getWeight ()
 获取字幕重量 更多...
 
 setTextColor (color)
 设置标题文字颜色 更多...
 
 getTextColor ()
 获取标题文本颜色 更多...
 
 setDrawOutline (drawOutline)
 设置字幕描边。 更多...
 
 getDrawOutline ()
 获取字幕描边。 更多...
 
 setOutlineWidth (outlineWidth)
 设置标题笔划的宽度。 更多...
 
 getOutlineWidth ()
 获取标题笔画的宽度。 更多...
 
 setOutlineColor (color)
 设置标题描边的颜色。 更多...
 
 getOutlineColor ()
 获取标题笔划的颜色。 更多...
 
 setDrawShadow (drawShadow)
 设置字幕阴影。 更多...
 
 getDrawShadow ()
 获取字幕阴影。 更多...
 
 setShadowOffset (offset)
 设置字幕阴影偏移 更多...
 
 getShadowOffset ()
 获取当前字幕阴影的偏移量。 更多...
 
 setShadowColor (color)
 设置字幕阴影颜色 更多...
 
 getShadowColor ()
 获取字幕阴影颜色 更多...
 
 setShadowFeather (feather)
 设置字幕阴影的羽化程度。 更多...
 
 getShadowFeather ()
 获取字幕阴影的羽化度。 更多...
 
 setFontSize (fontSize)
 设置字幕字体大小。 更多...
 
 getFontSize ()
 获取字幕字体大小。 更多...
 
 setFontByFilePath (filePath)
 按文件路径设置字幕字体 更多...
 
 getFontFilePath ()
 获取字幕字体文件路径 更多...
 
 setFontFamily (family)
 设置标题字体系列 更多...
 
 getFontFamily ()
 获取字体名称 更多...
 
 getFontCompoundFamilyName ()
 获取字体组合名称 更多...
 
 setCaptionTranslation (translation)
 设置字幕平移量。 更多...
 
 getCaptionTranslation ()
 获取字幕平移量。 更多...
 
 translateCaption (translationOffset)
 字幕平移。 更多...
 
 setAnchorPoint (anchor)
 设置字幕锚。 更多...
 
 getAnchorPoint ()
 获取字幕锚。 更多...
 
 setScaleX (scale)
 设置字幕的水平缩放系数。 更多...
 
 getScaleX ()
 获取标题的水平缩放系数。 更多...
 
 setScaleY (scale)
 设置标题的垂直比例系数。 更多...
 
 getScaleY ()
 获取标题的垂直比例系数。 更多...
 
 scaleCaption (scaleFactor, anchor)
 缩放字幕。 更多...
 
 scaleCaption2 (scaleFactor)
 在中心缩放标题 更多...
 
 setRotationZ (angle)
 设置字幕的旋转角度。 更多...
 
 getRotationZ ()
 获取标题的旋转角度。 更多...
 
 rotateCaption (angle, anchor)
 旋转字幕 更多...
 
 rotateCaption2 (angle)
 以字幕中心点为锚点旋转字幕。 更多...
 
 getTextBoundingRect ()
 获取标题文本矩形 更多...
 
 getBoundingRectangleVertices ()
 获取转换后字幕的原始包围矩形的顶点位置。 更多...
 
 getCaptionBoundingVertices (boundingType)
 获取原始字幕边界的变换顶点位置。 更多...
 
 setZValue (value)
 设置标题 Z 值。 更多...
 
 getZValue ()
 获取标题 Z 值。 更多...
 
 setRecordingUserOperation (recordingUserOperation)
 设置是否记录用户操作。 更多...
 
 setOpacity (opacity)
 设置字幕不透明度。 更多...
 
 getOpacity ()
 设置字幕不透明度。 更多...
 
 isFrameCaption ()
 确定它是否是边框标题。 更多...
 
 isTextColorChanged ()
 确定标题文本颜色是否改变。 更多...
 
 isModular ()
 确定当前标题是否为模块化标题。 更多...
 
 setBackgroundColor (backgroundColor)
 设置文本背景颜色。 更多...
 
 getBackgroundColor ()
 获取当前文本背景颜色值。 更多...
 
 setBackgroundRadius (radius)
 设置文本背景矩形的角半径。 更多...
 
 getBackgroundRadius ()
 获取文本背景矩形的角半径。 更多...
 
 setCurrentKeyFrameTime (time)
 设置标题 KeyFrameTime。 更多...
 
 setIsLyrics (isLyrics)
 设置字幕歌词类型 更多...
 
 isLyrics ()
 歌词与否 更多...
 
 enableSpeed (enable)
 开启变速 更多...
 
 isSpeedEnabled ()
 是否开启变速 更多...
 
 setFrameCaptionMaxFontSize (maxFontSize)
 设置边框标题的最大字体大小。只有边框标题可以使用此方法。 更多...
 
 setTextFrameOriginRect (rect)
 设置帧标题的原始帧大小。如果当前字幕不是帧字幕,则此功能无效。您可以获得原始帧大小。 更多...
 
 setTextSpanList (spanList)
 用户可以指定字幕中位置从某一起始字符到某一结束字符之间,应用多种layout属性 更多...
 
 getTextSpanList ()
 获取字幕layout属性列表 更多...
 
- Public 成员函数 继承自 NvsFx
 constructor ()
 特效类。构造器
 
 getDescription ()
 获取特效的描述。返回 NvsFxDescription 对象 更多...
 
 setIntVal (fxParam, val)
 设置整数值 更多...
 
 getIntVal (fxParam)
 获取整数值 更多...
 
 setIntValAtTime (fxParam, val, time)
 在某个时间设置整数值 更多...
 
 getIntValAtTime (fxParam, time)
 在某个时间获取整数值 更多...
 
 setFloatVal (fxParam, val)
 设置浮点值 更多...
 
 getFloatVal (fxParam)
 获取浮点值 更多...
 
 setFloatValAtTime (fxParam, val, time)
 在某个时间设置浮点值 更多...
 
 getFloatValAtTime (fxParam, time)
 在某个时间获取浮点值 更多...
 
 setBooleanVal (fxParam, val)
 设置布尔值 更多...
 
 getBooleanVal (fxParam)
 获取布尔值 更多...
 
 setBooleanValAtTime (fxParam, val, time)
 在某个时间设置布尔值 更多...
 
 getBooleanValAtTime (fxParam, time)
 在某个时间获取布尔值 更多...
 
 setMenuVal (fxParam, val)
 设置菜单值 更多...
 
 getMenuVal (fxParam)
 设置菜单值 更多...
 
 setMenuValAtTime (fxParam, val, time)
 在某个时间设置菜单值 更多...
 
 getMenuValAtTime (fxParam, time)
 在某个时间获取菜单值 更多...
 
 setStringVal (fxParam, val)
 设置字符串值 更多...
 
 getStringVal (fxParam)
 获取字符串值 更多...
 
 setStringValAtTime (fxParam, val, time)
 在某个时间点设置字符串值 更多...
 
 getStringValAtTime (fxParam, time)
 在某个时间获取字符串值 更多...
 
 setColorVal (fxParam, val)
 设置颜色值 更多...
 
 getColorVal (fxParam)
 设置颜色值 更多...
 
 setColorValAtTime (fxParam, val, time)
 在某个时间设置颜色 更多...
 
 getColorValAtTime (fxParam, time)
 在某个时间点获取颜色值 更多...
 
 removeKeyframeAtTime (fxParam, time)
 在某个时间删除关键帧 更多...
 
 removeAllKeyframe (fxParam)
 删除所有关键帧 更多...
 
 hasKeyframeList (fxParam)
 是否有关键帧列表 更多...
 
 findKeyframeTime (fxParam, time, flags)
 在某个时间查询关键帧 更多...
 
 setParamKeyframes (fxParam, keyframes)
 设置关键帧参数 更多...
 
 getParamKeyframes (fxParam)
 获取关键帧参数 更多...
 
 setParamKeyframeAtTime (fxParam, time, keyframe)
 在某个时间设置关键帧参数 更多...
 
 getParamKeyframeAtTime (fxParam, time)
 在某个时间获取关键帧参数 更多...
 
 getIntpFxParamValsAtTime (fxParam, time)
 在某个时间获取关键帧参数 更多...
 
 setFilterIntensity (intensity)
 设置滤镜强度 更多...
 
 getFilterIntensity ()
 获取滤镜强度 更多...
 
 setRegional (isRegional)
 设置区域 更多...
 
 getRegional ()
 获取区域范围 更多...
 
 setIgnoreBackground (isIgnoreBackground)
 设置忽略背景 更多...
 
 getIgnoreBackground ()
 获取忽略背景 更多...
 
 setInverseRegion (isInverseRegion)
 设置反转区域 更多...
 
 getInverseRegion ()
 获取反转区域 更多...
 
 setRegion (region)
 设置区域 更多...
 
 setRegionAtTime (region, time)
 在某个时间设置区域 更多...
 
 setEllipseRegion (center, a, b, angle)
 设置椭圆区域 更多...
 
 setEllipseRegionAtTime (center, a, b, angle, time)
 在某个时间点设置椭圆区域 更多...
 
 getRegionInfos ()
 获取特效区域信息 更多...
 
 getRegionInfosAtTime (time)
 获取特效在某个时间点的区域信息 更多...
 
 setRegionalFeatherWidth (featherWidth)
 设置区域羽化宽度 更多...
 
 getRegionalFeatherWidth ()
 获取区域羽化宽度 更多...
 
 getParticleSystemContext ()
 获取粒子特效上下文 更多...
 
 getARSceneManipulate ()
 获取ARScene操作 更多...
 
 setExprVar (varName, varValue)
 设置表达式变量 更多...
 
 getExprVar (varName)
 获取表达式变量 更多...
 
 setExprObjectVar (varName, varValue)
 设置对象(例如:颜色)表达式变量 更多...
 
 getExprObjectVar (varName)
 获取对象(例如:颜色)表达式变量 更多...
 
 clearExprVar ()
 清除Expr值 更多...
 
 clearExprVarCtx ()
 清空表达式中定义的全部参数的值,并设置为默认值0 更多...
 
 setArbitraryVal (fxParam, val)
 设置特效不定类型的值 更多...
 
 getArbitraryVal (fxParam)
 获取特效不定类型的值 更多...
 
 setArbitraryValAtTime (fxParam, val, time)
 
 getArbitraryValAtTime (fxParam, time)
 获取特效某时间点不定类型的值 更多...
 
 setRegionInfos (regionInfos)
 设置多个区域信息 更多...
 
 setRegionInfosAtTime (regionInfos, time)
 设置某个时间点的多个区域信息 更多...
 
- Public 成员函数 继承自 NvsProjObj
 constructor ()
 
 setInternalObject (obj)
 设置内置对象 更多...
 
 getInternalObject ()
 获取内置对象 更多...
 
 setTemplateAttachment (key, value)
 设置模板附件 更多...
 
 getTemplateAttachment (key)
 根据键,获取模板属性值 更多...
 

详细描述

片段字幕

成员函数说明

◆ getAbsoluteTimeUsed()

NvsClipCaption::getAbsoluteTimeUsed ( )
inline

获取是否使用绝对时间线渲染特效

返回
{Boolean} 是否使用绝对时间

◆ setAbsoluteTimeUsed()

NvsClipCaption::setAbsoluteTimeUsed (   used)
inline

设置是否使用绝对时间线渲染特效

参数
{Boolean}used 是否使用

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