Inheritance diagram for nv_python_libs.mashups.mashups_api.Videos:

Collaboration diagram for nv_python_libs.mashups.mashups_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	setTreeViewIcon (self, dir_icon=None)
	Start - Utility functions. More...

def	getMashupsConfig (self)

def	getUserPreferences (self)

def	searchForVideos (self, title, pagenumber)
	End of Utility functions. More...

def	displayTreeView (self)

Public Attributes
	config

	common

	log_name

	logger

	error_messages

	channel

	channel_icon

	tree_dir_icon

	mashups_config

	userPrefs

Detailed Description

Main interface to any Mashup
This is done to support a common naming framework for all python Netvision plugins
no matter their site target.

Supports MNV Mashup Search and Treeview methods
The apikey is a not required for Mashups

Definition at line 71 of file mashups_api.py.

Constructor & Destructor Documentation

◆ init()

def nv_python_libs.mashups.mashups_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 79 of file mashups_api.py.

Member Function Documentation

◆ displayTreeView()

def nv_python_libs.mashups.mashups_api.Videos.displayTreeView ( self )

Gather the Mashups Internet sources then get the videos meta data in each of them
Display the results and exit

Definition at line 423 of file mashups_api.py.

◆ getMashupsConfig()

def nv_python_libs.mashups.mashups_api.Videos.getMashupsConfig ( self )

 Read the MNV Mashups grabber "mashups_config.xml" configuration file
return nothing

Definition at line 185 of file mashups_api.py.

Referenced by nv_python_libs.mashups.mashups_api.Videos.getUserPreferences().

◆ getUserPreferences()

def nv_python_libs.mashups.mashups_api.Videos.getUserPreferences ( self )

Read the mashups_config.xml and user preference xxxxxMashup.xml file.
If the xxxxxMashup.xml file does not exist then copy the default.
return nothing

Definition at line 205 of file mashups_api.py.

Referenced by nv_python_libs.bbciplayer.bbciplayer_api.Videos.displayTreeView(), nv_python_libs.hulu.hulu_api.Videos.displayTreeView(), nv_python_libs.mashups.mashups_api.Videos.displayTreeView(), nv_python_libs.rev3.rev3_api.Videos.displayTreeView(), nv_python_libs.thewb.thewb_api.Videos.displayTreeView(), nv_python_libs.bbciplayer.bbciplayer_api.Videos.searchForVideos(), nv_python_libs.hulu.hulu_api.Videos.searchForVideos(), nv_python_libs.mashups.mashups_api.Videos.searchForVideos(), and nv_python_libs.tedtalks.tedtalks_api.Videos.searchForVideos().

◆ searchForVideos()

def nv_python_libs.mashups.mashups_api.Videos.searchForVideos	(	self,
		title,
		pagenumber
	)

End of Utility functions.

Common name for a video search. Used to interface with MythTV plugin NetVision
Display the results and exit

Definition at line 288 of file mashups_api.py.

◆ setTreeViewIcon()

def nv_python_libs.mashups.mashups_api.Videos.setTreeViewIcon	(	self,
		dir_icon = `None`
	)

Start - Utility functions.

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 165 of file mashups_api.py.

Referenced by nv_python_libs.mashups.mashups_api.Videos.displayTreeView(), nv_python_libs.vimeo.vimeo_api.Videos.getTreeVideos(), nv_python_libs.dailymotion.dailymotion_api.Videos.getVideos(), nv_python_libs.mtv.mtv_api.Videos.getVideos(), nv_python_libs.vimeo.vimeo_api.Videos.getVideos(), nv_python_libs.bliptv.bliptv_api.Videos.getVideosForURL(), nv_python_libs.mtv.mtv_api.Videos.getVideosForURL(), nv_python_libs.youtube.youtube_api.Videos.getVideosForURL(), and nv_python_libs.mashups.mashups_api.Videos.searchForVideos().

Member Data Documentation

◆ channel

nv_python_libs.mashups.mashups_api.Videos.channel

Definition at line 152 of file mashups_api.py.

