#import <NvsVideoEffectCaption.h>

类 NvsVideoEffectCaption 继承关系图:

构造函数
(void)	- setVideoResolution:
	设置字幕渲染的画幅解析度更多...

(int64_t)	- changeInPoint:
	改变字幕在时间线上显示的入点更多...

(int64_t)	- changeOutPoint:
	改变字幕在时间线上显示的出点更多...

(void)	- movePosition:
	改变字幕在时间线上的显示位置(入点和出点同时偏移offset值) 更多...

(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:
	设置字幕水平对齐方式更多...

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

(void)	- setTextVerticalAlignment:
	设置字幕垂直对齐方式更多...

(NvsVideoEffectTextAlignment)	- getTextVerticalAlignment
	获取字幕垂直对齐方式更多...

(void)	- setBold:
	设置字幕字体是否加粗更多...

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

(void)	- setWeight:
	设置字幕权重更多...

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

(void)	- setItalic:
	设置字幕字体是否是斜体更多...

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

(void)	- setUnderline:
	设置字幕下划线更多...

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

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

(void)	- setLetterSpacing:
	设置字幕字间距更多...

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

(void)	- setLetterSpacingType:
	设置字幕字间距类型更多...

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

(void)	- setLineSpacing:
	设置字幕行间距更多...

(void)	- setTextColor:
	设置字幕文本颜色更多...

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

(void)	- setDrawOutline:
	设置字幕是否描边更多...

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

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

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

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

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

(void)	- setDrawShadow:
	设置字幕阴影更多...

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

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

(NvsEffectColor)	- 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获取原始边框大小更多...

(NvsEffectRect)	- getTextBoundingRect:
	获取字幕文本矩形框更多...

(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:
	设置字幕文本的背景颜色更多...

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

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

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

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

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

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

(BOOL)	- isFrameCaption
	获取字幕是否是边框字幕更多...

构造函数继承自 NvsEffect
(void)	- setIntVal:val:
	设置特效参数整数值更多...

(int)	- getIntVal:
	获得特效参数整数值更多...

(void)	- setFloatVal:val:
	设置特效参数浮点值更多...

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

(void)	- setBooleanVal:val:
	设置特效参数布尔值更多...

(BOOL)	- getBooleanVal:
	获得特效参数布尔值更多...

(void)	- setStringVal:val:
	设置特效参数字符串值更多...

(NSString *)	- getStringVal:
	获得特效参数字符串值更多...

(void)	- setColorVal:val:
	设置特效参数颜色值更多...

(NvsEffectColor)	- getColorVal:
	获得特效参数颜色值更多...

(void)	- setPosition2DVal:val:
	设置特效参数二维坐标更多...

(NvsEffectPosition2D)	- getPosition2DVal:
	获得特效参数二维坐标更多...

(void)	- setPosition3DVal:val:
	设置特效参数三维坐标更多...

(NvsEffectPosition3D)	- getPosition3DVal:
	获得特效参数三维坐标更多...

(void)	- setMenuVal:val:
	设置特效参数菜单值更多...

(NSString *)	- getMenuVal:
	获得特效参数菜单值更多...

(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
	获得局部滤镜是否反选区域更多...

(void)	- setRegion:
	设置局部滤镜的控制范围更多...

(NSArray *)	- getRegion
	获取局部滤镜的控制范围更多...

(NvsMaskRegionInfo *)	- getRegionInfo
	获取局部滤镜的控制范围更多...

(void)	- setRegionInfo:
	设置局部滤镜的控制范围更多...

(void)	- setRegionInfoAtTime:time:
	设置某时刻局部滤镜的控制范围更多...

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

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

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

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

(NvsParticleSystemContext *)	- getParticleSystemContext
	获得粒子特效上下文更多...

(NvsPaintingEffectContext *)	- getPaintingEffectContext
	获得手绘特效上下文更多...

(NvsARSceneManipulate *)	- getARSceneManipulate
	获得AR场景操作指针更多...

(void)	- setExprVar:varValue:
	设置表达式中定义参数的值更多...

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

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

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

属性
BOOL	isPanoramic
	是否为全景图字幕更多...

BOOL	isModular
	当前字幕是否为模块字幕更多...

BOOL	clipAffinityEnabled
	是否开启与clip的亲和关系更多...

int64_t	inPoint
	字幕在时间线上显示的入点（单位微秒）更多...

int64_t	outPoint
	字幕在时间线显示上的出点（单位微秒）更多...

NvsVideoEffectRoleInTheme	roleInTheme
	字幕在主题中的角色(通用、片头、片尾) 更多...

NvsVideoEffectCategory	category
	片段类型更多...

NSString *	captionStylePackageId
	字幕样式包裹ID 更多...

NSString *	modularCaptionContextPackageId
	模块字幕环境样式包裹ID 更多...

NSString *	modularCaptionRendererPackageId
	模块字幕渲染样式包裹ID 更多...

NSString *	modularCaptionAnimationPackageId
	模块字幕循环动画样式包裹ID 更多...

NSString *	modularCaptionInAnimationPackageId
	模块字幕入动画样式包裹ID 更多...

NSString *	modularCaptionOutAnimationPackageId
	模块字幕出动画样式包裹ID 更多...

属性继承自 NvsEffect
NvsEffectDescription *	description
	特效描述更多...

详细描述

字幕

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

警告

自从: 2.20.0

函数文档

◆ applyCaptionStyle:

- (bool) applyCaptionStyle: (NSString *) captionStylePackageId

运用字幕样式

参数

captionStylePackageId 字幕样式资源包ID

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

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

◆ applyCaptionStyleWithAssetDefaultParam:isUseDefaultAssetParam:

- (bool) applyCaptionStyleWithAssetDefaultParam:	(NSString *)	captionStylePackageId
isUseDefaultAssetParam:	(NvsVideoEffectAssetDefaultParam)	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

◆ changeInPoint:

- (int64_t) changeInPoint: (int64_t) newInPoint

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

参数

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

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

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

参见: - changeOutPoint:; - movePosition:

◆ changeOutPoint:

- (int64_t) changeOutPoint: (int64_t) newOutPoint

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

参数

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

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

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

参见: - changeInPoint:; - movePosition:

◆ getAnchorPoint

- (CGPoint) getAnchorPoint

获取字幕锚点

返回: 返回字幕锚点

自从: 1.15.0

参见: - setAnchorPoint:

◆ getBackgroundColor

- (NvsEffectColor) getBackgroundColor

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

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

参见: - setBackgroundColor:

自从: 2.15.1

◆ getBackgroundRadius

- (float) getBackgroundRadius

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

返回: 返回圆角半径值

参见: - setBackgroundRadius:

自从: 2.15.1

◆ getBold

- (BOOL) getBold

获取字幕字体加粗状态

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

参见: - setBold:

◆ getCaptionBoundingVertices:

- (NSArray *) getCaptionBoundingVertices: (NvsVideoEffectBoundingType) boundingType

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

参数

boundingType 边框类型。请参见[边框类型] Bounding Type

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

自从: 2.9.0

◆ getCaptionTranslation

- (CGPoint) getCaptionTranslation

获取字幕的平移量

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

参见: - setCaptionTranslation:

◆ getCenterAzimuthAngle

- (float) getCenterAzimuthAngle

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

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

自从: 1.6.0

◆ getCenterPolarAngle

- (float) getCenterPolarAngle

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

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

自从: 1.6.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

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

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

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

自从: 1.7.0

◆ getOutlineColor

- (NvsEffectColor) getOutlineColor

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

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

参见: - setOutlineColor:

◆ getOutlineWidth

- (float) getOutlineWidth

获取当前字幕描边的宽度

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

参见: - setOutlineWidth:

◆ getPanoramicRotation

- (float) getPanoramicRotation

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

返回: 返回字幕旋转角度

自从: 01.7.1

◆ getPanoramicScaleX

- (float) getPanoramicScaleX

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

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

自从: 1.6.0

◆ getPanoramicScaleY

- (float) getPanoramicScaleY

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

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

自从: 1.6.0

◆ getPolarAngleRange

- (float) getPolarAngleRange

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

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

自从: 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

- (NvsEffectColor) getSecondaryColor

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

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

参见: setSecondaryColor

自从: 2.19.0

◆ getShadowColor

- (NvsEffectColor) getShadowColor

获取当前字幕阴影的颜色

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

参见: - setShadowColor:

◆ getShadowFeather

- (float) getShadowFeather

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

返回: 返回羽化程度

参见: setShadowFeather

◆ getShadowOffset

- (CGPoint) getShadowOffset

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

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

参见: - setShadowOffset:

◆ getText

- (NSString *) getText

获取字幕文本

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

参见: - setText:

◆ getTextAlignment

- (NvsVideoEffectTextAlignment) getTextAlignment

获取字幕水平对齐方式

返回: 返回字幕水平对齐方式

参见: - setTextAlignment:

◆ getTextBoundingRect:

- (NvsEffectRect) getTextBoundingRect: (BOOL) actualBoundingRect

获取字幕文本矩形框

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

◆ getTextCenterAzimuthAngle

- (float) getTextCenterAzimuthAngle

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

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

自从: 2.5.1

◆ getTextCenterPolarAngle

- (float) getTextCenterPolarAngle

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

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

自从: 2.5.1

◆ getTextColor

- (NvsEffectColor) getTextColor

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

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

参见: - setTextColor:

◆ getTextOrthoAngleRange

- (float) getTextOrthoAngleRange

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

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

自从: 2.5.1

◆ getTextPolarAngleRange

- (float) getTextPolarAngleRange

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

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

自从: 2.5.1

◆ getTextVerticalAlignment

- (NvsVideoEffectTextAlignment) 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:

◆ isFrameCaption

- (BOOL) isFrameCaption

获取字幕是否是边框字幕

返回: 字幕是否是边框字幕

自从: 2.19.1

◆ movePosition:

- (void) movePosition: (int64_t) offset

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

参数

offset 偏移值（单位微秒）

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

参见: - changeInPoint:; - changeOutPoint:

◆ 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 NvsEffectColor *) 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

◆ setCaptionTranslation:

- (void) setCaptionTranslation: (CGPoint) translation

设置字幕的平移量

参数

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

参见: - getCaptionTranslation; - translateCaption:

◆ setCenterAzimuthAngle:

- (void) setCenterAzimuthAngle: (float) centerAzimuthAngle

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

参数

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

自从: 1.6.0

◆ setCenterPolarAngle:

- (void) setCenterPolarAngle: (float) centerPolarAngle

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

参数

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

自从: 1.6.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: (NvsVideoEffectLetterSpacingType) 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 NvsEffectColor *) outlineColor

设置字幕描边的颜色

参数

outlineColor 描边颜色值

参见: - getOutlineColor

◆ setOutlineWidth:

- (void) setOutlineWidth: (float) outlineWidth

设置字幕描边的宽度

参数

outlineWidth 描边宽度

参见: - getOutlineWidth

◆ setPanoramicRotation:

- (void) setPanoramicRotation: (float) rotationAngle

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

参数

rotationAngle 旋转角度

自从: 1.7.1

◆ setPanoramicScaleX:

- (void) setPanoramicScaleX: (float) scaleX

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

参数

scaleX 水平缩放系数

自从: 1.6.0

◆ setPanoramicScaleY:

- (void) setPanoramicScaleY: (float) scaleY

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

参数

scaleY 垂直缩放系数

自从: 1.6.0

◆ setPolarAngleRange:

- (void) setPolarAngleRange: (float) polarAngleRange

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

参数

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

自从: 1.6.0

◆ setRecordingUserOperation:

- (void) setRecordingUserOperation: (BOOL) recordingUserOperation

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

参数

recordingUserOperation 字幕是否记录用户操作

自从: 02.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 NvsEffectColor *) color

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

