### AnalyzeForIntellisearch Source: https://extremraym.com/cloud/resolve-scripting-doc Performs Intellisearch analysis on a MediaPoolItem. Returns true if successful and required packages are installed. ```APIDOC ## AnalyzeForIntellisearch(identifyFaces, isBetterMode) ### Description Performs Intellisearch analysis on the MediaPoolItem. `identifyFaces` specifies whether to identify faces; `isBetterMode` specifies whether to use Better mode. Returns True if required packages are installed and analysis is successful. ### Parameters - **identifyFaces** (bool) - Specifies whether to identify faces. - **isBetterMode** (bool) - Specifies whether to use Better mode. ### Return - **Bool** - True if required packages are installed and analysis is successful. ``` -------------------------------- ### StartRendering(isInteractiveMode=False) Source: https://extremraym.com/cloud/resolve-scripting-doc Starts rendering all jobs currently in the render queue, with an option for interactive mode. ```APIDOC ## StartRendering(isInteractiveMode=False) ### Description Starts rendering all queued render jobs. The optional `isInteractiveMode` enables error feedback in the UI during rendering. ### Parameters #### Path Parameters - **isInteractiveMode** (Bool) - Optional - If set to True, enables error feedback in the UI during rendering. Defaults to False. ### Returns - Bool: True if rendering was initiated successfully, False otherwise. ``` -------------------------------- ### Get Timeline Item Property Example Source: https://extremraym.com/cloud/resolve-scripting-doc Shows how to retrieve the current value of a specific timeline item property. For properties using constants, the returned value will be the corresponding number. ```python item: TimelineItem # Get a single property pan_value = item.GetProperty("Pan") # Get multiple properties properties = ["Tilt", "ZoomX", "RotationAngle"] tilt_zoom_rotation = item.GetProperty(properties) # Get a property that uses constants composite_mode = item.GetProperty("CompositeMode") # composite_mode will be a number, e.g., 0 for COMPOSITE_NORMAL ``` -------------------------------- ### StartRendering([jobIds...], isInteractiveMode=False) Source: https://extremraym.com/cloud/resolve-scripting-doc Starts rendering specified jobs, with an option to enable interactive mode for UI feedback. ```APIDOC ## StartRendering([jobIds...], isInteractiveMode=False) ### Description Starts rendering jobs indicated by the input job IDs. The optional `isInteractiveMode` enables error feedback in the UI during rendering. ### Parameters #### Path Parameters - **[jobIds...]** (string) - Required - A list of job IDs for the renders to start. - **isInteractiveMode** (Bool) - Optional - If set to True, enables error feedback in the UI during rendering. Defaults to False. ### Returns - Bool: True if rendering was initiated successfully, False otherwise. ``` -------------------------------- ### Timeline - GetStartTimecode Source: https://extremraym.com/cloud/resolve-scripting-doc Retrieves the start timecode for the timeline. ```APIDOC ## GetStartTimecode() ### Description Returns the start timecode for the timeline. ### Return - **string** - The start timecode of the timeline. ``` -------------------------------- ### Set Timeline Item Property Example Source: https://extremraym.com/cloud/resolve-scripting-doc Demonstrates how to set various properties of a timeline item using key-value pairs or a dictionary. Ensure values are within the specified ranges. ```python item: TimelineItem # Set a property using key and value item.SetProperty("Pan", 1.5) # Set multiple properties using a dictionary properties = { "Tilt": -0.5, "ZoomX": 50.0, "RotationAngle": 90.0 } item.SetProperty(properties) ``` -------------------------------- ### GetName() Source: https://extremraym.com/cloud/resolve-scripting-doc Gets the name of the current project. ```APIDOC ## GetName() ### Description Returns the project name. ### Returns - string: The name of the project. ``` -------------------------------- ### Prerequisites for DaVinci Resolve Scripting Source: https://extremraym.com/cloud/resolve-scripting-doc Lists the required software installations for DaVinci Resolve scripting. Ensure one of these versions is installed for all users. ```plaintext Lua 5.1 Python >= 3.6 64-bit Python 2.7 64-bit ``` -------------------------------- ### TimelineItem.GetStart Source: https://extremraym.com/cloud/resolve-scripting-doc Retrieves the start frame position of a timeline item on the timeline, with optional subframe precision. ```APIDOC ## TimelineItem.GetStart(subframe_precision) ### Description Returns the start frame position of the timeline item on the timeline. Returns fractional frames if subframe_precision is True. ### Method TimelineItem.GetStart ### Parameters #### Path Parameters - **subframe_precision** (boolean) - Optional - If True, returns fractional frames. ``` -------------------------------- ### TimelineItem.GetSourceStartTime Source: https://extremraym.com/cloud/resolve-scripting-doc Retrieves the start time position of the media pool clip within the timeline clip. ```APIDOC ## TimelineItem.GetSourceStartTime() ### Description Returns the start time position of the media pool clip in the timeline clip. ### Method TimelineItem.GetSourceStartTime ### Returns - **float** - The start time position of the source media. ``` -------------------------------- ### Project Settings Source: https://extremraym.com/cloud/resolve-scripting-doc Allows getting and setting project-level settings. These correspond to properties available in the Project Settings dialog. ```APIDOC ## Project:GetSetting ### Description Retrieves the value of a specific project setting. ### Method Project:GetSetting(settingName) ### Parameters #### Path Parameters - **settingName** (string) - Required - The key of the project setting to retrieve. ### Response #### Success Response - Returns the value of the specified project setting. Returns a trivial result for invalid keys. ## Project:SetSetting ### Description Sets the value of a specific project setting. ### Method Project:SetSetting(settingName, value, [additional_args...]) ### Parameters #### Path Parameters - **settingName** (string) - Required - The key of the project setting to set. - **value** (any) - Required - The value to set for the project setting. - **additional_args** (any) - Optional - Additional arguments for specific settings like 'superScale' or 'timelineFrameRate'. ### Response #### Success Response - Returns a value indicating the success of the operation. Check the return value to ensure the operation was successful. ### Enumerated Values #### `superScale` - **Value**: An enumerated integer between 0 and 4. - 0: Auto - 1: No scaling - 2, 3, 4: Super Scale multipliers (2x, 3x, 4x) - **Special Case '2x Enhanced'**: `Project:SetSetting('superScale', 2, sharpnessValue, noiseReductionValue)` - `sharpnessValue` (float, 0.0 to 1.0) - `noiseReductionValue` (float, 0.0 to 1.0) #### `timelineFrameRate` - **Value**: A string representing a frame rate available in project settings. - **Drop Frame**: Append "DF" to the frame rate string (e.g., "29.97 DF") to enable drop frame. ``` -------------------------------- ### AnalyzeForSlate Source: https://extremraym.com/cloud/resolve-scripting-doc Performs Slate analysis on a MediaPoolItem using current settings and a specified marker color. Returns true if successful and required packages are installed. ```APIDOC ## AnalyzeForSlate(markerColor) ### Description Performs Slate analysis on the MediaPoolItem using the current settings and specified markerColor. Returns True if required packages are installed and analysis is successful. ### Parameters - **markerColor** (string) - The color of the marker to use for Slate analysis. ### Return - **Bool** - True if required packages are installed and analysis is successful. ``` -------------------------------- ### Timeline - GetStartFrame Source: https://extremraym.com/cloud/resolve-scripting-doc Retrieves the frame number at the start of the timeline. ```APIDOC ## GetStartFrame() ### Description Returns the frame number at the start of the timeline. ### Return - **int** - The starting frame number. ``` -------------------------------- ### TimelineItem.GetSourceStartFrame Source: https://extremraym.com/cloud/resolve-scripting-doc Retrieves the start frame position of the media pool clip within the timeline clip. ```APIDOC ## TimelineItem.GetSourceStartFrame() ### Description Returns the start frame position of the media pool clip in the timeline clip. ### Method TimelineItem.GetSourceStartFrame ### Returns - **integer** - The start frame position of the source media. ``` -------------------------------- ### AddItemListToMediaPool (array of itemInfos) Source: https://extremraym.com/cloud/resolve-scripting-doc Adds a list of items specified as dictionaries containing media path, start frame, and end frame from Media Storage into the current Media Pool folder. Returns a list of the created MediaPoolItems. ```APIDOC ## AddItemListToMediaPool([{itemInfo}, ...]) ### Description Adds a list of itemInfos specified as dict of `media`, `startFrame` (int), `endFrame` (int) from Media Storage into the current Media Pool folder. Returns a list of the MediaPoolItems created. ### Parameters #### Path Parameters - **itemInfo** (object) - Required - An object with keys `media` (string), `startFrame` (int), and `endFrame` (int) specifying the item to add. ### Returns - **[clips...]** - A list of the MediaPoolItems created. ``` -------------------------------- ### Timeline Settings Source: https://extremraym.com/cloud/resolve-scripting-doc Allows getting and setting timeline-level settings. These correspond to properties available in the Timeline Settings dialog. ```APIDOC ## Timeline:GetSetting ### Description Retrieves the value of a specific timeline setting. ### Method Timeline:GetSetting(settingName) ### Parameters #### Path Parameters - **settingName** (string) - Required - The key of the timeline setting to retrieve. ### Response #### Success Response - Returns the value of the specified timeline setting. Returns a trivial result for invalid keys. ## Timeline:SetSetting ### Description Sets the value of a specific timeline setting. ### Method Timeline:SetSetting(settingName, value) ### Parameters #### Path Parameters - **settingName** (string) - Required - The key of the timeline setting to set. - **value** (any) - Required - The value to set for the timeline setting. ### Response #### Success Response - Returns a value indicating the success of the operation. Check the return value to ensure the operation was successful. ### Enumerated Values #### `timelineFrameRate` - **Value**: A string representing a frame rate available in project settings. - **Drop Frame**: Append "DF" to the frame rate string (e.g., "29.97 DF") to enable drop frame. ``` -------------------------------- ### Timeline - SetStartTimecode Source: https://extremraym.com/cloud/resolve-scripting-doc Sets the start timecode of the timeline. Returns true if the change is successful. ```APIDOC ## SetStartTimecode(timecode) ### Description Set the start timecode of the timeline to the string `timecode`. Returns true when the change is successful, false otherwise. ### Parameters - **timecode** (string) - The desired start timecode for the timeline. ### Return - **Bool** - True if the timecode was set successfully, false otherwise. ``` -------------------------------- ### AddTake Source: https://extremraym.com/cloud/resolve-scripting-doc Adds a media pool item as a new take to the timeline item. Optionally specifies start and end frames for the take. ```APIDOC ## AddTake ### Description Adds mediaPoolItem as a new take. Initializes a take selector for the timeline item if needed. By default, the full clip extents is added. startFrame (int) and endFrame (int) are optional arguments used to specify the extents. ### Method `AddTake(mediaPoolItem, startFrame, endFrame)` ### Parameters - **mediaPoolItem**: The media pool item to add as a take. - **startFrame** (int, optional): The starting frame for the take. - **endFrame** (int, optional): The ending frame for the take. ### Returns - **Bool**: True if the take was added successfully, False otherwise. ``` -------------------------------- ### Create a Simple DaVinci Resolve Project (Python) Source: https://extremraym.com/cloud/resolve-scripting-doc This Python script demonstrates how to create a new project named 'Hello World' using the DaVinci Resolve scripting API. Ensure the Resolve application is running before execution. ```python #!/usr/bin/env python import DaVinciResolveScript as dvr_script resolve = dvr_script.scriptapp("Resolve") fusion = resolve.Fusion() projectManager = resolve.GetProjectManager() projectManager.CreateProject("Hello World") ``` -------------------------------- ### CreateProject Source: https://extremraym.com/cloud/resolve-scripting-doc Creates a new project with a given name and an optional media location path. Returns the created project or None if the name is not unique. ```APIDOC ## CreateProject ### Description Creates and returns a project if projectName (string) is unique, and None if it is not. Accepts an optional argument to set the media location path. ### Method `CreateProject(projectName, mediaLocationPath)` ### Parameters - **projectName** (string) - Required - The name for the new project. - **mediaLocationPath** (string) - Optional - The path for the project's media location. ### Return - **Project** - The created project object, or None if the project name is not unique. ``` -------------------------------- ### Set DaVinci Resolve Scripting Environment Variables (Linux) Source: https://extremraym.com/cloud/resolve-scripting-doc Configure these environment variables to allow your Python installation to find DaVinci Resolve scripting dependencies on Linux. Note that paths may vary based on installation. ```bash RESOLVE_SCRIPT_API="/opt/resolve/Developer/Scripting" RESOLVE_SCRIPT_LIB="/opt/resolve/libs/Fusion/fusionscript.so" PYTHONPATH="$PYTHONPATH:$RESOLVE_SCRIPT_API/Modules/" ``` -------------------------------- ### GetPresetList() Source: https://extremraym.com/cloud/resolve-scripting-doc Retrieves a list of all available presets and their associated information. ```APIDOC ## GetPresetList() ### Description Returns a list of presets and their information. ### Returns - [presets...]: A list containing information about available presets. ``` -------------------------------- ### Project.GetPresets Source: https://extremraym.com/cloud/resolve-scripting-doc Retrieves a dictionary of all available presets and their associated information. ```APIDOC ## Project.GetPresets() ### Description Returns a dictionary that lists all available presets and their details. ### Return - {presets...} (dict) ``` -------------------------------- ### StartRendering(jobId1, jobId2, ...) Source: https://extremraym.com/cloud/resolve-scripting-doc Initiates the rendering process for specified render jobs. ```APIDOC ## StartRendering(jobId1, jobId2, ...) ### Description Starts rendering jobs indicated by the input job IDs. ### Parameters #### Path Parameters - **jobId1, jobId2, ...** (string) - Required - One or more job IDs of the renders to start. ### Returns - Bool: True if rendering was initiated successfully, False otherwise. ``` -------------------------------- ### TimelineItem Properties Source: https://extremraym.com/cloud/resolve-scripting-doc Methods for getting and setting properties of a timeline item. ```APIDOC ## GetProperty(propertyKey) ### Description Returns the value of the specified key. If no key is specified, returns a dictionary (Python) or table (Lua) for all supported keys. ### Method GetProperty ### Parameters #### Path Parameters - **propertyKey** (string) - Optional - The key of the property to retrieve. ``` -------------------------------- ### GetSetting(settingName) Source: https://extremraym.com/cloud/resolve-scripting-doc Retrieves the value of a specific project setting. ```APIDOC ## GetSetting(settingName) ### Description Returns the value of a project setting indicated by `settingName`. ### Parameters #### Path Parameters - **settingName** (string) - Required - The name of the project setting to retrieve. ### Returns - string: The value of the specified project setting. Check the section below for more information. ``` -------------------------------- ### GetMountedVolumes() Source: https://extremraym.com/cloud/resolve-scripting-doc Deprecated function to get paths of mounted volumes in Media Storage. ```python `GetMountedVolumes()` ``` -------------------------------- ### Voice Isolation Source: https://extremraym.com/cloud/resolve-scripting-doc Methods for getting and setting the Voice Isolation state and amount. ```APIDOC ## GetVoiceIsolationState ### Description Returns the current Voice Isolation state, including whether it is enabled and the amount. ### Method `GetVoiceIsolationState()` ### Returns - **{VoiceIsolationState}**: A dictionary containing `isEnabled` (bool) and `amount` (int). ``` ```APIDOC ## SetVoiceIsolationState ### Description Sets the Voice Isolation state for the timeline item. Requires 'Studio and AI Scripting APIs' prerequisites. ### Method `SetVoiceIsolationState({VoiceIsolationState})` ### Parameters - **{VoiceIsolationState}** (dict): A dictionary with `isEnabled` (bool) and `amount` (int, range 0-100). ### Returns - **Bool**: True if the state was set successfully, False otherwise. ``` -------------------------------- ### Cloud Project Settings Dictionary Source: https://extremraym.com/cloud/resolve-scripting-doc Dictionary keys for configuring cloud project settings. These are used when loading, creating, importing, or restoring cloud projects. ```python * `resolve.CLOUD_SETTING_PROJECT_NAME`: String, [`` by default] * `resolve.CLOUD_SETTING_PROJECT_MEDIA_PATH`: String, [`` by default] * `resolve.CLOUD_SETTING_IS_COLLAB`: Bool, [False by default] * `resolve.CLOUD_SETTING_SYNC_MODE`: syncMode (see below), [`resolve.CLOUD_SYNC_PROXY_ONLY` by default] * `resolve.CLOUD_SETTING_IS_CAMERA_ACCESS`: Bool [False by default] ``` -------------------------------- ### Clip Enabled Status Source: https://extremraym.com/cloud/resolve-scripting-doc Methods for getting and setting the enabled status of a clip. ```APIDOC ## SetClipEnabled ### Description Sets the enabled status of the clip. ### Method `SetClipEnabled(Bool)` ### Parameters - **Bool**: True to enable the clip, False to disable it. ### Returns - **Bool**: True if the status was set successfully, False otherwise. ``` ```APIDOC ## GetClipEnabled ### Description Gets the enabled status of the clip. ### Method `GetClipEnabled()` ### Returns - **Bool**: The current enabled status of the clip. ``` -------------------------------- ### TimelineItem.GetNumNodes() Source: https://extremraym.com/cloud/resolve-scripting-doc Deprecated function to get the number of nodes in the current graph for a timeline item. ```python `GetNumNodes()` ``` -------------------------------- ### TimelineItem.GetFusionCompNames() Source: https://extremraym.com/cloud/resolve-scripting-doc Deprecated function to get Fusion composition names associated with a timeline item. ```python `GetFusionCompNames()` ``` -------------------------------- ### CreateCloudProject Source: https://extremraym.com/cloud/resolve-scripting-doc Creates and returns a cloud project based on the provided cloud settings. ```APIDOC ## CreateCloudProject ### Description Creates and returns a cloud project. ### Method `CreateCloudProject({cloudSettings})` ### Parameters - **{cloudSettings}** (object) - Required - Cloud project settings. Refer to 'Cloud Projects Settings' subsection for details. ### Return - **Project** - The created cloud project object. ``` -------------------------------- ### GetRenderPresetList() Source: https://extremraym.com/cloud/resolve-scripting-doc Fetches a list of available render presets and their configurations. ```APIDOC ## GetRenderPresetList() ### Description Returns a list of render presets and their information. ### Returns - [presets...]: A list containing information about available render presets. ``` -------------------------------- ### SetRenderSettings({settings}) Source: https://extremraym.com/cloud/resolve-scripting-doc Configures the rendering settings using a dictionary of parameters. ```APIDOC ## SetRenderSettings({settings}) ### Description Sets the given settings for rendering. Settings is a dictionary with supported keys. ### Parameters #### Path Parameters - **settings** (dict) - Required - A dictionary containing render settings. Refer to section "Looking up render settings" for information on supported settings. ### Returns - Bool: True if the settings were applied successfully, False otherwise. ``` -------------------------------- ### GotoRootFolder Source: https://extremraym.com/cloud/resolve-scripting-doc Navigates to the root folder in the database. ```APIDOC ## GotoRootFolder ### Description Opens root folder in database. ### Method `GotoRootFolder()` ### Return - **Bool** - True if successful, False otherwise. ``` -------------------------------- ### TimelineItem.GetLUT(nodeIndex) Source: https://extremraym.com/cloud/resolve-scripting-doc Deprecated function to get the relative LUT path for a given node index. ```python `GetLUT(nodeIndex)` ``` -------------------------------- ### GetSubFolders(folderPath) Source: https://extremraym.com/cloud/resolve-scripting-doc Deprecated function to get subfolder paths within a given folder path. ```python `GetSubFolders(folderPath)` ``` -------------------------------- ### LoadCloudProject Source: https://extremraym.com/cloud/resolve-scripting-doc Loads and returns a cloud project based on the provided cloud settings. Returns None if no matching cloud project is found. ```APIDOC ## LoadCloudProject ### Description Loads and returns a cloud project with the following cloud settings if there is a match found, and None if there is no matching cloud project. ### Method `LoadCloudProject({cloudSettings})` ### Parameters - **{cloudSettings}** (object) - Required - Cloud project settings. Refer to 'Cloud Projects Settings' subsection for details. ### Return - **Project** - The loaded cloud project object, or None if no matching project is found. ``` -------------------------------- ### GetSetting Source: https://extremraym.com/cloud/resolve-scripting-doc Returns the value of a timeline setting indicated by settingName. ```APIDOC ## GetSetting(settingName) ### Description Returns value of timeline setting (indicated by settingName : string). Check the section below for more information. ### Method Not specified (assumed to be a direct function call in a scripting environment) ### Parameters * **settingName** (string) - The name of the timeline setting to retrieve. ### Response #### Success Response * **value** (string) - The value of the specified timeline setting. ``` -------------------------------- ### LoadProject Source: https://extremraym.com/cloud/resolve-scripting-doc Loads and returns a project by its name. Returns None if no matching project is found. ```APIDOC ## LoadProject ### Description Loads and returns the project with name = projectName (string) if there is a match found, and None if there is no matching Project. ### Method `LoadProject(projectName)` ### Parameters - **projectName** (string) - Required - The name of the project to load. ### Return - **Project** - The loaded project object, or None if no matching project is found. ``` -------------------------------- ### Timeline.GetItemsInTrack(trackType, index) Source: https://extremraym.com/cloud/resolve-scripting-doc Deprecated function to get timeline items on a specific video or audio track. ```python `GetItemsInTrack(trackType, index)` ``` -------------------------------- ### AutoSyncAudio Source: https://extremraym.com/cloud/resolve-scripting-doc Synchronizes audio for specified media pool items. ```APIDOC ## AutoSyncAudio ### Description Syncs audio for specified [MediaPoolItems] (list). The list must contain a minimum of two MediaPoolItems - at least one video and one audio clip. Returns True if successful. Refer to 'Audio Sync Settings' section for details. ### Parameters - **MediaPoolItems** ([MediaPoolItem]) - A list of media pool items to sync audio for. - **audioSyncSettings** ({audioSyncSettings}) - Optional settings for audio synchronization. ### Return Bool - True if audio synchronization was successful, False otherwise. ``` -------------------------------- ### RenderWithQuickExport(preset_name, {param_dict}) Source: https://extremraym.com/cloud/resolve-scripting-doc Initiates a quick export render for the current timeline using a specified preset and optional parameters. ```APIDOC ## RenderWithQuickExport(preset_name, {param_dict}) ### Description Starts a quick export render for the current active timeline. `preset_name` must be from the `GetQuickExportRenderPresets` list. `param_dict` supports render settings keys like `TargetDir`, `CustomName`, `VideoQuality`, and `EnableUpload`. The `EnableUpload` key allows direct upload for supported web presets. ### Parameters #### Path Parameters - **preset_name** (string) - Required - The name of the Quick Export render preset to use. - **param_dict** (dict) - Optional - A dictionary supporting render settings keys such as `TargetDir`, `CustomName`, `VideoQuality`, and `EnableUpload`. ### Returns - {status info}: A dictionary with job status and render time, or an error string if the render failed or was not attempted. Refer to section "Looking up Render Settings" for information on supported settings. ``` -------------------------------- ### OpenFolder Source: https://extremraym.com/cloud/resolve-scripting-doc Opens the specified folder. ```APIDOC ## OpenFolder ### Description Opens folder under given name. ### Method `OpenFolder(folderName)` ### Parameters - **folderName** (string) - Required - The name of the folder to open. ### Return - **Bool** - True if the folder was opened successfully, False otherwise. ``` -------------------------------- ### TimelineItem.GetVersionNames(versionType) Source: https://extremraym.com/cloud/resolve-scripting-doc Deprecated function to get version names for a timeline item, specifying local (0) or remote (1) versions. ```python `GetVersionNames(versionType)` ``` -------------------------------- ### GetPresets() Source: https://extremraym.com/cloud/resolve-scripting-doc Deprecated function to retrieve project presets and their information. ```python `GetPresets()` ``` -------------------------------- ### GetMediaPool() Source: https://extremraym.com/cloud/resolve-scripting-doc Returns the Media Pool object for the current project. ```APIDOC ## GetMediaPool() ### Description Returns the Media Pool object. ### Returns - MediaPool: The Media Pool object. ``` -------------------------------- ### Take Management Source: https://extremraym.com/cloud/resolve-scripting-doc Methods for managing takes within a timeline item, including getting counts, retrieving take information, deleting, selecting, and finalizing takes. ```APIDOC ## Take Management ### GetSelectedTakeIndex ### Description Returns the index of the currently selected take, or 0 if the clip is not a take selector. ### Method `GetSelectedTakeIndex()` ### Returns - **int**: The index of the selected take, or 0. ``` ```APIDOC ## GetTakesCount ### Description Returns the number of takes in the take selector, or 0 if the clip is not a take selector. ### Method `GetTakesCount()` ### Returns - **int**: The number of takes. ``` ```APIDOC ## GetTakeByIndex ### Description Returns information about a specific take by its index. ### Method `GetTakeByIndex(idx)` ### Parameters - **idx** (int): The index of the take to retrieve. ### Returns - **{takeInfo...}**: A dictionary containing `startFrame`, `endFrame`, and `mediaPoolItem` for the specified take. ``` ```APIDOC ## DeleteTakeByIndex ### Description Deletes a take from the timeline item by its index. ### Method `DeleteTakeByIndex(idx)` ### Parameters - **idx** (int): The index of the take to delete (1-based). ### Returns - **Bool**: True if the take was deleted successfully, False otherwise. ``` ```APIDOC ## SelectTakeByIndex ### Description Selects a specific take by its index. ### Method `SelectTakeByIndex(idx)` ### Parameters - **idx** (int): The index of the take to select (1-based). ### Returns - **Bool**: True if the take was selected successfully, False otherwise. ``` ```APIDOC ## FinalizeTake ### Description Finalizes the current take selection. ### Method `FinalizeTake()` ### Returns - **Bool**: True if the take selection was finalized successfully, False otherwise. ``` -------------------------------- ### ImportProject Source: https://extremraym.com/cloud/resolve-scripting-doc Imports a project from a specified file path, with an optional project name. Returns True if the import is successful. ```APIDOC ## ImportProject ### Description Imports a project from the file path provided with given project name, if any. Returns True if successful. ### Method `ImportProject(filePath, projectName=None)` ### Parameters - **filePath** (string) - Required - The path to the project file to import. - **projectName** (string) - Optional - The name to assign to the imported project. ### Return - **Bool** - True if the import was successful, False otherwise. ``` -------------------------------- ### Unsupported Export Types in DaVinci Resolve Source: https://extremraym.com/cloud/resolve-scripting-doc Starting with DaVinci Resolve 18.1, these FCPXML export types are no longer supported. Use these for reference to avoid errors. ```plaintext - `resolve.EXPORT_FCPXML_1_3` - `resolve.EXPORT_FCPXML_1_4` - `resolve.EXPORT_FCPXML_1_5` - `resolve.EXPORT_FCPXML_1_6` - `resolve.EXPORT_FCPXML_1_7` ``` -------------------------------- ### GetRenderFormats() Source: https://extremraym.com/cloud/resolve-scripting-doc Retrieves a dictionary of available render formats and their corresponding file extensions. ```APIDOC ## GetRenderFormats() ### Description Returns a dictionary mapping render formats to their file extensions. ### Returns - {render formats..}: A dictionary where keys are format names and values are their file extensions. ``` -------------------------------- ### Set DaVinci Resolve Scripting Environment Variables (Windows) Source: https://extremraym.com/cloud/resolve-scripting-doc Configure these environment variables to allow your Python installation to find DaVinci Resolve scripting dependencies on Windows. ```bash RESOLVE_SCRIPT_API="%PROGRAMDATA%\Blackmagic Design\DaVinci Resolve\Support\Developer\Scripting" RESOLVE_SCRIPT_LIB="C:\Program Files\Blackmagic Design\DaVinci Resolve\fusionscript.dll" PYTHONPATH="%PYTHONPATH%;%RESOLVE_SCRIPT_API%\Modules\" ``` -------------------------------- ### Media Pool Item Clip Properties Source: https://extremraym.com/cloud/resolve-scripting-doc Allows getting and setting clip properties for media pool items. These correspond to properties available in the Clip Attributes dialog. ```APIDOC ## MediaPoolItem:GetClipProperty ### Description Retrieves the value of a specific clip property for a media pool item. ### Method MediaPoolItem:GetClipProperty(propertyName) ### Parameters #### Path Parameters - **propertyName** (string) - Required - The key of the clip property to retrieve. ### Response #### Success Response - Returns the value of the specified clip property. Returns a trivial result for invalid keys. ## MediaPoolItem:SetClipProperty ### Description Sets the value of a specific clip property for a media pool item. ### Method MediaPoolItem:SetClipProperty(propertyName, value, [additional_args...]) ### Parameters #### Path Parameters - **propertyName** (string) - Required - The key of the clip property to set. - **value** (any) - Required - The value to set for the clip property. - **additional_args** (any) - Optional - Additional arguments for specific properties like 'Super Scale'. ### Response #### Success Response - Returns a value indicating the success of the operation. Check the return value to ensure the operation was successful. ### Enumerated Values #### "Super Scale" - **Value**: An enumerated integer between 1 and 4. - 1: No scaling - 2, 3, 4: Super Scale multipliers (2x, 3x, 4x) - **Special Case '2x Enhanced'**: `MediaPoolItem:SetClipProperty('Super Scale', 2, sharpnessValue, noiseReductionValue)` - `sharpnessValue` (float, 0.0 to 1.0) - `noiseReductionValue` (float, 0.0 to 1.0) #### "Cloud Sync" - **Value**: An enumerated integer corresponding to cloud sync states: - `resolve.CLOUD_SYNC_DEFAULT` == -1 - `resolve.CLOUD_SYNC_DOWNLOAD_IN_QUEUE` == 0 - `resolve.CLOUD_SYNC_DOWNLOAD_IN_PROGRESS` == 1 - `resolve.CLOUD_SYNC_DOWNLOAD_SUCCESS` == 2 - `resolve.CLOUD_SYNC_DOWNLOAD_FAIL` == 3 - `resolve.CLOUD_SYNC_DOWNLOAD_NOT_FOUND` == 4 - `resolve.CLOUD_SYNC_UPLOAD_IN_QUEUE` == 5 - `resolve.CLOUD_SYNC_UPLOAD_IN_PROGRESS` == 6 - `resolve.CLOUD_SYNC_UPLOAD_SUCCESS` == 7 - `resolve.CLOUD_SYNC_UPLOAD_FAIL` == 8 - `resolve.CLOUD_SYNC_UPLOAD_NOT_FOUND` == 9 - `resolve.CLOUD_SYNC_SUCCESS` == 10 ``` -------------------------------- ### GetQuickExportRenderPresets() Source: https://extremraym.com/cloud/resolve-scripting-doc Fetches a list of names for available Quick Export render presets. ```APIDOC ## GetQuickExportRenderPresets() ### Description Returns a list of Quick Export render presets by name. ### Returns - [preset_name..]: A list of strings, where each string is the name of a Quick Export render preset. ``` -------------------------------- ### CreateFolder Source: https://extremraym.com/cloud/resolve-scripting-doc Creates a new folder if the specified folder name is unique. ```APIDOC ## CreateFolder ### Description Creates a folder if folderName (string) is unique. ### Method `CreateFolder(folderName)` ### Parameters - **folderName** (string) - Required - The name of the folder to create. ### Return - **Bool** - True if the folder was created successfully, False otherwise. ``` -------------------------------- ### Set DaVinci Resolve Scripting Environment Variables (Mac OS X) Source: https://extremraym.com/cloud/resolve-scripting-doc Configure these environment variables to allow your Python installation to find DaVinci Resolve scripting dependencies on Mac OS X. ```bash RESOLVE_SCRIPT_API="/Library/Application Support/Blackmagic Design/DaVinci Resolve/Developer/Scripting" RESOLVE_SCRIPT_LIB="/Applications/DaVinci Resolve/DaVinci Resolve.app/Contents/Libraries/Fusion/fusionscript.so" PYTHONPATH="$PYTHONPATH:$RESOLVE_SCRIPT_API/Modules/" ``` -------------------------------- ### Cloud Projects Settings Source: https://extremraym.com/cloud/resolve-scripting-doc Information on functions for managing cloud projects: `ProjectManager:LoadCloudProject`, `ProjectManager:CreateCloudProject`, `ProjectManager:ImportCloudProject`, and `ProjectManager:RestoreCloudProject`. ```APIDOC ## Cloud Project Management Functions ### Description Functions for loading, creating, importing, and restoring cloud projects. ### Methods * `ProjectManager:LoadCloudProject(cloudSettings)` * `ProjectManager:CreateCloudProject(cloudSettings)` * `ProjectManager:ImportCloudProject(cloudSettings)` * `ProjectManager:RestoreCloudProject(cloudSettings)` ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body * `cloudSettings` (dict) - Required - A dictionary containing settings for cloud projects. Keys include: * `resolve.CLOUD_SETTING_PROJECT_NAME` (String, default: "") * `resolve.CLOUD_SETTING_PROJECT_MEDIA_PATH` (String, default: "") * `resolve.CLOUD_SETTING_IS_COLLAB` (Bool, default: False) * `resolve.CLOUD_SETTING_SYNC_MODE` (syncMode enum, default: `resolve.CLOUD_SYNC_PROXY_ONLY`) * `resolve.CLOUD_SETTING_IS_CAMERA_ACCESS` (Bool, default: False) `syncMode` can be one of: * `resolve.CLOUD_SYNC_NONE` * `resolve.CLOUD_SYNC_PROXY_ONLY` * `resolve.CLOUD_SYNC_PROXY_AND_ORIG` **Note:** - `ProjectManager:LoadCloudProject` and `ProjectManager:CreateCloudProject` require `resolve.PROJECT_NAME` to be defined. - All four functions require `resolve.PROJECT_MEDIA_PATH` to be defined. - `ProjectManager:LoadCloudProject` has specific behavior for subsequent loads regarding honored settings. ### Request Example ```python cloud_settings = { "resolve.CLOUD_SETTING_PROJECT_NAME": "MyCloudProject", "resolve.CLOUD_SETTING_PROJECT_MEDIA_PATH": "/path/to/media", "resolve.CLOUD_SETTING_IS_COLLAB": True, "resolve.CLOUD_SETTING_SYNC_MODE": "resolve.CLOUD_SYNC_PROXY_ONLY" } # Example for creating a cloud project ProjectManager:CreateCloudProject(cloud_settings) ``` ### Response #### Success Response (200) Details of the response are not specified in the source. ``` -------------------------------- ### Project.GetRenderPresets Source: https://extremraym.com/cloud/resolve-scripting-doc Retrieves a dictionary of all render presets and their associated information. ```APIDOC ## Project.GetRenderPresets() ### Description Returns a dictionary that lists all available render presets and their details. ### Return - {presets...} (dict) ``` -------------------------------- ### AddTimelineMattesToMediaPool Source: https://extremraym.com/cloud/resolve-scripting-doc Adds specified media files as timeline mattes into the current media pool folder. Returns a list of the created MediaPoolItems. ```APIDOC ## AddTimelineMattesToMediaPool([paths]) ### Description Adds specified media files as timeline mattes in the current media pool folder. ### Parameters #### Path Parameters - **paths** (array of strings) - Required - A list of paths to the media files to be added as timeline mattes. ### Returns - **[MediaPoolItems]** - A list of the created MediaPoolItems. ``` -------------------------------- ### GetRenderResolutions(format, codec) Source: https://extremraym.com/cloud/resolve-scripting-doc Fetches a list of applicable resolutions for a given render format and codec, or all resolutions if no arguments are provided. ```APIDOC ## GetRenderResolutions(format, codec) ### Description Returns a list of resolutions applicable for the given render format and render codec. Returns the full list of resolutions if no arguments are provided. Each element in the list is a dictionary with `Width` and `Height` keys. ### Parameters #### Path Parameters - **format** (string) - Optional - The render format for which to list resolutions. - **codec** (string) - Optional - The render codec for which to list resolutions. ### Returns - [{Resolution}]: A list of dictionaries, where each dictionary represents a resolution with `Width` and `Height` keys. ``` -------------------------------- ### SetPreset(presetName) Source: https://extremraym.com/cloud/resolve-scripting-doc Applies a specified preset to the project. ```APIDOC ## SetPreset(presetName) ### Description Sets the project's preset to the one specified by presetName. ### Parameters #### Path Parameters - **presetName** (string) - Required - The name of the preset to apply. ### Returns - Bool: True if the preset was successfully applied, False otherwise. ``` -------------------------------- ### SetMarkInOut Source: https://extremraym.com/cloud/resolve-scripting-doc Sets the in and out marks for video, audio, or all tracks on the timeline. ```APIDOC ## SetMarkInOut(in, out, type=`all`) ### Description Sets the mark in/out for the specified type. ### Method SetMarkInOut ### Parameters #### Path Parameters - **in** (integer) - Required - The in-point frame number. - **out** (integer) - Required - The out-point frame number. - **type** (string) - Optional - The type of mark to set: 'video', 'audio', or 'all' (default). ``` -------------------------------- ### ArchiveProject Source: https://extremraym.com/cloud/resolve-scripting-doc Archives a project to a specified file path with configurable options for including source media and render cache. ```APIDOC ## ArchiveProject ### Description Archives project to provided file path with the configuration as provided by the optional arguments. ### Method `ArchiveProject(projectName, filePath, isArchiveSrcMedia=True, isArchiveRenderCache=True, isArchiveProxyMedia=False)` ### Parameters - **projectName** (string) - Required - The name of the project to archive. - **filePath** (string) - Required - The file path to archive the project to. - **isArchiveSrcMedia** (bool) - Optional - Whether to archive source media. Defaults to True. - **isArchiveRenderCache** (bool) - Optional - Whether to archive render cache. Defaults to True. - **isArchiveProxyMedia** (bool) - Optional - Whether to archive proxy media. Defaults to False. ### Return - **Bool** - True if successful, False otherwise. ``` -------------------------------- ### GetGallery() Source: https://extremraym.com/cloud/resolve-scripting-doc Retrieves the Gallery object associated with the project. ```APIDOC ## GetGallery() ### Description Returns the Gallery object. ### Returns - Gallery: The Gallery object. ``` -------------------------------- ### GotoParentFolder Source: https://extremraym.com/cloud/resolve-scripting-doc Navigates to the parent folder of the current folder, if a parent exists. ```APIDOC ## GotoParentFolder ### Description Opens parent folder of current folder in database if current folder has parent. ### Method `GotoParentFolder()` ### Return - **Bool** - True if successful, False otherwise. ``` -------------------------------- ### ImportCloudProject Source: https://extremraym.com/cloud/resolve-scripting-doc Imports a cloud project from a specified file path. Returns True if the import is successful, False otherwise. ```APIDOC ## ImportCloudProject ### Description Returns True if import cloud project is successful; False otherwise. ### Method `ImportCloudProject(filePath, {cloudSettings})` ### Parameters - **filePath** (string) - Required - The file path of the cloud project to import. - **{cloudSettings}** (object) - Required - Cloud project settings. Refer to 'Cloud Projects Settings' subsection for details. ### Return - **Bool** - True if the import was successful, False otherwise. ``` -------------------------------- ### LoadBurnInPreset Source: https://extremraym.com/cloud/resolve-scripting-doc Loads a user-defined data burn-in preset for the project. Returns true if the preset is loaded successfully. ```APIDOC ## LoadBurnInPreset(presetName) ### Description Loads a user-defined data burn-in preset for the project when supplied with a preset name. ### Parameters #### Path Parameters - **presetName** (string) - Required - The name of the preset to load. ### Returns - **Bool** - True if successful, otherwise False. ``` -------------------------------- ### ApplyFairlightPresetToCurrentTimeline Source: https://extremraym.com/cloud/resolve-scripting-doc Applies a Fairlight preset by its name to the current timeline. Returns true if the application was successful, false otherwise. ```APIDOC ## ApplyFairlightPresetToCurrentTimeline(name) ### Description Applies a Fairlight Preset of a given name to the current timeline. ### Parameters #### Path Parameters - **name** (string) - Required - The name of the Fairlight preset to apply. ### Returns - **Bool** - True if successful, False otherwise. ``` -------------------------------- ### GetFileList Source: https://extremraym.com/cloud/resolve-scripting-doc Returns a list of media files and other file listings within a specified absolute folder path. Note that media listings might be consolidated entries. ```APIDOC ## GetFileList(folderPath) ### Description Returns a list of media and file listings in the given absolute folder path. Note that media listings may be logically consolidated entries. ### Parameters #### Path Parameters - **folderPath** (string) - Required - The absolute path of the folder to list files from. ### Returns - **[paths...]** - A list of file and folder paths within the specified directory. ``` -------------------------------- ### ExportProject Source: https://extremraym.com/cloud/resolve-scripting-doc Exports a project to a specified file path, with an option to include stills and LUTs. Returns True if the export is successful. ```APIDOC ## ExportProject ### Description Exports project to provided file path, including stills and LUTs if withStillsAndLUTs is True (enabled by default). Returns True if successful. ### Method `ExportProject(projectName, filePath, withStillsAndLUTs=True)` ### Parameters - **projectName** (string) - Required - The name of the project to export. - **filePath** (string) - Required - The path to save the exported project. - **withStillsAndLUTs** (bool) - Optional - Whether to include stills and LUTs. Defaults to True. ### Return - **Bool** - True if the export was successful, False otherwise. ``` -------------------------------- ### RestoreProject Source: https://extremraym.com/cloud/resolve-scripting-doc Restores a project from a specified file path, with an optional project name. Returns True if the restore operation is successful. ```APIDOC ## RestoreProject ### Description Restores a project from the file path provided with given project name, if any. Returns True if successful. ### Method `RestoreProject(filePath, projectName=None)` ### Parameters - **filePath** (string) - Required - The path to the project file to restore. - **projectName** (string) - Optional - The name to assign to the restored project. ### Return - **Bool** - True if the restore was successful, False otherwise. ``` -------------------------------- ### CreateSubtitlesFromAudio Source: https://extremraym.com/cloud/resolve-scripting-doc Creates subtitles from the audio track of the timeline. Supports optional auto-caption settings. ```APIDOC ## CreateSubtitlesFromAudio({autoCaptionSettings}) ### Description Creates subtitles from audio for the timeline. Takes in optional dictionary {autoCaptionSettings}. Returns True on success, False otherwise. ### Method CreateSubtitlesFromAudio ### Parameters #### Path Parameters - **autoCaptionSettings** (dictionary) - Optional - Settings for automatic captioning. Refer to 'Auto Caption Settings' subsection for details. ``` -------------------------------- ### GrabStill Source: https://extremraym.com/cloud/resolve-scripting-doc Grabs a still image from the current video clip in the timeline. ```APIDOC ## GrabStill() ### Description Grabs a still from the current video clip. Returns a GalleryStill object. ### Method GrabStill ### Returns - **GalleryStill** - An object representing the grabbed still image. ``` -------------------------------- ### CreateFusionClip Source: https://extremraym.com/cloud/resolve-scripting-doc Creates a Fusion clip of input timeline items. It returns the created timeline item. ```APIDOC ## CreateFusionClip([timelineItems]) ### Description Creates a Fusion clip of input timeline items. It returns the created timeline item. ### Method Not specified (assumed to be a direct function call in a scripting environment) ### Parameters * **timelineItems** (array) - An array of timeline items to include in the Fusion clip. ### Response #### Success Response * **timelineItem** (object) - The created Fusion clip timeline item. ``` -------------------------------- ### ExportCurrentFrameAsStill Source: https://extremraym.com/cloud/resolve-scripting-doc Exports the current video frame as a still image to a specified file path. The file path must end with a valid image format extension. Returns true on success, false otherwise. ```APIDOC ## ExportCurrentFrameAsStill(filePath) ### Description Exports the current frame as a still image to the supplied file path. The file path must end in a valid export file format. ### Parameters #### Path Parameters - **filePath** (string) - Required - The full path where the still image will be saved, including the filename and extension. ### Returns - **Bool** - True if successful, False otherwise. ```