Inheritance diagram for nv_python_libs.vimeo.vimeo_api.Videos:

Collaboration diagram for nv_python_libs.vimeo.vimeo_api.Videos:

Public Member Functions
def	__init__ (self, apikey, mythtv=True, interactive=False, select_first=False, debug=False, custom_ui=None, language=None, search_all_languages=False)

def	massageDescription (self, text)
	Start - Utility functions. More...

def	textUtf8 (self, text)

def	ampReplace (self, text)

def	setTreeViewIcon (self, dir_icon=None)

def	initializeVimeo (self)
	End of Utility functions. More...

def	processVideoUrl (self, url)

def	searchTitle (self, title, pagenumber, pagelen)

def	searchForVideos (self, title, pagenumber)

def	getChannels (self)

def	displayTreeView (self)

def	getVideos (self, dir_dict, dictionaries)

def	getVideosForChannels (self, method, dictionary)

def	getTreeVideos (self, method, dictionaries)

Public Attributes
	config

	mythxml

	log_name

	log

	error_messages

	key_translation

	tree_key_list

	tree_order

	tree_org

	tree_customize

	feed_names

	feed_icons

	treeview

	channel_icon

	tree_dir_icon

	client

	channel

	channel_dict

	channel_count

	channel_list_max

	tree_key

	next_page

	max_page

	tree_list

	channel_id

	dir_name

Private Member Functions
def	_initLogger (self)

Detailed Description

Main interface to http://vimeo.com/
This is done to support a common naming framework for all python Netvision plugins no matter their site
target.

Supports search and tree view methods
The apikey is a not passed but is created as a session token to access http://vimeo.com/

Definition at line 620 of file vimeo_api.py.

Constructor & Destructor Documentation

◆ init()

def nv_python_libs.vimeo.vimeo_api.Videos.__init__	(	self,
		apikey,
		mythtv = `True`,
		interactive = `False`,
		select_first = `False`,
		debug = `False`,
		custom_ui = `None`,
		language = `None`,
		search_all_languages = `False`
	)

apikey (str/unicode):
    Specify the target site API key. Applications need their own key in some cases

mythtv (True/False):
    When True, the returned meta data is being returned has the key and values massaged to match MythTV
    When False, the returned meta data  is being returned matches what target site returned

interactive (True/False): (This option is not supported by all target site apis)
    When True, uses built-in console UI is used to select the correct show.
    When False, the first search result is used.

select_first (True/False): (This option is not supported currently implemented in any grabbers)
    Automatically selects the first series search result (rather
    than showing the user a list of more than one series).
    Is overridden by interactive = False, or specifying a custom_ui

debug (True/False):
     shows verbose debugging information

custom_ui (xx_ui.BaseUI subclass): (This option is not supported currently implemented in any grabbers)
    A callable subclass of interactive class (overrides interactive option)

language (2 character language abbreviation): (This option is not supported by all target site apis)
    The language of the returned data. Is also the language search
    uses. Default is "en" (English). For full list, run..

search_all_languages (True/False): (This option is not supported by all target site apis)
    By default, a Netvision grabber will only search in the language specified using
    the language option. When this is True, it will search for the
    show in any language

Definition at line 628 of file vimeo_api.py.

Member Function Documentation

◆ massageDescription()

def nv_python_libs.vimeo.vimeo_api.Videos.massageDescription	(	self,
		text
	)

Start - Utility functions.

Removes HTML markup from a text string.
@param text The HTML source.
@return The plain text.  If the HTML source contains non-ASCII
entities or character references, this is a Unicode string.

Definition at line 770 of file vimeo_api.py.

Referenced by nv_python_libs.vimeo.vimeo_api.Videos.getTreeVideos(), nv_python_libs.vimeo.vimeo_api.Videos.getVideos(), nv_python_libs.youtube.youtube_api.Videos.getVideosForURL(), nv_python_libs.youtube.youtube_api.Videos.parseDetails(), and nv_python_libs.vimeo.vimeo_api.Videos.searchTitle().

◆ _initLogger()

def nv_python_libs.vimeo.vimeo_api.Videos._initLogger ( self )

private

Setups a logger using the logging module, returns a log object

Definition at line 804 of file vimeo_api.py.

◆ textUtf8()

