Folder#

class pybmd.folder.Folder(folder)[source]

Bases: WrapperBase

Methods

`__init__`(folder)
`analyze_for_intellisearch`(identify_faces, ...)	Performs Intellisearch analysis on all MediaPoolItems in the folder.
`analyze_for_slate`(marker_color)	Performs Slate analysis on all MediaPoolItems in the folder using the current settings and specified marker color.
`clear_audio_classification`()	Clears audio classification of the MediaPoolItems within the folder and nested folders.
`clear_transcription`()	Clears audio transcription of the MediaPoolItems within the folder and nested folders.
`export`(file_path)	Returns true if export of DRB folder to filePath is successful, false otherwise
`get_clip_list`()	Returns list of MediaPoolItem objects for all clips in this folder.
`get_is_folder_stale`()	Returns true if folder is stale in collaboration mode, false otherwise
`get_name`()	Returns name of this folder.
`get_sub_folder_list`()	Return a list of sub folders in this folder.
`get_unique_id`()	Returns a unique ID for the media pool folder
`perform_audio_classification`()	Analyzes and classifies the audio of the MediaPoolItems within the folder and nested folders.
`remove_motion_blur`(deblur_option)	Applies motion deblur on the MediaPoolItems in the folder.
`transcribe_audio`([use_speaker_detection])	Transcribes audio of the MediaPoolItems within the folder and nested folders.

get_clip_list() → List[MediaPoolItem][source]

Returns list of MediaPoolItem objects for all clips in this folder.

Return type:: List[MediaPoolItem]

get_name() → str[source]

Returns name of this folder.

Return type:: str

get_sub_folder_list() → List[Folder][source]

Return a list of sub folders in this folder.

Return type:: List[Folder]

get_is_folder_stale() → bool[source]

Returns true if folder is stale in collaboration mode, false otherwise

Return type:: bool

get_unique_id() → str[source]

Returns a unique ID for the media pool folder

Return type:: str

export(file_path: str) → bool[source]

Returns true if export of DRB folder to filePath is successful, false otherwise

Parameters:: file_path (str) – file path to export DRB file
Returns:: Returns true if export of DRB folder to filePath is successful, false otherwise
Return type:: bool

transcribe_audio(use_speaker_detection: bool | None = None) → bool[source]

Transcribes audio of the MediaPoolItems within the folder and nested folders.

Parameters:: use_speaker_detection (bool, optional) – Whether to use speaker detection when transcribing. If None, the project’s setting is used. Defaults to None.
Returns:: Returns True if successful; False otherwise
Return type:: bool

clear_transcription() → bool[source]

Clears audio transcription of the MediaPoolItems within the folder and nested folders.

Returns:: Returns True if successful; False otherwise.
Return type:: bool

perform_audio_classification() → bool[source]

Analyzes and classifies the audio of the MediaPoolItems within the folder and nested folders.

Studio-only. Refer to DaVinci Resolve’s “Studio and AI Scripting APIs” prerequisites; returns False if requirements are not met.

Returns:: Returns True if successful, False otherwise.
Return type:: bool
Raises:: APIVersionError – If Resolve version < 21.0.2

Version:: Added in DaVinci Resolve 21.0.2

clear_audio_classification() → bool[source]

Clears audio classification of the MediaPoolItems within the folder and nested folders.

Studio-only. Refer to DaVinci Resolve’s “Studio and AI Scripting APIs” prerequisites; returns False if requirements are not met.

Returns:: Returns True if successful, False otherwise.
Return type:: bool
Raises:: APIVersionError – If Resolve version < 21.0.2

Version:: Added in DaVinci Resolve 21.0.2

remove_motion_blur(deblur_option: MotionDeblurSettings | dict) → List[List[MediaPoolItem]][source]

Applies motion deblur on the MediaPoolItems in the folder.

Studio-only. Refer to DaVinci Resolve’s “Studio and AI Scripting APIs” prerequisites.

Parameters:

deblur_option (MotionDeblurSettings | dict) – Motion deblur settings. A MotionDeblurSettings model or a raw dict.

Returns:

A list of [original, newly_created]: MediaPoolItem pairs.

Return type:

List[List[MediaPoolItem]]

Raises:

APIVersionError – If Resolve version < 21.0.2

Version:: Added in DaVinci Resolve 21.0.2

analyze_for_intellisearch(identify_faces: bool, is_better_mode: bool) → bool[source]

Performs Intellisearch analysis on all MediaPoolItems in the folder.

Studio-only. Refer to DaVinci Resolve’s “Studio and AI Scripting APIs” prerequisites (AI IntelliSearch Faster/Better Extras); returns False if requirements are not met.

Parameters:

identify_faces (bool) – Whether to identify faces.
is_better_mode (bool) – Whether to use Better mode (else Faster mode).

Returns:

Returns True if required packages are installed and analysis is successful.

Return type:

bool

Raises:

APIVersionError – If Resolve version < 21.0.2

Version:: Added in DaVinci Resolve 21.0.2

analyze_for_slate(marker_color: MarkerColor | str) → bool[source]

Performs Slate analysis on all MediaPoolItems in the folder using the current settings and specified marker color.

Studio-only. Refer to DaVinci Resolve’s “Studio and AI Scripting APIs” prerequisites (AI Slate ID Extras); returns False if requirements are not met.

Parameters:: marker_color (MarkerColor | str) – Marker color to use. A MarkerColor enum member or the underlying color string.
Returns:: Returns True if required packages are installed and analysis is successful.
Return type:: bool
Raises:: APIVersionError – If Resolve version < 21.0.2

Version:: Added in DaVinci Resolve 21.0.2