MediaPool Item

MediaPoolItem.markers property

Returns the Marker Collection for this MediaPoolItem.

Attributes

MediaPoolItem.name -> str property

Returns:

Type	Description
str	MediaPoolItem name

MediaPoolItem.media_id -> str property

Returns:

Type	Description
str	MediaPoolItem UUID

MediaPoolItem.flags -> List[str] property

Gets flag list

Returns:

Type	Description
List[str]	list of valid flag colors

MediaPoolItem.color -> str writable property

Gets or sets clip color

Parameters:

Name	Type	Description	Default
color	str	new clip color	required

Returns:

Type	Description
str	clip color

MediaPoolItem.properties -> Union[str, Dict[Any, Any]] property

Gets all clip properties

Returns:

Name	Type	Description
dict	Union[str, Dict[Any, Any]]	dict with clip properties

Functions

MediaPoolItem.get_metadata(metadata_key: Optional[str] = None) -> Union[str, Dict[Any, Any]]

Gets metadata metadata_key for MediaPoolItem. If no metadata_key is provided, returns a Dict with all available metadata. Can return an empty dict if there's no metadata.

Parameters:

Name	Type	Description	Default
metadata_key	Optional[Any]	metadata key	None

Returns:

Type	Description
Union[str, Dict[Any, Any]]	Dict or str corresponding to metadata_key

MediaPoolItem.set_metadata(meta_dict: Any) -> bool

Sets metadata with meta_dict:

    meta_dict = {
        metadata_key: metadata value
        }

It's recommended you validate which metadata you wan't to change first by using MediaPoolItem.get_metadata() and getting a dict with all the metadata to see which one you want to alter.

This will probably change for the better for version 1.0

Parameters:

Name	Type	Description	Default
meta_dict	dict	dict with metadata to be set	required

Returns:

Name	Type	Description
bool	bool	True if successful, False otherwise

MediaPoolItem.add_flag(color: str) -> bool

Adds a flag

Parameters:

Name	Type	Description	Default
color	str	flag color	required

Returns:

Name	Type	Description
bool	bool	True if successful, False otherwise

MediaPoolItem.clear_flags(color: str = 'All') -> bool

Clears flags

Parameters:

Name	Type	Description	Default
color	str	Clears flag by color. If none provided, defaults to "All" which clears all flags.	'All'

Returns:

Type	Description
bool	True if successful, False otherwise

MediaPoolItem.clear_color() -> bool

Clears clip color

Returns:

Name	Type	Description
bool	bool	True if successful, False otherwise

MediaPoolItem.set_property(name: str, value: Union[str, int, float]) -> bool

Sets property

Parameters:

Name	Type	Description	Default
name	str	property name	required
value	Union[str, int, float]	property value	required

Returns:

Name	Type	Description
bool	bool	True if successful, False otherwise

MediaPoolItem.link_proxy(path: str) -> bool

Links media located at path to this MediaPoolItem

Parameters:

Name	Type	Description	Default
path	str	absolute path to proxy media	required

Returns:

Name	Type	Description
bool	bool	True if successful, False otherwise

MediaPoolItem.unlink_proxy() -> bool

Unlinks proxy media of this MediaPoolItem

Returns:

Name	Type	Description
bool	bool	True if successful, False otherwise

MediaPoolItem.replace_clip(path: str) -> bool

Replaces the underlying asset and metadata of MediaPoolItem with the specified absolute clip path.

Parameters:

Name	Type	Description	Default
path	str	path to clip	required

Returns:

Name	Type	Description
bool	bool	True if successful, False otherwise