SbsOnDemand::Media::Media Class Reference

Represents a media (rendition) for a single video. More...

List of all members.

Public Member Functions
def	__init__
	Creates a media object.
def	getUrl
	Get the raw url for the media.
def	getSMIL
	Get the raw SMIL data for the media.
def	getSMILDOM
	Get the SMIL data parsed by xml.dom.minidom.
def	getBaseUrl
	Get the base url.
def	getVideoUrl
	Get the video url.
def	getCaptions
	Get captions for the media.
Public Attributes
	audioChannels
	audioSampleRate
	bitrate
	checksums
	contentType
	duration
	expression
	fileSize
	frameRate
	format
	height
	isDefault
	language
	sourceTime
	url
	width
	assetTypes
Properties
	baseUrl = property(getBaseUrl)
	videoUrl = property(getVideoUrl)
	captions = property(getCaptions)
Private Member Functions
def	_parseSMIL
	Parse the SMIL data with xml.dom.minidom.
Private Attributes
	_smil
	_smilDOM

---

Detailed Description

Represents a media (rendition) for a single video.

---

Constructor & Destructor Documentation

def SbsOnDemand::Media::Media::__init__	(		self,
			params
	)

Creates a media object.

Parameters:

params

the media data

---

Member Function Documentation

def SbsOnDemand::Media::Media::_parseSMIL

(

self

)

[private]

Parse the SMIL data with xml.dom.minidom.

Warning:

This function is only valid for video media, calling it on other contentTypes will trigger a InvalidMediaType exception

def SbsOnDemand::Media::Media::getBaseUrl

(

self

)

Get the base url.

Returns:

the base url (usually for rtmp streams in the form of "rtmp://server/path?auth=token")

Warning:

This function is only valid for video media, calling it on other contentTypes will trigger a InvalidMediaType exception

def SbsOnDemand::Media::Media::getCaptions

(

self

)

Get captions for the media.

Returns:

an array of dict objects, each containing the src, lang, and type of the caption

Warning:

This function is only valid for video media, calling it on other contentTypes will trigger a InvalidMediaType exception

def SbsOnDemand::Media::Media::getSMIL

(

self

)

Get the raw SMIL data for the media.

Returns:

a string of raw SMIL data from the server

Warning:

This function is only valid for video media, calling it on other contentTypes will trigger a InvalidMediaType exception

def SbsOnDemand::Media::Media::getSMILDOM

(

self

)

Get the SMIL data parsed by xml.dom.minidom.

Returns:

a Document parsed by xml.dom.minidom

Warning:

This function is only valid for video media, calling it on other contentTypes will trigger a InvalidMediaType exception

def SbsOnDemand::Media::Media::getUrl

(

self

)

Get the raw url for the media.

Returns:

a absolute url to the content or SMIL file for the content

def SbsOnDemand::Media::Media::getVideoUrl

(

self

)

Get the video url.

Returns:

the video url (usually for rtmp streams in the form of "mp4:path/video.mp4")

Warning:

This function is only valid for video media, calling it on other contentTypes will trigger a InvalidMediaType exception

---

Property Documentation

SbsOnDemand::Media::Media::baseUrl = property(getBaseUrl) [static]

See also:

getBaseUrl

SbsOnDemand::Media::Media::captions = property(getCaptions) [static]

See also:

getCaptions

SbsOnDemand::Media::Media::videoUrl = property(getVideoUrl) [static]

See also:

getVideoUrl

---

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

• SbsOnDemand/Media.py