美摄SDK For iOS  3.14.0
构造函数 | 属性 | 所有成员列表
NvsCaption类 参考

时间线字幕 更多...

#import <NvsCaption.h>

类 NvsCaption 继承关系图:
NvsFx NvsObject NvsCaptureCaption NvsClipCaption NvsTimelineCaption NvsTrackCaption

构造函数

(bool) - applyCaptionStyle:
 运用字幕样式 更多...
 
(bool) - applyModularCaptionContext:
 运用模块字幕环境样式包 更多...
 
(bool) - applyModularCaptionRenderer:
 运用模块字幕渲染样式包 更多...
 
(bool) - applyModularCaptionAnimation:
 运用模块字幕循环动画样式包 更多...
 
(bool) - applyModularCaptionInAnimation:
 运用模块字幕入动画样式包。注意：如果已经应用了循环动画样式包，需要先把循环动画设置为null，否则不生效 更多...
 
(bool) - applyModularCaptionOutAnimation:
 运用模块字幕出动画样式包. 注意：如果已经应用了循环动画样式包，需要先把循环动画设置为null，否则不生效 更多...
 
(void) - setModularCaptionAnimationPeroid:
 设置模块字幕循环动画的周期 更多...
 
(int) - getModularCaptionAnimationPeroid
 获取模块字幕循环动画的周期 更多...
 
(void) - setModularCaptionInAnimationDuration:
 设置模块字幕入动画的时长 更多...
 
(int) - getModularCaptionInAnimationDuration
 获取模块字幕入动画的时长 更多...
 
(void) - setModularCaptionOutAnimationDuration:
 设置模块字幕出动画的时长 更多...
 
(int) - getModularCaptionOutAnimationDuration
 获取模块字幕出动画的时长 更多...
 
(bool) - applyCaptionStyleWithAssetDefaultParam:isUseDefaultAssetParam:
 运用字幕样式 更多...
 
(void) - setText:
 设置字幕文本 更多...
 
(NSString *) - getText
 获取字幕文本 更多...
 
(void) - setVerticalLayout:
 设置字幕是否为竖版布局 更多...
 
(BOOL) - getVerticalLayout
 获取字幕布局状态 更多...
 
(void) - setTextAlignment:
 设置字幕水平对齐方式 更多...
 
(NvsTextAlignment) - getTextAlignment
 获取字幕水平对齐方式 更多...
 
(void) - setTextVerticalAlignment:
 设置字幕垂直对齐方式，仅边框型字幕有效 更多...
 
(NvsTextAlignment) - getTextVerticalAlignment
 获取字幕垂直对齐方式，仅边框型字幕有效 更多...
 
(void) - setBold:
 设置字幕字体是否加粗 更多...
 
(BOOL) - getBold
 获取字幕字体加粗状态 更多...
 
(void) - setWeight:
 设置字幕权重 更多...
 
(int) - getWeight
 获取字幕权重值 更多...
 
(void) - setItalic:
 设置字幕字体是否是斜体 更多...
 
(BOOL) - getItalic
 获取字幕斜体状态 更多...
 
(void) - setUnderline:
 设置字幕下划线 更多...
 
(BOOL) - getUnderline
 获取字幕下划线状态 更多...
 
(float) - getLetterSpacing
 获取字幕字间距 更多...
 
(void) - setLetterSpacing:
 设置字幕字间距 更多...
 
(NvsLetterSpacingType) - getLetterSpacingType
 获取字幕字间距类型 更多...
 
(void) - setLetterSpacingType:
 设置字幕字间距类型 更多...
 
(float) - getLineSpacing
 获取字幕行间距 更多...
 
(void) - setLineSpacing:
 设置字幕行间距 更多...
 
(void) - setTextColor:
 设置字幕文本颜色 更多...
 
(void) - resetTextColorState
 重置字幕颜色状态 更多...
 
(NvsColor) - getTextColor
 获取字幕字体的当前颜色值 更多...
 
(void) - setDrawOutline:
 设置字幕是否描边 更多...
 
(BOOL) - getDrawOutline
 获取字幕描边状态 更多...
 
(void) - setOutlineColor:
 设置字幕描边的颜色 更多...
 
(NvsColor) - getOutlineColor
 获取当前字幕描边的颜色值 更多...
 
(void) - resetOutlineColorState
 重置字幕描边颜色状态 更多...
 
(void) - setOutlineWidth:
 设置字幕描边的宽度 更多...
 
(float) - getOutlineWidth
 获取当前字幕描边的宽度 更多...
 
(void) - setDrawShadow:
 设置字幕阴影 更多...
 
(BOOL) - getDrawShadow
 获取当前字幕阴影状态 更多...
 
(void) - setShadowColor:
 设置字幕阴影的颜色 更多...
 
(NvsColor) - getShadowColor
 获取当前字幕阴影的颜色 更多...
 
(void) - setShadowOffset:
 设置字幕阴影的偏移量 更多...
 
(CGPoint) - getShadowOffset
 获取当前字幕阴影的偏移量 更多...
 
(void) - setShadowFeather:
 设置字幕阴影的羽化程度 更多...
 
(float) - getShadowFeather
 获取当前字幕阴影的羽化程度 更多...
 
(void) - setFontSize:
 设置字幕字体大小 更多...
 
(float) - getFontSize
 获取当前字幕的字体大小 更多...
 
(void) - setFrameCaptionMaxFontSize:
 设置边框字幕最大字体大小，只对边框型字幕有效果 更多...
 
(void) - setFontWithFilePath:
 设置字幕字体 更多...
 
(NSString *) - getFontFilePath
 获取字幕字体的文件路径 更多...
 
(NSString *) - getFontFamily
 获取字幕字体 更多...
 
(void) - setFontFamily:
 设置字幕字体 更多...
 
(void) - setCaptionTranslation:
 设置字幕的平移量 更多...
 
(CGPoint) - getCaptionTranslation
 获取字幕的平移量 更多...
 
(void) - translateCaption:
 平移字幕 更多...
 
(void) - setAnchorPoint:
 设置字幕锚点 更多...
 
(CGPoint) - getAnchorPoint
 获取字幕锚点 更多...
 
(void) - setScaleX:
 对字幕设置水平缩放系数 更多...
 
(float) - getScaleX
 获取字幕水平缩放系数 更多...
 
