MythTV  master
Public Member Functions | Public Attributes | List of all members
nv_python_libs.rev3.rev3_api.Videos Class Reference
Inheritance diagram for nv_python_libs.rev3.rev3_api.Videos:
Inheritance graph
[legend]
Collaboration diagram for nv_python_libs.rev3.rev3_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 getRev3Config (self)
 Start - Utility functions. More...
 
def getUserPreferences (self)
 
def updateRev3 (self, create=False)
 
def getSeasonEpisode (self, title, link=None)
 
def getVideoID (self, link)
 
def searchTitle (self, title, pagenumber, pagelen)
 End of Utility functions. More...
 
def searchForVideos (self, title, pagenumber)
 
def displayTreeView (self)
 

Public Attributes

 config
 
 common
 
 log_name
 
 logger
 
 error_messages
 
 channel
 
 s_e_Patterns
 
 FullScreen
 
 FullScreenParser
 
 FullScreenVidIDxPath
 
 channel_icon
 
 rev3_config
 
 userPrefs
 

Detailed Description

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

Definition at line 93 of file rev3_api.py.

Constructor & Destructor Documentation

◆ __init__()

def nv_python_libs.rev3.rev3_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 rev3_api.py.

Member Function Documentation

◆ getRev3Config()

def nv_python_libs.rev3.rev3_api.Videos.getRev3Config (   self)

Start - Utility functions.

Read the MNV Revision3 grabber "rev3_config.xml" configuration file
return nothing

Definition at line 196 of file rev3_api.py.

Referenced by nv_python_libs.rev3.rev3_api.Videos.getUserPreferences(), and nv_python_libs.rev3.rev3_api.Videos.searchForVideos().

◆ getUserPreferences()

def nv_python_libs.rev3.rev3_api.Videos.getUserPreferences (   self)
Read the rev3_config.xml and user preference rev3.xml file.
If the rev3.xml file does not exist then create it.
If the rev3.xml file is too old then update it.
return nothing

Definition at line 216 of file rev3_api.py.

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

◆ updateRev3()

def nv_python_libs.rev3.rev3_api.Videos.updateRev3 (   self,
  create = False 
)
Create or update the rev3.xml user preferences file
return nothing

Definition at line 254 of file rev3_api.py.

◆ getSeasonEpisode()

def nv_python_libs.rev3.rev3_api.Videos.getSeasonEpisode (   self,
  title,
  link = None 
)
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 437 of file rev3_api.py.

Referenced by nv_python_libs.rev3.rev3_api.Videos.displayTreeView(), nv_python_libs.rev3.rev3_api.Videos.searchTitle(), and nv_python_libs.thewb.thewb_api.Videos.searchTitle().

◆ getVideoID()

def nv_python_libs.rev3.rev3_api.Videos.getVideoID (   self,
  link 
)
Read the Web page to find the video ID number used for fullscreen autoplay
return the video ID number
return None if the number cannot be found

Definition at line 461 of file rev3_api.py.

Referenced by nv_python_libs.rev3.rev3_api.Videos.displayTreeView().

◆ searchTitle()

def nv_python_libs.rev3.rev3_api.Videos.searchTitle (   self,
  title,
  pagenumber,
  pagelen 
)

End of Utility functions.

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

Definition at line 502 of file rev3_api.py.

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

◆ searchForVideos()

def nv_python_libs.rev3.rev3_api.Videos.searchForVideos (   self,
  title,
  pagenumber 
)
Common name for a video search. Used to interface with MythTV plugin NetVision

Definition at line 581 of file rev3_api.py.

◆ displayTreeView()

def nv_python_libs.rev3.rev3_api.Videos.displayTreeView (   self)
Gather the Revision3 feeds then get a max page of videos meta data in each of them
Display the results and exit

Definition at line 645 of file rev3_api.py.

Member Data Documentation

◆ config

nv_python_libs.rev3.rev3_api.Videos.config

Definition at line 134 of file rev3_api.py.

Referenced by nv_python_libs.vimeo.vimeo_api.Videos._initLogger(), nv_python_libs.youtube.youtube_api.Videos._initLogger(), nv_python_libs.rev3.rev3_api.Videos.displayTreeView(), nv_python_libs.thewb.thewb_api.Videos.displayTreeView(), nv_python_libs.vimeo.vimeo_api.Videos.displayTreeView(), giantbomb.giantbomb_api.gamedbQueries.gameData(), giantbomb.giantbomb_api.gamedbQueries.gameSearch(), 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.rev3.rev3_api.Videos.getUserPreferences(), nv_python_libs.tedtalks.tedtalks_api.Videos.getUserPreferences(), nv_python_libs.thewb.thewb_api.Videos.getUserPreferences(), nv_python_libs.youtube.youtube_api.Videos.getUserPreferences(), nv_python_libs.youtube.youtube_api.Videos.getVideoCategories(), nv_python_libs.rev3.rev3_api.Videos.getVideoID(), nv_python_libs.vimeo.vimeo_api.Videos.getVideos(), nv_python_libs.youtube.youtube_api.Videos.getVideosForURL(), 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.rev3.rev3_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.updateRev3(), nv_python_libs.tedtalks.tedtalks_api.Videos.updateTedTalks(), and nv_python_libs.thewb.thewb_api.Videos.updateTheWB().

◆ common

nv_python_libs.rev3.rev3_api.Videos.common

◆ log_name

nv_python_libs.rev3.rev3_api.Videos.log_name

◆ logger

nv_python_libs.rev3.rev3_api.Videos.logger

Definition at line 147 of file rev3_api.py.

◆ error_messages

nv_python_libs.rev3.rev3_api.Videos.error_messages

◆ channel

nv_python_libs.rev3.rev3_api.Videos.channel

◆ s_e_Patterns

nv_python_libs.rev3.rev3_api.Videos.s_e_Patterns

◆ FullScreen

nv_python_libs.rev3.rev3_api.Videos.FullScreen

◆ FullScreenParser

nv_python_libs.rev3.rev3_api.Videos.FullScreenParser

◆ FullScreenVidIDxPath

nv_python_libs.rev3.rev3_api.Videos.FullScreenVidIDxPath

Definition at line 176 of file rev3_api.py.

Referenced by nv_python_libs.rev3.rev3_api.Videos.getVideoID().

◆ channel_icon

nv_python_libs.rev3.rev3_api.Videos.channel_icon

◆ rev3_config

nv_python_libs.rev3.rev3_api.Videos.rev3_config

◆ userPrefs

nv_python_libs.rev3.rev3_api.Videos.userPrefs

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