GalleryStillAlbum

class pybmd.gallery_still_album.GalleryStillAlbum(gallery_still_album)

Bases: object

docstring for GalleryStillAlbum.

Methods

__init__(gallery_still_album)
delete_stills(gallery_stills)	Delete the given gallery stills from the album.
export_stills(gallery_stills, folder_path, ...)	Exports list of GalleryStill objects 'galleryStill' to directory 'folderPath', with filename prefix 'filePrefix', using file format 'format'
get_label(gallery_still)	Returns label of given gallery still.
get_stills()	Returns list of GalleryStill objects in this album.
set_label(gallery_still, label)	sets label of given gallery still.

delete_stills(gallery_stills: List[GalleryStill]) → bool

Delete the given gallery stills from the album.

Parameters:

gallery_stills (List[GalleryStill])

Return type:

bool

export_stills(gallery_stills: List[GalleryStill], folder_path: str, file_prefix: str, format: StillFormat) → bool

Exports list of GalleryStill objects ‘galleryStill’ to directory ‘folderPath’, with filename prefix ‘filePrefix’, using file format ‘format’

Parameters:

• gallery_stills (List[GalleryStill]) – a list of GalleryStill objects to export

• folder_path (str) – folder path to export to

• file_prefix (str) – filename prefix for exported files

• format (StillFormats) – StillFormat Object to use for export format

Returns:

function returns true if export was successful, false otherwise

Return type:

bool

get_label(gallery_still: GalleryStill) → str

Returns label of given gallery still.

Parameters:

gallery_still (GalleryStill)

Return type:

str

get_stills() → List[GalleryStill]

Returns list of GalleryStill objects in this album.

Return type:

List[GalleryStill]

set_label(gallery_still: GalleryStill, label: str) → bool

sets label of given gallery still.

Parameters:

• gallery_still (GalleryStill) – gallery still to set label on

• label (str) – label to set on gallery still

Returns:

ture if successful, false otherwise

Return type:

bool