public class VeProcessRenderTask
extends java.lang.Object
Constructor and Description |
---|
VeProcessRenderTask(java.lang.String license,
java.lang.String tplFolder,
java.lang.String outputPath) |
VeProcessRenderTask(java.lang.String license,
java.lang.String tplFolder,
java.lang.String outputFile,
java.lang.String[] assetPaths) |
Modifier and Type | Method and Description |
---|---|
void |
destroy()
销毁渲染资源,必须调用
|
int |
getErrorCode()
获取渲染错误码
|
java.lang.String |
getErrorMsg()
获取渲染错误信息
|
java.lang.String |
getLicenseProfile()
获取 license 信息
|
int |
getMusicFadeoutDuration() |
float |
getMusicVolume() |
float |
getRenderProgress()
获取渲染进度
|
java.lang.String |
getStatus()
获取渲染任务状态
|
java.lang.String |
getTaskRenderedInfo()
获取渲染后的信息, 在 render() 后调用
|
java.util.List<Watermark> |
getWatermarkList() |
boolean |
isLicenseValid()
检查 license 是否有效
|
boolean |
isMusicLoop() |
boolean |
render()
启动渲染
|
void |
setAssetDir(java.lang.String assetPath)
设置引擎生成的素材存放目录,
|
void |
setAssetPaths(java.lang.String[] paths)
设置替换素材路径
|
void |
setBitrateControl(float control)
设置视频比特率控制参数,默认 0.25
|
void |
setDynamicSubFiles(java.lang.String json)
设置动态模板附加素材
|
void |
setDynamicSubTexts(java.lang.String subTextJson)
为动态模板设置关联的附加文字
|
void |
setMusicFadeoutDuration(int musicFadeoutDuration)
设置淡出时间, 单位秒
|
void |
setMusicLoop(boolean musicLoop)
设置音乐是否循环
|
void |
setMusicPath(java.lang.String musicPath,
boolean loopMusic)
设置音乐文件
|
void |
setMusicVolume(float musicVolume)
设置音量
0 - 1.0, 输出音量为原音量 * musicVolume
|
void |
setScriptData(java.lang.String scriptData)
设置脚本参数
|
void |
setScriptDir(java.lang.String scriptDir)
设置脚本目录
|
void |
setScriptMainFile(java.lang.String scriptMainFile)
设置脚本主文件路径
|
void |
setSnapShotFrames(int[] snapShotFrames)
设置快照帧索引
[1, 100] 表示第1, 100 帧会被生成 1.png , 100.png 到 snapshot path 目录中
|
void |
setSnapShotPath(java.lang.String snapShotPath)
设置快照保存目录
|
void |
setTemplateType(TemplateType type)
设置模板类型
|
void |
setTextPainterDir(java.lang.String textPainterPath)
设置文字绘制工具目录
|
void |
setWatermarkList(java.util.List<Watermark> watermarkList)
设置水印
|
public VeProcessRenderTask(java.lang.String license, java.lang.String tplFolder, java.lang.String outputPath)
public VeProcessRenderTask(java.lang.String license, java.lang.String tplFolder, java.lang.String outputFile, java.lang.String[] assetPaths)
public int getErrorCode()
ErrorCode
public java.lang.String getStatus()
RenderStatus
public boolean isMusicLoop()
public void setMusicLoop(boolean musicLoop)
musicLoop
- public void setTemplateType(TemplateType type)
type
- public boolean isLicenseValid()
public java.lang.String getLicenseProfile()
public java.lang.String getErrorMsg()
RenderStatus
public void setAssetPaths(java.lang.String[] paths)
paths
- public void setMusicPath(java.lang.String musicPath, boolean loopMusic)
musicPath
- loopMusic
- public void setBitrateControl(float control)
control
- public java.util.List<Watermark> getWatermarkList()
public void setWatermarkList(java.util.List<Watermark> watermarkList)
watermarkList
- public int getMusicFadeoutDuration()
public void setMusicFadeoutDuration(int musicFadeoutDuration)
musicFadeoutDuration
- public float getMusicVolume()
public void setMusicVolume(float musicVolume)
musicVolume
- public void setDynamicSubFiles(java.lang.String json)
json,
- 附加素材数据, json 字符串public void setDynamicSubTexts(java.lang.String subTextJson)
1. 当前文字是由 TextPainter 绘制,使用这个接口, 必须先设置好 assetPath 和 textpianter path
2. 非动态模板设置无效
subTextJson,
- 文字素材数组public void setAssetDir(java.lang.String assetPath)
1. TextPainter 绘制的文字图片会被放到设置的目录, 引擎不会对该目录执行清理动作,
需要调用方在渲染完成后,删除该目录进行清理
2. 由于生成的素材可能与别的任务重名,所以建议每个任务使用单独的素材目录
assetPath,
- 素材存放目录public void setTextPainterDir(java.lang.String textPainterPath)
1. 引擎使用该目录的 TextPainter 和 font_list.json 进行文字绘制
textPainterPath,
- 文字绘制工具目录public boolean render() throws InvalidLicenseException, RenderException, NotSupportedTemplateException
InvalidLicenseException
RenderException
NotSupportedTemplateException
public java.lang.String getTaskRenderedInfo()
public void destroy()
public void setScriptDir(java.lang.String scriptDir)
scriptDir
- public void setScriptData(java.lang.String scriptData)
scriptData
- public void setScriptMainFile(java.lang.String scriptMainFile)
scriptMainFile
- public void setSnapShotPath(java.lang.String snapShotPath)
snapShotPath,
- 目录public void setSnapShotFrames(int[] snapShotFrames)
snapShotFrames,
- 帧数组public float getRenderProgress()