Inheritance diagram for nv_python_libs.mtv.mtv_api.Videos:

Collaboration diagram for nv_python_libs.mtv.mtv_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	searchTitle (self, title, pagenumber, pagelen)
	End of Utility functions. More...

def	videoDetails (self, url, title='')

def	searchForVideos (self, title, pagenumber)

def	displayTreeView (self)

def	makeURL (self, URL)

def	getVideos (self, dir_dict, dictionaries)

def	getVideosForURL (self, url, dictionaries)

Public Attributes
	config

	log_name

	log

	error_messages

	key_translation

	tree_order

	tree_org

	tree_customize

	feed_names

	feed_icons

	mtvHtmlPath

	treeview

	channel_icon

	tree_dir_icon

	grabber_title

	channel

	tree_key

Private Member Functions
def	_initLogger (self)

Detailed Description

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

Supports search methods
The apikey is a not required to access http://www.mtv.com/

Definition at line 97 of file mtv_api.py.

Constructor & Destructor Documentation

◆ init()

def nv_python_libs.mtv.mtv_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 105 of file mtv_api.py.

Member Function Documentation

◆ massageDescription()

def nv_python_libs.mtv.mtv_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 252 of file mtv_api.py.

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

◆ _initLogger()

def nv_python_libs.mtv.mtv_api.Videos._initLogger ( self )

private

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

Definition at line 286 of file mtv_api.py.

◆ textUtf8()

def nv_python_libs.mtv.mtv_api.Videos.textUtf8	(	self,
		text
	)

Definition at line 305 of file mtv_api.py.

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

◆ ampReplace()

def nv_python_libs.mtv.mtv_api.Videos.ampReplace	(	self,
		text
	)

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

Definition at line 317 of file mtv_api.py.

Referenced by nv_python_libs.vimeo.vimeo_api.Videos.getTreeVideos(), nv_python_libs.mtv.mtv_api.Videos.getVideosForURL(), nv_python_libs.mtv.mtv_api.Videos.massageDescription(), 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.mtv.mtv_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 325 of file mtv_api.py.

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

◆ searchTitle()

def nv_python_libs.mtv.mtv_api.Videos.searchTitle	(	self,
		title,
		pagenumber,
		pagelen
	)

End of Utility functions.

Key word video search of the MTV web site
return an array of matching item dictionaries
return

Definition at line 349 of file mtv_api.py.

Referenced by nv_python_libs.thewb.thewb_api.Videos.displayTreeView(), nv_python_libs.tedtalks.tedtalks_api.Videos.searchForVideos(), nv_python_libs.thewb.thewb_api.Videos.searchForVideos(), and nv_python_libs.rev3.rev3_api.Videos.searchForVideos().

◆ videoDetails()

def nv_python_libs.mtv.mtv_api.Videos.videoDetails	(	self,
		url,
		title = `''`
	)

Using the passed URL retrieve the video meta data details
return a dictionary of video metadata details
return

Definition at line 444 of file mtv_api.py.

Referenced by nv_python_libs.mtv.mtv_api.Videos.searchTitle().

◆ searchForVideos()

def nv_python_libs.mtv.mtv_api.Videos.searchForVideos	(	self,
		title,
		pagenumber
	)

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

Definition at line 497 of file mtv_api.py.

◆ displayTreeView()

def nv_python_libs.mtv.mtv_api.Videos.displayTreeView ( self )

Gather the MTV Genres/Artists/...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 568 of file mtv_api.py.

◆ makeURL()

def nv_python_libs.mtv.mtv_api.Videos.makeURL	(	self,
		URL
	)

Form a URL to search for videos
return a URL

Definition at line 596 of file mtv_api.py.

Referenced by nv_python_libs.mtv.mtv_api.Videos.getVideos().

◆ getVideos()

def nv_python_libs.mtv.mtv_api.Videos.getVideos	(	self,
		dir_dict,
		dictionaries
	)

Parse a list made of genres/artists ... etc lists and retrieve video meta data
return a dictionary of directory names and categories video metadata

Definition at line 622 of file mtv_api.py.

◆ getVideosForURL()

def nv_python_libs.mtv.mtv_api.Videos.getVideosForURL	(	self,
		url,
		dictionaries
	)

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

Definition at line 657 of file mtv_api.py.

Referenced by nv_python_libs.youtube.youtube_api.Videos.getVideosForCategory().

Member Data Documentation

◆ config

nv_python_libs.mtv.mtv_api.Videos.config

Definition at line 138 of file mtv_api.py.

◆ log_name

nv_python_libs.mtv.mtv_api.Videos.log_name

Definition at line 147 of file mtv_api.py.

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

◆ log

nv_python_libs.mtv.mtv_api.Videos.log

Definition at line 148 of file mtv_api.py.

◆ error_messages

nv_python_libs.mtv.mtv_api.Videos.error_messages

Definition at line 161 of file mtv_api.py.