(void) - setScaleY:
 对字幕设置垂直缩放系数 更多...
 
(float) - getScaleY
 获取字幕垂直缩放系数 更多...
 
(void) - scaleCaption:anchor:
 缩放字幕 更多...
 
(void) - setRotationZ:
 对字幕设置旋转角度 更多...
 
(float) - getRotationZ
 获取字幕旋转角度 更多...
 
(void) - rotateCaption:anchor:
 旋转字幕 更多...
 
(void) - rotateCaption:
 以字幕中心点为锚点旋转字幕 更多...
 
(void) - setTextFrameOriginRect:
 设置边框字幕的原始边框大小，如果当前字幕不是边框字幕，该函数没有效果. 可以通过getCaptionBoundingVertices中的BOUNDING_TYPE_TEXT_ORIGIN_FRAME获取原始边框大小 更多...
 
(NvsRect) - getTextBoundingRect
 获取字幕文本矩形框 更多...
 
(NSArray *) - getBoundingRectangleVertices
 获取字幕的原始包围矩形框变换后的顶点位置 更多...
 
(NSArray *) - getCaptionBoundingVertices:
 获取字幕原始边框变换后的顶点位置 更多...
 
(void) - setCenterPolarAngle:
 对字幕设置中心点的极角。只对全景图字幕有效 更多...
 
(float) - getCenterPolarAngle
 获取字幕中心点的极角。只对全景图字幕有效 更多...
 
(float) - getTextCenterPolarAngle
 获取字幕文本中心点的极角。只对全景图字幕有效 更多...
 
(void) - setCenterAzimuthAngle:
 对字幕设置中心点的方位角。只对全景图字幕有效 更多...
 
(float) - getCenterAzimuthAngle
 获取字幕中心点的方位角。只对全景图字幕有效 更多...
 
(float) - getTextCenterAzimuthAngle
 获取字幕文本中心点的方位角。只对全景图字幕有效 更多...
 
(void) - setPolarAngleRange:
 对字幕设置极角的张角。只对全景图字幕有效 更多...
 
(float) - getPolarAngleRange
 获取字幕极角的张角。只对全景图字幕有效 更多...
 
(float) - getTextPolarAngleRange
 获取字幕文本极角的张角。只对全景图字幕有效 更多...
 
(float) - getOrthoAngleRange
 获取字幕与极角垂直的张角。只对全景图字幕有效 更多...
 
(float) - getTextOrthoAngleRange
 获取字幕文本与极角垂直的张角。只对全景图字幕有效 更多...
 
(void) - setPanoramicScaleX:
 对字幕设置水平缩放系数。只对全景图字幕有效 更多...
 
(float) - getPanoramicScaleX
 获取字幕水平缩放系数。只对全景图字幕有效 更多...
 
(void) - setPanoramicScaleY:
 对字幕设置垂直缩放系数。只对全景图字幕有效 更多...
 
(float) - getPanoramicScaleY
 获取字幕垂直缩放系数。只对全景图字幕有效 更多...
 
(void) - setPanoramicRotation:
 对字幕设置旋转角度。只对全景图字幕有效 更多...
 
(float) - getPanoramicRotation
 获取字幕旋转角度。只对全景图字幕有效 更多...
 
(void) - setZValue:
 设置字幕Z值 更多...
 
(float) - getZValue
 获取字幕Z值。 更多...
 
(void) - setRecordingUserOperation:
 设置字幕是否记录用户的操作 更多...
 
(void) - setOpacity:
 设置字幕透明度 更多...
 
(float) - getOpacity
 获取字幕透明度 更多...
 
(void) - setBackgroundColor:
 设置字幕文本的背景颜色 更多...
 
(NvsColor) - getBackgroundColor
 获取字幕文本的当前背景颜色值 更多...
 
(void) - setBackgroundRadius:
 设置字幕文本的背景框的圆角半径 更多...
 
(float) - getBackgroundRadius
 获取字幕文本的当前背景框的圆角半径 更多...
 
(void) - setBoundaryPaddingRatio:
 设置字幕边界扩展比率 更多...
 
(float) - getBoundaryPaddingRatio
 获取字幕边界扩展比率 更多...
 
(void) - setSecondaryColor:
 设置字幕第二个颜色, 目前只应用在卡拉OK字幕上 更多...
 
(NvsColor) - getSecondaryColor
 获取字幕字体的当前第二个颜色值 更多...
 
(void) - setSecondaryOutlineColor:
 设置字幕描边的第二个颜色, 目前只应用在卡拉OK字幕上 更多...
 
(NvsColor) - getSecondaryOutlineColor
 获取字幕描边的第二个颜色值 更多...
 
(void) - setCurrentKeyFrameTime:
 设置字幕的关键帧时间 更多...
 
(bool) - setControlPoint:controlPointPair:
 设置字幕的关键帧控制点对 更多...
 
(NvsControlPointPair *) - getControlPoint:
 返回关键帧控制点对 更多...
 
(BOOL) - isFrameCaption
 获取字幕是否是边框字幕 更多...
 
(void) - setTextSpanList:
 用户可以指定字幕中位置从某一起始字符到某一结束字符之间，应用多种layout属性。 更多...
 
(NSArray< NvsCaptionSpan * > *) - getTextSpanList
 获取需要应用多种layout属性 更多...
 
(NvsCaptionTextLayout *) - getTextLayout
 获取字幕layout属性 更多...
 
(int) - getComplexRenderLayerCount
 获取复杂字幕层数。 更多...
 
(BOOL) - hasOutlineLayerInComplexRender:
 判断当前层是否有描边 更多...
 
(NvsColor) - getComplexRenderLayerOutlineColor:
 获取复杂字幕某层字幕描边颜色值。 更多...
 
(BOOL) - setComplexRenderLayerOutlineColor:color:
 设置复杂字幕某层字幕描边颜色值。 更多...
 
(float) - getComplexRenderLayerOutlineWidth:
 获取复杂字幕某层字幕描边宽度。 更多...
 
(BOOL) - setComplexRenderLayerOutlineWidth:width:
 设置复杂字幕某层字幕描边宽度。 更多...
 
(float) - getComplexRenderLayerOpacity:
 获取复杂字幕某层字幕不透明度。 更多...
 
