DaVinci Resolve Scripting API

https://extremraym.com/cloud/resolve-scripting-doc
Admin
This documentation provides an introduction to the Scripting API for DaVinci Resolve Studio,...
Tokens:65,810
Snippets:456
Trust Score:8.6
Update:1 week ago
Show doc for...
Tokens:
Raw
### StartRendering(isInteractiveMode=False)

Source: https://extremraym.com/cloud/resolve-scripting-doc

Starts rendering all queued render jobs, with optional interactive mode.

```APIDOC
## StartRendering(isInteractiveMode=False)

### Description
Starts rendering all queued render jobs. The optional isInteractiveMode, when set, enables error feedback in the UI during rendering.

### Method
StartRendering

### Parameters
- **isInteractiveMode** (bool) - Optional - Enables error feedback in the UI during rendering.

### Returns
Bool
```

--------------------------------

### RenderWithQuickExport(preset_name, {param_dict})

Source: https://extremraym.com/cloud/resolve-scripting-doc

Starts a quick export render for the current active timeline.

```APIDOC
## RenderWithQuickExport(preset_name, {param_dict})

### Description
Starts a quick export render for the current active timeline. preset_name from GetQuickExportRenderPresets list. param_dict supports render settings keys `TargetDir`, `CustomName`, `VideoQuality`, and `EnableUpload`. `EnableUpload` key enables direct upload for supported web presets. Returns a dict with job status and time taken to render, or an error string if render has failed or not attempted. Refer to section "Looking up Render Settings" for information on the above supported settings.

### Method
RenderWithQuickExport

### Parameters
- **preset_name** (string) - Required - The name of the Quick Export preset.
- **param_dict** (dict) - Required - A dictionary of parameters. Supported keys: `TargetDir`, `CustomName`, `VideoQuality`, `EnableUpload`.

### Returns
{status info}
```

--------------------------------

### Timeline.GetStartTimecode()

Source: https://extremraym.com/cloud/resolve-scripting-doc

Returns the start timecode for the timeline.

```APIDOC
## Timeline.GetStartTimecode()

### Description
Returns the start timecode for the timeline.

### Method
GetStartTimecode

### Endpoint
Timeline.GetStartTimecode()

### Parameters
None

### Response
#### Success Response
- **string** - The start timecode.

#### Response Example
"01:00:00:00"
```

--------------------------------

### Python script to create a project

Source: https://extremraym.com/cloud/resolve-scripting-doc

A minimal Python script that imports DaVinciResolveScript, gets the Resolve application object, and creates a project named "Hello World". Requires DaVinci Resolve to be running and the environment variables set as described above.

```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")
```

--------------------------------

### Folder.AnalyzeForIntellisearch(identifyFaces, isBetterMode)

Source: https://extremraym.com/cloud/resolve-scripting-doc

Performs Intellisearch analysis on all MediaPoolItems in the folder. Returns True if required packages are installed and analysis is successful.

```APIDOC
## Folder.AnalyzeForIntellisearch(identifyFaces, isBetterMode)

### Description
Performs Intellisearch analysis on all MediaPoolItems in the folder.

### Method
AnalyzeForIntellisearch

### Parameters
- **identifyFaces** (bool) - Required - Whether to identify faces.
- **isBetterMode** (bool) - Required - Whether to use Better mode.

### Return
Bool - True if required packages are installed and analysis is successful.

### Notes
Refer to section "Studio and AI Scripting APIs" for prerequisites.
```

--------------------------------

### StartRendering(jobId1, jobId2, ...)

Source: https://extremraym.com/cloud/resolve-scripting-doc

Starts rendering jobs indicated by the input job ids.

```APIDOC
## StartRendering(jobId1, jobId2, ...)

### Description
Starts rendering jobs indicated by the input job ids.

### Method
StartRendering

### Parameters
- **jobId1, jobId2, ...** (string) - Required - One or more job IDs to render.

### Returns
Bool
```

--------------------------------

### MediaPool.ImportMedia([{clipInfo}])

Source: https://extremraym.com/cloud/resolve-scripting-doc

Imports file path(s) into the current Media Pool folder as specified in the list of clipInfo dict. Returns a list of the MediaPoolItems created. Each clipInfo gets imported as one MediaPoolItem unless 'Show Individual Frames' is turned on.

```APIDOC
## ImportMedia([{clipInfo}])

### Description
Imports file path(s) into the current Media Pool folder as specified in the list of clipInfo dict. Returns a list of the MediaPoolItems created. Each clipInfo gets imported as one MediaPoolItem unless 'Show Individual Frames' is turned on.

### Method
ImportMedia

### Parameters
- **clipInfo** (dict) - Required - A dictionary with the following keys:
  - **FilePath** (string) - Required - The file path to import.
  - **StartIndex** (int) - Optional - The start index for image sequences.
  - **EndIndex** (int) - Optional - The end index for image sequences.

### Return Type
[MediaPoolItems]

### Response
#### Success Response
- **[MediaPoolItems]** - List of created media pool items.

### Example
ImportMedia([{`FilePath`:"file_%03d.dpx", `StartIndex`:1, `EndIndex`:100}]) would import clip "file_[001-100].dpx".

```

--------------------------------

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

Source: https://extremraym.com/cloud/resolve-scripting-doc

Starts rendering jobs indicated by the input job ids, with optional interactive mode.

```APIDOC
## StartRendering([jobIds...], isInteractiveMode=False)

### Description
Starts rendering jobs indicated by the input job ids. The optional isInteractiveMode, when set, enables error feedback in the UI during rendering.

### Method
StartRendering

### Parameters
- **jobIds** (array of string) - Required - List of job IDs to render.
- **isInteractiveMode** (bool) - Optional - Enables error feedback in the UI during rendering.

### Returns
Bool
```