def nv_python_libs.vimeo.vimeo_api.Videos.textUtf8	(	self,
		text
	)

Definition at line 823 of file vimeo_api.py.

Referenced by giantbomb.giantbomb_api.gamedbQueries.ampReplace(), nv_python_libs.vimeo.vimeo_api.Videos.ampReplace(), nv_python_libs.vimeo.vimeo_api.Videos.massageDescription(), and giantbomb.giantbomb_api.gamedbQueries.massageText().

◆ ampReplace()

def nv_python_libs.vimeo.vimeo_api.Videos.ampReplace	(	self,
		text
	)

Replace all "&" characters with "&amp;"

Definition at line 835 of file vimeo_api.py.

Referenced by nv_python_libs.vimeo.vimeo_api.Videos.getTreeVideos(), nv_python_libs.vimeo.vimeo_api.Videos.massageDescription(), giantbomb.giantbomb_api.gamedbQueries.massageText(), nv_python_libs.vimeo.vimeo_api.Videos.processVideoUrl(), and nv_python_libs.vimeo.vimeo_api.Videos.searchTitle().

◆ setTreeViewIcon()

def nv_python_libs.vimeo.vimeo_api.Videos.setTreeViewIcon	(	self,
		dir_icon = `None`
	)

Check if there is a specific generic tree view icon. If not default to the channel icon.
return self.tree_dir_icon

Definition at line 843 of file vimeo_api.py.

Referenced by nv_python_libs.vimeo.vimeo_api.Videos.getTreeVideos(), nv_python_libs.vimeo.vimeo_api.Videos.getVideos(), and nv_python_libs.youtube.youtube_api.Videos.getVideosForURL().

◆ initializeVimeo()

def nv_python_libs.vimeo.vimeo_api.Videos.initializeVimeo ( self )

End of Utility functions.

Initialize acccess methods for all Vimeo API calls
raise errors if there are issues during the initalization steps
return nothing

Definition at line 866 of file vimeo_api.py.

Referenced by nv_python_libs.vimeo.vimeo_api.Videos.displayTreeView(), and nv_python_libs.vimeo.vimeo_api.Videos.searchTitle().

◆ processVideoUrl()

def nv_python_libs.vimeo.vimeo_api.Videos.processVideoUrl	(	self,
		url
	)

Definition at line 889 of file vimeo_api.py.

Referenced by nv_python_libs.vimeo.vimeo_api.Videos.getTreeVideos(), and nv_python_libs.vimeo.vimeo_api.Videos.searchTitle().

◆ searchTitle()

def nv_python_libs.vimeo.vimeo_api.Videos.searchTitle	(	self,
		title,
		pagenumber,
		pagelen
	)

Key word video search of the vimeo.com web site
return an array of matching item dictionaries
return

Definition at line 894 of file vimeo_api.py.

◆ searchForVideos()

def nv_python_libs.vimeo.vimeo_api.Videos.searchForVideos	(	self,
		title,
		pagenumber
	)

Common name for a video search. Used to interface with MythTV plugin NetVision

Definition at line 1022 of file vimeo_api.py.

◆ getChannels()

def nv_python_libs.vimeo.vimeo_api.Videos.getChannels ( self )

Get the channel directory information and fill out the tree view directory structures as required
raise exceptions if the there was an issue getting Channel information or no channel data
return True if successful

Definition at line 1091 of file vimeo_api.py.

Referenced by nv_python_libs.vimeo.vimeo_api.Videos.displayTreeView().

◆ displayTreeView()

def nv_python_libs.vimeo.vimeo_api.Videos.displayTreeView ( self )

Gather the Vimeo Groups/Channels...etc then get a max page of videos meta data in each of them
return array of directories and their video metadata

Definition at line 1163 of file vimeo_api.py.

◆ getVideos()

def nv_python_libs.vimeo.vimeo_api.Videos.getVideos	(	self,
		dir_dict,
		dictionaries
	)

Parse a list made of category lists and retrieve video meta data
return a dictionary of directory names and categories video metadata

Definition at line 1218 of file vimeo_api.py.

◆ getVideosForChannels()

def nv_python_libs.vimeo.vimeo_api.Videos.getVideosForChannels	(	self,
		method,
		dictionary
	)

Process all channel related directory videos
return dictionary of new video items