Referenced by nv_python_libs.bbciplayer.bbciplayer_api.Videos.displayTreeView(), nv_python_libs.dailymotion.dailymotion_api.Videos.displayTreeView(), nv_python_libs.hulu.hulu_api.Videos.displayTreeView(), nv_python_libs.mashups.mashups_api.Videos.displayTreeView(), nv_python_libs.rev3.rev3_api.Videos.displayTreeView(), nv_python_libs.thewb.thewb_api.Videos.displayTreeView(), nv_python_libs.vimeo.vimeo_api.Videos.displayTreeView(), nv_python_libs.youtube.youtube_api.Videos.displayTreeView(), nv_python_libs.vimeo.vimeo_api.Videos.getTreeVideos(), nv_python_libs.mtv.mtv_api.Videos.getVideosForURL(), nv_python_libs.youtube.youtube_api.Videos.getVideosForURL(), nv_python_libs.bbciplayer.bbciplayer_api.Videos.searchForVideos(), nv_python_libs.hulu.hulu_api.Videos.searchForVideos(), nv_python_libs.mashups.mashups_api.Videos.searchForVideos(), nv_python_libs.rev3.rev3_api.Videos.searchForVideos(), nv_python_libs.tedtalks.tedtalks_api.Videos.searchForVideos(), nv_python_libs.thewb.thewb_api.Videos.searchForVideos(), nv_python_libs.mnvsearch.mnvsearch_api.Videos.searchForVideos(), nv_python_libs.bbciplayer.bbciplayer_api.Videos.searchTitle(), nv_python_libs.hulu.hulu_api.Videos.searchTitle(), nv_python_libs.rev3.rev3_api.Videos.searchTitle(), nv_python_libs.vimeo.vimeo_api.Videos.searchTitle(), nv_python_libs.youtube.youtube_api.Videos.searchTitle(), nv_python_libs.mnvsearch.mnvsearch_api.Videos.searchTitle(), and nv_python_libs.thewb.thewb_api.Videos.searchTitle().

◆ channel_icon

nv_python_libs.mashups.mashups_api.Videos.channel_icon

Definition at line 154 of file mashups_api.py.

Referenced by nv_python_libs.bbciplayer.bbciplayer_api.Videos.displayTreeView(), nv_python_libs.hulu.hulu_api.Videos.displayTreeView(), nv_python_libs.mashups.mashups_api.Videos.displayTreeView(), nv_python_libs.pbs.pbs_api.Videos.displayTreeView(), nv_python_libs.rev3.rev3_api.Videos.displayTreeView(), nv_python_libs.tedtalks.tedtalks_api.Videos.displayTreeView(), nv_python_libs.thewb.thewb_api.Videos.displayTreeView(), nv_python_libs.bliptv.bliptv_api.Videos.getVideos(), nv_python_libs.dailymotion.dailymotion_api.Videos.getVideos(), nv_python_libs.mtv.mtv_api.Videos.getVideos(), nv_python_libs.vimeo.vimeo_api.Videos.getVideos(), nv_python_libs.mashups.mashups_api.Videos.searchForVideos(), and nv_python_libs.pbs.pbs_api.Videos.searchForVideos().

◆ common

nv_python_libs.mashups.mashups_api.Videos.common

Definition at line 129 of file mashups_api.py.