--------------------------------

### Folder.AnalyzeForSlate(markerColor)

Source: https://extremraym.com/cloud/resolve-scripting-doc

Performs Slate analysis on all MediaPoolItems in the folder using the current settings and specified markerColor. Returns True if required packages are installed and analysis is successful.

```APIDOC
## Folder.AnalyzeForSlate(markerColor)

### Description
Performs Slate analysis on all MediaPoolItems in the folder using the current settings and specified markerColor.

### Method
AnalyzeForSlate

### Parameters
- **markerColor** (string) - Required - The marker color to use.

### Return
Bool - True if required packages are installed and analysis is successful.

### Notes
Refer to section "Analyze Slate Settings" for information on markerColor. Refer to section "Studio and AI Scripting APIs" for prerequisites.
```

--------------------------------

### GetMarkInOut()

Source: https://extremraym.com/cloud/resolve-scripting-doc

Returns a dictionary of in/out marks set. Keys are omitted if not set. Example: {video: {in: 0, out: 134}, audio: {in: 0, out: 134}}

```APIDOC
## GetMarkInOut()

### Description
Returns a dictionary of in/out marks set. Keys are omitted if not set. Example: {video: {in: 0, out: 134}, audio: {in: 0, out: 134}}

### Method
GetMarkInOut

### Parameters
None

### Returns
- **{mark}** - A dictionary with keys 'video' and/or 'audio', each containing 'in' and 'out' frame numbers.
```

--------------------------------

### MediaPool.GetTimelineMatteList(Folder)

Source: https://extremraym.com/cloud/resolve-scripting-doc

Gets mattes in the specified Folder, as a list of MediaPoolItems.

```APIDOC
## GetTimelineMatteList(Folder)

### Description
Gets mattes in the specified Folder, as a list of MediaPoolItems.

### Method
GetTimelineMatteList

### Parameters
- **Folder** (Folder) - Required - The folder from which to get mattes.

### Return Type
[MediaPoolItems]

### Response
#### Success Response
- **[MediaPoolItems]** - List of media pool items representing mattes.

```

--------------------------------

### MediaPool.GetClipMatteList(MediaPoolItem)

Source: https://extremraym.com/cloud/resolve-scripting-doc

Gets mattes for the specified MediaPoolItem, as a list of paths to the matte files.

```APIDOC
## GetClipMatteList(MediaPoolItem)

### Description
Gets mattes for the specified MediaPoolItem, as a list of paths to the matte files.

### Method
GetClipMatteList

### Parameters
- **MediaPoolItem** (MediaPoolItem) - Required - The media pool item for which to get mattes.

### Return Type
[paths]

### Response
#### Success Response
- **[paths]** - List of file paths to the matte files.

```

--------------------------------

### Timeline.SetStartTimecode(timecode)

Source: https://extremraym.com/cloud/resolve-scripting-doc

Sets the start timecode of the timeline.

```APIDOC
## Timeline.SetStartTimecode(timecode)

### Description
Set the start timecode of the timeline to the string `timecode`. Returns true when the change is successful, false otherwise.

### Method
SetStartTimecode

### Endpoint
Timeline.SetStartTimecode(timecode)

### Parameters
#### Request Body
- **timecode** (string) - Required - The new start timecode.

### Response
#### Success Response
- **Bool** - True if successful, False otherwise.

#### Response Example
true
```

--------------------------------

### Project:GetSetting

Source: https://extremraym.com/cloud/resolve-scripting-doc

Retrieves the value of a project setting identified by a key. Calling without parameters returns a snapshot of all queryable properties.

```APIDOC
## Project:GetSetting

### Description
Retrieves the value of a project setting identified by a key. Calling without parameters returns a snapshot of all queryable properties.

### Method
GetSetting

### Parameters
#### settingName (string) - Optional - The key of the property to retrieve. If omitted, returns all properties.

### Response
#### Success Response
Returns the property value (typically a string or integer). If an invalid key is used, returns a trivial result.

### Example
```
x = Project:GetSetting('superScale')
```
```

--------------------------------

### ProjectManager.CreateProject

Source: https://extremraym.com/cloud/resolve-scripting-doc

Creates a new project with a unique name and optional media location path, returning the created Project object or None if the name is not unique.

```APIDOC
## ProjectManager.CreateProject

### Description
Creates a new project with the given name. The name must be unique; otherwise, None is returned. An optional media location path can be specified.

### Method
CreateProject

### Parameters
- **projectName** (string) - Required - The name of the project to create.
- **mediaLocationPath** (string) - Optional - The path for media storage.

### Return Value
- **Project** - The created Project object, or None if the name is not unique.
```

--------------------------------

### GetPresetList()

Source: https://extremraym.com/cloud/resolve-scripting-doc

Returns a list of presets and their information.

```APIDOC
## GetPresetList()

### Description
Returns a list of presets and their information.

### Method
GetPresetList

### Parameters
None

### Returns
[presets...]
```

--------------------------------

### Timeline.GetStartFrame()

Source: https://extremraym.com/cloud/resolve-scripting-doc

Returns the frame number at the start of the timeline.

```APIDOC
## Timeline.GetStartFrame()

### Description
Returns the frame number at the start of timeline.

### Method
GetStartFrame

### Endpoint
Timeline.GetStartFrame()

### Parameters
None

### Response
#### Success Response
- **int** - The frame number at the start of the timeline.

#### Response Example
100
```

--------------------------------

### Graph.GetLUT(nodeIndex)

Source: https://extremraym.com/cloud/resolve-scripting-doc

Gets the relative LUT path for the specified node.

```APIDOC
## Graph.GetLUT(nodeIndex)

### Description
Gets relative LUT path based on the node index provided.

### Method
GetLUT

### Parameters
- **nodeIndex** (int) - Required - Node index, 1 <= nodeIndex <= total number of nodes.

### Return Type
String

### Returns
Relative LUT path.
```