Definition at line 1253 of file vimeo_api.py.

◆ getTreeVideos()

def nv_python_libs.vimeo.vimeo_api.Videos.getTreeVideos	(	self,
		method,
		dictionaries
	)

Get the video metadata for url search
return the video dictionary of directories and their video mata data

Definition at line 1299 of file vimeo_api.py.

Member Data Documentation

◆ config

nv_python_libs.vimeo.vimeo_api.Videos.config

Definition at line 661 of file vimeo_api.py.

Referenced by nv_python_libs.youtube.youtube_api.Videos._initLogger(), nv_python_libs.vimeo.vimeo_api.Videos._initLogger(), nv_python_libs.vimeo.vimeo_api.Videos.displayTreeView(), giantbomb.giantbomb_api.gamedbQueries.gameData(), giantbomb.giantbomb_api.gamedbQueries.gameSearch(), nv_python_libs.youtube.youtube_api.Videos.getSearchResults(), nv_python_libs.youtube.youtube_api.Videos.getUserPreferences(), nv_python_libs.youtube.youtube_api.Videos.getVideoCategories(), nv_python_libs.vimeo.vimeo_api.Videos.getVideos(), and nv_python_libs.youtube.youtube_api.Videos.getVideosForURL().

◆ mythxml

nv_python_libs.vimeo.vimeo_api.Videos.mythxml

Definition at line 662 of file vimeo_api.py.

Referenced by nv_python_libs.youtube.youtube_api.Videos.parseDetails(), and nv_python_libs.vimeo.vimeo_api.Videos.processVideoUrl().

◆ log_name

nv_python_libs.vimeo.vimeo_api.Videos.log_name

Definition at line 666 of file vimeo_api.py.

Referenced by nv_python_libs.youtube.youtube_api.Videos._initLogger(), and nv_python_libs.vimeo.vimeo_api.Videos._initLogger().

◆ log

nv_python_libs.vimeo.vimeo_api.Videos.log

Definition at line 667 of file vimeo_api.py.

◆ error_messages

nv_python_libs.vimeo.vimeo_api.Videos.error_messages

Definition at line 680 of file vimeo_api.py.

Referenced by nv_python_libs.vimeo.vimeo_api.Videos.displayTreeView(), nv_python_libs.youtube.youtube_api.Videos.getSearchResults(), nv_python_libs.vimeo.vimeo_api.Videos.getTreeVideos(), nv_python_libs.youtube.youtube_api.Videos.getVideoCategories(), nv_python_libs.youtube.youtube_api.Videos.getVideoDetails(), nv_python_libs.youtube.youtube_api.Videos.getVideosForURL(), and nv_python_libs.vimeo.vimeo_api.Videos.searchTitle().

◆ key_translation

nv_python_libs.vimeo.vimeo_api.Videos.key_translation

Definition at line 683 of file vimeo_api.py.

Referenced by nv_python_libs.vimeo.vimeo_api.Videos.getTreeVideos(), and nv_python_libs.youtube.youtube_api.Videos.translateItem().

◆ tree_key_list

nv_python_libs.vimeo.vimeo_api.Videos.tree_key_list

Definition at line 708 of file vimeo_api.py.

◆ tree_order

nv_python_libs.vimeo.vimeo_api.Videos.tree_order

Definition at line 710 of file vimeo_api.py.

Referenced by nv_python_libs.vimeo.vimeo_api.Videos.displayTreeView().

◆ tree_org

nv_python_libs.vimeo.vimeo_api.Videos.tree_org

Definition at line 712 of file vimeo_api.py.

◆ tree_customize

nv_python_libs.vimeo.vimeo_api.Videos.tree_customize

Definition at line 723 of file vimeo_api.py.

◆ feed_names

nv_python_libs.vimeo.vimeo_api.Videos.feed_names

Definition at line 734 of file vimeo_api.py.

◆ feed_icons

nv_python_libs.vimeo.vimeo_api.Videos.feed_icons

Definition at line 742 of file vimeo_api.py.

Referenced by nv_python_libs.vimeo.vimeo_api.Videos.getVideos().

◆ treeview

nv_python_libs.vimeo.vimeo_api.Videos.treeview

Definition at line 751 of file vimeo_api.py.

Referenced by nv_python_libs.vimeo.vimeo_api.Videos.displayTreeView().

