MythTV  master
Public Member Functions | Public Attributes | List of all members
nv_python_libs.bbciplayer.bbciplayer_api.Videos Class Reference
Inheritance diagram for nv_python_libs.bbciplayer.bbciplayer_api.Videos:
Inheritance graph
[legend]
Collaboration diagram for nv_python_libs.bbciplayer.bbciplayer_api.Videos:
Collaboration graph
[legend]

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 93 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 101 of file bbciplayer_api.py.

Member Function Documentation

◆ 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 206 of file bbciplayer_api.py.

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

◆ getUserPreferences()

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

◆ 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 260 of file bbciplayer_api.py.

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

◆ getSeasonEpisode()

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

◆ processVideoUrl()

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

◆ searchTitle()

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

◆ 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 423 of file bbciplayer_api.py.

◆ 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 492 of file bbciplayer_api.py.

Member Data Documentation

◆ config

nv_python_libs.bbciplayer.bbciplayer_api.Videos.config

Definition at line 134 of file bbciplayer_api.py.

Referenced by nv_python_libs.mtv.mtv_api.Videos._initLogger(), nv_python_libs.youtube.youtube_api.Videos._initLogger(), nv_python_libs.bliptv.bliptv_api.Videos._initLogger(), nv_python_libs.dailymotion.dailymotion_api.Videos._initLogger(), nv_python_libs.vimeo.vimeo_api.Videos._initLogger(), nv_python_libs.mainProcess.siteQueries.displayHTML(), nv_python_libs.mainProcess.siteQueries.displayTreeView(), nv_python_libs.mashups.mashups_api.Videos.displayTreeView(), nv_python_libs.hulu.hulu_api.Videos.displayTreeView(), nv_python_libs.bbciplayer.bbciplayer_api.Videos.displayTreeView(), nv_python_libs.thewb.thewb_api.Videos.displayTreeView(), nv_python_libs.rev3.rev3_api.Videos.displayTreeView(), nv_python_libs.dailymotion.dailymotion_api.Videos.displayTreeView(), nv_python_libs.vimeo.vimeo_api.Videos.displayTreeView(), giantbomb.giantbomb_api.gamedbQueries.gameData(), giantbomb.giantbomb_api.gamedbQueries.gameSearch(), nv_python_libs.bbciplayer.bbciplayer_api.Videos.getBBCConfig(), nv_python_libs.bliptv.bliptv_api.Videos.getCategories(), nv_python_libs.hulu.hulu_api.Videos.getHuluConfig(), nv_python_libs.mashups.mashups_api.Videos.getMashupsConfig(), 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.mnvsearch.mnvsearch_api.Videos.getTreeviewData(), nv_python_libs.youtube.youtube_api.Videos.getUserPreferences(), nv_python_libs.hulu.hulu_api.Videos.getUserPreferences(), nv_python_libs.rev3.rev3_api.Videos.getUserPreferences(), nv_python_libs.tedtalks.tedtalks_api.Videos.getUserPreferences(), nv_python_libs.pbs.pbs_api.Videos.getUserPreferences(), nv_python_libs.mashups.mashups_api.Videos.getUserPreferences(), nv_python_libs.bbciplayer.bbciplayer_api.Videos.getUserPreferences(), nv_python_libs.thewb.thewb_api.Videos.getUserPreferences(), nv_python_libs.youtube.youtube_api.Videos.getVideoCategories(), nv_python_libs.rev3.rev3_api.Videos.getVideoID(), nv_python_libs.mtv.mtv_api.Videos.getVideos(), nv_python_libs.bliptv.bliptv_api.Videos.getVideos(), nv_python_libs.dailymotion.dailymotion_api.Videos.getVideos(), nv_python_libs.vimeo.vimeo_api.Videos.getVideos(), nv_python_libs.dailymotion.dailymotion_api.Videos.getVideosForGroupURL(), nv_python_libs.youtube.youtube_api.Videos.getVideosForURL(), nv_python_libs.mtv.mtv_api.Videos.getVideosForURL(), nv_python_libs.bliptv.bliptv_api.Videos.getVideosForURL(), nv_python_libs.dailymotion.dailymotion_api.Videos.getVideosForURL(), nv_python_libs.mnvsearch.mnvsearch_api.Videos.searchForVideos(), nv_python_libs.mashups.mashups_api.Videos.searchForVideos(), nv_python_libs.tedtalks.tedtalks_api.Videos.searchForVideos(), nv_python_libs.hulu.hulu_api.Videos.searchForVideos(), nv_python_libs.bbciplayer.bbciplayer_api.Videos.searchForVideos(), nv_python_libs.thewb.thewb_api.Videos.searchForVideos(), nv_python_libs.rev3.rev3_api.Videos.searchForVideos(), nv_python_libs.mnvsearch.mnvsearch_api.Videos.searchTitle(), nv_python_libs.hulu.hulu_api.Videos.searchTitle(), nv_python_libs.bbciplayer.bbciplayer_api.Videos.searchTitle(), 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.bliptv.bliptv_api.Videos.searchTitle(), nv_python_libs.rev3.rev3_api.Videos.searchTitle(), nv_python_libs.dailymotion.dailymotion_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().

◆ mythxml

nv_python_libs.bbciplayer.bbciplayer_api.Videos.mythxml

◆ common

nv_python_libs.bbciplayer.bbciplayer_api.Videos.common