--------------------------------

### GetSetting(settingName)

Source: https://extremraym.com/cloud/resolve-scripting-doc

Returns the value of a project setting.

```APIDOC
## GetSetting(settingName)

### Description
Returns value of project setting (indicated by settingName, string). Check the section below for more information.

### Method
GetSetting

### Parameters
- **settingName** (string) - Required - The name of the setting.

### Returns
string
```

--------------------------------

### ProjectManager.GotoRootFolder

Source: https://extremraym.com/cloud/resolve-scripting-doc

Opens the root folder in the database.

```APIDOC
## ProjectManager.GotoRootFolder

### Description
Opens the root folder in the database.

### Method
GotoRootFolder

### Parameters
None

### Return Value
- **Bool** - True if successful, False otherwise.
```

--------------------------------

### CreateSubtitlesFromAudio({autoCaptionSettings})

Source: https://extremraym.com/cloud/resolve-scripting-doc

Creates subtitles from audio for the timeline.

```APIDOC
## CreateSubtitlesFromAudio({autoCaptionSettings})

### Description
Creates subtitles from audio for the timeline. Takes in optional dictionary {autoCaptionSettings}. Check 'Auto Caption Settings' subsection below for more information. Returns True on success, False otherwise. Refer to section "Studio and AI Scripting APIs" for prerequisites.

### Method
CreateSubtitlesFromAudio

### Parameters
- **autoCaptionSettings** (dict) - Optional - Dictionary of auto caption settings.

### Returns
Bool - True on success, False otherwise.
```

--------------------------------

### GetAudioMapping()

Source: https://extremraym.com/cloud/resolve-scripting-doc

Returns a string with MediaPoolItem's audio mapping information. Check 'Audio Mapping' section for more information.

```APIDOC
## GetAudioMapping()

### Description
Returns a string with MediaPoolItem's audio mapping information. Check 'Audio Mapping' section for more information.

### Method
GetAudioMapping

### Parameters
None

### Returns
- **json formatted string** - The audio mapping information as a JSON string.
```

--------------------------------

### Prerequisites: Required Lua and Python versions

Source: https://extremraym.com/cloud/resolve-scripting-doc

Lists the software versions required for DaVinci Resolve scripting: Lua 5.1, Python >= 3.6 64-bit, and Python 2.7 64-bit. These must be installed for all users.

```text
Lua 5.1
Python >= 3.6 64-bit
Python 2.7 64-bit
```

--------------------------------

### MediaPool.ImportTimelineFromFile(filePath, {importOptions})

Source: https://extremraym.com/cloud/resolve-scripting-doc

Creates a timeline based on parameters within the given file (AAF/EDL/XML/FCPXML/DRT/ADL/OTIO) and optional importOptions dict.

```APIDOC
## ImportTimelineFromFile(filePath, {importOptions})

### Description
Creates a timeline based on parameters within the given file (AAF/EDL/XML/FCPXML/DRT/ADL/OTIO) and optional importOptions dict.

### Method
ImportTimelineFromFile

### Parameters
- **filePath** (string) - Required - The path to the file to import.
- **importOptions** (dict) - Optional - A dictionary with the following supported keys:
  - **timelineName** (string) - Optional - Specifies the name of the timeline to be created. Not valid for DRT import.
  - **importSourceClips** (Bool) - Optional - Specifies whether source clips should be imported, True by default. Not valid for DRT import.
  - **sourceClipsPath** (string) - Optional - A filesystem path to search for source clips if the media is inaccessible in their original path and if `importSourceClips` is True.
  - **sourceClipsFolders** (List of Media Pool folder objects) - Optional - Media Pool folder objects to search for source clips if the media is not present in current folder and if `importSourceClips` is False. Not valid for DRT import.
  - **interlaceProcessing** (Bool) - Optional - Specifies whether to enable interlace processing on the imported timeline being created. Valid only for AAF import.

### Return Type
Timeline

### Response
#### Success Response
- **Timeline** - The created timeline object.

```

--------------------------------

### TimelineItem:SetProperty and TimelineItem:GetProperty

Source: https://extremraym.com/cloud/resolve-scripting-doc

These functions allow getting and setting properties on a TimelineItem. The supported property keys and their accepted values are documented, including constants for composite modes, retime processes, motion estimation, scaling, and resize filters.