参数

color 字幕颜色值

参见: - getSecondaryColor

自从: 2.19.0

◆ setShadowColor:

- (void) setShadowColor: (const NvsEffectColor *) 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: (NvsVideoEffectTextAlignment) textAlign

设置字幕水平对齐方式

参数

textAlign 字幕水平对齐方式

参见: - getTextAlignment; setTextVerticalAlignment

◆ setTextColor:

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

设置字幕文本颜色

参数

textColor 字幕文本颜色值

参见: - getTextColor

◆ setTextFrameOriginRect:

- (void) setTextFrameOriginRect: (NvsEffectRect) rc

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

参数

rc 新的边框大小

参见: getCaptionBoundingVertices

自从: 2.19.0

◆ setTextVerticalAlignment:

- (void) setTextVerticalAlignment: (NvsVideoEffectTextAlignment) textVerticalAlign

设置字幕垂直对齐方式

参数

textVerticalAlign 字幕垂直对齐方式

参见: - getTextVerticalAlignment; setTextAlignment

自从: 2.19.1

◆ setUnderline:

- (void) setUnderline: (BOOL) underline

设置字幕下划线

参数

underline 是否设置下划线

参见: - getUnderline

◆ setVerticalLayout:

- (void) setVerticalLayout: (BOOL) verticalLayout

