MediaStorage

Attributes

MediaStorage.mounted_volumes -> List[Any] property

Gets list of OS mounted volumes

Returns:

Name	Type	Description
list	List[Any]	list of volumes

Functions

MediaStorage.get_subfolders(folder_path: str) -> List[str]

Gets subfolders on folder_path

Parameters:

Name	Type	Description	Default
folder_path	str	parent folder	required

Returns:

Type	Description
List[str]	List[str]: list of subfolders

MediaStorage.get_file_list(folder_path: str) -> List[str]

Gets list of file on folder_path

Parameters:

Name	Type	Description	Default
folder_path	str	parent folder	required

Returns:

Type	Description
List[str]	List[str]: list of files in parent_folder

MediaStorage.reveal_in_storage(path: str) -> bool

Opens path in media storage

Parameters:

Name	Type	Description	Default
path	str	path	required

Returns:

Name	Type	Description
None	bool	None

MediaStorage.add_clip_mattes(mediapool_item: 'MediaPoolItem', paths: List[str], stereo_eye: str) -> bool

Adds clip mattes from path in mediapool_item

Parameters:

Name	Type	Description	Default
mediapool_item	MediaPoolItem	a MediaPoolItem object	required
paths	Union[List[str], str]	A list of path strings or a single path string	required

Returns:

Name	Type	Description
bool	bool	True if successful, False otherwise

MediaStorage.add_timelilne_mattes(paths: List[str]) -> List['MediaPoolItem']

Adds timeline mattes into media pool

Parameters:

Name	Type	Description	Default
paths	Union[List[str], str]	a list of path strings or a single path string to a timeline matte	required

Returns:

Type	Description
List['MediaPoolItem']	List[MediaPoolItem]: list of timeline mattes MediaPoolItems

MediaStorage.addclips_to_mediapool(item: List[str]) -> List['MediaPoolItem']

Adds clips to media pool

Parameters:

Name	Type	Description	Default
item	List[str]	a list of media paths or folders to add to media pool	required

Returns:

Type	Description
List['MediaPoolItem']	List[MediaPoolItem]: list of added MediaPoolItems

Info

Even if you only added one clip, the returned MediaPoolItem will be inside a list. Access it directly by slicing it with the 0 index.