(BOOL) - setComplexRenderLayerOpacity:opacity:
 设置复杂字幕某层字幕不透明度。 更多...
 
- 构造函数 继承自 NvsFx
(void) - setIntVal:val:
 设置特效的整数参数值 更多...
 
(int) - getIntVal:
 获得特效的整数参数值 更多...
 
(void) - setIntValAtTime:val:time:
 设置指定时间点上特效的整数参数值 更多...
 
(int) - getIntValAtTime:time:
 获得指定时间点上特效的整数参数值 更多...
 
(void) - setFloatVal:val:
 设置特效的浮点数参数值 更多...
 
(double) - getFloatVal:
 获得特效浮点数参数值 更多...
 
(void) - setFloatValAtTime:val:time:
 设置指定时间点上特效的浮点数参数值 更多...
 
(double) - getFloatValAtTime:time:
 获得指定时间点上特效浮点数参数值 更多...
 
(void) - setBooleanVal:val:
 设置特效布尔值参数值 更多...
 
(BOOL) - getBooleanVal:
 获得特效的布尔值参数值 更多...
 
(void) - setBooleanValAtTime:val:time:
 设置指点时间点上特效布尔值参数值 更多...
 
(BOOL) - getBooleanValAtTime:time:
 获得特效的布尔值参数值 更多...
 
(void) - setStringVal:val:
 设置特效字符串参数值 更多...
 
(NSString *) - getStringVal:
 获得特效字符串参数值 更多...
 
(void) - setStringValAtTime:val:time:
 设置指定时间点上特效字符串参数值 更多...
 
(NSString *) - getStringValAtTime:time:
 获得指定时间点上特效字符串参数值 更多...
 
(void) - setColorVal:val:
 设置特效颜色值参数值 更多...
 
(NvsColor) - getColorVal:
 获得特效颜色值参数值 更多...
 
(void) - setColorValAtTime:val:time:
 设置特效颜色值参数值 更多...
 
(NvsColor) - getColorValAtTime:time:
 获得特效颜色值参数值 更多...
 
(void) - setPosition2DVal:val:
 设置特效二维坐标参数值 更多...
 
(NvsPosition2D) - getPosition2DVal:
 获得特效二维坐标参数值 更多...
 
(void) - setPosition2DValAtTime:val:time:
 设置特效二维坐标参数值 更多...
 
(NvsPosition2D) - getPosition2DValAtTime:time:
 获得特效二维坐标参数值 更多...
 
(void) - setPosition3DVal:val:
 设置特效三维坐标参数值 更多...
 
(NvsPosition3D) - getPosition3DVal:
 获得特效三维坐标参数值 更多...
 
(void) - setPosition3DValAtTime:val:time:
 设置特效三维坐标参数值 更多...
 
(NvsPosition3D) - getPosition3DValAtTime:time:
 获得特效三维坐标参数值 更多...
 
(void) - setMenuVal:val:
 设置特效菜单参数值 更多...
 
(NSString *) - getMenuVal:
 获得特效菜单参数值 更多...
 
(void) - setMenuValAtTime:val:time:
 设置特效菜单参数值 更多...
 
(NSString *) - getMenuValAtTime:time:
 获得特效菜单参数值 更多...
 
(void) - setArbDataVal:val:
 设置自定义数据参数值 更多...
 
(NvsArbitraryData *) - getArbDataVal:
 返回自定义数据参数值 更多...
 
(void) - setArbDataValAtTime:val:time:
 设置自定义数据参数值 更多...
 
(NvsArbitraryData *) - getArbDataValAtTime:time:
 返回自定义数据参数值 更多...
 
(bool) - removeKeyframeAtTime:time:
 删除参数指定时间点的关键帧 更多...
 
(bool) - removeAllKeyframe:
 删除参数的所有关键帧 更多...
 
(bool) - hasKeyframeList:
 当前参数是否有关键帧列表 更多...
 
(int64_t) - findKeyframeTime:time:flags:
 获取指定时间点附近的关键帧 更多...
 
(bool) - setKeyFrameControlPoint:time:controlPointPair:
 设置关键帧控制点对 更多...
 
(NvsControlPointPair *) - getKeyFrameControlPoint:time:
 返回关键帧控制点对 更多...
 
(bool) - setKeyFrameControlPointMode:time:controlPointModePair:
 设置关键帧控制点对 更多...
 
(NvsControlPointModePair *) - getKeyFrameControlPointMode:time:
 返回关键帧控制点模式对 更多...
 
(void) - setFilterIntensity:
 设置滤镜的强度 更多...
 
(float) - getFilterIntensity
 获得滤镜的强度 更多...
 
(void) - setFilterMask:
 设置滤镜遮罩 更多...
 
(bool) - getFilterMask
 获得是否使用滤镜遮罩 更多...
 
(void) - setRegional:
 设置滤镜是否为局部滤镜 更多...
 
(BOOL) - getRegional
 获得滤镜是否为局部滤镜 更多...
 
(void) - setIgnoreBackground:
 设置局部滤镜是否消除背景 更多...
 
(BOOL) - getIgnoreBackground
 获得局部滤镜是否消除背景 更多...
 
(void) - setInverseRegion:
 设置局部滤镜是否反选区域 更多...
 
(BOOL) - getInverseRegion
 获得局部滤镜是否反选区域 更多...
 
(NSArray *) - getRegion
 获取局部滤镜的控制范围 更多...
 
(void) - setRegion:
 设置局部滤镜的控制范围 更多...
 
(NvsMaskRegionInfo *) - getRegionInfo
 获取局部滤镜的蒙版区域信息 更多...
 
(void) - setRegionInfo:
 设置局部滤镜的蒙版区域信息 更多...
 
(void) - setRegionInfoAtTime:time:
 设置指定时间点局部滤镜的蒙版区域信息 更多...
 
(NvsMaskRegionInfo *) - getRegionInfoAtTime:
 获取指定时间点局部滤镜的模板区域信息 更多...
 
(void) - setRegionalFeatherWidth:
 设置局部滤镜的羽化宽度 更多...
 
(float) - getRegionalFeatherWidth
 获得局部滤镜的羽化宽度 更多...
 
(void) - setRegionalFeatherWidthAtTime:time:
 设置指定时间点局部滤镜的羽化宽度 更多...
 
