method
stringlengths 6
115
| return
stringlengths 3
19
| function
stringlengths 18
1.28k
| category
stringclasses 5
values |
|---|---|---|---|
Fusion() | Fusion | Returns the Fusion object. Starting point for Fusion scripts | Resolve |
GetMediaStorage() | MediaStorage | Returns the media storage object to query and act on media locations | Resolve |
GetProjectManager() | ProjectManager | Returns the project manager object for currently open database | Resolve |
OpenPage(pageName) | Bool | Switches to indicated page in DaVinci Resolve. Input can be one of ('media', 'cut', 'edit', 'fusion', 'color', 'fairlight', 'deliver') | Resolve |
GetCurrentPage() | String | Returns the page currently displayed in the main window. Returned value can be one of ('media', 'cut', 'edit', 'fusion', 'color', 'fairlight', 'deliver', None) | Resolve |
GetProductName() | String | Returns product name('DaVinci Resolve' or 'DaVinci Resolve Studio') | Resolve |
GetVersion() | [version fields] | Returns list of product version fields in [major, minor, patch, build, suffix] format | Resolve |
GetVersionString() | String | Returns product version in 'major.minor.patch[suffix].build' format | Resolve |
LoadLayoutPreset(presetName) | Bool | Loads UI layout from saved preset named 'presetName' | Resolve |
UpdateLayoutPreset(presetName) | Bool | Overwrites preset named 'presetName' with current UI layout | Resolve |
ExportLayoutPreset(presetName, presetFilePath) | Bool | Exports preset named 'presetName' to path 'presetFilePath' | Resolve |
DeleteLayoutPreset(presetName) | Bool | Deletes preset named 'presetName' | Resolve |
SaveLayoutPreset(presetName) | Bool | Saves current UI layout as a preset named 'presetName' | Resolve |
ImportLayoutPreset(presetFilePath, presetName) | Bool | Imports preset from path 'presetFilePath'. The optional argument 'presetName' specifies how the preset shall be named. If not specified, the preset is named based on the filename | Resolve |
Quit() | None | Quits the Resolve App | Resolve |
ArchiveProject(projectName, filePath, isArchiveSrcMedia=True, isArchiveRenderCache=True, isArchiveProxyMedia=False) | Bool | Archives project to provided file path with the configuration as provided by the optional arguments | ProjectManager |
CreateProject(projectName) | Project | Creates and returns a project if projectName (string) is unique, and None if it is not | ProjectManager |
DeleteProject(projectName) | Bool | Delete project in the current folder if not currently loaded | ProjectManager |
LoadProject(projectName) | Project | Loads and returns the project with name = projectName (string) if there is a match found, and None if there is no matching Project | ProjectManager |
GetCurrentProject() | Project | Returns the currently loaded Resolve project | ProjectManager |
SaveProject() | Bool | Saves the currently loaded project with its own name. Returns True if successful | ProjectManager |
CloseProject(project) | Bool | Closes the specified project without saving | ProjectManager |
CreateFolder(folderName) | Bool | Creates a folder if folderName (string) is unique | ProjectManager |
DeleteFolder(folderName) | Bool | Deletes the specified folder if it exists. Returns True in case of success | ProjectManager |
GetProjectListInCurrentFolder() | [project names...] | Returns a list of project names in current folder | ProjectManager |
GetFolderListInCurrentFolder() | [folder names...] | Returns a list of folder names in current folder | ProjectManager |
GotoRootFolder() | Bool | Opens root folder in database | ProjectManager |
GotoParentFolder() | Bool | Opens parent folder of current folder in database if current folder has parent | ProjectManager |
GetCurrentFolder() | string | Returns the current folder name | ProjectManager |
OpenFolder(folderName) | Bool | Opens folder under given name | ProjectManager |
ImportProject(filePath, projectName=None) | Bool | Imports a project from the file path provided with given project name, if any. Returns True if successful | ProjectManager |
ExportProject(projectName, filePath, withStillsAndLUTs=True) | Bool | Exports project to provided file path, including stills and LUTs if withStillsAndLUTs is True (enabled by default). Returns True in case of success | ProjectManager |
RestoreProject(filePath, projectName=None) | Bool | Restores a project from the file path provided with given project name, if any. Returns True if successful | ProjectManager |
GetCurrentDatabase() | {dbInfo} | Returns a dictionary (with keys 'DbType', 'DbName' and optional 'IpAddress') corresponding to the current database connection | ProjectManager |
GetDatabaseList() | [{dbInfo}] | Returns a list of dictionary items (with keys 'DbType', 'DbName' and optional 'IpAddress') corresponding to all the databases added to Resolve | ProjectManager |
SetCurrentDatabase({dbInfo}) | Bool | Switches current database connection to the database specified by the keys below, and closes any open project.'DbType': 'Disk' or 'PostgreSQL' (string)'DbName': database name (string)'IpAddress': IP address of the PostgreSQL server (string, optional key - defaults to '127.0.0.1') | ProjectManager |
GetMediaPool() | MediaPool | Returns the Media Pool object | Project |
GetTimelineCount() | Int | Returns the number of timelines currently present in the project | Project |
GetTimelineByIndex(idx) | Timeline | Returns timeline at the given index, 1 <= idx <= project.GetTimelineCount() | Project |
GetCurrentTimeline() | Timeline | Returns the currently loaded timeline | Project |
SetCurrentTimeline(timeline) | Bool | Sets given timeline as current timeline for the project. Returns True if successful | Project |
GetGallery() | Gallery | Returns the Gallery object | Project |
GetName() | String | Returns project name | Project |
SetName(projectName) | Bool | Sets project name if given projectName (string) is unique | Project |
GetPresetList() | [presets...] | Returns a list of presets and their information | Project |
SetPreset(presetName) | Bool | Sets preset by given presetName (string) into project | Project |
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 | Project |
DeleteRenderJob(jobId) | Bool | Deletes render job for input job id (string) | Project |
DeleteAllRenderJobs() | Bool | Deletes all render jobs in the queue | Project |
GetRenderJobList() | [render jobs...] | Returns a list of render jobs and their information | Project |
GetRenderPresetList() | [presets...] | Returns a list of render presets and their information | Project |
StartRendering(jobId1, jobId2, ...) | Bool | Starts rendering jobs indicated by the input job ids | Project |
StartRendering([jobIds...], isInteractiveMode=False) | Bool | Starts rendering jobs indicated by the input job idsThe optional 'isInteractiveMode', when set, enables error feedback in the UI during rendering | Project |
StartRendering(isInteractiveMode=False) | Bool | Starts rendering all queued render jobs. The optional 'isInteractiveMode', when set, enables error feedback in the UI during rendering | Project |
StopRendering() | None | Stops any current render processes | Project |
IsRenderingInProgress() | Bool | Returns True if rendering is in progress | Project |
LoadRenderPreset(presetName) | Bool | Sets a preset as current preset for rendering if presetName (string) exists | Project |
SaveAsNewRenderPreset(presetName) | Bool | Creates new render preset by given name if presetName(string) is unique | Project |
SetRenderSettings({settings}) | Bool | Sets given settings for rendering. Settings is a dict, with support for the keys: Refer to 'Looking up render settings' section for information for supported settings | Project |
GetRenderJobStatus(jobId) | {status info} | Returns a dict with job status and completion percentage of the job by given jobId (string) | Project |
GetSetting(settingName) | String | Returns value of project setting (indicated by settingName, string). Check the section below for more information | Project |
SetSetting(settingName, settingValue) | Bool | Sets the project setting (indicated by settingName, string) to the value (settingValue, string). Check the section below for more information | Project |
GetRenderFormats() | {render formats...} | Returns a dict (format -> file extension) of available render formats | Project |
GetRenderCodecs(renderFormat) | {render codecs...} | Returns a dict (codec description -> codec name) of available codecs for given render format (string) | Project |
GetCurrentRenderFormatAndCodec() | {format, codec} | Returns a dict with currently selected format 'format' and render codec 'codec' | Project |
SetCurrentRenderFormatAndCodec(format, codec) | Bool | Sets given render format (string) and render codec (string) as options for rendering | Project |
GetCurrentRenderMode() | Int | Returns the render mode: 0 - Individual clips, 1 - Single clip | Project |
SetCurrentRenderMode(renderMode) | Bool | Sets the render mode. Specify renderMode = 0 for Individual clips, 1 for Single clip | Project |
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' | Project |
RefreshLUTList() | Bool | Refreshes LUT List | Project |
GetUniqueId() | String | Returns a unique ID for the project item | Project |
InsertAudioToCurrentTrackAtPlayhead(mediaPath, startOffsetInSamples, durationInSamples) | Bool | Inserts the media specified by mediaPath (string) with startOffsetInSamples (int) and durationInSamples (int) at the playhead on a selected track on the Fairlight page. Returns True if successful, otherwise False | Project |
GetName() | String | Returns the timeline name | Timeline |
SetName(timelineName) | Bool | Sets the timeline name if timelineName (string) is unique. Returns True if successful | Timeline |
GetStartFrame() | Int | Returns the frame number at the start of timeline | Timeline |
GetEndFrame() | Int | Returns the frame number at the end of timeline | Timeline |
SetStartTimecode(timecode) | Bool | Set the start timecode of the timeline to the string 'timecode'. Returns true when the change is successful, false otherwise | Timeline |
GetStartTimecode() | String | Returns the start timecode for the timeline | Timeline |
GetTrackCount(trackType) | Int | Returns the number of tracks for the given track type ('audio', 'video' or 'subtitle') | Timeline |
GetItemListInTrack(trackType, index) | [TimelineItem...] | Returns a list of TimelineItem objects on that track (based on trackType and index). 1 <= index <= GetTrackCount(trackType) | Timeline |
AddMarker(frameId, color, name, note, duration, customData) | Bool | Creates a new marker at given frameId position and with given marker information. 'customData' is optional and helps to attach user specific data to the marker | Timeline |
GetMarkers() | {markers...} | Returns a dict (frameId -> {information}) of all markers and dicts with their informationExample: a value of {96.0: {'color': 'Green', 'duration': 1.0, 'note': '', 'name': 'Marker 1', 'customData': ''}, ...} indicates a single green marker at timeline offset 96 | Timeline |
GetMarkerByCustomData(customData) | {marker...} | Returns marker {information} for the first matching marker with specified customData | Timeline |
UpdateMarkerCustomData(frameId, customData) | Bool | Updates customData (string) for the marker at given frameId position. CustomData is not exposed via UI and is useful for scripting developer to attach any user specific data to markers | Timeline |
GetMarkerCustomData(frameId) | String | Returns customData string for the marker at given frameId position | Timeline |
DeleteMarkersByColor(color) | Bool | Deletes all timeline markers of the specified color. An 'All' argument is supported and deletes all timeline markers | Timeline |
DeleteMarkerAtFrame(frameNum) | Bool | Deletes the timeline marker at the given frame number | Timeline |
DeleteMarkerByCustomData(customData) | Bool | Delete first matching marker with specified customData | Timeline |
ApplyGradeFromDRX(path, gradeMode, item1, item2, ...) | Bool | Loads a still from given file path (string) and applies grade to Timeline Items with gradeMode (int): 0 - 'No keyframes', 1 - 'Source Timecode aligned', 2 - 'Start Frames aligned' | Timeline |
ApplyGradeFromDRX(path, gradeMode, [items]) | Bool | Loads a still from given file path (string) and applies grade to Timeline Items with gradeMode (int): 0 - 'No keyframes', 1 - 'Source Timecode aligned', 2 - 'Start Frames aligned' | Timeline |
GetCurrentTimecode() | String | Returns a string timecode representation for the current playhead position, while on Cut, Edit, Color, Fairlight and Deliver pages | Timeline |
SetCurrentTimecode(timecode) | Bool | Sets current playhead position from input timecode for Cut, Edit, Color, Fairlight and Deliver pages | Timeline |
GetCurrentVideoItem() | TimelineItem | Returns the current video TimelineItem | Timeline |
GetCurrentClipThumbnailImage() | {thumbnailData} | Returns a dict (keys 'width', 'height', 'format' and 'data') with data containing raw thumbnail image data (RGB 8-bit image data encoded in base64 format) for current media in the Color PageAn example of how to retrieve and interpret thumbnails is provided in 6_get_current_media_thumbnail.py in the Examples folder | Timeline |
GetTrackName(trackType, trackIndex) | String | Returns the track name for track indicated by trackType ('audio', 'video' or 'subtitle') and index. 1 <= trackIndex <= GetTrackCount(trackType) | Timeline |
SetTrackName(trackType, trackIndex, name) | Bool | Sets the track name (string) for track indicated by trackType ('audio', 'video' or 'subtitle') and index. 1 <= trackIndex <= GetTrackCount(trackType) | Timeline |
DuplicateTimeline(timelineName) | timeline | Duplicates the timeline and returns the created timeline, with the (optional) timelineName, on success | Timeline |
CreateCompoundClip([timelineItems], {clipInfo}) | timelineItem | Creates a compound clip of input timeline items with an optional clipInfo map: {'startTimecode' : '00:00:00:00', 'name' : 'Compound Clip 1'}. It returns the created timeline item | Timeline |
CreateFusionClip([timelineItems]) | timelineItem | Creates a Fusion clip of input timeline items. It returns the created timeline item | Timeline |
ImportIntoTimeline(filePath, {importOptions}) | Bool | Imports timeline items from an AAF file and optional importOptions dict into the timeline, with support for the keys:'autoImportSourceClipsIntoMediaPool': Bool, specifies if source clips should be imported into media pool, True by default'ignoreFileExtensionsWhenMatching': Bool, specifies if file extensions should be ignored when matching, False by default'linkToSourceCameraFiles': Bool, specifies if link to source camera files should be enabled, False by default'useSizingInfo': Bool, specifies if sizing information should be used, False by default'importMultiChannelAudioTracksAsLinkedGroups': Bool, specifies if multi-channel audio tracks should be imported as linked groups, False by default'insertAdditionalTracks': Bool, specifies if additional tracks should be inserted, True by default'insertWithOffset': string, specifies insert with offset value in timecode format - defaults to '00:00:00:00', applicable if 'insertAdditionalTracks' is False'sourceClipsPath': string, specifies a filesystem path to search for source clips if the media is inaccessible in their original path and if 'ignoreFileExtensionsWhenMatching' is True'sourceClipsFolders': string, list of Media Pool folder objects to search for source clips if the media is not present in current folder | Timeline |