```APIDOC
## TimelineItem:SetProperty / TimelineItem:GetProperty

### Description
These functions are used to get and set properties on a TimelineItem. The supported keys and their accepted values are listed below.

### Method
N/A (Scripting API function)

### Endpoint
N/A

### Parameters
#### Property Keys
- **Pan** (float) - Values from -4.0 * width to 4.0 * width
- **Tilt** (float) - Values from -4.0 * height to 4.0 * height
- **ZoomX** (float) - Values from 0.0 to 100.0
- **ZoomY** (float) - Values from 0.0 to 100.0
- **ZoomGang** (boolean) - Boolean value
- **RotationAngle** (float) - Values from -360.0 to 360.0
- **AnchorPointX** (float) - Values from -4.0 * width to 4.0 * width
- **AnchorPointY** (float) - Values from -4.0 * height to 4.0 * height
- **Pitch** (float) - Values from -1.5 to 1.5
- **Yaw** (float) - Values from -1.5 to 1.5
- **FlipX** (boolean) - Boolean value for flipping horizontally
- **FlipY** (boolean) - Boolean value for flipping vertically
- **CropLeft** (float) - Values from 0.0 to width
- **CropRight** (float) - Values from 0.0 to width
- **CropTop** (float) - Values from 0.0 to height
- **CropBottom** (float) - Values from 0.0 to height
- **CropSoftness** (float) - Values from -100.0 to 100.0
- **CropRetain** (boolean) - Boolean value for "Retain Image Position" checkbox
- **DynamicZoomEase** (constant) - One of: DYNAMIC_ZOOM_EASE_LINEAR (0), DYNAMIC_ZOOM_EASE_IN, DYNAMIC_ZOOM_EASE_OUT, DYNAMIC_ZOOM_EASE_IN_AND_OUT
- **CompositeMode** (constant) - One of: COMPOSITE_NORMAL (0), COMPOSITE_ADD, COMPOSITE_SUBTRACT, COMPOSITE_DIFF, COMPOSITE_MULTIPLY, COMPOSITE_SCREEN, COMPOSITE_OVERLAY, COMPOSITE_HARDLIGHT, COMPOSITE_SOFTLIGHT, COMPOSITE_DARKEN, COMPOSITE_LIGHTEN, COMPOSITE_COLOR_DODGE, COMPOSITE_COLOR_BURN, COMPOSITE_EXCLUSION, COMPOSITE_HUE, COMPOSITE_SATURATE, COMPOSITE_COLORIZE, COMPOSITE_LUMA_MASK, COMPOSITE_DIVIDE, COMPOSITE_LINEAR_DODGE, COMPOSITE_LINEAR_BURN, COMPOSITE_LINEAR_LIGHT, COMPOSITE_VIVID_LIGHT, COMPOSITE_PIN_LIGHT, COMPOSITE_HARD_MIX, COMPOSITE_LIGHTER_COLOR, COMPOSITE_DARKER_COLOR, COMPOSITE_FOREGROUND, COMPOSITE_ALPHA, COMPOSITE_INVERTED_ALPHA, COMPOSITE_LUM, COMPOSITE_INVERTED_LUM
- **Opacity** (float) - Values from 0.0 to 100.0
- **Distortion** (float) - Values from -1.0 to 1.0
- **RetimeProcess** (constant) - One of: RETIME_USE_PROJECT (0), RETIME_NEAREST, RETIME_FRAME_BLEND, RETIME_OPTICAL_FLOW
- **MotionEstimation** (constant) - One of: MOTION_EST_USE_PROJECT (0), MOTION_EST_STANDARD_FASTER, MOTION_EST_STANDARD_BETTER, MOTION_EST_ENHANCED_FASTER, MOTION_EST_ENHANCED_BETTER, MOTION_EST_SPEED_WARP_BETTER, MOTION_EST_SPEED_WARP_FASTER
- **Scaling** (constant) - One of: SCALE_USE_PROJECT (0), SCALE_CROP, SCALE_FIT, SCALE_FILL, SCALE_STRETCH
- **ResizeFilter** (constant) - One of: RESIZE_FILTER_USE_PROJECT (0), RESIZE_FILTER_SHARPER, RESIZE_FILTER_SMOOTHER, RESIZE_FILTER_BICUBIC, RESIZE_FILTER_BILINEAR, RESIZE_FILTER_BESSEL, RESIZE_FILTER_BOX, RESIZE_FILTER_CATMULL_ROM, RESIZE_FILTER_CUBIC, RESIZE_FILTER_GAUSSIAN, RESIZE_FILTER_LANCZOS, RESIZE_FILTER_MITCHELL, RESIZE_FILTER_NEAREST_NEIGHBOR, RESIZE_FILTER_QUADRATIC, RESIZE_FILTER_SINC, RESIZE_FILTER_LINEAR

### Request Example
Arguments can be passed as key-value pairs or grouped into a dictionary (Python) or table (Lua) as a single argument.

### Response
Getting values for keys that use constants will return the number which is in the constant.
```

--------------------------------

### Project:SetSetting

Source: https://extremraym.com/cloud/resolve-scripting-doc

Sets the value of a project setting identified by a key. For '2x Enhanced' super scale, additional parameters are required.

```APIDOC
## Project:SetSetting

### Description
Sets the value of a project setting identified by a key. For '2x Enhanced' super scale, additional parameters are required.

### Method
SetSetting

### Parameters
#### settingName (string) - Required - The key of the property to set.
#### value (string or integer) - Required - The value to set.
#### sharpnessValue (float) - Optional - Required only for '2x Enhanced' super scale. Range [0.0, 1.0].
#### noiseReductionValue (float) - Optional - Required only for '2x Enhanced' super scale. Range [0.0, 1.0].

### Response
#### Success Response
Returns a boolean indicating success.

### Example
```
Project:SetSetting('superScale', 2, 0.5, 0.5)
```
```

--------------------------------

### ProjectManager.LoadProject

Source: https://extremraym.com/cloud/resolve-scripting-doc

Loads and returns a project by name if a match is found, otherwise returns None.

```APIDOC
## ProjectManager.LoadProject

### Description
Loads the project with the given name and returns it. If no matching project is found, returns None.

### Method
LoadProject

### Parameters
- **projectName** (string) - Required - The name of the project to load.

### Return Value
- **Project** - The loaded Project object, or None if no match is found.
```

--------------------------------

### Linux environment variables for Resolve scripting

Source: https://extremraym.com/cloud/resolve-scripting-doc

Sets the RESOLVE_SCRIPT_API, RESOLVE_SCRIPT_LIB, and PYTHONPATH environment variables on Linux so Python can locate the DaVinci Resolve scripting API and library. For standard ISO Linux installations, the paths may need to be modified to refer to /home/resolve instead of /opt/resolve.

```bash
RESOLVE_SCRIPT_API="/opt/resolve/Developer/Scripting"
RESOLVE_SCRIPT_LIB="/opt/resolve/libs/Fusion/fusionscript.so"
PYTHONPATH="$PYTHONPATH:$RESOLVE_SCRIPT_API/Modules/"
```

