Vimeo Tools Showcase Module
This module contains the class VimeoShowcase.
- class VimeoShowcase(connection, code_or_uri=None, name=None, data=None, data_object=None, videos=[], creation_data={})
Bases:
VimeoItemA class to represent a Vimeo showcase.
- Parameters
connection (VimeoConnection) –
code_or_uri (Optional[str]) –
name (Optional[str]) –
data (Optional[Dict[str, Any]]) –
data_object (Optional[VimeoData]) –
videos (List['VimeoVideo']) –
creation_data (Optional[Dict[str, Any]]) –
- API_URI = '/me/albums'
- BASE_URI = '/albums'
- USER_URI = '/users/{user_id}/albums'
- add_logo(picture)
Add a logo to the showcase.
- Parameters
picture (str) –
- add_thumbnail(picture)
Add a thumbnail to the showcase.
- Parameters
picture (str) –
- add_video(video)
Add a video to the showcase.
- Parameters
video (Union[str, VimeoVideo]) –
- property allow_continuous_play: str
- Return type
str
- property allow_downloads: str
- Return type
str
- Return type
str
- allowed_keys_to_set = ['brand_color', 'description', 'domain', 'hide_nav', 'hide_upcoming', 'layout', 'name', 'privacy', 'review_mode', 'sort', 'theme', 'urluse_custom_domain']
- property autoplay: str
- Return type
str
- property brand_color: str
- Return type
str
- property custom_logo: str
- Return type
str
- delete()
Delete the showcase on Vimeo and also delete the object.
- delete_logo(logo_id)
Delete the logo of the showcase.
- Parameters
logo_id (str) –
- delete_thumbnail(thumbnail_id)
Delete the thumbnail of the showcase.
- Parameters
thumbnail_id (str) –
- property description: str
- Return type
str
- property domain: str
- Return type
str
- property domain_certificate_state: str
- Return type
str
- property embed_brand_color: str
- Return type
str
- property embed_custom_logo: str
- Return type
str
- get_logo(logo_id)
Get the logo of the showcase.
- Parameters
logo_id (str) –
- get_test_data()
Get test data for the showcase.
- get_thumbnail(thumbnail_id)
Get the thumbnail of the showcase.
- Parameters
thumbnail_id (str) –
- get_thumbnails()
Get the thumbnails of the showcase.
- get_videos(refresh=False, returning='object')
Get the videos of the showcase.
- Return type
Union[Dict[str,Any],List[Dict[str,Any]],List[VimeoVideo],List[str],str]- Parameters
refresh (bool) –
returning (Literal['code', 'codes', 'uri', 'uris', 'name', 'names', 'dict', 'list', 'object', 'objects', 'json']) –
- property has_chosen_thumbnail: str
- Return type
str
- property hide_from_vimeo: str
- Return type
str
- Return type
str
- property hide_upcoming: str
- Return type
str
- property hide_vimeo_logo: str
- Return type
str
- key = 'embed_custom_logo'
- property layout: str
- Return type
str
- property logos
Get the logos of the showcase.
- property loop: str
- Return type
str
- property nb_videos: int
Get the number of videos in the showcase.
- Return type
int
- remove_video(video)
Remove a video from the showcase.
- Parameters
video (str) –
- replace_videos(videos)
Replace all the videos of the showcase.
- Parameters
videos (List[Union[str, VimeoVideo]]) –
- property review_mode: str
- Return type
str
- property roku_genres: str
- Return type
str
- property roku_language: str
- Return type
str
- property roku_provider_name: str
- Return type
str
- property seo_allow_indexed: str
- Return type
str
- property seo_description: str
- Return type
str
- property seo_keywords: str
- Return type
str
- property seo_title: str
- Return type
str
- set_featured_video(video_id)
Set the featured video of the showcase.
- Parameters
video_id (str) –
- set_logo(picture)
Replace the logo of the showcase.
- Parameters
picture (str) –
- Return type
str
- property sort: str
- Return type
str
- property theme: str
- Return type
str
- property url: str
- Return type
str
- property use_custom_domain: str
- Return type
str
- val = {'type': <class 'str'>}
- property videos: List[VimeoVideo]
Get the videos of the showcase.
- Return type
List[VimeoVideo]
- property web_brand_color: str
- Return type
str
- property web_custom_logo: str
- Return type
str