(float) - getRegionalFeatherWidthAtTime:
 获得指定时间点局部滤镜的羽化宽度 更多...
 
(void) - setRegionCoordinateSystemType:
 设置局部滤镜所在坐标系类型，默认为NDC坐标系 更多...
 
(int) - getRegionCoordinateSystemType
 获得局部滤镜所在坐标系类型 更多...
 
(NvsParticleSystemContext *) - getParticleSystemContext
 获得粒子特效上下文指针。请参见NvsParticleSystemContext 更多...
 
(NvsARFaceContext *) - getARFaceContext
 获得人脸特效上下文指针。请参见NvsARFaceContext 更多...
 
(NvsPaintingEffectContext *) - getPaintingEffectContext
 获得手绘特效上下文指针。请参见NvsPaintingEffectContext 更多...
 
(NvsARSceneManipulate *) - getARSceneManipulate
 获得AR场景操作指针。请参见NvsARSceneManipulate 更多...
 
(void) - setExprVar:varValue:
 设置表达式中定义参数的值 更多...
 
(double) - getExprVar:
 获得表达式中定义参数的值 更多...
 
(void) - setColorExprVar:varValue:
 设置颜色类型表达式中定义参数的值 更多...
 
(NvsColor) - getColorExprVar:
 获得颜色表达式中定义参数的值 更多...
 
(void) - clearExprVar:
 清空表达式中定义参数的值，并设置为默认值0 更多...
 
(void) - clearExprVarCtx
 清空表达式中定义的全部参数的值，并设置为默认值0 更多...
 
- 构造函数 继承自 NvsObject
(void) - setAttachment:forKey:
 给NvsObject对象添加附件，用来标识NvsObject的对象或者用于其他用途 更多...
 
(void) - setTemplateAttachment:forKey:
 为NvsObject对象添加模板资源的附加数据，用来标识NvsObject的模板数据 更多...
 
(NSObject *) - getAttachment:
 获取已经添加的附件 更多...
 
(NSString *) - getTemplateAttachment:
 获取NvsObject的模板资源附件 更多...
 

属性

BOOL isPanoramic
 是否为全景图字幕 更多...
 
BOOL isModular
 当前字幕是否为模块字幕 更多...
 
NvsRoleInTheme roleInTheme
 字幕在主题中的角色(通用、片头、片尾) 更多...
 
NvsCategory category
 片段类型 更多...
 
NSString * captionStylePackageId
 字幕样式包裹ID 更多...
 
NSString * modularCaptionContextPackageId
 模块字幕环境样式包裹ID 更多...
 
NSString * modularCaptionRendererPackageId
 模块字幕渲染样式包裹ID 更多...
 
NSString * modularCaptionAnimationPackageId
 模块字幕循环动画样式包裹ID 更多...
 
NSString * modularCaptionInAnimationPackageId
 模块字幕入动画样式包裹ID 更多...
 
NSString * modularCaptionOutAnimationPackageId
 模块字幕出动画样式包裹ID 更多...
 
- 属性 继承自 NvsFx
NvsFxDescription * description
 特效描述 更多...
 

详细描述

时间线字幕

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

警告

函数文档

◆ applyCaptionStyle:

- (bool) applyCaptionStyle: (NSString *)  captionStylePackageId

运用字幕样式

参数
captionStylePackageId字幕样式资源包ID
返回
返回bool值。true表示成功运用字幕样式，false则运用失败
警告
此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题。

◆ applyCaptionStyleWithAssetDefaultParam:isUseDefaultAssetParam:

- (bool) applyCaptionStyleWithAssetDefaultParam: (NSString *)  captionStylePackageId
isUseDefaultAssetParam: (NvsAssetDefaultParam)  isUseDefaultAssetParam 

运用字幕样式

参数
captionStylePackageId字幕样式资源包ID
isUseDefaultAssetParam是否使用默认素材参数
返回
返回bool值。true表示成功运用字幕样式，false则运用失败
警告
此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题。

◆ applyModularCaptionAnimation:

- (bool) applyModularCaptionAnimation: (NSString *)  captionAnimationPackageId

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

参数
captionAnimationPackageId字幕循环动画样式资源包ID
返回
返回boolean值。true表示成功运用，false则运用失败
警告
此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题
参见
getModularCaptionAnimationPackageId
自从
2.15.2

◆ applyModularCaptionContext:

- (bool) applyModularCaptionContext: (NSString *)  captionContextPackageId

运用模块字幕环境样式包

参数
captionContextPackageId字幕环境样式资源包ID
返回
返回boolean值。true表示成功运用，false则运用失败
警告
此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题
参见
getModularCaptionContextPackageId
自从
2.15.2

◆ applyModularCaptionInAnimation:

- (bool) applyModularCaptionInAnimation: (NSString *)  captionInAnimationPackageId

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

参数
captionInAnimationPackageId字幕入动画样式资源包ID
返回
返回boolean值。true表示成功运用，false则运用失败
警告
此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题
参见
getModularCaptionInAnimationPackageId
自从
2.15.2

◆ applyModularCaptionOutAnimation:

- (bool) applyModularCaptionOutAnimation: (NSString *)  captionOutAnimationPackageId

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

参数
captionOutAnimationPackageId字幕出动画样式资源包ID
返回
返回boolean值。true表示成功运用，false则运用失败
警告
此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题
参见
getModularCaptionOutAnimationPackageId
自从
2.15.2

◆ applyModularCaptionRenderer:

- (bool) applyModularCaptionRenderer: (NSString *)  captionRendererPackageId

运用模块字幕渲染样式包

参数
captionRendererPackageId字幕渲染样式资源包ID
返回
返回boolean值。true表示成功运用，false则运用失败
警告
此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题
参见
getModularCaptionRenderPackageId
自从
2.15.2

◆ getAnchorPoint

- (CGPoint) getAnchorPoint

获取字幕锚点

返回
返回字幕锚点
自从
1.15.0
参见
- setAnchorPoint:

◆ getBackgroundColor

- (NvsColor) getBackgroundColor

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

返回
返回NvsColor对象，表示当前的文本背景颜色值
参见
- setBackgroundColor:
自从
2.15.1

◆ getBackgroundRadius

- (float) getBackgroundRadius

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

返回
返回圆角半径值
参见
- setBackgroundRadius:
自从
2.15.1

