TXVideoEditer Class Reference

Inherits from	NSObject
Declared in	TXVideoEditer.h

Overview

视频编辑类

Other Methods

`generateDelegate`

生成视频回调的委托对象, 可以获取生成进度与完成时间等

@property (nonatomic, weak) id<TXVideoGenerateListener> generateDelegate

Declared In

TXVideoEditer.h

`previewDelegate`

视频预览回调的委托对象，可以获取视频的播放进度等

@property (nonatomic, weak) id<TXVideoPreviewListener> previewDelegate

Declared In

TXVideoEditer.h

`videoProcessDelegate`

视频画面处理的委托对象，可以获取视频画面的OpenGL纹理ID [精简版不支持]

@property (nonatomic, weak) id<TXVideoCustomProcessListener> videoProcessDelegate

Declared In

TXVideoEditer.h

`supportsTwoPassEncoding`

判断是否支持TwoPass-Encoding [精简版不支持]

@property (nonatomic, readonly) BOOL supportsTwoPassEncoding

Declared In

TXVideoEditer.h

`param`	编辑器画面预览参数

`– setVideoPath:`

设置视频文件路径

- (int)setVideoPath:(NSString *)videoPath

Parameters

`videoPath`	视频文件路径

Return Value

0 成功； -1 视频文件不存在； -2 视频不支持：暂不支持2个声道以上的视频编辑

Declared In

TXVideoEditer.h

`– setVideoAsset:`

设置视频 AVAsset

- (int)setVideoAsset:(AVAsset *)videoAsset

Parameters

`videoAsset`	视频AVAsset对象,从本地相册loading出来的视频，可以直接传入对应的视频属性，会极大的降低视频从相册loading的时间，具体请参考demo用法

Return Value

0 成功； -1 视频属性asset 为nil； -2 视频不支持：暂不支持2个声道以上的视频编辑

Declared In

TXVideoEditer.h

`– setPictureList:fps:`

设置转场图片列表 [精简版不支持]

- (int)setPictureList:(NSArray<UIImage*> *)pitureList fps:(int)fps

Parameters

`pitureList`	转场图片列表,至少设置三张图片（tips ：图片最好压缩到720P以下（参考demo用法），否则内存占用可能过大，导致编辑过程异常）
`fps`	转场图片生成视频后的fps （15 ~ 30）

Return Value

0 设置成功； -1 设置失败，请检查图片列表是否存在，图片数量是否大于等于3张，fps是否正常；

Declared In

TXVideoEditer.h

`– setPictureTransition:duration:`

设置图片转场类型 [精简版不支持]

- (void)setPictureTransition:(TXTransitionType)transitionType duration:(void ( ^ ) ( CGFloat ))duration

Parameters

`transitionType`	转场类型，详情见 TXTransitionType
`duration`	转场视频时长（tips：同一个图片列表，每种转场动画的持续时间可能不一样，这里可以获取转场图片的持续时长）；

Declared In

TXVideoEditer.h

预览逻辑相关方法

`time`	预览帧时间(s)

`startTime`	播放起始时间(s)
`endTime`	播放结束时间(s)

`– pausePlay`

暂停播放

- (void)pausePlay

Declared In

TXVideoEditer.h

`– resumePlay`

继续播放

- (void)resumePlay

Declared In

TXVideoEditer.h

`– setBeautyFilter:setWhiteningLevel:`

设置美颜，美白级别 0~9

- (void)setBeautyFilter:(float)beautyLevel setWhiteningLevel:(float)whiteningLevel

Parameters

`beautyLevel`	磨皮级别 0~9
`whiteningLevel`	美白级别 0~9

Declared In

TXVideoEditer.h

`image`	滤镜图片

`– setFilter:leftIntensity:rightFilter:rightIntensity:leftRatio:`

设置两个滤镜效果

- (void)setFilter:(UIImage *)leftFilter leftIntensity:(CGFloat)leftIntensity rightFilter:(UIImage *)rightFilter rightIntensity:(CGFloat)rightIntensity leftRatio:(CGFloat)leftRatio

Parameters