Definition at line 143 of file bbciplayer_api.py.

Referenced by nv_python_libs.thewb.thewb_api.Videos.createItems(), nv_python_libs.mashups.mashups_api.Videos.displayTreeView(), nv_python_libs.hulu.hulu_api.Videos.displayTreeView(), nv_python_libs.bbciplayer.bbciplayer_api.Videos.displayTreeView(), 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.mnvsearch.mnvsearch_api.Videos.searchForVideos(), nv_python_libs.mashups.mashups_api.Videos.searchForVideos(), nv_python_libs.tedtalks.tedtalks_api.Videos.searchForVideos(), nv_python_libs.hulu.hulu_api.Videos.searchForVideos(), nv_python_libs.bbciplayer.bbciplayer_api.Videos.searchForVideos(), nv_python_libs.thewb.thewb_api.Videos.searchForVideos(), nv_python_libs.rev3.rev3_api.Videos.searchForVideos(), nv_python_libs.mnvsearch.mnvsearch_api.Videos.searchTitle(), nv_python_libs.hulu.hulu_api.Videos.searchTitle(), nv_python_libs.bbciplayer.bbciplayer_api.Videos.searchTitle(), 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.bbciplayer.bbciplayer_api.Videos.log_name

◆ logger

nv_python_libs.bbciplayer.bbciplayer_api.Videos.logger

◆ error_messages

nv_python_libs.bbciplayer.bbciplayer_api.Videos.error_messages

Definition at line 158 of file bbciplayer_api.py.

Referenced by nv_python_libs.mashups.mashups_api.Videos.displayTreeView(), nv_python_libs.hulu.hulu_api.Videos.displayTreeView(), nv_python_libs.bbciplayer.bbciplayer_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.bbciplayer.bbciplayer_api.Videos.getBBCConfig(), nv_python_libs.bliptv.bliptv_api.Videos.getCategories(), nv_python_libs.hulu.hulu_api.Videos.getHuluConfig(), nv_python_libs.mashups.mashups_api.Videos.getMashupsConfig(), 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.dailymotion.dailymotion_api.Videos.getVideosForGroupURL(), nv_python_libs.youtube.youtube_api.Videos.getVideosForURL(), nv_python_libs.mtv.mtv_api.Videos.getVideosForURL(), nv_python_libs.bliptv.bliptv_api.Videos.getVideosForURL(), nv_python_libs.dailymotion.dailymotion_api.Videos.getVideosForURL(), nv_python_libs.mashups.mashups_api.Videos.searchForVideos(), nv_python_libs.tedtalks.tedtalks_api.Videos.searchForVideos(), nv_python_libs.hulu.hulu_api.Videos.searchForVideos(), nv_python_libs.bbciplayer.bbciplayer_api.Videos.searchForVideos(), nv_python_libs.thewb.thewb_api.Videos.searchForVideos(), nv_python_libs.bliptv.bliptv_api.Videos.searchForVideos(), nv_python_libs.rev3.rev3_api.Videos.searchForVideos(), nv_python_libs.mnvsearch.mnvsearch_api.Videos.searchTitle(), nv_python_libs.hulu.hulu_api.Videos.searchTitle(), nv_python_libs.bbciplayer.bbciplayer_api.Videos.searchTitle(), 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.bliptv.bliptv_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().

◆ channel

nv_python_libs.bbciplayer.bbciplayer_api.Videos.channel

Definition at line 161 of file bbciplayer_api.py.

Referenced by nv_python_libs.mashups.mashups_api.Videos.displayTreeView(), nv_python_libs.hulu.hulu_api.Videos.displayTreeView(), nv_python_libs.bbciplayer.bbciplayer_api.Videos.displayTreeView(), 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.dailymotion.dailymotion_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.mnvsearch.mnvsearch_api.Videos.searchForVideos(), nv_python_libs.mashups.mashups_api.Videos.searchForVideos(), nv_python_libs.tedtalks.tedtalks_api.Videos.searchForVideos(), nv_python_libs.hulu.hulu_api.Videos.searchForVideos(), nv_python_libs.bbciplayer.bbciplayer_api.Videos.searchForVideos(), nv_python_libs.thewb.thewb_api.Videos.searchForVideos(), nv_python_libs.rev3.rev3_api.Videos.searchForVideos(), nv_python_libs.mnvsearch.mnvsearch_api.Videos.searchTitle(), nv_python_libs.hulu.hulu_api.Videos.searchTitle(), nv_python_libs.bbciplayer.bbciplayer_api.Videos.searchTitle(), nv_python_libs.youtube.youtube_api.Videos.searchTitle(), nv_python_libs.thewb.thewb_api.Videos.searchTitle(), nv_python_libs.rev3.rev3_api.Videos.searchTitle(), and nv_python_libs.vimeo.vimeo_api.Videos.searchTitle().

◆ countryCodeParsers

nv_python_libs.bbciplayer.bbciplayer_api.Videos.countryCodeParsers

◆ s_e_Patterns

nv_python_libs.bbciplayer.bbciplayer_api.Videos.s_e_Patterns

◆ channel_icon

nv_python_libs.bbciplayer.bbciplayer_api.Videos.channel_icon

◆ bbciplayer_config

nv_python_libs.bbciplayer.bbciplayer_api.Videos.bbciplayer_config

◆ userPrefs

nv_python_libs.bbciplayer.bbciplayer_api.Videos.userPrefs

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