◆ getBold

- (BOOL) getBold

获取字幕字体加粗状态

返回
返回字幕字体加粗状态，YES表示字体已加粗，NO则字体未加粗。
参见
- setBold:

◆ getBoundaryPaddingRatio

- (float) getBoundaryPaddingRatio

获取字幕边界扩展比率

返回
扩展比率
参见
setBoundaryPaddingRatio

◆ getBoundingRectangleVertices

- (NSArray *) getBoundingRectangleVertices

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

返回
返回NSArray对象，里面的对象类型为NSValue，而实际包含的数据类型为CGPoint，包含四个顶点位置，依次分别对应原始包围矩形框的左上，左下，右下，右上顶点
自从
1.8.1

◆ getCaptionBoundingVertices:

- (NSArray *) getCaptionBoundingVertices: (NvsBoundingType)  boundingType

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

参数
boundingType边框类型。请参见[边框类型] Bounding Type
返回
返回NSArray对象，里面的对象类型为NSValue，而实际包含的数据类型为CGPoint，包含四个顶点位置，依次分别对应原始边框的左上，左下，右下，右上顶点
自从
2.9.0

◆ getCaptionTranslation

- (CGPoint) getCaptionTranslation

获取字幕的平移量

返回
返回CGPoint对象，表示获得的字幕平移量
参见
- setCaptionTranslation:

◆ getCenterAzimuthAngle

- (float) getCenterAzimuthAngle

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

返回
返回字幕中心点的方位角，单位为角度
注意: 注意：3.13.0以后默认不开启全景功能
自从
1.6.0

◆ getCenterPolarAngle

- (float) getCenterPolarAngle

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

返回
返回字幕中心点的极角，单位为角度
注意: 注意：3.13.0以后默认不开启全景功能
自从
1.6.0

◆ getComplexRenderLayerCount

- (int) getComplexRenderLayerCount

获取复杂字幕层数。

返回
字幕层数。

◆ getComplexRenderLayerOpacity:

- (float) getComplexRenderLayerOpacity: (int)  layerIndex

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

参数
layerIndex字幕层数
返回
不透明度。

◆ getComplexRenderLayerOutlineColor:

- (NvsColor) getComplexRenderLayerOutlineColor: (int)  layerIndex

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

参数
layerIndex字幕层数
返回
描边颜色值。

◆ getComplexRenderLayerOutlineWidth:

- (float) getComplexRenderLayerOutlineWidth: (int)  layerIndex

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

参数
layerIndex字幕层数
返回
描边宽度。

◆ getControlPoint:

- (NvsControlPointPair*) getControlPoint: (NSString *)  fxParam

返回关键帧控制点对

参数
fxParam字幕参数的类型
返回
返回获得的控制点信息, 如果控制点为{0, 0}说明当前控制点插值方式为线性插值
参见
setControlPoint: controlPointPair
自从
2.22.0

◆ getDrawOutline

- (BOOL) getDrawOutline

获取字幕描边状态

返回
返回BOOL值，YES表示已描边，NO则未描边
参见
- setDrawOutline:

◆ getDrawShadow

- (BOOL) getDrawShadow

获取当前字幕阴影状态

返回
返回BOOL值，YES表示有字幕阴影，NO则没有字幕阴影
参见
- setDrawShadow:

◆ getFontFamily

- (NSString *) getFontFamily

获取字幕字体

自从
2.13.3
参见
setFontFamily

◆ getFontFilePath

- (NSString *) getFontFilePath

获取字幕字体的文件路径

返回
返回字幕字体的文件路径
自从
1.3.0
参见
- setFontWithFilePath:

◆ getFontSize

- (float) getFontSize

获取当前字幕的字体大小

返回
返回获得的字幕字体大小值
参见
- setFontSize:

◆ getItalic

- (BOOL) getItalic

获取字幕斜体状态

返回
返回BOOL值，YES表示是斜体字体，NO则不是斜体
参见
- setItalic:

◆ getLetterSpacing

- (float) getLetterSpacing

获取字幕字间距

返回
返回float值，类型默认百分比值。(LETTER_SPACING_TYPE)
参见
setLetterSpacing
setLetterSpacingType
自从
1.16.0

◆ getLetterSpacingType

- (NvsLetterSpacingType) getLetterSpacingType

获取字幕字间距类型

返回
返回字间距类型 (LETTER_SPACING_TYPE)
参见
setLetterSpacingType
自从
2.15.1

◆ getLineSpacing

- (float) getLineSpacing

获取字幕行间距

返回
返回float值， 行间距，绝对值
参见
setLineSpacing
自从
2.15.1

◆ getModularCaptionAnimationPeroid

- (int) getModularCaptionAnimationPeroid

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

返回
返回模块字幕的动画周期，注意：单位是毫秒
参见
setModularCaptionAnimationPeroid
自从
2.15.2

◆ getModularCaptionInAnimationDuration

- (int) getModularCaptionInAnimationDuration

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

返回
返回模块字幕入动画的时长，注意：单位是毫秒
参见
setModularCaptionInAnimationDuration
自从
2.15.2

◆ getModularCaptionOutAnimationDuration

- (int) getModularCaptionOutAnimationDuration

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

返回
返回模块字幕出动画的时长，注意：单位是毫秒
参见
setModularCaptionOutAnimationDuration
自从
2.15.2

◆ getOpacity

- (float) getOpacity

获取字幕透明度

返回
返回字幕透明度
参见
- setOpacity:

◆ getOrthoAngleRange

- (float) getOrthoAngleRange

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

返回
返回字幕与极角垂直的张角，单位为角度
注意: 注意：3.13.0以后默认不开启全景功能
自从
1.7.0

◆ getOutlineColor

- (NvsColor) getOutlineColor

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

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

◆ getOutlineWidth

- (float) getOutlineWidth

获取当前字幕描边的宽度

返回
返回获得的字幕描边的宽度值
参见
- setOutlineWidth:

◆ getPanoramicRotation

- (float) getPanoramicRotation

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

返回
返回字幕旋转角度
注意: 注意：3.13.0以后默认不开启全景功能
自从
1.7.1

◆ getPanoramicScaleX

- (float) getPanoramicScaleX

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

