nv_python_libs::mtv::mtv_api Namespace Reference

Classes
class	OutStreamEncoder
class	XmlHandler
class	Videos
Functions
def	massageDescription
def	_initLogger
def	textUtf8
def	ampReplace
def	setTreeViewIcon
def	searchTitle
def	videoDetails
def	searchForVideos
def	displayTreeView
def	makeURL
def	getVideos
def	getVideosForURL
Variables
string	__title__ = "mtv_api - Simple-to-use Python interface to the MTV API (http://developer.mtvnservices.com/docs)"
string	__author__ = "R.D. Vaughan"
string	__purpose__
string	__version__ = "v0.2.5"
	tree_dir_icon
	grabber_title
	channel
	tree_key

---

Function Documentation

def nv_python_libs::mtv::mtv_api::massageDescription	(		self,
			text
	)

Removes HTML markup from a text string.
@param text The HTML source.
@return The plain text.  If the HTML source contains non-ASCII
entities or character references, this is a Unicode string.

Definition at line 256 of file mtv_api.py.

def nv_python_libs::mtv::mtv_api::_initLogger

(

self

)

[private]

Setups a logger using the logging module, returns a log object

Definition at line 290 of file mtv_api.py.

def nv_python_libs::mtv::mtv_api::textUtf8	(		self,
			text
	)

Definition at line 309 of file mtv_api.py.

def nv_python_libs::mtv::mtv_api::ampReplace	(		self,
			text
	)

Replace all "&" characters with "&"

Definition at line 321 of file mtv_api.py.

def nv_python_libs::mtv::mtv_api::setTreeViewIcon	(		self,
			dir_icon = None
	)

Check if there is a specific generic tree view icon. If not default to the channel icon.
return self.tree_dir_icon

Definition at line 329 of file mtv_api.py.

def nv_python_libs::mtv::mtv_api::searchTitle	(		self,
			title,
			pagenumber,
			pagelen
	)

Key word video search of the MTV web site
return an array of matching item dictionaries
return

Definition at line 353 of file mtv_api.py.

def nv_python_libs::mtv::mtv_api::videoDetails	(		self,
			url,
			title = u''
	)

Using the passed URL retrieve the video meta data details
return a dictionary of video metadata details
return

Definition at line 448 of file mtv_api.py.

def nv_python_libs::mtv::mtv_api::searchForVideos	(		self,
			title,
			pagenumber
	)

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

Definition at line 501 of file mtv_api.py.

def nv_python_libs::mtv::mtv_api::displayTreeView

(

self

)

Gather the MTV Genres/Artists/...etc then get a max page of videos meta data in each of them
return array of directories and their video metadata

Definition at line 572 of file mtv_api.py.

def nv_python_libs::mtv::mtv_api::makeURL	(		self,
			URL
	)

Form a URL to search for videos
return a URL

Definition at line 600 of file mtv_api.py.

def nv_python_libs::mtv::mtv_api::getVideos	(		self,
			dir_dict,
			dictionaries
	)

Parse a list made of genres/artists ... etc lists and retrieve video meta data
return a dictionary of directory names and categories video metadata

Definition at line 626 of file mtv_api.py.

def nv_python_libs::mtv::mtv_api::getVideosForURL	(		self,
			url,
			dictionaries
	)

Get the video metadata for url search
return the video dictionary of directories and their video mata data

Definition at line 661 of file mtv_api.py.

---

Variable Documentation

string nv_python_libs::mtv::mtv_api::__title__ = "mtv_api - Simple-to-use Python interface to the MTV API (http://developer.mtvnservices.com/docs)"

Definition at line 14 of file mtv_api.py.

string nv_python_libs::mtv::mtv_api::__author__ = "R.D. Vaughan"

Definition at line 15 of file mtv_api.py.

string nv_python_libs::mtv::mtv_api::__purpose__

Initial value:

'''
This python script is intended to perform a variety of utility functions to search and access text
metadata, video and image URLs from MTV. These routines are based on the api. Specifications
for this api are published at http://developer.mtvnservices.com/docs
'''

Definition at line 16 of file mtv_api.py.

string nv_python_libs::mtv::mtv_api::__version__ = "v0.2.5"

Definition at line 22 of file mtv_api.py.

nv_python_libs::mtv::mtv_api::tree_dir_icon

Definition at line 333 of file mtv_api.py.

nv_python_libs::mtv::mtv_api::grabber_title

Definition at line 505 of file mtv_api.py.

nv_python_libs::mtv::mtv_api::channel

Definition at line 577 of file mtv_api.py.

nv_python_libs::mtv::mtv_api::tree_key

Definition at line 594 of file mtv_api.py.