NvsTimelineVideoFx类 参考

时间线视频特效 时间线视频特效是作用于时间线实例上的视频特效。 时间线视频特效分为內建特效、包裹特效和自定义特效三种类型。 內建特效是集成在sdk内部的，不需要授权即可直接使用。包裹特效是将特效资源整合成了特效包，每个特效包都有其一一对应的授权文件，并且要先安装再使用，具体情况请参见素材包安装 自定义特效是用户通过编写代码实现的特效 时间线视频特效包含特效入点和出点，通过入点和出点我们可以指定特效作用于时间线的位置和长度，入点要小于出点，单位为微秒。 时间线视频特效允许叠加，渲染顺序通过预设Z值控制。 更多...

#import <NvsTimelineVideoFx.h>

类 NvsTimelineVideoFx 继承关系图:

构造函数
(int64_t)	- changeInPoint:
	改变时间线视频特效在时间线上的入点 当设置的入点值不符合既定规则时最终返回入点值有可能与设置的入点值不同，比如新的入点值小于0，新的入点值大于时间线长度或者新的入点值大于出点值。 更多...
(int64_t)	- changeOutPoint:
	改变时间线视频特效在时间线上的出点 当设置的出点值不符合既定规则时最终返回出点值有可能与设置的出点值不同，比如新的出点值小于0，新的出点值大于时间线长度或者新的出点值小于入点值。 更多...
(void)	- movePosition:
	改变时间线视频特效在时间线上的位置(入点和出点同时偏移offset值) 更多...
(void)	- setZValue:
	设置时间线视频特效Z值 Z值决定了特效的渲染顺序，Z值越大，特效越处于上层 更多...
(float)	- getZValue
	获取时间线视频特效Z值 更多...
(CGPoint)	- mapPointFromCanonicalToParticleSystem:
	将时间线坐标转换为粒子系统坐标 更多...
构造函数 继承自 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的模板资源附件 更多...

属性
NvsTimelineVideoFxType	timelineVideoFxType
	时间线视频特效类型 更多...
NSString *	bultinTimelineVideoFxName
	内嵌时间线视频特效名字。如果不是内嵌时间线视频特效返回nil 更多...
NSString *	timelineVideoFxPackageId
	时间线视频特效资源包ID。如果不是资源包时间线视频特效返回nil 更多...
int64_t	inPoint
	时间线视频特效在时间线上的入点（单位微秒） 更多...
int64_t	outPoint
	时间线视频特效在时间线上的出点（单位微秒） 更多...
属性 继承自 NvsFx
NvsFxDescription *	description
	特效描述 更多...

详细描述

时间线视频特效 时间线视频特效是作用于时间线实例上的视频特效。 时间线视频特效分为內建特效、包裹特效和自定义特效三种类型。 內建特效是集成在sdk内部的，不需要授权即可直接使用。包裹特效是将特效资源整合成了特效包，每个特效包都有其一一对应的授权文件，并且要先安装再使用，具体情况请参见素材包安装 自定义特效是用户通过编写代码实现的特效 时间线视频特效包含特效入点和出点，通过入点和出点我们可以指定特效作用于时间线的位置和长度，入点要小于出点，单位为微秒。 时间线视频特效允许叠加，渲染顺序通过预设Z值控制。

警告

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

函数文档

changeInPoint:

- (int64_t) changeInPoint:

(int64_t)

newInPoint

改变时间线视频特效在时间线上的入点 当设置的入点值不符合既定规则时最终返回入点值有可能与设置的入点值不同，比如新的入点值小于0，新的入点值大于时间线长度或者新的入点值大于出点值。

参数

newInPoint

时间线特效在时间线上的新的入点（单位微秒）

返回

返回时间线视频特效在时间线上最终的入点值（单位微秒

警告

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

参见

changeOutPoint

movePosition

changeOutPoint:

- (int64_t) changeOutPoint:

(int64_t)

newOutPoint

改变时间线视频特效在时间线上的出点 当设置的出点值不符合既定规则时最终返回出点值有可能与设置的出点值不同，比如新的出点值小于0，新的出点值大于时间线长度或者新的出点值小于入点值。

参数

newOutPoint

时间线视频特效在时间线上的新的出点（单位微秒）

返回

返回时间线视频特效在时间线最终的出点值（单位微秒）

警告

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

参见

changeInPoint

movePosition

getZValue

- (float) getZValue

获取时间线视频特效Z值

返回

返回时间线视频特效Z值

自从

2.17.0

mapPointFromCanonicalToParticleSystem:

- (CGPoint) mapPointFromCanonicalToParticleSystem:

(CGPoint)

ptCononical

将时间线坐标转换为粒子系统坐标

参数

ptCononical

时间线坐标

返回

返回转换后的粒子系统坐标CGPoint

自从

1.16.0

movePosition:

- (void) movePosition:

(int64_t)

offset

改变时间线视频特效在时间线上的位置(入点和出点同时偏移offset值)

参数

offset

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

警告

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

参见

changeInPoint

changeOutPoint

setZValue:

- (void) setZValue:

(float)

value

设置时间线视频特效Z值 Z值决定了特效的渲染顺序，Z值越大，特效越处于上层

参数

value

z值

自从

2.17.0

属性说明

bultinTimelineVideoFxName

- (NSString*) bultinTimelineVideoFxName

readatomicassign

内嵌时间线视频特效名字。如果不是内嵌时间线视频特效返回nil

inPoint

- (int64_t) inPoint

readatomicassign

时间线视频特效在时间线上的入点（单位微秒）

outPoint

- (int64_t) outPoint

readatomicassign

时间线视频特效在时间线上的出点（单位微秒）

timelineVideoFxPackageId

- (NSString*) timelineVideoFxPackageId

readatomicassign

时间线视频特效资源包ID。如果不是资源包时间线视频特效返回nil

timelineVideoFxType

- (NvsTimelineVideoFxType) timelineVideoFxType

readatomicassign

时间线视频特效类型

---

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

• include/sdkcore/ios/NvsTimelineVideoFx.h