#import <NvsVideoEffectCompoundCaption.h>

类 NvsVideoEffectCompoundCaption 继承关系图:

构造函数
(int64_t)	- changeInPoint:
	改变字幕显示的入点更多...

(int64_t)	- changeOutPoint:
	改变字幕显示的出点更多...

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

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

(NSString *)	- getText:
	获取字幕文本更多...

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

(NSString *)	- getFontFamily:
	获取字幕字体的名字更多...

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

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

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

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

(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)	- rotateCaptionAroundCenter:boundingType:
	绕字幕边框中心旋转更多...

(NSArray *)	- getCaptionBoundingVertices:boundingType:
	获取字幕原始边框变换后的顶点位置更多...

(NSArray *)	- getCompoundBoundingVertices:
	获取复合字幕原始边框变换后的顶点位置更多...

(void)	- setZValue:
	设置字幕Z值更多...

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

(void)	- setOpacity:
	设置字幕透明度更多...

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

(void)	- setVideoResolution:
	设置复合字幕渲染的画幅解析度更多...

构造函数继承自 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 更多...

属性
NSInteger	captionCount
	获取该复合字幕中子字幕的数量更多...

int64_t	inPoint
	字幕显示的入点（单位微秒）更多...

int64_t	outPoint
	字幕显示的出点（单位微秒）更多...

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

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

函数文档

◆ changeInPoint:

- (int64_t) changeInPoint: (int64_t) newInPoint

改变字幕显示的入点

参数

newInPoint 字幕新的入点（单位微秒）

返回: 返回字幕显示的入点（单位微秒）

参见: changeOutPoint; getInPoint; movePosition

◆ changeOutPoint:

- (int64_t) changeOutPoint: (int64_t) newOutPoint

改变字幕显示的出点

参数

newOutPoint 字幕新的出点（单位微秒）

返回: 返回字幕显示的出点（单位微秒）

参见: changeInPoint; getOutPoint; movePosition

◆ getAnchorPoint

- (CGPoint) getAnchorPoint

获取字幕锚点

返回: 返回字幕锚点

参见: setAnchorPoint

◆ getCaptionBoundingVertices:boundingType:

- (NSArray *) getCaptionBoundingVertices:	(NSInteger)	captionIndex
boundingType:	(NvsEffectBoundingType)	boundingType

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

参数

captionIndex	要获取顶点位置的字幕索引号
boundingType	边框类型。请参见边框类型

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

◆ getCaptionTranslation

- (CGPoint) getCaptionTranslation

获取字幕的平移量

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

参见: setCaptionTranslation

◆ getCompoundBoundingVertices:

- (NSArray *) getCompoundBoundingVertices: (NvsEffectBoundingType) boundingType

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

参数

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

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

◆ getFontFamily:

- (NSString *) getFontFamily: (NSInteger) captionIndex

获取字幕字体的名字

参数

captionIndex 想要获取字体的字幕索引号

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

参见: setFontFamily

◆ getOpacity

- (float) getOpacity

获取字幕透明度

返回: 返回字幕透明度

参见: - setOpacity:

◆ getRotationZ

- (float) getRotationZ

获取字幕旋转角度

返回: 返回字幕旋转角度

参见: setRotationZ

◆ getScaleX

- (float) getScaleX

获取字幕水平缩放系数

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

参见: setScaleX; - getScaleY

◆ getScaleY

- (float) getScaleY

获取字幕垂直缩放系数

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

参见: setScaleY; - getScaleX

◆ getText:

- (NSString *) getText: (NSInteger) captionIndex

获取字幕文本

参数

captionIndex 想要获取文字的字幕索引号

返回: 返回字幕文本

参见: setText

◆ getTextColor:

- (NvsEffectColor) getTextColor: (NSInteger) captionIndex

获取字幕的颜色值

参数

captionIndex 想要获取文本颜色的字幕索引号

返回: 返回NvsColor对象，表示文本的颜色值

参见: setTextColor

◆ getWeight:

- (int) getWeight: (int) captionIndex

获取字幕权重值

参数

captionIndex 想要设置文字的字幕索引号

返回: 字幕权重值

参见: setWeight: captionIndex:

◆ getZValue

- (float) getZValue

获取字幕Z值

返回: 返回字幕Z值

◆ movePosition:

- (void) movePosition: (int64_t) offset

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

参数

offset 入点和出点改变的偏移值（单位微秒）

参见: changeInPoint; changeOutPoint

◆ rotateCaption:anchor:

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

