Inheritance diagram for nv_python_libs.pbs.pbs_api.Videos:

Collaboration diagram for nv_python_libs.pbs.pbs_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	getPBSConfig (self)
	Start - Utility functions. More...

def	getUserPreferences (self)

def	updatePBS (self, create=False)

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

	mashups_api

	pbs_config

	userPrefs

	Search

Detailed Description

Main interface to http://video.pbs.org/
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://video.pbs.org/

Definition at line 102 of file pbs_api.py.

Constructor & Destructor Documentation

◆ init()

def nv_python_libs.pbs.pbs_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 110 of file pbs_api.py.

Member Function Documentation

◆ getPBSConfig()

def nv_python_libs.pbs.pbs_api.Videos.getPBSConfig ( self )

Start - Utility functions.

Read the MNV PBS grabber "pbs_config.xml" configuration file
return nothing

Definition at line 200 of file pbs_api.py.

Referenced by nv_python_libs.pbs.pbs_api.Videos.getUserPreferences().

◆ getUserPreferences()

def nv_python_libs.pbs.pbs_api.Videos.getUserPreferences ( self )

Read the pbs_config.xml and user preference pbs.xml file.
If the pbs.xml file does not exist then create it.
If the pbs.xml file is too old then update it.
return nothing

Definition at line 220 of file pbs_api.py.

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

◆ updatePBS()

def nv_python_libs.pbs.pbs_api.Videos.updatePBS	(	self,
		create = `False`
	)

Create or update the pbs.xml user preferences file
return nothing

Definition at line 259 of file pbs_api.py.

◆ searchForVideos()

def nv_python_libs.pbs.pbs_api.Videos.searchForVideos	(	self,
		title,
		pagenumber
	)

End of Utility functions.

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

Definition at line 374 of file pbs_api.py.

◆ displayTreeView()

def nv_python_libs.pbs.pbs_api.Videos.displayTreeView ( self )

Gather all videos for each PBS show
Display the results and exit

Definition at line 399 of file pbs_api.py.

Member Data Documentation

◆ config

nv_python_libs.pbs.pbs_api.Videos.config

Definition at line 143 of file pbs_api.py.

◆ common

nv_python_libs.pbs.pbs_api.Videos.common

Definition at line 151 of file pbs_api.py.

Referenced by nv_python_libs.thewb.thewb_api.Videos.createItems(), 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.youtube.youtube_api.Videos.massageDescription(), nv_python_libs.youtube.youtube_api.Videos.parseDetails(), 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.thewb.thewb_api.Videos.searchTitle(), nv_python_libs.rev3.rev3_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().

◆ log_name

nv_python_libs.pbs.pbs_api.Videos.log_name

Definition at line 154 of file pbs_api.py.

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

◆ logger

nv_python_libs.pbs.pbs_api.Videos.logger

Definition at line 156 of file pbs_api.py.

◆ error_messages

nv_python_libs.pbs.pbs_api.Videos.error_messages

Definition at line 166 of file pbs_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.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.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(), and nv_python_libs.thewb.thewb_api.Videos.updateTheWB().

◆ channel

nv_python_libs.pbs.pbs_api.Videos.channel

Definition at line 169 of file pbs_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.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().

◆ channel_icon

nv_python_libs.pbs.pbs_api.Videos.channel_icon

Definition at line 171 of file pbs_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.vimeo.vimeo_api.Videos.getVideos(), and nv_python_libs.pbs.pbs_api.Videos.searchForVideos().

◆ mashups_api

nv_python_libs.pbs.pbs_api.Videos.mashups_api

Definition at line 177 of file pbs_api.py.

Referenced by nv_python_libs.pbs.pbs_api.Videos.displayTreeView(), nv_python_libs.tedtalks.tedtalks_api.Videos.displayTreeView(), nv_python_libs.pbs.pbs_api.Videos.searchForVideos(), nv_python_libs.pbs.pbs_api.Videos.updatePBS(), and nv_python_libs.tedtalks.tedtalks_api.Videos.updateTedTalks().

◆ pbs_config

nv_python_libs.pbs.pbs_api.Videos.pbs_config

Definition at line 213 of file pbs_api.py.

Referenced by nv_python_libs.pbs.pbs_api.Videos.getUserPreferences(), and nv_python_libs.pbs.pbs_api.Videos.updatePBS().

◆ userPrefs

nv_python_libs.pbs.pbs_api.Videos.userPrefs

Definition at line 240 of file pbs_api.py.

Referenced by nv_python_libs.thewb.thewb_api.Videos.displayTreeView(), nv_python_libs.rev3.rev3_api.Videos.displayTreeView(), 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().

◆ Search

nv_python_libs.pbs.pbs_api.Videos.Search

Definition at line 389 of file pbs_api.py.

Referenced by nv_python_libs.pbs.pbs_api.Videos.displayTreeView().

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

pbs_api.py

Public Member Functions

Public Attributes