返回
返回字幕水平缩放系数
注意: 注意：3.13.0以后默认不开启全景功能
自从
1.6.0

◆ getPanoramicScaleY

- (float) getPanoramicScaleY

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

返回
返回字幕垂直缩放系数
注意: 注意：3.13.0以后默认不开启全景功能
自从
1.6.0

◆ getPolarAngleRange

- (float) getPolarAngleRange

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

返回
返回字幕极角的张角，单位为角度
注意: 注意：3.13.0以后默认不开启全景功能
自从
1.6.0

◆ getRotationZ

- (float) getRotationZ

获取字幕旋转角度

返回
返回字幕旋转角度
自从
1.14.1
参见
- setRotationZ:

◆ getScaleX

- (float) getScaleX

获取字幕水平缩放系数

返回
返回字幕水平缩放系数
自从
1.14.1
参见
- setScaleX:
- getScaleY

◆ getScaleY

- (float) getScaleY

获取字幕垂直缩放系数

返回
返回字幕垂直缩放系数
自从
1.14.1
参见
- setScaleY:
- getScaleX

◆ getSecondaryColor

- (NvsColor) getSecondaryColor

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

返回
返回NvsColor对象，表示获得的颜色值
参见
setSecondaryColor
自从
2.19.0

◆ getSecondaryOutlineColor

- (NvsColor) getSecondaryOutlineColor

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

返回
返回NvsColor对象，表示获得的颜色值
参见
setSecondaryOutlineColor
自从
3.1.0

◆ getShadowColor

- (NvsColor) getShadowColor

获取当前字幕阴影的颜色

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

◆ getShadowFeather

- (float) getShadowFeather

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

返回
返回羽化程度
参见
setShadowFeather

◆ getShadowOffset

- (CGPoint) getShadowOffset

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

返回
返回CGPoint对象，表示获得的字幕阴影偏移量
参见
- setShadowOffset:

◆ getText

- (NSString *) getText

获取字幕文本

返回
返回获取的字幕文本
参见
- setText:

◆ getTextAlignment

- (NvsTextAlignment) getTextAlignment

获取字幕水平对齐方式

返回
返回字幕水平对齐方式
参见
- setTextAlignment:

◆ getTextBoundingRect

- (NvsRect) getTextBoundingRect

获取字幕文本矩形框

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

◆ getTextCenterAzimuthAngle

- (float) getTextCenterAzimuthAngle

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

返回
返回字幕文本中心点的方位角，单位为角度
注意: 注意：3.13.0以后默认不开启全景功能
自从
2.5.1

◆ getTextCenterPolarAngle

- (float) getTextCenterPolarAngle

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

返回
返回字幕文本中心点的极角，单位为角度
注意: 注意：3.13.0以后默认不开启全景功能
自从
2.5.1

◆ getTextColor

- (NvsColor) getTextColor

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

返回
返回NvsColor对象，表示获得的颜色值
参见
- setTextColor:

◆ getTextLayout

- (NvsCaptionTextLayout *) getTextLayout

获取字幕layout属性

自从
3.6.0

◆ getTextOrthoAngleRange

- (float) getTextOrthoAngleRange

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

返回
返回字幕文本与极角垂直的张角，单位为角度
注意: 注意：3.13.0以后默认不开启全景功能
自从
2.5.1

◆ getTextPolarAngleRange

- (float) getTextPolarAngleRange

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

返回
返回字幕文本极角的张角，单位为角度
注意: 注意：3.13.0以后默认不开启全景功能
自从
2.5.1

◆ getTextSpanList

- (NSArray<NvsCaptionSpan *>*) getTextSpanList

获取需要应用多种layout属性

自从
3.5.0

◆ getTextVerticalAlignment

- (NvsTextAlignment) getTextVerticalAlignment

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

返回
返回字幕垂直对齐方式
参见
- setTextVerticalAlignment:
自从
2.19.1

◆ getUnderline

- (BOOL) getUnderline

获取字幕下划线状态

返回
返回boolean值，true表示是下划线，false则不是下划线
参见
setUnderline

◆ getVerticalLayout

- (BOOL) getVerticalLayout

获取字幕布局状态

返回
返回字幕布局状态，YES表示字幕为竖版布局，NO则水平布局。
参见
- setVerticalLayout:

◆ getWeight

- (int) getWeight

获取字幕权重值

返回
字幕权重值
参见
setWeight

◆ getZValue

- (float) getZValue

获取字幕Z值。

返回
返回字幕Z值。
参见
- setZValue:

◆ hasOutlineLayerInComplexRender:

- (BOOL) hasOutlineLayerInComplexRender: (int)  layerIndex

判断当前层是否有描边

参数
layerIndex字幕层数
返回
描边状态

◆ isFrameCaption

- (BOOL) isFrameCaption

获取字幕是否是边框字幕

返回
字幕是否是边框字幕
自从
2.19.1

◆ resetOutlineColorState

- (void) resetOutlineColorState

重置字幕描边颜色状态

参见
- getOutlineColor

◆ resetTextColorState

- (void) resetTextColorState

重置字幕颜色状态

参见
- getTextColor

◆ rotateCaption:

- (void) rotateCaption: (float)  angle

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

参数
angle字幕旋转的角度
自从
1.8.1
参见
- rotateCaption:anchor:

◆ rotateCaption:anchor:

- (void) rotateCaption: (float)  angle
anchor: (CGPoint)  anchor 

旋转字幕

参数
angle字幕旋转的角度
anchor字幕旋转的锚点
自从
1.8.1
参见
- rotateCaption:

◆ scaleCaption:anchor:

- (void) scaleCaption: (float)  scaleFactor
anchor: (CGPoint)  anchor 

缩放字幕

参数
scaleFactor字幕缩放的因子
anchor字幕缩放的锚点
自从
1.8.1

◆ setAnchorPoint:

- (void) setAnchorPoint: (CGPoint)  anchor

设置字幕锚点

参数
anchor锚点
自从
1.15.0
参见
- getAnchorPoint

◆ setBackgroundColor:

- (void) setBackgroundColor: (const NvsColor *)  backgroundColor

设置字幕文本的背景颜色

参数
backgroundColor文本背景颜色值
参见
- getBackgroundColor:
自从
2.15.1

◆ setBackgroundRadius:

- (void) setBackgroundRadius: (float)  radius

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

