Project
Project
基本信息 Basic Info
GetName()
返回值：string
Returns project name.
SetName(projectName)
返回值：Bool
Sets project name if given projectname (text) is unique.
GetSetting(settingName)
返回值：string
Returns setting value by given settingName (string) if the setting exist.
With empty settingName the function returns a full list of settings.
SetSetting(settingName, settingValue)
返回值：Bool
Sets project setting base on given name (string) and value (string).
GetGallery()
返回值： Gallery
Returns the Gallery object.
GetPresetList()
返回值：[presets...]
Returns a table of presets and their information.
注意
旧版本 GetPresets() 已弃用
SetPreset(presetName)
返回值：Bool
Sets preset by given presetName (string) into project.
GetMediaPool()
返回值：MediaPool
Returns the Media Pool object.
RefreshLUTList()
返回值： Bool
Refreshes LUT List
时间线相关
GetTimelineCount()
返回值：int
Returns the number of timelines currently present in the project.
GetTimelineByIndex(idx)
返回值：Timeline
Returns timeline at the given index, 1 <= idx <= project
GetCurrentTimeline()
返回值：Timeline
Returns the currently loaded timeline.
SetCurrentTimeline(timeline)
返回值：Bool
Sets given timeline as current timeline for the project. Returns True if successful.
渲染相关
AddRenderJob()
返回值： string
Adds a render job based on current render settings to the render queue. Returns a unique job id (string) for the new render job.
DeleteRenderJob(jobId)
返回值： Bool
Deletes render job for input job id (string).
DeleteAllRenderJobs()
返回值： Bool
Deletes all render jobs in the queue.
GetRenderJobList()
返回值：[render jobs...]
Returns a table of render jobs and their information.
注意
旧版本 GetRenderJobs() 已弃用
GetRenderPresetList()
返回值：[presets...]
Returns a table of render presets and their information.
注意
旧版本 GetRenderPresets() 已弃用
StartRendering(jobId1, jobId2, ...)
返回值：Bool
Starts rendering jobs indicated by the input job ids..
StartRendering([jobIds...], isInteractiveMode=False)
返回值：Bool
Starts rendering jobs indicated by the input job ids.
The optional isInteractiveMode, when set, enables error feedback in the UI during rendering.
StartRendering(isInteractiveMode=False)
返回值：Bool
Starts rendering all queued render jobs.
The optional isInteractiveMode, when set, enables error feedback in the UI during rendering.
StopRendering()
返回值：None
Stops rendering for all render jobs.
IsRenderingInProgress()
返回值：Bool
Returns true is rendering is in progress.
LoadRenderPreset(presetName)
返回值：Bool
Sets a preset as current preset for rendering if presetName (text) exists.
SaveAsNewRenderPreset(presetName)
返回值：Bool
Creates a new render preset by given name if presetName(text) is unique.
SetRenderSettings([settings map])
返回值：Bool
Sets given settings for rendering. Settings map is a map, keys of map are:
- "SelectAllFrames"
- "MarkIn"
- "MarkOut"
- "TargetDir"
- "CustomName"
GetRenderJobStatus(jobId)
返回值：[status info]
Returns job status and completion rendering percentage of the job by given job index (int).
GetRenderFormats()
返回值：[render formats...]
Returns a list of available render formats.
GetRenderCodecs(renderFormat)
返回值：[render codecs...]
Returns a list of available codecs for given render format (string).
GetCurrentRenderFormatAndCodec()
返回值：[format, codec]
Returns currently selected render format and render codec.
SetCurrentRenderFormatAndCodec(format, codec)
返回值：Bool
Sets given render format (string) and render codec (string) as options for rendering.
GetCurrentRenderMode()
返回值： int
Returns the render mode: 0 - Individual clips, 1 - Single clip.
SetCurrentRenderMode(renderMode)
返回值： Bool
Sets the render mode. Specify renderMode = 0 for Individual clips, 1 for Single clip.
GetRenderResolutions(format, codec)
返回值： [{Resolution}]
Returns list of resolutions applicable for the given render format (string) and render codec (string). Returns full list of resolutions if no argument is provided. Each element in the list is a dictionary with 2 keys "Width" and "Height".