Project

Basic Info

GetName()

Return: string

Returns project name.

SetName(projectName)

Return: Bool

Sets project name if given projectname (text) is unique.

GetSetting(settingName)

Return: 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)

Return: Bool

Sets project setting base on given name (string) and value (string).

GetGallery()

Return: Gallery

Returns the Gallery object.

GetPresetList()

Return: [presets...]

Returns a table of presets and their information.

Note

Old version GetPresets() Deprecated

SetPreset(presetName)

Return: Bool

Sets preset by given presetName (string) into project.

GetMediaPool()

Return: MediaPool

Returns the Media Pool object.

RefreshLUTList()

Return: Bool

Refreshes LUT List

Timeline Related

GetTimelineCount()

Return: int

Returns the number of timelines currently present in the project.

GetTimelineByIndex(idx)

Return: Timeline

Returns timeline at the given index, 1 <= idx <= project

GetCurrentTimeline()

Return: Timeline

Returns the currently loaded timeline.

SetCurrentTimeline(timeline)

Return: Bool

Sets given timeline as current timeline for the project. Returns True if successful.

Render Related

AddRenderJob()

Return: 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)

Return: Bool

Deletes render job for input job id (string).

DeleteAllRenderJobs()

Return: Bool

Deletes all render jobs in the queue.

GetRenderJobList()

Return: [render jobs...]

Returns a table of render jobs and their information.

Note

Old version GetRenderJobs() Deprecated

GetRenderPresetList()

Return: [presets...]

Returns a table of render presets and their information.

Note

Old version GetRenderPresets() Deprecated

StartRendering(jobId1, jobId2, ...)

Return: Bool

Starts rendering jobs indicated by the input job ids..

StartRendering([jobIds...], isInteractiveMode=False)

Return: 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)

Return: Bool

Starts rendering all queued render jobs.

The optional isInteractiveMode, when set, enables error feedback in the UI during rendering.

StopRendering()

Return: None

Stops rendering for all render jobs.

IsRenderingInProgress()

Return: Bool

Returns true is rendering is in progress.

LoadRenderPreset(presetName)

Return: Bool

Sets a preset as current preset for rendering if presetName (text) exists.

SaveAsNewRenderPreset(presetName)

Return: Bool

Creates a new render preset by given name if presetName(text) is unique.

SetRenderSettings([settings map])

Return: Bool

Sets given settings for rendering. Settings map is a map, keys of map are:

• "SelectAllFrames"
• "MarkIn"
• "MarkOut"
• "TargetDir"
• "CustomName"

GetRenderJobStatus(jobId)

Return: [status info]

Returns job status and completion rendering percentage of the job by given job index (int).

GetRenderFormats()

Return: [render formats...]

Returns a list of available render formats.

GetRenderCodecs(renderFormat)

Return: [render codecs...]

Returns a list of available codecs for given render format (string).

GetCurrentRenderFormatAndCodec()

Return: [format, codec]

Returns currently selected render format and render codec.

SetCurrentRenderFormatAndCodec(format, codec)

Return: Bool

Sets given render format (string) and render codec (string) as options for rendering.

GetCurrentRenderMode()

Return: int

Returns the render mode: 0 - Individual clips, 1 - Single clip.

SetCurrentRenderMode(renderMode)

Return: Bool

Sets the render mode. Specify renderMode = 0 for Individual clips, 1 for Single clip.

GetRenderResolutions(format, codec)

Return: [{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".