参数
radius圆角半径值
参见
- getBackgroundRadius:
自从
2.15.1

◆ setBold:

- (void) setBold: (BOOL)  bold

设置字幕字体是否加粗

参数
bold表示字幕字体是否加粗，YES表示加粗，NO则不加粗。
参见
- getBold

◆ setBoundaryPaddingRatio:

- (void) setBoundaryPaddingRatio: (float)  ratio

设置字幕边界扩展比率

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

◆ setCaptionTranslation:

- (void) setCaptionTranslation: (CGPoint)  translation

设置字幕的平移量

参数
translation字幕平移的水平和垂直的绝对平移值
参见
- getCaptionTranslation
- translateCaption:

◆ setCenterAzimuthAngle:

- (void) setCenterAzimuthAngle: (float)  centerAzimuthAngle

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

参数
centerAzimuthAngle中心点的方位角，单位为角度
注意: 注意：3.13.0以后默认不开启全景功能
自从
1.6.0

◆ setCenterPolarAngle:

- (void) setCenterPolarAngle: (float)  centerPolarAngle

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

参数
centerPolarAngle中心点的极角，单位为角度
注意: 注意：3.13.0以后默认不开启全景功能
自从
1.6.0

◆ setComplexRenderLayerOpacity:opacity:

- (BOOL) setComplexRenderLayerOpacity: (int)  layerIndex
opacity: (float)  opacity 

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

参数
layerIndex字幕层数
opacity不透明度
返回
设置成功与否

◆ setComplexRenderLayerOutlineColor:color:

- (BOOL) setComplexRenderLayerOutlineColor: (int)  layerIndex
color: (NvsColor)  color 

设置复杂字幕某层字幕描边颜色值。

参数
layerIndex字幕层数
color颜色值
返回
设置成功与否。

◆ setComplexRenderLayerOutlineWidth:width:

- (BOOL) setComplexRenderLayerOutlineWidth: (int)  layerIndex
width: (float)  width 

设置复杂字幕某层字幕描边宽度。

参数
layerIndex字幕层数
width描边宽度
返回
设置成功与否

◆ setControlPoint:controlPointPair:

- (bool) setControlPoint: (NSString *)  fxParam
controlPointPair: (NvsControlPointPair *)  controlPointPair 

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

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

◆ setCurrentKeyFrameTime:

- (void) setCurrentKeyFrameTime: (int64_t)  time

设置字幕的关键帧时间

参见
setCurrentKeyFrameTime
自从
2.19.1

◆ setDrawOutline:

- (void) setDrawOutline: (BOOL)  drawOutline

设置字幕是否描边

参数
drawOutline是否对字幕描边。YES表示对字幕进行描边，NO则不描边
参见
- getDrawOutline

◆ setDrawShadow:

- (void) setDrawShadow: (BOOL)  drawShadow

设置字幕阴影

参数
drawShadow是否设置字幕阴影。YES表示设置字幕阴影，NO则不设置
参见
- getDrawShadow

◆ setFontFamily:

- (void) setFontFamily: (NSString *)  family

设置字幕字体

参数
family字体名字，若设为空字符串，则设为默认字体
自从
2.4.2
参见
- getFontFamily

◆ setFontSize:

- (void) setFontSize: (float)  fontSize

设置字幕字体大小

参数
fontSize字幕字体大小值
参见
- getFontSize

◆ setFontWithFilePath:

- (void) setFontWithFilePath: (NSString *)  filePath

设置字幕字体

参数
filePath字幕字体文件路径，若设为空字符串，则设为默认字体
自从
1.3.0
参见
- getFontFilePath

◆ setFrameCaptionMaxFontSize:

- (void) setFrameCaptionMaxFontSize: (float)  maxFontSize

设置边框字幕最大字体大小，只对边框型字幕有效果

自从
2.19.1

◆ setItalic:

- (void) setItalic: (BOOL)  italic

设置字幕字体是否是斜体

参数
italic是否是斜体。YES表示设置字幕字体为斜体，NO则不设为斜体
参见
- getItalic

◆ setLetterSpacing:

- (void) setLetterSpacing: (float)  letterSpacing

设置字幕字间距

参数
letterSpacing字间距，类型默认百分比。(LETTER_SPACING_TYPE)
参见
- getLetterSpacing
setLetterSpacingType
自从
1.16.0

◆ setLetterSpacingType:

- (void) setLetterSpacingType: (NvsLetterSpacingType)  letterSpacingType

设置字幕字间距类型

参数
letterSpacingType字间距类型. (LETTER_SPACING_TYPE)
参见
- getLetterSpacingType
自从
2.15.1

◆ setLineSpacing:

- (void) setLineSpacing: (float)  lineSpacing

设置字幕行间距

参数
lineSpacing行间距，绝对值
参见
- getLineSpacing
自从
2.15.1

◆ setModularCaptionAnimationPeroid:

- (void) setModularCaptionAnimationPeroid: (int)  periodInMS

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

参数
periodInMS周期的时间，注意：单位是毫秒
参见
- getModularCaptionAnimationPeroid
自从
2.15.2

◆ setModularCaptionInAnimationDuration:

- (void) setModularCaptionInAnimationDuration: (int)  inAnimationDurationInMS

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

参数
inAnimationDurationInMS入动画的时长，注意：单位是毫秒
参见
- getModularCaptionInAnimationDuration
自从
2.15.2

◆ setModularCaptionOutAnimationDuration:

- (void) setModularCaptionOutAnimationDuration: (int)  outAnimationDurationInMS

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

参数
outAnimationDurationInMS出动画的时长，注意：单位是毫秒
参见
- getModularCaptionOutAnimationDuration
自从
2.15.2

◆ setOpacity:

- (void) setOpacity: (float)  opacity

设置字幕透明度

参数
value字幕透明度
参见
- getOpacity

◆ setOutlineColor:

- (void) setOutlineColor: (const NvsColor *)  outlineColor

设置字幕描边的颜色

参数
outlineColor描边颜色值
参见
- getOutlineColor

◆ setOutlineWidth:

- (void) setOutlineWidth: (float)  outlineWidth

设置字幕描边的宽度

参数
outlineWidth描边宽度
参见
- getOutlineWidth

◆ setPanoramicRotation:

- (void) setPanoramicRotation: (float)  rotationAngle

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

