Class VeProcessRenderTask


  • public class VeProcessRenderTask
    extends java.lang.Object
    • Constructor Summary

      Constructors 
      Constructor 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)  
    • Constructor Detail

      • VeProcessRenderTask

        public VeProcessRenderTask​(java.lang.String license,
                                   java.lang.String tplFolder,
                                   java.lang.String outputPath)
      • VeProcessRenderTask

        public VeProcessRenderTask​(java.lang.String license,
                                   java.lang.String tplFolder,
                                   java.lang.String outputFile,
                                   java.lang.String[] assetPaths)
    • Method Detail

      • getErrorCode

        public int getErrorCode()
        获取渲染错误码
        Returns:
        int, see ErrorCode
      • getStatus

        public java.lang.String getStatus()
        获取渲染任务状态
        Returns:
        String, see RenderStatus
      • isMusicLoop

        public boolean isMusicLoop()
      • setMusicLoop

        public void setMusicLoop​(boolean musicLoop)
        设置音乐是否循环
        Parameters:
        musicLoop -
      • setTemplateType

        public void setTemplateType​(TemplateType type)
        设置模板类型
        Parameters:
        type -
      • isLicenseValid

        public boolean isLicenseValid()
        检查 license 是否有效
        Returns:
        boolean
      • getLicenseProfile

        public java.lang.String getLicenseProfile()
        获取 license 信息
        Returns:
        String
      • getErrorMsg

        public java.lang.String getErrorMsg()
        获取渲染错误信息
        Returns:
        String, see RenderStatus
      • setAssetPaths

        public void setAssetPaths​(java.lang.String[] paths)
        设置替换素材路径
        Parameters:
        paths -
      • setMusicPath

        public void setMusicPath​(java.lang.String musicPath,
                                 boolean loopMusic)
        设置音乐文件
        Parameters:
        musicPath -
        loopMusic -
      • setBitrateControl

        public void setBitrateControl​(float control)
        设置视频比特率控制参数,默认 0.25
        Parameters:
        control -
      • getWatermarkList

        public java.util.List<Watermark> getWatermarkList()
      • setWatermarkList

        public void setWatermarkList​(java.util.List<Watermark> watermarkList)
        设置水印
        Parameters:
        watermarkList -
      • getMusicFadeoutDuration

        public int getMusicFadeoutDuration()
      • setMusicFadeoutDuration

        public void setMusicFadeoutDuration​(int musicFadeoutDuration)
        设置淡出时间, 单位秒
        Parameters:
        musicFadeoutDuration -
      • getMusicVolume

        public float getMusicVolume()
      • setMusicVolume

        public void setMusicVolume​(float musicVolume)
        设置音量 0 - 1.0, 输出音量为原音量 * musicVolume
        Parameters:
        musicVolume -
      • setDynamicSubFiles

        public void setDynamicSubFiles​(java.lang.String json)
        设置动态模板附加素材
        Parameters:
        json - , 附加素材数据, json 字符串
      • setDynamicSubTexts

        public void setDynamicSubTexts​(java.lang.String subTextJson)
        为动态模板设置关联的附加文字

        1. 当前文字是由 TextPainter 绘制,使用这个接口, 必须先设置好 assetPath 和 textpianter path
        2. 非动态模板设置无效

        Parameters:
        subTextJson - , 文字素材数组
      • setAssetDir

        public void setAssetDir​(java.lang.String assetPath)
        设置引擎生成的素材存放目录,

        1. TextPainter 绘制的文字图片会被放到设置的目录, 引擎不会对该目录执行清理动作, 需要调用方在渲染完成后,删除该目录进行清理
        2. 由于生成的素材可能与别的任务重名,所以建议每个任务使用单独的素材目录

        Parameters:
        assetPath - , 素材存放目录
      • setTextPainterDir

        public void setTextPainterDir​(java.lang.String textPainterPath)
        设置文字绘制工具目录

        1. 引擎使用该目录的 TextPainter 和 font_list.json 进行文字绘制

        Parameters:
        textPainterPath - , 文字绘制工具目录
      • setRetainAudioOfVideo

        public void setRetainAudioOfVideo​(boolean retainAudioOfVideo)
        是否保留视频替换素材中的音频
        Parameters:
        retainAudioOfVideo -
      • setDynamicAdaptVideo

        public void setDynamicAdaptVideo​(boolean dynamicAdaptVideo)
        渲染动态模板,是否对视频替换素材进行自适应
        Parameters:
        dynamicAdaptVideo -
      • getTaskRenderedInfo

        public java.lang.String getTaskRenderedInfo()
        获取渲染后的信息, 在 render() 后调用
      • destroy

        public void destroy()
        销毁渲染资源,必须调用
      • setScriptDir

        public void setScriptDir​(java.lang.String scriptDir)
        设置脚本目录
        Parameters:
        scriptDir -
      • setScriptData

        public void setScriptData​(java.lang.String scriptData)
        设置脚本参数
        Parameters:
        scriptData -
      • setScriptMainFile

        public void setScriptMainFile​(java.lang.String scriptMainFile)
        设置脚本主文件路径
        Parameters:
        scriptMainFile -
      • setSnapShotPath

        public void setSnapShotPath​(java.lang.String snapShotPath)
        设置快照保存目录
        Parameters:
        snapShotPath - , 目录
      • setSnapShotFrames

        public void setSnapShotFrames​(int[] snapShotFrames)
        设置快照帧索引 [1, 100] 表示第1, 100 帧会被生成 1.png , 100.png 到 snapshot path 目录中
        Parameters:
        snapShotFrames - , 帧数组
      • getRenderProgress

        public float getRenderProgress()
        获取渲染进度 无论成功失败,最终都会返回 1.0
        Returns:
        float, 范围 0.0 - 1.0