--------------------------------

### ProjectManager.CreateCloudProject

Source: https://extremraym.com/cloud/resolve-scripting-doc

Creates and returns a cloud project using the provided cloud settings.

```APIDOC
## ProjectManager.CreateCloudProject

### Description
Creates a cloud project with the given cloud settings and returns the created Project object.

### Method
CreateCloudProject

### Parameters
- **cloudSettings** (dict) - Required - Cloud project settings. See 'Cloud Projects Settings' subsection for details.

### Return Value
- **Project** - The created cloud Project object.
```

--------------------------------

### GetName()

Source: https://extremraym.com/cloud/resolve-scripting-doc

Returns the project name.

```APIDOC
## GetName()

### Description
Returns project name.

### Method
GetName

### Parameters
None

### Returns
string
```

--------------------------------

### ProjectManager.GotoParentFolder

Source: https://extremraym.com/cloud/resolve-scripting-doc

Opens the parent folder of the current folder if it exists.

```APIDOC
## ProjectManager.GotoParentFolder

### Description
Opens the parent folder of the current folder if the current folder has a parent.

### Method
GotoParentFolder

### Parameters
None

### Return Value
- **Bool** - True if successful, False otherwise.
```

--------------------------------

### MediaPool.ImportMedia([items...])

Source: https://extremraym.com/cloud/resolve-scripting-doc

Imports specified file/folder paths into the current Media Pool folder. Input is an array of file/folder paths. Returns a list of the MediaPoolItems created.

```APIDOC
## ImportMedia([items...])

### Description
Imports specified file/folder paths into the current Media Pool folder. Input is an array of file/folder paths. Returns a list of the MediaPoolItems created.

### Method
ImportMedia

### Parameters
- **[items...]** (array of string) - Required - An array of file or folder paths to import.

### Return Type
[MediaPoolItems]

### Response
#### Success Response
- **[MediaPoolItems]** - List of created media pool items.

```

--------------------------------

### GrabStill()

Source: https://extremraym.com/cloud/resolve-scripting-doc

Grabs a still from the current video clip.

```APIDOC
## GrabStill()

### Description
Grabs still from the current video clip. Returns a GalleryStill object.

### Method
GrabStill

### Parameters
None

### Returns
galleryStill - The grabbed still.
```

--------------------------------

### ProjectManager.OpenFolder

Source: https://extremraym.com/cloud/resolve-scripting-doc

Opens a folder under the given name.

```APIDOC
## ProjectManager.OpenFolder

### Description
Opens the folder with the given name.

### Method
OpenFolder

### Parameters
- **folderName** (string) - Required - The name of the folder to open.

### Return Value
- **Bool** - True if successful, False otherwise.
```

--------------------------------

### GetSetting(settingName)

Source: https://extremraym.com/cloud/resolve-scripting-doc

Returns the value of a timeline setting.

```APIDOC
## GetSetting(settingName)

### Description
Returns value of timeline setting (indicated by settingName : string). Check the section below for more information.

### Method
Function

### Parameters
- **settingName** (string) - Required - The name of the setting.

### Returns
- **string** - The value of the setting.
```

--------------------------------

### LinkFullResolutionMedia(fullResMediaPath)

Source: https://extremraym.com/cloud/resolve-scripting-doc

Links proxy media to full resolution media files specified via its path.

```APIDOC
## LinkFullResolutionMedia(fullResMediaPath)

### Description
Links proxy media to full resolution media files specified via its path.

### Method
LinkFullResolutionMedia

### Parameters
- **fullResMediaPath** (string) - Required - Absolute path to the full resolution media file.

### Returns
- **Bool** - True if successful, False otherwise.
```

--------------------------------

### SetRenderSettings({settings})

Source: https://extremraym.com/cloud/resolve-scripting-doc

Sets render settings using a dictionary of key-value pairs. The dictionary supports various settings for frame selection, output format, video/audio encoding, and more.

```APIDOC
## SetRenderSettings({settings})

### Description
Sets render settings using a dictionary of key-value pairs. The dictionary supports various settings for frame selection, output format, video/audio encoding, and more.

### Method
SetRenderSettings

### Parameters
#### settings (dictionary)
- **SelectAllFrames** (Bool) - When set True, the settings MarkIn and MarkOut are ignored.
- **MarkIn** (int) - In point for rendering.
- **MarkOut** (int) - Out point for rendering.
- **TargetDir** (string) - Target directory for output.
- **CustomName** (string) - Custom name for output.
- **UniqueFilenameStyle** (int) - 0 - Prefix, 1 - Suffix.
- **ExportVideo** (Bool) - Whether to export video.
- **ExportAudio** (Bool) - Whether to export audio.
- **FormatWidth** (int) - Output width.
- **FormatHeight** (int) - Output height.
- **FrameRate** (float) - Frame rate (examples: 23.976, 24).
- **PixelAspectRatio** (string) - For SD resolution: `16_9` or `4_3`; other resolutions: `square` or `cinemascope`.
- **VideoQuality** (int or string) - Possible values for current codec (if applicable): 0 (int) - automatic; [1 -> MAX] (int) - input bit rate; [`Least`, `Low`, `Medium`, `High`, `Best`] (String) - quality level.
- **AudioCodec** (string) - Audio codec (example: `aac`).
- **AudioBitDepth** (int) - Audio bit depth.
- **AudioSampleRate** (int) - Audio sample rate.
- **ColorSpaceTag** (string) - Color space tag (example: "Same as Project", `AstroDesign`).
- **GammaTag** (string) - Gamma tag (example: "Same as Project", `ACEScct`).
- **ExportAlpha** (Bool) - Whether to export alpha.
- **EncodingProfile** (string) - Encoding profile (example: `Main10`). Can only be set for H.264 and H.265.
- **MultiPassEncode** (Bool) - Multi-pass encoding. Can only be set for H.264.
- **AlphaMode** (int) - 0 - Premultiplied, 1 - Straight. Can only be set if `ExportAlpha` is true.
- **NetworkOptimization** (Bool) - Only supported by QuickTime and MP4 formats.
- **ClipStartFrame** (int) - Clip start frame.
- **TimelineStartTimecode** (string) - Timeline start timecode (example: "01:00:00:00").
- **ReplaceExistingFilesInPlace** (Bool) - Replace existing files in place.
- **ExportSubtitle** (Bool) - Whether to export subtitles.
- **SubtitleFormat** (string) - Options: `BurnIn`, `EmbeddedCaptions`, `SeparateFile`.
- **UseFullExtents** (Bool) - Use full extents.
- **AddFrameHandles** (int) - >= 0. Ignored if use full extents is enabled.
- **DataBurnIn** (string) - Example: "Same as project", `None`.

```

