MediaData«
MediaData (StorageAdapter)
«
Main MediaData class used to manage all media data associated with a post.
Attributes:
| Name | Type | Description |
|---|---|---|
storage_proxy |
StorageProxy |
Storage proxy used to communicate with storage backend. |
add_media(self, media_data, media_name, media_data_format='data_url', overwrite=True)
«
Add media to be saved.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
media_data |
str |
Byte64 encoded string in DataURL format. |
required |
media_name |
str |
Name of media used to reference media bytes stored. |
required |
media_data_format |
str,optional |
Media format being passed to method. |
'data_url' |
overwrite |
bool |
OVerwrite existing media data with same name. |
True |
Returns:
| Type | Description |
|---|---|
None |
Nothing returned |
delete_media(self, media_name)
«
Delete media that is stored on disk.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
media_name |
str |
Name of media data to be deleted. |
required |
Returns:
| Type | Description |
|---|---|
None |
Nothing returned |
get_media(self, media_name, return_format='data_url')
«
Get bytes for media data.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
media_name |
str |
Name of media data to be retrieved. |
required |
media_data_format |
str,optional |
Media format to be returned. |
required |
Returns:
| Type | Description |
|---|---|
str |
byte64 encoded str in DataURL format. |
remove_media(self, media_name)
«
Remove media that has not yet been saved to disk.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
media_name |
str |
Name of media data to remove. |
required |
Returns:
| Type | Description |
|---|---|
None |
Nothing returned |
save(self)
«
Save all unsaved data to disk.
Returns:
| Type | Description |
|---|---|
None |
Nothing returned |