Inheritance diagram for nv_python_libs.mnvsearch.mnvsearch_api.Videos:

Collaboration diagram for nv_python_libs.mnvsearch.mnvsearch_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	searchTitle (self, title, pagenumber, pagelen, feedtitle=False)

def	searchForVideos (self, title, pagenumber, feedtitle=False)

def	getTreeviewData (self, searchTerms, pagenumber, pagelen, feedtitle=False)

Public Attributes
	config

	common

	log_name

	logger

	error_messages

	channel

	channel_icon

Detailed Description

Main interface to the MNV treeview table search
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 for this grabber

Definition at line 113 of file mnvsearch_api.py.

Constructor & Destructor Documentation

◆ init()

def nv_python_libs.mnvsearch.mnvsearch_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 121 of file mnvsearch_api.py.

Member Function Documentation

◆ searchTitle()

def nv_python_libs.mnvsearch.mnvsearch_api.Videos.searchTitle	(	self,
		title,
		pagenumber,
		pagelen,
		feedtitle = `False`
	)

Key word video search of the MNV treeview tables
return an array of matching item elements
return

Definition at line 194 of file mnvsearch_api.py.

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

◆ searchForVideos()

def nv_python_libs.mnvsearch.mnvsearch_api.Videos.searchForVideos	(	self,
		title,
		pagenumber,
		feedtitle = `False`
	)

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

Definition at line 287 of file mnvsearch_api.py.

◆ getTreeviewData()

def nv_python_libs.mnvsearch.mnvsearch_api.Videos.getTreeviewData	(	self,
		searchTerms,
		pagenumber,
		pagelen,
		feedtitle = `False`
	)

Use a SQL call to get any matching data base entries from the "netvisiontreeitems" and
"netvisionrssitems" tables. The search term can contain multiple search words separated
by a ";" character.
return a list of items found in the search or an empty dictionary if none were found

Definition at line 348 of file mnvsearch_api.py.

Referenced by nv_python_libs.mnvsearch.mnvsearch_api.Videos.searchTitle().