--------------------------------

### mpItem.GetAudioMapping()

Source: https://extremraym.com/cloud/resolve-scripting-doc

Returns a JSON string describing the audio channel mapping for a media item, including embedded and linked audio channels and track mappings.

```APIDOC
## mpItem.GetAudioMapping()

### Description
Returns a JSON string representing the audio mapping of a media item, including embedded and linked audio channels and track mappings.

### Method
GetAudioMapping

### Endpoint
mpItem.GetAudioMapping()

### Parameters
None

### Response
#### Success Response
Returns a JSON string with the following structure:

```json
{
  "embedded_audio_channels": 2,
  "linked_audio": {
    "1": {
      "channels": 8,
      "offset": -100,
      "path": "FILE_PATH"
    },
    "2": {
      "channels": 6,
      "offset": 200,
      "path": "FILE_PATH"
    }
  },
  "track_mapping": {
    "1": {
      "channel_idx": [1, 3],
      "mute": true,
      "type": "Stereo"
    },
    "2": {
      "channel_idx": [3, 4, 5, 6, 7, 8, 9, 10],
      "mute": true,
      "type": "7.1"
    },
    "3": {
      "channel_idx": [1, 1, 1, 1, 15, 16],
      "mute": false,
      "type": "5.1"
    }
  }
}
```

#### Response Fields
- **embedded_audio_channels** (integer) - Total number of embedded channels across all tracks.
- **linked_audio** (object) - A list of only linked audio information. Each key is a linked clip identifier.
  - **channels** (integer) - Number of channels for the linked clip.
  - **offset** (integer) - Audio offset in samples. Negative means audio at media offset 0 plays file_start + offset sample. Positive means audio at media start plays offset samples of digital black then file_start + 0th audio sample.
  - **path** (string) - File path of the linked clip.
- **track_mapping** (object) - Listing of all tracks. Each key is a track number.
  - **channel_idx** (array of integers) - Channel indices for the track. Length corresponds to the number of channels allowed by the format type.
  - **mute** (boolean) - Indicates if the track is muted. Valid values: true/false.
  - **type** (string) - Audio format type (e.g., "Stereo", "7.1", "5.1").
```

--------------------------------

### AutoSyncAudio([MediaPoolItems], {audioSyncSettings})

Source: https://extremraym.com/cloud/resolve-scripting-doc

Syncs audio for a list of media pool items, requiring at least one video and one audio clip. Returns True if successful.

```APIDOC
## AutoSyncAudio([MediaPoolItems], {audioSyncSettings})

### Description
Syncs audio for specified MediaPoolItems. The list must contain a minimum of two MediaPoolItems - at least one video and one audio clip.

### Method
AutoSyncAudio

### Parameters
- **MediaPoolItems** (list) - Required - List of MediaPoolItems to sync.
- **audioSyncSettings** (dict) - Optional - Audio sync settings.

### Return
Bool - True if successful.

### Notes
Refer to 'Audio Sync Settings' section for details.
```

--------------------------------

### CreateStereoClip(LeftMediaPoolItem, RightMediaPoolItem)

Source: https://extremraym.com/cloud/resolve-scripting-doc

Creates a new 3D stereoscopic media pool entry from two existing media pool items, replacing the input media in the media pool. Requires Studio and AI Scripting APIs.

```APIDOC
## CreateStereoClip(LeftMediaPoolItem, RightMediaPoolItem)

### Description
Creates a new 3D stereoscopic media pool entry from two existing media pool items, replacing the input media in the media pool.

### Method
CreateStereoClip

### Parameters
- **LeftMediaPoolItem** (MediaPoolItem) - Required - The left eye media pool item.
- **RightMediaPoolItem** (MediaPoolItem) - Required - The right eye media pool item.

### Return
MediaPoolItem - The newly created stereoscopic media pool item.

### Notes
Refer to section "Studio and AI Scripting APIs" for prerequisites.
```

--------------------------------

### Timeline:GetSetting

Source: https://extremraym.com/cloud/resolve-scripting-doc

Retrieves the value of a timeline setting identified by a key. Calling without parameters returns a snapshot of all queryable properties.

```APIDOC
## Timeline:GetSetting

### Description
Retrieves the value of a timeline setting identified by a key. Calling without parameters returns a snapshot of all queryable properties.

### Method
GetSetting

### Parameters
#### settingName (string) - Optional - The key of the property to retrieve. If omitted, returns all properties.

### Response
#### Success Response
Returns the property value (typically a string or integer). If an invalid key is used, returns a trivial result.

### Example
```
x = Timeline:GetSetting('timelineFrameRate')
```
```

--------------------------------

### ProjectManager.CreateFolder

Source: https://extremraym.com/cloud/resolve-scripting-doc

Creates a folder if the given name is unique.

