openlp-core team mailing list archive
-
openlp-core team
-
Mailing list archive
-
Message #12989
[Merge] lp:~crichter/openlp/media into lp:openlp
rimach has proposed merging lp:~crichter/openlp/media into lp:openlp.
Requested reviews:
John Cegalis (jseagull1)
Andreas Preikschat (googol)
Jonathan Corwin (j-corwin)
For more details, see:
https://code.launchpad.net/~crichter/openlp/media/+merge/84344
add vlc mediaplayer
--
https://code.launchpad.net/~crichter/openlp/media/+merge/84344
Your team OpenLP Core is subscribed to branch lp:openlp.
=== added file 'openlp/core/ui/media/vlc.py'
--- openlp/core/ui/media/vlc.py 1970-01-01 00:00:00 +0000
+++ openlp/core/ui/media/vlc.py 2011-12-02 23:48:27 +0000
@@ -0,0 +1,6274 @@
+#! /usr/bin/python
+
+# Python ctypes bindings for VLC
+#
+# Copyright (C) 2009-2010 the VideoLAN team
+# $Id: $
+#
+# Authors: Olivier Aubert <olivier.aubert at liris.cnrs.fr>
+# Jean Brouwers <MrJean1 at gmail.com>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+
+"""This module provides bindings for the LibVLC public API, see
+U{http://wiki.videolan.org/LibVLC}.
+
+You can find the documentation and a README file with some examples
+at U{http://www.advene.org/download/python-ctypes/}.
+
+Basically, the most important class is L{Instance}, which is used
+to create a libvlc instance. From this instance, you then create
+L{MediaPlayer} and L{MediaListPlayer} instances.
+
+Alternatively, you may create instances of the L{MediaPlayer} and
+L{MediaListPlayer} class directly and an instance of L{Instance}
+will be implicitly created. The latter can be obtained using the
+C{get_instance} method of L{MediaPlayer} and L{MediaListPlayer}.
+"""
+
+import ctypes
+from ctypes.util import find_library
+import os
+import sys
+
+# Used by EventManager in override.py
+from inspect import getargspec
+
+__version__ = "N/A"
+build_date = "Tue Sep 13 17:50:18 2011"
+
+# Internal guard to prevent internal classes to be directly
+# instanciated.
+_internal_guard = object()
+
+def find_lib():
+ dll = None
+ plugin_path = None
+ if sys.platform.startswith('linux'):
+ p = find_library('vlc')
+ try:
+ dll = ctypes.CDLL(p)
+ except OSError: # may fail
+ dll = ctypes.CDLL('libvlc.so.5')
+ elif sys.platform.startswith('win'):
+ p = find_library('libvlc.dll')
+ if p is None:
+ try: # some registry settings
+ import _winreg as w # leaner than win32api, win32con
+ for r in w.HKEY_LOCAL_MACHINE, w.HKEY_CURRENT_USER:
+ try:
+ r = w.OpenKey(r, 'Software\\VideoLAN\\VLC')
+ plugin_path, _ = w.QueryValueEx(r, 'InstallDir')
+ w.CloseKey(r)
+ break
+ except w.error:
+ pass
+ except ImportError: # no PyWin32
+ pass
+ if plugin_path is None:
+ # try some standard locations.
+ for p in ('Program Files\\VideoLan\\', 'VideoLan\\',
+ 'Program Files\\', ''):
+ p = 'C:\\' + p + 'VLC\\libvlc.dll'
+ if os.path.exists(p):
+ plugin_path = os.path.dirname(p)
+ break
+ if plugin_path is not None: # try loading
+ p = os.getcwd()
+ os.chdir(plugin_path)
+ # if chdir failed, this will raise an exception
+ dll = ctypes.CDLL('libvlc.dll')
+ # restore cwd after dll has been loaded
+ os.chdir(p)
+ else: # may fail
+ dll = ctypes.CDLL('libvlc.dll')
+ else:
+ plugin_path = os.path.dirname(p)
+ dll = ctypes.CDLL(p)
+
+ elif sys.platform.startswith('darwin'):
+ # FIXME: should find a means to configure path
+ d = '/Applications/VLC.app/Contents/MacOS/'
+ p = d + 'lib/libvlc.dylib'
+ if os.path.exists(p):
+ dll = ctypes.CDLL(p)
+ d += 'modules'
+ if os.path.isdir(d):
+ plugin_path = d
+ else: # hope, some PATH is set...
+ dll = ctypes.CDLL('libvlc.dylib')
+
+ else:
+ raise NotImplementedError('%s: %s not supported' % (sys.argv[0], sys.platform))
+
+ return (dll, plugin_path)
+
+# plugin_path used on win32 and MacOS in override.py
+dll, plugin_path = find_lib()
+
+class VLCException(Exception):
+ """Exception raised by libvlc methods.
+ """
+ pass
+
+try:
+ _Ints = (int, long)
+except NameError: # no long in Python 3+
+ _Ints = int
+
+# Default instance. It is used to instanciate classes directly in the
+# OO-wrapper.
+_default_instance = None
+
+def get_default_instance():
+ """Return the default VLC.Instance.
+ """
+ global _default_instance
+ if _default_instance is None:
+ _default_instance = Instance()
+ return _default_instance
+
+_Seqs = (list, tuple)
+
+_Cfunctions = {} # from LibVLC __version__
+
+def _Cfunction(name, flags, errcheck, *types):
+ """(INTERNAL) New ctypes function binding.
+ """
+ if hasattr(dll, name):
+ p = ctypes.CFUNCTYPE(*types)
+ f = p((name, dll), flags)
+ if errcheck is not None:
+ f.errcheck = errcheck
+ _Cfunctions[name] = f
+ return f
+ raise NameError('no function %r' % (name,))
+
+def _Cobject(cls, ctype):
+ """(INTERNAL) New instance from ctypes.
+ """
+ o = object.__new__(cls)
+ o._as_parameter_ = ctype
+ return o
+
+def _Constructor(cls, ptr=_internal_guard):
+ """(INTERNAL) New wrapper from ctypes.
+ """
+ if ptr == _internal_guard:
+ raise VLCException("(INTERNAL) ctypes class. You should get references for this class through methods of the LibVLC API.")
+ if ptr is None or ptr == 0:
+ return None
+ return _Cobject(cls, ctypes.c_void_p(ptr))
+
+class _Ctype(object):
+ """(INTERNAL) Base class for ctypes.
+ """
+ @staticmethod
+ def from_param(this): # not self
+ """(INTERNAL) ctypes parameter conversion method.
+ """
+ if this is None:
+ return None
+ return this._as_parameter_
+
+class ListPOINTER(object):
+ """Just like a POINTER but accept a list of ctype as an argument.
+ """
+ def __init__(self, etype):
+ self.etype = etype
+
+ def from_param(self, param):
+ if isinstance(param, _Seqs):
+ return (self.etype * len(param))(*param)
+
+# errcheck functions for some native functions.
+def string_result(result, func, arguments):
+ """Errcheck function. Returns a string and frees the original pointer.
+
+ It assumes the result is a char *.
+ """
+ if result:
+ # make a python string copy
+ s = ctypes.string_at(result)
+ # free original string ptr
+ libvlc_free(result)
+ return s
+ return None
+
+def class_result(classname):
+ """Errcheck function. Returns a function that creates the specified class.
+ """
+ def wrap_errcheck(result, func, arguments):
+ if result is None:
+ return None
+ return classname(result)
+ return wrap_errcheck
+
+ # Generated enum types #
+
+class _Enum(ctypes.c_uint):
+ '''(INTERNAL) Base class
+ '''
+ _enum_names_ = {}
+
+ def __str__(self):
+ n = self._enum_names_.get(self.value, '') or ('FIXME_(%r)' % (self.value,))
+ return '.'.join((self.__class__.__name__, n))
+
+ def __repr__(self):
+ return '.'.join((self.__class__.__module__, self.__str__()))
+
+ def __eq__(self, other):
+ return ( (isinstance(other, _Enum) and self.value == other.value)
+ or (isinstance(other, _Ints) and self.value == other) )
+
+ def __ne__(self, other):
+ return not self.__eq__(other)
+
+class EventType(_Enum):
+ '''Event types.
+ '''
+ _enum_names_ = {
+ 0: 'MediaMetaChanged',
+ 1: 'MediaSubItemAdded',
+ 2: 'MediaDurationChanged',
+ 3: 'MediaParsedChanged',
+ 4: 'MediaFreed',
+ 5: 'MediaStateChanged',
+ 0x100: 'MediaPlayerMediaChanged',
+ 257: 'MediaPlayerNothingSpecial',
+ 258: 'MediaPlayerOpening',
+ 259: 'MediaPlayerBuffering',
+ 260: 'MediaPlayerPlaying',
+ 261: 'MediaPlayerPaused',
+ 262: 'MediaPlayerStopped',
+ 263: 'MediaPlayerForward',
+ 264: 'MediaPlayerBackward',
+ 265: 'MediaPlayerEndReached',
+ 266: 'MediaPlayerEncounteredError',
+ 267: 'MediaPlayerTimeChanged',
+ 268: 'MediaPlayerPositionChanged',
+ 269: 'MediaPlayerSeekableChanged',
+ 270: 'MediaPlayerPausableChanged',
+ 271: 'MediaPlayerTitleChanged',
+ 272: 'MediaPlayerSnapshotTaken',
+ 273: 'MediaPlayerLengthChanged',
+ 0x200: 'MediaListItemAdded',
+ 513: 'MediaListWillAddItem',
+ 514: 'MediaListItemDeleted',
+ 515: 'MediaListWillDeleteItem',
+ 0x300: 'MediaListViewItemAdded',
+ 769: 'MediaListViewWillAddItem',
+ 770: 'MediaListViewItemDeleted',
+ 771: 'MediaListViewWillDeleteItem',
+ 0x400: 'MediaListPlayerPlayed',
+ 1025: 'MediaListPlayerNextItemSet',
+ 1026: 'MediaListPlayerStopped',
+ 0x500: 'MediaDiscovererStarted',
+ 1281: 'MediaDiscovererEnded',
+ 0x600: 'VlmMediaAdded',
+ 1537: 'VlmMediaRemoved',
+ 1538: 'VlmMediaChanged',
+ 1539: 'VlmMediaInstanceStarted',
+ 1540: 'VlmMediaInstanceStopped',
+ 1541: 'VlmMediaInstanceStatusInit',
+ 1542: 'VlmMediaInstanceStatusOpening',
+ 1543: 'VlmMediaInstanceStatusPlaying',
+ 1544: 'VlmMediaInstanceStatusPause',
+ 1545: 'VlmMediaInstanceStatusEnd',
+ 1546: 'VlmMediaInstanceStatusError',
+ }
+EventType.MediaDiscovererEnded = EventType(1281)
+EventType.MediaDiscovererStarted = EventType(0x500)
+EventType.MediaDurationChanged = EventType(2)
+EventType.MediaFreed = EventType(4)
+EventType.MediaListItemAdded = EventType(0x200)
+EventType.MediaListItemDeleted = EventType(514)
+EventType.MediaListPlayerNextItemSet = EventType(1025)
+EventType.MediaListPlayerPlayed = EventType(0x400)
+EventType.MediaListPlayerStopped = EventType(1026)
+EventType.MediaListViewItemAdded = EventType(0x300)
+EventType.MediaListViewItemDeleted = EventType(770)
+EventType.MediaListViewWillAddItem = EventType(769)
+EventType.MediaListViewWillDeleteItem = EventType(771)
+EventType.MediaListWillAddItem = EventType(513)
+EventType.MediaListWillDeleteItem = EventType(515)
+EventType.MediaMetaChanged = EventType(0)
+EventType.MediaParsedChanged = EventType(3)
+EventType.MediaPlayerBackward = EventType(264)
+EventType.MediaPlayerBuffering = EventType(259)
+EventType.MediaPlayerEncounteredError = EventType(266)
+EventType.MediaPlayerEndReached = EventType(265)
+EventType.MediaPlayerForward = EventType(263)
+EventType.MediaPlayerLengthChanged = EventType(273)
+EventType.MediaPlayerMediaChanged = EventType(0x100)
+EventType.MediaPlayerNothingSpecial = EventType(257)
+EventType.MediaPlayerOpening = EventType(258)
+EventType.MediaPlayerPausableChanged = EventType(270)
+EventType.MediaPlayerPaused = EventType(261)
+EventType.MediaPlayerPlaying = EventType(260)
+EventType.MediaPlayerPositionChanged = EventType(268)
+EventType.MediaPlayerSeekableChanged = EventType(269)
+EventType.MediaPlayerSnapshotTaken = EventType(272)
+EventType.MediaPlayerStopped = EventType(262)
+EventType.MediaPlayerTimeChanged = EventType(267)
+EventType.MediaPlayerTitleChanged = EventType(271)
+EventType.MediaStateChanged = EventType(5)
+EventType.MediaSubItemAdded = EventType(1)
+EventType.VlmMediaAdded = EventType(0x600)
+EventType.VlmMediaChanged = EventType(1538)
+EventType.VlmMediaInstanceStarted = EventType(1539)
+EventType.VlmMediaInstanceStatusEnd = EventType(1545)
+EventType.VlmMediaInstanceStatusError = EventType(1546)
+EventType.VlmMediaInstanceStatusInit = EventType(1541)
+EventType.VlmMediaInstanceStatusOpening = EventType(1542)
+EventType.VlmMediaInstanceStatusPause = EventType(1544)
+EventType.VlmMediaInstanceStatusPlaying = EventType(1543)
+EventType.VlmMediaInstanceStopped = EventType(1540)
+EventType.VlmMediaRemoved = EventType(1537)
+
+class Meta(_Enum):
+ '''Meta data types.
+ '''
+ _enum_names_ = {
+ 0: 'Title',
+ 1: 'Artist',
+ 2: 'Genre',
+ 3: 'Copyright',
+ 4: 'Album',
+ 5: 'TrackNumber',
+ 6: 'Description',
+ 7: 'Rating',
+ 8: 'Date',
+ 9: 'Setting',
+ 10: 'URL',
+ 11: 'Language',
+ 12: 'NowPlaying',
+ 13: 'Publisher',
+ 14: 'EncodedBy',
+ 15: 'ArtworkURL',
+ 16: 'TrackID',
+ }
+Meta.Album = Meta(4)
+Meta.Artist = Meta(1)
+Meta.ArtworkURL = Meta(15)
+Meta.Copyright = Meta(3)
+Meta.Date = Meta(8)
+Meta.Description = Meta(6)
+Meta.EncodedBy = Meta(14)
+Meta.Genre = Meta(2)
+Meta.Language = Meta(11)
+Meta.NowPlaying = Meta(12)
+Meta.Publisher = Meta(13)
+Meta.Rating = Meta(7)
+Meta.Setting = Meta(9)
+Meta.Title = Meta(0)
+Meta.TrackID = Meta(16)
+Meta.TrackNumber = Meta(5)
+Meta.URL = Meta(10)
+
+class State(_Enum):
+ '''Note the order of libvlc_state_t enum must match exactly the order of
+See mediacontrol_playerstatus, See input_state_e enums,
+and videolan.libvlc.state (at bindings/cil/src/media.cs).
+expected states by web plugins are:
+idle/close=0, opening=1, buffering=2, playing=3, paused=4,
+stopping=5, ended=6, error=7.
+ '''
+ _enum_names_ = {
+ 0: 'NothingSpecial',
+ 1: 'Opening',
+ 2: 'Buffering',
+ 3: 'Playing',
+ 4: 'Paused',
+ 5: 'Stopped',
+ 6: 'Ended',
+ 7: 'Error',
+ }
+State.Buffering = State(2)
+State.Ended = State(6)
+State.Error = State(7)
+State.NothingSpecial = State(0)
+State.Opening = State(1)
+State.Paused = State(4)
+State.Playing = State(3)
+State.Stopped = State(5)
+
+class TrackType(_Enum):
+ '''N/A
+ '''
+ _enum_names_ = {
+ -1: 'unknown',
+ 0: 'audio',
+ 1: 'video',
+ 2: 'text',
+ }
+TrackType.audio = TrackType(0)
+TrackType.text = TrackType(2)
+TrackType.unknown = TrackType(-1)
+TrackType.video = TrackType(1)
+
+class PlaybackMode(_Enum):
+ '''Defines playback modes for playlist.
+ '''
+ _enum_names_ = {
+ 0: 'default',
+ 1: 'loop',
+ 2: 'repeat',
+ }
+PlaybackMode.default = PlaybackMode(0)
+PlaybackMode.loop = PlaybackMode(1)
+PlaybackMode.repeat = PlaybackMode(2)
+
+class VideoMarqueeOption(_Enum):
+ '''Marq options definition.
+ '''
+ _enum_names_ = {
+ 0: 'Enable',
+ 1: 'Text',
+ 2: 'Color',
+ 3: 'Opacity',
+ 4: 'Position',
+ 5: 'Refresh',
+ 6: 'Size',
+ 7: 'Timeout',
+ 8: 'marquee_X',
+ 9: 'marquee_Y',
+ }
+VideoMarqueeOption.Color = VideoMarqueeOption(2)
+VideoMarqueeOption.Enable = VideoMarqueeOption(0)
+VideoMarqueeOption.Opacity = VideoMarqueeOption(3)
+VideoMarqueeOption.Position = VideoMarqueeOption(4)
+VideoMarqueeOption.Refresh = VideoMarqueeOption(5)
+VideoMarqueeOption.Size = VideoMarqueeOption(6)
+VideoMarqueeOption.Text = VideoMarqueeOption(1)
+VideoMarqueeOption.Timeout = VideoMarqueeOption(7)
+VideoMarqueeOption.marquee_X = VideoMarqueeOption(8)
+VideoMarqueeOption.marquee_Y = VideoMarqueeOption(9)
+
+class NavigateMode(_Enum):
+ '''Navigation mode.
+ '''
+ _enum_names_ = {
+ 0: 'activate',
+ 1: 'up',
+ 2: 'down',
+ 3: 'left',
+ 4: 'right',
+ }
+NavigateMode.activate = NavigateMode(0)
+NavigateMode.down = NavigateMode(2)
+NavigateMode.left = NavigateMode(3)
+NavigateMode.right = NavigateMode(4)
+NavigateMode.up = NavigateMode(1)
+
+class VideoLogoOption(_Enum):
+ '''Option values for libvlc_video_{get,set}_logo_{int,string}.
+ '''
+ _enum_names_ = {
+ 0: 'enable',
+ 1: 'file',
+ 2: 'logo_x',
+ 3: 'logo_y',
+ 4: 'delay',
+ 5: 'repeat',
+ 6: 'opacity',
+ 7: 'position',
+ }
+VideoLogoOption.delay = VideoLogoOption(4)
+VideoLogoOption.enable = VideoLogoOption(0)
+VideoLogoOption.file = VideoLogoOption(1)
+VideoLogoOption.logo_x = VideoLogoOption(2)
+VideoLogoOption.logo_y = VideoLogoOption(3)
+VideoLogoOption.opacity = VideoLogoOption(6)
+VideoLogoOption.position = VideoLogoOption(7)
+VideoLogoOption.repeat = VideoLogoOption(5)
+
+class VideoAdjustOption(_Enum):
+ '''Option values for libvlc_video_{get,set}_adjust_{int,float,bool}.
+ '''
+ _enum_names_ = {
+ 0: 'Enable',
+ 1: 'Contrast',
+ 2: 'Brightness',
+ 3: 'Hue',
+ 4: 'Saturation',
+ 5: 'Gamma',
+ }
+VideoAdjustOption.Brightness = VideoAdjustOption(2)
+VideoAdjustOption.Contrast = VideoAdjustOption(1)
+VideoAdjustOption.Enable = VideoAdjustOption(0)
+VideoAdjustOption.Gamma = VideoAdjustOption(5)
+VideoAdjustOption.Hue = VideoAdjustOption(3)
+VideoAdjustOption.Saturation = VideoAdjustOption(4)
+
+class AudioOutputDeviceTypes(_Enum):
+ '''Audio device types.
+ '''
+ _enum_names_ = {
+ -1: 'Error',
+ 1: 'Mono',
+ 2: 'Stereo',
+ 4: '_2F2R',
+ 5: '_3F2R',
+ 6: '_5_1',
+ 7: '_6_1',
+ 8: '_7_1',
+ 10: 'SPDIF',
+ }
+AudioOutputDeviceTypes.Error = AudioOutputDeviceTypes(-1)
+AudioOutputDeviceTypes.Mono = AudioOutputDeviceTypes(1)
+AudioOutputDeviceTypes.SPDIF = AudioOutputDeviceTypes(10)
+AudioOutputDeviceTypes.Stereo = AudioOutputDeviceTypes(2)
+AudioOutputDeviceTypes._2F2R = AudioOutputDeviceTypes(4)
+AudioOutputDeviceTypes._3F2R = AudioOutputDeviceTypes(5)
+AudioOutputDeviceTypes._5_1 = AudioOutputDeviceTypes(6)
+AudioOutputDeviceTypes._6_1 = AudioOutputDeviceTypes(7)
+AudioOutputDeviceTypes._7_1 = AudioOutputDeviceTypes(8)
+
+class AudioOutputChannel(_Enum):
+ '''Audio channels.
+ '''
+ _enum_names_ = {
+ -1: 'Error',
+ 1: 'Stereo',
+ 2: 'RStereo',
+ 3: 'Left',
+ 4: 'Right',
+ 5: 'Dolbys',
+ }
+AudioOutputChannel.Dolbys = AudioOutputChannel(5)
+AudioOutputChannel.Error = AudioOutputChannel(-1)
+AudioOutputChannel.Left = AudioOutputChannel(3)
+AudioOutputChannel.RStereo = AudioOutputChannel(2)
+AudioOutputChannel.Right = AudioOutputChannel(4)
+AudioOutputChannel.Stereo = AudioOutputChannel(1)
+
+ # End of generated enum types #
+
+ # From libvlc_structures.h
+
+class AudioOutput(ctypes.Structure):
+
+ def __str__(self):
+ return '%s(%s:%s)' % (self.__class__.__name__, self.name, self.description)
+
+ def __repr__(self):
+ return '%s.%s' % (self.__class__.__module__, self.__str__())
+
+AudioOutput._fields_ = [ # recursive struct
+ ('name', ctypes.c_char_p),
+ ('description', ctypes.c_char_p),
+ ('next', ctypes.POINTER(AudioOutput)),
+ ]
+
+class LogMessage(ctypes.Structure):
+ _fields_ = [
+ ('size', ctypes.c_uint ),
+ ('severity', ctypes.c_int ),
+ ('type', ctypes.c_char_p),
+ ('name', ctypes.c_char_p),
+ ('header', ctypes.c_char_p),
+ ('message', ctypes.c_char_p),
+ ]
+
+ def __init__(self):
+ super(LogMessage, self).__init__()
+ self.size = ctypes.sizeof(self)
+
+ def __str__(self):
+ return '%s(%d:%s): %s' % (self.__class__.__name__, self.severity, self.type, self.message)
+
+ def __repr__(self):
+ return '%s.%s' % (self.__class__.__module__, self.__str__())
+
+class MediaEvent(ctypes.Structure):
+ _fields_ = [
+ ('media_name', ctypes.c_char_p),
+ ('instance_name', ctypes.c_char_p),
+ ]
+
+class MediaStats(ctypes.Structure):
+ _fields_ = [
+ ('read_bytes', ctypes.c_int ),
+ ('input_bitrate', ctypes.c_float),
+ ('demux_read_bytes', ctypes.c_int ),
+ ('demux_bitrate', ctypes.c_float),
+ ('demux_corrupted', ctypes.c_int ),
+ ('demux_discontinuity', ctypes.c_int ),
+ ('decoded_video', ctypes.c_int ),
+ ('decoded_audio', ctypes.c_int ),
+ ('displayed_pictures', ctypes.c_int ),
+ ('lost_pictures', ctypes.c_int ),
+ ('played_abuffers', ctypes.c_int ),
+ ('lost_abuffers', ctypes.c_int ),
+ ('sent_packets', ctypes.c_int ),
+ ('sent_bytes', ctypes.c_int ),
+ ('send_bitrate', ctypes.c_float),
+ ]
+
+ def __str__(self):
+ l = [' %s:\t%s' % (n, getattr(self, n)) for n, t in self._fields_]
+ return '\n'.join([self.__class__.__name__] + l)
+
+ def __repr__(self):
+ return '%s.%s' % (self.__class__.__module__, self.__str__())
+
+class MediaTrackInfo(ctypes.Structure):
+ _fields_ = [
+ ('codec', ctypes.c_uint32),
+ ('id', ctypes.c_int ),
+ ('type', TrackType ),
+ ('profile', ctypes.c_int ),
+ ('level', ctypes.c_int ),
+ ('channels_or_height', ctypes.c_uint ),
+ ('rate_or_width', ctypes.c_uint ),
+ ]
+
+ def __str__(self):
+ l = [" %s:\t%s" % (n, getattr(self, n)) for n, t in self._fields_]
+ return "\n".join([self.__class__.__name__] + l)
+
+ def __repr__(self):
+ return '%s.%s' % (self.__class__.__module__, self.__str__())
+
+class PlaylistItem(ctypes.Structure):
+ _fields_ = [
+ ('id', ctypes.c_int ),
+ ('uri', ctypes.c_char_p),
+ ('name', ctypes.c_char_p),
+ ]
+
+ def __str__(self):
+ return '%s #%d %s (uri %s)' % (self.__class__.__name__, self.id, self.name, self.uri)
+
+ def __repr__(self):
+ return '%s.%s' % (self.__class__.__module__, self.__str__())
+
+class Position(object):
+ """Enum-like, immutable window position constants.
+
+ See e.g. VideoMarqueeOption.Position.
+ """
+ Center = 0
+ Left = 1
+ CenterLeft = 1
+ Right = 2
+ CenterRight = 2
+ Top = 4
+ TopCenter = 4
+ TopLeft = 5
+ TopRight = 6
+ Bottom = 8
+ BottomCenter = 8
+ BottomLeft = 9
+ BottomRight = 10
+ def __init__(self, *unused):
+ raise TypeError('constants only')
+ def __setattr__(self, *unused): #PYCHOK expected
+ raise TypeError('immutable constants')
+
+class Rectangle(ctypes.Structure):
+ _fields_ = [
+ ('top', ctypes.c_int),
+ ('left', ctypes.c_int),
+ ('bottom', ctypes.c_int),
+ ('right', ctypes.c_int),
+ ]
+
+class TrackDescription(ctypes.Structure):
+
+ def __str__(self):
+ return '%s(%d:%s)' % (self.__class__.__name__, self.id, self.name)
+
+ def __repr__(self):
+ return '%s.%s' % (self.__class__.__module__, self.__str__())
+
+TrackDescription._fields_ = [ # recursive struct
+ ('id', ctypes.c_int ),
+ ('name', ctypes.c_char_p),
+ ('next', ctypes.POINTER(TrackDescription)),
+ ]
+
+def track_description_list(head):
+ """Convert a TrackDescription linked list to a Python list (and release the former).
+ """
+ r = []
+ if head:
+ item = head
+ while item:
+ item = item.contents
+ r.append((item.id, item.name))
+ item = item.next
+ libvlc_track_description_release(head)
+ return r
+
+class EventUnion(ctypes.Union):
+ _fields_ = [
+ ('meta_type', ctypes.c_uint ),
+ ('new_child', ctypes.c_uint ),
+ ('new_duration', ctypes.c_longlong),
+ ('new_status', ctypes.c_int ),
+ ('media', ctypes.c_void_p ),
+ ('new_state', ctypes.c_uint ),
+ # Media instance
+ ('new_position', ctypes.c_float ),
+ ('new_time', ctypes.c_longlong),
+ ('new_title', ctypes.c_int ),
+ ('new_seekable', ctypes.c_longlong),
+ ('new_pausable', ctypes.c_longlong),
+ # FIXME: Skipped MediaList and MediaListView...
+ ('filename', ctypes.c_char_p ),
+ ('new_length', ctypes.c_longlong),
+ ('media_event', MediaEvent ),
+ ]
+
+class Event(ctypes.Structure):
+ _fields_ = [
+ ('type', EventType ),
+ ('object', ctypes.c_void_p),
+ ('u', EventUnion ),
+ ]
+
+class ModuleDescription(ctypes.Structure):
+ def __str__(self):
+ return '%s %s (%s)' % (self.__class__.__name__, self.shortname, self.name)
+
+ModuleDescription._fields_ = [ # recursive struct
+ ('name', ctypes.c_char_p),
+ ('shortname', ctypes.c_char_p),
+ ('longname', ctypes.c_char_p),
+ ('help', ctypes.c_char_p),
+ ('next', ctypes.POINTER(ModuleDescription)),
+ ]
+
+def module_description_list(head):
+ """Convert a ModuleDescription linked list to a Python list (and release the former).
+ """
+ r = []
+ if head:
+ item = head
+ while item:
+ item = item.contents
+ r.append((item.name, item.shortname, item.longname, item.help))
+ item = item.next
+ libvlc_module_description_list_release(head)
+ return r
+
+ # End of header.py #
+
+class EventManager(_Ctype):
+ '''Create an event manager with callback handler.
+
+ This class interposes the registration and handling of
+ event notifications in order to (a) remove the need for
+ decorating each callback functions with the decorator
+ '@callbackmethod', (b) allow any number of positional
+ and/or keyword arguments to the callback (in addition
+ to the Event instance) and (c) to preserve the Python
+ objects such that the callback and argument objects
+ remain alive (i.e. are not garbage collected) until
+ B{after} the notification has been unregistered.
+
+ @note: Only a single notification can be registered
+ for each event type in an EventManager instance.
+
+ '''
+
+ _callback_handler = None
+ _callbacks = {}
+
+ def __new__(cls, ptr=_internal_guard):
+ if ptr == _internal_guard:
+ raise VLCException("(INTERNAL) ctypes class.\nYou should get a reference to EventManager through the MediaPlayer.event_manager() method.")
+ return _Constructor(cls, ptr)
+
+ def event_attach(self, eventtype, callback, *args, **kwds):
+ """Register an event notification.
+
+ @param eventtype: the desired event type to be notified about.
+ @param callback: the function to call when the event occurs.
+ @param args: optional positional arguments for the callback.
+ @param kwds: optional keyword arguments for the callback.
+ @return: 0 on success, ENOMEM on error.
+
+ @note: The callback function must have at least one argument,
+ an Event instance. Any other, optional positional and keyword
+ arguments are in B{addition} to the first one.
+ """
+ if not isinstance(eventtype, EventType):
+ raise VLCException("%s required: %r" % ('EventType', eventtype))
+ if not hasattr(callback, '__call__'): # callable()
+ raise VLCException("%s required: %r" % ('callable', callback))
+ # check that the callback expects arguments
+ if not any(getargspec(callback)[:2]): # list(...)
+ raise VLCException("%s required: %r" % ('argument', callback))
+
+ if self._callback_handler is None:
+ _called_from_ctypes = ctypes.CFUNCTYPE(None, ctypes.POINTER(Event), ctypes.c_void_p)
+ @_called_from_ctypes
+ def _callback_handler(event, k):
+ """(INTERNAL) handle callback call from ctypes.
+
+ @note: We cannot simply make this an EventManager
+ method since ctypes does not prepend self as the
+ first parameter, hence this closure.
+ """
+ try: # retrieve Python callback and arguments
+ call, args, kwds = self._callbacks[k]
+ # deref event.contents to simplify callback code
+ call(event.contents, *args, **kwds)
+ except KeyError: # detached?
+ pass
+ self._callback_handler = _callback_handler
+ self._callbacks = {}
+
+ k = eventtype.value
+ r = libvlc_event_attach(self, k, self._callback_handler, k)
+ if not r:
+ self._callbacks[k] = (callback, args, kwds)
+ return r
+
+ def event_detach(self, eventtype):
+ """Unregister an event notification.
+
+ @param eventtype: the event type notification to be removed.
+ """
+ if not isinstance(eventtype, EventType):
+ raise VLCException("%s required: %r" % ('EventType', eventtype))
+
+ k = eventtype.value
+ if k in self._callbacks:
+ del self._callbacks[k] # remove, regardless of libvlc return value
+ libvlc_event_detach(self, k, self._callback_handler, k)
+
+class Instance(_Ctype):
+ '''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)
+
+ '''
+
+ def __new__(cls, *args):
+ if len(args) == 1:
+ # Only 1 arg. It is either a C pointer, or an arg string,
+ # or a tuple.
+ i = args[0]
+ if isinstance(i, _Ints):
+ return _Constructor(cls, i)
+ elif isinstance(i, basestring):
+ args = i.strip().split()
+ elif isinstance(i, _Seqs):
+ args = i
+ else:
+ raise VLCException('Instance %r' % (args,))
+
+ if not args and plugin_path is not None:
+ # no parameters passed, for win32 and MacOS,
+ # specify the plugin_path if detected earlier
+ args = ['vlc', '--plugin-path=' + plugin_path]
+ return libvlc_new(len(args), args)
+
+ def media_player_new(self, uri=None):
+ """Create a new MediaPlayer instance.
+
+ @param uri: an optional URI to play in the player.
+ """
+ p = libvlc_media_player_new(self)
+ if uri:
+ p.set_media(self.media_new(uri))
+ p._instance = self
+ return p
+
+ def media_list_player_new(self):
+ """Create a new MediaListPlayer instance.
+ """
+ p = libvlc_media_list_player_new(self)
+ p._instance = self
+ return p
+
+ def media_new(self, mrl, *options):
+ """Create a new Media instance.
+
+ Options can be specified as supplementary string parameters, e.g.
+
+ C{m = i.media_new('foo.avi', 'sub-filter=marq{marquee=Hello}', 'vout-filter=invert')}
+
+ Alternatively, the options can be added to the media using the Media.add_options method:
+
+ C{m.add_options('foo.avi', 'sub-filter=marq@test{marquee=Hello}', 'video-filter=invert')}
+
+ @param options: optional media option=value strings
+ """
+ m = libvlc_media_new_location(self, mrl)
+ for o in options:
+ libvlc_media_add_option(m, o)
+ m._instance = self
+ return m
+
+ def media_list_new(self, mrls=None):
+ """Create a new MediaList instance.
+ @param mrls: optional list of MRL strings
+ """
+ l = libvlc_media_list_new(self)
+ # We should take the lock, but since we did not leak the
+ # reference, nobody else can access it.
+ if mrls:
+ for m in mrls:
+ l.add_media(m)
+ l._instance = self
+ return l
+
+ def audio_output_enumerate_devices(self):
+ """Enumerate the defined audio output devices.
+
+ @return: list of dicts {name:, description:, devices:}
+ """
+ r = []
+ head = libvlc_audio_output_list_get(self)
+ if head:
+ i = head
+ while i:
+ i = i.contents
+ d = [{'id': libvlc_audio_output_device_id (self, i.name, d),
+ 'longname': libvlc_audio_output_device_longname(self, i.name, d)}
+ for d in range(libvlc_audio_output_device_count (self, i.name))]
+ r.append({'name': i.name, 'description': i.description, 'devices': d})
+ i = i.next
+ libvlc_audio_output_list_release(head)
+ return r
+
+ def audio_filter_list_get(self):
+ """Returns a list of available audio filters.
+
+ """
+ return module_description_list(libvlc_audio_filter_list_get(self))
+
+ def video_filter_list_get(self):
+ """Returns a list of available video filters.
+
+ """
+ return module_description_list(libvlc_video_filter_list_get(self))
+
+
+ def release(self):
+ '''Decrement the reference count of a libvlc instance, and destroy it
+ if it reaches zero.
+ '''
+ return libvlc_release(self)
+
+ def retain(self):
+ '''Increments the reference count of a libvlc instance.
+ The initial reference count is 1 after L{new}() returns.
+ '''
+ return libvlc_retain(self)
+
+ def add_intf(self, name):
+ '''Try to start a user interface for the libvlc instance.
+ @param name: interface name, or NULL for default.
+ @return: 0 on success, -1 on error.
+ '''
+ return libvlc_add_intf(self, name)
+
+ def wait(self):
+ '''Waits until an interface causes the instance to exit.
+ You should start at least one interface first, using L{add_intf}().
+ '''
+ return libvlc_wait(self)
+
+ def set_user_agent(self, name, http):
+ '''Sets the application name. LibVLC passes this as the user agent string
+ when a protocol requires it.
+ @param name: human-readable application name, e.g. "FooBar player 1.2.3".
+ @param http: HTTP User Agent, e.g. "FooBar/1.2.3 Python/2.6.0".
+ @version: LibVLC 1.1.1 or later.
+ '''
+ return libvlc_set_user_agent(self, name, http)
+
+ def get_log_verbosity(self):
+ '''Always returns minus one.
+ This function is only provided for backward compatibility.
+ @return: always -1.
+ '''
+ return libvlc_get_log_verbosity(self)
+
+ def set_log_verbosity(self, level):
+ '''This function does nothing.
+ It is only provided for backward compatibility.
+ @param level: ignored.
+ '''
+ return libvlc_set_log_verbosity(self, level)
+
+ def log_open(self):
+ '''This function does nothing useful.
+ It is only provided for backward compatibility.
+ @return: an unique pointer or NULL on error.
+ '''
+ return libvlc_log_open(self)
+
+ def media_new_location(self, psz_mrl):
+ '''Create a media with a certain given media resource location,
+ for instance a valid URL.
+ @note: To refer to a local file with this function,
+ the file://... URI syntax B{must} be used (see IETF RFC3986).
+ We recommend using L{media_new_path}() instead when dealing with
+ local files.
+ See L{media_release}.
+ @param psz_mrl: the media location.
+ @return: the newly created media or NULL on error.
+ '''
+ return libvlc_media_new_location(self, psz_mrl)
+
+ def media_new_path(self, path):
+ '''Create a media for a certain file path.
+ See L{media_release}.
+ @param path: local filesystem path.
+ @return: the newly created media or NULL on error.
+ '''
+ return libvlc_media_new_path(self, path)
+
+ def media_new_fd(self, fd):
+ '''Create a media for an already open file descriptor.
+ The file descriptor shall be open for reading (or reading and writing).
+ Regular file descriptors, pipe read descriptors and character device
+ descriptors (including TTYs) are supported on all platforms.
+ Block device descriptors are supported where available.
+ Directory descriptors are supported on systems that provide fdopendir().
+ Sockets are supported on all platforms where they are file descriptors,
+ i.e. all except Windows.
+ @note: This library will B{not} automatically close the file descriptor
+ under any circumstance. Nevertheless, a file descriptor can usually only be
+ rendered once in a media player. To render it a second time, the file
+ descriptor should probably be rewound to the beginning with lseek().
+ See L{media_release}.
+ @param fd: open file descriptor.
+ @return: the newly created media or NULL on error.
+ @version: LibVLC 1.1.5 and later.
+ '''
+ return libvlc_media_new_fd(self, fd)
+
+ def media_new_as_node(self, psz_name):
+ '''Create a media as an empty node with a given name.
+ See L{media_release}.
+ @param psz_name: the name of the node.
+ @return: the new empty media or NULL on error.
+ '''
+ return libvlc_media_new_as_node(self, psz_name)
+
+ def media_discoverer_new_from_name(self, psz_name):
+ '''Discover media service by name.
+ @param psz_name: service name.
+ @return: media discover object or NULL in case of error.
+ '''
+ return libvlc_media_discoverer_new_from_name(self, psz_name)
+
+ def media_library_new(self):
+ '''Create an new Media Library object.
+ @return: a new object or NULL on error.
+ '''
+ return libvlc_media_library_new(self)
+
+ def audio_output_list_get(self):
+ '''Get the list of available audio outputs.
+ @return: list of available audio outputs. It must be freed it with In case of error, NULL is returned.
+ '''
+ return libvlc_audio_output_list_get(self)
+
+ def audio_output_device_count(self, psz_audio_output):
+ '''Get count of devices for audio output, these devices are hardware oriented
+ like analor or digital output of sound card.
+ @param psz_audio_output: - name of audio output, See L{AudioOutput}.
+ @return: number of devices.
+ '''
+ return libvlc_audio_output_device_count(self, psz_audio_output)
+
+ def audio_output_device_longname(self, psz_audio_output, i_device):
+ '''Get long name of device, if not available short name given.
+ @param psz_audio_output: - name of audio output, See L{AudioOutput}.
+ @param i_device: device index.
+ @return: long name of device.
+ '''
+ return libvlc_audio_output_device_longname(self, psz_audio_output, i_device)
+
+ def audio_output_device_id(self, psz_audio_output, i_device):
+ '''Get id name of device.
+ @param psz_audio_output: - name of audio output, See L{AudioOutput}.
+ @param i_device: device index.
+ @return: id name of device, use for setting device, need to be free after use.
+ '''
+ return libvlc_audio_output_device_id(self, psz_audio_output, i_device)
+
+ def vlm_release(self):
+ '''Release the vlm instance related to the given L{Instance}.
+ '''
+ return libvlc_vlm_release(self)
+
+ def vlm_add_broadcast(self, psz_name, psz_input, psz_output, i_options, ppsz_options, b_enabled, b_loop):
+ '''Add a broadcast, with one input.
+ @param psz_name: the name of the new broadcast.
+ @param psz_input: the input MRL.
+ @param psz_output: the output MRL (the parameter to the "sout" variable).
+ @param i_options: number of additional options.
+ @param ppsz_options: additional options.
+ @param b_enabled: boolean for enabling the new broadcast.
+ @param b_loop: Should this broadcast be played in loop ?
+ @return: 0 on success, -1 on error.
+ '''
+ return libvlc_vlm_add_broadcast(self, psz_name, psz_input, psz_output, i_options, ppsz_options, b_enabled, b_loop)
+
+ def vlm_add_vod(self, psz_name, psz_input, i_options, ppsz_options, b_enabled, psz_mux):
+ '''Add a vod, with one input.
+ @param psz_name: the name of the new vod media.
+ @param psz_input: the input MRL.
+ @param i_options: number of additional options.
+ @param ppsz_options: additional options.
+ @param b_enabled: boolean for enabling the new vod.
+ @param psz_mux: the muxer of the vod media.
+ @return: 0 on success, -1 on error.
+ '''
+ return libvlc_vlm_add_vod(self, psz_name, psz_input, i_options, ppsz_options, b_enabled, psz_mux)
+
+ def vlm_del_media(self, psz_name):
+ '''Delete a media (VOD or broadcast).
+ @param psz_name: the media to delete.
+ @return: 0 on success, -1 on error.
+ '''
+ return libvlc_vlm_del_media(self, psz_name)
+
+ def vlm_set_enabled(self, psz_name, b_enabled):
+ '''Enable or disable a media (VOD or broadcast).
+ @param psz_name: the media to work on.
+ @param b_enabled: the new status.
+ @return: 0 on success, -1 on error.
+ '''
+ return libvlc_vlm_set_enabled(self, psz_name, b_enabled)
+
+ def vlm_set_output(self, psz_name, psz_output):
+ '''Set the output for a media.
+ @param psz_name: the media to work on.
+ @param psz_output: the output MRL (the parameter to the "sout" variable).
+ @return: 0 on success, -1 on error.
+ '''
+ return libvlc_vlm_set_output(self, psz_name, psz_output)
+
+ def vlm_set_input(self, psz_name, psz_input):
+ '''Set a media's input MRL. This will delete all existing inputs and
+ add the specified one.
+ @param psz_name: the media to work on.
+ @param psz_input: the input MRL.
+ @return: 0 on success, -1 on error.
+ '''
+ return libvlc_vlm_set_input(self, psz_name, psz_input)
+
+ def vlm_add_input(self, psz_name, psz_input):
+ '''Add a media's input MRL. This will add the specified one.
+ @param psz_name: the media to work on.
+ @param psz_input: the input MRL.
+ @return: 0 on success, -1 on error.
+ '''
+ return libvlc_vlm_add_input(self, psz_name, psz_input)
+
+ def vlm_set_loop(self, psz_name, b_loop):
+ '''Set a media's loop status.
+ @param psz_name: the media to work on.
+ @param b_loop: the new status.
+ @return: 0 on success, -1 on error.
+ '''
+ return libvlc_vlm_set_loop(self, psz_name, b_loop)
+
+ def vlm_set_mux(self, psz_name, psz_mux):
+ '''Set a media's vod muxer.
+ @param psz_name: the media to work on.
+ @param psz_mux: the new muxer.
+ @return: 0 on success, -1 on error.
+ '''
+ return libvlc_vlm_set_mux(self, psz_name, psz_mux)
+
+ def vlm_change_media(self, psz_name, psz_input, psz_output, i_options, ppsz_options, b_enabled, b_loop):
+ '''Edit the parameters of a media. This will delete all existing inputs and
+ add the specified one.
+ @param psz_name: the name of the new broadcast.
+ @param psz_input: the input MRL.
+ @param psz_output: the output MRL (the parameter to the "sout" variable).
+ @param i_options: number of additional options.
+ @param ppsz_options: additional options.
+ @param b_enabled: boolean for enabling the new broadcast.
+ @param b_loop: Should this broadcast be played in loop ?
+ @return: 0 on success, -1 on error.
+ '''
+ return libvlc_vlm_change_media(self, psz_name, psz_input, psz_output, i_options, ppsz_options, b_enabled, b_loop)
+
+ def vlm_play_media(self, psz_name):
+ '''Play the named broadcast.
+ @param psz_name: the name of the broadcast.
+ @return: 0 on success, -1 on error.
+ '''
+ return libvlc_vlm_play_media(self, psz_name)
+
+ def vlm_stop_media(self, psz_name):
+ '''Stop the named broadcast.
+ @param psz_name: the name of the broadcast.
+ @return: 0 on success, -1 on error.
+ '''
+ return libvlc_vlm_stop_media(self, psz_name)
+
+ def vlm_pause_media(self, psz_name):
+ '''Pause the named broadcast.
+ @param psz_name: the name of the broadcast.
+ @return: 0 on success, -1 on error.
+ '''
+ return libvlc_vlm_pause_media(self, psz_name)
+
+ def vlm_seek_media(self, psz_name, f_percentage):
+ '''Seek in the named broadcast.
+ @param psz_name: the name of the broadcast.
+ @param f_percentage: the percentage to seek to.
+ @return: 0 on success, -1 on error.
+ '''
+ return libvlc_vlm_seek_media(self, psz_name, f_percentage)
+
+ def vlm_show_media(self, psz_name):
+ '''Return information about the named media as a JSON
+ string representation.
+ This function is mainly intended for debugging use,
+ if you want programmatic access to the state of
+ a vlm_media_instance_t, please use the corresponding
+ libvlc_vlm_get_media_instance_xxx -functions.
+ Currently there are no such functions available for
+ vlm_media_t though.
+ @param psz_name: the name of the media, if the name is an empty string, all media is described.
+ @return: string with information about named media, or NULL on error.
+ '''
+ return libvlc_vlm_show_media(self, psz_name)
+
+ def vlm_get_media_instance_position(self, psz_name, i_instance):
+ '''Get vlm_media instance position by name or instance id.
+ @param psz_name: name of vlm media instance.
+ @param i_instance: instance id.
+ @return: position as float or -1. on error.
+ '''
+ return libvlc_vlm_get_media_instance_position(self, psz_name, i_instance)
+
+ def vlm_get_media_instance_time(self, psz_name, i_instance):
+ '''Get vlm_media instance time by name or instance id.
+ @param psz_name: name of vlm media instance.
+ @param i_instance: instance id.
+ @return: time as integer or -1 on error.
+ '''
+ return libvlc_vlm_get_media_instance_time(self, psz_name, i_instance)
+
+ def vlm_get_media_instance_length(self, psz_name, i_instance):
+ '''Get vlm_media instance length by name or instance id.
+ @param psz_name: name of vlm media instance.
+ @param i_instance: instance id.
+ @return: length of media item or -1 on error.
+ '''
+ return libvlc_vlm_get_media_instance_length(self, psz_name, i_instance)
+
+ def vlm_get_media_instance_rate(self, psz_name, i_instance):
+ '''Get vlm_media instance playback rate by name or instance id.
+ @param psz_name: name of vlm media instance.
+ @param i_instance: instance id.
+ @return: playback rate or -1 on error.
+ '''
+ return libvlc_vlm_get_media_instance_rate(self, psz_name, i_instance)
+
+ def vlm_get_media_instance_title(self, psz_name, i_instance):
+ '''Get vlm_media instance title number by name or instance id.
+ @param psz_name: name of vlm media instance.
+ @param i_instance: instance id.
+ @return: title as number or -1 on error.
+ @bug: will always return 0.
+ '''
+ return libvlc_vlm_get_media_instance_title(self, psz_name, i_instance)
+
+ def vlm_get_media_instance_chapter(self, psz_name, i_instance):
+ '''Get vlm_media instance chapter number by name or instance id.
+ @param psz_name: name of vlm media instance.
+ @param i_instance: instance id.
+ @return: chapter as number or -1 on error.
+ @bug: will always return 0.
+ '''
+ return libvlc_vlm_get_media_instance_chapter(self, psz_name, i_instance)
+
+ def vlm_get_media_instance_seekable(self, psz_name, i_instance):
+ '''Is libvlc instance seekable ?
+ @param psz_name: name of vlm media instance.
+ @param i_instance: instance id.
+ @return: 1 if seekable, 0 if not, -1 if media does not exist.
+ @bug: will always return 0.
+ '''
+ return libvlc_vlm_get_media_instance_seekable(self, psz_name, i_instance)
+
+ def vlm_get_event_manager(self):
+ '''Get libvlc_event_manager from a vlm media.
+ The p_event_manager is immutable, so you don't have to hold the lock.
+ @return: libvlc_event_manager.
+ '''
+ return libvlc_vlm_get_event_manager(self)
+
+class Log(_Ctype):
+ '''Create a new VLC log instance.
+
+ '''
+
+ def __new__(cls, ptr=_internal_guard):
+ '''(INTERNAL) ctypes wrapper constructor.
+ '''
+ return _Constructor(cls, ptr)
+
+ def __iter__(self):
+ return self.get_iterator()
+
+ def dump(self):
+ return [ str(m) for m in self ]
+
+
+ def close(self):
+ '''Frees memory allocated by L{open}().
+ '''
+ return libvlc_log_close(self)
+
+ def count(self):
+ '''Always returns zero.
+ This function is only provided for backward compatibility.
+ @return: always zero.
+ '''
+ return libvlc_log_count(self)
+
+ def __len__(self):
+ return libvlc_log_count(self)
+
+ def clear(self):
+ '''This function does nothing.
+ It is only provided for backward compatibility.
+ '''
+ return libvlc_log_clear(self)
+
+ def get_iterator(self):
+ '''This function does nothing useful.
+ It is only provided for backward compatibility.
+ @return: an unique pointer or NULL on error or if the parameter was NULL.
+ '''
+ return libvlc_log_get_iterator(self)
+
+class LogIterator(_Ctype):
+ '''Create a new VLC log iterator.
+
+ '''
+
+ def __new__(cls, ptr=_internal_guard):
+ '''(INTERNAL) ctypes wrapper constructor.
+ '''
+ return _Constructor(cls, ptr)
+
+ def __iter__(self):
+ return self
+
+ def next(self):
+ if self.has_next():
+ b = LogMessage()
+ i = libvlc_log_iterator_next(self, b)
+ return i.contents
+ raise StopIteration
+
+
+ def free(self):
+ '''Frees memory allocated by L{log_get_iterator}().
+ '''
+ return libvlc_log_iterator_free(self)
+
+ def has_next(self):
+ '''Always returns zero.
+ This function is only provided for backward compatibility.
+ @return: always zero.
+ '''
+ return libvlc_log_iterator_has_next(self)
+
+class Media(_Ctype):
+ '''Create a new Media instance.
+
+ Usage: Media(MRL, *options)
+
+ See vlc.Instance.media_new documentation for details.
+
+ '''
+
+ def __new__(cls, *args):
+ if args:
+ i = args[0]
+ if isinstance(i, _Ints):
+ return _Constructor(cls, i)
+ if isinstance(i, Instance):
+ return i.media_new(*args[1:])
+
+ o = get_default_instance().media_new(*args)
+ return o
+
+ def get_instance(self):
+ return getattr(self, '_instance', None)
+
+ def add_options(self, *options):
+ """Add a list of options to the media.
+
+ Options must be written without the double-dash, e.g.:
+
+ C{m.add_options('sub-filter=marq@test{marquee=Hello}', 'video-filter=invert')}
+
+ Alternatively, the options can directly be passed in the Instance.media_new method:
+
+ C{m = instance.media_new('foo.avi', 'sub-filter=marq@test{marquee=Hello}', 'video-filter=invert')}
+
+ @param options: optional media option=value strings
+ """
+ for o in options:
+ self.add_option(o)
+
+
+ def add_option(self, ppsz_options):
+ '''Add an option to the media.
+ This option will be used to determine how the media_player will
+ read the media. This allows to use VLC's advanced
+ reading/streaming options on a per-media basis.
+ The options are detailed in vlc --long-help, for instance "--sout-all".
+ @param ppsz_options: the options (as a string).
+ '''
+ return libvlc_media_add_option(self, ppsz_options)
+
+ def add_option_flag(self, ppsz_options, i_flags):
+ '''Add an option to the media with configurable flags.
+ This option will be used to determine how the media_player will
+ read the media. This allows to use VLC's advanced
+ reading/streaming options on a per-media basis.
+ The options are detailed in vlc --long-help, for instance "--sout-all".
+ @param ppsz_options: the options (as a string).
+ @param i_flags: the flags for this option.
+ '''
+ return libvlc_media_add_option_flag(self, ppsz_options, i_flags)
+
+ def retain(self):
+ '''Retain a reference to a media descriptor object (libvlc_media_t). Use
+ L{release}() to decrement the reference count of a
+ media descriptor object.
+ '''
+ return libvlc_media_retain(self)
+
+ def release(self):
+ '''Decrement the reference count of a media descriptor object. If the
+ reference count is 0, then L{release}() will release the
+ media descriptor object. It will send out an libvlc_MediaFreed event
+ to all listeners. If the media descriptor object has been released it
+ should not be used again.
+ '''
+ return libvlc_media_release(self)
+
+ def get_mrl(self):
+ '''Get the media resource locator (mrl) from a media descriptor object.
+ @return: string with mrl of media descriptor object.
+ '''
+ return libvlc_media_get_mrl(self)
+
+ def duplicate(self):
+ '''Duplicate a media descriptor object.
+ '''
+ return libvlc_media_duplicate(self)
+
+ def get_meta(self, e_meta):
+ '''Read the meta of the media.
+ If the media has not yet been parsed this will return NULL.
+ This methods automatically calls L{parse_async}(), so after calling
+ it you may receive a libvlc_MediaMetaChanged event. If you prefer a synchronous
+ version ensure that you call L{parse}() before get_meta().
+ See L{parse}
+ See L{parse_async}
+ See libvlc_MediaMetaChanged.
+ @param e_meta: the meta to read.
+ @return: the media's meta.
+ '''
+ return libvlc_media_get_meta(self, e_meta)
+
+ def set_meta(self, e_meta, psz_value):
+ '''Set the meta of the media (this function will not save the meta, call
+ L{save_meta} in order to save the meta).
+ @param e_meta: the meta to write.
+ @param psz_value: the media's meta.
+ '''
+ return libvlc_media_set_meta(self, e_meta, psz_value)
+
+ def save_meta(self):
+ '''Save the meta previously set.
+ @return: true if the write operation was successfull.
+ '''
+ return libvlc_media_save_meta(self)
+
+ def get_state(self):
+ '''Get current state of media descriptor object. Possible media states
+ are defined in libvlc_structures.c ( libvlc_NothingSpecial=0,
+ libvlc_Opening, libvlc_Buffering, libvlc_Playing, libvlc_Paused,
+ libvlc_Stopped, libvlc_Ended,
+ libvlc_Error).
+ See libvlc_state_t.
+ @return: state of media descriptor object.
+ '''
+ return libvlc_media_get_state(self)
+
+ def get_stats(self, p_stats):
+ '''Get the current statistics about the media.
+ @param p_stats:: structure that contain the statistics about the media (this structure must be allocated by the caller).
+ @return: true if the statistics are available, false otherwise \libvlc_return_bool.
+ '''
+ return libvlc_media_get_stats(self, p_stats)
+
+ def event_manager(self):
+ '''Get event manager from media descriptor object.
+ NOTE: this function doesn't increment reference counting.
+ @return: event manager object.
+ '''
+ return libvlc_media_event_manager(self)
+
+ def get_duration(self):
+ '''Get duration (in ms) of media descriptor object item.
+ @return: duration of media item or -1 on error.
+ '''
+ return libvlc_media_get_duration(self)
+
+ def parse(self):
+ '''Parse a media.
+ This fetches (local) meta data and tracks information.
+ The method is synchronous.
+ See L{parse_async}
+ See L{get_meta}
+ See L{get_tracks_info}.
+ '''
+ return libvlc_media_parse(self)
+
+ def parse_async(self):
+ '''Parse a media.
+ This fetches (local) meta data and tracks information.
+ The method is the asynchronous of L{parse}().
+ To track when this is over you can listen to libvlc_MediaParsedChanged
+ event. However if the media was already parsed you will not receive this
+ event.
+ See L{parse}
+ See libvlc_MediaParsedChanged
+ See L{get_meta}
+ See L{get_tracks_info}.
+ '''
+ return libvlc_media_parse_async(self)
+
+ def is_parsed(self):
+ '''Get Parsed status for media descriptor object.
+ See libvlc_MediaParsedChanged.
+ @return: true if media object has been parsed otherwise it returns false \libvlc_return_bool.
+ '''
+ return libvlc_media_is_parsed(self)
+
+ def set_user_data(self, p_new_user_data):
+ '''Sets media descriptor's user_data. user_data is specialized data
+ accessed by the host application, VLC.framework uses it as a pointer to
+ an native object that references a L{Media} pointer.
+ @param p_new_user_data: pointer to user data.
+ '''
+ return libvlc_media_set_user_data(self, p_new_user_data)
+
+ def get_user_data(self):
+ '''Get media descriptor's user_data. user_data is specialized data
+ accessed by the host application, VLC.framework uses it as a pointer to
+ an native object that references a L{Media} pointer.
+ '''
+ return libvlc_media_get_user_data(self)
+
+ def get_tracks_info(self):
+ '''Get media descriptor's elementary streams description
+ Note, you need to call L{parse}() or play the media at least once
+ before calling this function.
+ Not doing this will result in an empty array.
+ @param tracks: address to store an allocated array of Elementary Streams descriptions (must be freed by the caller).
+ @return: the number of Elementary Streams.
+ '''
+ return libvlc_media_get_tracks_info(self)
+
+ def player_new_from_media(self):
+ '''Create a Media Player object from a Media.
+ @return: a new media player object, or NULL on error.
+ '''
+ return libvlc_media_player_new_from_media(self)
+
+class MediaDiscoverer(_Ctype):
+ '''N/A
+ '''
+
+ def __new__(cls, ptr=_internal_guard):
+ '''(INTERNAL) ctypes wrapper constructor.
+ '''
+ return _Constructor(cls, ptr)
+ def release(self):
+ '''Release media discover object. If the reference count reaches 0, then
+ the object will be released.
+ '''
+ return libvlc_media_discoverer_release(self)
+
+ def localized_name(self):
+ '''Get media service discover object its localized name.
+ @return: localized name.
+ '''
+ return libvlc_media_discoverer_localized_name(self)
+
+ def media_list(self):
+ '''Get media service discover media list.
+ @return: list of media items.
+ '''
+ return libvlc_media_discoverer_media_list(self)
+
+ def event_manager(self):
+ '''Get event manager from media service discover object.
+ @return: event manager object.
+ '''
+ return libvlc_media_discoverer_event_manager(self)
+
+ def is_running(self):
+ '''Query if media service discover object is running.
+ @return: true if running, false if not \libvlc_return_bool.
+ '''
+ return libvlc_media_discoverer_is_running(self)
+
+class MediaLibrary(_Ctype):
+ '''N/A
+ '''
+
+ def __new__(cls, ptr=_internal_guard):
+ '''(INTERNAL) ctypes wrapper constructor.
+ '''
+ return _Constructor(cls, ptr)
+ def release(self):
+ '''Release media library object. This functions decrements the
+ reference count of the media library object. If it reaches 0,
+ then the object will be released.
+ '''
+ return libvlc_media_library_release(self)
+
+ def retain(self):
+ '''Retain a reference to a media library object. This function will
+ increment the reference counting for this object. Use
+ L{release}() to decrement the reference count.
+ '''
+ return libvlc_media_library_retain(self)
+
+ def load(self):
+ '''Load media library.
+ @return: 0 on success, -1 on error.
+ '''
+ return libvlc_media_library_load(self)
+
+ def media_list(self):
+ '''Get media library subitems.
+ @return: media list subitems.
+ '''
+ return libvlc_media_library_media_list(self)
+
+class MediaList(_Ctype):
+ '''Create a new MediaList instance.
+
+ Usage: MediaList(list_of_MRLs)
+
+ See vlc.Instance.media_list_new documentation for details.
+
+ '''
+
+ def __new__(cls, *args):
+ if args:
+ i = args[0]
+ if isinstance(i, _Ints):
+ return _Constructor(cls, i)
+ if isinstance(i, Instance):
+ return i.media_list_new(*args[1:])
+
+ o = get_default_instance().media_list_new(*args)
+ return o
+
+ def get_instance(self):
+ return getattr(self, '_instance', None)
+
+ def add_media(self, mrl):
+ """Add media instance to media list.
+
+ The L{lock} should be held upon entering this function.
+ @param p_md: a media instance or a MRL.
+ @return: 0 on success, -1 if the media list is read-only.
+ """
+ if isinstance(mrl, basestring):
+ mrl = (self.get_instance() or get_default_instance()).media_new(mrl)
+ return libvlc_media_list_add_media(self, mrl)
+
+
+ def release(self):
+ '''Release media list created with L{new}().
+ '''
+ return libvlc_media_list_release(self)
+
+ def retain(self):
+ '''Retain reference to a media list.
+ '''
+ return libvlc_media_list_retain(self)
+
+ def set_media(self, p_md):
+ '''Associate media instance with this media list instance.
+ If another media instance was present it will be released.
+ The L{lock} should NOT be held upon entering this function.
+ @param p_md: media instance to add.
+ '''
+ return libvlc_media_list_set_media(self, p_md)
+
+ def media(self):
+ '''Get media instance from this media list instance. This action will increase
+ the refcount on the media instance.
+ The L{lock} should NOT be held upon entering this function.
+ @return: media instance.
+ '''
+ return libvlc_media_list_media(self)
+
+ def insert_media(self, p_md, i_pos):
+ '''Insert media instance in media list on a position
+ The L{lock} should be held upon entering this function.
+ @param p_md: a media instance.
+ @param i_pos: position in array where to insert.
+ @return: 0 on success, -1 if the media list is read-only.
+ '''
+ return libvlc_media_list_insert_media(self, p_md, i_pos)
+
+ def remove_index(self, i_pos):
+ '''Remove media instance from media list on a position
+ The L{lock} should be held upon entering this function.
+ @param i_pos: position in array where to insert.
+ @return: 0 on success, -1 if the list is read-only or the item was not found.
+ '''
+ return libvlc_media_list_remove_index(self, i_pos)
+
+ def count(self):
+ '''Get count on media list items
+ The L{lock} should be held upon entering this function.
+ @return: number of items in media list.
+ '''
+ return libvlc_media_list_count(self)
+
+ def __len__(self):
+ return libvlc_media_list_count(self)
+
+ def item_at_index(self, i_pos):
+ '''List media instance in media list at a position
+ The L{lock} should be held upon entering this function.
+ @param i_pos: position in array where to insert.
+ @return: media instance at position i_pos, or NULL if not found. In case of success, L{media_retain}() is called to increase the refcount on the media.
+ '''
+ return libvlc_media_list_item_at_index(self, i_pos)
+
+ def __getitem__(self, i):
+ return libvlc_media_list_item_at_index(self, i)
+
+ def __iter__(self):
+ for i in range(len(self)):
+ yield self[i]
+
+ def index_of_item(self, p_md):
+ '''Find index position of List media instance in media list.
+ Warning: the function will return the first matched position.
+ The L{lock} should be held upon entering this function.
+ @param p_md: media instance.
+ @return: position of media instance or -1 if media not found.
+ '''
+ return libvlc_media_list_index_of_item(self, p_md)
+
+ def is_readonly(self):
+ '''This indicates if this media list is read-only from a user point of view.
+ @return: 1 on readonly, 0 on readwrite \libvlc_return_bool.
+ '''
+ return libvlc_media_list_is_readonly(self)
+
+ def lock(self):
+ '''Get lock on media list items.
+ '''
+ return libvlc_media_list_lock(self)
+
+ def unlock(self):
+ '''Release lock on media list items
+ The L{lock} should be held upon entering this function.
+ '''
+ return libvlc_media_list_unlock(self)
+
+ def event_manager(self):
+ '''Get libvlc_event_manager from this media list instance.
+ The p_event_manager is immutable, so you don't have to hold the lock.
+ @return: libvlc_event_manager.
+ '''
+ return libvlc_media_list_event_manager(self)
+
+class MediaListPlayer(_Ctype):
+ '''Create a new MediaListPlayer instance.
+
+ It may take as parameter either:
+ - a vlc.Instance
+ - nothing
+
+ '''
+
+ def __new__(cls, arg=None):
+ if arg is None:
+ i = get_default_instance()
+ elif isinstance(arg, Instance):
+ i = arg
+ elif isinstance(arg, _Ints):
+ return _Constructor(cls, arg)
+ else:
+ raise TypeError('MediaListPlayer %r' % (arg,))
+
+ return i.media_list_player_new()
+
+ def get_instance(self):
+ """Return the associated Instance.
+ """
+ return self._instance #PYCHOK expected
+
+
+ def release(self):
+ '''Release a media_list_player after use
+ Decrement the reference count of a media player object. If the
+ reference count is 0, then L{release}() will
+ release the media player object. If the media player object
+ has been released, then it should not be used again.
+ '''
+ return libvlc_media_list_player_release(self)
+
+ def retain(self):
+ '''Retain a reference to a media player list object. Use
+ L{release}() to decrement reference count.
+ '''
+ return libvlc_media_list_player_retain(self)
+
+ def event_manager(self):
+ '''Return the event manager of this media_list_player.
+ @return: the event manager.
+ '''
+ return libvlc_media_list_player_event_manager(self)
+
+ def set_media_player(self, p_mi):
+ '''Replace media player in media_list_player with this instance.
+ @param p_mi: media player instance.
+ '''
+ return libvlc_media_list_player_set_media_player(self, p_mi)
+
+ def set_media_list(self, p_mlist):
+ '''Set the media list associated with the player.
+ @param p_mlist: list of media.
+ '''
+ return libvlc_media_list_player_set_media_list(self, p_mlist)
+
+ def play(self):
+ '''Play media list.
+ '''
+ return libvlc_media_list_player_play(self)
+
+ def pause(self):
+ '''Pause media list.
+ '''
+ return libvlc_media_list_player_pause(self)
+
+ def is_playing(self):
+ '''Is media list playing?
+ @return: true for playing and false for not playing \libvlc_return_bool.
+ '''
+ return libvlc_media_list_player_is_playing(self)
+
+ def get_state(self):
+ '''Get current libvlc_state of media list player.
+ @return: libvlc_state_t for media list player.
+ '''
+ return libvlc_media_list_player_get_state(self)
+
+ def play_item_at_index(self, i_index):
+ '''Play media list item at position index.
+ @param i_index: index in media list to play.
+ @return: 0 upon success -1 if the item wasn't found.
+ '''
+ return libvlc_media_list_player_play_item_at_index(self, i_index)
+
+ def __getitem__(self, i):
+ return libvlc_media_list_player_play_item_at_index(self, i)
+
+ def __iter__(self):
+ for i in range(len(self)):
+ yield self[i]
+
+ def play_item(self, p_md):
+ '''Play the given media item.
+ @param p_md: the media instance.
+ @return: 0 upon success, -1 if the media is not part of the media list.
+ '''
+ return libvlc_media_list_player_play_item(self, p_md)
+
+ def stop(self):
+ '''Stop playing media list.
+ '''
+ return libvlc_media_list_player_stop(self)
+
+ def next(self):
+ '''Play next item from media list.
+ @return: 0 upon success -1 if there is no next item.
+ '''
+ return libvlc_media_list_player_next(self)
+
+ def previous(self):
+ '''Play previous item from media list.
+ @return: 0 upon success -1 if there is no previous item.
+ '''
+ return libvlc_media_list_player_previous(self)
+
+ def set_playback_mode(self, e_mode):
+ '''Sets the playback mode for the playlist.
+ @param e_mode: playback mode specification.
+ '''
+ return libvlc_media_list_player_set_playback_mode(self, e_mode)
+
+class MediaPlayer(_Ctype):
+ '''Create a new MediaPlayer instance.
+
+ It may take as parameter either:
+ - a string (media URI), options... In this case, a vlc.Instance will be created.
+ - a vlc.Instance, a string (media URI), options...
+
+ '''
+
+ def __new__(cls, *args):
+ if len(args) == 1 and isinstance(args[0], _Ints):
+ return _Constructor(cls, args[0])
+
+ if args and isinstance(args[0], Instance):
+ instance = args[0]
+ args = args[1:]
+ else:
+ instance = get_default_instance()
+
+ o = instance.media_player_new()
+ if args:
+ o.set_media(instance.media_new(*args))
+ return o
+
+ def get_instance(self):
+ """Return the associated Instance.
+ """
+ return self._instance #PYCHOK expected
+
+ def set_mrl(self, mrl, *options):
+ """Set the MRL to play.
+
+ @param mrl: The MRL
+ @param options: optional media option=value strings
+ @return: the Media object
+ """
+ m = self.get_instance().media_new(mrl, *options)
+ self.set_media(m)
+ return m
+
+ def video_get_spu_description(self):
+ """Get the description of available video subtitles.
+ """
+ return track_description_list(libvlc_video_get_spu_description(self))
+
+ def video_get_title_description(self):
+ """Get the description of available titles.
+ """
+ return track_description_list(libvlc_video_get_title_description(self))
+
+ def video_get_chapter_description(self, title):
+ """Get the description of available chapters for specific title.
+
+ @param title: selected title (int)
+ """
+ return track_description_list(libvlc_video_get_chapter_description(self, title))
+
+ def video_get_track_description(self):
+ """Get the description of available video tracks.
+ """
+ return track_description_list(libvlc_video_get_track_description(self))
+
+ def audio_get_track_description(self):
+ """Get the description of available audio tracks.
+ """
+ return track_description_list(libvlc_audio_get_track_description(self))
+
+ def video_get_size(self, num=0):
+ """Get the video size in pixels as 2-tuple (width, height).
+
+ @param num: video number (default 0).
+ """
+ r = libvlc_video_get_size(self, num)
+ if isinstance(r, tuple) and len(r) == 2:
+ return r
+ else:
+ raise VLCException('invalid video number (%s)' % (num,))
+
+ def set_hwnd(self, drawable):
+ """Set a Win32/Win64 API window handle (HWND).
+
+ Specify where the media player should render its video
+ output. If LibVLC was built without Win32/Win64 API output
+ support, then this has no effects.
+
+ @param drawable: windows handle of the drawable.
+ """
+ if not isinstance(drawable, ctypes.c_void_p):
+ drawable = ctypes.c_void_p(int(drawable))
+ libvlc_media_player_set_hwnd(self, drawable)
+
+ def video_get_width(self, num=0):
+ """Get the width of a video in pixels.
+
+ @param num: video number (default 0).
+ """
+ return self.video_get_size(num)[0]
+
+ def video_get_height(self, num=0):
+ """Get the height of a video in pixels.
+
+ @param num: video number (default 0).
+ """
+ return self.video_get_size(num)[1]
+
+ def video_get_cursor(self, num=0):
+ """Get the mouse pointer coordinates over a video as 2-tuple (x, y).
+
+ Coordinates are expressed in terms of the decoded video resolution,
+ B{not} in terms of pixels on the screen/viewport. To get the
+ latter, you must query your windowing system directly.
+
+ Either coordinate may be negative or larger than the corresponding
+ size of the video, if the cursor is outside the rendering area.
+
+ @warning: The coordinates may be out-of-date if the pointer is not
+ located on the video rendering area. LibVLC does not track the
+ mouse pointer if the latter is outside the video widget.
+
+ @note: LibVLC does not support multiple mouse pointers (but does
+ support multiple input devices sharing the same pointer).
+
+ @param num: video number (default 0).
+ """
+ r = libvlc_video_get_cursor(self, num)
+ if isinstance(r, tuple) and len(r) == 2:
+ return r
+ raise VLCException('invalid video number (%s)' % (num,))
+
+
+ def release(self):
+ '''Release a media_player after use
+ Decrement the reference count of a media player object. If the
+ reference count is 0, then L{release}() will
+ release the media player object. If the media player object
+ has been released, then it should not be used again.
+ '''
+ return libvlc_media_player_release(self)
+
+ def retain(self):
+ '''Retain a reference to a media player object. Use
+ L{release}() to decrement reference count.
+ '''
+ return libvlc_media_player_retain(self)
+
+ def set_media(self, p_md):
+ '''Set the media that will be used by the media_player. If any,
+ previous md will be released.
+ @param p_md: the Media. Afterwards the p_md can be safely destroyed.
+ '''
+ return libvlc_media_player_set_media(self, p_md)
+
+ def get_media(self):
+ '''Get the media used by the media_player.
+ @return: the media associated with p_mi, or NULL if no media is associated.
+ '''
+ return libvlc_media_player_get_media(self)
+
+ def event_manager(self):
+ '''Get the Event Manager from which the media player send event.
+ @return: the event manager associated with p_mi.
+ '''
+ return libvlc_media_player_event_manager(self)
+
+ def is_playing(self):
+ '''is_playing.
+ @return: 1 if the media player is playing, 0 otherwise \libvlc_return_bool.
+ '''
+ return libvlc_media_player_is_playing(self)
+
+ def play(self):
+ '''Play.
+ @return: 0 if playback started (and was already started), or -1 on error.
+ '''
+ return libvlc_media_player_play(self)
+
+ def set_pause(self, do_pause):
+ '''Pause or resume (no effect if there is no media).
+ @param do_pause: play/resume if zero, pause if non-zero.
+ @version: LibVLC 1.1.1 or later.
+ '''
+ return libvlc_media_player_set_pause(self, do_pause)
+
+ def pause(self):
+ '''Toggle pause (no effect if there is no media).
+ '''
+ return libvlc_media_player_pause(self)
+
+ def stop(self):
+ '''Stop (no effect if there is no media).
+ '''
+ return libvlc_media_player_stop(self)
+
+ def video_set_format(self, chroma, width, height, pitch):
+ '''Set decoded video chroma and dimensions.
+ This only works in combination with libvlc_video_set_callbacks(),
+ and is mutually exclusive with libvlc_video_set_format_callbacks().
+ @param chroma: a four-characters string identifying the chroma (e.g. "RV32" or "YUYV").
+ @param width: pixel width.
+ @param height: pixel height.
+ @param pitch: line pitch (in bytes).
+ @version: LibVLC 1.1.1 or later.
+ @bug: All pixel planes are expected to have the same pitch. To use the YCbCr color space with chrominance subsampling, consider using libvlc_video_set_format_callbacks() instead.
+ '''
+ return libvlc_video_set_format(self, chroma, width, height, pitch)
+
+ def set_nsobject(self, drawable):
+ '''Set the NSView handler where the media player should render its video output.
+ Use the vout called "macosx".
+ The drawable is an NSObject that follow the VLCOpenGLVideoViewEmbedding
+ protocol:
+ @begincode
+ \@protocol VLCOpenGLVideoViewEmbedding <NSObject>
+ - (void)addVoutSubview:(NSView *)view;
+ - (void)removeVoutSubview:(NSView *)view;
+ \@end
+ @endcode
+ Or it can be an NSView object.
+ If you want to use it along with Qt4 see the QMacCocoaViewContainer. Then
+ the following code should work:
+ @begincode
+
+ NSView *video = [[NSView alloc] init];
+ QMacCocoaViewContainer *container = new QMacCocoaViewContainer(video, parent);
+ L{set_nsobject}(mp, video);
+ [video release];
+
+ @endcode
+ You can find a live example in VLCVideoView in VLCKit.framework.
+ @param drawable: the drawable that is either an NSView or an object following the VLCOpenGLVideoViewEmbedding protocol.
+ '''
+ return libvlc_media_player_set_nsobject(self, drawable)
+
+ def get_nsobject(self):
+ '''Get the NSView handler previously set with L{set_nsobject}().
+ @return: the NSView handler or 0 if none where set.
+ '''
+ return libvlc_media_player_get_nsobject(self)
+
+ def set_agl(self, drawable):
+ '''Set the agl handler where the media player should render its video output.
+ @param drawable: the agl handler.
+ '''
+ return libvlc_media_player_set_agl(self, drawable)
+
+ def get_agl(self):
+ '''Get the agl handler previously set with L{set_agl}().
+ @return: the agl handler or 0 if none where set.
+ '''
+ return libvlc_media_player_get_agl(self)
+
+ def set_xwindow(self, drawable):
+ '''Set an X Window System drawable where the media player should render its
+ video output. If LibVLC was built without X11 output support, then this has
+ no effects.
+ The specified identifier must correspond to an existing Input/Output class
+ X11 window. Pixmaps are B{not} supported. The caller shall ensure that
+ the X11 server is the same as the one the VLC instance has been configured
+ with. This function must be called before video playback is started;
+ otherwise it will only take effect after playback stop and restart.
+ @param drawable: the ID of the X window.
+ '''
+ return libvlc_media_player_set_xwindow(self, drawable)
+
+ def get_xwindow(self):
+ '''Get the X Window System window identifier previously set with
+ L{set_xwindow}(). Note that this will return the identifier
+ even if VLC is not currently using it (for instance if it is playing an
+ audio-only input).
+ @return: an X window ID, or 0 if none where set.
+ '''
+ return libvlc_media_player_get_xwindow(self)
+
+ def get_hwnd(self):
+ '''Get the Windows API window handle (HWND) previously set with
+ L{set_hwnd}(). The handle will be returned even if LibVLC
+ is not currently outputting any video to it.
+ @return: a window handle or NULL if there are none.
+ '''
+ return libvlc_media_player_get_hwnd(self)
+
+ def audio_set_format(self, format, rate, channels):
+ '''Set decoded audio format.
+ This only works in combination with libvlc_audio_set_callbacks(),
+ and is mutually exclusive with libvlc_audio_set_format_callbacks().
+ @param format: a four-characters string identifying the sample format (e.g. "S16N" or "FL32").
+ @param rate: sample rate (expressed in Hz).
+ @param channels: channels count.
+ @version: LibVLC 1.2.0 or later.
+ '''
+ return libvlc_audio_set_format(self, format, rate, channels)
+
+ def get_length(self):
+ '''Get the current movie length (in ms).
+ @return: the movie length (in ms), or -1 if there is no media.
+ '''
+ return libvlc_media_player_get_length(self)
+
+ def get_time(self):
+ '''Get the current movie time (in ms).
+ @return: the movie time (in ms), or -1 if there is no media.
+ '''
+ return libvlc_media_player_get_time(self)
+
+ def set_time(self, i_time):
+ '''Set the movie time (in ms). This has no effect if no media is being played.
+ Not all formats and protocols support this.
+ @param i_time: the movie time (in ms).
+ '''
+ return libvlc_media_player_set_time(self, i_time)
+
+ def get_position(self):
+ '''Get movie position.
+ @return: movie position, or -1. in case of error.
+ '''
+ return libvlc_media_player_get_position(self)
+
+ def set_position(self, f_pos):
+ '''Set movie position. This has no effect if playback is not enabled.
+ This might not work depending on the underlying input format and protocol.
+ @param f_pos: the position.
+ '''
+ return libvlc_media_player_set_position(self, f_pos)
+
+ def set_chapter(self, i_chapter):
+ '''Set movie chapter (if applicable).
+ @param i_chapter: chapter number to play.
+ '''
+ return libvlc_media_player_set_chapter(self, i_chapter)
+
+ def get_chapter(self):
+ '''Get movie chapter.
+ @return: chapter number currently playing, or -1 if there is no media.
+ '''
+ return libvlc_media_player_get_chapter(self)
+
+ def get_chapter_count(self):
+ '''Get movie chapter count.
+ @return: number of chapters in movie, or -1.
+ '''
+ return libvlc_media_player_get_chapter_count(self)
+
+ def will_play(self):
+ '''Is the player able to play.
+ @return: boolean \libvlc_return_bool.
+ '''
+ return libvlc_media_player_will_play(self)
+
+ def get_chapter_count_for_title(self, i_title):
+ '''Get title chapter count.
+ @param i_title: title.
+ @return: number of chapters in title, or -1.
+ '''
+ return libvlc_media_player_get_chapter_count_for_title(self, i_title)
+
+ def set_title(self, i_title):
+ '''Set movie title.
+ @param i_title: title number to play.
+ '''
+ return libvlc_media_player_set_title(self, i_title)
+
+ def get_title(self):
+ '''Get movie title.
+ @return: title number currently playing, or -1.
+ '''
+ return libvlc_media_player_get_title(self)
+
+ def get_title_count(self):
+ '''Get movie title count.
+ @return: title number count, or -1.
+ '''
+ return libvlc_media_player_get_title_count(self)
+
+ def previous_chapter(self):
+ '''Set previous chapter (if applicable).
+ '''
+ return libvlc_media_player_previous_chapter(self)
+
+ def next_chapter(self):
+ '''Set next chapter (if applicable).
+ '''
+ return libvlc_media_player_next_chapter(self)
+
+ def get_rate(self):
+ '''Get the requested movie play rate.
+ @warning: Depending on the underlying media, the requested rate may be
+ different from the real playback rate.
+ @return: movie play rate.
+ '''
+ return libvlc_media_player_get_rate(self)
+
+ def set_rate(self, rate):
+ '''Set movie play rate.
+ @param rate: movie play rate to set.
+ @return: -1 if an error was detected, 0 otherwise (but even then, it might not actually work depending on the underlying media protocol).
+ '''
+ return libvlc_media_player_set_rate(self, rate)
+
+ def get_state(self):
+ '''Get current movie state.
+ @return: the current state of the media player (playing, paused, ...) See libvlc_state_t.
+ '''
+ return libvlc_media_player_get_state(self)
+
+ def get_fps(self):
+ '''Get movie fps rate.
+ @return: frames per second (fps) for this playing movie, or 0 if unspecified.
+ '''
+ return libvlc_media_player_get_fps(self)
+
+ def has_vout(self):
+ '''How many video outputs does this media player have?
+ @return: the number of video outputs.
+ '''
+ return libvlc_media_player_has_vout(self)
+
+ def is_seekable(self):
+ '''Is this media player seekable?
+ @return: true if the media player can seek \libvlc_return_bool.
+ '''
+ return libvlc_media_player_is_seekable(self)
+
+ def can_pause(self):
+ '''Can this media player be paused?
+ @return: true if the media player can pause \libvlc_return_bool.
+ '''
+ return libvlc_media_player_can_pause(self)
+
+ def next_frame(self):
+ '''Display the next frame (if supported).
+ '''
+ return libvlc_media_player_next_frame(self)
+
+ def navigate(self, navigate):
+ '''Navigate through DVD Menu.
+ @param navigate: the Navigation mode.
+ @version: libVLC 1.2.0 or later.
+ '''
+ return libvlc_media_player_navigate(self, navigate)
+
+ def toggle_fullscreen(self):
+ '''Toggle fullscreen status on non-embedded video outputs.
+ @warning: The same limitations applies to this function
+ as to L{set_fullscreen}().
+ '''
+ return libvlc_toggle_fullscreen(self)
+
+ def set_fullscreen(self, b_fullscreen):
+ '''Enable or disable fullscreen.
+ @warning: With most window managers, only a top-level windows can be in
+ full-screen mode. Hence, this function will not operate properly if
+ L{set_xwindow}() was used to embed the video in a
+ non-top-level window. In that case, the embedding window must be reparented
+ to the root window B{before} fullscreen mode is enabled. You will want
+ to reparent it back to its normal parent when disabling fullscreen.
+ @param b_fullscreen: boolean for fullscreen status.
+ '''
+ return libvlc_set_fullscreen(self, b_fullscreen)
+
+ def get_fullscreen(self):
+ '''Get current fullscreen status.
+ @return: the fullscreen status (boolean) \libvlc_return_bool.
+ '''
+ return libvlc_get_fullscreen(self)
+
+ def video_set_key_input(self, on):
+ '''Enable or disable key press events handling, according to the LibVLC hotkeys
+ configuration. By default and for historical reasons, keyboard events are
+ handled by the LibVLC video widget.
+ @note: On X11, there can be only one subscriber for key press and mouse
+ click events per window. If your application has subscribed to those events
+ for the X window ID of the video widget, then LibVLC will not be able to
+ handle key presses and mouse clicks in any case.
+ @warning: This function is only implemented for X11 and Win32 at the moment.
+ @param on: true to handle key press events, false to ignore them.
+ '''
+ return libvlc_video_set_key_input(self, on)
+
+ def video_set_mouse_input(self, on):
+ '''Enable or disable mouse click events handling. By default, those events are
+ handled. This is needed for DVD menus to work, as well as a few video
+ filters such as "puzzle".
+ See L{video_set_key_input}().
+ @warning: This function is only implemented for X11 and Win32 at the moment.
+ @param on: true to handle mouse click events, false to ignore them.
+ '''
+ return libvlc_video_set_mouse_input(self, on)
+
+ def video_get_scale(self):
+ '''Get the current video scaling factor.
+ See also L{video_set_scale}().
+ @return: the currently configured zoom factor, or 0. if the video is set to fit to the output window/drawable automatically.
+ '''
+ return libvlc_video_get_scale(self)
+
+ def video_set_scale(self, f_factor):
+ '''Set the video scaling factor. That is the ratio of the number of pixels on
+ screen to the number of pixels in the original decoded video in each
+ dimension. Zero is a special value; it will adjust the video to the output
+ window/drawable (in windowed mode) or the entire screen.
+ Note that not all video outputs support scaling.
+ @param f_factor: the scaling factor, or zero.
+ '''
+ return libvlc_video_set_scale(self, f_factor)
+
+ def video_get_aspect_ratio(self):
+ '''Get current video aspect ratio.
+ @return: the video aspect ratio or NULL if unspecified (the result must be released with free() or L{free}()).
+ '''
+ return libvlc_video_get_aspect_ratio(self)
+
+ def video_set_aspect_ratio(self, psz_aspect):
+ '''Set new video aspect ratio.
+ @param psz_aspect: new video aspect-ratio or NULL to reset to default @note Invalid aspect ratios are ignored.
+ '''
+ return libvlc_video_set_aspect_ratio(self, psz_aspect)
+
+ def video_get_spu(self):
+ '''Get current video subtitle.
+ @return: the video subtitle selected, or -1 if none.
+ '''
+ return libvlc_video_get_spu(self)
+
+ def video_get_spu_count(self):
+ '''Get the number of available video subtitles.
+ @return: the number of available video subtitles.
+ '''
+ return libvlc_video_get_spu_count(self)
+
+ def video_set_spu(self, i_spu):
+ '''Set new video subtitle.
+ @param i_spu: new video subtitle to select.
+ @return: 0 on success, -1 if out of range.
+ '''
+ return libvlc_video_set_spu(self, i_spu)
+
+ def video_set_subtitle_file(self, psz_subtitle):
+ '''Set new video subtitle file.
+ @param psz_subtitle: new video subtitle file.
+ @return: the success status (boolean).
+ '''
+ return libvlc_video_set_subtitle_file(self, psz_subtitle)
+
+ def video_get_crop_geometry(self):
+ '''Get current crop filter geometry.
+ @return: the crop filter geometry or NULL if unset.
+ '''
+ return libvlc_video_get_crop_geometry(self)
+
+ def video_set_crop_geometry(self, psz_geometry):
+ '''Set new crop filter geometry.
+ @param psz_geometry: new crop filter geometry (NULL to unset).
+ '''
+ return libvlc_video_set_crop_geometry(self, psz_geometry)
+
+ def video_get_teletext(self):
+ '''Get current teletext page requested.
+ @return: the current teletext page requested.
+ '''
+ return libvlc_video_get_teletext(self)
+
+ def video_set_teletext(self, i_page):
+ '''Set new teletext page to retrieve.
+ @param i_page: teletex page number requested.
+ '''
+ return libvlc_video_set_teletext(self, i_page)
+
+ def toggle_teletext(self):
+ '''Toggle teletext transparent status on video output.
+ '''
+ return libvlc_toggle_teletext(self)
+
+ def video_get_track_count(self):
+ '''Get number of available video tracks.
+ @return: the number of available video tracks (int).
+ '''
+ return libvlc_video_get_track_count(self)
+
+ def video_get_track(self):
+ '''Get current video track.
+ @return: the video track (int) or -1 if none.
+ '''
+ return libvlc_video_get_track(self)
+
+ def video_set_track(self, i_track):
+ '''Set video track.
+ @param i_track: the track (int).
+ @return: 0 on success, -1 if out of range.
+ '''
+ return libvlc_video_set_track(self, i_track)
+
+ def video_take_snapshot(self, num, psz_filepath, i_width, i_height):
+ '''Take a snapshot of the current video window.
+ If i_width AND i_height is 0, original size is used.
+ If i_width XOR i_height is 0, original aspect-ratio is preserved.
+ @param num: number of video output (typically 0 for the first/only one).
+ @param psz_filepath: the path where to save the screenshot to.
+ @param i_width: the snapshot's width.
+ @param i_height: the snapshot's height.
+ @return: 0 on success, -1 if the video was not found.
+ '''
+ return libvlc_video_take_snapshot(self, num, psz_filepath, i_width, i_height)
+
+ def video_set_deinterlace(self, psz_mode):
+ '''Enable or disable deinterlace filter.
+ @param psz_mode: type of deinterlace filter, NULL to disable.
+ '''
+ return libvlc_video_set_deinterlace(self, psz_mode)
+
+ def video_get_marquee_int(self, option):
+ '''Get an integer marquee option value.
+ @param option: marq option to get See libvlc_video_marquee_int_option_t.
+ '''
+ return libvlc_video_get_marquee_int(self, option)
+
+ def video_get_marquee_string(self, option):
+ '''Get a string marquee option value.
+ @param option: marq option to get See libvlc_video_marquee_string_option_t.
+ '''
+ return libvlc_video_get_marquee_string(self, option)
+
+ def video_set_marquee_int(self, option, i_val):
+ '''Enable, disable or set an integer marquee option
+ Setting libvlc_marquee_Enable has the side effect of enabling (arg !0)
+ or disabling (arg 0) the marq filter.
+ @param option: marq option to set See libvlc_video_marquee_int_option_t.
+ @param i_val: marq option value.
+ '''
+ return libvlc_video_set_marquee_int(self, option, i_val)
+
+ def video_set_marquee_string(self, option, psz_text):
+ '''Set a marquee string option.
+ @param option: marq option to set See libvlc_video_marquee_string_option_t.
+ @param psz_text: marq option value.
+ '''
+ return libvlc_video_set_marquee_string(self, option, psz_text)
+
+ def video_get_logo_int(self, option):
+ '''Get integer logo option.
+ @param option: logo option to get, values of libvlc_video_logo_option_t.
+ '''
+ return libvlc_video_get_logo_int(self, option)
+
+ def video_set_logo_int(self, option, value):
+ '''Set logo option as integer. Options that take a different type value
+ are ignored.
+ Passing libvlc_logo_enable as option value has the side effect of
+ starting (arg !0) or stopping (arg 0) the logo filter.
+ @param option: logo option to set, values of libvlc_video_logo_option_t.
+ @param value: logo option value.
+ '''
+ return libvlc_video_set_logo_int(self, option, value)
+
+ def video_set_logo_string(self, option, psz_value):
+ '''Set logo option as string. Options that take a different type value
+ are ignored.
+ @param option: logo option to set, values of libvlc_video_logo_option_t.
+ @param psz_value: logo option value.
+ '''
+ return libvlc_video_set_logo_string(self, option, psz_value)
+
+ def video_get_adjust_int(self, option):
+ '''Get integer adjust option.
+ @param option: adjust option to get, values of libvlc_video_adjust_option_t.
+ @version: LibVLC 1.1.1 and later.
+ '''
+ return libvlc_video_get_adjust_int(self, option)
+
+ def video_set_adjust_int(self, option, value):
+ '''Set adjust option as integer. Options that take a different type value
+ are ignored.
+ Passing libvlc_adjust_enable as option value has the side effect of
+ starting (arg !0) or stopping (arg 0) the adjust filter.
+ @param option: adust option to set, values of libvlc_video_adjust_option_t.
+ @param value: adjust option value.
+ @version: LibVLC 1.1.1 and later.
+ '''
+ return libvlc_video_set_adjust_int(self, option, value)
+
+ def video_get_adjust_float(self, option):
+ '''Get float adjust option.
+ @param option: adjust option to get, values of libvlc_video_adjust_option_t.
+ @version: LibVLC 1.1.1 and later.
+ '''
+ return libvlc_video_get_adjust_float(self, option)
+
+ def video_set_adjust_float(self, option, value):
+ '''Set adjust option as float. Options that take a different type value
+ are ignored.
+ @param option: adust option to set, values of libvlc_video_adjust_option_t.
+ @param value: adjust option value.
+ @version: LibVLC 1.1.1 and later.
+ '''
+ return libvlc_video_set_adjust_float(self, option, value)
+
+ def audio_output_set(self, psz_name):
+ '''Set the audio output.
+ Change will be applied after stop and play.
+ @param psz_name: name of audio output, use psz_name of See L{AudioOutput}.
+ @return: 0 if function succeded, -1 on error.
+ '''
+ return libvlc_audio_output_set(self, psz_name)
+
+ def audio_output_device_set(self, psz_audio_output, psz_device_id):
+ '''Set audio output device. Changes are only effective after stop and play.
+ @param psz_audio_output: - name of audio output, See L{AudioOutput}.
+ @param psz_device_id: device.
+ '''
+ return libvlc_audio_output_device_set(self, psz_audio_output, psz_device_id)
+
+ def audio_output_get_device_type(self):
+ '''Get current audio device type. Device type describes something like
+ character of output sound - stereo sound, 2.1, 5.1 etc.
+ @return: the audio devices type See libvlc_audio_output_device_types_t.
+ '''
+ return libvlc_audio_output_get_device_type(self)
+
+ def audio_output_set_device_type(self, device_type):
+ '''Set current audio device type.
+ @param device_type: the audio device type,
+ '''
+ return libvlc_audio_output_set_device_type(self, device_type)
+
+ def audio_toggle_mute(self):
+ '''Toggle mute status.
+ '''
+ return libvlc_audio_toggle_mute(self)
+
+ def audio_get_mute(self):
+ '''Get current mute status.
+ @return: the mute status (boolean) \libvlc_return_bool.
+ '''
+ return libvlc_audio_get_mute(self)
+
+ def audio_set_mute(self, status):
+ '''Set mute status.
+ @param status: If status is true then mute, otherwise unmute.
+ '''
+ return libvlc_audio_set_mute(self, status)
+
+ def audio_get_volume(self):
+ '''Get current software audio volume.
+ @return: the software volume in percents (0 = mute, 100 = nominal / 0dB).
+ '''
+ return libvlc_audio_get_volume(self)
+
+ def audio_set_volume(self, i_volume):
+ '''Set current software audio volume.
+ @param i_volume: the volume in percents (0 = mute, 100 = 0dB).
+ @return: 0 if the volume was set, -1 if it was out of range.
+ '''
+ return libvlc_audio_set_volume(self, i_volume)
+
+ def audio_get_track_count(self):
+ '''Get number of available audio tracks.
+ @return: the number of available audio tracks (int), or -1 if unavailable.
+ '''
+ return libvlc_audio_get_track_count(self)
+
+ def audio_get_track(self):
+ '''Get current audio track.
+ @return: the audio track (int), or -1 if none.
+ '''
+ return libvlc_audio_get_track(self)
+
+ def audio_set_track(self, i_track):
+ '''Set current audio track.
+ @param i_track: the track (int).
+ @return: 0 on success, -1 on error.
+ '''
+ return libvlc_audio_set_track(self, i_track)
+
+ def audio_get_channel(self):
+ '''Get current audio channel.
+ @return: the audio channel See libvlc_audio_output_channel_t.
+ '''
+ return libvlc_audio_get_channel(self)
+
+ def audio_set_channel(self, channel):
+ '''Set current audio channel.
+ @param channel: the audio channel, See libvlc_audio_output_channel_t.
+ @return: 0 on success, -1 on error.
+ '''
+ return libvlc_audio_set_channel(self, channel)
+
+ def audio_get_delay(self):
+ '''Get current audio delay.
+ @return: the audio delay (microseconds).
+ @version: LibVLC 1.1.1 or later.
+ '''
+ return libvlc_audio_get_delay(self)
+
+ def audio_set_delay(self, i_delay):
+ '''Set current audio delay. The audio delay will be reset to zero each time the media changes.
+ @param i_delay: the audio delay (microseconds).
+ @return: 0 on success, -1 on error.
+ @version: LibVLC 1.1.1 or later.
+ '''
+ return libvlc_audio_set_delay(self, i_delay)
+
+
+ # LibVLC __version__ functions #
+
+def libvlc_errmsg():
+ '''A human-readable error message for the last LibVLC error in the calling
+ thread. The resulting string is valid until another error occurs (at least
+ until the next LibVLC call).
+ @warning
+ This will be NULL if there was no error.
+ '''
+ f = _Cfunctions.get('libvlc_errmsg', None) or \
+ _Cfunction('libvlc_errmsg', (), None,
+ ctypes.c_char_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_errmsg
+ libvlc_errmsg = f
+ return f()
+
+def libvlc_clearerr():
+ '''Clears the LibVLC error status for the current thread. This is optional.
+ By default, the error status is automatically overridden when a new error
+ occurs, and destroyed when the thread exits.
+ '''
+ f = _Cfunctions.get('libvlc_clearerr', None) or \
+ _Cfunction('libvlc_clearerr', (), None,
+ None)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_clearerr
+ libvlc_clearerr = f
+ return f()
+
+def libvlc_new(argc, argv):
+ '''Create and initialize a libvlc instance.
+ This functions accept a list of "command line" arguments similar to the
+ main(). These arguments affect the LibVLC instance default configuration.
+ @param argc: the number of arguments (should be 0).
+ @param argv: list of arguments (should be NULL).
+ @return: the libvlc instance or NULL in case of error.
+ @version Arguments are meant to be passed from the command line to LibVLC, just like VLC media player does. The list of valid arguments depends on the LibVLC version, the operating system and platform, and set of available LibVLC plugins. Invalid or unsupported arguments will cause the function to fail (i.e. return NULL). Also, some arguments may alter the behaviour or otherwise interfere with other LibVLC functions. @warning There is absolutely no warranty or promise of forward, backward and cross-platform compatibility with regards to L{libvlc_new}() arguments. We recommend that you do not use them, other than when debugging.
+ '''
+ f = _Cfunctions.get('libvlc_new', None) or \
+ _Cfunction('libvlc_new', ((1,), (1,),), class_result(Instance),
+ ctypes.c_void_p, ctypes.c_int, ListPOINTER(ctypes.c_char_p))
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_new
+ libvlc_new = f
+ return f(argc, argv)
+
+def libvlc_release(p_instance):
+ '''Decrement the reference count of a libvlc instance, and destroy it
+ if it reaches zero.
+ @param p_instance: the instance to destroy.
+ '''
+ f = _Cfunctions.get('libvlc_release', None) or \
+ _Cfunction('libvlc_release', ((1,),), None,
+ None, Instance)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_release
+ libvlc_release = f
+ return f(p_instance)
+
+def libvlc_retain(p_instance):
+ '''Increments the reference count of a libvlc instance.
+ The initial reference count is 1 after L{libvlc_new}() returns.
+ @param p_instance: the instance to reference.
+ '''
+ f = _Cfunctions.get('libvlc_retain', None) or \
+ _Cfunction('libvlc_retain', ((1,),), None,
+ None, Instance)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_retain
+ libvlc_retain = f
+ return f(p_instance)
+
+def libvlc_add_intf(p_instance, name):
+ '''Try to start a user interface for the libvlc instance.
+ @param p_instance: the instance.
+ @param name: interface name, or NULL for default.
+ @return: 0 on success, -1 on error.
+ '''
+ f = _Cfunctions.get('libvlc_add_intf', None) or \
+ _Cfunction('libvlc_add_intf', ((1,), (1,),), None,
+ ctypes.c_int, Instance, ctypes.c_char_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_add_intf
+ libvlc_add_intf = f
+ return f(p_instance, name)
+
+def libvlc_wait(p_instance):
+ '''Waits until an interface causes the instance to exit.
+ You should start at least one interface first, using L{libvlc_add_intf}().
+ @param p_instance: the instance.
+ '''
+ f = _Cfunctions.get('libvlc_wait', None) or \
+ _Cfunction('libvlc_wait', ((1,),), None,
+ None, Instance)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_wait
+ libvlc_wait = f
+ return f(p_instance)
+
+def libvlc_set_user_agent(p_instance, name, http):
+ '''Sets the application name. LibVLC passes this as the user agent string
+ when a protocol requires it.
+ @param p_instance: LibVLC instance.
+ @param name: human-readable application name, e.g. "FooBar player 1.2.3".
+ @param http: HTTP User Agent, e.g. "FooBar/1.2.3 Python/2.6.0".
+ @version: LibVLC 1.1.1 or later.
+ '''
+ f = _Cfunctions.get('libvlc_set_user_agent', None) or \
+ _Cfunction('libvlc_set_user_agent', ((1,), (1,), (1,),), None,
+ None, Instance, ctypes.c_char_p, ctypes.c_char_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_set_user_agent
+ libvlc_set_user_agent = f
+ return f(p_instance, name, http)
+
+def libvlc_get_version():
+ '''Retrieve libvlc version.
+ Example: "1.1.0-git The Luggage".
+ @return: a string containing the libvlc version.
+ '''
+ f = _Cfunctions.get('libvlc_get_version', None) or \
+ _Cfunction('libvlc_get_version', (), None,
+ ctypes.c_char_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_get_version
+ libvlc_get_version = f
+ return f()
+
+def libvlc_get_compiler():
+ '''Retrieve libvlc compiler version.
+ Example: "gcc version 4.2.3 (Ubuntu 4.2.3-2ubuntu6)".
+ @return: a string containing the libvlc compiler version.
+ '''
+ f = _Cfunctions.get('libvlc_get_compiler', None) or \
+ _Cfunction('libvlc_get_compiler', (), None,
+ ctypes.c_char_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_get_compiler
+ libvlc_get_compiler = f
+ return f()
+
+def libvlc_get_changeset():
+ '''Retrieve libvlc changeset.
+ Example: "aa9bce0bc4".
+ @return: a string containing the libvlc changeset.
+ '''
+ f = _Cfunctions.get('libvlc_get_changeset', None) or \
+ _Cfunction('libvlc_get_changeset', (), None,
+ ctypes.c_char_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_get_changeset
+ libvlc_get_changeset = f
+ return f()
+
+def libvlc_free(ptr):
+ '''Frees an heap allocation returned by a LibVLC function.
+ If you know you're using the same underlying C run-time as the LibVLC
+ implementation, then you can call ANSI C free() directly instead.
+ @param ptr: the pointer.
+ '''
+ f = _Cfunctions.get('libvlc_free', None) or \
+ _Cfunction('libvlc_free', ((1,),), None,
+ None, ctypes.c_void_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_free
+ libvlc_free = f
+ return f(ptr)
+
+def libvlc_event_attach(p_event_manager, i_event_type, f_callback, user_data):
+ '''Register for an event notification.
+ @param p_event_manager: the event manager to which you want to attach to. Generally it is obtained by vlc_my_object_event_manager() where my_object is the object you want to listen to.
+ @param i_event_type: the desired event to which we want to listen.
+ @param f_callback: the function to call when i_event_type occurs.
+ @param user_data: user provided data to carry with the event.
+ @return: 0 on success, ENOMEM on error.
+ '''
+ f = _Cfunctions.get('libvlc_event_attach', None) or \
+ _Cfunction('libvlc_event_attach', ((1,), (1,), (1,), (1,),), None,
+ ctypes.c_int, EventManager, ctypes.c_uint, ctypes.c_void_p, ctypes.c_void_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_event_attach
+ libvlc_event_attach = f
+ return f(p_event_manager, i_event_type, f_callback, user_data)
+
+def libvlc_event_detach(p_event_manager, i_event_type, f_callback, p_user_data):
+ '''Unregister an event notification.
+ @param p_event_manager: the event manager.
+ @param i_event_type: the desired event to which we want to unregister.
+ @param f_callback: the function to call when i_event_type occurs.
+ @param p_user_data: user provided data to carry with the event.
+ '''
+ f = _Cfunctions.get('libvlc_event_detach', None) or \
+ _Cfunction('libvlc_event_detach', ((1,), (1,), (1,), (1,),), None,
+ None, EventManager, ctypes.c_uint, ctypes.c_void_p, ctypes.c_void_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_event_detach
+ libvlc_event_detach = f
+ return f(p_event_manager, i_event_type, f_callback, p_user_data)
+
+def libvlc_event_type_name(event_type):
+ '''Get an event's type name.
+ @param event_type: the desired event.
+ '''
+ f = _Cfunctions.get('libvlc_event_type_name', None) or \
+ _Cfunction('libvlc_event_type_name', ((1,),), None,
+ ctypes.c_char_p, ctypes.c_uint)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_event_type_name
+ libvlc_event_type_name = f
+ return f(event_type)
+
+def libvlc_get_log_verbosity(p_instance):
+ '''Always returns minus one.
+ This function is only provided for backward compatibility.
+ @param p_instance: ignored.
+ @return: always -1.
+ '''
+ f = _Cfunctions.get('libvlc_get_log_verbosity', None) or \
+ _Cfunction('libvlc_get_log_verbosity', ((1,),), None,
+ ctypes.c_uint, Instance)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_get_log_verbosity
+ libvlc_get_log_verbosity = f
+ return f(p_instance)
+
+def libvlc_set_log_verbosity(p_instance, level):
+ '''This function does nothing.
+ It is only provided for backward compatibility.
+ @param p_instance: ignored.
+ @param level: ignored.
+ '''
+ f = _Cfunctions.get('libvlc_set_log_verbosity', None) or \
+ _Cfunction('libvlc_set_log_verbosity', ((1,), (1,),), None,
+ None, Instance, ctypes.c_uint)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_set_log_verbosity
+ libvlc_set_log_verbosity = f
+ return f(p_instance, level)
+
+def libvlc_log_open(p_instance):
+ '''This function does nothing useful.
+ It is only provided for backward compatibility.
+ @param p_instance: libvlc instance.
+ @return: an unique pointer or NULL on error.
+ '''
+ f = _Cfunctions.get('libvlc_log_open', None) or \
+ _Cfunction('libvlc_log_open', ((1,),), class_result(Log),
+ ctypes.c_void_p, Instance)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_log_open
+ libvlc_log_open = f
+ return f(p_instance)
+
+def libvlc_log_close(p_log):
+ '''Frees memory allocated by L{libvlc_log_open}().
+ @param p_log: libvlc log instance or NULL.
+ '''
+ f = _Cfunctions.get('libvlc_log_close', None) or \
+ _Cfunction('libvlc_log_close', ((1,),), None,
+ None, Log)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_log_close
+ libvlc_log_close = f
+ return f(p_log)
+
+def libvlc_log_count(p_log):
+ '''Always returns zero.
+ This function is only provided for backward compatibility.
+ @param p_log: ignored.
+ @return: always zero.
+ '''
+ f = _Cfunctions.get('libvlc_log_count', None) or \
+ _Cfunction('libvlc_log_count', ((1,),), None,
+ ctypes.c_uint, Log)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_log_count
+ libvlc_log_count = f
+ return f(p_log)
+
+def libvlc_log_clear(p_log):
+ '''This function does nothing.
+ It is only provided for backward compatibility.
+ @param p_log: ignored.
+ '''
+ f = _Cfunctions.get('libvlc_log_clear', None) or \
+ _Cfunction('libvlc_log_clear', ((1,),), None,
+ None, Log)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_log_clear
+ libvlc_log_clear = f
+ return f(p_log)
+
+def libvlc_log_get_iterator(p_log):
+ '''This function does nothing useful.
+ It is only provided for backward compatibility.
+ @param p_log: ignored.
+ @return: an unique pointer or NULL on error or if the parameter was NULL.
+ '''
+ f = _Cfunctions.get('libvlc_log_get_iterator', None) or \
+ _Cfunction('libvlc_log_get_iterator', ((1,),), class_result(LogIterator),
+ ctypes.c_void_p, Log)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_log_get_iterator
+ libvlc_log_get_iterator = f
+ return f(p_log)
+
+def libvlc_log_iterator_free(p_iter):
+ '''Frees memory allocated by L{libvlc_log_get_iterator}().
+ @param p_iter: libvlc log iterator or NULL.
+ '''
+ f = _Cfunctions.get('libvlc_log_iterator_free', None) or \
+ _Cfunction('libvlc_log_iterator_free', ((1,),), None,
+ None, LogIterator)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_log_iterator_free
+ libvlc_log_iterator_free = f
+ return f(p_iter)
+
+def libvlc_log_iterator_has_next(p_iter):
+ '''Always returns zero.
+ This function is only provided for backward compatibility.
+ @param p_iter: ignored.
+ @return: always zero.
+ '''
+ f = _Cfunctions.get('libvlc_log_iterator_has_next', None) or \
+ _Cfunction('libvlc_log_iterator_has_next', ((1,),), None,
+ ctypes.c_int, LogIterator)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_log_iterator_has_next
+ libvlc_log_iterator_has_next = f
+ return f(p_iter)
+
+def libvlc_log_iterator_next(p_iter, p_buffer):
+ '''Always returns NULL.
+ This function is only provided for backward compatibility.
+ @param p_iter: libvlc log iterator or NULL.
+ @param p_buffer: ignored.
+ @return: always NULL.
+ '''
+ f = _Cfunctions.get('libvlc_log_iterator_next', None) or \
+ _Cfunction('libvlc_log_iterator_next', ((1,), (1,),), None,
+ ctypes.POINTER(LogMessage), LogIterator, ctypes.POINTER(LogMessage))
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_log_iterator_next
+ libvlc_log_iterator_next = f
+ return f(p_iter, p_buffer)
+
+def libvlc_module_description_list_release(p_list):
+ '''Release a list of module descriptions.
+ @param p_list: the list to be released.
+ '''
+ f = _Cfunctions.get('libvlc_module_description_list_release', None) or \
+ _Cfunction('libvlc_module_description_list_release', ((1,),), None,
+ None, ctypes.POINTER(ModuleDescription))
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_module_description_list_release
+ libvlc_module_description_list_release = f
+ return f(p_list)
+
+def libvlc_audio_filter_list_get(p_instance):
+ '''Returns a list of audio filters that are available.
+ @param p_instance: libvlc instance.
+ @return: a list of module descriptions. It should be freed with L{libvlc_module_description_list_release}(). In case of an error, NULL is returned. See L{ModuleDescription} See L{libvlc_module_description_list_release}.
+ '''
+ f = _Cfunctions.get('libvlc_audio_filter_list_get', None) or \
+ _Cfunction('libvlc_audio_filter_list_get', ((1,),), None,
+ ctypes.POINTER(ModuleDescription), Instance)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_audio_filter_list_get
+ libvlc_audio_filter_list_get = f
+ return f(p_instance)
+
+def libvlc_video_filter_list_get(p_instance):
+ '''Returns a list of video filters that are available.
+ @param p_instance: libvlc instance.
+ @return: a list of module descriptions. It should be freed with L{libvlc_module_description_list_release}(). In case of an error, NULL is returned. See L{ModuleDescription} See L{libvlc_module_description_list_release}.
+ '''
+ f = _Cfunctions.get('libvlc_video_filter_list_get', None) or \
+ _Cfunction('libvlc_video_filter_list_get', ((1,),), None,
+ ctypes.POINTER(ModuleDescription), Instance)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_filter_list_get
+ libvlc_video_filter_list_get = f
+ return f(p_instance)
+
+def libvlc_clock():
+ '''Return the current time as defined by LibVLC. The unit is the microsecond.
+ Time increases monotonically (regardless of time zone changes and RTC
+ adjustements).
+ The origin is arbitrary but consistent across the whole system
+ (e.g. the system uptim, the time since the system was booted).
+ @note: On systems that support it, the POSIX monotonic clock is used.
+ '''
+ f = _Cfunctions.get('libvlc_clock', None) or \
+ _Cfunction('libvlc_clock', (), None,
+ ctypes.c_int64)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_clock
+ libvlc_clock = f
+ return f()
+
+def libvlc_media_new_location(p_instance, psz_mrl):
+ '''Create a media with a certain given media resource location,
+ for instance a valid URL.
+ @note: To refer to a local file with this function,
+ the file://... URI syntax B{must} be used (see IETF RFC3986).
+ We recommend using L{libvlc_media_new_path}() instead when dealing with
+ local files.
+ See L{libvlc_media_release}.
+ @param p_instance: the instance.
+ @param psz_mrl: the media location.
+ @return: the newly created media or NULL on error.
+ '''
+ f = _Cfunctions.get('libvlc_media_new_location', None) or \
+ _Cfunction('libvlc_media_new_location', ((1,), (1,),), class_result(Media),
+ ctypes.c_void_p, Instance, ctypes.c_char_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_new_location
+ libvlc_media_new_location = f
+ return f(p_instance, psz_mrl)
+
+def libvlc_media_new_path(p_instance, path):
+ '''Create a media for a certain file path.
+ See L{libvlc_media_release}.
+ @param p_instance: the instance.
+ @param path: local filesystem path.
+ @return: the newly created media or NULL on error.
+ '''
+ f = _Cfunctions.get('libvlc_media_new_path', None) or \
+ _Cfunction('libvlc_media_new_path', ((1,), (1,),), class_result(Media),
+ ctypes.c_void_p, Instance, ctypes.c_char_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_new_path
+ libvlc_media_new_path = f
+ return f(p_instance, path)
+
+def libvlc_media_new_fd(p_instance, fd):
+ '''Create a media for an already open file descriptor.
+ The file descriptor shall be open for reading (or reading and writing).
+ Regular file descriptors, pipe read descriptors and character device
+ descriptors (including TTYs) are supported on all platforms.
+ Block device descriptors are supported where available.
+ Directory descriptors are supported on systems that provide fdopendir().
+ Sockets are supported on all platforms where they are file descriptors,
+ i.e. all except Windows.
+ @note: This library will B{not} automatically close the file descriptor
+ under any circumstance. Nevertheless, a file descriptor can usually only be
+ rendered once in a media player. To render it a second time, the file
+ descriptor should probably be rewound to the beginning with lseek().
+ See L{libvlc_media_release}.
+ @param p_instance: the instance.
+ @param fd: open file descriptor.
+ @return: the newly created media or NULL on error.
+ @version: LibVLC 1.1.5 and later.
+ '''
+ f = _Cfunctions.get('libvlc_media_new_fd', None) or \
+ _Cfunction('libvlc_media_new_fd', ((1,), (1,),), class_result(Media),
+ ctypes.c_void_p, Instance, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_new_fd
+ libvlc_media_new_fd = f
+ return f(p_instance, fd)
+
+def libvlc_media_new_as_node(p_instance, psz_name):
+ '''Create a media as an empty node with a given name.
+ See L{libvlc_media_release}.
+ @param p_instance: the instance.
+ @param psz_name: the name of the node.
+ @return: the new empty media or NULL on error.
+ '''
+ f = _Cfunctions.get('libvlc_media_new_as_node', None) or \
+ _Cfunction('libvlc_media_new_as_node', ((1,), (1,),), class_result(Media),
+ ctypes.c_void_p, Instance, ctypes.c_char_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_new_as_node
+ libvlc_media_new_as_node = f
+ return f(p_instance, psz_name)
+
+def libvlc_media_add_option(p_md, ppsz_options):
+ '''Add an option to the media.
+ This option will be used to determine how the media_player will
+ read the media. This allows to use VLC's advanced
+ reading/streaming options on a per-media basis.
+ The options are detailed in vlc --long-help, for instance "--sout-all".
+ @param p_md: the media descriptor.
+ @param ppsz_options: the options (as a string).
+ '''
+ f = _Cfunctions.get('libvlc_media_add_option', None) or \
+ _Cfunction('libvlc_media_add_option', ((1,), (1,),), None,
+ None, Media, ctypes.c_char_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_add_option
+ libvlc_media_add_option = f
+ return f(p_md, ppsz_options)
+
+def libvlc_media_add_option_flag(p_md, ppsz_options, i_flags):
+ '''Add an option to the media with configurable flags.
+ This option will be used to determine how the media_player will
+ read the media. This allows to use VLC's advanced
+ reading/streaming options on a per-media basis.
+ The options are detailed in vlc --long-help, for instance "--sout-all".
+ @param p_md: the media descriptor.
+ @param ppsz_options: the options (as a string).
+ @param i_flags: the flags for this option.
+ '''
+ f = _Cfunctions.get('libvlc_media_add_option_flag', None) or \
+ _Cfunction('libvlc_media_add_option_flag', ((1,), (1,), (1,),), None,
+ None, Media, ctypes.c_char_p, ctypes.c_uint)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_add_option_flag
+ libvlc_media_add_option_flag = f
+ return f(p_md, ppsz_options, i_flags)
+
+def libvlc_media_retain(p_md):
+ '''Retain a reference to a media descriptor object (libvlc_media_t). Use
+ L{libvlc_media_release}() to decrement the reference count of a
+ media descriptor object.
+ @param p_md: the media descriptor.
+ '''
+ f = _Cfunctions.get('libvlc_media_retain', None) or \
+ _Cfunction('libvlc_media_retain', ((1,),), None,
+ None, Media)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_retain
+ libvlc_media_retain = f
+ return f(p_md)
+
+def libvlc_media_release(p_md):
+ '''Decrement the reference count of a media descriptor object. If the
+ reference count is 0, then L{libvlc_media_release}() will release the
+ media descriptor object. It will send out an libvlc_MediaFreed event
+ to all listeners. If the media descriptor object has been released it
+ should not be used again.
+ @param p_md: the media descriptor.
+ '''
+ f = _Cfunctions.get('libvlc_media_release', None) or \
+ _Cfunction('libvlc_media_release', ((1,),), None,
+ None, Media)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_release
+ libvlc_media_release = f
+ return f(p_md)
+
+def libvlc_media_get_mrl(p_md):
+ '''Get the media resource locator (mrl) from a media descriptor object.
+ @param p_md: a media descriptor object.
+ @return: string with mrl of media descriptor object.
+ '''
+ f = _Cfunctions.get('libvlc_media_get_mrl', None) or \
+ _Cfunction('libvlc_media_get_mrl', ((1,),), string_result,
+ ctypes.c_void_p, Media)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_get_mrl
+ libvlc_media_get_mrl = f
+ return f(p_md)
+
+def libvlc_media_duplicate(p_md):
+ '''Duplicate a media descriptor object.
+ @param p_md: a media descriptor object.
+ '''
+ f = _Cfunctions.get('libvlc_media_duplicate', None) or \
+ _Cfunction('libvlc_media_duplicate', ((1,),), class_result(Media),
+ ctypes.c_void_p, Media)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_duplicate
+ libvlc_media_duplicate = f
+ return f(p_md)
+
+def libvlc_media_get_meta(p_md, e_meta):
+ '''Read the meta of the media.
+ If the media has not yet been parsed this will return NULL.
+ This methods automatically calls L{libvlc_media_parse_async}(), so after calling
+ it you may receive a libvlc_MediaMetaChanged event. If you prefer a synchronous
+ version ensure that you call L{libvlc_media_parse}() before get_meta().
+ See L{libvlc_media_parse}
+ See L{libvlc_media_parse_async}
+ See libvlc_MediaMetaChanged.
+ @param p_md: the media descriptor.
+ @param e_meta: the meta to read.
+ @return: the media's meta.
+ '''
+ f = _Cfunctions.get('libvlc_media_get_meta', None) or \
+ _Cfunction('libvlc_media_get_meta', ((1,), (1,),), string_result,
+ ctypes.c_void_p, Media, Meta)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_get_meta
+ libvlc_media_get_meta = f
+ return f(p_md, e_meta)
+
+def libvlc_media_set_meta(p_md, e_meta, psz_value):
+ '''Set the meta of the media (this function will not save the meta, call
+ L{libvlc_media_save_meta} in order to save the meta).
+ @param p_md: the media descriptor.
+ @param e_meta: the meta to write.
+ @param psz_value: the media's meta.
+ '''
+ f = _Cfunctions.get('libvlc_media_set_meta', None) or \
+ _Cfunction('libvlc_media_set_meta', ((1,), (1,), (1,),), None,
+ None, Media, Meta, ctypes.c_char_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_set_meta
+ libvlc_media_set_meta = f
+ return f(p_md, e_meta, psz_value)
+
+def libvlc_media_save_meta(p_md):
+ '''Save the meta previously set.
+ @param p_md: the media desriptor.
+ @return: true if the write operation was successfull.
+ '''
+ f = _Cfunctions.get('libvlc_media_save_meta', None) or \
+ _Cfunction('libvlc_media_save_meta', ((1,),), None,
+ ctypes.c_int, Media)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_save_meta
+ libvlc_media_save_meta = f
+ return f(p_md)
+
+def libvlc_media_get_state(p_md):
+ '''Get current state of media descriptor object. Possible media states
+ are defined in libvlc_structures.c ( libvlc_NothingSpecial=0,
+ libvlc_Opening, libvlc_Buffering, libvlc_Playing, libvlc_Paused,
+ libvlc_Stopped, libvlc_Ended,
+ libvlc_Error).
+ See libvlc_state_t.
+ @param p_md: a media descriptor object.
+ @return: state of media descriptor object.
+ '''
+ f = _Cfunctions.get('libvlc_media_get_state', None) or \
+ _Cfunction('libvlc_media_get_state', ((1,),), None,
+ State, Media)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_get_state
+ libvlc_media_get_state = f
+ return f(p_md)
+
+def libvlc_media_get_stats(p_md, p_stats):
+ '''Get the current statistics about the media.
+ @param p_md:: media descriptor object.
+ @param p_stats:: structure that contain the statistics about the media (this structure must be allocated by the caller).
+ @return: true if the statistics are available, false otherwise \libvlc_return_bool.
+ '''
+ f = _Cfunctions.get('libvlc_media_get_stats', None) or \
+ _Cfunction('libvlc_media_get_stats', ((1,), (1,),), None,
+ ctypes.c_int, Media, ctypes.POINTER(MediaStats))
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_get_stats
+ libvlc_media_get_stats = f
+ return f(p_md, p_stats)
+
+def libvlc_media_event_manager(p_md):
+ '''Get event manager from media descriptor object.
+ NOTE: this function doesn't increment reference counting.
+ @param p_md: a media descriptor object.
+ @return: event manager object.
+ '''
+ f = _Cfunctions.get('libvlc_media_event_manager', None) or \
+ _Cfunction('libvlc_media_event_manager', ((1,),), class_result(EventManager),
+ ctypes.c_void_p, Media)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_event_manager
+ libvlc_media_event_manager = f
+ return f(p_md)
+
+def libvlc_media_get_duration(p_md):
+ '''Get duration (in ms) of media descriptor object item.
+ @param p_md: media descriptor object.
+ @return: duration of media item or -1 on error.
+ '''
+ f = _Cfunctions.get('libvlc_media_get_duration', None) or \
+ _Cfunction('libvlc_media_get_duration', ((1,),), None,
+ ctypes.c_longlong, Media)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_get_duration
+ libvlc_media_get_duration = f
+ return f(p_md)
+
+def libvlc_media_parse(p_md):
+ '''Parse a media.
+ This fetches (local) meta data and tracks information.
+ The method is synchronous.
+ See L{libvlc_media_parse_async}
+ See L{libvlc_media_get_meta}
+ See L{libvlc_media_get_tracks_info}.
+ @param p_md: media descriptor object.
+ '''
+ f = _Cfunctions.get('libvlc_media_parse', None) or \
+ _Cfunction('libvlc_media_parse', ((1,),), None,
+ None, Media)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_parse
+ libvlc_media_parse = f
+ return f(p_md)
+
+def libvlc_media_parse_async(p_md):
+ '''Parse a media.
+ This fetches (local) meta data and tracks information.
+ The method is the asynchronous of L{libvlc_media_parse}().
+ To track when this is over you can listen to libvlc_MediaParsedChanged
+ event. However if the media was already parsed you will not receive this
+ event.
+ See L{libvlc_media_parse}
+ See libvlc_MediaParsedChanged
+ See L{libvlc_media_get_meta}
+ See L{libvlc_media_get_tracks_info}.
+ @param p_md: media descriptor object.
+ '''
+ f = _Cfunctions.get('libvlc_media_parse_async', None) or \
+ _Cfunction('libvlc_media_parse_async', ((1,),), None,
+ None, Media)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_parse_async
+ libvlc_media_parse_async = f
+ return f(p_md)
+
+def libvlc_media_is_parsed(p_md):
+ '''Get Parsed status for media descriptor object.
+ See libvlc_MediaParsedChanged.
+ @param p_md: media descriptor object.
+ @return: true if media object has been parsed otherwise it returns false \libvlc_return_bool.
+ '''
+ f = _Cfunctions.get('libvlc_media_is_parsed', None) or \
+ _Cfunction('libvlc_media_is_parsed', ((1,),), None,
+ ctypes.c_int, Media)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_is_parsed
+ libvlc_media_is_parsed = f
+ return f(p_md)
+
+def libvlc_media_set_user_data(p_md, p_new_user_data):
+ '''Sets media descriptor's user_data. user_data is specialized data
+ accessed by the host application, VLC.framework uses it as a pointer to
+ an native object that references a L{Media} pointer.
+ @param p_md: media descriptor object.
+ @param p_new_user_data: pointer to user data.
+ '''
+ f = _Cfunctions.get('libvlc_media_set_user_data', None) or \
+ _Cfunction('libvlc_media_set_user_data', ((1,), (1,),), None,
+ None, Media, ctypes.c_void_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_set_user_data
+ libvlc_media_set_user_data = f
+ return f(p_md, p_new_user_data)
+
+def libvlc_media_get_user_data(p_md):
+ '''Get media descriptor's user_data. user_data is specialized data
+ accessed by the host application, VLC.framework uses it as a pointer to
+ an native object that references a L{Media} pointer.
+ @param p_md: media descriptor object.
+ '''
+ f = _Cfunctions.get('libvlc_media_get_user_data', None) or \
+ _Cfunction('libvlc_media_get_user_data', ((1,),), None,
+ ctypes.c_void_p, Media)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_get_user_data
+ libvlc_media_get_user_data = f
+ return f(p_md)
+
+def libvlc_media_get_tracks_info(p_md):
+ '''Get media descriptor's elementary streams description
+ Note, you need to call L{libvlc_media_parse}() or play the media at least once
+ before calling this function.
+ Not doing this will result in an empty array.
+ @param p_md: media descriptor object.
+ @param tracks: address to store an allocated array of Elementary Streams descriptions (must be freed by the caller).
+ @return: the number of Elementary Streams.
+ '''
+ f = _Cfunctions.get('libvlc_media_get_tracks_info', None) or \
+ _Cfunction('libvlc_media_get_tracks_info', ((1,), (2,),), None,
+ ctypes.c_int, Media, ctypes.POINTER(ctypes.c_void_p))
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_get_tracks_info
+ libvlc_media_get_tracks_info = f
+ return f(p_md)
+
+def libvlc_media_discoverer_new_from_name(p_inst, psz_name):
+ '''Discover media service by name.
+ @param p_inst: libvlc instance.
+ @param psz_name: service name.
+ @return: media discover object or NULL in case of error.
+ '''
+ f = _Cfunctions.get('libvlc_media_discoverer_new_from_name', None) or \
+ _Cfunction('libvlc_media_discoverer_new_from_name', ((1,), (1,),), class_result(MediaDiscoverer),
+ ctypes.c_void_p, Instance, ctypes.c_char_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_discoverer_new_from_name
+ libvlc_media_discoverer_new_from_name = f
+ return f(p_inst, psz_name)
+
+def libvlc_media_discoverer_release(p_mdis):
+ '''Release media discover object. If the reference count reaches 0, then
+ the object will be released.
+ @param p_mdis: media service discover object.
+ '''
+ f = _Cfunctions.get('libvlc_media_discoverer_release', None) or \
+ _Cfunction('libvlc_media_discoverer_release', ((1,),), None,
+ None, MediaDiscoverer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_discoverer_release
+ libvlc_media_discoverer_release = f
+ return f(p_mdis)
+
+def libvlc_media_discoverer_localized_name(p_mdis):
+ '''Get media service discover object its localized name.
+ @param p_mdis: media discover object.
+ @return: localized name.
+ '''
+ f = _Cfunctions.get('libvlc_media_discoverer_localized_name', None) or \
+ _Cfunction('libvlc_media_discoverer_localized_name', ((1,),), string_result,
+ ctypes.c_void_p, MediaDiscoverer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_discoverer_localized_name
+ libvlc_media_discoverer_localized_name = f
+ return f(p_mdis)
+
+def libvlc_media_discoverer_media_list(p_mdis):
+ '''Get media service discover media list.
+ @param p_mdis: media service discover object.
+ @return: list of media items.
+ '''
+ f = _Cfunctions.get('libvlc_media_discoverer_media_list', None) or \
+ _Cfunction('libvlc_media_discoverer_media_list', ((1,),), class_result(MediaList),
+ ctypes.c_void_p, MediaDiscoverer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_discoverer_media_list
+ libvlc_media_discoverer_media_list = f
+ return f(p_mdis)
+
+def libvlc_media_discoverer_event_manager(p_mdis):
+ '''Get event manager from media service discover object.
+ @param p_mdis: media service discover object.
+ @return: event manager object.
+ '''
+ f = _Cfunctions.get('libvlc_media_discoverer_event_manager', None) or \
+ _Cfunction('libvlc_media_discoverer_event_manager', ((1,),), class_result(EventManager),
+ ctypes.c_void_p, MediaDiscoverer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_discoverer_event_manager
+ libvlc_media_discoverer_event_manager = f
+ return f(p_mdis)
+
+def libvlc_media_discoverer_is_running(p_mdis):
+ '''Query if media service discover object is running.
+ @param p_mdis: media service discover object.
+ @return: true if running, false if not \libvlc_return_bool.
+ '''
+ f = _Cfunctions.get('libvlc_media_discoverer_is_running', None) or \
+ _Cfunction('libvlc_media_discoverer_is_running', ((1,),), None,
+ ctypes.c_int, MediaDiscoverer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_discoverer_is_running
+ libvlc_media_discoverer_is_running = f
+ return f(p_mdis)
+
+def libvlc_media_library_new(p_instance):
+ '''Create an new Media Library object.
+ @param p_instance: the libvlc instance.
+ @return: a new object or NULL on error.
+ '''
+ f = _Cfunctions.get('libvlc_media_library_new', None) or \
+ _Cfunction('libvlc_media_library_new', ((1,),), class_result(MediaLibrary),
+ ctypes.c_void_p, Instance)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_library_new
+ libvlc_media_library_new = f
+ return f(p_instance)
+
+def libvlc_media_library_release(p_mlib):
+ '''Release media library object. This functions decrements the
+ reference count of the media library object. If it reaches 0,
+ then the object will be released.
+ @param p_mlib: media library object.
+ '''
+ f = _Cfunctions.get('libvlc_media_library_release', None) or \
+ _Cfunction('libvlc_media_library_release', ((1,),), None,
+ None, MediaLibrary)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_library_release
+ libvlc_media_library_release = f
+ return f(p_mlib)
+
+def libvlc_media_library_retain(p_mlib):
+ '''Retain a reference to a media library object. This function will
+ increment the reference counting for this object. Use
+ L{libvlc_media_library_release}() to decrement the reference count.
+ @param p_mlib: media library object.
+ '''
+ f = _Cfunctions.get('libvlc_media_library_retain', None) or \
+ _Cfunction('libvlc_media_library_retain', ((1,),), None,
+ None, MediaLibrary)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_library_retain
+ libvlc_media_library_retain = f
+ return f(p_mlib)
+
+def libvlc_media_library_load(p_mlib):
+ '''Load media library.
+ @param p_mlib: media library object.
+ @return: 0 on success, -1 on error.
+ '''
+ f = _Cfunctions.get('libvlc_media_library_load', None) or \
+ _Cfunction('libvlc_media_library_load', ((1,),), None,
+ ctypes.c_int, MediaLibrary)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_library_load
+ libvlc_media_library_load = f
+ return f(p_mlib)
+
+def libvlc_media_library_media_list(p_mlib):
+ '''Get media library subitems.
+ @param p_mlib: media library object.
+ @return: media list subitems.
+ '''
+ f = _Cfunctions.get('libvlc_media_library_media_list', None) or \
+ _Cfunction('libvlc_media_library_media_list', ((1,),), class_result(MediaList),
+ ctypes.c_void_p, MediaLibrary)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_library_media_list
+ libvlc_media_library_media_list = f
+ return f(p_mlib)
+
+def libvlc_media_list_new(p_instance):
+ '''Create an empty media list.
+ @param p_instance: libvlc instance.
+ @return: empty media list, or NULL on error.
+ '''
+ f = _Cfunctions.get('libvlc_media_list_new', None) or \
+ _Cfunction('libvlc_media_list_new', ((1,),), class_result(MediaList),
+ ctypes.c_void_p, Instance)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_list_new
+ libvlc_media_list_new = f
+ return f(p_instance)
+
+def libvlc_media_list_release(p_ml):
+ '''Release media list created with L{libvlc_media_list_new}().
+ @param p_ml: a media list created with L{libvlc_media_list_new}().
+ '''
+ f = _Cfunctions.get('libvlc_media_list_release', None) or \
+ _Cfunction('libvlc_media_list_release', ((1,),), None,
+ None, MediaList)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_list_release
+ libvlc_media_list_release = f
+ return f(p_ml)
+
+def libvlc_media_list_retain(p_ml):
+ '''Retain reference to a media list.
+ @param p_ml: a media list created with L{libvlc_media_list_new}().
+ '''
+ f = _Cfunctions.get('libvlc_media_list_retain', None) or \
+ _Cfunction('libvlc_media_list_retain', ((1,),), None,
+ None, MediaList)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_list_retain
+ libvlc_media_list_retain = f
+ return f(p_ml)
+
+def libvlc_media_list_set_media(p_ml, p_md):
+ '''Associate media instance with this media list instance.
+ If another media instance was present it will be released.
+ The L{libvlc_media_list_lock} should NOT be held upon entering this function.
+ @param p_ml: a media list instance.
+ @param p_md: media instance to add.
+ '''
+ f = _Cfunctions.get('libvlc_media_list_set_media', None) or \
+ _Cfunction('libvlc_media_list_set_media', ((1,), (1,),), None,
+ None, MediaList, Media)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_list_set_media
+ libvlc_media_list_set_media = f
+ return f(p_ml, p_md)
+
+def libvlc_media_list_media(p_ml):
+ '''Get media instance from this media list instance. This action will increase
+ the refcount on the media instance.
+ The L{libvlc_media_list_lock} should NOT be held upon entering this function.
+ @param p_ml: a media list instance.
+ @return: media instance.
+ '''
+ f = _Cfunctions.get('libvlc_media_list_media', None) or \
+ _Cfunction('libvlc_media_list_media', ((1,),), class_result(Media),
+ ctypes.c_void_p, MediaList)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_list_media
+ libvlc_media_list_media = f
+ return f(p_ml)
+
+def libvlc_media_list_add_media(p_ml, p_md):
+ '''Add media instance to media list
+ The L{libvlc_media_list_lock} should be held upon entering this function.
+ @param p_ml: a media list instance.
+ @param p_md: a media instance.
+ @return: 0 on success, -1 if the media list is read-only.
+ '''
+ f = _Cfunctions.get('libvlc_media_list_add_media', None) or \
+ _Cfunction('libvlc_media_list_add_media', ((1,), (1,),), None,
+ ctypes.c_int, MediaList, Media)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_list_add_media
+ libvlc_media_list_add_media = f
+ return f(p_ml, p_md)
+
+def libvlc_media_list_insert_media(p_ml, p_md, i_pos):
+ '''Insert media instance in media list on a position
+ The L{libvlc_media_list_lock} should be held upon entering this function.
+ @param p_ml: a media list instance.
+ @param p_md: a media instance.
+ @param i_pos: position in array where to insert.
+ @return: 0 on success, -1 if the media list is read-only.
+ '''
+ f = _Cfunctions.get('libvlc_media_list_insert_media', None) or \
+ _Cfunction('libvlc_media_list_insert_media', ((1,), (1,), (1,),), None,
+ ctypes.c_int, MediaList, Media, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_list_insert_media
+ libvlc_media_list_insert_media = f
+ return f(p_ml, p_md, i_pos)
+
+def libvlc_media_list_remove_index(p_ml, i_pos):
+ '''Remove media instance from media list on a position
+ The L{libvlc_media_list_lock} should be held upon entering this function.
+ @param p_ml: a media list instance.
+ @param i_pos: position in array where to insert.
+ @return: 0 on success, -1 if the list is read-only or the item was not found.
+ '''
+ f = _Cfunctions.get('libvlc_media_list_remove_index', None) or \
+ _Cfunction('libvlc_media_list_remove_index', ((1,), (1,),), None,
+ ctypes.c_int, MediaList, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_list_remove_index
+ libvlc_media_list_remove_index = f
+ return f(p_ml, i_pos)
+
+def libvlc_media_list_count(p_ml):
+ '''Get count on media list items
+ The L{libvlc_media_list_lock} should be held upon entering this function.
+ @param p_ml: a media list instance.
+ @return: number of items in media list.
+ '''
+ f = _Cfunctions.get('libvlc_media_list_count', None) or \
+ _Cfunction('libvlc_media_list_count', ((1,),), None,
+ ctypes.c_int, MediaList)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_list_count
+ libvlc_media_list_count = f
+ return f(p_ml)
+
+def libvlc_media_list_item_at_index(p_ml, i_pos):
+ '''List media instance in media list at a position
+ The L{libvlc_media_list_lock} should be held upon entering this function.
+ @param p_ml: a media list instance.
+ @param i_pos: position in array where to insert.
+ @return: media instance at position i_pos, or NULL if not found. In case of success, L{libvlc_media_retain}() is called to increase the refcount on the media.
+ '''
+ f = _Cfunctions.get('libvlc_media_list_item_at_index', None) or \
+ _Cfunction('libvlc_media_list_item_at_index', ((1,), (1,),), class_result(Media),
+ ctypes.c_void_p, MediaList, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_list_item_at_index
+ libvlc_media_list_item_at_index = f
+ return f(p_ml, i_pos)
+
+def libvlc_media_list_index_of_item(p_ml, p_md):
+ '''Find index position of List media instance in media list.
+ Warning: the function will return the first matched position.
+ The L{libvlc_media_list_lock} should be held upon entering this function.
+ @param p_ml: a media list instance.
+ @param p_md: media instance.
+ @return: position of media instance or -1 if media not found.
+ '''
+ f = _Cfunctions.get('libvlc_media_list_index_of_item', None) or \
+ _Cfunction('libvlc_media_list_index_of_item', ((1,), (1,),), None,
+ ctypes.c_int, MediaList, Media)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_list_index_of_item
+ libvlc_media_list_index_of_item = f
+ return f(p_ml, p_md)
+
+def libvlc_media_list_is_readonly(p_ml):
+ '''This indicates if this media list is read-only from a user point of view.
+ @param p_ml: media list instance.
+ @return: 1 on readonly, 0 on readwrite \libvlc_return_bool.
+ '''
+ f = _Cfunctions.get('libvlc_media_list_is_readonly', None) or \
+ _Cfunction('libvlc_media_list_is_readonly', ((1,),), None,
+ ctypes.c_int, MediaList)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_list_is_readonly
+ libvlc_media_list_is_readonly = f
+ return f(p_ml)
+
+def libvlc_media_list_lock(p_ml):
+ '''Get lock on media list items.
+ @param p_ml: a media list instance.
+ '''
+ f = _Cfunctions.get('libvlc_media_list_lock', None) or \
+ _Cfunction('libvlc_media_list_lock', ((1,),), None,
+ None, MediaList)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_list_lock
+ libvlc_media_list_lock = f
+ return f(p_ml)
+
+def libvlc_media_list_unlock(p_ml):
+ '''Release lock on media list items
+ The L{libvlc_media_list_lock} should be held upon entering this function.
+ @param p_ml: a media list instance.
+ '''
+ f = _Cfunctions.get('libvlc_media_list_unlock', None) or \
+ _Cfunction('libvlc_media_list_unlock', ((1,),), None,
+ None, MediaList)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_list_unlock
+ libvlc_media_list_unlock = f
+ return f(p_ml)
+
+def libvlc_media_list_event_manager(p_ml):
+ '''Get libvlc_event_manager from this media list instance.
+ The p_event_manager is immutable, so you don't have to hold the lock.
+ @param p_ml: a media list instance.
+ @return: libvlc_event_manager.
+ '''
+ f = _Cfunctions.get('libvlc_media_list_event_manager', None) or \
+ _Cfunction('libvlc_media_list_event_manager', ((1,),), class_result(EventManager),
+ ctypes.c_void_p, MediaList)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_list_event_manager
+ libvlc_media_list_event_manager = f
+ return f(p_ml)
+
+def libvlc_media_list_player_new(p_instance):
+ '''Create new media_list_player.
+ @param p_instance: libvlc instance.
+ @return: media list player instance or NULL on error.
+ '''
+ f = _Cfunctions.get('libvlc_media_list_player_new', None) or \
+ _Cfunction('libvlc_media_list_player_new', ((1,),), class_result(MediaListPlayer),
+ ctypes.c_void_p, Instance)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_list_player_new
+ libvlc_media_list_player_new = f
+ return f(p_instance)
+
+def libvlc_media_list_player_release(p_mlp):
+ '''Release a media_list_player after use
+ Decrement the reference count of a media player object. If the
+ reference count is 0, then L{libvlc_media_list_player_release}() will
+ release the media player object. If the media player object
+ has been released, then it should not be used again.
+ @param p_mlp: media list player instance.
+ '''
+ f = _Cfunctions.get('libvlc_media_list_player_release', None) or \
+ _Cfunction('libvlc_media_list_player_release', ((1,),), None,
+ None, MediaListPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_list_player_release
+ libvlc_media_list_player_release = f
+ return f(p_mlp)
+
+def libvlc_media_list_player_retain(p_mlp):
+ '''Retain a reference to a media player list object. Use
+ L{libvlc_media_list_player_release}() to decrement reference count.
+ @param p_mlp: media player list object.
+ '''
+ f = _Cfunctions.get('libvlc_media_list_player_retain', None) or \
+ _Cfunction('libvlc_media_list_player_retain', ((1,),), None,
+ None, MediaListPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_list_player_retain
+ libvlc_media_list_player_retain = f
+ return f(p_mlp)
+
+def libvlc_media_list_player_event_manager(p_mlp):
+ '''Return the event manager of this media_list_player.
+ @param p_mlp: media list player instance.
+ @return: the event manager.
+ '''
+ f = _Cfunctions.get('libvlc_media_list_player_event_manager', None) or \
+ _Cfunction('libvlc_media_list_player_event_manager', ((1,),), class_result(EventManager),
+ ctypes.c_void_p, MediaListPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_list_player_event_manager
+ libvlc_media_list_player_event_manager = f
+ return f(p_mlp)
+
+def libvlc_media_list_player_set_media_player(p_mlp, p_mi):
+ '''Replace media player in media_list_player with this instance.
+ @param p_mlp: media list player instance.
+ @param p_mi: media player instance.
+ '''
+ f = _Cfunctions.get('libvlc_media_list_player_set_media_player', None) or \
+ _Cfunction('libvlc_media_list_player_set_media_player', ((1,), (1,),), None,
+ None, MediaListPlayer, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_list_player_set_media_player
+ libvlc_media_list_player_set_media_player = f
+ return f(p_mlp, p_mi)
+
+def libvlc_media_list_player_set_media_list(p_mlp, p_mlist):
+ '''Set the media list associated with the player.
+ @param p_mlp: media list player instance.
+ @param p_mlist: list of media.
+ '''
+ f = _Cfunctions.get('libvlc_media_list_player_set_media_list', None) or \
+ _Cfunction('libvlc_media_list_player_set_media_list', ((1,), (1,),), None,
+ None, MediaListPlayer, MediaList)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_list_player_set_media_list
+ libvlc_media_list_player_set_media_list = f
+ return f(p_mlp, p_mlist)
+
+def libvlc_media_list_player_play(p_mlp):
+ '''Play media list.
+ @param p_mlp: media list player instance.
+ '''
+ f = _Cfunctions.get('libvlc_media_list_player_play', None) or \
+ _Cfunction('libvlc_media_list_player_play', ((1,),), None,
+ None, MediaListPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_list_player_play
+ libvlc_media_list_player_play = f
+ return f(p_mlp)
+
+def libvlc_media_list_player_pause(p_mlp):
+ '''Pause media list.
+ @param p_mlp: media list player instance.
+ '''
+ f = _Cfunctions.get('libvlc_media_list_player_pause', None) or \
+ _Cfunction('libvlc_media_list_player_pause', ((1,),), None,
+ None, MediaListPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_list_player_pause
+ libvlc_media_list_player_pause = f
+ return f(p_mlp)
+
+def libvlc_media_list_player_is_playing(p_mlp):
+ '''Is media list playing?
+ @param p_mlp: media list player instance.
+ @return: true for playing and false for not playing \libvlc_return_bool.
+ '''
+ f = _Cfunctions.get('libvlc_media_list_player_is_playing', None) or \
+ _Cfunction('libvlc_media_list_player_is_playing', ((1,),), None,
+ ctypes.c_int, MediaListPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_list_player_is_playing
+ libvlc_media_list_player_is_playing = f
+ return f(p_mlp)
+
+def libvlc_media_list_player_get_state(p_mlp):
+ '''Get current libvlc_state of media list player.
+ @param p_mlp: media list player instance.
+ @return: libvlc_state_t for media list player.
+ '''
+ f = _Cfunctions.get('libvlc_media_list_player_get_state', None) or \
+ _Cfunction('libvlc_media_list_player_get_state', ((1,),), None,
+ State, MediaListPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_list_player_get_state
+ libvlc_media_list_player_get_state = f
+ return f(p_mlp)
+
+def libvlc_media_list_player_play_item_at_index(p_mlp, i_index):
+ '''Play media list item at position index.
+ @param p_mlp: media list player instance.
+ @param i_index: index in media list to play.
+ @return: 0 upon success -1 if the item wasn't found.
+ '''
+ f = _Cfunctions.get('libvlc_media_list_player_play_item_at_index', None) or \
+ _Cfunction('libvlc_media_list_player_play_item_at_index', ((1,), (1,),), None,
+ ctypes.c_int, MediaListPlayer, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_list_player_play_item_at_index
+ libvlc_media_list_player_play_item_at_index = f
+ return f(p_mlp, i_index)
+
+def libvlc_media_list_player_play_item(p_mlp, p_md):
+ '''Play the given media item.
+ @param p_mlp: media list player instance.
+ @param p_md: the media instance.
+ @return: 0 upon success, -1 if the media is not part of the media list.
+ '''
+ f = _Cfunctions.get('libvlc_media_list_player_play_item', None) or \
+ _Cfunction('libvlc_media_list_player_play_item', ((1,), (1,),), None,
+ ctypes.c_int, MediaListPlayer, Media)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_list_player_play_item
+ libvlc_media_list_player_play_item = f
+ return f(p_mlp, p_md)
+
+def libvlc_media_list_player_stop(p_mlp):
+ '''Stop playing media list.
+ @param p_mlp: media list player instance.
+ '''
+ f = _Cfunctions.get('libvlc_media_list_player_stop', None) or \
+ _Cfunction('libvlc_media_list_player_stop', ((1,),), None,
+ None, MediaListPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_list_player_stop
+ libvlc_media_list_player_stop = f
+ return f(p_mlp)
+
+def libvlc_media_list_player_next(p_mlp):
+ '''Play next item from media list.
+ @param p_mlp: media list player instance.
+ @return: 0 upon success -1 if there is no next item.
+ '''
+ f = _Cfunctions.get('libvlc_media_list_player_next', None) or \
+ _Cfunction('libvlc_media_list_player_next', ((1,),), None,
+ ctypes.c_int, MediaListPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_list_player_next
+ libvlc_media_list_player_next = f
+ return f(p_mlp)
+
+def libvlc_media_list_player_previous(p_mlp):
+ '''Play previous item from media list.
+ @param p_mlp: media list player instance.
+ @return: 0 upon success -1 if there is no previous item.
+ '''
+ f = _Cfunctions.get('libvlc_media_list_player_previous', None) or \
+ _Cfunction('libvlc_media_list_player_previous', ((1,),), None,
+ ctypes.c_int, MediaListPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_list_player_previous
+ libvlc_media_list_player_previous = f
+ return f(p_mlp)
+
+def libvlc_media_list_player_set_playback_mode(p_mlp, e_mode):
+ '''Sets the playback mode for the playlist.
+ @param p_mlp: media list player instance.
+ @param e_mode: playback mode specification.
+ '''
+ f = _Cfunctions.get('libvlc_media_list_player_set_playback_mode', None) or \
+ _Cfunction('libvlc_media_list_player_set_playback_mode', ((1,), (1,),), None,
+ None, MediaListPlayer, PlaybackMode)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_list_player_set_playback_mode
+ libvlc_media_list_player_set_playback_mode = f
+ return f(p_mlp, e_mode)
+
+def libvlc_media_player_new(p_libvlc_instance):
+ '''Create an empty Media Player object.
+ @param p_libvlc_instance: the libvlc instance in which the Media Player should be created.
+ @return: a new media player object, or NULL on error.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_new', None) or \
+ _Cfunction('libvlc_media_player_new', ((1,),), class_result(MediaPlayer),
+ ctypes.c_void_p, Instance)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_new
+ libvlc_media_player_new = f
+ return f(p_libvlc_instance)
+
+def libvlc_media_player_new_from_media(p_md):
+ '''Create a Media Player object from a Media.
+ @param p_md: the media. Afterwards the p_md can be safely destroyed.
+ @return: a new media player object, or NULL on error.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_new_from_media', None) or \
+ _Cfunction('libvlc_media_player_new_from_media', ((1,),), class_result(MediaPlayer),
+ ctypes.c_void_p, Media)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_new_from_media
+ libvlc_media_player_new_from_media = f
+ return f(p_md)
+
+def libvlc_media_player_release(p_mi):
+ '''Release a media_player after use
+ Decrement the reference count of a media player object. If the
+ reference count is 0, then L{libvlc_media_player_release}() will
+ release the media player object. If the media player object
+ has been released, then it should not be used again.
+ @param p_mi: the Media Player to free.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_release', None) or \
+ _Cfunction('libvlc_media_player_release', ((1,),), None,
+ None, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_release
+ libvlc_media_player_release = f
+ return f(p_mi)
+
+def libvlc_media_player_retain(p_mi):
+ '''Retain a reference to a media player object. Use
+ L{libvlc_media_player_release}() to decrement reference count.
+ @param p_mi: media player object.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_retain', None) or \
+ _Cfunction('libvlc_media_player_retain', ((1,),), None,
+ None, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_retain
+ libvlc_media_player_retain = f
+ return f(p_mi)
+
+def libvlc_media_player_set_media(p_mi, p_md):
+ '''Set the media that will be used by the media_player. If any,
+ previous md will be released.
+ @param p_mi: the Media Player.
+ @param p_md: the Media. Afterwards the p_md can be safely destroyed.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_set_media', None) or \
+ _Cfunction('libvlc_media_player_set_media', ((1,), (1,),), None,
+ None, MediaPlayer, Media)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_set_media
+ libvlc_media_player_set_media = f
+ return f(p_mi, p_md)
+
+def libvlc_media_player_get_media(p_mi):
+ '''Get the media used by the media_player.
+ @param p_mi: the Media Player.
+ @return: the media associated with p_mi, or NULL if no media is associated.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_get_media', None) or \
+ _Cfunction('libvlc_media_player_get_media', ((1,),), class_result(Media),
+ ctypes.c_void_p, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_get_media
+ libvlc_media_player_get_media = f
+ return f(p_mi)
+
+def libvlc_media_player_event_manager(p_mi):
+ '''Get the Event Manager from which the media player send event.
+ @param p_mi: the Media Player.
+ @return: the event manager associated with p_mi.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_event_manager', None) or \
+ _Cfunction('libvlc_media_player_event_manager', ((1,),), class_result(EventManager),
+ ctypes.c_void_p, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_event_manager
+ libvlc_media_player_event_manager = f
+ return f(p_mi)
+
+def libvlc_media_player_is_playing(p_mi):
+ '''is_playing.
+ @param p_mi: the Media Player.
+ @return: 1 if the media player is playing, 0 otherwise \libvlc_return_bool.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_is_playing', None) or \
+ _Cfunction('libvlc_media_player_is_playing', ((1,),), None,
+ ctypes.c_int, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_is_playing
+ libvlc_media_player_is_playing = f
+ return f(p_mi)
+
+def libvlc_media_player_play(p_mi):
+ '''Play.
+ @param p_mi: the Media Player.
+ @return: 0 if playback started (and was already started), or -1 on error.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_play', None) or \
+ _Cfunction('libvlc_media_player_play', ((1,),), None,
+ ctypes.c_int, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_play
+ libvlc_media_player_play = f
+ return f(p_mi)
+
+def libvlc_media_player_set_pause(mp, do_pause):
+ '''Pause or resume (no effect if there is no media).
+ @param mp: the Media Player.
+ @param do_pause: play/resume if zero, pause if non-zero.
+ @version: LibVLC 1.1.1 or later.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_set_pause', None) or \
+ _Cfunction('libvlc_media_player_set_pause', ((1,), (1,),), None,
+ None, MediaPlayer, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_set_pause
+ libvlc_media_player_set_pause = f
+ return f(mp, do_pause)
+
+def libvlc_media_player_pause(p_mi):
+ '''Toggle pause (no effect if there is no media).
+ @param p_mi: the Media Player.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_pause', None) or \
+ _Cfunction('libvlc_media_player_pause', ((1,),), None,
+ None, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_pause
+ libvlc_media_player_pause = f
+ return f(p_mi)
+
+def libvlc_media_player_stop(p_mi):
+ '''Stop (no effect if there is no media).
+ @param p_mi: the Media Player.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_stop', None) or \
+ _Cfunction('libvlc_media_player_stop', ((1,),), None,
+ None, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_stop
+ libvlc_media_player_stop = f
+ return f(p_mi)
+
+def libvlc_video_set_format(mp, chroma, width, height, pitch):
+ '''Set decoded video chroma and dimensions.
+ This only works in combination with libvlc_video_set_callbacks(),
+ and is mutually exclusive with libvlc_video_set_format_callbacks().
+ @param mp: the media player.
+ @param chroma: a four-characters string identifying the chroma (e.g. "RV32" or "YUYV").
+ @param width: pixel width.
+ @param height: pixel height.
+ @param pitch: line pitch (in bytes).
+ @version: LibVLC 1.1.1 or later.
+ @bug: All pixel planes are expected to have the same pitch. To use the YCbCr color space with chrominance subsampling, consider using libvlc_video_set_format_callbacks() instead.
+ '''
+ f = _Cfunctions.get('libvlc_video_set_format', None) or \
+ _Cfunction('libvlc_video_set_format', ((1,), (1,), (1,), (1,), (1,),), None,
+ None, MediaPlayer, ctypes.c_char_p, ctypes.c_uint, ctypes.c_uint, ctypes.c_uint)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_set_format
+ libvlc_video_set_format = f
+ return f(mp, chroma, width, height, pitch)
+
+def libvlc_media_player_set_nsobject(p_mi, drawable):
+ '''Set the NSView handler where the media player should render its video output.
+ Use the vout called "macosx".
+ The drawable is an NSObject that follow the VLCOpenGLVideoViewEmbedding
+ protocol:
+ @begincode
+ \@protocol VLCOpenGLVideoViewEmbedding <NSObject>
+ - (void)addVoutSubview:(NSView *)view;
+ - (void)removeVoutSubview:(NSView *)view;
+ \@end
+ @endcode
+ Or it can be an NSView object.
+ If you want to use it along with Qt4 see the QMacCocoaViewContainer. Then
+ the following code should work:
+ @begincode
+
+ NSView *video = [[NSView alloc] init];
+ QMacCocoaViewContainer *container = new QMacCocoaViewContainer(video, parent);
+ L{libvlc_media_player_set_nsobject}(mp, video);
+ [video release];
+
+ @endcode
+ You can find a live example in VLCVideoView in VLCKit.framework.
+ @param p_mi: the Media Player.
+ @param drawable: the drawable that is either an NSView or an object following the VLCOpenGLVideoViewEmbedding protocol.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_set_nsobject', None) or \
+ _Cfunction('libvlc_media_player_set_nsobject', ((1,), (1,),), None,
+ None, MediaPlayer, ctypes.c_void_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_set_nsobject
+ libvlc_media_player_set_nsobject = f
+ return f(p_mi, drawable)
+
+def libvlc_media_player_get_nsobject(p_mi):
+ '''Get the NSView handler previously set with L{libvlc_media_player_set_nsobject}().
+ @param p_mi: the Media Player.
+ @return: the NSView handler or 0 if none where set.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_get_nsobject', None) or \
+ _Cfunction('libvlc_media_player_get_nsobject', ((1,),), None,
+ ctypes.c_void_p, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_get_nsobject
+ libvlc_media_player_get_nsobject = f
+ return f(p_mi)
+
+def libvlc_media_player_set_agl(p_mi, drawable):
+ '''Set the agl handler where the media player should render its video output.
+ @param p_mi: the Media Player.
+ @param drawable: the agl handler.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_set_agl', None) or \
+ _Cfunction('libvlc_media_player_set_agl', ((1,), (1,),), None,
+ None, MediaPlayer, ctypes.c_uint32)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_set_agl
+ libvlc_media_player_set_agl = f
+ return f(p_mi, drawable)
+
+def libvlc_media_player_get_agl(p_mi):
+ '''Get the agl handler previously set with L{libvlc_media_player_set_agl}().
+ @param p_mi: the Media Player.
+ @return: the agl handler or 0 if none where set.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_get_agl', None) or \
+ _Cfunction('libvlc_media_player_get_agl', ((1,),), None,
+ ctypes.c_uint32, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_get_agl
+ libvlc_media_player_get_agl = f
+ return f(p_mi)
+
+def libvlc_media_player_set_xwindow(p_mi, drawable):
+ '''Set an X Window System drawable where the media player should render its
+ video output. If LibVLC was built without X11 output support, then this has
+ no effects.
+ The specified identifier must correspond to an existing Input/Output class
+ X11 window. Pixmaps are B{not} supported. The caller shall ensure that
+ the X11 server is the same as the one the VLC instance has been configured
+ with. This function must be called before video playback is started;
+ otherwise it will only take effect after playback stop and restart.
+ @param p_mi: the Media Player.
+ @param drawable: the ID of the X window.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_set_xwindow', None) or \
+ _Cfunction('libvlc_media_player_set_xwindow', ((1,), (1,),), None,
+ None, MediaPlayer, ctypes.c_uint32)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_set_xwindow
+ libvlc_media_player_set_xwindow = f
+ return f(p_mi, drawable)
+
+def libvlc_media_player_get_xwindow(p_mi):
+ '''Get the X Window System window identifier previously set with
+ L{libvlc_media_player_set_xwindow}(). Note that this will return the identifier
+ even if VLC is not currently using it (for instance if it is playing an
+ audio-only input).
+ @param p_mi: the Media Player.
+ @return: an X window ID, or 0 if none where set.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_get_xwindow', None) or \
+ _Cfunction('libvlc_media_player_get_xwindow', ((1,),), None,
+ ctypes.c_uint32, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_get_xwindow
+ libvlc_media_player_get_xwindow = f
+ return f(p_mi)
+
+def libvlc_media_player_set_hwnd(p_mi, drawable):
+ '''Set a Win32/Win64 API window handle (HWND) where the media player should
+ render its video output. If LibVLC was built without Win32/Win64 API output
+ support, then this has no effects.
+ @param p_mi: the Media Player.
+ @param drawable: windows handle of the drawable.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_set_hwnd', None) or \
+ _Cfunction('libvlc_media_player_set_hwnd', ((1,), (1,),), None,
+ None, MediaPlayer, ctypes.c_void_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_set_hwnd
+ libvlc_media_player_set_hwnd = f
+ return f(p_mi, drawable)
+
+def libvlc_media_player_get_hwnd(p_mi):
+ '''Get the Windows API window handle (HWND) previously set with
+ L{libvlc_media_player_set_hwnd}(). The handle will be returned even if LibVLC
+ is not currently outputting any video to it.
+ @param p_mi: the Media Player.
+ @return: a window handle or NULL if there are none.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_get_hwnd', None) or \
+ _Cfunction('libvlc_media_player_get_hwnd', ((1,),), None,
+ ctypes.c_void_p, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_get_hwnd
+ libvlc_media_player_get_hwnd = f
+ return f(p_mi)
+
+def libvlc_audio_set_format(mp, format, rate, channels):
+ '''Set decoded audio format.
+ This only works in combination with libvlc_audio_set_callbacks(),
+ and is mutually exclusive with libvlc_audio_set_format_callbacks().
+ @param mp: the media player.
+ @param format: a four-characters string identifying the sample format (e.g. "S16N" or "FL32").
+ @param rate: sample rate (expressed in Hz).
+ @param channels: channels count.
+ @version: LibVLC 1.2.0 or later.
+ '''
+ f = _Cfunctions.get('libvlc_audio_set_format', None) or \
+ _Cfunction('libvlc_audio_set_format', ((1,), (1,), (1,), (1,),), None,
+ None, MediaPlayer, ctypes.c_char_p, ctypes.c_uint, ctypes.c_uint)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_audio_set_format
+ libvlc_audio_set_format = f
+ return f(mp, format, rate, channels)
+
+def libvlc_media_player_get_length(p_mi):
+ '''Get the current movie length (in ms).
+ @param p_mi: the Media Player.
+ @return: the movie length (in ms), or -1 if there is no media.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_get_length', None) or \
+ _Cfunction('libvlc_media_player_get_length', ((1,),), None,
+ ctypes.c_longlong, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_get_length
+ libvlc_media_player_get_length = f
+ return f(p_mi)
+
+def libvlc_media_player_get_time(p_mi):
+ '''Get the current movie time (in ms).
+ @param p_mi: the Media Player.
+ @return: the movie time (in ms), or -1 if there is no media.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_get_time', None) or \
+ _Cfunction('libvlc_media_player_get_time', ((1,),), None,
+ ctypes.c_longlong, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_get_time
+ libvlc_media_player_get_time = f
+ return f(p_mi)
+
+def libvlc_media_player_set_time(p_mi, i_time):
+ '''Set the movie time (in ms). This has no effect if no media is being played.
+ Not all formats and protocols support this.
+ @param p_mi: the Media Player.
+ @param i_time: the movie time (in ms).
+ '''
+ f = _Cfunctions.get('libvlc_media_player_set_time', None) or \
+ _Cfunction('libvlc_media_player_set_time', ((1,), (1,),), None,
+ None, MediaPlayer, ctypes.c_longlong)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_set_time
+ libvlc_media_player_set_time = f
+ return f(p_mi, i_time)
+
+def libvlc_media_player_get_position(p_mi):
+ '''Get movie position.
+ @param p_mi: the Media Player.
+ @return: movie position, or -1. in case of error.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_get_position', None) or \
+ _Cfunction('libvlc_media_player_get_position', ((1,),), None,
+ ctypes.c_float, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_get_position
+ libvlc_media_player_get_position = f
+ return f(p_mi)
+
+def libvlc_media_player_set_position(p_mi, f_pos):
+ '''Set movie position. This has no effect if playback is not enabled.
+ This might not work depending on the underlying input format and protocol.
+ @param p_mi: the Media Player.
+ @param f_pos: the position.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_set_position', None) or \
+ _Cfunction('libvlc_media_player_set_position', ((1,), (1,),), None,
+ None, MediaPlayer, ctypes.c_float)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_set_position
+ libvlc_media_player_set_position = f
+ return f(p_mi, f_pos)
+
+def libvlc_media_player_set_chapter(p_mi, i_chapter):
+ '''Set movie chapter (if applicable).
+ @param p_mi: the Media Player.
+ @param i_chapter: chapter number to play.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_set_chapter', None) or \
+ _Cfunction('libvlc_media_player_set_chapter', ((1,), (1,),), None,
+ None, MediaPlayer, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_set_chapter
+ libvlc_media_player_set_chapter = f
+ return f(p_mi, i_chapter)
+
+def libvlc_media_player_get_chapter(p_mi):
+ '''Get movie chapter.
+ @param p_mi: the Media Player.
+ @return: chapter number currently playing, or -1 if there is no media.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_get_chapter', None) or \
+ _Cfunction('libvlc_media_player_get_chapter', ((1,),), None,
+ ctypes.c_int, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_get_chapter
+ libvlc_media_player_get_chapter = f
+ return f(p_mi)
+
+def libvlc_media_player_get_chapter_count(p_mi):
+ '''Get movie chapter count.
+ @param p_mi: the Media Player.
+ @return: number of chapters in movie, or -1.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_get_chapter_count', None) or \
+ _Cfunction('libvlc_media_player_get_chapter_count', ((1,),), None,
+ ctypes.c_int, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_get_chapter_count
+ libvlc_media_player_get_chapter_count = f
+ return f(p_mi)
+
+def libvlc_media_player_will_play(p_mi):
+ '''Is the player able to play.
+ @param p_mi: the Media Player.
+ @return: boolean \libvlc_return_bool.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_will_play', None) or \
+ _Cfunction('libvlc_media_player_will_play', ((1,),), None,
+ ctypes.c_int, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_will_play
+ libvlc_media_player_will_play = f
+ return f(p_mi)
+
+def libvlc_media_player_get_chapter_count_for_title(p_mi, i_title):
+ '''Get title chapter count.
+ @param p_mi: the Media Player.
+ @param i_title: title.
+ @return: number of chapters in title, or -1.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_get_chapter_count_for_title', None) or \
+ _Cfunction('libvlc_media_player_get_chapter_count_for_title', ((1,), (1,),), None,
+ ctypes.c_int, MediaPlayer, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_get_chapter_count_for_title
+ libvlc_media_player_get_chapter_count_for_title = f
+ return f(p_mi, i_title)
+
+def libvlc_media_player_set_title(p_mi, i_title):
+ '''Set movie title.
+ @param p_mi: the Media Player.
+ @param i_title: title number to play.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_set_title', None) or \
+ _Cfunction('libvlc_media_player_set_title', ((1,), (1,),), None,
+ None, MediaPlayer, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_set_title
+ libvlc_media_player_set_title = f
+ return f(p_mi, i_title)
+
+def libvlc_media_player_get_title(p_mi):
+ '''Get movie title.
+ @param p_mi: the Media Player.
+ @return: title number currently playing, or -1.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_get_title', None) or \
+ _Cfunction('libvlc_media_player_get_title', ((1,),), None,
+ ctypes.c_int, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_get_title
+ libvlc_media_player_get_title = f
+ return f(p_mi)
+
+def libvlc_media_player_get_title_count(p_mi):
+ '''Get movie title count.
+ @param p_mi: the Media Player.
+ @return: title number count, or -1.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_get_title_count', None) or \
+ _Cfunction('libvlc_media_player_get_title_count', ((1,),), None,
+ ctypes.c_int, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_get_title_count
+ libvlc_media_player_get_title_count = f
+ return f(p_mi)
+
+def libvlc_media_player_previous_chapter(p_mi):
+ '''Set previous chapter (if applicable).
+ @param p_mi: the Media Player.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_previous_chapter', None) or \
+ _Cfunction('libvlc_media_player_previous_chapter', ((1,),), None,
+ None, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_previous_chapter
+ libvlc_media_player_previous_chapter = f
+ return f(p_mi)
+
+def libvlc_media_player_next_chapter(p_mi):
+ '''Set next chapter (if applicable).
+ @param p_mi: the Media Player.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_next_chapter', None) or \
+ _Cfunction('libvlc_media_player_next_chapter', ((1,),), None,
+ None, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_next_chapter
+ libvlc_media_player_next_chapter = f
+ return f(p_mi)
+
+def libvlc_media_player_get_rate(p_mi):
+ '''Get the requested movie play rate.
+ @warning: Depending on the underlying media, the requested rate may be
+ different from the real playback rate.
+ @param p_mi: the Media Player.
+ @return: movie play rate.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_get_rate', None) or \
+ _Cfunction('libvlc_media_player_get_rate', ((1,),), None,
+ ctypes.c_float, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_get_rate
+ libvlc_media_player_get_rate = f
+ return f(p_mi)
+
+def libvlc_media_player_set_rate(p_mi, rate):
+ '''Set movie play rate.
+ @param p_mi: the Media Player.
+ @param rate: movie play rate to set.
+ @return: -1 if an error was detected, 0 otherwise (but even then, it might not actually work depending on the underlying media protocol).
+ '''
+ f = _Cfunctions.get('libvlc_media_player_set_rate', None) or \
+ _Cfunction('libvlc_media_player_set_rate', ((1,), (1,),), None,
+ ctypes.c_int, MediaPlayer, ctypes.c_float)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_set_rate
+ libvlc_media_player_set_rate = f
+ return f(p_mi, rate)
+
+def libvlc_media_player_get_state(p_mi):
+ '''Get current movie state.
+ @param p_mi: the Media Player.
+ @return: the current state of the media player (playing, paused, ...) See libvlc_state_t.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_get_state', None) or \
+ _Cfunction('libvlc_media_player_get_state', ((1,),), None,
+ State, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_get_state
+ libvlc_media_player_get_state = f
+ return f(p_mi)
+
+def libvlc_media_player_get_fps(p_mi):
+ '''Get movie fps rate.
+ @param p_mi: the Media Player.
+ @return: frames per second (fps) for this playing movie, or 0 if unspecified.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_get_fps', None) or \
+ _Cfunction('libvlc_media_player_get_fps', ((1,),), None,
+ ctypes.c_float, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_get_fps
+ libvlc_media_player_get_fps = f
+ return f(p_mi)
+
+def libvlc_media_player_has_vout(p_mi):
+ '''How many video outputs does this media player have?
+ @param p_mi: the media player.
+ @return: the number of video outputs.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_has_vout', None) or \
+ _Cfunction('libvlc_media_player_has_vout', ((1,),), None,
+ ctypes.c_uint, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_has_vout
+ libvlc_media_player_has_vout = f
+ return f(p_mi)
+
+def libvlc_media_player_is_seekable(p_mi):
+ '''Is this media player seekable?
+ @param p_mi: the media player.
+ @return: true if the media player can seek \libvlc_return_bool.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_is_seekable', None) or \
+ _Cfunction('libvlc_media_player_is_seekable', ((1,),), None,
+ ctypes.c_int, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_is_seekable
+ libvlc_media_player_is_seekable = f
+ return f(p_mi)
+
+def libvlc_media_player_can_pause(p_mi):
+ '''Can this media player be paused?
+ @param p_mi: the media player.
+ @return: true if the media player can pause \libvlc_return_bool.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_can_pause', None) or \
+ _Cfunction('libvlc_media_player_can_pause', ((1,),), None,
+ ctypes.c_int, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_can_pause
+ libvlc_media_player_can_pause = f
+ return f(p_mi)
+
+def libvlc_media_player_next_frame(p_mi):
+ '''Display the next frame (if supported).
+ @param p_mi: the media player.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_next_frame', None) or \
+ _Cfunction('libvlc_media_player_next_frame', ((1,),), None,
+ None, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_next_frame
+ libvlc_media_player_next_frame = f
+ return f(p_mi)
+
+def libvlc_media_player_navigate(p_mi, navigate):
+ '''Navigate through DVD Menu.
+ @param p_mi: the Media Player.
+ @param navigate: the Navigation mode.
+ @version: libVLC 1.2.0 or later.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_navigate', None) or \
+ _Cfunction('libvlc_media_player_navigate', ((1,), (1,),), None,
+ None, MediaPlayer, ctypes.c_uint)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_media_player_navigate
+ libvlc_media_player_navigate = f
+ return f(p_mi, navigate)
+
+def libvlc_track_description_release(p_track_description):
+ '''Release (free) L{TrackDescription}.
+ @param p_track_description: the structure to release.
+ '''
+ f = _Cfunctions.get('libvlc_track_description_release', None) or \
+ _Cfunction('libvlc_track_description_release', ((1,),), None,
+ None, ctypes.POINTER(TrackDescription))
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_track_description_release
+ libvlc_track_description_release = f
+ return f(p_track_description)
+
+def libvlc_toggle_fullscreen(p_mi):
+ '''Toggle fullscreen status on non-embedded video outputs.
+ @warning: The same limitations applies to this function
+ as to L{libvlc_set_fullscreen}().
+ @param p_mi: the media player.
+ '''
+ f = _Cfunctions.get('libvlc_toggle_fullscreen', None) or \
+ _Cfunction('libvlc_toggle_fullscreen', ((1,),), None,
+ None, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_toggle_fullscreen
+ libvlc_toggle_fullscreen = f
+ return f(p_mi)
+
+def libvlc_set_fullscreen(p_mi, b_fullscreen):
+ '''Enable or disable fullscreen.
+ @warning: With most window managers, only a top-level windows can be in
+ full-screen mode. Hence, this function will not operate properly if
+ L{libvlc_media_player_set_xwindow}() was used to embed the video in a
+ non-top-level window. In that case, the embedding window must be reparented
+ to the root window B{before} fullscreen mode is enabled. You will want
+ to reparent it back to its normal parent when disabling fullscreen.
+ @param p_mi: the media player.
+ @param b_fullscreen: boolean for fullscreen status.
+ '''
+ f = _Cfunctions.get('libvlc_set_fullscreen', None) or \
+ _Cfunction('libvlc_set_fullscreen', ((1,), (1,),), None,
+ None, MediaPlayer, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_set_fullscreen
+ libvlc_set_fullscreen = f
+ return f(p_mi, b_fullscreen)
+
+def libvlc_get_fullscreen(p_mi):
+ '''Get current fullscreen status.
+ @param p_mi: the media player.
+ @return: the fullscreen status (boolean) \libvlc_return_bool.
+ '''
+ f = _Cfunctions.get('libvlc_get_fullscreen', None) or \
+ _Cfunction('libvlc_get_fullscreen', ((1,),), None,
+ ctypes.c_int, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_get_fullscreen
+ libvlc_get_fullscreen = f
+ return f(p_mi)
+
+def libvlc_video_set_key_input(p_mi, on):
+ '''Enable or disable key press events handling, according to the LibVLC hotkeys
+ configuration. By default and for historical reasons, keyboard events are
+ handled by the LibVLC video widget.
+ @note: On X11, there can be only one subscriber for key press and mouse
+ click events per window. If your application has subscribed to those events
+ for the X window ID of the video widget, then LibVLC will not be able to
+ handle key presses and mouse clicks in any case.
+ @warning: This function is only implemented for X11 and Win32 at the moment.
+ @param p_mi: the media player.
+ @param on: true to handle key press events, false to ignore them.
+ '''
+ f = _Cfunctions.get('libvlc_video_set_key_input', None) or \
+ _Cfunction('libvlc_video_set_key_input', ((1,), (1,),), None,
+ None, MediaPlayer, ctypes.c_uint)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_set_key_input
+ libvlc_video_set_key_input = f
+ return f(p_mi, on)
+
+def libvlc_video_set_mouse_input(p_mi, on):
+ '''Enable or disable mouse click events handling. By default, those events are
+ handled. This is needed for DVD menus to work, as well as a few video
+ filters such as "puzzle".
+ See L{libvlc_video_set_key_input}().
+ @warning: This function is only implemented for X11 and Win32 at the moment.
+ @param p_mi: the media player.
+ @param on: true to handle mouse click events, false to ignore them.
+ '''
+ f = _Cfunctions.get('libvlc_video_set_mouse_input', None) or \
+ _Cfunction('libvlc_video_set_mouse_input', ((1,), (1,),), None,
+ None, MediaPlayer, ctypes.c_uint)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_set_mouse_input
+ libvlc_video_set_mouse_input = f
+ return f(p_mi, on)
+
+def libvlc_video_get_size(p_mi, num):
+ '''Get the pixel dimensions of a video.
+ @param p_mi: media player.
+ @param num: number of the video (starting from, and most commonly 0).
+ @return: px pixel width, py pixel height.
+ '''
+ f = _Cfunctions.get('libvlc_video_get_size', None) or \
+ _Cfunction('libvlc_video_get_size', ((1,), (1,), (2,), (2,),), None,
+ ctypes.c_int, MediaPlayer, ctypes.c_uint, ctypes.POINTER(ctypes.c_uint), ctypes.POINTER(ctypes.c_uint))
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_get_size
+ libvlc_video_get_size = f
+ return f(p_mi, num)
+
+def libvlc_video_get_cursor(p_mi, num):
+ '''Get the mouse pointer coordinates over a video.
+ Coordinates are expressed in terms of the decoded video resolution,
+ B{not} in terms of pixels on the screen/viewport (to get the latter,
+ you can query your windowing system directly).
+ Either of the coordinates may be negative or larger than the corresponding
+ dimension of the video, if the cursor is outside the rendering area.
+ @warning: The coordinates may be out-of-date if the pointer is not located
+ on the video rendering area. LibVLC does not track the pointer if it is
+ outside of the video widget.
+ @note: LibVLC does not support multiple pointers (it does of course support
+ multiple input devices sharing the same pointer) at the moment.
+ @param p_mi: media player.
+ @param num: number of the video (starting from, and most commonly 0).
+ @return: px abscissa, py ordinate.
+ '''
+ f = _Cfunctions.get('libvlc_video_get_cursor', None) or \
+ _Cfunction('libvlc_video_get_cursor', ((1,), (1,), (2,), (2,),), None,
+ ctypes.c_int, MediaPlayer, ctypes.c_uint, ctypes.POINTER(ctypes.c_int), ctypes.POINTER(ctypes.c_int))
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_get_cursor
+ libvlc_video_get_cursor = f
+ return f(p_mi, num)
+
+def libvlc_video_get_scale(p_mi):
+ '''Get the current video scaling factor.
+ See also L{libvlc_video_set_scale}().
+ @param p_mi: the media player.
+ @return: the currently configured zoom factor, or 0. if the video is set to fit to the output window/drawable automatically.
+ '''
+ f = _Cfunctions.get('libvlc_video_get_scale', None) or \
+ _Cfunction('libvlc_video_get_scale', ((1,),), None,
+ ctypes.c_float, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_get_scale
+ libvlc_video_get_scale = f
+ return f(p_mi)
+
+def libvlc_video_set_scale(p_mi, f_factor):
+ '''Set the video scaling factor. That is the ratio of the number of pixels on
+ screen to the number of pixels in the original decoded video in each
+ dimension. Zero is a special value; it will adjust the video to the output
+ window/drawable (in windowed mode) or the entire screen.
+ Note that not all video outputs support scaling.
+ @param p_mi: the media player.
+ @param f_factor: the scaling factor, or zero.
+ '''
+ f = _Cfunctions.get('libvlc_video_set_scale', None) or \
+ _Cfunction('libvlc_video_set_scale', ((1,), (1,),), None,
+ None, MediaPlayer, ctypes.c_float)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_set_scale
+ libvlc_video_set_scale = f
+ return f(p_mi, f_factor)
+
+def libvlc_video_get_aspect_ratio(p_mi):
+ '''Get current video aspect ratio.
+ @param p_mi: the media player.
+ @return: the video aspect ratio or NULL if unspecified (the result must be released with free() or L{libvlc_free}()).
+ '''
+ f = _Cfunctions.get('libvlc_video_get_aspect_ratio', None) or \
+ _Cfunction('libvlc_video_get_aspect_ratio', ((1,),), string_result,
+ ctypes.c_void_p, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_get_aspect_ratio
+ libvlc_video_get_aspect_ratio = f
+ return f(p_mi)
+
+def libvlc_video_set_aspect_ratio(p_mi, psz_aspect):
+ '''Set new video aspect ratio.
+ @param p_mi: the media player.
+ @param psz_aspect: new video aspect-ratio or NULL to reset to default @note Invalid aspect ratios are ignored.
+ '''
+ f = _Cfunctions.get('libvlc_video_set_aspect_ratio', None) or \
+ _Cfunction('libvlc_video_set_aspect_ratio', ((1,), (1,),), None,
+ None, MediaPlayer, ctypes.c_char_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_set_aspect_ratio
+ libvlc_video_set_aspect_ratio = f
+ return f(p_mi, psz_aspect)
+
+def libvlc_video_get_spu(p_mi):
+ '''Get current video subtitle.
+ @param p_mi: the media player.
+ @return: the video subtitle selected, or -1 if none.
+ '''
+ f = _Cfunctions.get('libvlc_video_get_spu', None) or \
+ _Cfunction('libvlc_video_get_spu', ((1,),), None,
+ ctypes.c_int, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_get_spu
+ libvlc_video_get_spu = f
+ return f(p_mi)
+
+def libvlc_video_get_spu_count(p_mi):
+ '''Get the number of available video subtitles.
+ @param p_mi: the media player.
+ @return: the number of available video subtitles.
+ '''
+ f = _Cfunctions.get('libvlc_video_get_spu_count', None) or \
+ _Cfunction('libvlc_video_get_spu_count', ((1,),), None,
+ ctypes.c_int, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_get_spu_count
+ libvlc_video_get_spu_count = f
+ return f(p_mi)
+
+def libvlc_video_get_spu_description(p_mi):
+ '''Get the description of available video subtitles.
+ @param p_mi: the media player.
+ @return: list containing description of available video subtitles.
+ '''
+ f = _Cfunctions.get('libvlc_video_get_spu_description', None) or \
+ _Cfunction('libvlc_video_get_spu_description', ((1,),), None,
+ ctypes.POINTER(TrackDescription), MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_get_spu_description
+ libvlc_video_get_spu_description = f
+ return f(p_mi)
+
+def libvlc_video_set_spu(p_mi, i_spu):
+ '''Set new video subtitle.
+ @param p_mi: the media player.
+ @param i_spu: new video subtitle to select.
+ @return: 0 on success, -1 if out of range.
+ '''
+ f = _Cfunctions.get('libvlc_video_set_spu', None) or \
+ _Cfunction('libvlc_video_set_spu', ((1,), (1,),), None,
+ ctypes.c_int, MediaPlayer, ctypes.c_uint)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_set_spu
+ libvlc_video_set_spu = f
+ return f(p_mi, i_spu)
+
+def libvlc_video_set_subtitle_file(p_mi, psz_subtitle):
+ '''Set new video subtitle file.
+ @param p_mi: the media player.
+ @param psz_subtitle: new video subtitle file.
+ @return: the success status (boolean).
+ '''
+ f = _Cfunctions.get('libvlc_video_set_subtitle_file', None) or \
+ _Cfunction('libvlc_video_set_subtitle_file', ((1,), (1,),), None,
+ ctypes.c_int, MediaPlayer, ctypes.c_char_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_set_subtitle_file
+ libvlc_video_set_subtitle_file = f
+ return f(p_mi, psz_subtitle)
+
+def libvlc_video_get_title_description(p_mi):
+ '''Get the description of available titles.
+ @param p_mi: the media player.
+ @return: list containing description of available titles.
+ '''
+ f = _Cfunctions.get('libvlc_video_get_title_description', None) or \
+ _Cfunction('libvlc_video_get_title_description', ((1,),), None,
+ ctypes.POINTER(TrackDescription), MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_get_title_description
+ libvlc_video_get_title_description = f
+ return f(p_mi)
+
+def libvlc_video_get_chapter_description(p_mi, i_title):
+ '''Get the description of available chapters for specific title.
+ @param p_mi: the media player.
+ @param i_title: selected title.
+ @return: list containing description of available chapter for title i_title.
+ '''
+ f = _Cfunctions.get('libvlc_video_get_chapter_description', None) or \
+ _Cfunction('libvlc_video_get_chapter_description', ((1,), (1,),), None,
+ ctypes.POINTER(TrackDescription), MediaPlayer, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_get_chapter_description
+ libvlc_video_get_chapter_description = f
+ return f(p_mi, i_title)
+
+def libvlc_video_get_crop_geometry(p_mi):
+ '''Get current crop filter geometry.
+ @param p_mi: the media player.
+ @return: the crop filter geometry or NULL if unset.
+ '''
+ f = _Cfunctions.get('libvlc_video_get_crop_geometry', None) or \
+ _Cfunction('libvlc_video_get_crop_geometry', ((1,),), string_result,
+ ctypes.c_void_p, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_get_crop_geometry
+ libvlc_video_get_crop_geometry = f
+ return f(p_mi)
+
+def libvlc_video_set_crop_geometry(p_mi, psz_geometry):
+ '''Set new crop filter geometry.
+ @param p_mi: the media player.
+ @param psz_geometry: new crop filter geometry (NULL to unset).
+ '''
+ f = _Cfunctions.get('libvlc_video_set_crop_geometry', None) or \
+ _Cfunction('libvlc_video_set_crop_geometry', ((1,), (1,),), None,
+ None, MediaPlayer, ctypes.c_char_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_set_crop_geometry
+ libvlc_video_set_crop_geometry = f
+ return f(p_mi, psz_geometry)
+
+def libvlc_video_get_teletext(p_mi):
+ '''Get current teletext page requested.
+ @param p_mi: the media player.
+ @return: the current teletext page requested.
+ '''
+ f = _Cfunctions.get('libvlc_video_get_teletext', None) or \
+ _Cfunction('libvlc_video_get_teletext', ((1,),), None,
+ ctypes.c_int, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_get_teletext
+ libvlc_video_get_teletext = f
+ return f(p_mi)
+
+def libvlc_video_set_teletext(p_mi, i_page):
+ '''Set new teletext page to retrieve.
+ @param p_mi: the media player.
+ @param i_page: teletex page number requested.
+ '''
+ f = _Cfunctions.get('libvlc_video_set_teletext', None) or \
+ _Cfunction('libvlc_video_set_teletext', ((1,), (1,),), None,
+ None, MediaPlayer, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_set_teletext
+ libvlc_video_set_teletext = f
+ return f(p_mi, i_page)
+
+def libvlc_toggle_teletext(p_mi):
+ '''Toggle teletext transparent status on video output.
+ @param p_mi: the media player.
+ '''
+ f = _Cfunctions.get('libvlc_toggle_teletext', None) or \
+ _Cfunction('libvlc_toggle_teletext', ((1,),), None,
+ None, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_toggle_teletext
+ libvlc_toggle_teletext = f
+ return f(p_mi)
+
+def libvlc_video_get_track_count(p_mi):
+ '''Get number of available video tracks.
+ @param p_mi: media player.
+ @return: the number of available video tracks (int).
+ '''
+ f = _Cfunctions.get('libvlc_video_get_track_count', None) or \
+ _Cfunction('libvlc_video_get_track_count', ((1,),), None,
+ ctypes.c_int, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_get_track_count
+ libvlc_video_get_track_count = f
+ return f(p_mi)
+
+def libvlc_video_get_track_description(p_mi):
+ '''Get the description of available video tracks.
+ @param p_mi: media player.
+ @return: list with description of available video tracks, or NULL on error.
+ '''
+ f = _Cfunctions.get('libvlc_video_get_track_description', None) or \
+ _Cfunction('libvlc_video_get_track_description', ((1,),), None,
+ ctypes.POINTER(TrackDescription), MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_get_track_description
+ libvlc_video_get_track_description = f
+ return f(p_mi)
+
+def libvlc_video_get_track(p_mi):
+ '''Get current video track.
+ @param p_mi: media player.
+ @return: the video track (int) or -1 if none.
+ '''
+ f = _Cfunctions.get('libvlc_video_get_track', None) or \
+ _Cfunction('libvlc_video_get_track', ((1,),), None,
+ ctypes.c_int, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_get_track
+ libvlc_video_get_track = f
+ return f(p_mi)
+
+def libvlc_video_set_track(p_mi, i_track):
+ '''Set video track.
+ @param p_mi: media player.
+ @param i_track: the track (int).
+ @return: 0 on success, -1 if out of range.
+ '''
+ f = _Cfunctions.get('libvlc_video_set_track', None) or \
+ _Cfunction('libvlc_video_set_track', ((1,), (1,),), None,
+ ctypes.c_int, MediaPlayer, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_set_track
+ libvlc_video_set_track = f
+ return f(p_mi, i_track)
+
+def libvlc_video_take_snapshot(p_mi, num, psz_filepath, i_width, i_height):
+ '''Take a snapshot of the current video window.
+ If i_width AND i_height is 0, original size is used.
+ If i_width XOR i_height is 0, original aspect-ratio is preserved.
+ @param p_mi: media player instance.
+ @param num: number of video output (typically 0 for the first/only one).
+ @param psz_filepath: the path where to save the screenshot to.
+ @param i_width: the snapshot's width.
+ @param i_height: the snapshot's height.
+ @return: 0 on success, -1 if the video was not found.
+ '''
+ f = _Cfunctions.get('libvlc_video_take_snapshot', None) or \
+ _Cfunction('libvlc_video_take_snapshot', ((1,), (1,), (1,), (1,), (1,),), None,
+ ctypes.c_int, MediaPlayer, ctypes.c_uint, ctypes.c_char_p, ctypes.c_int, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_take_snapshot
+ libvlc_video_take_snapshot = f
+ return f(p_mi, num, psz_filepath, i_width, i_height)
+
+def libvlc_video_set_deinterlace(p_mi, psz_mode):
+ '''Enable or disable deinterlace filter.
+ @param p_mi: libvlc media player.
+ @param psz_mode: type of deinterlace filter, NULL to disable.
+ '''
+ f = _Cfunctions.get('libvlc_video_set_deinterlace', None) or \
+ _Cfunction('libvlc_video_set_deinterlace', ((1,), (1,),), None,
+ None, MediaPlayer, ctypes.c_char_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_set_deinterlace
+ libvlc_video_set_deinterlace = f
+ return f(p_mi, psz_mode)
+
+def libvlc_video_get_marquee_int(p_mi, option):
+ '''Get an integer marquee option value.
+ @param p_mi: libvlc media player.
+ @param option: marq option to get See libvlc_video_marquee_int_option_t.
+ '''
+ f = _Cfunctions.get('libvlc_video_get_marquee_int', None) or \
+ _Cfunction('libvlc_video_get_marquee_int', ((1,), (1,),), None,
+ ctypes.c_int, MediaPlayer, ctypes.c_uint)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_get_marquee_int
+ libvlc_video_get_marquee_int = f
+ return f(p_mi, option)
+
+def libvlc_video_get_marquee_string(p_mi, option):
+ '''Get a string marquee option value.
+ @param p_mi: libvlc media player.
+ @param option: marq option to get See libvlc_video_marquee_string_option_t.
+ '''
+ f = _Cfunctions.get('libvlc_video_get_marquee_string', None) or \
+ _Cfunction('libvlc_video_get_marquee_string', ((1,), (1,),), string_result,
+ ctypes.c_void_p, MediaPlayer, ctypes.c_uint)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_get_marquee_string
+ libvlc_video_get_marquee_string = f
+ return f(p_mi, option)
+
+def libvlc_video_set_marquee_int(p_mi, option, i_val):
+ '''Enable, disable or set an integer marquee option
+ Setting libvlc_marquee_Enable has the side effect of enabling (arg !0)
+ or disabling (arg 0) the marq filter.
+ @param p_mi: libvlc media player.
+ @param option: marq option to set See libvlc_video_marquee_int_option_t.
+ @param i_val: marq option value.
+ '''
+ f = _Cfunctions.get('libvlc_video_set_marquee_int', None) or \
+ _Cfunction('libvlc_video_set_marquee_int', ((1,), (1,), (1,),), None,
+ None, MediaPlayer, ctypes.c_uint, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_set_marquee_int
+ libvlc_video_set_marquee_int = f
+ return f(p_mi, option, i_val)
+
+def libvlc_video_set_marquee_string(p_mi, option, psz_text):
+ '''Set a marquee string option.
+ @param p_mi: libvlc media player.
+ @param option: marq option to set See libvlc_video_marquee_string_option_t.
+ @param psz_text: marq option value.
+ '''
+ f = _Cfunctions.get('libvlc_video_set_marquee_string', None) or \
+ _Cfunction('libvlc_video_set_marquee_string', ((1,), (1,), (1,),), None,
+ None, MediaPlayer, ctypes.c_uint, ctypes.c_char_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_set_marquee_string
+ libvlc_video_set_marquee_string = f
+ return f(p_mi, option, psz_text)
+
+def libvlc_video_get_logo_int(p_mi, option):
+ '''Get integer logo option.
+ @param p_mi: libvlc media player instance.
+ @param option: logo option to get, values of libvlc_video_logo_option_t.
+ '''
+ f = _Cfunctions.get('libvlc_video_get_logo_int', None) or \
+ _Cfunction('libvlc_video_get_logo_int', ((1,), (1,),), None,
+ ctypes.c_int, MediaPlayer, ctypes.c_uint)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_get_logo_int
+ libvlc_video_get_logo_int = f
+ return f(p_mi, option)
+
+def libvlc_video_set_logo_int(p_mi, option, value):
+ '''Set logo option as integer. Options that take a different type value
+ are ignored.
+ Passing libvlc_logo_enable as option value has the side effect of
+ starting (arg !0) or stopping (arg 0) the logo filter.
+ @param p_mi: libvlc media player instance.
+ @param option: logo option to set, values of libvlc_video_logo_option_t.
+ @param value: logo option value.
+ '''
+ f = _Cfunctions.get('libvlc_video_set_logo_int', None) or \
+ _Cfunction('libvlc_video_set_logo_int', ((1,), (1,), (1,),), None,
+ None, MediaPlayer, ctypes.c_uint, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_set_logo_int
+ libvlc_video_set_logo_int = f
+ return f(p_mi, option, value)
+
+def libvlc_video_set_logo_string(p_mi, option, psz_value):
+ '''Set logo option as string. Options that take a different type value
+ are ignored.
+ @param p_mi: libvlc media player instance.
+ @param option: logo option to set, values of libvlc_video_logo_option_t.
+ @param psz_value: logo option value.
+ '''
+ f = _Cfunctions.get('libvlc_video_set_logo_string', None) or \
+ _Cfunction('libvlc_video_set_logo_string', ((1,), (1,), (1,),), None,
+ None, MediaPlayer, ctypes.c_uint, ctypes.c_char_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_set_logo_string
+ libvlc_video_set_logo_string = f
+ return f(p_mi, option, psz_value)
+
+def libvlc_video_get_adjust_int(p_mi, option):
+ '''Get integer adjust option.
+ @param p_mi: libvlc media player instance.
+ @param option: adjust option to get, values of libvlc_video_adjust_option_t.
+ @version: LibVLC 1.1.1 and later.
+ '''
+ f = _Cfunctions.get('libvlc_video_get_adjust_int', None) or \
+ _Cfunction('libvlc_video_get_adjust_int', ((1,), (1,),), None,
+ ctypes.c_int, MediaPlayer, ctypes.c_uint)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_get_adjust_int
+ libvlc_video_get_adjust_int = f
+ return f(p_mi, option)
+
+def libvlc_video_set_adjust_int(p_mi, option, value):
+ '''Set adjust option as integer. Options that take a different type value
+ are ignored.
+ Passing libvlc_adjust_enable as option value has the side effect of
+ starting (arg !0) or stopping (arg 0) the adjust filter.
+ @param p_mi: libvlc media player instance.
+ @param option: adust option to set, values of libvlc_video_adjust_option_t.
+ @param value: adjust option value.
+ @version: LibVLC 1.1.1 and later.
+ '''
+ f = _Cfunctions.get('libvlc_video_set_adjust_int', None) or \
+ _Cfunction('libvlc_video_set_adjust_int', ((1,), (1,), (1,),), None,
+ None, MediaPlayer, ctypes.c_uint, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_set_adjust_int
+ libvlc_video_set_adjust_int = f
+ return f(p_mi, option, value)
+
+def libvlc_video_get_adjust_float(p_mi, option):
+ '''Get float adjust option.
+ @param p_mi: libvlc media player instance.
+ @param option: adjust option to get, values of libvlc_video_adjust_option_t.
+ @version: LibVLC 1.1.1 and later.
+ '''
+ f = _Cfunctions.get('libvlc_video_get_adjust_float', None) or \
+ _Cfunction('libvlc_video_get_adjust_float', ((1,), (1,),), None,
+ ctypes.c_float, MediaPlayer, ctypes.c_uint)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_get_adjust_float
+ libvlc_video_get_adjust_float = f
+ return f(p_mi, option)
+
+def libvlc_video_set_adjust_float(p_mi, option, value):
+ '''Set adjust option as float. Options that take a different type value
+ are ignored.
+ @param p_mi: libvlc media player instance.
+ @param option: adust option to set, values of libvlc_video_adjust_option_t.
+ @param value: adjust option value.
+ @version: LibVLC 1.1.1 and later.
+ '''
+ f = _Cfunctions.get('libvlc_video_set_adjust_float', None) or \
+ _Cfunction('libvlc_video_set_adjust_float', ((1,), (1,), (1,),), None,
+ None, MediaPlayer, ctypes.c_uint, ctypes.c_float)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_video_set_adjust_float
+ libvlc_video_set_adjust_float = f
+ return f(p_mi, option, value)
+
+def libvlc_audio_output_list_get(p_instance):
+ '''Get the list of available audio outputs.
+ @param p_instance: libvlc instance.
+ @return: list of available audio outputs. It must be freed it with In case of error, NULL is returned.
+ '''
+ f = _Cfunctions.get('libvlc_audio_output_list_get', None) or \
+ _Cfunction('libvlc_audio_output_list_get', ((1,),), None,
+ ctypes.POINTER(AudioOutput), Instance)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_audio_output_list_get
+ libvlc_audio_output_list_get = f
+ return f(p_instance)
+
+def libvlc_audio_output_list_release(p_list):
+ '''Free the list of available audio outputs.
+ @param p_list: list with audio outputs for release.
+ '''
+ f = _Cfunctions.get('libvlc_audio_output_list_release', None) or \
+ _Cfunction('libvlc_audio_output_list_release', ((1,),), None,
+ None, ctypes.POINTER(AudioOutput))
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_audio_output_list_release
+ libvlc_audio_output_list_release = f
+ return f(p_list)
+
+def libvlc_audio_output_set(p_mi, psz_name):
+ '''Set the audio output.
+ Change will be applied after stop and play.
+ @param p_mi: media player.
+ @param psz_name: name of audio output, use psz_name of See L{AudioOutput}.
+ @return: 0 if function succeded, -1 on error.
+ '''
+ f = _Cfunctions.get('libvlc_audio_output_set', None) or \
+ _Cfunction('libvlc_audio_output_set', ((1,), (1,),), None,
+ ctypes.c_int, MediaPlayer, ctypes.c_char_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_audio_output_set
+ libvlc_audio_output_set = f
+ return f(p_mi, psz_name)
+
+def libvlc_audio_output_device_count(p_instance, psz_audio_output):
+ '''Get count of devices for audio output, these devices are hardware oriented
+ like analor or digital output of sound card.
+ @param p_instance: libvlc instance.
+ @param psz_audio_output: - name of audio output, See L{AudioOutput}.
+ @return: number of devices.
+ '''
+ f = _Cfunctions.get('libvlc_audio_output_device_count', None) or \
+ _Cfunction('libvlc_audio_output_device_count', ((1,), (1,),), None,
+ ctypes.c_int, Instance, ctypes.c_char_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_audio_output_device_count
+ libvlc_audio_output_device_count = f
+ return f(p_instance, psz_audio_output)
+
+def libvlc_audio_output_device_longname(p_instance, psz_audio_output, i_device):
+ '''Get long name of device, if not available short name given.
+ @param p_instance: libvlc instance.
+ @param psz_audio_output: - name of audio output, See L{AudioOutput}.
+ @param i_device: device index.
+ @return: long name of device.
+ '''
+ f = _Cfunctions.get('libvlc_audio_output_device_longname', None) or \
+ _Cfunction('libvlc_audio_output_device_longname', ((1,), (1,), (1,),), string_result,
+ ctypes.c_void_p, Instance, ctypes.c_char_p, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_audio_output_device_longname
+ libvlc_audio_output_device_longname = f
+ return f(p_instance, psz_audio_output, i_device)
+
+def libvlc_audio_output_device_id(p_instance, psz_audio_output, i_device):
+ '''Get id name of device.
+ @param p_instance: libvlc instance.
+ @param psz_audio_output: - name of audio output, See L{AudioOutput}.
+ @param i_device: device index.
+ @return: id name of device, use for setting device, need to be free after use.
+ '''
+ f = _Cfunctions.get('libvlc_audio_output_device_id', None) or \
+ _Cfunction('libvlc_audio_output_device_id', ((1,), (1,), (1,),), string_result,
+ ctypes.c_void_p, Instance, ctypes.c_char_p, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_audio_output_device_id
+ libvlc_audio_output_device_id = f
+ return f(p_instance, psz_audio_output, i_device)
+
+def libvlc_audio_output_device_set(p_mi, psz_audio_output, psz_device_id):
+ '''Set audio output device. Changes are only effective after stop and play.
+ @param p_mi: media player.
+ @param psz_audio_output: - name of audio output, See L{AudioOutput}.
+ @param psz_device_id: device.
+ '''
+ f = _Cfunctions.get('libvlc_audio_output_device_set', None) or \
+ _Cfunction('libvlc_audio_output_device_set', ((1,), (1,), (1,),), None,
+ None, MediaPlayer, ctypes.c_char_p, ctypes.c_char_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_audio_output_device_set
+ libvlc_audio_output_device_set = f
+ return f(p_mi, psz_audio_output, psz_device_id)
+
+def libvlc_audio_output_get_device_type(p_mi):
+ '''Get current audio device type. Device type describes something like
+ character of output sound - stereo sound, 2.1, 5.1 etc.
+ @param p_mi: media player.
+ @return: the audio devices type See libvlc_audio_output_device_types_t.
+ '''
+ f = _Cfunctions.get('libvlc_audio_output_get_device_type', None) or \
+ _Cfunction('libvlc_audio_output_get_device_type', ((1,),), None,
+ ctypes.c_int, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_audio_output_get_device_type
+ libvlc_audio_output_get_device_type = f
+ return f(p_mi)
+
+def libvlc_audio_output_set_device_type(p_mi, device_type):
+ '''Set current audio device type.
+ @param p_mi: vlc instance.
+ @param device_type: the audio device type,
+ '''
+ f = _Cfunctions.get('libvlc_audio_output_set_device_type', None) or \
+ _Cfunction('libvlc_audio_output_set_device_type', ((1,), (1,),), None,
+ None, MediaPlayer, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_audio_output_set_device_type
+ libvlc_audio_output_set_device_type = f
+ return f(p_mi, device_type)
+
+def libvlc_audio_toggle_mute(p_mi):
+ '''Toggle mute status.
+ @param p_mi: media player.
+ '''
+ f = _Cfunctions.get('libvlc_audio_toggle_mute', None) or \
+ _Cfunction('libvlc_audio_toggle_mute', ((1,),), None,
+ None, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_audio_toggle_mute
+ libvlc_audio_toggle_mute = f
+ return f(p_mi)
+
+def libvlc_audio_get_mute(p_mi):
+ '''Get current mute status.
+ @param p_mi: media player.
+ @return: the mute status (boolean) \libvlc_return_bool.
+ '''
+ f = _Cfunctions.get('libvlc_audio_get_mute', None) or \
+ _Cfunction('libvlc_audio_get_mute', ((1,),), None,
+ ctypes.c_int, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_audio_get_mute
+ libvlc_audio_get_mute = f
+ return f(p_mi)
+
+def libvlc_audio_set_mute(p_mi, status):
+ '''Set mute status.
+ @param p_mi: media player.
+ @param status: If status is true then mute, otherwise unmute.
+ '''
+ f = _Cfunctions.get('libvlc_audio_set_mute', None) or \
+ _Cfunction('libvlc_audio_set_mute', ((1,), (1,),), None,
+ None, MediaPlayer, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_audio_set_mute
+ libvlc_audio_set_mute = f
+ return f(p_mi, status)
+
+def libvlc_audio_get_volume(p_mi):
+ '''Get current software audio volume.
+ @param p_mi: media player.
+ @return: the software volume in percents (0 = mute, 100 = nominal / 0dB).
+ '''
+ f = _Cfunctions.get('libvlc_audio_get_volume', None) or \
+ _Cfunction('libvlc_audio_get_volume', ((1,),), None,
+ ctypes.c_int, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_audio_get_volume
+ libvlc_audio_get_volume = f
+ return f(p_mi)
+
+def libvlc_audio_set_volume(p_mi, i_volume):
+ '''Set current software audio volume.
+ @param p_mi: media player.
+ @param i_volume: the volume in percents (0 = mute, 100 = 0dB).
+ @return: 0 if the volume was set, -1 if it was out of range.
+ '''
+ f = _Cfunctions.get('libvlc_audio_set_volume', None) or \
+ _Cfunction('libvlc_audio_set_volume', ((1,), (1,),), None,
+ ctypes.c_int, MediaPlayer, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_audio_set_volume
+ libvlc_audio_set_volume = f
+ return f(p_mi, i_volume)
+
+def libvlc_audio_get_track_count(p_mi):
+ '''Get number of available audio tracks.
+ @param p_mi: media player.
+ @return: the number of available audio tracks (int), or -1 if unavailable.
+ '''
+ f = _Cfunctions.get('libvlc_audio_get_track_count', None) or \
+ _Cfunction('libvlc_audio_get_track_count', ((1,),), None,
+ ctypes.c_int, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_audio_get_track_count
+ libvlc_audio_get_track_count = f
+ return f(p_mi)
+
+def libvlc_audio_get_track_description(p_mi):
+ '''Get the description of available audio tracks.
+ @param p_mi: media player.
+ @return: list with description of available audio tracks, or NULL.
+ '''
+ f = _Cfunctions.get('libvlc_audio_get_track_description', None) or \
+ _Cfunction('libvlc_audio_get_track_description', ((1,),), None,
+ ctypes.POINTER(TrackDescription), MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_audio_get_track_description
+ libvlc_audio_get_track_description = f
+ return f(p_mi)
+
+def libvlc_audio_get_track(p_mi):
+ '''Get current audio track.
+ @param p_mi: media player.
+ @return: the audio track (int), or -1 if none.
+ '''
+ f = _Cfunctions.get('libvlc_audio_get_track', None) or \
+ _Cfunction('libvlc_audio_get_track', ((1,),), None,
+ ctypes.c_int, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_audio_get_track
+ libvlc_audio_get_track = f
+ return f(p_mi)
+
+def libvlc_audio_set_track(p_mi, i_track):
+ '''Set current audio track.
+ @param p_mi: media player.
+ @param i_track: the track (int).
+ @return: 0 on success, -1 on error.
+ '''
+ f = _Cfunctions.get('libvlc_audio_set_track', None) or \
+ _Cfunction('libvlc_audio_set_track', ((1,), (1,),), None,
+ ctypes.c_int, MediaPlayer, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_audio_set_track
+ libvlc_audio_set_track = f
+ return f(p_mi, i_track)
+
+def libvlc_audio_get_channel(p_mi):
+ '''Get current audio channel.
+ @param p_mi: media player.
+ @return: the audio channel See libvlc_audio_output_channel_t.
+ '''
+ f = _Cfunctions.get('libvlc_audio_get_channel', None) or \
+ _Cfunction('libvlc_audio_get_channel', ((1,),), None,
+ ctypes.c_int, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_audio_get_channel
+ libvlc_audio_get_channel = f
+ return f(p_mi)
+
+def libvlc_audio_set_channel(p_mi, channel):
+ '''Set current audio channel.
+ @param p_mi: media player.
+ @param channel: the audio channel, See libvlc_audio_output_channel_t.
+ @return: 0 on success, -1 on error.
+ '''
+ f = _Cfunctions.get('libvlc_audio_set_channel', None) or \
+ _Cfunction('libvlc_audio_set_channel', ((1,), (1,),), None,
+ ctypes.c_int, MediaPlayer, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_audio_set_channel
+ libvlc_audio_set_channel = f
+ return f(p_mi, channel)
+
+def libvlc_audio_get_delay(p_mi):
+ '''Get current audio delay.
+ @param p_mi: media player.
+ @return: the audio delay (microseconds).
+ @version: LibVLC 1.1.1 or later.
+ '''
+ f = _Cfunctions.get('libvlc_audio_get_delay', None) or \
+ _Cfunction('libvlc_audio_get_delay', ((1,),), None,
+ ctypes.c_int64, MediaPlayer)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_audio_get_delay
+ libvlc_audio_get_delay = f
+ return f(p_mi)
+
+def libvlc_audio_set_delay(p_mi, i_delay):
+ '''Set current audio delay. The audio delay will be reset to zero each time the media changes.
+ @param p_mi: media player.
+ @param i_delay: the audio delay (microseconds).
+ @return: 0 on success, -1 on error.
+ @version: LibVLC 1.1.1 or later.
+ '''
+ f = _Cfunctions.get('libvlc_audio_set_delay', None) or \
+ _Cfunction('libvlc_audio_set_delay', ((1,), (1,),), None,
+ ctypes.c_int, MediaPlayer, ctypes.c_int64)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_audio_set_delay
+ libvlc_audio_set_delay = f
+ return f(p_mi, i_delay)
+
+def libvlc_vlm_release(p_instance):
+ '''Release the vlm instance related to the given L{Instance}.
+ @param p_instance: the instance.
+ '''
+ f = _Cfunctions.get('libvlc_vlm_release', None) or \
+ _Cfunction('libvlc_vlm_release', ((1,),), None,
+ None, Instance)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_vlm_release
+ libvlc_vlm_release = f
+ return f(p_instance)
+
+def libvlc_vlm_add_broadcast(p_instance, psz_name, psz_input, psz_output, i_options, ppsz_options, b_enabled, b_loop):
+ '''Add a broadcast, with one input.
+ @param p_instance: the instance.
+ @param psz_name: the name of the new broadcast.
+ @param psz_input: the input MRL.
+ @param psz_output: the output MRL (the parameter to the "sout" variable).
+ @param i_options: number of additional options.
+ @param ppsz_options: additional options.
+ @param b_enabled: boolean for enabling the new broadcast.
+ @param b_loop: Should this broadcast be played in loop ?
+ @return: 0 on success, -1 on error.
+ '''
+ f = _Cfunctions.get('libvlc_vlm_add_broadcast', None) or \
+ _Cfunction('libvlc_vlm_add_broadcast', ((1,), (1,), (1,), (1,), (1,), (1,), (1,), (1,),), None,
+ ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_char_p, ctypes.c_char_p, ctypes.c_int, ListPOINTER(ctypes.c_char_p), ctypes.c_int, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_vlm_add_broadcast
+ libvlc_vlm_add_broadcast = f
+ return f(p_instance, psz_name, psz_input, psz_output, i_options, ppsz_options, b_enabled, b_loop)
+
+def libvlc_vlm_add_vod(p_instance, psz_name, psz_input, i_options, ppsz_options, b_enabled, psz_mux):
+ '''Add a vod, with one input.
+ @param p_instance: the instance.
+ @param psz_name: the name of the new vod media.
+ @param psz_input: the input MRL.
+ @param i_options: number of additional options.
+ @param ppsz_options: additional options.
+ @param b_enabled: boolean for enabling the new vod.
+ @param psz_mux: the muxer of the vod media.
+ @return: 0 on success, -1 on error.
+ '''
+ f = _Cfunctions.get('libvlc_vlm_add_vod', None) or \
+ _Cfunction('libvlc_vlm_add_vod', ((1,), (1,), (1,), (1,), (1,), (1,), (1,),), None,
+ ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_char_p, ctypes.c_int, ListPOINTER(ctypes.c_char_p), ctypes.c_int, ctypes.c_char_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_vlm_add_vod
+ libvlc_vlm_add_vod = f
+ return f(p_instance, psz_name, psz_input, i_options, ppsz_options, b_enabled, psz_mux)
+
+def libvlc_vlm_del_media(p_instance, psz_name):
+ '''Delete a media (VOD or broadcast).
+ @param p_instance: the instance.
+ @param psz_name: the media to delete.
+ @return: 0 on success, -1 on error.
+ '''
+ f = _Cfunctions.get('libvlc_vlm_del_media', None) or \
+ _Cfunction('libvlc_vlm_del_media', ((1,), (1,),), None,
+ ctypes.c_int, Instance, ctypes.c_char_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_vlm_del_media
+ libvlc_vlm_del_media = f
+ return f(p_instance, psz_name)
+
+def libvlc_vlm_set_enabled(p_instance, psz_name, b_enabled):
+ '''Enable or disable a media (VOD or broadcast).
+ @param p_instance: the instance.
+ @param psz_name: the media to work on.
+ @param b_enabled: the new status.
+ @return: 0 on success, -1 on error.
+ '''
+ f = _Cfunctions.get('libvlc_vlm_set_enabled', None) or \
+ _Cfunction('libvlc_vlm_set_enabled', ((1,), (1,), (1,),), None,
+ ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_vlm_set_enabled
+ libvlc_vlm_set_enabled = f
+ return f(p_instance, psz_name, b_enabled)
+
+def libvlc_vlm_set_output(p_instance, psz_name, psz_output):
+ '''Set the output for a media.
+ @param p_instance: the instance.
+ @param psz_name: the media to work on.
+ @param psz_output: the output MRL (the parameter to the "sout" variable).
+ @return: 0 on success, -1 on error.
+ '''
+ f = _Cfunctions.get('libvlc_vlm_set_output', None) or \
+ _Cfunction('libvlc_vlm_set_output', ((1,), (1,), (1,),), None,
+ ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_char_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_vlm_set_output
+ libvlc_vlm_set_output = f
+ return f(p_instance, psz_name, psz_output)
+
+def libvlc_vlm_set_input(p_instance, psz_name, psz_input):
+ '''Set a media's input MRL. This will delete all existing inputs and
+ add the specified one.
+ @param p_instance: the instance.
+ @param psz_name: the media to work on.
+ @param psz_input: the input MRL.
+ @return: 0 on success, -1 on error.
+ '''
+ f = _Cfunctions.get('libvlc_vlm_set_input', None) or \
+ _Cfunction('libvlc_vlm_set_input', ((1,), (1,), (1,),), None,
+ ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_char_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_vlm_set_input
+ libvlc_vlm_set_input = f
+ return f(p_instance, psz_name, psz_input)
+
+def libvlc_vlm_add_input(p_instance, psz_name, psz_input):
+ '''Add a media's input MRL. This will add the specified one.
+ @param p_instance: the instance.
+ @param psz_name: the media to work on.
+ @param psz_input: the input MRL.
+ @return: 0 on success, -1 on error.
+ '''
+ f = _Cfunctions.get('libvlc_vlm_add_input', None) or \
+ _Cfunction('libvlc_vlm_add_input', ((1,), (1,), (1,),), None,
+ ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_char_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_vlm_add_input
+ libvlc_vlm_add_input = f
+ return f(p_instance, psz_name, psz_input)
+
+def libvlc_vlm_set_loop(p_instance, psz_name, b_loop):
+ '''Set a media's loop status.
+ @param p_instance: the instance.
+ @param psz_name: the media to work on.
+ @param b_loop: the new status.
+ @return: 0 on success, -1 on error.
+ '''
+ f = _Cfunctions.get('libvlc_vlm_set_loop', None) or \
+ _Cfunction('libvlc_vlm_set_loop', ((1,), (1,), (1,),), None,
+ ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_vlm_set_loop
+ libvlc_vlm_set_loop = f
+ return f(p_instance, psz_name, b_loop)
+
+def libvlc_vlm_set_mux(p_instance, psz_name, psz_mux):
+ '''Set a media's vod muxer.
+ @param p_instance: the instance.
+ @param psz_name: the media to work on.
+ @param psz_mux: the new muxer.
+ @return: 0 on success, -1 on error.
+ '''
+ f = _Cfunctions.get('libvlc_vlm_set_mux', None) or \
+ _Cfunction('libvlc_vlm_set_mux', ((1,), (1,), (1,),), None,
+ ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_char_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_vlm_set_mux
+ libvlc_vlm_set_mux = f
+ return f(p_instance, psz_name, psz_mux)
+
+def libvlc_vlm_change_media(p_instance, psz_name, psz_input, psz_output, i_options, ppsz_options, b_enabled, b_loop):
+ '''Edit the parameters of a media. This will delete all existing inputs and
+ add the specified one.
+ @param p_instance: the instance.
+ @param psz_name: the name of the new broadcast.
+ @param psz_input: the input MRL.
+ @param psz_output: the output MRL (the parameter to the "sout" variable).
+ @param i_options: number of additional options.
+ @param ppsz_options: additional options.
+ @param b_enabled: boolean for enabling the new broadcast.
+ @param b_loop: Should this broadcast be played in loop ?
+ @return: 0 on success, -1 on error.
+ '''
+ f = _Cfunctions.get('libvlc_vlm_change_media', None) or \
+ _Cfunction('libvlc_vlm_change_media', ((1,), (1,), (1,), (1,), (1,), (1,), (1,), (1,),), None,
+ ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_char_p, ctypes.c_char_p, ctypes.c_int, ListPOINTER(ctypes.c_char_p), ctypes.c_int, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_vlm_change_media
+ libvlc_vlm_change_media = f
+ return f(p_instance, psz_name, psz_input, psz_output, i_options, ppsz_options, b_enabled, b_loop)
+
+def libvlc_vlm_play_media(p_instance, psz_name):
+ '''Play the named broadcast.
+ @param p_instance: the instance.
+ @param psz_name: the name of the broadcast.
+ @return: 0 on success, -1 on error.
+ '''
+ f = _Cfunctions.get('libvlc_vlm_play_media', None) or \
+ _Cfunction('libvlc_vlm_play_media', ((1,), (1,),), None,
+ ctypes.c_int, Instance, ctypes.c_char_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_vlm_play_media
+ libvlc_vlm_play_media = f
+ return f(p_instance, psz_name)
+
+def libvlc_vlm_stop_media(p_instance, psz_name):
+ '''Stop the named broadcast.
+ @param p_instance: the instance.
+ @param psz_name: the name of the broadcast.
+ @return: 0 on success, -1 on error.
+ '''
+ f = _Cfunctions.get('libvlc_vlm_stop_media', None) or \
+ _Cfunction('libvlc_vlm_stop_media', ((1,), (1,),), None,
+ ctypes.c_int, Instance, ctypes.c_char_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_vlm_stop_media
+ libvlc_vlm_stop_media = f
+ return f(p_instance, psz_name)
+
+def libvlc_vlm_pause_media(p_instance, psz_name):
+ '''Pause the named broadcast.
+ @param p_instance: the instance.
+ @param psz_name: the name of the broadcast.
+ @return: 0 on success, -1 on error.
+ '''
+ f = _Cfunctions.get('libvlc_vlm_pause_media', None) or \
+ _Cfunction('libvlc_vlm_pause_media', ((1,), (1,),), None,
+ ctypes.c_int, Instance, ctypes.c_char_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_vlm_pause_media
+ libvlc_vlm_pause_media = f
+ return f(p_instance, psz_name)
+
+def libvlc_vlm_seek_media(p_instance, psz_name, f_percentage):
+ '''Seek in the named broadcast.
+ @param p_instance: the instance.
+ @param psz_name: the name of the broadcast.
+ @param f_percentage: the percentage to seek to.
+ @return: 0 on success, -1 on error.
+ '''
+ f = _Cfunctions.get('libvlc_vlm_seek_media', None) or \
+ _Cfunction('libvlc_vlm_seek_media', ((1,), (1,), (1,),), None,
+ ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_float)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_vlm_seek_media
+ libvlc_vlm_seek_media = f
+ return f(p_instance, psz_name, f_percentage)
+
+def libvlc_vlm_show_media(p_instance, psz_name):
+ '''Return information about the named media as a JSON
+ string representation.
+ This function is mainly intended for debugging use,
+ if you want programmatic access to the state of
+ a vlm_media_instance_t, please use the corresponding
+ libvlc_vlm_get_media_instance_xxx -functions.
+ Currently there are no such functions available for
+ vlm_media_t though.
+ @param p_instance: the instance.
+ @param psz_name: the name of the media, if the name is an empty string, all media is described.
+ @return: string with information about named media, or NULL on error.
+ '''
+ f = _Cfunctions.get('libvlc_vlm_show_media', None) or \
+ _Cfunction('libvlc_vlm_show_media', ((1,), (1,),), string_result,
+ ctypes.c_void_p, Instance, ctypes.c_char_p)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_vlm_show_media
+ libvlc_vlm_show_media = f
+ return f(p_instance, psz_name)
+
+def libvlc_vlm_get_media_instance_position(p_instance, psz_name, i_instance):
+ '''Get vlm_media instance position by name or instance id.
+ @param p_instance: a libvlc instance.
+ @param psz_name: name of vlm media instance.
+ @param i_instance: instance id.
+ @return: position as float or -1. on error.
+ '''
+ f = _Cfunctions.get('libvlc_vlm_get_media_instance_position', None) or \
+ _Cfunction('libvlc_vlm_get_media_instance_position', ((1,), (1,), (1,),), None,
+ ctypes.c_float, Instance, ctypes.c_char_p, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_vlm_get_media_instance_position
+ libvlc_vlm_get_media_instance_position = f
+ return f(p_instance, psz_name, i_instance)
+
+def libvlc_vlm_get_media_instance_time(p_instance, psz_name, i_instance):
+ '''Get vlm_media instance time by name or instance id.
+ @param p_instance: a libvlc instance.
+ @param psz_name: name of vlm media instance.
+ @param i_instance: instance id.
+ @return: time as integer or -1 on error.
+ '''
+ f = _Cfunctions.get('libvlc_vlm_get_media_instance_time', None) or \
+ _Cfunction('libvlc_vlm_get_media_instance_time', ((1,), (1,), (1,),), None,
+ ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_vlm_get_media_instance_time
+ libvlc_vlm_get_media_instance_time = f
+ return f(p_instance, psz_name, i_instance)
+
+def libvlc_vlm_get_media_instance_length(p_instance, psz_name, i_instance):
+ '''Get vlm_media instance length by name or instance id.
+ @param p_instance: a libvlc instance.
+ @param psz_name: name of vlm media instance.
+ @param i_instance: instance id.
+ @return: length of media item or -1 on error.
+ '''
+ f = _Cfunctions.get('libvlc_vlm_get_media_instance_length', None) or \
+ _Cfunction('libvlc_vlm_get_media_instance_length', ((1,), (1,), (1,),), None,
+ ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_vlm_get_media_instance_length
+ libvlc_vlm_get_media_instance_length = f
+ return f(p_instance, psz_name, i_instance)
+
+def libvlc_vlm_get_media_instance_rate(p_instance, psz_name, i_instance):
+ '''Get vlm_media instance playback rate by name or instance id.
+ @param p_instance: a libvlc instance.
+ @param psz_name: name of vlm media instance.
+ @param i_instance: instance id.
+ @return: playback rate or -1 on error.
+ '''
+ f = _Cfunctions.get('libvlc_vlm_get_media_instance_rate', None) or \
+ _Cfunction('libvlc_vlm_get_media_instance_rate', ((1,), (1,), (1,),), None,
+ ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_vlm_get_media_instance_rate
+ libvlc_vlm_get_media_instance_rate = f
+ return f(p_instance, psz_name, i_instance)
+
+def libvlc_vlm_get_media_instance_title(p_instance, psz_name, i_instance):
+ '''Get vlm_media instance title number by name or instance id.
+ @param p_instance: a libvlc instance.
+ @param psz_name: name of vlm media instance.
+ @param i_instance: instance id.
+ @return: title as number or -1 on error.
+ @bug: will always return 0.
+ '''
+ f = _Cfunctions.get('libvlc_vlm_get_media_instance_title', None) or \
+ _Cfunction('libvlc_vlm_get_media_instance_title', ((1,), (1,), (1,),), None,
+ ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_vlm_get_media_instance_title
+ libvlc_vlm_get_media_instance_title = f
+ return f(p_instance, psz_name, i_instance)
+
+def libvlc_vlm_get_media_instance_chapter(p_instance, psz_name, i_instance):
+ '''Get vlm_media instance chapter number by name or instance id.
+ @param p_instance: a libvlc instance.
+ @param psz_name: name of vlm media instance.
+ @param i_instance: instance id.
+ @return: chapter as number or -1 on error.
+ @bug: will always return 0.
+ '''
+ f = _Cfunctions.get('libvlc_vlm_get_media_instance_chapter', None) or \
+ _Cfunction('libvlc_vlm_get_media_instance_chapter', ((1,), (1,), (1,),), None,
+ ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_vlm_get_media_instance_chapter
+ libvlc_vlm_get_media_instance_chapter = f
+ return f(p_instance, psz_name, i_instance)
+
+def libvlc_vlm_get_media_instance_seekable(p_instance, psz_name, i_instance):
+ '''Is libvlc instance seekable ?
+ @param p_instance: a libvlc instance.
+ @param psz_name: name of vlm media instance.
+ @param i_instance: instance id.
+ @return: 1 if seekable, 0 if not, -1 if media does not exist.
+ @bug: will always return 0.
+ '''
+ f = _Cfunctions.get('libvlc_vlm_get_media_instance_seekable', None) or \
+ _Cfunction('libvlc_vlm_get_media_instance_seekable', ((1,), (1,), (1,),), None,
+ ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_int)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_vlm_get_media_instance_seekable
+ libvlc_vlm_get_media_instance_seekable = f
+ return f(p_instance, psz_name, i_instance)
+
+def libvlc_vlm_get_event_manager(p_instance):
+ '''Get libvlc_event_manager from a vlm media.
+ The p_event_manager is immutable, so you don't have to hold the lock.
+ @param p_instance: a libvlc instance.
+ @return: libvlc_event_manager.
+ '''
+ f = _Cfunctions.get('libvlc_vlm_get_event_manager', None) or \
+ _Cfunction('libvlc_vlm_get_event_manager', ((1,),), class_result(EventManager),
+ ctypes.c_void_p, Instance)
+ if not __debug__: # i.e. python -O or -OO
+ global libvlc_vlm_get_event_manager
+ libvlc_vlm_get_event_manager = f
+ return f(p_instance)
+
+
+# 6 function(s) blacklisted:
+# libvlc_audio_set_callbacks
+# libvlc_audio_set_format_callbacks
+# libvlc_audio_set_volume_callback
+# libvlc_set_exit_handler
+# libvlc_video_set_callbacks
+# libvlc_video_set_format_callbacks
+
+# 12 function(s) not wrapped as methods:
+# libvlc_audio_output_list_release
+# libvlc_clearerr
+# libvlc_clock
+# libvlc_errmsg
+# libvlc_event_type_name
+# libvlc_free
+# libvlc_get_changeset
+# libvlc_get_compiler
+# libvlc_get_version
+# libvlc_module_description_list_release
+# libvlc_new
+# libvlc_track_description_release
+
+# Start of footer.py #
+
+# Backward compatibility
+def callbackmethod(callback):
+ """Now obsolete @callbackmethod decorator."""
+ return callback
+
+# libvlc_free is not present in some versions of libvlc. If it is not
+# in the library, then emulate it by calling libc.free
+if not hasattr(dll, 'libvlc_free'):
+ # need to find the free function in the C runtime. This is
+ # platform specific.
+ # For Linux and MacOSX
+ libc_path = find_library('c')
+ if libc_path:
+ libc = ctypes.CDLL(libc_path)
+ libvlc_free = libc.free
+ else:
+ # On win32, it is impossible to guess the proper lib to call
+ # (msvcrt, mingw...). Just ignore the call: it will memleak,
+ # but not prevent to run the application.
+ def libvlc_free(p):
+ pass
+
+ # ensure argtypes is right, because default type of int won't work
+ # on 64-bit systems
+ libvlc_free.argtypes = [ ctypes.c_void_p ]
+
+# Version functions
+def _dot2int(v):
+ '''(INTERNAL) Convert 'i.i.i[.i]' str to int.
+ '''
+ t = [int(i) for i in v.split('.')]
+ if len(t) == 3:
+ t.append(0)
+ elif len(t) != 4:
+ raise ValueError('"i.i.i[.i]": %r' % (v,))
+ if min(t) < 0 or max(t) > 255:
+ raise ValueError('[0..255]: %r' % (v,))
+ i = t.pop(0)
+ while t:
+ i = (i << 8) + t.pop(0)
+ return i
+
+def hex_version():
+ """Return the version of these bindings in hex or 0 if unavailable.
+ """
+ try:
+ return _dot2int(__version__.split('-')[-1])
+ except (NameError, ValueError):
+ return 0
+
+def libvlc_hex_version():
+ """Return the libvlc version in hex or 0 if unavailable.
+ """
+ try:
+ return _dot2int(libvlc_get_version().split()[0])
+ except ValueError:
+ return 0
+
+
+def debug_callback(event, *args, **kwds):
+ '''Example callback, useful for debugging.
+ '''
+ l = ['event %s' % (event.type,)]
+ if args:
+ l.extend(map(str, args))
+ if kwds:
+ l.extend(sorted('%s=%s' % t for t in kwds.items()))
+ print('Debug callback (%s)' % ', '.join(l))
+
+if __name__ == '__main__':
+
+ try:
+ from msvcrt import getch
+ except ImportError:
+ import termios
+ import tty
+
+ def getch(): # getchar(), getc(stdin) #PYCHOK flake
+ fd = sys.stdin.fileno()
+ old = termios.tcgetattr(fd)
+ try:
+ tty.setraw(fd)
+ ch = sys.stdin.read(1)
+ finally:
+ termios.tcsetattr(fd, termios.TCSADRAIN, old)
+ return ch
+
+ def end_callback(event):
+ print('End of media stream (event %s)' % event.type)
+ sys.exit(0)
+
+ echo_position = False
+ def pos_callback(event, player):
+ if echo_position:
+ sys.stdout.write('\r%s to %.2f%% (%.2f%%)' % (event.type,
+ event.u.new_position * 100,
+ player.get_position() * 100))
+ sys.stdout.flush()
+
+ def print_version():
+ """Print libvlc version"""
+ try:
+ print('Build date: %s (%#x)' % (build_date, hex_version()))
+ print('LibVLC version: %s (%#x)' % (libvlc_get_version(), libvlc_hex_version()))
+ print('LibVLC compiler: %s' % libvlc_get_compiler())
+ if plugin_path:
+ print('Plugin path: %s' % plugin_path)
+ except:
+ print('Error: %s' % sys.exc_info()[1])
+
+ if sys.argv[1:] and sys.argv[1] not in ('-h', '--help'):
+
+ movie = os.path.expanduser(sys.argv[1])
+ if not os.access(movie, os.R_OK):
+ print('Error: %s file not readable' % movie)
+ sys.exit(1)
+
+ instance = Instance()
+ try:
+ media = instance.media_new(movie, 'sub-filter=marq') # load marqee option
+ except NameError:
+ print('NameError: %s (%s vs LibVLC %s)' % (sys.exc_info()[1],
+ __version__,
+ libvlc_get_version()))
+ sys.exit(1)
+ player = instance.media_player_new()
+ player.set_media(media)
+ player.play()
+
+ # Some marquee examples. Marquee requires 'sub-filter=marq' in the
+ # media_new() call above. See also the Media.add_options method
+ # and <http://www.videolan.org/doc/play-howto/en/ch04.html>
+ player.video_set_marquee_int(VideoMarqueeOption.Enable, 1)
+ player.video_set_marquee_int(VideoMarqueeOption.Size, 24) # pixels
+ player.video_set_marquee_int(VideoMarqueeOption.Position, Position.Bottom)
+ if True: # only one marquee can be specified
+ player.video_set_marquee_int(VideoMarqueeOption.Timeout, 5000) # millisec, 0==forever
+ t = media.get_mrl() # movie
+ else: # update marquee text periodically
+ player.video_set_marquee_int(VideoMarqueeOption.Timeout, 0) # millisec, 0==forever
+ player.video_set_marquee_int(VideoMarqueeOption.Refresh, 1000) # millisec (or sec?)
+ ##t = '$L / $D or $P at $T'
+ t = '%Y-%m-%d %H:%M:%S'
+ player.video_set_marquee_string(VideoMarqueeOption.Text, t)
+
+ # Some event manager examples. Note, the callback can be any Python
+ # callable and does not need to be decorated. Optionally, specify
+ # any number of positional and/or keyword arguments to be passed
+ # to the callback (in addition to the first one, an Event instance).
+ event_manager = player.event_manager()
+ event_manager.event_attach(EventType.MediaPlayerEndReached, end_callback)
+ event_manager.event_attach(EventType.MediaPlayerPositionChanged, pos_callback, player)
+
+ def mspf():
+ """Milliseconds per frame."""
+ return int(1000 // (player.get_fps() or 25))
+
+ def print_info():
+ """Print information about the media"""
+ try:
+ print_version()
+ media = player.get_media()
+ print('State: %s' % player.get_state())
+ print('Media: %s' % media.get_mrl())
+ print('Track: %s/%s' % (player.video_get_track(), player.video_get_track_count()))
+ print('Current time: %s/%s' % (player.get_time(), media.get_duration()))
+ print('Position: %s' % player.get_position())
+ print('FPS: %s (%d ms)' % (player.get_fps(), mspf()))
+ print('Rate: %s' % player.get_rate())
+ print('Video size: %s' % str(player.video_get_size(0))) # num=0
+ print('Scale: %s' % player.video_get_scale())
+ print('Aspect ratio: %s' % player.video_get_aspect_ratio())
+ #print('Window:' % player.get_hwnd()
+ except Exception:
+ print('Error: %s', sys.exc_info()[1])
+
+ def sec_forward():
+ """Go forward one sec"""
+ player.set_time(player.get_time() + 1000)
+
+ def sec_backward():
+ """Go backward one sec"""
+ player.set_time(player.get_time() - 1000)
+
+ def frame_forward():
+ """Go forward one frame"""
+ player.set_time(player.get_time() + mspf())
+
+ def frame_backward():
+ """Go backward one frame"""
+ player.set_time(player.get_time() - mspf())
+
+ def print_help():
+ """Print help"""
+ print('Single-character commands:')
+ for k, m in sorted(keybindings.items()):
+ m = (m.__doc__ or m.__name__).splitlines()[0]
+ print(' %s: %s.' % (k, m.rstrip('.')))
+ print('0-9: go to that fraction of the movie')
+
+ def quit_app():
+ """Stop and exit"""
+ sys.exit(0)
+
+ def toggle_echo_position():
+ """Toggle echoing of media position"""
+ global echo_position
+ echo_position = not echo_position
+
+ keybindings = {
+ ' ': player.pause,
+ '+': sec_forward,
+ '-': sec_backward,
+ '.': frame_forward,
+ ',': frame_backward,
+ 'f': player.toggle_fullscreen,
+ 'i': print_info,
+ 'p': toggle_echo_position,
+ 'q': quit_app,
+ '?': print_help,
+ }
+
+ print('Press q to quit, ? to get help.%s' % os.linesep)
+ while True:
+ k = getch().decode('utf8') # Python 3+
+ print('> %s' % k)
+ if k in keybindings:
+ keybindings[k]()
+ elif k.isdigit():
+ # jump to fraction of the movie.
+ player.set_position(float('0.'+k))
+
+ else:
+ print('Usage: %s <movie_filename>' % sys.argv[0])
+ print('Once launched, type ? for help.')
+ print('')
+ print_version()
=== added file 'openlp/core/ui/media/vlcplayer.py'
--- openlp/core/ui/media/vlcplayer.py 1970-01-01 00:00:00 +0000
+++ openlp/core/ui/media/vlcplayer.py 2011-12-02 23:48:27 +0000
@@ -0,0 +1,211 @@
+# -*- coding: utf-8 -*-
+# vim: autoindent shiftwidth=4 expandtab textwidth=80 tabstop=4 softtabstop=4
+
+###############################################################################
+# OpenLP - Open Source Lyrics Projection #
+# --------------------------------------------------------------------------- #
+# Copyright (c) 2008-2011 Raoul Snyman #
+# Portions copyright (c) 2008-2011 Tim Bentley, Gerald Britton, Jonathan #
+# Corwin, Michael Gorven, Scott Guerrieri, Matthias Hub, Meinert Jordan, #
+# Armin Köhler, Joshua Miller, Stevan Pettit, Andreas Preikschat, Mattias #
+# Põldaru, Christian Richter, Philip Ridout, Simon Scudder, Jeffrey Smith, #
+# Maikel Stuivenberg, Martin Thompson, Jon Tibble, Frode Woldsund #
+# --------------------------------------------------------------------------- #
+# This program is free software; you can redistribute it and/or modify it #
+# under the terms of the GNU General Public License as published by the Free #
+# Software Foundation; version 2 of the License. #
+# #
+# This program is distributed in the hope that it will be useful, but WITHOUT #
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or #
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for #
+# more details. #
+# #
+# You should have received a copy of the GNU General Public License along #
+# with this program; if not, write to the Free Software Foundation, Inc., 59 #
+# Temple Place, Suite 330, Boston, MA 02111-1307 USA #
+###############################################################################
+
+import logging
+import sys, os
+from datetime import datetime
+try:
+ import vlc
+ vlc_available = bool(vlc.get_default_instance())
+except ImportError:
+ vlc_available = False
+
+from PyQt4 import QtCore, QtGui
+from openlp.core.lib import Receiver
+from openlp.core.lib.mediaplayer import MediaPlayer
+from openlp.core.ui.media import MediaState
+
+log = logging.getLogger(__name__)
+
+AUDIO_EXT = [
+ u'*.mp3'
+ , u'*.wav'
+ , u'*.ogg'
+ ]
+
+VIDEO_EXT = [
+ u'*.3gp'
+ , u'*.asf', u'*.wmv'
+ , u'*.au'
+ , u'*.avi'
+ , u'*.flv'
+ , u'*.mov'
+ , u'*.mp4'
+ , u'*.ogm'
+ , u'*.mkv', u'*.mka'
+ , u'*.ts', u'*.mpg'
+ , u'*.mpg', u'*.mp2'
+ , u'*.nsc'
+ , u'*.nsv'
+ , u'*.nut'
+ , u'*.ra', u'*.ram', u'*.rm', u'*.rv' ,u'*.rmbv'
+ , u'*.a52', u'*.dts', u'*.aac', u'*.flac' ,u'*.dv', u'*.vid'
+ , u'*.tta', u'*.tac'
+ , u'*.ty'
+ , u'*.dts'
+ , u'*.xa'
+ , u'*.iso'
+ , u'*.vob'
+ ]
+
+
+class VlcPlayer(MediaPlayer):
+ """
+ A specialised version of the MediaPlayer class, which provides a QtWebKit
+ display.
+ """
+
+ def __init__(self, parent):
+ MediaPlayer.__init__(self, parent, u'vlc')
+ self.parent = parent
+ self.canFolder = True
+ self.audio_extensions_list = AUDIO_EXT
+ self.video_extensions_list = VIDEO_EXT
+
+ def setup(self, display):
+ display.vlcWidget = QtGui.QFrame(display)
+ # creating a basic vlc instance
+ command_line_options = u'--no-video-title-show'
+ if not display.hasAudio:
+ command_line_options += u' --no-audio --no-video-title-show'
+ if QtCore.QSettings().value(u'advanced/hide mouse',
+ QtCore.QVariant(False)).toBool() and \
+ display.controller.isLive:
+ command_line_options += u' --mouse-hide-timeout=0'
+ display.vlcInstance = vlc.Instance(command_line_options)
+ display.vlcInstance.set_log_verbosity(2)
+ # creating an empty vlc media player
+ display.vlcMediaPlayer = display.vlcInstance.media_player_new()
+ display.vlcWidget.resize(display.size())
+ display.vlcWidget.raise_()
+ display.vlcWidget.hide()
+ # the media player has to be 'connected' to the QFrame
+ # (otherwise a video would be displayed in it's own window)
+ # this is platform specific!
+ # you have to give the id of the QFrame (or similar object) to
+ # vlc, different platforms have different functions for this
+ if sys.platform == "linux2": # for Linux using the X Server
+ display.vlcMediaPlayer.set_xwindow(int(display.vlcWidget.winId()))
+ elif sys.platform == "win32": # for Windows
+ display.vlcMediaPlayer.set_hwnd(int(display.vlcWidget.winId()))
+ elif sys.platform == "darwin": # for MacOS
+ display.vlcMediaPlayer.set_agl(int(display.vlcWidget.winId()))
+ self.hasOwnWidget = True
+
+ def check_available(self):
+ return vlc_available
+
+ def load(self, display):
+ log.debug(u'load vid in Vlc Controller')
+ controller = display.controller
+ volume = controller.media_info.volume
+ file_path = str(
+ controller.media_info.file_info.absoluteFilePath().toUtf8())
+ path = os.path.normcase(file_path)
+ # create the media
+ display.vlcMedia = display.vlcInstance.media_new_path(path)
+ # put the media in the media player
+ display.vlcMediaPlayer.set_media(display.vlcMedia)
+ # parse the metadata of the file
+ display.vlcMedia.parse()
+ self.volume(display, volume)
+ return True
+
+ def media_state_wait(self, display, mediaState):
+ """
+ Wait for the video to change its state
+ Wait no longer than 60 seconds. (loading an iso file needs a long time)
+ """
+ start = datetime.now()
+ while not mediaState == display.vlcMedia.get_state():
+ if display.vlcMedia.get_state() == vlc.State.Error:
+ return False
+ Receiver.send_message(u'openlp_process_events')
+ if (datetime.now() - start).seconds > 60:
+ return False
+ return True
+
+ def resize(self, display):
+ display.vlcWidget.resize(display.size())
+
+ def play(self, display):
+ controller = display.controller
+ start_time = 0
+ if controller.media_info.start_time > 0:
+ start_time = controller.media_info.start_time
+ display.vlcMediaPlayer.play()
+ if self.media_state_wait(display, vlc.State.Playing):
+ if start_time > 0:
+ self.seek(display, controller.media_info.start_time * 1000)
+ controller.media_info.length = \
+ int(display.vlcMediaPlayer.get_media().get_duration() / 1000)
+ controller.seekSlider.setMaximum(controller.media_info.length * 1000)
+ self.state = MediaState.Playing
+ display.vlcWidget.raise_()
+ return True
+ else:
+ return False
+
+ def pause(self, display):
+ if display.vlcMedia.get_state() != vlc.State.Playing:
+ return
+ display.vlcMediaPlayer.pause()
+ if self.media_state_wait(display, vlc.State.Paused):
+ self.state = MediaState.Paused
+
+ def stop(self, display):
+ display.vlcMediaPlayer.stop()
+ self.state = MediaState.Stopped
+
+ def volume(self, display, vol):
+ if display.hasAudio:
+ display.vlcMediaPlayer.audio_set_volume(vol)
+
+ def seek(self, display, seekVal):
+ if display.vlcMediaPlayer.is_seekable():
+ display.vlcMediaPlayer.set_time(seekVal)
+
+ def reset(self, display):
+ display.vlcMediaPlayer.stop()
+ display.vlcWidget.setVisible(False)
+ self.state = MediaState.Off
+
+ def set_visible(self, display, status):
+ if self.hasOwnWidget:
+ display.vlcWidget.setVisible(status)
+
+ def update_ui(self, display):
+ controller = display.controller
+ if controller.media_info.end_time > 0:
+ if display.vlcMediaPlayer.get_time() > \
+ controller.media_info.end_time * 1000:
+ self.stop(display)
+ self.set_visible(display, False)
+ if not controller.seekSlider.isSliderDown():
+ controller.seekSlider.setSliderPosition( \
+ display.vlcMediaPlayer.get_time())
+
=== modified file 'openlp/core/ui/media/webkitplayer.py'
--- openlp/core/ui/media/webkitplayer.py 2011-12-01 18:07:15 +0000
+++ openlp/core/ui/media/webkitplayer.py 2011-12-02 23:48:27 +0000
@@ -297,11 +297,12 @@
def load(self, display):
log.debug(u'load vid in Webkit Controller')
controller = display.controller
- if display.hasAudio:
+ if display.hasAudio and not controller.media_info.is_background:
volume = controller.media_info.volume
vol = float(volume) / float(100)
else:
vol = 0
+ print vol
path = controller.media_info.file_info.absoluteFilePath()
if controller.media_info.is_background:
loop = u'true'
Follow ups