◆ channel_icon

nv_python_libs.vimeo.vimeo_api.Videos.channel_icon

Definition at line 752 of file vimeo_api.py.

Referenced by nv_python_libs.vimeo.vimeo_api.Videos.getVideos().

◆ tree_dir_icon

nv_python_libs.vimeo.vimeo_api.Videos.tree_dir_icon

Definition at line 847 of file vimeo_api.py.

◆ client

nv_python_libs.vimeo.vimeo_api.Videos.client

Definition at line 872 of file vimeo_api.py.

Referenced by nv_python_libs.vimeo.vimeo_api.Videos.searchTitle().

◆ channel

nv_python_libs.vimeo.vimeo_api.Videos.channel

Definition at line 1026 of file vimeo_api.py.

Referenced by nv_python_libs.youtube.youtube_api.Videos.displayTreeView(), nv_python_libs.vimeo.vimeo_api.Videos.displayTreeView(), nv_python_libs.vimeo.vimeo_api.Videos.getTreeVideos(), nv_python_libs.youtube.youtube_api.Videos.getVideosForURL(), nv_python_libs.youtube.youtube_api.Videos.searchTitle(), and nv_python_libs.vimeo.vimeo_api.Videos.searchTitle().

◆ channel_dict

nv_python_libs.vimeo.vimeo_api.Videos.channel_dict

Definition at line 1096 of file vimeo_api.py.

◆ channel_count

nv_python_libs.vimeo.vimeo_api.Videos.channel_count

Definition at line 1097 of file vimeo_api.py.

◆ channel_list_max

nv_python_libs.vimeo.vimeo_api.Videos.channel_list_max

Definition at line 1101 of file vimeo_api.py.

◆ tree_key

nv_python_libs.vimeo.vimeo_api.Videos.tree_key

Definition at line 1211 of file vimeo_api.py.

Referenced by nv_python_libs.vimeo.vimeo_api.Videos.getVideos(), and nv_python_libs.youtube.youtube_api.Videos.getVideosForURL().

◆ next_page

nv_python_libs.vimeo.vimeo_api.Videos.next_page

Definition at line 1257 of file vimeo_api.py.

Referenced by nv_python_libs.vimeo.vimeo_api.Videos.getTreeVideos().

◆ max_page

nv_python_libs.vimeo.vimeo_api.Videos.max_page

Definition at line 1258 of file vimeo_api.py.

Referenced by nv_python_libs.vimeo.vimeo_api.Videos.getTreeVideos().

◆ tree_list

nv_python_libs.vimeo.vimeo_api.Videos.tree_list

Definition at line 1259 of file vimeo_api.py.

Referenced by nv_python_libs.vimeo.vimeo_api.Videos.getTreeVideos().

◆ channel_id

nv_python_libs.vimeo.vimeo_api.Videos.channel_id

Definition at line 1265 of file vimeo_api.py.

Referenced by nv_python_libs.vimeo.vimeo_api.Videos.getTreeVideos().

◆ dir_name

nv_python_libs.vimeo.vimeo_api.Videos.dir_name

Definition at line 1266 of file vimeo_api.py.

Referenced by nv_python_libs.vimeo.vimeo_api.Videos.getTreeVideos().

The documentation for this class was generated from the following file:

vimeo_api.py

Public Member Functions

Public Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ massageDescription()

◆ _initLogger()

◆ textUtf8()

◆ ampReplace()

◆ setTreeViewIcon()

◆ initializeVimeo()

◆ processVideoUrl()

◆ searchTitle()

◆ searchForVideos()

◆ getChannels()

◆ displayTreeView()

◆ getVideos()

◆ getVideosForChannels()

◆ getTreeVideos()

Member Data Documentation

◆ config

◆ mythxml

◆ log_name

◆ log

◆ error_messages

◆ key_translation

◆ tree_key_list

◆ tree_order

◆ tree_org

◆ tree_customize

◆ feed_names

◆ feed_icons

◆ treeview

◆ channel_icon

◆ tree_dir_icon

◆ client

◆ channel

◆ channel_dict

◆ channel_count

◆ channel_list_max

◆ tree_key

◆ next_page

◆ max_page

◆ tree_list

◆ channel_id

◆ dir_name

◆ init()