```APIDOC
## ProjectManager.CreateFolder

### Description
Creates a new folder with the given name. The name must be unique.

### Method
CreateFolder

### Parameters
- **folderName** (string) - Required - The name of the folder to create.

### Return Value
- **Bool** - True if the folder is created, False otherwise.
```

--------------------------------

### TranscribeAudio(useSpeakerDetection=None)

Source: https://extremraym.com/cloud/resolve-scripting-doc

Transcribes audio of the MediaPoolItem. Returns True if successful; False otherwise. Accepts an optional boolean argument to use speaker detection when transcribing. If no argument is specified, uses the project's setting. Refer to section 'Studio and AI Scripting APIs' for prerequisites.

```APIDOC
## TranscribeAudio(useSpeakerDetection=None)

### Description
Transcribes audio of the MediaPoolItem. Returns True if successful; False otherwise. Accepts an optional boolean argument to use speaker detection when transcribing. If no argument is specified, uses the project's setting. Refer to section 'Studio and AI Scripting APIs' for prerequisites.

### Method
TranscribeAudio

### Parameters
- **useSpeakerDetection** (boolean) - Optional - Whether to use speaker detection. If omitted, uses project setting.

### Returns
- **Bool** - True if successful, False otherwise.
```

--------------------------------

### GetRenderPresetList()

Source: https://extremraym.com/cloud/resolve-scripting-doc

Returns a list of render presets and their information.

```APIDOC
## GetRenderPresetList()

### Description
Returns a list of render presets and their information.

### Method
GetRenderPresetList

### Parameters
None

### Returns
[presets...]
```

--------------------------------

### ProjectManager.LoadCloudProject

Source: https://extremraym.com/cloud/resolve-scripting-doc

Loads and returns a cloud project matching the provided cloud settings, or None if no match is found.

```APIDOC
## ProjectManager.LoadCloudProject

### Description
Loads a cloud project with the given cloud settings and returns it. Returns None if no matching cloud project is found.

### Method
LoadCloudProject

### Parameters
- **cloudSettings** (dict) - Required - Cloud project settings. See 'Cloud Projects Settings' subsection for details.

### Return Value
- **Project** - The loaded cloud Project object, or None if no match.
```

--------------------------------

### SetMarkInOut(in, out, type='all')

Source: https://extremraym.com/cloud/resolve-scripting-doc

Sets mark in/out of type 'video', 'audio', or 'all' (default).

```APIDOC
## SetMarkInOut(in, out, type='all')

### Description
Sets mark in/out of type 'video', 'audio', or 'all' (default).

### Method
SetMarkInOut

### Parameters
- **in** (number) - Required - The in frame number.
- **out** (number) - Required - The out frame number.
- **type** (string) - Optional - The type of mark: 'video', 'audio', or 'all'. Default is 'all'.

### Returns
- **Bool** - True if successful, False otherwise.
```

--------------------------------

### GetRenderFormats()

Source: https://extremraym.com/cloud/resolve-scripting-doc

Returns a dict of available render formats.

```APIDOC
## GetRenderFormats()

### Description
Returns a dict (format -> file extension) of available render formats.

### Method
GetRenderFormats

### Parameters
None

### Returns
{render formats..}
```

--------------------------------

### MediaPool.CreateTimelineFromClips(name, [{clipInfo}])

Source: https://extremraym.com/cloud/resolve-scripting-doc

Creates a new timeline with the specified name, appending the list of clipInfos specified as a dict of mediaPoolItem, startFrame, endFrame, recordFrame.

```APIDOC
## CreateTimelineFromClips(name, [{clipInfo}])

### Description
Creates a new timeline with the specified name, appending the list of clipInfos specified as a dict of `mediaPoolItem`, `startFrame` (float/int), `endFrame` (float/int), `recordFrame` (float/int).

### Method
CreateTimelineFromClips

### Parameters
- **name** (string) - Required - The name of the new timeline.
- **clipInfo** (dict) - Required - A dictionary with the following keys:
  - **mediaPoolItem** (MediaPoolItem) - Required - The media pool item.
  - **startFrame** (float/int) - Required - The start frame.
  - **endFrame** (float/int) - Required - The end frame.
  - **recordFrame** (float/int) - Required - The record frame.

### Return Type
Timeline

### Response
#### Success Response
- **Timeline** - The created timeline object.

```

--------------------------------

### Timeline.CreateSubtitlesFromAudio({autoCaptionSettings})

Source: https://extremraym.com/cloud/resolve-scripting-doc

Creates subtitles from audio using the provided auto caption settings dictionary. The settings control language, caption preset, characters per line, line break type, and gap between subtitles.

