Inheritance diagram for nv_python_libs.bbciplayer.bbciplayer_api.Videos:

Collaboration diagram for nv_python_libs.bbciplayer.bbciplayer_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	getBBCConfig (self)
	Start - Utility functions. More...

def	getUserPreferences (self)

def	setCountry (self, item)

def	getSeasonEpisode (self, title)

def	processVideoUrl (self, url)
	End of Utility functions. More...

def	searchTitle (self, title, pagenumber, pagelen)

def	searchForVideos (self, title, pagenumber)

def	displayTreeView (self)

Public Attributes
	config

	mythxml

	common

	log_name

	logger

	error_messages

	channel

	countryCodeParsers

	s_e_Patterns

	channel_icon

	bbciplayer_config

	userPrefs

Detailed Description

Main interface to http://www.bbciplayer.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.bbciplayer.com/

Definition at line 74 of file bbciplayer_api.py.

Constructor & Destructor Documentation

◆ init()

def nv_python_libs.bbciplayer.bbciplayer_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 82 of file bbciplayer_api.py.

Member Function Documentation

◆ displayTreeView()

def nv_python_libs.bbciplayer.bbciplayer_api.Videos.displayTreeView ( self )

Gather the BBC iPlayer feeds then get a max page of videos meta data in each of them
Display the results and exit

Definition at line 473 of file bbciplayer_api.py.

◆ getBBCConfig()

def nv_python_libs.bbciplayer.bbciplayer_api.Videos.getBBCConfig ( self )

Start - Utility functions.

 Read the MNV BBC iPlayer grabber "bbc_config.xml" configuration file
return nothing

Definition at line 187 of file bbciplayer_api.py.

Referenced by nv_python_libs.bbciplayer.bbciplayer_api.Videos.getUserPreferences().

◆ getSeasonEpisode()

def nv_python_libs.bbciplayer.bbciplayer_api.Videos.getSeasonEpisode	(	self,
		title
	)

 Check is there is any season or episode number information in an item's title
return array of season and/or episode numbers
return array with None values

Definition at line 256 of file bbciplayer_api.py.

Referenced by nv_python_libs.bbciplayer.bbciplayer_api.Videos.displayTreeView(), nv_python_libs.hulu.hulu_api.Videos.displayTreeView(), nv_python_libs.rev3.rev3_api.Videos.displayTreeView(), nv_python_libs.bbciplayer.bbciplayer_api.Videos.searchTitle(), nv_python_libs.hulu.hulu_api.Videos.searchTitle(), nv_python_libs.rev3.rev3_api.Videos.searchTitle(), and nv_python_libs.thewb.thewb_api.Videos.searchTitle().

◆ getUserPreferences()

def nv_python_libs.bbciplayer.bbciplayer_api.Videos.getUserPreferences ( self )

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

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

◆ processVideoUrl()

def nv_python_libs.bbciplayer.bbciplayer_api.Videos.processVideoUrl	(	self,
		url
	)

End of Utility functions.

Definition at line 284 of file bbciplayer_api.py.

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

◆ searchForVideos()

def nv_python_libs.bbciplayer.bbciplayer_api.Videos.searchForVideos	(	self,
		title,
		pagenumber
	)

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

Definition at line 404 of file bbciplayer_api.py.

◆ searchTitle()

def nv_python_libs.bbciplayer.bbciplayer_api.Videos.searchTitle	(	self,
		title,
		pagenumber,
		pagelen
	)

Key word video search of the BBC iPlayer web site
return an array of matching item elements
return

Definition at line 289 of file bbciplayer_api.py.

Referenced by nv_python_libs.bbciplayer.bbciplayer_api.Videos.displayTreeView(), nv_python_libs.hulu.hulu_api.Videos.displayTreeView(), nv_python_libs.thewb.thewb_api.Videos.displayTreeView(), nv_python_libs.bbciplayer.bbciplayer_api.Videos.searchForVideos(), nv_python_libs.bliptv.bliptv_api.Videos.searchForVideos(), nv_python_libs.hulu.hulu_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(), and nv_python_libs.mnvsearch.mnvsearch_api.Videos.searchForVideos().

◆ setCountry()

def nv_python_libs.bbciplayer.bbciplayer_api.Videos.setCountry	(	self,
		item
	)

Parse the item information (HTML or RSS/XML) to identify if the content is a video or
audio file. Set the contry code if a video is detected as it can only be played in the "UK"
return "uk" if a video type was detected.
return None if a video type was NOT detected.

Definition at line 241 of file bbciplayer_api.py.

Referenced by nv_python_libs.bbciplayer.bbciplayer_api.Videos.displayTreeView().

Member Data Documentation

◆ bbciplayer_config

nv_python_libs.bbciplayer.bbciplayer_api.Videos.bbciplayer_config

Definition at line 200 of file bbciplayer_api.py.

Referenced by nv_python_libs.bbciplayer.bbciplayer_api.Videos.getUserPreferences(), and nv_python_libs.bbciplayer.bbciplayer_api.Videos.searchTitle().

◆ channel

nv_python_libs.bbciplayer.bbciplayer_api.Videos.channel

Definition at line 151 of file bbciplayer_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.bbciplayer.bbciplayer_api.Videos.channel_icon

Definition at line 176 of file bbciplayer_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.bbciplayer.bbciplayer_api.Videos.common

Definition at line 133 of file bbciplayer_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.bbciplayer.bbciplayer_api.Videos.config

Definition at line 124 of file bbciplayer_api.py.

◆ countryCodeParsers

nv_python_libs.bbciplayer.bbciplayer_api.Videos.countryCodeParsers

Definition at line 154 of file bbciplayer_api.py.

Referenced by nv_python_libs.bbciplayer.bbciplayer_api.Videos.setCountry().

◆ error_messages

nv_python_libs.bbciplayer.bbciplayer_api.Videos.error_messages

Definition at line 148 of file bbciplayer_api.py.

◆ log_name

nv_python_libs.bbciplayer.bbciplayer_api.Videos.log_name

Definition at line 136 of file bbciplayer_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.bbciplayer.bbciplayer_api.Videos.logger

Definition at line 138 of file bbciplayer_api.py.

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

◆ mythxml

nv_python_libs.bbciplayer.bbciplayer_api.Videos.mythxml

Definition at line 125 of file bbciplayer_api.py.

Referenced by nv_python_libs.youtube.youtube_api.Videos.parseDetails(), nv_python_libs.bbciplayer.bbciplayer_api.Videos.processVideoUrl(), nv_python_libs.bliptv.bliptv_api.Videos.processVideoUrl(), nv_python_libs.dailymotion.dailymotion_api.Videos.processVideoUrl(), and nv_python_libs.vimeo.vimeo_api.Videos.processVideoUrl().

◆ s_e_Patterns

nv_python_libs.bbciplayer.bbciplayer_api.Videos.s_e_Patterns

Definition at line 161 of file bbciplayer_api.py.

Referenced by nv_python_libs.common.common_api.Common.getSeasonEpisode(), nv_python_libs.bbciplayer.bbciplayer_api.Videos.getSeasonEpisode(), nv_python_libs.thewb.thewb_api.Videos.getSeasonEpisode(), nv_python_libs.hulu.hulu_api.Videos.getSeasonEpisode(), and nv_python_libs.rev3.rev3_api.Videos.getSeasonEpisode().

◆ userPrefs

nv_python_libs.bbciplayer.bbciplayer_api.Videos.userPrefs

Definition at line 235 of file bbciplayer_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/bbciplayer/bbciplayer_api.py

Public Member Functions

Public Attributes