Package elisa :: Package core :: Module media_file :: Class MediaFile
[hide private]
[frames] | no frames]

Class MediaFile

source code


This class provides a file-like API to access data at a given URI.

MediaFiles are created by elisa.base_components.media_provider.MediaProvider objects. They act as proxies to the latter, thus are bound to MediaProviders.

Nested Classes [hide private]
  __metaclass__
Instance Methods [hide private]
 
__init__(self, media_provider, descriptor)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
close(self)
Close myself via my media_provider
source code
 
descriptor__get(self)
Descriptor readonly access
source code
 
read(self, size=-1)
Read some data from my descriptor using my media_provider
source code
 
seek(self, offset, whence=0)
Seek to given offset of my descriptor, via my media_provider
source code
 
_blocking_read(self, size=-1) source code
 
_blocking_seek(self, offset, whence=0) source code
 
_blocking_close(self) source code

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Static Methods [hide private]
 
__classinit__(cls, new_attrs)
Given a class and a new set of attributes (as passed in by __classinit__), create or modify properties based on functions with special names ending in __get, __set, and __del.
source code
Class Variables [hide private]
  name = 'media_file'
Instance Variables [hide private]
object descriptor
media descriptor symbolizing the opened media
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, media_provider, descriptor)
(Constructor)

source code 
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Parameters:
Overrides: object.__init__

read(self, size=-1)

source code 
Read some data from my descriptor using my media_provider
Parameters:
  • size (int) - length of data to retrieve. The media_provider will do its best to fetch that amount of data. size = -1 means retrieving all available data at once
Returns:
string

seek(self, offset, whence=0)

source code 
Seek to given offset of my descriptor, via my media_provider
Parameters:
  • offset (int) - how much to seek in the file
  • whence (int) - from where to seek in the file, default=0 means current position
Returns:
bool

Instance Variable Details [hide private]

descriptor

media descriptor symbolizing the opened media
Get Method:
elisa.core.media_file.MediaFile.descriptor__get(self) - Descriptor readonly access
Set Method:
'frontend'
Delete Method:
'frontend'