Referenced by nv_python_libs.thewb.thewb_api.Videos.displayTreeView(), nv_python_libs.rev3.rev3_api.Videos.displayTreeView(), nv_python_libs.vimeo.vimeo_api.Videos.displayTreeView(), nv_python_libs.pbs.pbs_api.Videos.getPBSConfig(), nv_python_libs.rev3.rev3_api.Videos.getRev3Config(), nv_python_libs.youtube.youtube_api.Videos.getSearchResults(), nv_python_libs.tedtalks.tedtalks_api.Videos.getTedTalksConfig(), nv_python_libs.thewb.thewb_api.Videos.getTheWBConfig(), 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(), nv_python_libs.mtv.mtv_api.Videos.getVideosForURL(), nv_python_libs.tedtalks.tedtalks_api.Videos.searchForVideos(), nv_python_libs.thewb.thewb_api.Videos.searchForVideos(), nv_python_libs.rev3.rev3_api.Videos.searchForVideos(), nv_python_libs.tedtalks.tedtalks_api.Videos.searchTitle(), nv_python_libs.mtv.mtv_api.Videos.searchTitle(), nv_python_libs.thewb.thewb_api.Videos.searchTitle(), nv_python_libs.rev3.rev3_api.Videos.searchTitle(), nv_python_libs.vimeo.vimeo_api.Videos.searchTitle(), nv_python_libs.pbs.pbs_api.Videos.updatePBS(), nv_python_libs.rev3.rev3_api.Videos.updateRev3(), nv_python_libs.tedtalks.tedtalks_api.Videos.updateTedTalks(), nv_python_libs.thewb.thewb_api.Videos.updateTheWB(), and nv_python_libs.mtv.mtv_api.Videos.videoDetails().

◆ key_translation

nv_python_libs.mtv.mtv_api.Videos.key_translation

Definition at line 164 of file mtv_api.py.

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

◆ tree_order

nv_python_libs.mtv.mtv_api.Videos.tree_order

Definition at line 185 of file mtv_api.py.

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

◆ tree_org

nv_python_libs.mtv.mtv_api.Videos.tree_org

Definition at line 186 of file mtv_api.py.

◆ tree_customize

nv_python_libs.mtv.mtv_api.Videos.tree_customize

Definition at line 201 of file mtv_api.py.

Referenced by nv_python_libs.mtv.mtv_api.Videos.makeURL().

◆ feed_names

nv_python_libs.mtv.mtv_api.Videos.feed_names

Definition at line 216 of file mtv_api.py.

Referenced by nv_python_libs.mtv.mtv_api.Videos.getVideosForURL().

◆ feed_icons

nv_python_libs.mtv.mtv_api.Videos.feed_icons

Definition at line 223 of file mtv_api.py.

Referenced by nv_python_libs.mtv.mtv_api.Videos.getVideos(), and nv_python_libs.vimeo.vimeo_api.Videos.getVideos().

◆ mtvHtmlPath

nv_python_libs.mtv.mtv_api.Videos.mtvHtmlPath

Definition at line 230 of file mtv_api.py.

Referenced by nv_python_libs.mtv.mtv_api.Videos.getVideosForURL(), and nv_python_libs.mtv.mtv_api.Videos.videoDetails().

◆ treeview

nv_python_libs.mtv.mtv_api.Videos.treeview

Definition at line 233 of file mtv_api.py.

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

◆ channel_icon

nv_python_libs.mtv.mtv_api.Videos.channel_icon

Definition at line 234 of file mtv_api.py.

Referenced by nv_python_libs.pbs.pbs_api.Videos.displayTreeView(), nv_python_libs.tedtalks.tedtalks_api.Videos.displayTreeView(), nv_python_libs.thewb.thewb_api.Videos.displayTreeView(), nv_python_libs.rev3.rev3_api.Videos.displayTreeView(), nv_python_libs.mtv.mtv_api.Videos.getVideos(), nv_python_libs.vimeo.vimeo_api.Videos.getVideos(), and nv_python_libs.pbs.pbs_api.Videos.searchForVideos().

◆ tree_dir_icon

nv_python_libs.mtv.mtv_api.Videos.tree_dir_icon

Definition at line 329 of file mtv_api.py.

◆ grabber_title

nv_python_libs.mtv.mtv_api.Videos.grabber_title

Definition at line 501 of file mtv_api.py.

Referenced by nv_python_libs.mainProcess.siteQueries.displayHTML(), nv_python_libs.mainProcess.siteQueries.displayTreeView(), nv_python_libs.pbs.pbs_api.Videos.displayTreeView(), nv_python_libs.tedtalks.tedtalks_api.Videos.displayTreeView(), nv_python_libs.mashups.mashups_api.Videos.displayTreeView(), nv_python_libs.mashups.mashups_api.Videos.searchForVideos(), and nv_python_libs.pbs.pbs_api.Videos.searchForVideos().

◆ channel

nv_python_libs.mtv.mtv_api.Videos.channel

Definition at line 573 of file mtv_api.py.

Referenced by nv_python_libs.youtube.youtube_api.Videos.displayTreeView(), nv_python_libs.thewb.thewb_api.Videos.displayTreeView(), nv_python_libs.rev3.rev3_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.mtv.mtv_api.Videos.getVideosForURL(), nv_python_libs.tedtalks.tedtalks_api.Videos.searchForVideos(), nv_python_libs.thewb.thewb_api.Videos.searchForVideos(), nv_python_libs.rev3.rev3_api.Videos.searchForVideos(), nv_python_libs.thewb.thewb_api.Videos.searchTitle(), nv_python_libs.youtube.youtube_api.Videos.searchTitle(), nv_python_libs.rev3.rev3_api.Videos.searchTitle(), and nv_python_libs.vimeo.vimeo_api.Videos.searchTitle().

◆ tree_key

nv_python_libs.mtv.mtv_api.Videos.tree_key

Definition at line 590 of file mtv_api.py.

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

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

mtv_api.py

Public Member Functions

Public Attributes

Private Member Functions