参数
rotationAngle旋转角度
注意: 注意：3.13.0以后默认不开启全景功能
自从
1.7.1

◆ setPanoramicScaleX:

- (void) setPanoramicScaleX: (float)  scaleX

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

参数
scaleX水平缩放系数
注意: 注意：3.13.0以后默认不开启全景功能
自从
1.6.0

◆ setPanoramicScaleY:

- (void) setPanoramicScaleY: (float)  scaleY

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

参数
scaleY垂直缩放系数
注意: 注意：3.13.0以后默认不开启全景功能
自从
1.6.0

◆ setPolarAngleRange:

- (void) setPolarAngleRange: (float)  polarAngleRange

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

参数
polarAngleRange极角的张角，单位为角度
注意: 注意：3.13.0以后默认不开启全景功能
自从
1.6.0

◆ setRecordingUserOperation:

- (void) setRecordingUserOperation: (BOOL)  recordingUserOperation

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

参数
recordingUserOperation字幕是否记录用户操作
自从
2.11.0

◆ setRotationZ:

- (void) setRotationZ: (float)  angle

对字幕设置旋转角度

参数
angle旋转角度
自从
1.14.1
参见
- getRotationZ

◆ setScaleX:

- (void) setScaleX: (float)  scale

对字幕设置水平缩放系数

参数
scale水平缩放系数
自从
1.14.1
参见
- getScaleX
- setScaleY:

◆ setScaleY:

- (void) setScaleY: (float)  scale

对字幕设置垂直缩放系数

参数
scale垂直缩放系数
自从
1.14.1
参见
- getScaleY
- setScaleX:

◆ setSecondaryColor:

- (void) setSecondaryColor: (const NvsColor *)  color

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

参数
color字幕颜色值
参见
- getSecondaryColor
自从
2.19.0

◆ setSecondaryOutlineColor:

- (void) setSecondaryOutlineColor: (const NvsColor *)  color

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

参数
color字幕描边颜色值
参见
- getSecondaryOutlineColor
自从
3.1.0

◆ setShadowColor:

- (void) setShadowColor: (const NvsColor *)  shadowColor

设置字幕阴影的颜色

参数
shadowColor字幕阴影颜色值
参见
- getShadowColor

◆ setShadowFeather:

- (void) setShadowFeather: (float)  feather

设置字幕阴影的羽化程度

参数
feather羽化程度
参见
- getShadowFeather

◆ setShadowOffset:

- (void) setShadowOffset: (CGPoint)  shadowOffset

设置字幕阴影的偏移量

参数
shadowOffset字幕阴影的偏移量
参见
- getShadowOffset

◆ setText:

- (void) setText: (NSString *)  text

设置字幕文本

参数
text字幕文本
参见
- getText

◆ setTextAlignment:

- (void) setTextAlignment: (NvsTextAlignment)  textAlign

设置字幕水平对齐方式

参数
textAlign字幕水平对齐方式
参见
- getTextAlignment
setTextVerticalAlignment

◆ setTextColor:

- (void) setTextColor: (const NvsColor *)  textColor

设置字幕文本颜色

参数
textColor字幕文本颜色值
参见
- getTextColor

◆ setTextFrameOriginRect:

- (void) setTextFrameOriginRect: (NvsRect)  rc

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

参数
rc新的边框大小
参见
getCaptionBoundingVertices
自从
2.19.0

◆ setTextSpanList:

- (void) setTextSpanList: (NSArray< NvsCaptionSpan * > *)  storyboardCaptionSpanList

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

返回
是否成功设置。
自从
3.5.0

◆ setTextVerticalAlignment:

- (void) setTextVerticalAlignment: (NvsTextAlignment)  textVerticalAlign

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

参数
textVerticalAlign字幕垂直对齐方式
参见
- getTextVerticalAlignment
setTextAlignment
自从
2.19.1

◆ setUnderline:

- (void) setUnderline: (BOOL)  underline

设置字幕下划线

参数
underline是否设置下划线
参见
- getUnderline

◆ setVerticalLayout:

- (void) setVerticalLayout: (BOOL)  verticalLayout

设置字幕是否为竖版布局

参数
verticalLayout表示字幕是否为竖版布局，YES表示是竖版布局，NO则为水平布局。
参见
- getVerticalLayout

◆ setWeight:

- (void) setWeight: (int)  weight

设置字幕权重

参数
weightopentype中的权重值
参见
- getWeight

◆ setZValue:

- (void) setZValue: (float)  value

设置字幕Z值

参数
value字幕Z值
参见
- getZValue

◆ translateCaption:

- (void) translateCaption: (CGPoint)  translationOffset

平移字幕

参数
translationOffset字幕平移的水平和垂直的偏移值
自从
1.7.0
参见
- setCaptionTranslation:
- getCaptionTranslation

属性说明

◆ captionStylePackageId

- (NSString*) captionStylePackageId
readatomicassign

字幕样式包裹ID

自从
2.17.1

◆ category

- (NvsCategory) category
readatomicassign

片段类型

◆ isModular

- (BOOL) isModular
readatomicassign

当前字幕是否为模块字幕

自从
2.15.2

◆ isPanoramic

- (BOOL) isPanoramic
readatomicassign

是否为全景图字幕

自从
1.6.0

◆ modularCaptionAnimationPackageId

- (NSString*) modularCaptionAnimationPackageId
readatomicassign

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

自从
2.15.2

◆ modularCaptionContextPackageId

- (NSString*) modularCaptionContextPackageId
readatomicassign

模块字幕环境样式包裹ID

自从
2.15.2

◆ modularCaptionInAnimationPackageId

- (NSString*) modularCaptionInAnimationPackageId
readatomicassign

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

自从
2.15.2

◆ modularCaptionOutAnimationPackageId

- (NSString*) modularCaptionOutAnimationPackageId
readatomicassign

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

自从
2.15.2

◆ modularCaptionRendererPackageId

- (NSString*) modularCaptionRendererPackageId
readatomicassign

模块字幕渲染样式包裹ID

自从
2.15.2

◆ roleInTheme

- (NvsRoleInTheme) roleInTheme
readatomicassign

字幕在主题中的角色(通用、片头、片尾)

该类的文档由以下文件生成:
制作者   doxygen 1.8.18