Referenced by nv_python_libs.thewb.thewb_api.Videos.createItems(), nv_python_libs.bbciplayer.bbciplayer_api.Videos.displayTreeView(), nv_python_libs.hulu.hulu_api.Videos.displayTreeView(), nv_python_libs.mashups.mashups_api.Videos.displayTreeView(), nv_python_libs.rev3.rev3_api.Videos.displayTreeView(), nv_python_libs.thewb.thewb_api.Videos.displayTreeView(), nv_python_libs.youtube.youtube_api.Videos.displayTreeView(), nv_python_libs.youtube.youtube_api.Videos.massageDescription(), nv_python_libs.youtube.youtube_api.Videos.parseDetails(), nv_python_libs.bbciplayer.bbciplayer_api.Videos.searchForVideos(), nv_python_libs.hulu.hulu_api.Videos.searchForVideos(), nv_python_libs.mashups.mashups_api.Videos.searchForVideos(), nv_python_libs.rev3.rev3_api.Videos.searchForVideos(), nv_python_libs.tedtalks.tedtalks_api.Videos.searchForVideos(), nv_python_libs.thewb.thewb_api.Videos.searchForVideos(), nv_python_libs.mnvsearch.mnvsearch_api.Videos.searchForVideos(), nv_python_libs.bbciplayer.bbciplayer_api.Videos.searchTitle(), nv_python_libs.hulu.hulu_api.Videos.searchTitle(), nv_python_libs.rev3.rev3_api.Videos.searchTitle(), nv_python_libs.tedtalks.tedtalks_api.Videos.searchTitle(), nv_python_libs.mnvsearch.mnvsearch_api.Videos.searchTitle(), nv_python_libs.thewb.thewb_api.Videos.searchTitle(), nv_python_libs.pbs.pbs_api.Videos.updatePBS(), nv_python_libs.rev3.rev3_api.Videos.updateRev3(), and nv_python_libs.thewb.thewb_api.Videos.updateTheWB().

◆ config

nv_python_libs.mashups.mashups_api.Videos.config

Definition at line 121 of file mashups_api.py.

◆ error_messages

nv_python_libs.mashups.mashups_api.Videos.error_messages

Definition at line 149 of file mashups_api.py.

◆ log_name

nv_python_libs.mashups.mashups_api.Videos.log_name

Definition at line 132 of file mashups_api.py.

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

◆ logger

nv_python_libs.mashups.mashups_api.Videos.logger

Definition at line 134 of file mashups_api.py.

Referenced by nv_python_libs.common.common_api.Common.callCommandLine(), and nv_python_libs.common.common_api.Common.initLogger().

◆ mashups_config

nv_python_libs.mashups.mashups_api.Videos.mashups_config

Definition at line 198 of file mashups_api.py.

Referenced by nv_python_libs.mashups.mashups_api.Videos.getUserPreferences().

◆ tree_dir_icon

nv_python_libs.mashups.mashups_api.Videos.tree_dir_icon

Definition at line 169 of file mashups_api.py.

Referenced by nv_python_libs.bliptv.bliptv_api.Videos.setTreeViewIcon(), nv_python_libs.dailymotion.dailymotion_api.Videos.setTreeViewIcon(), nv_python_libs.mashups.mashups_api.Videos.setTreeViewIcon(), nv_python_libs.mtv.mtv_api.Videos.setTreeViewIcon(), nv_python_libs.vimeo.vimeo_api.Videos.setTreeViewIcon(), and nv_python_libs.youtube.youtube_api.Videos.setTreeViewIcon().

◆ userPrefs

nv_python_libs.mashups.mashups_api.Videos.userPrefs

Definition at line 235 of file mashups_api.py.

Referenced by nv_python_libs.bbciplayer.bbciplayer_api.Videos.displayTreeView(), nv_python_libs.hulu.hulu_api.Videos.displayTreeView(), nv_python_libs.mashups.mashups_api.Videos.displayTreeView(), nv_python_libs.rev3.rev3_api.Videos.displayTreeView(), nv_python_libs.thewb.thewb_api.Videos.displayTreeView(), nv_python_libs.bbciplayer.bbciplayer_api.Videos.searchForVideos(), nv_python_libs.hulu.hulu_api.Videos.searchForVideos(), nv_python_libs.mashups.mashups_api.Videos.searchForVideos(), nv_python_libs.bbciplayer.bbciplayer_api.Videos.searchTitle(), nv_python_libs.tedtalks.tedtalks_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(), and nv_python_libs.thewb.thewb_api.Videos.updateTheWB().

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

mythtv/programs/scripts/internetcontent/nv_python_libs/mashups/mashups_api.py

Public Member Functions

Public Attributes