VimeoChild, VimeoItem, VimeoVideo, VimeoShowcase, VimeoFolder

This module contains the classes VimeoVideo, VimeoShowcase, VimeoFolder, as well as their bases classes VimeoChild and VimeoItem.

All instances must be initialized with a VimeoConnection object

class VimeoVideo(connection, code_or_uri, data=None, data_object=None)

Bases: VimeoItem, VimeoChild

A class to represent a Vimeo video.

Parameters

• connection (VimeoConnection) –

• code_or_uri (str) –

• data (Optional[Dict[str, Any]]) –

• data_object (Optional[VimeoData]) –

BASE_URI = '/videos'

add_domain(domain)

Add a domain to the whitelist of the video. :type domain: str :param domain: str :return: None

Parameters

domain (str) –

add_tag(tag, refresh=False)

Parameters

• tag (str) –

• refresh (bool) –

add_tags(tags, refresh=False)

Add tags to the video. :type tags: Union[str, List[str]] :param tags: str or list of str :type refresh: bool :param refresh: bool :return: None

Parameters

• tags (Union[str, List[str]]) –

• refresh (bool) –

add_to_folder(folder)

Add the video to a folder. :type folder: Union[str, VimeoFolder] :param folder: str :return: None

Parameters

folder (Union[str, VimeoFolder]) –

allowed_keys_to_set = ['content_rating', 'custom_url', 'description', 'embed.buttons.embed', 'embed.buttons.fullscreen', 'embed.buttons.hd', 'embed.buttons.like', 'embed.buttons.scaling', 'embed.buttons.share', 'embed.buttons.watchlater', 'embed.cards', 'embed.cards.display_time', 'embed.cards.headline', 'embed.cards.id', 'embed.cards.image_url', 'embed.cards.teaser', 'embed.cards.timecode', 'embed.cards.url', 'embed.color', 'embed.end_screen.type', 'embed.logos.custom.active', 'embed.logos.custom.id', 'embed.logos.custom.link', 'embed.logos.custom.sticky', 'embed.logos.vimeo', 'embed.playbar', 'embed.title.name', 'embed.title.owner', 'embed.title.portrait', 'embed.volume', 'embed_domains', 'embed_domains_add', 'embed_domains_delete', 'hide_from_vimeo', 'license', 'locale', 'name', 'password', 'privacy.add', 'privacy.comments', 'privacy.download', 'privacy.embed', 'privacy.view', 'review_page.active', 'spatial.director_timeline', 'spatial.director_timeline.pitch *', 'spatial.director_timeline.roll', 'spatial.director_timeline.time_code *', 'spatial.director_timeline.yaw *', 'spatial.field_of_view', 'spatial.projectionspatial.stereo_format']

property app: str

Return type

str

property categories: str

Return type

str

property chapters: List[Dict[str, Any]]

Get the video chapters. :type refresh: bool :param refresh: bool :rtype: List[Dict[str, Any]] :return: List[Dict[str, Any]]

property content_rating: str

Return type

str

property content_rating_class: str

Return type

str

property content_ratings: List[Dict[str, Any]]

Get the video content ratings. :type refresh: bool :param refresh: bool :rtype: List[Dict[str, Any]] :return: List[Dict[str, Any]]

delete()

property description: str

Return type

str

property dimensions: Dict[str, int]

Get the video dimensions. :rtype: Dict[str, int] :return: Dict[str, int]

property download: str

Return type

str

property files: str

Return type

str

get_chapter(chapter_id, refresh=False)

Get the video chapter. :type chapter_id: str :param chapter_id: str :type refresh: bool :param refresh: bool :rtype: Dict[str, Any] :return: Dict[str, Any]

Parameters

• chapter_id (str) –

• refresh (bool) –

Return type

Dict[str, Any]

get_showcases(returning='object', refresh=False)

Get the showcases the video is in. :type returning: Literal[‘object’, ‘objects’, ‘list’, ‘dict’, ‘name’, ‘names’, ‘code’, ‘codes’, ‘uri’, ‘uris’] :param returning: str :type refresh: bool :param refresh: bool :rtype: Union[List[str], Dict[str, Any], List[VimeoShowcase]] :return: Union[List[str], Dict[str, Any]]

Parameters

• returning (Literal['object', 'objects', 'list', 'dict', 'name', 'names', 'code', 'codes', 'uri', 'uris']) –

• refresh (bool) –

Return type

Union[List[str], Dict[str, Any], List[VimeoShowcase]]

get_tags(returning='dict', refresh=False)

Return type

Union[List[str], str]

Parameters

• returning (Literal['dict', 'list', 'json', 'names', 'name', 'uris', 'uri', 'tags', 'tag', 'canonical']) –

• refresh (bool) –

property has_audio: str

Return type

str

property hash: int

Get the video hash. :rtype: int :return: str

property height: str

Return type

str

property is_playable: str

Return type

str

key = 'license'

property language: str

Return type

str

property last_user_action_event_date: str

Return type

str

property license: str

Return type

str

property manage_link: str

Return type

str

property parent_folder: str

Return type

str

property play: str

Return type

str

property player_embed_url: str

Return type

str

property privacy: Dict[str, Union[str, bool]]

Get the video privacy settings. :rtype: Dict[str, Union[str, bool]] :return: Dict[str, Union[str, bool]]

property rating_mod_locked: str

Return type

str

property release_time: str

Return type

str

remove_domain(domain)

Remove a domain from the video’s whitelist. :type domain: str :param domain: str :return: None

Parameters

domain (str) –

remove_from_folder(folder)

Remove the video from a folder. :type folder: str :param folder: str :return: None

Parameters

folder (str) –

remove_tag(tag)

Remove a tag from the video. :type tag: str :param tag: str :return: None

This method uses the delete method of the Vimeo API.

Parameters

tag (str) –

remove_tags(tags, refresh=False)

Remove tags from the video. :type tags: Union[str, List[str]] :param tags: str or list of str :type refresh: bool :param refresh: bool :return: None

This method uses the put method of the Vimeo API.

Parameters

• tags (Union[str, List[str]]) –

• refresh (bool) –

property review_page: str

Return type

str

set_description(value)

Parameters

value (str) –

set_key = 'locale'

set_tags(tags)

Parameters

tags (Union[str, List[str], List[Dict[str, str]]]) –

setter_cmd = "\n@language.setter\ndef language(self, value: str):\n    self._data['language'] = value\n    self.set_property('locale', value)\n"

property stats: str

Return type

str

property status: str

Get the video status. :rtype: str :return: str

property tags: List[str]

Return type

List[str]

property tags_data: List[Dict[str, Any]]

Return type

List[Dict[str, Any]]

property transcode: str

Return type

str

property type: str

Return type

str

upload()

upload_picture()

property uploader: str

Return type

str

val = {'type': <class 'dict'>}

property width: str

Return type

str