home *** CD-ROM | disk | FTP | other *** search
- # This file was automatically generated by SWIG (http://www.swig.org).
- # Version 1.3.31
- #
- # Don't modify this file, modify the SWIG interface instead.
- # This file is compatible with both classic and new-style classes.
-
- import _mc
- import new
- new_instancemethod = new.instancemethod
- try:
- _swig_property = property
- except NameError:
- pass # Python < 2.2 doesn't have 'property'.
- def _swig_setattr_nondynamic(self,class_type,name,value,static=1):
- if (name == "thisown"): return self.this.own(value)
- if (name == "this"):
- if type(value).__name__ == 'PySwigObject':
- self.__dict__[name] = value
- return
- method = class_type.__swig_setmethods__.get(name,None)
- if method: return method(self,value)
- if (not static) or hasattr(self,name):
- self.__dict__[name] = value
- else:
- raise AttributeError("You cannot add attributes to %s" % self)
-
- def _swig_setattr(self,class_type,name,value):
- return _swig_setattr_nondynamic(self,class_type,name,value,0)
-
- def _swig_getattr(self,class_type,name):
- if (name == "thisown"): return self.this.own()
- method = class_type.__swig_getmethods__.get(name,None)
- if method: return method(self)
- raise AttributeError,name
-
- def _swig_repr(self):
- try: strthis = "proxy of " + self.this.__repr__()
- except: strthis = ""
- return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
-
- import types
- try:
- _object = types.ObjectType
- _newclass = 1
- except AttributeError:
- class _object : pass
- _newclass = 0
- del types
-
-
- class PySwigIterator(_object):
- """1"""
- __swig_setmethods__ = {}
- __setattr__ = lambda self, name, value: _swig_setattr(self, PySwigIterator, name, value)
- __swig_getmethods__ = {}
- __getattr__ = lambda self, name: _swig_getattr(self, PySwigIterator, name)
- def __init__(self): raise AttributeError, "No constructor defined"
- __repr__ = _swig_repr
- __swig_destroy__ = _mc.delete_PySwigIterator
- __del__ = lambda self : None;
- def value(*args):
- """
- value(self) -> PyObject
-
- 1
- """
- return _mc.PySwigIterator_value(*args)
-
- def incr(*args):
- """
- incr(self, size_t n=1) -> PySwigIterator
- incr(self) -> PySwigIterator
-
- 1
- """
- return _mc.PySwigIterator_incr(*args)
-
- def decr(*args):
- """
- decr(self, size_t n=1) -> PySwigIterator
- decr(self) -> PySwigIterator
-
- 1
- """
- return _mc.PySwigIterator_decr(*args)
-
- def distance(*args):
- """
- distance(self, PySwigIterator x) -> ptrdiff_t
-
- 1
- """
- return _mc.PySwigIterator_distance(*args)
-
- def equal(*args):
- """
- equal(self, PySwigIterator x) -> bool
-
- 1
- """
- return _mc.PySwigIterator_equal(*args)
-
- def copy(*args):
- """
- copy(self) -> PySwigIterator
-
- 1
- """
- return _mc.PySwigIterator_copy(*args)
-
- def next(*args):
- """
- next(self) -> PyObject
-
- 1
- """
- return _mc.PySwigIterator_next(*args)
-
- def previous(*args):
- """
- previous(self) -> PyObject
-
- 1
- """
- return _mc.PySwigIterator_previous(*args)
-
- def advance(*args):
- """
- advance(self, ptrdiff_t n) -> PySwigIterator
-
- 1
- """
- return _mc.PySwigIterator_advance(*args)
-
- def __eq__(*args):
- """
- __eq__(self, PySwigIterator x) -> bool
-
- 1
- """
- return _mc.PySwigIterator___eq__(*args)
-
- def __ne__(*args):
- """
- __ne__(self, PySwigIterator x) -> bool
-
- 1
- """
- return _mc.PySwigIterator___ne__(*args)
-
- def __iadd__(*args):
- """
- __iadd__(self, ptrdiff_t n) -> PySwigIterator
-
- 1
- """
- return _mc.PySwigIterator___iadd__(*args)
-
- def __isub__(*args):
- """
- __isub__(self, ptrdiff_t n) -> PySwigIterator
-
- 1
- """
- return _mc.PySwigIterator___isub__(*args)
-
- def __add__(*args):
- """
- __add__(self, ptrdiff_t n) -> PySwigIterator
-
- 1
- """
- return _mc.PySwigIterator___add__(*args)
-
- def __sub__(*args):
- """
- __sub__(self, ptrdiff_t n) -> PySwigIterator
- __sub__(self, PySwigIterator x) -> ptrdiff_t
-
- 1
- """
- return _mc.PySwigIterator___sub__(*args)
-
- def __iter__(self): return self
- PySwigIterator_swigregister = _mc.PySwigIterator_swigregister
- PySwigIterator_swigregister(PySwigIterator)
-
- class stdParameters(_object):
- """1"""
- __swig_setmethods__ = {}
- __setattr__ = lambda self, name, value: _swig_setattr(self, stdParameters, name, value)
- __swig_getmethods__ = {}
- __getattr__ = lambda self, name: _swig_getattr(self, stdParameters, name)
- __repr__ = _swig_repr
- def iterator(*args):
- """
- iterator(self, PyObject PYTHON_SELF) -> PySwigIterator
-
- 1
- """
- return _mc.stdParameters_iterator(*args)
-
- def __iter__(self): return self.iterator()
- def __nonzero__(*args):
- """
- __nonzero__(self) -> bool
-
- 1
- """
- return _mc.stdParameters___nonzero__(*args)
-
- def __len__(*args):
- """
- __len__(self) -> size_type
-
- 1
- """
- return _mc.stdParameters___len__(*args)
-
- def __getitem__(*args):
- """
- __getitem__(self, key_type key) -> mapped_type
-
- 1
- """
- return _mc.stdParameters___getitem__(*args)
-
- def __delitem__(*args):
- """
- __delitem__(self, key_type key)
-
- 1
- """
- return _mc.stdParameters___delitem__(*args)
-
- def has_key(*args):
- """
- has_key(self, key_type key) -> bool
-
- 1
- """
- return _mc.stdParameters_has_key(*args)
-
- def keys(*args):
- """
- keys(self) -> PyObject
-
- 1
- """
- return _mc.stdParameters_keys(*args)
-
- def values(*args):
- """
- values(self) -> PyObject
-
- 1
- """
- return _mc.stdParameters_values(*args)
-
- def items(*args):
- """
- items(self) -> PyObject
-
- 1
- """
- return _mc.stdParameters_items(*args)
-
- def __contains__(*args):
- """
- __contains__(self, key_type key) -> bool
-
- 1
- """
- return _mc.stdParameters___contains__(*args)
-
- def key_iterator(*args):
- """
- key_iterator(self, PyObject PYTHON_SELF) -> PySwigIterator
-
- 1
- """
- return _mc.stdParameters_key_iterator(*args)
-
- def value_iterator(*args):
- """
- value_iterator(self, PyObject PYTHON_SELF) -> PySwigIterator
-
- 1
- """
- return _mc.stdParameters_value_iterator(*args)
-
- def __iter__(self): return self.key_iterator()
- def iterkeys(self): return self.key_iterator()
- def itervalues(self): return self.value_iterator()
- def iteritems(self): return self.iterator()
- def __setitem__(*args):
- """
- __setitem__(self, key_type key, mapped_type x)
-
- 1
- """
- return _mc.stdParameters___setitem__(*args)
-
- def __init__(self, *args):
- """
- __init__(self) -> stdParameters
- __init__(self, stdParameters ?) -> stdParameters
-
- 1
- """
- this = _mc.new_stdParameters(*args)
- try: self.this.append(this)
- except: self.this = this
- def empty(*args):
- """
- empty(self) -> bool
-
- 1
- """
- return _mc.stdParameters_empty(*args)
-
- def size(*args):
- """
- size(self) -> size_type
-
- 1
- """
- return _mc.stdParameters_size(*args)
-
- def clear(*args):
- """
- clear(self)
-
- 1
- """
- return _mc.stdParameters_clear(*args)
-
- def swap(*args):
- """
- swap(self, stdParameters v)
-
- 1
- """
- return _mc.stdParameters_swap(*args)
-
- def get_allocator(*args):
- """
- get_allocator(self) -> allocator_type
-
- 1
- """
- return _mc.stdParameters_get_allocator(*args)
-
- def begin(*args):
- """
- begin(self) -> iterator
- begin(self) -> const_iterator
-
- 1
- """
- return _mc.stdParameters_begin(*args)
-
- def end(*args):
- """
- end(self) -> iterator
- end(self) -> const_iterator
-
- 1
- """
- return _mc.stdParameters_end(*args)
-
- def rbegin(*args):
- """
- rbegin(self) -> reverse_iterator
- rbegin(self) -> const_reverse_iterator
-
- 1
- """
- return _mc.stdParameters_rbegin(*args)
-
- def rend(*args):
- """
- rend(self) -> reverse_iterator
- rend(self) -> const_reverse_iterator
-
- 1
- """
- return _mc.stdParameters_rend(*args)
-
- def count(*args):
- """
- count(self, key_type x) -> size_type
-
- 1
- """
- return _mc.stdParameters_count(*args)
-
- def erase(*args):
- """
- erase(self, key_type x) -> size_type
- erase(self, iterator position)
- erase(self, iterator first, iterator last)
-
- 1
- """
- return _mc.stdParameters_erase(*args)
-
- def find(*args):
- """
- find(self, key_type x) -> iterator
- find(self, key_type x) -> const_iterator
-
- 1
- """
- return _mc.stdParameters_find(*args)
-
- def lower_bound(*args):
- """
- lower_bound(self, key_type x) -> iterator
- lower_bound(self, key_type x) -> const_iterator
-
- 1
- """
- return _mc.stdParameters_lower_bound(*args)
-
- def upper_bound(*args):
- """
- upper_bound(self, key_type x) -> iterator
- upper_bound(self, key_type x) -> const_iterator
-
- 1
- """
- return _mc.stdParameters_upper_bound(*args)
-
- __swig_destroy__ = _mc.delete_stdParameters
- __del__ = lambda self : None;
- stdParameters_swigregister = _mc.stdParameters_swigregister
- stdParameters_swigregister(stdParameters)
-
- class stdListItems(_object):
- """1"""
- __swig_setmethods__ = {}
- __setattr__ = lambda self, name, value: _swig_setattr(self, stdListItems, name, value)
- __swig_getmethods__ = {}
- __getattr__ = lambda self, name: _swig_getattr(self, stdListItems, name)
- __repr__ = _swig_repr
- def iterator(*args):
- """
- iterator(self, PyObject PYTHON_SELF) -> PySwigIterator
-
- 1
- """
- return _mc.stdListItems_iterator(*args)
-
- def __iter__(self): return self.iterator()
- def __nonzero__(*args):
- """
- __nonzero__(self) -> bool
-
- 1
- """
- return _mc.stdListItems___nonzero__(*args)
-
- def __len__(*args):
- """
- __len__(self) -> size_type
-
- 1
- """
- return _mc.stdListItems___len__(*args)
-
- def pop(*args):
- """
- pop(self) -> value_type
-
- 1
- """
- return _mc.stdListItems_pop(*args)
-
- def __getslice__(*args):
- """
- __getslice__(self, difference_type i, difference_type j) -> stdListItems
-
- 1
- """
- return _mc.stdListItems___getslice__(*args)
-
- def __setslice__(*args):
- """
- __setslice__(self, difference_type i, difference_type j, stdListItems v)
-
- 1
- """
- return _mc.stdListItems___setslice__(*args)
-
- def __delslice__(*args):
- """
- __delslice__(self, difference_type i, difference_type j)
-
- 1
- """
- return _mc.stdListItems___delslice__(*args)
-
- def __delitem__(*args):
- """
- __delitem__(self, difference_type i)
-
- 1
- """
- return _mc.stdListItems___delitem__(*args)
-
- def __getitem__(*args):
- """
- __getitem__(self, difference_type i) -> value_type
-
- 1
- """
- return _mc.stdListItems___getitem__(*args)
-
- def __setitem__(*args):
- """
- __setitem__(self, difference_type i, value_type x)
-
- 1
- """
- return _mc.stdListItems___setitem__(*args)
-
- def append(*args):
- """
- append(self, value_type x)
-
- 1
- """
- return _mc.stdListItems_append(*args)
-
- def empty(*args):
- """
- empty(self) -> bool
-
- 1
- """
- return _mc.stdListItems_empty(*args)
-
- def size(*args):
- """
- size(self) -> size_type
-
- 1
- """
- return _mc.stdListItems_size(*args)
-
- def clear(*args):
- """
- clear(self)
-
- 1
- """
- return _mc.stdListItems_clear(*args)
-
- def swap(*args):
- """
- swap(self, stdListItems v)
-
- 1
- """
- return _mc.stdListItems_swap(*args)
-
- def get_allocator(*args):
- """
- get_allocator(self) -> allocator_type
-
- 1
- """
- return _mc.stdListItems_get_allocator(*args)
-
- def begin(*args):
- """
- begin(self) -> iterator
- begin(self) -> const_iterator
-
- 1
- """
- return _mc.stdListItems_begin(*args)
-
- def end(*args):
- """
- end(self) -> iterator
- end(self) -> const_iterator
-
- 1
- """
- return _mc.stdListItems_end(*args)
-
- def rbegin(*args):
- """
- rbegin(self) -> reverse_iterator
- rbegin(self) -> const_reverse_iterator
-
- 1
- """
- return _mc.stdListItems_rbegin(*args)
-
- def rend(*args):
- """
- rend(self) -> reverse_iterator
- rend(self) -> const_reverse_iterator
-
- 1
- """
- return _mc.stdListItems_rend(*args)
-
- def pop_back(*args):
- """
- pop_back(self)
-
- 1
- """
- return _mc.stdListItems_pop_back(*args)
-
- def erase(*args):
- """
- erase(self, iterator pos) -> iterator
- erase(self, iterator first, iterator last) -> iterator
-
- 1
- """
- return _mc.stdListItems_erase(*args)
-
- def __init__(self, *args):
- """
- __init__(self) -> stdListItems
- __init__(self, stdListItems ?) -> stdListItems
- __init__(self, size_type size) -> stdListItems
- __init__(self, size_type size, value_type value) -> stdListItems
-
- 1
- """
- this = _mc.new_stdListItems(*args)
- try: self.this.append(this)
- except: self.this = this
- def push_back(*args):
- """
- push_back(self, value_type x)
-
- 1
- """
- return _mc.stdListItems_push_back(*args)
-
- def front(*args):
- """
- front(self) -> value_type
-
- 1
- """
- return _mc.stdListItems_front(*args)
-
- def back(*args):
- """
- back(self) -> value_type
-
- 1
- """
- return _mc.stdListItems_back(*args)
-
- def assign(*args):
- """
- assign(self, size_type n, value_type x)
-
- 1
- """
- return _mc.stdListItems_assign(*args)
-
- def resize(*args):
- """
- resize(self, size_type new_size)
- resize(self, size_type new_size, value_type x)
-
- 1
- """
- return _mc.stdListItems_resize(*args)
-
- def insert(*args):
- """
- insert(self, iterator pos, value_type x) -> iterator
- insert(self, iterator pos, size_type n, value_type x)
-
- 1
- """
- return _mc.stdListItems_insert(*args)
-
- def reserve(*args):
- """
- reserve(self, size_type n)
-
- 1
- """
- return _mc.stdListItems_reserve(*args)
-
- def capacity(*args):
- """
- capacity(self) -> size_type
-
- 1
- """
- return _mc.stdListItems_capacity(*args)
-
- __swig_destroy__ = _mc.delete_stdListItems
- __del__ = lambda self : None;
- stdListItems_swigregister = _mc.stdListItems_swigregister
- stdListItems_swigregister(stdListItems)
-
- class ListItem(_object):
- """
- This class represents an item that is displayed in a user interface
- List or part of a playlist.
-
- It contains a long site of properties that are common for media items.
- Additional custom properties can be used as well. Most of the
- properties are optional. The required properties are: label, path,
- content type and media type.
- """
- __swig_setmethods__ = {}
- __setattr__ = lambda self, name, value: _swig_setattr(self, ListItem, name, value)
- __swig_getmethods__ = {}
- __getattr__ = lambda self, name: _swig_getattr(self, ListItem, name)
- __repr__ = _swig_repr
- MEDIA_UNKNOWN = _mc.ListItem_MEDIA_UNKNOWN
- MEDIA_AUDIO_MUSIC = _mc.ListItem_MEDIA_AUDIO_MUSIC
- MEDIA_AUDIO_SPEECH = _mc.ListItem_MEDIA_AUDIO_SPEECH
- MEDIA_AUDIO_RADIO = _mc.ListItem_MEDIA_AUDIO_RADIO
- MEDIA_AUDIO_OTHER = _mc.ListItem_MEDIA_AUDIO_OTHER
- MEDIA_VIDEO_MUSIC_VIDEO = _mc.ListItem_MEDIA_VIDEO_MUSIC_VIDEO
- MEDIA_VIDEO_FEATURE_FILM = _mc.ListItem_MEDIA_VIDEO_FEATURE_FILM
- MEDIA_VIDEO_TRAILER = _mc.ListItem_MEDIA_VIDEO_TRAILER
- MEDIA_VIDEO_EPISODE = _mc.ListItem_MEDIA_VIDEO_EPISODE
- MEDIA_VIDEO_CLIP = _mc.ListItem_MEDIA_VIDEO_CLIP
- MEDIA_VIDEO_OTHER = _mc.ListItem_MEDIA_VIDEO_OTHER
- MEDIA_PICTURE = _mc.ListItem_MEDIA_PICTURE
- MEDIA_FILE = _mc.ListItem_MEDIA_FILE
- def __init__(self, *args):
- """
- __init__(self, MediaType mediaType=MEDIA_UNKNOWN) -> ListItem
- __init__(self) -> ListItem
- __init__(self, CFileItemPtr item) -> ListItem
-
- Constructor to create a new list item.
-
- Parameters:
- -----------
-
- mediaType: the type of media that the list item represents.
- """
- this = _mc.new_ListItem(*args)
- try: self.this.append(this)
- except: self.this = this
- def SetLabel(*args):
- """
- SetLabel(self, string label)
-
- Sets the label.
- """
- return _mc.ListItem_SetLabel(*args)
-
- def SetPath(*args):
- """
- SetPath(self, string path)
-
- Sets the path.
-
- It could be either a local file or a URL with the protocols:http://,
- mms:// or flash:// (flash is described in the RSS specification).
- """
- return _mc.ListItem_SetPath(*args)
-
- def SetContentType(*args):
- """
- SetContentType(self, string contentType)
-
- Sets the content type.
- """
- return _mc.ListItem_SetContentType(*args)
-
- def SetTitle(*args):
- """
- SetTitle(self, string title)
-
- Sets the title.
- """
- return _mc.ListItem_SetTitle(*args)
-
- def SetThumbnail(*args):
- """
- SetThumbnail(self, string thumbnail)
-
- Sets the thumbnail.
-
- Could be either a local file or a URL with the protocolhttp://. The
- thumbnail will be scaled to 200x200, so it can not be used for
- displaying large images.
- """
- return _mc.ListItem_SetThumbnail(*args)
-
- def SetIcon(*args):
- """
- SetIcon(self, string thumbnail)
-
- Sets the icon.
-
- Could be either a local file or a URL with the protocolhttp://. The
- icon will be scaled to 200x200, so it can not be used for displaying
- large images.
- """
- return _mc.ListItem_SetIcon(*args)
-
- def SetTrackNumber(*args):
- """
- SetTrackNumber(self, int trackNumber)
-
- Sets the track number for audio CDs.
- """
- return _mc.ListItem_SetTrackNumber(*args)
-
- def SetArtist(*args):
- """
- SetArtist(self, string artist)
-
- Sets the arist name.
- """
- return _mc.ListItem_SetArtist(*args)
-
- def SetAlbum(*args):
- """
- SetAlbum(self, string album)
-
- Sets the album name.
- """
- return _mc.ListItem_SetAlbum(*args)
-
- def SetYear(*args):
- """
- SetYear(self, int year)
-
- Sets the release year.
- """
- return _mc.ListItem_SetYear(*args)
-
- def SetDate(*args):
- """
- SetDate(self, int year, int month, int day)
-
- Sets the release date.
- """
- return _mc.ListItem_SetDate(*args)
-
- def SetGenre(*args):
- """
- SetGenre(self, string genre)
-
- Sets the genre.
- """
- return _mc.ListItem_SetGenre(*args)
-
- def SetDirector(*args):
- """
- SetDirector(self, string director)
-
- Sets the director for video media.
- """
- return _mc.ListItem_SetDirector(*args)
-
- def SetSize(*args):
- """
- SetSize(self, int size)
-
- Sets the file size.
- """
- return _mc.ListItem_SetSize(*args)
-
- def SetDuration(*args):
- """
- SetDuration(self, int seconds)
-
- Sets the duration in seconds.
- """
- return _mc.ListItem_SetDuration(*args)
-
- def SetStarRating(*args):
- """
- SetStarRating(self, float rating)
-
- Sets the star rating for the content.
-
- Should be a value between 0 and 10.
- """
- return _mc.ListItem_SetStarRating(*args)
-
- def SetViewCount(*args):
- """
- SetViewCount(self, int viewCount)
-
- Sets the number of views.
- """
- return _mc.ListItem_SetViewCount(*args)
-
- def SetContentRating(*args):
- """
- SetContentRating(self, string rating)
-
- Sets the content rating (MPAA, TV).
- """
- return _mc.ListItem_SetContentRating(*args)
-
- def SetDescription(*args):
- """
- SetDescription(self, string plotOutline, bool isHTML=False)
- SetDescription(self, string plotOutline)
-
- Sets the description.
- """
- return _mc.ListItem_SetDescription(*args)
-
- def SetEpisode(*args):
- """
- SetEpisode(self, int episode)
-
- Sets the episode number for TV show.
- """
- return _mc.ListItem_SetEpisode(*args)
-
- def SetSeason(*args):
- """
- SetSeason(self, int season)
-
- Sets the season number for TV show.
- """
- return _mc.ListItem_SetSeason(*args)
-
- def SetTVShowTitle(*args):
- """
- SetTVShowTitle(self, string title)
-
- Sets the TV show title (different than the title which is the episode
- title).
- """
- return _mc.ListItem_SetTVShowTitle(*args)
-
- def SetComment(*args):
- """
- SetComment(self, string comment)
-
- Sets the comment.
- """
- return _mc.ListItem_SetComment(*args)
-
- def SetStudio(*args):
- """
- SetStudio(self, string studio)
-
- Sets the studio or network.
- """
- return _mc.ListItem_SetStudio(*args)
-
- def SetAuthor(*args):
- """
- SetAuthor(self, string author)
-
- Sets the author.
- """
- return _mc.ListItem_SetAuthor(*args)
-
- def AddCastAndRole(*args):
- """
- AddCastAndRole(self, string name, string role)
-
- Adds a cast with role to the list of cast.
- """
- return _mc.ListItem_AddCastAndRole(*args)
-
- def AddCast(*args):
- """
- AddCast(self, string name)
-
- Adds a cast to the list of cat.
- """
- return _mc.ListItem_AddCast(*args)
-
- def ClearCastAndRole(*args):
- """
- ClearCastAndRole(self)
-
- Clears the list of cast.
- """
- return _mc.ListItem_ClearCastAndRole(*args)
-
- def SetWriter(*args):
- """
- SetWriter(self, string write)
-
- Sets the writer.
- """
- return _mc.ListItem_SetWriter(*args)
-
- def SetTagLine(*args):
- """
- SetTagLine(self, string tagLine)
-
- Sets the tag line.
- """
- return _mc.ListItem_SetTagLine(*args)
-
- def SetProviderSource(*args):
- """
- SetProviderSource(self, string provider)
-
- Sets the provider source.
-
- This should be the web site name (e.g. CBS.com). This is used when an
- item is played from the feed, so the user will see "Play on
- <provider-name"
- """
- return _mc.ListItem_SetProviderSource(*args)
-
- def SetKeywords(*args):
- """
- SetKeywords(self, string keywords)
-
- Sets the key words.
- """
- return _mc.ListItem_SetKeywords(*args)
-
- def SetImage(*args):
- """
- SetImage(self, int id, string url)
-
- Sets additional (non thumbnail) image.
-
- This image is not scaled and loaded in the background. There could be
- up to 10 images per item.
-
- Parameters:
- -----------
-
- id: id of the image between 0 and 9
-
- url: url of the image. protocol should behttp://
- """
- return _mc.ListItem_SetImage(*args)
-
- def AddAlternativePath(*args):
- """
- AddAlternativePath(self, string label, string path, string contentType, string thumbUrl)
-
- Adds an altenative path for playing the media.
-
- When the user clicks on the item, additional Play options will be
- listed. This is useful to supporting playback of both SD and HD
- content.
-
- Parameters:
- -----------
-
- label: the label that will appear in the action menu (for example,
- Play HD)
-
- path: the path of media file. could be either a local file or a URL
- of protocols:http://, mms:// or flash://
-
- contentType: the content type of the media
-
- thumbUrl: the thumbnail that will be displayed next to the label
- """
- return _mc.ListItem_AddAlternativePath(*args)
-
- def SetProperty(*args):
- """
- SetProperty(self, string key, string value)
-
- Sets custom properties to the item.
-
- Parameters:
- -----------
-
- key: the key name for the property
-
- value: the value of the property
- """
- return _mc.ListItem_SetProperty(*args)
-
- def SetReportToServer(*args):
- """
- SetReportToServer(self, bool reportToServer)
-
- Boolean flag that defines whether boxee will report to the server that
- this item was played.
-
- By default every played content is reported to boxee. If the played
- content is inappropriate, it should not be reported to boxee.
- """
- return _mc.ListItem_SetReportToServer(*args)
-
- def SetResumable(*args):
- """
- SetResumable(self, bool resumable)
-
- Boolean flag which determines whether the item can be resumed from
- last stopped position.
- """
- return _mc.ListItem_SetResumable(*args)
-
- def SetAddToHistory(*args):
- """
- SetAddToHistory(self, bool addToHistory)
-
- Boolean flag that defines whether boxee will add this list item to the
- history when it is played.
-
- By default items are not added to history. If the played content is
- inappropriate, it should not be added to history.
- """
- return _mc.ListItem_SetAddToHistory(*args)
-
- def SetEnableRecommend(*args):
- """
- SetEnableRecommend(self, bool enabled)
-
- Boolean flag that enables/disables the recommend action in the boxee
- client.
-
- By default the recommend action is enabled.
- """
- return _mc.ListItem_SetEnableRecommend(*args)
-
- def SetEnableRate(*args):
- """
- SetEnableRate(self, bool enabled)
-
- Boolean flag that enables/disables the rate (like/dislike) action in
- the boxee client.
-
- By default the recommend action is enabled.
- """
- return _mc.ListItem_SetEnableRate(*args)
-
- def SetExternalItem(*args):
- """
- SetExternalItem(self, ListItem externalItem)
-
- In some (rare) cases you would like the application to play this item
- but when reporting to the server or updating the history, you would
- like to use another list item.
-
- In that case, create another list item and set it to be the external
- item of this one.
- """
- return _mc.ListItem_SetExternalItem(*args)
-
- def Select(*args):
- """
- Select(self, bool on)
-
- Marks item state as selected, this flag is usually used by the UI to
- highlight marked items in the list.
- """
- return _mc.ListItem_Select(*args)
-
- def GetMediaType(*args):
- """
- GetMediaType(self) -> int
-
- Get the media type.
- """
- return _mc.ListItem_GetMediaType(*args)
-
- def GetLabel(*args):
- """
- GetLabel(self) -> string
-
- Returns the label.
- """
- return _mc.ListItem_GetLabel(*args)
-
- def GetContentType(*args):
- """
- GetContentType(self) -> string
-
- Returns the content tyep.
- """
- return _mc.ListItem_GetContentType(*args)
-
- def GetPath(*args):
- """
- GetPath(self) -> string
-
- Returns the path.
- """
- return _mc.ListItem_GetPath(*args)
-
- def GetTitle(*args):
- """
- GetTitle(self) -> string
-
- Returns the title.
- """
- return _mc.ListItem_GetTitle(*args)
-
- def GetThumbnail(*args):
- """
- GetThumbnail(self) -> string
-
- Returns the thumbnail.
- """
- return _mc.ListItem_GetThumbnail(*args)
-
- def GetIcon(*args):
- """
- GetIcon(self) -> string
-
- Returns the icon.
- """
- return _mc.ListItem_GetIcon(*args)
-
- def GetTrackNumber(*args):
- """
- GetTrackNumber(self) -> int
-
- Returns the track number.
- """
- return _mc.ListItem_GetTrackNumber(*args)
-
- def GetArtist(*args):
- """
- GetArtist(self) -> string
-
- Returns the artist.
- """
- return _mc.ListItem_GetArtist(*args)
-
- def GetAlbum(*args):
- """
- GetAlbum(self) -> string
-
- Returns the album.
- """
- return _mc.ListItem_GetAlbum(*args)
-
- def GetYear(*args):
- """
- GetYear(self) -> int
-
- Returns the release year.
- """
- return _mc.ListItem_GetYear(*args)
-
- def GetDate(*args):
- """
- GetDate(self) -> string
-
- Returns the release date.
- """
- return _mc.ListItem_GetDate(*args)
-
- def GetGenre(*args):
- """
- GetGenre(self) -> string
-
- Returns the genre.
- """
- return _mc.ListItem_GetGenre(*args)
-
- def GetDirector(*args):
- """
- GetDirector(self) -> string
-
- Returns the director.
- """
- return _mc.ListItem_GetDirector(*args)
-
- def GetSize(*args):
- """
- GetSize(self) -> int
-
- Returns the size.
- """
- return _mc.ListItem_GetSize(*args)
-
- def GetSizeFormatted(*args):
- """
- GetSizeFormatted(self) -> string
-
- Returns the size, formatted with commas.
- """
- return _mc.ListItem_GetSizeFormatted(*args)
-
- def GetDuration(*args):
- """
- GetDuration(self) -> int
-
- Returns the duration in seconds.
- """
- return _mc.ListItem_GetDuration(*args)
-
- def GetDurationFormatted(*args):
- """
- GetDurationFormatted(self) -> string
-
- Returns the duration formatted as HH:MM:SS.
- """
- return _mc.ListItem_GetDurationFormatted(*args)
-
- def GetStarRating(*args):
- """
- GetStarRating(self) -> float
-
- Returns the star rating.
- """
- return _mc.ListItem_GetStarRating(*args)
-
- def GetViewCount(*args):
- """
- GetViewCount(self) -> int
-
- Rerturns the view count.
- """
- return _mc.ListItem_GetViewCount(*args)
-
- def GetViewCountFormatted(*args):
- """
- GetViewCountFormatted(self) -> string
-
- Rerturns the view count formatted with commas,.
- """
- return _mc.ListItem_GetViewCountFormatted(*args)
-
- def GetContentRating(*args):
- """
- GetContentRating(self) -> string
-
- Returns the content rating.
- """
- return _mc.ListItem_GetContentRating(*args)
-
- def GetDescription(*args):
- """
- GetDescription(self) -> string
-
- Returns the description.
- """
- return _mc.ListItem_GetDescription(*args)
-
- def GetEpisode(*args):
- """
- GetEpisode(self) -> int
-
- Returns the episode number for tv shows.
- """
- return _mc.ListItem_GetEpisode(*args)
-
- def GetSeason(*args):
- """
- GetSeason(self) -> int
-
- Returns the season number for tv shows.
- """
- return _mc.ListItem_GetSeason(*args)
-
- def GetTVShowTitle(*args):
- """
- GetTVShowTitle(self) -> string
-
- Returns the tv show title.
- """
- return _mc.ListItem_GetTVShowTitle(*args)
-
- def GetComment(*args):
- """
- GetComment(self) -> string
-
- Returns the comment.
- """
- return _mc.ListItem_GetComment(*args)
-
- def GetStudio(*args):
- """
- GetStudio(self) -> string
-
- Returns the studio.
- """
- return _mc.ListItem_GetStudio(*args)
-
- def GetAuthor(*args):
- """
- GetAuthor(self) -> string
-
- Returns the author.
- """
- return _mc.ListItem_GetAuthor(*args)
-
- def GetCastAndRole(*args):
- """
- GetCastAndRole(self) -> string
-
- Returns the cast and role.
- """
- return _mc.ListItem_GetCastAndRole(*args)
-
- def GetCast(*args):
- """
- GetCast(self) -> string
-
- Returns the cast.
- """
- return _mc.ListItem_GetCast(*args)
-
- def GetWriter(*args):
- """
- GetWriter(self) -> string
-
- Returns the writer.
- """
- return _mc.ListItem_GetWriter(*args)
-
- def GetTagLine(*args):
- """
- GetTagLine(self) -> string
-
- Returns the tag line.
- """
- return _mc.ListItem_GetTagLine(*args)
-
- def GetProviderSource(*args):
- """
- GetProviderSource(self) -> string
-
- Returns the provider source.
- """
- return _mc.ListItem_GetProviderSource(*args)
-
- def GetKeywords(*args):
- """
- GetKeywords(self) -> string
-
- Returns the keywords.
- """
- return _mc.ListItem_GetKeywords(*args)
-
- def GetProperty(*args):
- """
- GetProperty(self, string key) -> string
-
- Returns a custom property.
- """
- return _mc.ListItem_GetProperty(*args)
-
- def HasProperty(*args):
- """
- HasProperty(self, string key) -> bool
-
- Returns true if the property exist.
-
- Since: 0.9.12
- """
- return _mc.ListItem_HasProperty(*args)
-
- def GetReportToServer(*args):
- """
- GetReportToServer(self) -> bool
-
- Returns true if playing the item will be reported to boxee.
- """
- return _mc.ListItem_GetReportToServer(*args)
-
- def GetResumable(*args):
- """
- GetResumable(self) -> bool
-
- Returns true if item can be resumed from last stopped position.
- """
- return _mc.ListItem_GetResumable(*args)
-
- def GetWatched(*args):
- """
- GetWatched(self) -> bool
-
- Returns true if item is marked as watched in the boxee client and
- false otherwise.
- """
- return _mc.ListItem_GetWatched(*args)
-
- def IsEnabledRecommend(*args):
- """
- IsEnabledRecommend(self) -> bool
-
- Returns a boolean flag whether the recommend action is
- enabled/disabled in the boxee client.
- """
- return _mc.ListItem_IsEnabledRecommend(*args)
-
- def IsEnabledRate(*args):
- """
- IsEnabledRate(self) -> bool
-
- Returns a boolean flag whether the rate action is (like/dislike)
- enabled/disabled in the boxee client.
- """
- return _mc.ListItem_IsEnabledRate(*args)
-
- def GetImage(*args):
- """
- GetImage(self, int id) -> string
-
- Gets additional (non thumbnail) image attached to the list item via
- SetImage().
- """
- return _mc.ListItem_GetImage(*args)
-
- def Dump(*args):
- """
- Dump(self)
-
- Dumps the content of the list item to the boxee log.
-
- This is useful for debugging purposes.
- """
- return _mc.ListItem_Dump(*args)
-
- def GetFileItem(*args):
- """
- GetFileItem(self) -> CFileItemPtr
-
- 1
- """
- return _mc.ListItem_GetFileItem(*args)
-
- __swig_destroy__ = _mc.delete_ListItem
- __del__ = lambda self : None;
- ListItem_swigregister = _mc.ListItem_swigregister
- ListItem_swigregister(ListItem)
-
- class ListItems(stdListItems):
- """
- This class represents a list of ListItem.
-
- Should be used as a python array. Use append(), remove() etc.
- """
- __swig_setmethods__ = {}
- for _s in [stdListItems]: __swig_setmethods__.update(getattr(_s,'__swig_setmethods__',{}))
- __setattr__ = lambda self, name, value: _swig_setattr(self, ListItems, name, value)
- __swig_getmethods__ = {}
- for _s in [stdListItems]: __swig_getmethods__.update(getattr(_s,'__swig_getmethods__',{}))
- __getattr__ = lambda self, name: _swig_getattr(self, ListItems, name)
- __repr__ = _swig_repr
- def __init__(self, *args):
- """
- __init__(self) -> ListItems
-
- 1
- """
- this = _mc.new_ListItems(*args)
- try: self.this.append(this)
- except: self.this = this
- __swig_destroy__ = _mc.delete_ListItems
- __del__ = lambda self : None;
- ListItems_swigregister = _mc.ListItems_swigregister
- ListItems_swigregister(ListItems)
-
- class Control(_object):
- """
- Represents a control in the user interface.
-
- Get the Control object by calling GetControl() on the Window.
- """
- __swig_setmethods__ = {}
- __setattr__ = lambda self, name, value: _swig_setattr(self, Control, name, value)
- __swig_getmethods__ = {}
- __getattr__ = lambda self, name: _swig_getattr(self, Control, name)
- __repr__ = _swig_repr
- def __init__(self, *args):
- """
- __init__(self, int windowId, int controlId) -> Control
-
- 1
- """
- this = _mc.new_Control(*args)
- try: self.this.append(this)
- except: self.this = this
- __swig_destroy__ = _mc.delete_Control
- __del__ = lambda self : None;
- def SetFocus(*args):
- """
- SetFocus(self)
-
- Requests a focus on the control.
- """
- return _mc.Control_SetFocus(*args)
-
- def HasFocus(*args):
- """
- HasFocus(self) -> bool
-
- Returns true if the control holds the focus.
- """
- return _mc.Control_HasFocus(*args)
-
- def SetVisible(*args):
- """
- SetVisible(self, bool visible)
-
- Changes the visibility of the control.
-
- Parameters:
- -----------
-
- visible: true to make the control visible. false otherwise.
- """
- return _mc.Control_SetVisible(*args)
-
- def IsVisible(*args):
- """
- IsVisible(self) -> bool
-
- Returns true if the control is visible.
- """
- return _mc.Control_IsVisible(*args)
-
- def SetEnabled(*args):
- """
- SetEnabled(self, bool enabled)
-
- Sets whether the control is enabled.
-
- Controls which are not enabled cannot be focused.
-
- Parameters:
- -----------
-
- enabled: true to make the control enabled. false otherwise.
- """
- return _mc.Control_SetEnabled(*args)
-
- def IsEnabled(*args):
- """
- IsEnabled(self) -> bool
-
- Returns true if the control is enabled.
- """
- return _mc.Control_IsEnabled(*args)
-
- Control_swigregister = _mc.Control_swigregister
- Control_swigregister(Control)
-
- class Button(Control):
- """
- Represents a button control in the user interface.
-
- Get the Button object by calling GetButton() on the Window.
- """
- __swig_setmethods__ = {}
- for _s in [Control]: __swig_setmethods__.update(getattr(_s,'__swig_setmethods__',{}))
- __setattr__ = lambda self, name, value: _swig_setattr(self, Button, name, value)
- __swig_getmethods__ = {}
- for _s in [Control]: __swig_getmethods__.update(getattr(_s,'__swig_getmethods__',{}))
- __getattr__ = lambda self, name: _swig_getattr(self, Button, name)
- __repr__ = _swig_repr
- def __init__(self, *args):
- """
- __init__(self, int windowId, int controlId) -> Button
-
- 1
- """
- this = _mc.new_Button(*args)
- try: self.this.append(this)
- except: self.this = this
- def SetLabel(*args):
- """
- SetLabel(self, string label)
-
- Set the label of the button.
-
- Parameters:
- -----------
-
- label: the label of the button
- """
- return _mc.Button_SetLabel(*args)
-
- __swig_destroy__ = _mc.delete_Button
- __del__ = lambda self : None;
- Button_swigregister = _mc.Button_swigregister
- Button_swigregister(Button)
-
- class Edit(Control):
- """
- Represents an edit control in the user interface.
-
- Get the Edit object by calling GetEdit() on the Window.
- """
- __swig_setmethods__ = {}
- for _s in [Control]: __swig_setmethods__.update(getattr(_s,'__swig_setmethods__',{}))
- __setattr__ = lambda self, name, value: _swig_setattr(self, Edit, name, value)
- __swig_getmethods__ = {}
- for _s in [Control]: __swig_getmethods__.update(getattr(_s,'__swig_getmethods__',{}))
- __getattr__ = lambda self, name: _swig_getattr(self, Edit, name)
- __repr__ = _swig_repr
- def __init__(self, *args):
- """
- __init__(self, int windowId, int controlId) -> Edit
-
- 1
- """
- this = _mc.new_Edit(*args)
- try: self.this.append(this)
- except: self.this = this
- def SetText(*args):
- """
- SetText(self, string text)
-
- Sets the text of the edit control.
-
- Parameters:
- -----------
-
- text: the text of the edit control
- """
- return _mc.Edit_SetText(*args)
-
- def GetText(*args):
- """
- GetText(self) -> string
-
- Gets the text of the edit control.
- """
- return _mc.Edit_GetText(*args)
-
- __swig_destroy__ = _mc.delete_Edit
- __del__ = lambda self : None;
- Edit_swigregister = _mc.Edit_swigregister
- Edit_swigregister(Edit)
-
- class Image(Control):
- """
- Represents an image control in the user interface.
-
- Get the Image object by calling GetImage() on the Window.
- """
- __swig_setmethods__ = {}
- for _s in [Control]: __swig_setmethods__.update(getattr(_s,'__swig_setmethods__',{}))
- __setattr__ = lambda self, name, value: _swig_setattr(self, Image, name, value)
- __swig_getmethods__ = {}
- for _s in [Control]: __swig_getmethods__.update(getattr(_s,'__swig_getmethods__',{}))
- __getattr__ = lambda self, name: _swig_getattr(self, Image, name)
- __repr__ = _swig_repr
- def __init__(self, *args):
- """
- __init__(self, int windowId, int controlId) -> Image
-
- 1
- """
- this = _mc.new_Image(*args)
- try: self.this.append(this)
- except: self.this = this
- def SetTexture(*args):
- """
- SetTexture(self, string imagePath)
-
- Set the texture of the image.
-
- Parameters:
- -----------
-
- imagePath: the full path where the image resides. Should be a local
- file only. Supported formats: PNG, GIF, JPG.
- """
- return _mc.Image_SetTexture(*args)
-
- __swig_destroy__ = _mc.delete_Image
- __del__ = lambda self : None;
- Image_swigregister = _mc.Image_swigregister
- Image_swigregister(Image)
-
- class Label(Control):
- """
- Represents a label control in the user interface.
-
- Get the Label object by calling GetLabel() on the Window.
- """
- __swig_setmethods__ = {}
- for _s in [Control]: __swig_setmethods__.update(getattr(_s,'__swig_setmethods__',{}))
- __setattr__ = lambda self, name, value: _swig_setattr(self, Label, name, value)
- __swig_getmethods__ = {}
- for _s in [Control]: __swig_getmethods__.update(getattr(_s,'__swig_getmethods__',{}))
- __getattr__ = lambda self, name: _swig_getattr(self, Label, name)
- __repr__ = _swig_repr
- def __init__(self, *args):
- """
- __init__(self, int windowId, int controlId) -> Label
-
- 1
- """
- this = _mc.new_Label(*args)
- try: self.this.append(this)
- except: self.this = this
- def SetLabel(*args):
- """
- SetLabel(self, string label)
-
- Set the label text.
-
- Parameters:
- -----------
-
- label: the text of the label
- """
- return _mc.Label_SetLabel(*args)
-
- __swig_destroy__ = _mc.delete_Label
- __del__ = lambda self : None;
- Label_swigregister = _mc.Label_swigregister
- Label_swigregister(Label)
-
- class List(Control):
- """
- Represents a list control in the user interface.
-
- Get the List object by calling GetList() on the Window.
- """
- __swig_setmethods__ = {}
- for _s in [Control]: __swig_setmethods__.update(getattr(_s,'__swig_setmethods__',{}))
- __setattr__ = lambda self, name, value: _swig_setattr(self, List, name, value)
- __swig_getmethods__ = {}
- for _s in [Control]: __swig_getmethods__.update(getattr(_s,'__swig_getmethods__',{}))
- __getattr__ = lambda self, name: _swig_getattr(self, List, name)
- __repr__ = _swig_repr
- def __init__(self, *args):
- """
- __init__(self, int windowId, int controlId) -> List
-
- 1
- """
- this = _mc.new_List(*args)
- try: self.this.append(this)
- except: self.this = this
- def ScrollPageUp(*args):
- """
- ScrollPageUp(self)
-
- Scrolls the list one page up for vertical lists or left for horizontal
- lists.
- """
- return _mc.List_ScrollPageUp(*args)
-
- def ScrollPageDown(*args):
- """
- ScrollPageDown(self)
-
- Scrolls the list one page down for vertical lists or right for
- horizontal lists.
- """
- return _mc.List_ScrollPageDown(*args)
-
- def Refresh(*args):
- """
- Refresh(self)
-
- Refreshes the contents of the list.
- """
- return _mc.List_Refresh(*args)
-
- def SetContentURL(*args):
- """
- SetContentURL(self, string url)
-
- Sets the list with items from an RSS feed.
-
- Please see the RSS specification for supported RSS formats.
-
- Parameters:
- -----------
-
- url: url of the RSS. Should have and rss:// scheme.
- """
- return _mc.List_SetContentURL(*args)
-
- def SetFocusedItem(*args):
- """
- SetFocusedItem(self, int item)
-
- Focuses a specific item in the list.
-
- Only one item can be focused in the list.
-
- Parameters:
- -----------
-
- item: index of item in the list that should be focused
- """
- return _mc.List_SetFocusedItem(*args)
-
- def SetSelected(*args):
- """
- SetSelected(self, int item, bool selected)
-
- Selects/unselects an item in the list.
-
- Single/multiple selection is defined in the skin.
-
- Parameters:
- -----------
-
- item: index of item in the list that should be selected/unselected
-
- selected: true to select the item, false to unselect
- """
- return _mc.List_SetSelected(*args)
-
- def SelectAll(*args):
- """
- SelectAll(self)
-
- Selects all the items in the list.
- """
- return _mc.List_SelectAll(*args)
-
- def UnselectAll(*args):
- """
- UnselectAll(self)
-
- Unselect all the items in the list.
- """
- return _mc.List_UnselectAll(*args)
-
- def GetSelected(*args):
- """
- GetSelected(self) -> ListItems
-
- Returns all the selected items in the list.
- """
- return _mc.List_GetSelected(*args)
-
- def GetFocusedItem(*args):
- """
- GetFocusedItem(self) -> int
-
- Returns the index of the focused item in the list.
-
- Throws an exception if no item is focused.
- """
- return _mc.List_GetFocusedItem(*args)
-
- def GetItem(*args):
- """
- GetItem(self, int item) -> ListItem
-
- Returns a specific item in the list.
-
- Throws an exception if the item does not exist.
- """
- return _mc.List_GetItem(*args)
-
- def GetItems(*args):
- """
- GetItems(self) -> ListItems
-
- Returns all the items in the list.
- """
- return _mc.List_GetItems(*args)
-
- def SetItems(*args):
- """
- SetItems(self, ListItems list, int iSelectedItem=-1)
- SetItems(self, ListItems list)
-
- Loads the list with items.
-
- Parameters:
- -----------
-
- list: items to be set in the list.
- """
- return _mc.List_SetItems(*args)
-
- def JumpToLetter(*args):
- """
- JumpToLetter(self, char letter)
-
- Moves the focus in the list to the first item with the specified
- letter.
-
- Parameters:
- -----------
-
- letter: the letter to jump to.
- """
- return _mc.List_JumpToLetter(*args)
-
- __swig_destroy__ = _mc.delete_List
- __del__ = lambda self : None;
- List_swigregister = _mc.List_swigregister
- List_swigregister(List)
-
- class LocalConfig(_object):
- """
- Represents the storage of local configuration for an application.
-
- Local means that it is stored in the client (in the future there might
- be server side configuration). Get the LocalConfig object by calling
- GetLocalConfig() on the App object. Configuration is stored in a
- key/value manner. A key may have multiple values.
- """
- __swig_setmethods__ = {}
- __setattr__ = lambda self, name, value: _swig_setattr(self, LocalConfig, name, value)
- __swig_getmethods__ = {}
- __getattr__ = lambda self, name: _swig_getattr(self, LocalConfig, name)
- __repr__ = _swig_repr
- def SetValue(*args):
- """
- SetValue(self, string key, string value)
-
- Sets and stores a value in the configuraion file.
-
- Parameters:
- -----------
-
- key: the key identifier of the value to store
-
- value: the actual value to store
- """
- return _mc.LocalConfig_SetValue(*args)
-
- def GetValue(*args):
- """
- GetValue(self, string key) -> string
-
- Retrieves a value from the configuration file.
-
- If the key has multiple values, you can specify the index of the of
- key between curly brackets. For example, if the key "friends" has
- multiple values, you can retreive the 5th element by requesting key:
- friend{4}
-
- Parameters:
- -----------
-
- key: the key identifier of the value to retrieve
- """
- return _mc.LocalConfig_GetValue(*args)
-
- def Reset(*args):
- """
- Reset(self, string key)
-
- Resets and deletes a value from the configuration file.
-
- Parameters:
- -----------
-
- key: the key identifier of the value to reset
- """
- return _mc.LocalConfig_Reset(*args)
-
- def ResetAll(*args):
- """
- ResetAll(self)
-
- Resets and deletes all values from the configuration file.
- """
- return _mc.LocalConfig_ResetAll(*args)
-
- def PushBackValue(*args):
- """
- PushBackValue(self, string key, string value, int limit=0)
- PushBackValue(self, string key, string value)
-
- Adds value to a key.
-
- Add the value to the back of the list of values.
-
- Parameters:
- -----------
-
- key: the key identifier of the value to store
-
- value: the actual value to store
-
- limit: maximum number of values allowed for this key. if the number
- is passed, values will be chopped from the front.
- """
- return _mc.LocalConfig_PushBackValue(*args)
-
- def PushFrontValue(*args):
- """
- PushFrontValue(self, string key, string value, int limit=0)
- PushFrontValue(self, string key, string value)
-
- Adds value to a key.
-
- Add the value to the front of the list of values.
-
- Parameters:
- -----------
-
- key: the key identifier of the value to store
-
- value: the actual value to store
-
- limit: maximum number of values allowed for this key. if the number
- is passed, values will be chopped from the back.
- """
- return _mc.LocalConfig_PushFrontValue(*args)
-
- def Implode(*args):
- """
- Implode(self, string glue, string key) -> string
-
- Imploes all the values of a key to a single string, glued together.
-
- Parameters:
- -----------
-
- glue: the glue string between values
-
- key: the key identifier of the value to retrieve
- """
- return _mc.LocalConfig_Implode(*args)
-
- def __init__(self, *args):
- """
- __init__(self) -> LocalConfig
-
- 1
- """
- this = _mc.new_LocalConfig(*args)
- try: self.this.append(this)
- except: self.this = this
- __swig_destroy__ = _mc.delete_LocalConfig
- __del__ = lambda self : None;
- LocalConfig_swigregister = _mc.LocalConfig_swigregister
- LocalConfig_swigregister(LocalConfig)
-
- class ToggleButton(Control):
- """
- Represents a toggle button control in the user interface.
-
- Get the ToggleButton object by calling GetToggleButton() on the
- Window.
- """
- __swig_setmethods__ = {}
- for _s in [Control]: __swig_setmethods__.update(getattr(_s,'__swig_setmethods__',{}))
- __setattr__ = lambda self, name, value: _swig_setattr(self, ToggleButton, name, value)
- __swig_getmethods__ = {}
- for _s in [Control]: __swig_getmethods__.update(getattr(_s,'__swig_getmethods__',{}))
- __getattr__ = lambda self, name: _swig_getattr(self, ToggleButton, name)
- __repr__ = _swig_repr
- def __init__(self, *args):
- """
- __init__(self, int windowId, int controlId) -> ToggleButton
-
- 1
- """
- this = _mc.new_ToggleButton(*args)
- try: self.this.append(this)
- except: self.this = this
- def SetLabel(*args):
- """
- SetLabel(self, string label)
-
- Set the label of the button.
-
- Parameters:
- -----------
-
- label: the label of the button
- """
- return _mc.ToggleButton_SetLabel(*args)
-
- def SetSelected(*args):
- """
- SetSelected(self, bool selected)
-
- Mark the toggle button as selected/unselected.
-
- Parameters:
- -----------
-
- selected: true to select the toggle button, false for unselected
- """
- return _mc.ToggleButton_SetSelected(*args)
-
- def IsSelected(*args):
- """
- IsSelected(self) -> bool
-
- Returns true if the toggle button is selected, false otherwise.
- """
- return _mc.ToggleButton_IsSelected(*args)
-
- __swig_destroy__ = _mc.delete_ToggleButton
- __del__ = lambda self : None;
- ToggleButton_swigregister = _mc.ToggleButton_swigregister
- ToggleButton_swigregister(ToggleButton)
-
- class Window(_object):
- """
- Represents a toggle button control in the user interface.
-
- Get the Window object by calling GetActiveWindow() or GetWindow()
- functions.
- """
- __swig_setmethods__ = {}
- __setattr__ = lambda self, name, value: _swig_setattr(self, Window, name, value)
- __swig_getmethods__ = {}
- __getattr__ = lambda self, name: _swig_getattr(self, Window, name)
- __repr__ = _swig_repr
- def __init__(self, *args):
- """
- __init__(self, int id) -> Window
-
- 1
- """
- this = _mc.new_Window(*args)
- try: self.this.append(this)
- except: self.this = this
- def GetControl(*args):
- """
- GetControl(self, int id) -> Control
-
- Returns a control in the window.
-
- Parameters:
- -----------
-
- id: the id of the control
- """
- return _mc.Window_GetControl(*args)
-
- def GetLabel(*args):
- """
- GetLabel(self, int id) -> Label
-
- Returns a label control in the window.
- """
- return _mc.Window_GetLabel(*args)
-
- def GetList(*args):
- """
- GetList(self, int id) -> List
-
- Returns a list control in the window.
- """
- return _mc.Window_GetList(*args)
-
- def GetToggleButton(*args):
- """
- GetToggleButton(self, int id) -> ToggleButton
-
- Returns a toggle button control in the window.
- """
- return _mc.Window_GetToggleButton(*args)
-
- def GetButton(*args):
- """
- GetButton(self, int id) -> Button
-
- Returns a button control in the window.
- """
- return _mc.Window_GetButton(*args)
-
- def GetImage(*args):
- """
- GetImage(self, int id) -> Image
-
- Returns an image control in the window.
- """
- return _mc.Window_GetImage(*args)
-
- def GetEdit(*args):
- """
- GetEdit(self, int id) -> Edit
-
- Returns an edit control in the window.
- """
- return _mc.Window_GetEdit(*args)
-
- def PushState(*args):
- """
- PushState(self)
-
- Saves the state of the window and pushes it to the top of the window
- state stack.
-
- By default, if user hits ESC or Back, instead of closing the window,
- it will pop the state and return it. The state includes contents of
- lists and the selected items in lists. This is useful if you want to
- support "drill down" navigation in a window.
- """
- return _mc.Window_PushState(*args)
-
- def PopState(*args):
- """
- PopState(self, bool restoreState=True)
- PopState(self)
-
- Pops a state from the state stack (see PushState()) and sets the user
- interface accordingly.
-
- Parameters:
- -----------
-
- restoreState: true to restore the top most state in the stack
- """
- return _mc.Window_PopState(*args)
-
- def PopToState(*args):
- """
- PopToState(self, int remainInStack)
-
- Pops states from the state stack (see PushState()) and leaves
- "count" states in the stack.
-
- Parameters:
- -----------
-
- remainInStack: number of items to keep remained in the stack
- """
- return _mc.Window_PopToState(*args)
-
- def ClearStateStack(*args):
- """
- ClearStateStack(self, bool restoreState=True)
- ClearStateStack(self)
-
- Clears all the saved states.
-
- Parameters:
- -----------
-
- restoreState: restore the state of the bottom most state in the
- stack?
- """
- return _mc.Window_ClearStateStack(*args)
-
- __swig_destroy__ = _mc.delete_Window
- __del__ = lambda self : None;
- Window_swigregister = _mc.Window_swigregister
- Window_swigregister(Window)
-
- class Http(_object):
- """
- This class represents the Http object.
- """
- __swig_setmethods__ = {}
- __setattr__ = lambda self, name, value: _swig_setattr(self, Http, name, value)
- __swig_getmethods__ = {}
- __getattr__ = lambda self, name: _swig_getattr(self, Http, name)
- __repr__ = _swig_repr
- def __init__(self, *args):
- """
- __init__(self) -> Http
-
- Creates a new http object.
- """
- this = _mc.new_Http(*args)
- try: self.this.append(this)
- except: self.this = this
- __swig_destroy__ = _mc.delete_Http
- __del__ = lambda self : None;
- def SetHttpHeader(*args):
- """
- SetHttpHeader(self, string strKey, string strValue)
-
- set a request http header
-
- Parameters:
- -----------
-
- strKey: header name
-
- strValue: header value
- """
- return _mc.Http_SetHttpHeader(*args)
-
- def GetHttpHeader(*args):
- """
- GetHttpHeader(self, string strKey) -> string
-
- retrieves an http header from the reqponse
-
- Parameters:
- -----------
-
- strKey: header name
- """
- return _mc.Http_GetHttpHeader(*args)
-
- def GetHttpResponseCode(*args):
- """
- GetHttpResponseCode(self) -> int
-
- get the http response code from the operation
- """
- return _mc.Http_GetHttpResponseCode(*args)
-
- def Get(*args):
- """
- Get(self, string strUrl) -> string
-
- perform an HTTP GET request
-
- Parameters:
- -----------
-
- strUrl: the url to GET
- """
- return _mc.Http_Get(*args)
-
- def Post(*args):
- """
- Post(self, string strUrl, string strPostData) -> string
-
- perform an HTTP POST request
-
- Parameters:
- -----------
-
- strUrl: the url to POST to
-
- strPostData: the data (must be textual) to post in the request
- """
- return _mc.Http_Post(*args)
-
- def Download(*args):
- """
- Download(self, string strUrl, string strLocalPath) -> bool
-
- download a file
-
- Parameters:
- -----------
-
- strUrl: the url of the file to download
-
- strLocalPath: the path to save the file to
- """
- return _mc.Http_Download(*args)
-
- def SetUserAgent(*args):
- """
- SetUserAgent(self, string strUserAgent)
-
- set the user-agent field of the http request
-
- Parameters:
- -----------
-
- strUserAgent: the user-agent value to use
- """
- return _mc.Http_SetUserAgent(*args)
-
- def Reset(*args):
- """
- Reset(self)
-
- reset the object - all data will re-initialize
- """
- return _mc.Http_Reset(*args)
-
- Http_swigregister = _mc.Http_swigregister
- Http_swigregister(Http)
-
- class MC(_object):
- """
- Main class for interfacing with BOXEE.
- """
- __swig_setmethods__ = {}
- __setattr__ = lambda self, name, value: _swig_setattr(self, MC, name, value)
- __swig_getmethods__ = {}
- __getattr__ = lambda self, name: _swig_getattr(self, MC, name)
- __repr__ = _swig_repr
- def GetLocalizedString(*args):
- """
- GetLocalizedString(int id) -> string
-
- Returns a localized string based on an id of the string.
-
- Parameters:
- -----------
-
- id: id of the string. could be either a system wide id or an
- application specific id.
- """
- return _mc.MC_GetLocalizedString(*args)
-
- if _newclass:GetLocalizedString = staticmethod(GetLocalizedString)
- __swig_getmethods__["GetLocalizedString"] = lambda x: GetLocalizedString
- def GetInfoString(*args):
- """
- GetInfoString(string info) -> string
-
- Returns information about the user interface.
-
- See separate documentation regarding information that can be
- retrieved.
-
- Parameters:
- -----------
-
- info: a string representing the information to be retrieved.
- """
- return _mc.MC_GetInfoString(*args)
-
- if _newclass:GetInfoString = staticmethod(GetInfoString)
- __swig_getmethods__["GetInfoString"] = lambda x: GetInfoString
- def ShowDialogNotification(*args):
- """
- ShowDialogNotification(string msg, string thumbnail="")
- ShowDialogNotification(string msg)
-
- Displays a notification at the upper right corner of the screen for 5
- seconds.
-
- Parameters:
- -----------
-
- msg: mesage to be notified to the user.
-
- thumbnail: file name that contains the image to be displayed.
- Optional.
- """
- return _mc.MC_ShowDialogNotification(*args)
-
- if _newclass:ShowDialogNotification = staticmethod(ShowDialogNotification)
- __swig_getmethods__["ShowDialogNotification"] = lambda x: ShowDialogNotification
- def ShowDialogWait(*args):
- """
- ShowDialogWait()
-
- Displays a wait dialog.
-
- This should be displayed during long operations.
- """
- return _mc.MC_ShowDialogWait(*args)
-
- if _newclass:ShowDialogWait = staticmethod(ShowDialogWait)
- __swig_getmethods__["ShowDialogWait"] = lambda x: ShowDialogWait
- def HideDialogWait(*args):
- """
- HideDialogWait()
-
- Hides the wait dialog.
- """
- return _mc.MC_HideDialogWait(*args)
-
- if _newclass:HideDialogWait = staticmethod(HideDialogWait)
- __swig_getmethods__["HideDialogWait"] = lambda x: HideDialogWait
- def ShowDialogConfirm(*args):
- """
- ShowDialogConfirm(string heading, string body, string cancelButton, string confirmButton) -> bool
-
- Displays a confirmation dialog, such as Ok/Canel or Yes/No.
-
- Returns true if the confirm button was clicked or false if the cancel
- button was pressed or if the dialog was closed.
-
- Parameters:
- -----------
-
- heading: heading for the dialog
-
- body: contents of the dialog. use [CR] for line breaks.
-
- cancelButton: text to appear in the cancel button. Default is
- "Cancel". Optional.
-
- confirmButton: text to appear in the confirm button. Default is
- "Ok". Optional.
- """
- return _mc.MC_ShowDialogConfirm(*args)
-
- if _newclass:ShowDialogConfirm = staticmethod(ShowDialogConfirm)
- __swig_getmethods__["ShowDialogConfirm"] = lambda x: ShowDialogConfirm
- def ShowDialogOk(*args):
- """
- ShowDialogOk(string heading, string body)
-
- Displays an "Ok" dialog for displaying information to the user.
-
- Parameters:
- -----------
-
- heading: heading of the dialog
-
- body: contents of the dialog. use [CR] for line breaks.
- """
- return _mc.MC_ShowDialogOk(*args)
-
- if _newclass:ShowDialogOk = staticmethod(ShowDialogOk)
- __swig_getmethods__["ShowDialogOk"] = lambda x: ShowDialogOk
- def ShowDialogKeyboard(*args):
- """
- ShowDialogKeyboard(string heading, string defaultValue, bool hiddenInput) -> string
-
- Displays a keyboard dialog for text input.
-
- Returns true if a value was entered or false if the dialog was
- cancelled.
-
- Parameters:
- -----------
-
- heading: heading of the dialog
-
- defaultValue: value to be pre-populated in the dialog when displayed.
- if the dialog was closed with "Ok" it also contains the value that
- was types.
-
- hiddenInput: false - the typed value is displayed, true - the typed
- value is hidden and * are shown instead.
- """
- return _mc.MC_ShowDialogKeyboard(*args)
-
- if _newclass:ShowDialogKeyboard = staticmethod(ShowDialogKeyboard)
- __swig_getmethods__["ShowDialogKeyboard"] = lambda x: ShowDialogKeyboard
- def LogDebug(*args):
- """
- LogDebug(string msg)
-
- Log debug message into the Boxee log file.
-
- Parameters:
- -----------
-
- msg: message to be written to the log file
- """
- return _mc.MC_LogDebug(*args)
-
- if _newclass:LogDebug = staticmethod(LogDebug)
- __swig_getmethods__["LogDebug"] = lambda x: LogDebug
- def LogInfo(*args):
- """
- LogInfo(string msg)
-
- Log information message into the Boxee log file.
-
- Parameters:
- -----------
-
- msg: message to be written to the log file
- """
- return _mc.MC_LogInfo(*args)
-
- if _newclass:LogInfo = staticmethod(LogInfo)
- __swig_getmethods__["LogInfo"] = lambda x: LogInfo
- def LogError(*args):
- """
- LogError(string msg)
-
- Log error message into the Boxee log file.
-
- Parameters:
- -----------
-
- msg: message to be written to the log file
- """
- return _mc.MC_LogError(*args)
-
- if _newclass:LogError = staticmethod(LogError)
- __swig_getmethods__["LogError"] = lambda x: LogError
- def GetActiveWindow(*args):
- """
- GetActiveWindow() -> Window
-
- Get a reference to the currently active window.
- """
- return _mc.MC_GetActiveWindow(*args)
-
- if _newclass:GetActiveWindow = staticmethod(GetActiveWindow)
- __swig_getmethods__["GetActiveWindow"] = lambda x: GetActiveWindow
- def GetWindow(*args):
- """
- GetWindow(int id) -> Window
-
- Get a reference to the window by its id.
-
- Parameters:
- -----------
-
- id: the id of the window
- """
- return _mc.MC_GetWindow(*args)
-
- if _newclass:GetWindow = staticmethod(GetWindow)
- __swig_getmethods__["GetWindow"] = lambda x: GetWindow
- def ActivateWindow(*args):
- """
- ActivateWindow(int id)
-
- Activate a specific window by its id.
-
- Parameters:
- -----------
-
- id: the id of the window
- """
- return _mc.MC_ActivateWindow(*args)
-
- if _newclass:ActivateWindow = staticmethod(ActivateWindow)
- __swig_getmethods__["ActivateWindow"] = lambda x: ActivateWindow
- def CloseWindow(*args):
- """
- CloseWindow()
-
- Closes the currently active window and go to the previously open
- window.
- """
- return _mc.MC_CloseWindow(*args)
-
- if _newclass:CloseWindow = staticmethod(CloseWindow)
- __swig_getmethods__["CloseWindow"] = lambda x: CloseWindow
- def GetPlayer(*args):
- """
- GetPlayer() -> Player
-
- Returns a reference to a media player that can be used for playing
- media.
- """
- return _mc.MC_GetPlayer(*args)
-
- if _newclass:GetPlayer = staticmethod(GetPlayer)
- __swig_getmethods__["GetPlayer"] = lambda x: GetPlayer
- def GetTempDir(*args):
- """
- GetTempDir() -> string
-
- Returns the full path of a directory where temporary files can be
- placed.
- """
- return _mc.MC_GetTempDir(*args)
-
- if _newclass:GetTempDir = staticmethod(GetTempDir)
- __swig_getmethods__["GetTempDir"] = lambda x: GetTempDir
- def GetApp(*args):
- """
- GetApp() -> App
-
- Returns a reference to the App object, that should be used for
- application specific operations.
- """
- return _mc.MC_GetApp(*args)
-
- if _newclass:GetApp = staticmethod(GetApp)
- __swig_getmethods__["GetApp"] = lambda x: GetApp
- def GetCookieJar(*args):
- """
- GetCookieJar() -> string
-
- Returns the cookie jar used by boxee.
- """
- return _mc.MC_GetCookieJar(*args)
-
- if _newclass:GetCookieJar = staticmethod(GetCookieJar)
- __swig_getmethods__["GetCookieJar"] = lambda x: GetCookieJar
- def __init__(self, *args):
- """
- __init__(self) -> MC
-
- 1
- """
- this = _mc.new_MC(*args)
- try: self.this.append(this)
- except: self.this = this
- __swig_destroy__ = _mc.delete_MC
- __del__ = lambda self : None;
- MC_swigregister = _mc.MC_swigregister
- MC_swigregister(MC)
-
- def MC_GetLocalizedString(*args):
- """
- MC_GetLocalizedString(int id) -> string
-
- Returns a localized string based on an id of the string.
-
- Parameters:
- -----------
-
- id: id of the string. could be either a system wide id or an
- application specific id.
- """
- return _mc.MC_GetLocalizedString(*args)
-
- def MC_GetInfoString(*args):
- """
- MC_GetInfoString(string info) -> string
-
- Returns information about the user interface.
-
- See separate documentation regarding information that can be
- retrieved.
-
- Parameters:
- -----------
-
- info: a string representing the information to be retrieved.
- """
- return _mc.MC_GetInfoString(*args)
-
- def MC_ShowDialogNotification(*args):
- """
- ShowDialogNotification(string msg, string thumbnail="")
- MC_ShowDialogNotification(string msg)
-
- Displays a notification at the upper right corner of the screen for 5
- seconds.
-
- Parameters:
- -----------
-
- msg: mesage to be notified to the user.
-
- thumbnail: file name that contains the image to be displayed.
- Optional.
- """
- return _mc.MC_ShowDialogNotification(*args)
-
- def MC_ShowDialogWait(*args):
- """
- MC_ShowDialogWait()
-
- Displays a wait dialog.
-
- This should be displayed during long operations.
- """
- return _mc.MC_ShowDialogWait(*args)
-
- def MC_HideDialogWait(*args):
- """
- MC_HideDialogWait()
-
- Hides the wait dialog.
- """
- return _mc.MC_HideDialogWait(*args)
-
- def MC_ShowDialogConfirm(*args):
- """
- MC_ShowDialogConfirm(string heading, string body, string cancelButton, string confirmButton) -> bool
-
- Displays a confirmation dialog, such as Ok/Canel or Yes/No.
-
- Returns true if the confirm button was clicked or false if the cancel
- button was pressed or if the dialog was closed.
-
- Parameters:
- -----------
-
- heading: heading for the dialog
-
- body: contents of the dialog. use [CR] for line breaks.
-
- cancelButton: text to appear in the cancel button. Default is
- "Cancel". Optional.
-
- confirmButton: text to appear in the confirm button. Default is
- "Ok". Optional.
- """
- return _mc.MC_ShowDialogConfirm(*args)
-
- def MC_ShowDialogOk(*args):
- """
- MC_ShowDialogOk(string heading, string body)
-
- Displays an "Ok" dialog for displaying information to the user.
-
- Parameters:
- -----------
-
- heading: heading of the dialog
-
- body: contents of the dialog. use [CR] for line breaks.
- """
- return _mc.MC_ShowDialogOk(*args)
-
- def MC_ShowDialogKeyboard(*args):
- """
- MC_ShowDialogKeyboard(string heading, string defaultValue, bool hiddenInput) -> string
-
- Displays a keyboard dialog for text input.
-
- Returns true if a value was entered or false if the dialog was
- cancelled.
-
- Parameters:
- -----------
-
- heading: heading of the dialog
-
- defaultValue: value to be pre-populated in the dialog when displayed.
- if the dialog was closed with "Ok" it also contains the value that
- was types.
-
- hiddenInput: false - the typed value is displayed, true - the typed
- value is hidden and * are shown instead.
- """
- return _mc.MC_ShowDialogKeyboard(*args)
-
- def MC_LogDebug(*args):
- """
- MC_LogDebug(string msg)
-
- Log debug message into the Boxee log file.
-
- Parameters:
- -----------
-
- msg: message to be written to the log file
- """
- return _mc.MC_LogDebug(*args)
-
- def MC_LogInfo(*args):
- """
- MC_LogInfo(string msg)
-
- Log information message into the Boxee log file.
-
- Parameters:
- -----------
-
- msg: message to be written to the log file
- """
- return _mc.MC_LogInfo(*args)
-
- def MC_LogError(*args):
- """
- MC_LogError(string msg)
-
- Log error message into the Boxee log file.
-
- Parameters:
- -----------
-
- msg: message to be written to the log file
- """
- return _mc.MC_LogError(*args)
-
- def MC_GetActiveWindow(*args):
- """
- MC_GetActiveWindow() -> Window
-
- Get a reference to the currently active window.
- """
- return _mc.MC_GetActiveWindow(*args)
-
- def MC_GetWindow(*args):
- """
- MC_GetWindow(int id) -> Window
-
- Get a reference to the window by its id.
-
- Parameters:
- -----------
-
- id: the id of the window
- """
- return _mc.MC_GetWindow(*args)
-
- def MC_ActivateWindow(*args):
- """
- MC_ActivateWindow(int id)
-
- Activate a specific window by its id.
-
- Parameters:
- -----------
-
- id: the id of the window
- """
- return _mc.MC_ActivateWindow(*args)
-
- def MC_CloseWindow(*args):
- """
- MC_CloseWindow()
-
- Closes the currently active window and go to the previously open
- window.
- """
- return _mc.MC_CloseWindow(*args)
-
- def MC_GetPlayer(*args):
- """
- MC_GetPlayer() -> Player
-
- Returns a reference to a media player that can be used for playing
- media.
- """
- return _mc.MC_GetPlayer(*args)
-
- def MC_GetTempDir(*args):
- """
- MC_GetTempDir() -> string
-
- Returns the full path of a directory where temporary files can be
- placed.
- """
- return _mc.MC_GetTempDir(*args)
-
- def MC_GetApp(*args):
- """
- MC_GetApp() -> App
-
- Returns a reference to the App object, that should be used for
- application specific operations.
- """
- return _mc.MC_GetApp(*args)
-
- def MC_GetCookieJar(*args):
- """
- MC_GetCookieJar() -> string
-
- Returns the cookie jar used by boxee.
- """
- return _mc.MC_GetCookieJar(*args)
-
- class Player(_object):
- """
- This class represents the Player object used for playing all kinds of
- media items.
- """
- __swig_setmethods__ = {}
- __setattr__ = lambda self, name, value: _swig_setattr(self, Player, name, value)
- __swig_getmethods__ = {}
- __getattr__ = lambda self, name: _swig_getattr(self, Player, name)
- __repr__ = _swig_repr
- XAPP_PLAYER_ACTION_NONE = _mc.Player_XAPP_PLAYER_ACTION_NONE
- XAPP_PLAYER_ACTION_NEXT = _mc.Player_XAPP_PLAYER_ACTION_NEXT
- XAPP_PLAYER_ACTION_PREV = _mc.Player_XAPP_PLAYER_ACTION_PREV
- XAPP_PLAYER_ACTION_STOP = _mc.Player_XAPP_PLAYER_ACTION_STOP
- EVENT_NEXT_ITEM = _mc.Player_EVENT_NEXT_ITEM
- EVENT_STOPPED = _mc.Player_EVENT_STOPPED
- EVENT_ENDED = _mc.Player_EVENT_ENDED
- EVENT_STARTED = _mc.Player_EVENT_STARTED
- EVENT_NONE = _mc.Player_EVENT_NONE
- def __init__(self, *args):
- """
- __init__(self, bool bRegisterCallbacks=False) -> Player
- __init__(self) -> Player
-
- Creates a new player object.
-
- Parameters:
- -----------
-
- bRegisterCallbacks: indicates whether player action and event
- callbacks are tracked, false by default. If you enable callbacks you
- must have a single instance of a player in your application.
- """
- this = _mc.new_Player(*args)
- try: self.this.append(this)
- except: self.this = this
- __swig_destroy__ = _mc.delete_Player
- __del__ = lambda self : None;
- def PlaySelected(*args):
- """
- PlaySelected(self, int iItem, int type=0)
- PlaySelected(self, int iItem)
-
- Play item with specified index from the current playlist.
-
- Parameters:
- -----------
-
- iItem: index of the item to play from the current playlist
-
- TODO: Can not use the enum because of name conflict with existing
- PLAYLIST_MUSIC and PLAYLIST_VIDEO
- """
- return _mc.Player_PlaySelected(*args)
-
- def GetTime(*args):
- """
- GetTime(self) -> double
-
- Returns the current time in seconds of the currently playing media.
-
- Fractional portions of a second are possible. This returns a double to
- be consistent with GetTotalTime() and SeekTime(). Throws an exception
- if no item is currently playing.
- """
- return _mc.Player_GetTime(*args)
-
- def SeekTime(*args):
- """
- SeekTime(self, double seekTime)
-
- Sets the current position of the currently playing media to the
- specified time in seconds.
-
- Fractional portions of a second are valid. The passed time is the time
- offset from the beginning of the file as opposed to a delta from the
- current position. This method accepts a double to be consistent with
- GetTime() and GetTotalTime().
-
- Parameters:
- -----------
-
- seekTime: time in seconds
- """
- return _mc.Player_SeekTime(*args)
-
- def GetTotalTime(*args):
- """
- GetTotalTime(self) -> double
-
- Returns the total time in seconds of the current media.
-
- Fractional portions of a second are possible - but not necessarily
- supported by the player class. This returns a double to be consistent
- with GetTime() and SeekTime(). Throws an exception if no item is
- currently playing.
- """
- return _mc.Player_GetTotalTime(*args)
-
- def Stop(*args):
- """
- Stop(self)
-
- Stops playback.
- """
- return _mc.Player_Stop(*args)
-
- def Play(*args):
- """
- Play(self, ListItem item)
-
- Plays the specified list item.
-
- Parameters:
- -----------
-
- item: item to play
- """
- return _mc.Player_Play(*args)
-
- def PlayWithActionMenu(*args):
- """
- PlayWithActionMenu(self, ListItem item)
-
- Open Media Action Dialog on specified item.
-
- Parameters:
- -----------
-
- item: item to play
- """
- return _mc.Player_PlayWithActionMenu(*args)
-
- def Pause(*args):
- """
- Pause(self)
-
- Pause playback.
- """
- return _mc.Player_Pause(*args)
-
- def PlayNext(*args):
- """
- PlayNext(self)
-
- Skip to next item in the playlist.
- """
- return _mc.Player_PlayNext(*args)
-
- def PlayPrevious(*args):
- """
- PlayPrevious(self)
-
- Skip to the previous item in the playlist.
- """
- return _mc.Player_PlayPrevious(*args)
-
- def LockPlayerAction(*args):
- """
- LockPlayerAction(self, PLAYER_ACTION action)
-
- Disable specific player action Use XAPP_PLAYER_ACTION_NONE to unlock
- all action.
-
- Parameters:
- -----------
-
- action: action to lock
- """
- return _mc.Player_LockPlayerAction(*args)
-
- def GetLastPlayerEvent(*args):
- """
- GetLastPlayerEvent(self) -> int
-
- Returns the last event that occured in the player.
- """
- return _mc.Player_GetLastPlayerEvent(*args)
-
- def SetLastPlayerEvent(*args):
- """
- SetLastPlayerEvent(self, PLAYER_EVENT event)
-
- Set player event.
-
- Parameters:
- -----------
-
- event: player event
- """
- return _mc.Player_SetLastPlayerEvent(*args)
-
- def GetLastPlayerAction(*args):
- """
- GetLastPlayerAction(self) -> int
-
- Get last action performed by the player.
- """
- return _mc.Player_GetLastPlayerAction(*args)
-
- def SetLastPlayerAction(*args):
- """
- SetLastPlayerAction(self, PLAYER_ACTION action)
-
- Set lst player action.
-
- Parameters:
- -----------
-
- action: player action
- """
- return _mc.Player_SetLastPlayerAction(*args)
-
- def GetPlayingItem(*args):
- """
- GetPlayingItem(self) -> ListItem
-
- Returns the currently playing item.
- """
- return _mc.Player_GetPlayingItem(*args)
-
- def IsPlaying(*args):
- """
- IsPlaying(self) -> bool
-
- Returns true if Boxee is currently playing media, false otherwise.
- """
- return _mc.Player_IsPlaying(*args)
-
- def IsPlayingAudio(*args):
- """
- IsPlayingAudio(self) -> bool
-
- Returns true if Boxee is currently playing audio, false otherwise.
- """
- return _mc.Player_IsPlayingAudio(*args)
-
- def IsPlayingVideo(*args):
- """
- IsPlayingVideo(self) -> bool
-
- Returns true if Boxee is currently playing video, false otherwise.
- """
- return _mc.Player_IsPlayingVideo(*args)
-
- def IsPaused(*args):
- """
- IsPaused(self) -> bool
-
- Returns true if playback is paused.
- """
- return _mc.Player_IsPaused(*args)
-
- def IsCaching(*args):
- """
- IsCaching(self) -> bool
-
- Returns true if the player is currently at the caching phase.
- """
- return _mc.Player_IsCaching(*args)
-
- def IsForwarding(*args):
- """
- IsForwarding(self) -> bool
-
- Returns true if the player is currently perfroming fast forward
- operation.
- """
- return _mc.Player_IsForwarding(*args)
-
- def IsRewinding(*args):
- """
- IsRewinding(self) -> bool
-
- Returns true if the player is currently perfroming rewind operation.
-
- """
- return _mc.Player_IsRewinding(*args)
-
- def SetVolume(*args):
- """
- SetVolume(self, int percent)
-
- Set Boxee volume.
-
- Parameters:
- -----------
-
- percent: volume value (in percent)
- """
- return _mc.Player_SetVolume(*args)
-
- def GetVolume(*args):
- """
- GetVolume(self) -> int
-
- Returns current volume of the application.
- """
- return _mc.Player_GetVolume(*args)
-
- def ToggleMute(*args):
- """
- ToggleMute(self)
-
- Mute Boxee.
- """
- return _mc.Player_ToggleMute(*args)
-
- Player_swigregister = _mc.Player_swigregister
- Player_swigregister(Player)
-
- class PlayList(_object):
- """
- Represents a play list.
- """
- __swig_setmethods__ = {}
- __setattr__ = lambda self, name, value: _swig_setattr(self, PlayList, name, value)
- __swig_getmethods__ = {}
- __getattr__ = lambda self, name: _swig_getattr(self, PlayList, name)
- __repr__ = _swig_repr
- PLAYLIST_MUSIC = _mc.PlayList_PLAYLIST_MUSIC
- PLAYLIST_VIDEO = _mc.PlayList_PLAYLIST_VIDEO
- def __init__(self, *args):
- """
- __init__(self, PlayListType type) -> PlayList
-
- Create playlist of the specifed type (music or video).
- """
- this = _mc.new_PlayList(*args)
- try: self.this.append(this)
- except: self.this = this
- __swig_destroy__ = _mc.delete_PlayList
- __del__ = lambda self : None;
- def Play(*args):
- """
- Play(self, int iItem)
-
- Plays the specified item from the playlist.
- """
- return _mc.PlayList_Play(*args)
-
- def Add(*args):
- """
- Add(self, ListItem item)
-
- Add item to the playlist.
-
- Parameters:
- -----------
-
- item: item to add
- """
- return _mc.PlayList_Add(*args)
-
- def GetItem(*args):
- """
- GetItem(self, int index) -> ListItem
-
- Returns the item with the specified index from the playlist.
- """
- return _mc.PlayList_GetItem(*args)
-
- def Clear(*args):
- """
- Clear(self)
-
- Clears playlist.
- """
- return _mc.PlayList_Clear(*args)
-
- def GetPosition(*args):
- """
- GetPosition(self) -> int
-
- Returns the position of the current item in the playlist.
- """
- return _mc.PlayList_GetPosition(*args)
-
- def Size(*args):
- """
- Size(self) -> int
-
- Returns the size of the playlist.
- """
- return _mc.PlayList_Size(*args)
-
- PlayList_swigregister = _mc.PlayList_swigregister
- PlayList_swigregister(PlayList)
-
- class Parameters(stdParameters):
- """
- This class represents parameters that are passed to application
- launch.
-
- Should be used as a dictionary.
- """
- __swig_setmethods__ = {}
- for _s in [stdParameters]: __swig_setmethods__.update(getattr(_s,'__swig_setmethods__',{}))
- __setattr__ = lambda self, name, value: _swig_setattr(self, Parameters, name, value)
- __swig_getmethods__ = {}
- for _s in [stdParameters]: __swig_getmethods__.update(getattr(_s,'__swig_getmethods__',{}))
- __getattr__ = lambda self, name: _swig_getattr(self, Parameters, name)
- __repr__ = _swig_repr
- def toQueryString(*args):
- """
- toQueryString(self) -> string
-
- Converts the parameters in a URL query to a string:
- key=value&key2=value.
- """
- return _mc.Parameters_toQueryString(*args)
-
- def __init__(self, *args):
- """
- __init__(self) -> Parameters
-
- 1
- """
- this = _mc.new_Parameters(*args)
- try: self.this.append(this)
- except: self.this = this
- __swig_destroy__ = _mc.delete_Parameters
- __del__ = lambda self : None;
- Parameters_swigregister = _mc.Parameters_swigregister
- Parameters_swigregister(Parameters)
-
- class App(_object):
- """
- Main class for working with an application.
-
- Includes launching of applications, accessing the application
- configuration parameters storage, etc. Get the App object by calling
- GetApp() function.
- """
- __swig_setmethods__ = {}
- __setattr__ = lambda self, name, value: _swig_setattr(self, App, name, value)
- __swig_getmethods__ = {}
- __getattr__ = lambda self, name: _swig_getattr(self, App, name)
- __repr__ = _swig_repr
- def GetLocalConfig(*args):
- """
- GetLocalConfig() -> LocalConfig
-
- Returns the local configuration storage for an application.
- """
- return _mc.App_GetLocalConfig(*args)
-
- if _newclass:GetLocalConfig = staticmethod(GetLocalConfig)
- __swig_getmethods__["GetLocalConfig"] = lambda x: GetLocalConfig
- def ActivateWindow(*args):
- """
- ActivateWindow(int windowId, Parameters parameters)
-
- Activate a window of the application with parameters.
-
- Parameters:
- -----------
-
- windowId: window id
-
- parameters: parameters that will be passed to the application
- """
- return _mc.App_ActivateWindow(*args)
-
- if _newclass:ActivateWindow = staticmethod(ActivateWindow)
- __swig_getmethods__["ActivateWindow"] = lambda x: ActivateWindow
- def GetLaunchedWindowParameters(*args):
- """
- GetLaunchedWindowParameters() -> Parameters
-
- Returns the parameters of the activated application window using
- ActivateWindow.
- """
- return _mc.App_GetLaunchedWindowParameters(*args)
-
- if _newclass:GetLaunchedWindowParameters = staticmethod(GetLaunchedWindowParameters)
- __swig_getmethods__["GetLaunchedWindowParameters"] = lambda x: GetLaunchedWindowParameters
- def GetLaunchedListItem(*args):
- """
- GetLaunchedListItem() -> ListItem
-
- Returns the list item that the application was launched with.
-
- this is mainly useful to get an item from the
- history/recommendation/rating.
- """
- return _mc.App_GetLaunchedListItem(*args)
-
- if _newclass:GetLaunchedListItem = staticmethod(GetLaunchedListItem)
- __swig_getmethods__["GetLaunchedListItem"] = lambda x: GetLaunchedListItem
- def RunScript(*args):
- """
- RunScript(string scriptName, Parameters parameters)
-
- Run a python script of an application.
-
- Parameters:
- -----------
-
- scriptName: script name
-
- parameters: parameters that will be passed to the application script
-
- """
- return _mc.App_RunScript(*args)
-
- if _newclass:RunScript = staticmethod(RunScript)
- __swig_getmethods__["RunScript"] = lambda x: RunScript
- def GetLaunchedScriptParameters(*args):
- """
- GetLaunchedScriptParameters() -> Parameters
-
- Returns the parameters of the executed script using RunScript.
-
- You can also access those parameters with sys.arv[1].
- """
- return _mc.App_GetLaunchedScriptParameters(*args)
-
- if _newclass:GetLaunchedScriptParameters = staticmethod(GetLaunchedScriptParameters)
- __swig_getmethods__["GetLaunchedScriptParameters"] = lambda x: GetLaunchedScriptParameters
- def GetId(*args):
- """
- GetId() -> string
-
- Returns the id of the currently running application.
- """
- return _mc.App_GetId(*args)
-
- if _newclass:GetId = staticmethod(GetId)
- __swig_getmethods__["GetId"] = lambda x: GetId
- def GetAppDir(*args):
- """
- GetAppDir() -> string
-
- Returns the full path where the application is installed.
- """
- return _mc.App_GetAppDir(*args)
-
- if _newclass:GetAppDir = staticmethod(GetAppDir)
- __swig_getmethods__["GetAppDir"] = lambda x: GetAppDir
- def GetAppMediaDir(*args):
- """
- GetAppMediaDir() -> string
-
- Returns the full path where the media files of the application are
- stored.
- """
- return _mc.App_GetAppMediaDir(*args)
-
- if _newclass:GetAppMediaDir = staticmethod(GetAppMediaDir)
- __swig_getmethods__["GetAppMediaDir"] = lambda x: GetAppMediaDir
- def GetAppSkinDir(*args):
- """
- GetAppSkinDir() -> string
-
- Returns the full path where the skin files of the application are
- stored.
- """
- return _mc.App_GetAppSkinDir(*args)
-
- if _newclass:GetAppSkinDir = staticmethod(GetAppSkinDir)
- __swig_getmethods__["GetAppSkinDir"] = lambda x: GetAppSkinDir
- def GetAuthenticationToken(*args):
- """
- GetAuthenticationToken() -> string
-
- Returns an authentication token for the application.
-
- For boxee internal use.
- """
- return _mc.App_GetAuthenticationToken(*args)
-
- if _newclass:GetAuthenticationToken = staticmethod(GetAuthenticationToken)
- __swig_getmethods__["GetAuthenticationToken"] = lambda x: GetAuthenticationToken
- def __init__(self, *args):
- """
- __init__(self) -> App
-
- 1
- """
- this = _mc.new_App(*args)
- try: self.this.append(this)
- except: self.this = this
- __swig_destroy__ = _mc.delete_App
- __del__ = lambda self : None;
- App_swigregister = _mc.App_swigregister
- App_swigregister(App)
-
- def App_GetLocalConfig(*args):
- """
- App_GetLocalConfig() -> LocalConfig
-
- Returns the local configuration storage for an application.
- """
- return _mc.App_GetLocalConfig(*args)
-
- def App_ActivateWindow(*args):
- """
- App_ActivateWindow(int windowId, Parameters parameters)
-
- Activate a window of the application with parameters.
-
- Parameters:
- -----------
-
- windowId: window id
-
- parameters: parameters that will be passed to the application
- """
- return _mc.App_ActivateWindow(*args)
-
- def App_GetLaunchedWindowParameters(*args):
- """
- App_GetLaunchedWindowParameters() -> Parameters
-
- Returns the parameters of the activated application window using
- ActivateWindow.
- """
- return _mc.App_GetLaunchedWindowParameters(*args)
-
- def App_GetLaunchedListItem(*args):
- """
- App_GetLaunchedListItem() -> ListItem
-
- Returns the list item that the application was launched with.
-
- this is mainly useful to get an item from the
- history/recommendation/rating.
- """
- return _mc.App_GetLaunchedListItem(*args)
-
- def App_RunScript(*args):
- """
- App_RunScript(string scriptName, Parameters parameters)
-
- Run a python script of an application.
-
- Parameters:
- -----------
-
- scriptName: script name
-
- parameters: parameters that will be passed to the application script
-
- """
- return _mc.App_RunScript(*args)
-
- def App_GetLaunchedScriptParameters(*args):
- """
- App_GetLaunchedScriptParameters() -> Parameters
-
- Returns the parameters of the executed script using RunScript.
-
- You can also access those parameters with sys.arv[1].
- """
- return _mc.App_GetLaunchedScriptParameters(*args)
-
- def App_GetId(*args):
- """
- App_GetId() -> string
-
- Returns the id of the currently running application.
- """
- return _mc.App_GetId(*args)
-
- def App_GetAppDir(*args):
- """
- App_GetAppDir() -> string
-
- Returns the full path where the application is installed.
- """
- return _mc.App_GetAppDir(*args)
-
- def App_GetAppMediaDir(*args):
- """
- App_GetAppMediaDir() -> string
-
- Returns the full path where the media files of the application are
- stored.
- """
- return _mc.App_GetAppMediaDir(*args)
-
- def App_GetAppSkinDir(*args):
- """
- App_GetAppSkinDir() -> string
-
- Returns the full path where the skin files of the application are
- stored.
- """
- return _mc.App_GetAppSkinDir(*args)
-
- def App_GetAuthenticationToken(*args):
- """
- App_GetAuthenticationToken() -> string
-
- Returns an authentication token for the application.
-
- For boxee internal use.
- """
- return _mc.App_GetAuthenticationToken(*args)
-
- def GetLocalizedString(id):
- return MC.GetLocalizedString(id)
-
- def GetInfoString(info):
- return MC.GetInfoString(info)
-
- def ShowDialogNotification(msg, thumbnail=""):
- MC.ShowDialogNotification(msg, thumbnail)
-
- def ShowDialogWait():
- MC.ShowDialogWait()
-
- def HideDialogWait():
- MC.HideDialogWait()
-
- def ShowDialogConfirm(heading, body, cancelButton, confirmButton):
- return MC.ShowDialogConfirm(heading, body, cancelButton, confirmButton)
-
- def ShowDialogOk(heading, body):
- MC.ShowDialogOk(heading, body)
-
- def ShowDialogKeyboard(heading, value, hiddenInput):
- return MC.ShowDialogKeyboard(heading, value, hiddenInput);
-
- def ShowCustomDialog(id):
- return MC.ShowCustomDialog(id)
-
- def CloseActiveDialogs():
- return MC.CloseActiveDialogs()
-
- def LogDebug(msg):
- MC.LogDebug(msg)
-
- def LogInfo(msg):
- MC.LogDebug(msg)
-
- def LogError(msg):
- MC.LogDebug(msg)
-
- def GetActiveWindow():
- return MC.GetActiveWindow()
-
- def CloseWindow():
- MC.CloseWindow()
-
- def GetWindow(id):
- return MC.GetWindow(id)
-
- def ActivateWindow(id):
- MC.ActivateWindow(id)
-
- def GetPlayer():
- return MC.GetPlayer()
-
- def GetTempDir():
- return MC.GetTempDir()
-
- def GetApp():
- return MC.GetApp()
-
- def GetCookieJar():
- return MC.GetCookieJar()
-
-
-
-
-