旋转字幕

参数

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

◆ rotateCaptionAroundCenter:boundingType:

- (void) rotateCaptionAroundCenter:	(float)	angle
boundingType:	(NvsEffectBoundingType)	boundingType

绕字幕边框中心旋转

参数

angle	字幕旋转的角度
boundingType	用于计算中心点的边框类型。请参见边框类型

◆ scaleCaption:anchor:

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

缩放字幕

参数

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

◆ setAnchorPoint:

- (void) setAnchorPoint: (CGPoint) anchor

设置字幕锚点

参数

anchor 锚点

参见: - getAnchorPoint

◆ setCaptionTranslation:

- (void) setCaptionTranslation: (CGPoint) translation

设置字幕平移量

参数

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

参见: - getCaptionTranslation

◆ setFontFamily:family:

- (void) setFontFamily:	(NSInteger)	captionIndex
family:	(NSString *)	family

设置字幕字体

参数

captionIndex	想要设置字体的字幕索引号
family	字体名称，若设为空字符串，则设为默认字体

参见: getFontFamily

◆ setOpacity:

- (void) setOpacity: (float) opacity

设置字幕透明度

参数

value 字幕透明度

参见: - getOpacity

◆ setRotationZ:

- (void) setRotationZ: (float) angle

对字幕设置旋转角度

参数

angle 旋转角度

参见: - getRotationZ

◆ setScaleX:

- (void) setScaleX: (float) scale

对字幕设置水平缩放系数

参数

scale 水平缩放系数

参见: - getScaleX; setScaleY

◆ setScaleY:

- (void) setScaleY: (float) scale

对字幕设置垂直缩放系数

参数

scale 垂直缩放系数

参见: - getScaleY; setScaleX

◆ setText:text:

- (void) setText:	(NSInteger)	captionIndex
text:	(NSString *)	text

设置字幕文本

参数

captionIndex	想要设置文字的字幕索引号
text	字幕文本

参见: getText

◆ setTextColor:textColor:

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

设置字幕文本颜色

参数

captionIndex	想要设置文本颜色的字幕索引号
textColor	文本颜色值

参见: getTextColor

◆ setVideoResolution:

- (void) setVideoResolution: (NvsEffectVideoResolution *) resolution

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

参数

resolution 画幅解析度

自从: 2.20.0

◆ setWeight:captionIndex:

- (void) setWeight:	(int)	weight
captionIndex:	(int)	captionIndex

设置字幕权重

参数

weight	opentype中的权重值
captionIndex	想要设置文字的字幕索引号

参见: - getWeight:

◆ setZValue:

- (void) setZValue: (float) value

设置字幕Z值

参数

value z值

◆ translateCaption:

- (void) translateCaption: (CGPoint) translationOffset

平移字幕

参数

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

参见: setCaptionTranslation; - getCaptionTranslation

属性说明

◆ captionCount

- (NSInteger) captionCount

readatomicassign

获取该复合字幕中子字幕的数量

返回: 子字幕数量

◆ captionStylePackageId

- (NSString*) captionStylePackageId

readatomicassign

字幕样式包裹ID

◆ inPoint

- (int64_t) inPoint

readatomicassign

字幕显示的入点（单位微秒）

◆ outPoint

- (int64_t) outPoint

readatomicassign

字幕显示的出点（单位微秒）

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

include/sdkcore/ios/NvsVideoEffectCompoundCaption.h

构造函数

属性

函数文档

◆ changeInPoint:

◆ changeOutPoint:

◆ getAnchorPoint

◆ getCaptionBoundingVertices:boundingType:

◆ getCaptionTranslation

◆ getCompoundBoundingVertices:

◆ getFontFamily:

◆ getOpacity

◆ getRotationZ

◆ getScaleX

◆ getScaleY

◆ getText:

◆ getTextColor:

◆ getWeight:

◆ getZValue

◆ movePosition:

◆ rotateCaption:anchor:

◆ rotateCaptionAroundCenter:boundingType:

◆ scaleCaption:anchor:

◆ setAnchorPoint:

◆ setCaptionTranslation:

◆ setFontFamily:family:

◆ setOpacity:

◆ setRotationZ:

◆ setScaleX:

◆ setScaleY:

◆ setText:text:

◆ setTextColor:textColor:

◆ setVideoResolution:

◆ setWeight:captionIndex:

◆ setZValue:

◆ translateCaption:

属性说明

◆ captionCount

◆ captionStylePackageId

◆ inPoint

◆ outPoint