设置字幕是否为竖版布局

参数

verticalLayout 表示字幕是否为竖版布局，YES表示是竖版布局，NO则为水平布局。

参见: - getVerticalLayout

◆ setVideoResolution:

- (void) setVideoResolution: (NvsEffectVideoResolution) resolution

设置字幕渲染的画幅解析度

参数

resolution 画幅解析度

自从: 2.20.0

◆ setWeight:

- (void) setWeight: (int) weight

设置字幕权重

参数

weight opentype中的权重值

参见: - 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

- (NvsVideoEffectCategory) category

readatomicassign

片段类型

◆ clipAffinityEnabled

- (BOOL) clipAffinityEnabled

readwritenonatomicassign

是否开启与clip的亲和关系

自从: 1.7.1

◆ inPoint

- (int64_t) inPoint

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

◆ outPoint

- (int64_t) outPoint

readatomicassign

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

◆ roleInTheme

- (NvsVideoEffectRoleInTheme) roleInTheme

readatomicassign

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

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

include/sdkcore/ios/NvsVideoEffectCaption.h

构造函数

属性

详细描述

函数文档

◆ applyCaptionStyle:

◆ applyCaptionStyleWithAssetDefaultParam:isUseDefaultAssetParam:

◆ applyModularCaptionAnimation:

