nv_python_libs::bliptv::bliptv_api Namespace Reference

Classes
class	OutStreamEncoder
class	XmlHandler
class	Videos
Functions
def	detectUserLocationByIP
def	massageDescription
def	_initLogger
def	textUtf8
def	ampReplace
def	setTreeViewIcon
def	searchTitle
def	searchForVideos
def	getCategories
def	displayTreeView
def	makeURL
def	getVideos
def	getVideosForURL
Variables
string	__title__ = "bliptv_api - Simple-to-use Python interface to the bliptv API (http://blip.tv/about/api/)"
string	__author__ = "R.D. Vaughan"
string	__purpose__
string	__version__ = "v0.2.5"
	tree_dir_icon
	next_page
	channel
	treeview
	categories
	tree_key

---

Function Documentation

def nv_python_libs::bliptv::bliptv_api::detectUserLocationByIP

(

self

)

Get longitude and latitiude to find videos relative to your location. Up to three different
servers will be tried before giving up.
return a dictionary e.g.
{'Latitude': '43.6667', 'Country': 'Canada', 'Longitude': '-79.4167', 'City': 'Toronto'}
return an empty dictionary if there were any errors
Code found at: http://blog.suinova.com/2009/04/from-ip-to-geolocation-country-city.html

Definition at line 259 of file bliptv_api.py.

def nv_python_libs::bliptv::bliptv_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 318 of file bliptv_api.py.

def nv_python_libs::bliptv::bliptv_api::_initLogger

(

self

)

[private]

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

Definition at line 352 of file bliptv_api.py.

def nv_python_libs::bliptv::bliptv_api::textUtf8	(		self,
			text
	)

Definition at line 371 of file bliptv_api.py.

def nv_python_libs::bliptv::bliptv_api::ampReplace	(		self,
			text
	)

Replace all "&" characters with "&"

Definition at line 383 of file bliptv_api.py.

def nv_python_libs::bliptv::bliptv_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 390 of file bliptv_api.py.

def nv_python_libs::bliptv::bliptv_api::searchTitle	(		self,
			title,
			pagenumber,
			pagelen
	)

Key word video search of the blip.tv web site
return an array of matching item dictionaries
return

Definition at line 414 of file bliptv_api.py.

def nv_python_libs::bliptv::bliptv_api::searchForVideos	(		self,
			title,
			pagenumber
	)

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

Definition at line 517 of file bliptv_api.py.

def nv_python_libs::bliptv::bliptv_api::getCategories

(

self

)

Get the list of valid category ids and their name and update the proper dictionaries
return nothing

Definition at line 569 of file bliptv_api.py.

def nv_python_libs::bliptv::bliptv_api::displayTreeView

(

self

)

Gather the categories/feeds/...etc then retrieve a max page of videos meta data in each of them
return array of directories and their video meta data

Definition at line 625 of file bliptv_api.py.

def nv_python_libs::bliptv::bliptv_api::makeURL	(		self,
			URL
	)

Form a URL to search for videos
return a URL

Definition at line 653 of file bliptv_api.py.

def nv_python_libs::bliptv::bliptv_api::getVideos	(		self,
			dir_dict,
			dictionaries
	)

Parse a list made of categories and retrieve video meta data
return a dictionary of directory names and categories video meta data

Definition at line 679 of file bliptv_api.py.

def nv_python_libs::bliptv::bliptv_api::getVideosForURL	(		self,
			url,
			dictionaries
	)

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

Definition at line 710 of file bliptv_api.py.

---

Variable Documentation

string nv_python_libs::bliptv::bliptv_api::__title__ = "bliptv_api - Simple-to-use Python interface to the bliptv API (http://blip.tv/about/api/)"

Definition at line 15 of file bliptv_api.py.

string nv_python_libs::bliptv::bliptv_api::__author__ = "R.D. Vaughan"

Definition at line 16 of file bliptv_api.py.

string nv_python_libs::bliptv::bliptv_api::__purpose__

Initial value:

'''
This python script is intended to perform a variety of utility functions to search and access text
meta data, video and image URLs from blip.tv. These routines are based on the v2.0 api. Specifications
for this api are published at  http://blip.tv/about/api/
'''

Definition at line 17 of file bliptv_api.py.

string nv_python_libs::bliptv::bliptv_api::__version__ = "v0.2.5"

Definition at line 23 of file bliptv_api.py.

nv_python_libs::bliptv::bliptv_api::tree_dir_icon

Definition at line 394 of file bliptv_api.py.

nv_python_libs::bliptv::bliptv_api::next_page

Definition at line 438 of file bliptv_api.py.

nv_python_libs::bliptv::bliptv_api::channel

Definition at line 630 of file bliptv_api.py.

nv_python_libs::bliptv::bliptv_api::treeview

Definition at line 640 of file bliptv_api.py.

nv_python_libs::bliptv::bliptv_api::categories

Definition at line 644 of file bliptv_api.py.

Referenced by calendarComponent::calendarComponent(), calendarComponent::createCategories(), calendarComponent::deleteProperty(), calendarComponent::getConfig(), calendarComponent::getProperty(), VideoSelector::getVideoList(), ParseMetadataItem(), and calendarComponent::setCategories().

nv_python_libs::bliptv::bliptv_api::tree_key

Definition at line 647 of file bliptv_api.py.