MythTV  master
Public Member Functions | Public Attributes | List of all members
nv_python_libs.pbs.pbs_api.Videos Class Reference
Inheritance diagram for nv_python_libs.pbs.pbs_api.Videos:
Inheritance graph
Collaboration diagram for nv_python_libs.pbs.pbs_api.Videos:
Collaboration graph

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


Detailed Description

Main interface to
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

Definition at line 102 of file

Constructor & Destructor Documentation

◆ __init__()

def nv_python_libs.pbs.pbs_api.Videos.__init__ (   self,
  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

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

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

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

◆ searchForVideos()

def nv_python_libs.pbs.pbs_api.Videos.searchForVideos (   self,

End of Utility functions.

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

Definition at line 374 of file

◆ 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

Member Data Documentation

◆ config


Definition at line 143 of file

Referenced by, nv_python_libs.vimeo.vimeo_api.Videos._initLogger(), nv_python_libs.thewb.thewb_api.Videos.displayTreeView(), nv_python_libs.rev3.rev3_api.Videos.displayTreeView(), nv_python_libs.vimeo.vimeo_api.Videos.displayTreeView(), giantbomb.giantbomb_api.gamedbQueries.gameData(), giantbomb.giantbomb_api.gamedbQueries.gameSearch(), nv_python_libs.pbs.pbs_api.Videos.getPBSConfig(), nv_python_libs.rev3.rev3_api.Videos.getRev3Config(),, nv_python_libs.tedtalks.tedtalks_api.Videos.getTedTalksConfig(), nv_python_libs.thewb.thewb_api.Videos.getTheWBConfig(),, 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.thewb.thewb_api.Videos.getUserPreferences(),, nv_python_libs.rev3.rev3_api.Videos.getVideoID(), nv_python_libs.vimeo.vimeo_api.Videos.getVideos(),, 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(), nv_python_libs.tedtalks.tedtalks_api.Videos.updateTedTalks(), and nv_python_libs.thewb.thewb_api.Videos.updateTheWB().

◆ common


◆ log_name


◆ logger


Definition at line 156 of file

◆ error_messages


◆ channel

◆ channel_icon


◆ mashups_api


◆ pbs_config


◆ userPrefs


◆ Search


Definition at line 389 of file

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

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