```APIDOC
## Timeline.CreateSubtitlesFromAudio({autoCaptionSettings})

### Description
Creates subtitles from audio using the provided auto caption settings dictionary. The settings control language, caption preset, characters per line, line break type, and gap between subtitles.

### Method
CreateSubtitlesFromAudio

### Parameters
#### autoCaptionSettings (dictionary) - Required
- `resolve.SUBTITLE_LANGUAGE` (languageID) - Optional - Language for auto captioning. Default: `resolve.AUTO_CAPTION_AUTO`
- `resolve.SUBTITLE_CAPTION_PRESET` (presetType) - Optional - Caption preset. Default: `resolve.AUTO_CAPTION_SUBTITLE_DEFAULT`
- `resolve.SUBTITLE_CHARS_PER_LINE` (Number) - Optional - Number of characters per line, between 1 and 60 inclusive. Default: 42 (may change based on other settings)
- `resolve.SUBTITLE_LINE_BREAK` (lineBreakType) - Optional - Line break type. Default: `resolve.AUTO_CAPTION_LINE_SINGLE`
- `resolve.SUBTITLE_GAP` (Number) - Optional - Gap between subtitles, between 0 and 10 inclusive. Default: 0

### Supported Values
#### languageIDs
- `resolve.AUTO_CAPTION_AUTO`
- `resolve.AUTO_CAPTION_DANISH`
- `resolve.AUTO_CAPTION_DUTCH`
- `resolve.AUTO_CAPTION_ENGLISH`
- `resolve.AUTO_CAPTION_FRENCH`
- `resolve.AUTO_CAPTION_GERMAN`
- `resolve.AUTO_CAPTION_ITALIAN`
- `resolve.AUTO_CAPTION_JAPANESE`
- `resolve.AUTO_CAPTION_KOREAN`
- `resolve.AUTO_CAPTION_MANDARIN_SIMPLIFIED`
- `resolve.AUTO_CAPTION_MANDARIN_TRADITIONAL`
- `resolve.AUTO_CAPTION_NORWEGIAN`
- `resolve.AUTO_CAPTION_PORTUGUESE`
- `resolve.AUTO_CAPTION_RUSSIAN`
- `resolve.AUTO_CAPTION_SPANISH`
- `resolve.AUTO_CAPTION_SWEDISH`

#### presetTypes
- `resolve.AUTO_CAPTION_SUBTITLE_DEFAULT`
- `resolve.AUTO_CAPTION_TELETEXT`
- `resolve.AUTO_CAPTION_NETFLIX`

#### lineBreakTypes
- `resolve.AUTO_CAPTION_LINE_SINGLE`
- `resolve.AUTO_CAPTION_LINE_DOUBLE`

### Notes
Default values for some keys may change based on values defined for other keys, as per the UI. For example, if `resolve.SUBTITLE_LANGUAGE` is set to `resolve.AUTO_CAPTION_KOREAN` and `resolve.SUBTITLE_CAPTION_PRESET` is set to `resolve.AUTO_CAPTION_NETFLIX`, the default for `resolve.SUBTITLE_CHARS_PER_LINE` becomes 16 instead of 42.

### Example
```
{ resolve.SUBTITLE_LANGUAGE = resolve.AUTO_CAPTION_KOREAN,
  resolve.SUBTITLE_CAPTION_PRESET = resolve.AUTO_CAPTION_NETFLIX }
```
```

--------------------------------

### GetGallery()

Source: https://extremraym.com/cloud/resolve-scripting-doc

Returns the Gallery object.

```APIDOC
## GetGallery()

### Description
Returns the Gallery object.

### Method
GetGallery

### Parameters
None

### Returns
Gallery
```

--------------------------------

### SetRenderSettings({settings})

Source: https://extremraym.com/cloud/resolve-scripting-doc

Sets given settings for rendering.

```APIDOC
## SetRenderSettings({settings})

### Description
Sets given settings for rendering. Settings is a dict, with support for the keys: Refer to section "Looking up render settings" for information on supported settings.

### Method
SetRenderSettings

### Parameters
- **settings** (dict) - Required - A dictionary of render settings.

### Returns
Bool
```

--------------------------------

### MediaPool.RefreshFolders()

Source: https://extremraym.com/cloud/resolve-scripting-doc

Updates the folders in collaboration mode.

```APIDOC
## RefreshFolders()

### Description
Updates the folders in collaboration mode.

### Method
RefreshFolders

### Parameters
None

### Return Type
Bool

### Response
#### Success Response
- **Bool** - True if the refresh was successful, false otherwise.

```

--------------------------------

### CreateCompoundClip([timelineItems], {clipInfo})

Source: https://extremraym.com/cloud/resolve-scripting-doc

Creates a compound clip of input timeline items with an optional clipInfo map.

```APIDOC
## CreateCompoundClip([timelineItems], {clipInfo})

### Description
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.

### Method
Function

### Parameters
- **timelineItems** (array) - Required - List of timeline items to include in the compound clip.
- **clipInfo** (dict) - Optional - Dictionary with optional keys `startTimecode` (string) and `name` (string).

### Returns
- **timelineItem** - The created timeline item.
```

--------------------------------

### SetSetting(settingName, settingValue)

Source: https://extremraym.com/cloud/resolve-scripting-doc

Sets the project setting to the given value.

```APIDOC
## SetSetting(settingName, settingValue)

### Description
Sets the project setting (indicated by settingName, string) to the value (settingValue, string). Check the section below for more information.

### Method
SetSetting

### Parameters
- **settingName** (string) - Required - The name of the setting.
- **settingValue** (string) - Required - The value to set.

### Returns
Bool
```

--------------------------------

### ProjectManager.ImportProject

Source: https://extremraym.com/cloud/resolve-scripting-doc

Imports a project from a file path, optionally with a new project name.

```APIDOC
## ProjectManager.ImportProject

### Description
Imports a project from the given file path. An optional project name can be provided.

### Method
ImportProject

### Parameters
- **filePath** (string) - Required - The path to the project file to import.
- **projectName** (string) - Optional - The name to assign to the imported project.

### Return Value
- **Bool** - True if the import succeeds, False otherwise.
```

--------------------------------

### MediaPool.GetRootFolder()

Source: https://extremraym.com/cloud/resolve-scripting-doc

Returns the root Folder of the Media Pool.

```APIDOC
## GetRootFolder()

### Description
Returns the root Folder of the Media Pool.

### Method
GetRootFolder

### Return Type
Folder

### Parameters
None

### Response
#### Success Response
- **Folder** - The root folder object.

```

--------------------------------

### GetQuickExportRenderPresets()

Source: https://extremraym.com/cloud/resolve-scripting-doc

Returns a list of Quick Export render presets by name.

```APIDOC
## GetQuickExportRenderPresets()

### Description
Returns a list of Quick Export render presets by name.

### Method
GetQuickExportRenderPresets

### Parameters
None

### Returns
[preset_name..]
```
Tokens:
Raw