NvsTimelineCaption类 参考

时间线字幕 更多...

#import <NvsTimelineCaption.h>

类 NvsTimelineCaption 继承关系图:

构造函数
(int64_t)	- changeInPoint:
	改变字幕在时间线上显示的入点 更多...
(int64_t)	- changeOutPoint:
	改变字幕在时间线上显示的出点 更多...
(void)	- movePosition:
	改变字幕在时间线上的显示位置(入点和出点同时偏移offset值) 更多...
构造函数 继承自 NvsCaption
(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	clipAffinityEnabled
	是否开启与clip的亲和关系 更多...
int64_t	inPoint
	字幕在时间线上显示的入点（单位微秒） 更多...
int64_t	outPoint
	字幕在时间线显示上的出点（单位微秒） 更多...
属性 继承自 NvsCaption
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
	特效描述 更多...

详细描述

时间线字幕

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

警告

NvsTimelineCaption类中，所有public API都在UI线程使用！！！

函数文档

changeInPoint:

- (int64_t) changeInPoint:

(int64_t)

newInPoint

改变字幕在时间线上显示的入点

参数

newInPoint

字幕在时间线上的新的入点（单位微秒）

返回

返回字幕在时间线上的显示的入点值（单位微秒）

警告

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

参见

- changeOutPoint:

- movePosition:

changeOutPoint:

- (int64_t) changeOutPoint:

(int64_t)

newOutPoint

改变字幕在时间线上显示的出点

参数

newOutPoint

字幕在时间线上的新的出点（单位微秒）

返回

返回字幕在时间线上显示的出点值（单位微秒）

警告

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

参见

- changeInPoint:

- movePosition:

movePosition:

- (void) movePosition:

(int64_t)

offset

改变字幕在时间线上的显示位置(入点和出点同时偏移offset值)

参数

offset

偏移值（单位微秒）

警告

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

参见

- changeInPoint:

- changeOutPoint:

属性说明

clipAffinityEnabled

- (BOOL) clipAffinityEnabled

readwritenonatomicassign

是否开启与clip的亲和关系

自从

1.7.1

inPoint

- (int64_t) inPoint

readatomicassign

字幕在时间线上显示的入点（单位微秒）

outPoint

- (int64_t) outPoint

readatomicassign

字幕在时间线显示上的出点（单位微秒）

---

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

• include/sdkcore/ios/NvsTimelineCaption.h