`leftFilter`	左滤镜图片(nil代表无左滤镜)
`leftIntensity`	左滤镜浓度
`rightFilter`	右滤镜图片(nil代表无右滤镜)
`rightIntensity`	右滤镜浓度
`leftRatio`	左滤镜所占比例

Declared In

TXVideoEditer.h

`specialRatio`	从0到1，越大滤镜效果越明显，默认取值0.5

`isReverse`	是否倒放

`repeatList`	重复播放的范围列表

`rotation`	画面渲染角度, 必须是90的倍数

`speedList`	加速范围列表

`type`	特效类型
`startTime`	特效开始时间

`type`	特效类型
`endTime`	特效结束时间

`– deleteLastEffect`

删除最后一个添加的特效 [精简版不支持]

- (void)deleteLastEffect

Declared In

TXVideoEditer.h

`– deleteAllEffect`

删除所有特效 [精简版不支持]

- (void)deleteAllEffect

Declared In

TXVideoEditer.h

贴纸相关方法 [精简版不支持]

`subtitleList`	字幕列表

`pasterList`	静态贴纸列表

`animatedPasterList`	动态贴纸列表

BGM相关方法

`path`	音乐文件路径
`result`	0:成功, -1:音乐文件格式不支持

`asset`	音乐AVAsset对象, 从系统媒体库loading出来的音乐，可以直接传入对应的音乐属性，会极大的降低音乐从系统媒体库loading的时间，具体请参考demo用法
`result`	0:成功, -1:音乐文件格式不支持

`startTime`	音乐起始时间
`endTime`	音乐结束时间

`isLoop`	是否循环播放

`time`	背景音乐在视频的添加的起始时间

`volume`	音量, 取值范围 0.0 ~ 1.0

`volume`	背景音量, 取值范围 0.0 ~ 1.0

`– setBGMFadeInDuration:fadeOutDuration:`

设置背景音淡入淡出

- (void)setBGMFadeInDuration:(float)fadeInDuration fadeOutDuration:(float)fadeOutDuration

Parameters

`fadeInDuration`	淡入持续时长 (s)
`fadeOutDuration`	淡出持续时长 (s)

Declared In

TXVideoEditer.h

水印相关方法

`– setWaterMark:normalizationFrame:`

设置全局水印 [精简版不支持]

- (void)setWaterMark:(UIImage *)waterMark normalizationFrame:(CGRect)normalizationFrame

Parameters

`waterMark`	全局水印图片
`normalizationFrame`	水印相对于视频图像的归一化frame，x,y,width,height 取值范围 0~1； height不用设置，sdk内部会根据水印宽高比自动计算height；比如视频图像大小为（540，960） frame设置为（0.1，0.1，0.1,0）, 水印的实际像素坐标为（540 * 0.1，960 * 0.1，540 * 0.1 ，540 * 0.1 * waterMark.size.height / waterMark.size.width）

Declared In

TXVideoEditer.h

`– setTailWaterMark:normalizationFrame:duration:`

设置片尾水印 [精简版不支持]

- (void)setTailWaterMark:(UIImage *)tailWaterMark normalizationFrame:(CGRect)normalizationFrame duration:(CGFloat)duration

Parameters

`tailWaterMark`	片尾水印图片
`normalizationFrame`	水印相对于视频图像的归一化frame，x,y,width,height 取值范围 0~1； height不用设置，sdk内部会根据水印宽高比自动计算height；比如视频图像大小为（540，960） frame设置为（0.1，0.1，0.1,0）, 水印的实际像素坐标为（540 * 0.1，960 * 0.1，540 * 0.1 ，540 * 0.1 * waterMark.size.height / waterMark.size.width）
`duration`	水印的持续时长

Declared In

TXVideoEditer.h

视频生成相关方法

`startTime`	视频起始时间
`endTime`	视频结束时间

`bitrate`	视频码率单位:kbps 如果设置了码率，SDK生成视频会优先使用这个码率，注意码率不要太大或则太小，码率太小视频会模糊不清，码率太大，生成视频体积会很大这里建议设置范围为：600~12000，如果没有调用这个接口，SDK内部会根据压缩质量自动计算码率

