Vimeo Tools Folder Module

This module contains the class VimeoFolder, which represents a Vimeo folder (projects).

class VimeoFolder(connection, code_or_uri=None, name=None, description=None, data=None, data_object=None, privacy='nobody', users=[], parent_folder=None, password=None, sort='date', layout='grid', theme='standard')

Bases: VimeoItem, VimeoChild

Parameters

  • connection (VimeoConnection) –

  • code_or_uri (Optional[str]) –

  • name (Optional[str]) –

  • description (Optional[str]) –

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

  • data_object (Optional[VimeoData]) –

  • privacy (Literal['anybody', 'nobody', 'password', 'users']) –

  • users (List[str]) –

  • parent_folder (Optional[Union[str, VimeoFolder]]) –

  • password (Optional[str]) –

  • sort (Literal['arrange', 'date', 'manual', 'name', 'plays', 'likes', 'comments', 'duration']) –

  • layout (Literal['grid', 'player']) –

  • theme (Literal['dark', 'standard']) –

BASE_URI = '/me/projects'
add_video(video)

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

Parameters

video (Union[str, VimeoVideo]) –

add_videos(videos)

Add videos to the folder. :type videos: List[Union[str, VimeoVideo]] :param videos: List[Union[str, VimeoVideo]] :return: None

Parameters

videos (List[Union[str, VimeoVideo]]) –

allowed_keys_to_set = ['name']
get_folders(refresh=False, returning='objects')

Get the folders in the folder. :rtype: Union[List[VimeoFolder], List[Dict[str, Any]]] :return: List[VimeoFolder]

Parameters

  • refresh (bool) –

  • returning (Literal['data', 'objects']) –

Return type

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

get_items(refresh=False, returning='objects')

Get the items in the folder. :rtype: Union[List[Union[VimeoVideo, VimeoFolder]], List[Dict[str, Any]]] :return: List[Union[VimeoVideo, VimeoFolder]]

Parameters

  • refresh (bool) –

  • returning (Literal['data', 'objects']) –

Return type

Union[List[Union[VimeoVideo, VimeoFolder]], List[Dict[str, Any]]]

get_name(refresh=False)

Get the folder name. :rtype: str :return: str

Parameters

refresh (bool) –

Return type

str

get_videos(refresh=False, returning='objects')

Get the videos in the folder. :rtype: Union[List[VimeoVideo], List[Dict[str, Any]]] :return: List[VimeoVideo]

Parameters

  • refresh (bool) –

  • returning (Literal['data', 'objects']) –

Return type

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

property nb_videos: int

Get the number of videos in the folder. :rtype: int :return: int

remove_video(video)

Remove a video from the folder. :type video: Union[str, VimeoVideo] :param video: Union[str, VimeoVideo] :return: None

Note that this method does not delete the video from Vimeo.

Parameters

video (Union[str, VimeoVideo]) –

remove_videos(videos)

Remove videos from the folder. :type videos: List[Union[str, VimeoVideo]] :param videos: List[Union[str, VimeoVideo]] :return: None

Note that this method does not delete the videos from Vimeo.

Parameters

videos (List[Union[str, VimeoVideo]]) –