class Instance:
- @staticmethod
- def new(*p):
- """Create a new Instance.
+ """Create a new Instance instance.
+
+ It may take as parameter either:
+ - a string
+ - a list of strings as first parameters
+ - the parameters given as the constructor parameters (must be strings)
+ - a MediaControl instance
+ """
+ def __new__(cls, *p):
+ if p and p[0] == 0:
+ return None
+ elif p and isinstance(p[0], (int, long)):
+ # instance creation from ctypes
+ o=object.__new__(cls)
+ o._as_parameter_=ctypes.c_void_p(p[0])
+ return o
+ elif len(p) == 1 and isinstance(p[0], basestring):
+ # Only 1 string parameter: should be a parameter line
+ p=p[0].split(' ')
+ elif len(p) == 1 and isinstance(p[0], (tuple, list)):
+ p=p[0]
+
+ if p and isinstance(p[0], MediaControl):
+ return p[0].get_instance()
+ else:
+ if not p and detected_plugin_path is not None:
+ # No parameters passed. Under win32 and MacOS, specify
+ # the detected_plugin_path if present.
+ p=[ 'vlc', '--plugin-path='+ detected_plugin_path ]
+ e=VLCException()
+ return libvlc_new(len(p), p, e)
+
+ def media_player_new(self, uri=None):
+ """Create a new Media Player object.
+
+ @param uri: an optional URI to play in the player.
+ """
+ e=VLCException()
+ p=libvlc_media_player_new(self, e)
+ if uri:
+ p.set_media(self.media_new(uri))
+ p._instance=self
+ return p
+
+ def media_list_player_new(self):
+ """Create an empty Media Player object
"""
e=VLCException()
- return libvlc_new(len(p), p, e)
+ p=libvlc_media_list_player_new(self, e)
+ p._instance=self
+ return p
class MediaControl:
- @staticmethod
- def new(*p):
- """Create a new MediaControl
+ """Create a new MediaControl instance
+
+ It may take as parameter either:
+ - a string
+ - a list of strings as first parameters
+ - the parameters given as the constructor parameters (must be strings)
+ - a vlc.Instance
+ """
+ def __new__(cls, *p):
+ if p and p[0] == 0:
+ return None
+ elif p and isinstance(p[0], (int, long)):
+ # instance creation from ctypes
+ o=object.__new__(cls)
+ o._as_parameter_=ctypes.c_void_p(p[0])
+ return o
+ elif len(p) == 1 and isinstance(p[0], basestring):
+ # Only 1 string parameter: should be a parameter line
+ p=p[0].split(' ')
+ elif len(p) == 1 and isinstance(p[0], (tuple, list)):
+ p=p[0]
+
+ if p and isinstance(p[0], Instance):
+ e=MediaControlException()
+ return mediacontrol_new_from_instance(p[0], e)
+ else:
+ if not p and detected_plugin_path is not None:
+ # No parameters passed. Under win32 and MacOS, specify
+ # the detected_plugin_path if present.
+ p=[ 'vlc', '--plugin-path='+ detected_plugin_path ]
+ e=MediaControlException()
+ return mediacontrol_new(len(p), p, e)
+
+ def get_media_position(self, origin=PositionOrigin.AbsolutePosition, key=PositionKey.MediaTime):
+ e=MediaControlException()
+ p=mediacontrol_get_media_position(self, origin, key, e)
+ if p:
+ return p.contents
+ else:
+ return None
+
+ def set_media_position(self, pos):
+ """Set the media position.
+
+ @param pos: a MediaControlPosition or an integer (in ms)
"""
+ if not isinstance(pos, MediaControlPosition):
+ pos=MediaControlPosition(long(pos))
e=MediaControlException()
- return mediacontrol_new(len(p), p, e)
+ mediacontrol_set_media_position(self, pos, e)
- @staticmethod
- def new_from_instance(i):
- """Create a new MediaControl from an existing Instance.
+ def start(self, pos=0):
+ """Start the player at the given position.
+
+ @param pos: a MediaControlPosition or an integer (in ms)
"""
+ if not isinstance(pos, MediaControlPosition):
+ pos=MediaControlPosition(long(pos))
e=MediaControlException()
- return mediacontrol_new_from_instance(i, e)
+ mediacontrol_start(self, pos, e)
-class MediaList:
- def __len__(self):
- e=VLCException()
- return libvlc_media_list_count(self, e)
+ def snapshot(self, pos=0):
+ """Take a snapshot.
+
+ Note: the position parameter is not properly implemented. For
+ the moment, the only valid position is the 0-relative position
+ (i.e. the current position).
+
+ @param pos: a MediaControlPosition or an integer (in ms)
+ """
+ if not isinstance(pos, MediaControlPosition):
+ pos=MediaControlPosition(long(pos))
+ e=MediaControlException()
+ p=mediacontrol_snapshot(self, pos, e)
+ if p:
+ snap=p.contents
+ # FIXME: there is a bug in the current mediacontrol_snapshot
+ # implementation, which sets an incorrect date.
+ # Workaround here:
+ snap.date=self.get_media_position().value
+ return snap
+ else:
+ return None
+
+ def display_text(self, message='', begin=0, end=1000):
+ """Display a caption between begin and end positions.
- def __getitem__(self, i):
+ @param message: the caption to display
+ @param begin: the begin position
+ @param end: the end position
+ """
+ if not isinstance(begin, MediaControlPosition):
+ begin=self.value2position(pos)
+ if not isinstance(end, MediaControlPosition):
+ end=self.value2position(end)
+ e=MediaControlException()
+ mediacontrol_display_text(self, message, begin, end, e)
+
+ def get_stream_information(self, key=PositionKey.MediaTime):
+ """Return information about the stream.
+ """
+ e=MediaControlException()
+ return mediacontrol_get_stream_information(self, key, e).contents
+
+class MediaPlayer:
+ """Create a new MediaPlayer instance.
+
+ It may take as parameter either:
+ - a string (media URI). In this case, a vlc.Instance will be created.
+ - a vlc.Instance
+ """
+ def __new__(cls, *p):
+ if p and p[0] == 0:
+ return None
+ elif p and isinstance(p[0], (int, long)):
+ # instance creation from ctypes
+ o=object.__new__(cls)
+ o._as_parameter_=ctypes.c_void_p(p[0])
+ return o
+
+ if p and isinstance(p[0], Instance):
+ return p[0].media_player_new()
+ else:
+ i=Instance()
+ o=i.media_player_new()
+ if p:
+ o.set_media(i.media_new(p[0]))
+ return o
+
+ def get_instance(self):
+ """Return the associated vlc.Instance.
+ """
+ return self._instance
+
+class MediaListPlayer:
+ """Create a new MediaPlayer instance.
+
+ It may take as parameter either:
+ - a vlc.Instance
+ - nothing
+ """
+ def __new__(cls, *p):
+ if p and p[0] == 0:
+ return None
+ elif p and isinstance(p[0], (int, long)):
+ # instance creation from ctypes
+ o=object.__new__(cls)
+ o._as_parameter_=ctypes.c_void_p(p[0])
+ return o
+ elif len(p) == 1 and isinstance(p[0], (tuple, list)):
+ p=p[0]
+
+ if p and isinstance(p[0], Instance):
+ return p[0].media_list_player_new()
+ else:
+ i=Instance()
+ o=i.media_list_player_new()
+ return o
+
+ def get_instance(self):
+ """Return the associated vlc.Instance.
+ """
+ return self._instance
+
+class LogIterator:
+ def __iter__(self):
+ return self
+
+ def next(self):
+ if not self.has_next():
+ raise StopIteration
+ buf=LogMessage()
e=VLCException()
- return libvlc_media_list_item_at_index(self, i, e)
+ ret=libvlc_log_iterator_next(self, buf, e)
+ return ret.contents
+
+class Log:
+ def __iter__(self):
+ return self.get_iterator()
+
+ def dump(self):
+ return [ str(m) for m in self ]
projects / vlc / blobdiff