`– generateVideo:videoOutputPath:`

生成视频优点：兼容性好，支持各种操作类型的视频生成，生成的视频文件在各个平台播放的兼容性好缺点：生成视频速度稍慢调用之后在TXVideoGenerateListener里面监听结果回调

- (void)generateVideo:(TXVideoCompressed)videoCompressed videoOutputPath:(NSString *)videoOutputPath

Parameters

`videoCompressed`	视频压缩质量
`videoOutputPath`	视频操作之后存储路径

Declared In

TXVideoEditer.h

`– quickGenerateVideo:videoOutputPath:`

使用系统函数快速生成视频优点：生成视频速度快缺点：1，剪切出来的视频在各个平台播放的兼容性稍差 2，只有剪切和压缩操作才会使用系统函数，其他情况系统不支持，SDK内部会自动走正常视频生成的逻辑调用之后在 TXVideoGenerateListener 里面监听结果回调

- (void)quickGenerateVideo:(TXVideoCompressed)videoCompressed videoOutputPath:(NSString *)videoOutputPath

Parameters

`videoCompressed`	视频压缩质量
`videoOutputPath`	视频操作之后存储路径

Declared In

TXVideoEditer.h

`– generateVideoWithTwoPass:videoOutputPath:`

两次扫描生成视频(Two-Pass Encoding) [精简版不支持] 优点：兼容性好，在同等码率下视频更加清晰，可以在较低码率下保持视频质量，支持各种操作类型的视频生成，生成的视频文件在各个平台播放的兼容性好缺点：生成视频慢调用之后在TXVideoGenerateListener里面监听结果回调

- (void)generateVideoWithTwoPass:(TXVideoCompressed)videoCompressed videoOutputPath:(NSString *)videoOutputPath

Parameters

`videoCompressed`	视频压缩质量
`videoOutputPath`	视频操作之后存储路径

Declared In

TXVideoEditer.h

`– pauseGenerate`

暂停视频生成，仅适用于generateVideo，quickGenerateVideo调用无效

- (void)pauseGenerate

Discussion

SDK生成视频默认采用的是硬编码（编码效率高，编码出来的图像效果好），硬编码器在程序进后台后会停止工作，从而导致视频生成失败，这里新增了两个接口pauseGenerate，resumeGenerate，程序进后台后您可以调用pauseGenerate暂停视频生成，程序重新进前台后，您可以调用resumeGenerate 继续视频生成，这里需要注意的是，调用resumeGenerate，sdk会重启硬编码器，会有一定的概率重启失败，或则重启后前几帧数据编码失败，这个时候SDK内部会在 TXVideoGenerateListener 抛出编码错误事件，收到错误事件后您需要重新生成视频。

Declared In

TXVideoEditer.h

`– resumeGenerate`

继续视频生成，仅适用于generateVideo，quickGenerateVideo调用无效

- (void)resumeGenerate

Declared In

TXVideoEditer.h

`– cancelGenerate`

停止视频文件生成

- (void)cancelGenerate

Declared In

TXVideoEditer.h

TXVideoEditer Class Reference

Overview

Other Methods

See Also

Declared In

See Also

Declared In

See Also

Declared In

Declared In

Parameters

See Also

Declared In

Parameters

Return Value

Declared In

Parameters

Return Value

Declared In

Parameters

Return Value

Declared In

Parameters

Declared In

预览逻辑相关方法

Parameters

Declared In

Parameters

Declared In

Declared In

Declared In

Declared In

Parameters

Declared In

Parameters

Declared In

Parameters

Declared In

Parameters

Declared In

Parameters

Declared In

Parameters

See Also

Declared In

Parameters

Discussion

Declared In

Parameters

Declared In

Parameters

Declared In

Parameters

Declared In

Declared In

Declared In

贴纸相关方法 [精简版不支持]

Parameters

Declared In

Parameters

Declared In

Parameters

Declared In

BGM相关方法

Parameters

Declared In

Parameters

Declared In

Parameters

Declared In

Parameters

Declared In

Parameters

Declared In

Parameters

Declared In

Parameters

Declared In

Parameters

Declared In