◆ applyModularCaptionContext:

◆ applyModularCaptionInAnimation:

◆ applyModularCaptionOutAnimation:

◆ applyModularCaptionRenderer:

◆ changeInPoint:

◆ changeOutPoint:

◆ getAnchorPoint

◆ getBackgroundColor

◆ getBackgroundRadius

◆ getBold

◆ getCaptionBoundingVertices:

◆ getCaptionTranslation

◆ getCenterAzimuthAngle

◆ getCenterPolarAngle

◆ getDrawOutline

◆ getDrawShadow

◆ getFontFamily

◆ getFontFilePath

◆ getFontSize

◆ getItalic

◆ getLetterSpacing

◆ getLetterSpacingType

◆ getLineSpacing

◆ getModularCaptionAnimationPeroid

◆ getModularCaptionInAnimationDuration

◆ getModularCaptionOutAnimationDuration

◆ getOpacity

◆ getOrthoAngleRange

◆ getOutlineColor

◆ getOutlineWidth

◆ getPanoramicRotation

◆ getPanoramicScaleX

◆ getPanoramicScaleY

◆ getPolarAngleRange

◆ getRotationZ

◆ getScaleX

◆ getScaleY

◆ getSecondaryColor

◆ getShadowColor

◆ getShadowFeather

◆ getShadowOffset

◆ getText

◆ getTextAlignment

◆ getTextBoundingRect:

◆ getTextCenterAzimuthAngle

◆ getTextCenterPolarAngle

◆ getTextColor

◆ getTextOrthoAngleRange

◆ getTextPolarAngleRange

◆ getTextVerticalAlignment

◆ getUnderline

◆ getVerticalLayout

◆ getWeight

◆ getZValue

◆ isFrameCaption

◆ movePosition:

◆ rotateCaption:

◆ rotateCaption:anchor:

◆ scaleCaption:anchor:

◆ setAnchorPoint:

◆ setBackgroundColor:

◆ setBackgroundRadius:

◆ setBold:

◆ setCaptionTranslation:

◆ setCenterAzimuthAngle:

◆ setCenterPolarAngle:

◆ setCurrentKeyFrameTime:

◆ setDrawOutline:

◆ setDrawShadow:

◆ setFontFamily:

◆ setFontSize:

◆ setFontWithFilePath:

◆ setFrameCaptionMaxFontSize: