Folder#

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

Bases: object

Methods

`__init__`(folder)
`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
`transcribe_audio`()	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.

get_name() → str[source]

Returns name of this folder.

get_sub_folder_list() → List[Folder][source]

Return a list of sub folders in this folder.

get_is_folder_stale() → bool[source]

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

get_unique_id() → str[source]

Returns a unique ID for the media pool folder

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() → bool[source]

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

clear_transcription() → bool[source]

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