Resolve#

class pybmd.resolve.Resolve(resolve_ip: str = '127.0.0.1', auto_start: bool = False)[source]

Bases: object

Resolve class. Init Davinci Resolve Object Base for everything

Init Davinci Resolve Object

Parameters:
  • resolve_ip (str, optional) – davinci resolve ip. Defaults to 127.0.0.1.

  • auto_start (bool, optional) – pen davinci automatically if it’s not running, if you want to open davinci manually, change arg to false. Defaults to True.

Raises:

ResolveInitError – davinci resolve init failed.you need to check if davinci resolve is running.

Methods

__init__([resolve_ip, auto_start])

Init Davinci Resolve Object

delete_layout_preset(preset_name)

Deletes preset named preset_name.

export_burn_in_preset(preset_name, export_path)

Export a data burn in preset to a given path (string) if presetName (string) exists.

export_layout_preset(preset_name, ...)

Exports preset named preset_name to path preset_file_path.

export_render_preset(preset_name, export_path)

Export a preset to a given path (string) if presetName(string) exists.

get_current_page()

Returns the page currently displayed in the main window

get_keyframe_mode()

Refer to section 'Keyframe Mode information' for details.

get_media_storage()

Returns the MediaStorage object to query and act on media locations.

get_product_name()

Returns product name.

get_project_manager()

Returns the ProjectManager object for currently open database.

get_version()

Returns list of product version fields in [major, minor, patch, build, suffix] format.

get_version_string()

Returns product version in "major.minor.patch[suffix].build" format.

import_burn_in_preset(preset_path)

Import a data burn in preset from a given presetPath (string)

import_layout_preset(preset_file_path, ...)

Imports preset from path 'preset_file_path'.

import_render_preset(preset_path)

Import a preset from presetPath (string) and set it as current preset for rendering.

load_layout_preset(preset_name)

Loads UI layout from saved preset named preset_name.

open_page(page_name)

Switches to indicated page in DaVinci Resolve.

quit()

Quits the Resolve App.

save_layout_preset(preset_name)

Saves current UI layout as a preset named preset_name.

set_keyframe_mode(key_frame_mode)

Refer to section 'Keyframe Mode information' below for details.

update_layout_preset(preset_name)

Overwrites preset named 'preset_name' with current UI layout.

Attributes

fusion

Returns the Fusion object.

delete_layout_preset(preset_name: str) bool[source]

Deletes preset named preset_name.

Parameters:

preset_name (string)

Returns:

result

Return type:

bool

export_layout_preset(preset_name: str, preset_file_path: str) bool[source]

Exports preset named preset_name to path preset_file_path.

Parameters:
  • preset_name (str)

  • preset_file_path (str)

Returns:

result

Return type:

bool

property fusion: Fusion

Returns the Fusion object.

get_current_page() str[source]

Returns the page currently displayed in the main window

Returns:

Returned value can be one of (“media”, “cut”, “edit”, “fusion”, “color”, “fairlight”, “deliver”, None).

Return type:

str

get_media_storage() MediaStorage[source]

Returns the MediaStorage object to query and act on media locations.

Return type:

MediaStorage

get_product_name() str[source]

Returns product name.

Returns:

product name

Return type:

str

get_project_manager() ProjectManager[source]

Returns the ProjectManager object for currently open database.

Return type:

ProjectManager

get_version() list[source]

Returns list of product version fields in [major, minor, patch, build, suffix] format.

Returns:

list of product version fields

Return type:

list

get_version_string() str[source]

Returns product version in “major.minor.patch[suffix].build” format.

Returns:

product version string

Return type:

str

import_layout_preset(preset_file_path: str, preset_name: str) bool[source]

Imports preset from path ‘preset_file_path’. The optional argument ‘preset_name’ specifies how the preset shall be named. If not specified, the preset is named based on the filename.

Parameters:
  • preset_file_path (str)

  • preset_name (str)

Return type:

bool

load_layout_preset(preset_name: str) bool[source]

Loads UI layout from saved preset named preset_name.

Parameters:

preset_name (str)

Returns:

bool

Return type:

bool

open_page(page_name: str) bool[source]

Switches to indicated page in DaVinci Resolve.

Parameters:

page_name (str) – Input can be one of (“media”, “cut”, “edit”, “fusion”, “color”, “fairlight”, “deliver”).

Returns:

bool

Return type:

bool

quit()[source]

Quits the Resolve App.

save_layout_preset(preset_name: str) bool[source]

Saves current UI layout as a preset named preset_name.

Parameters:

preset_name (str)

Returns:

bool

Return type:

bool

update_layout_preset(preset_name: str) bool[source]

Overwrites preset named ‘preset_name’ with current UI layout.

Parameters:

preset_name (str)

Returns:

bool

Return type:

bool

import_render_preset(preset_path: str) bool[source]

Import a preset from presetPath (string) and set it as current preset for rendering.

Parameters:

preset_path (str) – path of preset file

Returns:

Returns True if succssful, False otherwise.

Return type:

bool

export_render_preset(preset_name: str, export_path: str) bool[source]

Export a preset to a given path (string) if presetName(string) exists.

Parameters:
  • preset_name (str) – export preset name

  • export_path (str) – export path

Returns:

Returns True if succssful, False otherwise.

Return type:

bool

import_burn_in_preset(preset_path: str) bool[source]

Import a data burn in preset from a given presetPath (string)

Parameters:

preset_path (str) – path of preset

Returns:

Returns True if succssful, False otherwise.

Return type:

bool

export_burn_in_preset(preset_name: str, export_path: str) bool[source]

Export a data burn in preset to a given path (string) if presetName (string) exists.

Parameters:
  • preset_name (str) – name of export preset

  • export_path (str) – path to export

Returns:

Returns True if succssful, False otherwise.

Return type:

bool

get_keyframe_mode() int[source]

Refer to section ‘Keyframe Mode information’ for details.

Returns:

currently set keyframe mode

Return type:

int

set_keyframe_mode(key_frame_mode: KeyframeMode) bool[source]

Refer to section ‘Keyframe Mode information’ below for details.

Parameters:

key_frame_mode (KeyframeModeInformation) – key frame mode

Returns:

Returns True when ‘keyframeMode’(enum) is successfully set.

Return type:

bool