diff --git a/app/tools/vlc.py b/app/tools/vlc.py index 7f3a4374..936124eb 100644 --- a/app/tools/vlc.py +++ b/app/tools/vlc.py @@ -41,21 +41,20 @@ C{get_instance} method of L{MediaPlayer} and L{MediaListPlayer}. """ import ctypes -from ctypes.util import find_library +import functools +import logging import os import sys -import functools - +from ctypes.util import find_library # Used by EventManager in override.py -from inspect import getargspec +from inspect import getargspec, signature -import logging logger = logging.getLogger(__name__) -__version__ = "3.0.8111" -__libvlc_version__ = "3.0.8" -__generator_version__ = "1.11" -build_date = "Sun Oct 27 20:26:27 2019 3.0.8" +__version__ = "3.0.12118" +__libvlc_version__ = "3.0.12" +__generator_version__ = "1.18" +build_date = "Tue Apr 20 20:46:07 2021 3.0.12" # The libvlc doc states that filenames are expected to be in UTF8, do # not rely on sys.getfilesystemencoding() which will be confused, @@ -68,6 +67,8 @@ if sys.version_info[0] > 2: bytes = bytes basestring = (str, bytes) PYTHON3 = True + + def str_to_bytes(s): """Translate string or bytes to bytes. """ @@ -76,6 +77,7 @@ if sys.version_info[0] > 2: else: return s + def bytes_to_str(b): """Translate bytes to string. """ @@ -89,6 +91,8 @@ else: bytes = str basestring = basestring PYTHON3 = False + + def str_to_bytes(s): """Translate string or bytes to bytes. """ @@ -97,6 +101,7 @@ else: else: return s + def bytes_to_str(b): """Translate bytes to unicode string. """ @@ -109,6 +114,7 @@ else: # instanciated. _internal_guard = object() + def find_lib(): dll = None plugin_path = os.environ.get('PYTHON_VLC_MODULE_PATH', None) @@ -149,22 +155,25 @@ def find_lib(): programfiles = os.environ["ProgramFiles"] homedir = os.environ["HOMEDRIVE"] for p in ('{programfiles}\\VideoLan{libname}', '{homedir}:\\VideoLan{libname}', - '{programfiles}{libname}', '{homedir}:{libname}'): - p = p.format(homedir = homedir, - programfiles = programfiles, - libname = '\\VLC\\' + libname) + '{programfiles}{libname}', '{homedir}:{libname}'): + p = p.format(homedir=homedir, + programfiles=programfiles, + libname='\\VLC\\' + libname) if os.path.exists(p): plugin_path = os.path.dirname(p) break if plugin_path is not None: # try loading + # PyInstaller Windows fix + if 'PyInstallerCDLL' in ctypes.CDLL.__name__: + ctypes.windll.kernel32.SetDllDirectoryW(None) p = os.getcwd() os.chdir(plugin_path) - # if chdir failed, this will raise an exception - dll = ctypes.CDLL(libname) - # restore cwd after dll has been loaded + # if chdir failed, this will raise an exception + dll = ctypes.CDLL('.\\' + libname) + # restore cwd after dll has been loaded os.chdir(p) else: # may fail - dll = ctypes.CDLL(libname) + dll = ctypes.CDLL('.\\' + libname) else: plugin_path = os.path.dirname(p) dll = ctypes.CDLL(p) @@ -203,20 +212,24 @@ def find_lib(): return (dll, plugin_path) + # plugin_path used on win32 and MacOS in override.py -dll, plugin_path = find_lib() +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 + _Ints = int _Seqs = (list, tuple) + # Used for handling *event_manager() methods. class memoize_parameterless(object): """Decorator. Caches a parameterless method's return value each time it is called. @@ -225,6 +238,7 @@ class memoize_parameterless(object): (not reevaluated). Adapted from https://wiki.python.org/moin/PythonDecoratorLibrary """ + def __init__(self, func): self.func = func self._cache = {} @@ -242,14 +256,16 @@ class memoize_parameterless(object): return self.func.__doc__ def __get__(self, obj, objtype): - """Support instance methods. - """ - return functools.partial(self.__call__, obj) + """Support instance methods. + """ + return functools.partial(self.__call__, obj) + # 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. """ @@ -258,6 +274,7 @@ def get_default_instance(): _default_instance = Instance() return _default_instance + def try_fspath(path): """Try calling os.fspath os.fspath is only available from py3.6 @@ -267,9 +284,11 @@ def try_fspath(path): except (AttributeError, TypeError): return path + _Cfunctions = {} # from LibVLC __version__ _Globals = globals() # sys.modules[__name__].__dict__ + def _Cfunction(name, flags, errcheck, *types): """(INTERNAL) New ctypes function binding. """ @@ -288,6 +307,7 @@ def _Cfunction(name, flags, errcheck, *types): return f raise NameError('no function %r' % (name,)) + def _Cobject(cls, ctype): """(INTERNAL) New instance from ctypes. """ @@ -295,15 +315,18 @@ def _Cobject(cls, ctype): 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.") + 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 _Cstruct(ctypes.Structure): """(INTERNAL) Base class for ctypes structures. """ @@ -316,9 +339,11 @@ class _Cstruct(ctypes.Structure): def __repr__(self): return '%s.%s' % (self.__class__.__module__, self) + class _Ctype(object): """(INTERNAL) Base class for ctypes. """ + @staticmethod def from_param(this): # not self """(INTERNAL) ctypes parameter conversion method. @@ -327,9 +352,11 @@ class _Ctype(object): return None return this._as_parameter_ + class ListPOINTER(object): """Just like a POINTER but accept a list of etype elements as an argument. """ + def __init__(self, etype): self.etype = etype @@ -339,6 +366,7 @@ class ListPOINTER(object): else: return ctypes.POINTER(param) + # errcheck functions for some native functions. def string_result(result, func, arguments): """Errcheck function. Returns a string and frees the original pointer. @@ -353,24 +381,40 @@ def string_result(result, func, arguments): 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 + # Wrapper for the opaque struct libvlc_log_t class Log(ctypes.Structure): pass + + Log_ptr = ctypes.POINTER(Log) + +# Wrapper for the opaque struct libvlc_media_thumbnail_request_t +class MediaThumbnailRequest: + def __new__(cls, *args): + if len(args) == 1 and isinstance(args[0], _Ints): + return _Constructor(cls, args[0]) + + # FILE* ctypes wrapper, copied from # http://svn.python.org/projects/ctypes/trunk/ctypeslib/ctypeslib/contrib/pythonhdr.py class FILE(ctypes.Structure): pass + + FILE_ptr = ctypes.POINTER(FILE) if PYTHON3: @@ -383,7 +427,7 @@ if PYTHON3: ctypes.c_char_p, ctypes.c_char_p, ctypes.c_char_p, - ctypes.c_int ] + ctypes.c_int] PyFile_AsFd = ctypes.pythonapi.PyObject_AsFileDescriptor PyFile_AsFd.restype = ctypes.c_int @@ -400,7 +444,40 @@ else: PyFile_AsFile.restype = FILE_ptr PyFile_AsFile.argtypes = [ctypes.py_object] - # Generated enum types # + +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 + + +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 + try: + libvlc_track_description_release(head) + except NameError: + libvlc_track_description_list_release(head) + + return r + + +# Generated enum types # class _Enum(ctypes.c_uint): '''(INTERNAL) Base class @@ -418,12 +495,13 @@ class _Enum(ctypes.c_uint): 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) ) + 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 LogLevel(_Enum): '''Logging messages level. \note future libvlc versions may define new levels. @@ -434,25 +512,13 @@ class LogLevel(_Enum): 3: 'WARNING', 4: 'ERROR', } -LogLevel.DEBUG = LogLevel(0) -LogLevel.ERROR = LogLevel(4) -LogLevel.NOTICE = LogLevel(2) + + +LogLevel.DEBUG = LogLevel(0) +LogLevel.ERROR = LogLevel(4) +LogLevel.NOTICE = LogLevel(2) LogLevel.WARNING = LogLevel(3) -class MediaDiscovererCategory(_Enum): - '''Category of a media discoverer -See libvlc_media_discoverer_list_get(). - ''' - _enum_names_ = { - 0: 'devices', - 1: 'lan', - 2: 'podcasts', - 3: 'localdirs', - } -MediaDiscovererCategory.devices = MediaDiscovererCategory(0) -MediaDiscovererCategory.lan = MediaDiscovererCategory(1) -MediaDiscovererCategory.localdirs = MediaDiscovererCategory(3) -MediaDiscovererCategory.podcasts = MediaDiscovererCategory(2) class DialogQuestionType(_Enum): '''@defgroup libvlc_dialog libvlc dialog @@ -466,9 +532,12 @@ libvlc dialog external api. 1: 'DIALOG_QUESTION_WARNING', 2: 'DIALOG_QUESTION_CRITICAL', } + + DialogQuestionType.DIALOG_QUESTION_CRITICAL = DialogQuestionType(2) -DialogQuestionType.DIALOG_QUESTION_NORMAL = DialogQuestionType(0) -DialogQuestionType.DIALOG_QUESTION_WARNING = DialogQuestionType(1) +DialogQuestionType.DIALOG_QUESTION_NORMAL = DialogQuestionType(0) +DialogQuestionType.DIALOG_QUESTION_WARNING = DialogQuestionType(1) + class EventType(_Enum): '''Event types. @@ -539,70 +608,73 @@ class EventType(_Enum): 1545: 'VlmMediaInstanceStatusEnd', 1546: 'VlmMediaInstanceStatusError', } -EventType.MediaDiscovererEnded = EventType(1281) -EventType.MediaDiscovererStarted = EventType(0x500) -EventType.MediaDurationChanged = EventType(2) -EventType.MediaFreed = EventType(4) -EventType.MediaListEndReached = EventType(516) -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.MediaPlayerAudioDevice = EventType(284) -EventType.MediaPlayerAudioVolume = EventType(283) -EventType.MediaPlayerBackward = EventType(264) -EventType.MediaPlayerBuffering = EventType(259) -EventType.MediaPlayerChapterChanged = EventType(285) -EventType.MediaPlayerCorked = EventType(279) -EventType.MediaPlayerESAdded = EventType(276) -EventType.MediaPlayerESDeleted = EventType(277) -EventType.MediaPlayerESSelected = EventType(278) -EventType.MediaPlayerEncounteredError = EventType(266) -EventType.MediaPlayerEndReached = EventType(265) -EventType.MediaPlayerForward = EventType(263) -EventType.MediaPlayerLengthChanged = EventType(273) -EventType.MediaPlayerMediaChanged = EventType(0x100) -EventType.MediaPlayerMuted = EventType(281) -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.MediaPlayerScrambledChanged = EventType(275) -EventType.MediaPlayerSeekableChanged = EventType(269) -EventType.MediaPlayerSnapshotTaken = EventType(272) -EventType.MediaPlayerStopped = EventType(262) -EventType.MediaPlayerTimeChanged = EventType(267) -EventType.MediaPlayerTitleChanged = EventType(271) -EventType.MediaPlayerUncorked = EventType(280) -EventType.MediaPlayerUnmuted = EventType(282) -EventType.MediaPlayerVout = EventType(274) -EventType.MediaStateChanged = EventType(5) -EventType.MediaSubItemAdded = EventType(1) -EventType.MediaSubItemTreeAdded = EventType(6) -EventType.RendererDiscovererItemAdded = EventType(1282) + + +EventType.MediaDiscovererEnded = EventType(1281) +EventType.MediaDiscovererStarted = EventType(0x500) +EventType.MediaDurationChanged = EventType(2) +EventType.MediaFreed = EventType(4) +EventType.MediaListEndReached = EventType(516) +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.MediaPlayerAudioDevice = EventType(284) +EventType.MediaPlayerAudioVolume = EventType(283) +EventType.MediaPlayerBackward = EventType(264) +EventType.MediaPlayerBuffering = EventType(259) +EventType.MediaPlayerChapterChanged = EventType(285) +EventType.MediaPlayerCorked = EventType(279) +EventType.MediaPlayerESAdded = EventType(276) +EventType.MediaPlayerESDeleted = EventType(277) +EventType.MediaPlayerESSelected = EventType(278) +EventType.MediaPlayerEncounteredError = EventType(266) +EventType.MediaPlayerEndReached = EventType(265) +EventType.MediaPlayerForward = EventType(263) +EventType.MediaPlayerLengthChanged = EventType(273) +EventType.MediaPlayerMediaChanged = EventType(0x100) +EventType.MediaPlayerMuted = EventType(281) +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.MediaPlayerScrambledChanged = EventType(275) +EventType.MediaPlayerSeekableChanged = EventType(269) +EventType.MediaPlayerSnapshotTaken = EventType(272) +EventType.MediaPlayerStopped = EventType(262) +EventType.MediaPlayerTimeChanged = EventType(267) +EventType.MediaPlayerTitleChanged = EventType(271) +EventType.MediaPlayerUncorked = EventType(280) +EventType.MediaPlayerUnmuted = EventType(282) +EventType.MediaPlayerVout = EventType(274) +EventType.MediaStateChanged = EventType(5) +EventType.MediaSubItemAdded = EventType(1) +EventType.MediaSubItemTreeAdded = EventType(6) +EventType.RendererDiscovererItemAdded = EventType(1282) EventType.RendererDiscovererItemDeleted = EventType(1283) -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.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.VlmMediaInstanceStatusPause = EventType(1544) EventType.VlmMediaInstanceStatusPlaying = EventType(1543) -EventType.VlmMediaInstanceStopped = EventType(1540) -EventType.VlmMediaRemoved = EventType(1537) +EventType.VlmMediaInstanceStopped = EventType(1540) +EventType.VlmMediaRemoved = EventType(1537) + class Meta(_Enum): '''Meta data types. @@ -635,32 +707,35 @@ class Meta(_Enum): 24: 'DiscNumber', 25: 'DiscTotal', } -Meta.Actors = Meta(22) -Meta.Album = Meta(4) + + +Meta.Actors = Meta(22) +Meta.Album = Meta(4) Meta.AlbumArtist = Meta(23) -Meta.Artist = Meta(1) -Meta.ArtworkURL = Meta(15) -Meta.Copyright = Meta(3) -Meta.Date = Meta(8) +Meta.Artist = Meta(1) +Meta.ArtworkURL = Meta(15) +Meta.Copyright = Meta(3) +Meta.Date = Meta(8) Meta.Description = Meta(6) -Meta.Director = Meta(18) -Meta.DiscNumber = Meta(24) -Meta.DiscTotal = Meta(25) -Meta.EncodedBy = Meta(14) -Meta.Episode = Meta(20) -Meta.Genre = Meta(2) -Meta.Language = Meta(11) -Meta.NowPlaying = Meta(12) -Meta.Publisher = Meta(13) -Meta.Rating = Meta(7) -Meta.Season = Meta(19) -Meta.Setting = Meta(9) -Meta.ShowName = Meta(21) -Meta.Title = Meta(0) -Meta.TrackID = Meta(16) +Meta.Director = Meta(18) +Meta.DiscNumber = Meta(24) +Meta.DiscTotal = Meta(25) +Meta.EncodedBy = Meta(14) +Meta.Episode = Meta(20) +Meta.Genre = Meta(2) +Meta.Language = Meta(11) +Meta.NowPlaying = Meta(12) +Meta.Publisher = Meta(13) +Meta.Rating = Meta(7) +Meta.Season = Meta(19) +Meta.Setting = Meta(9) +Meta.ShowName = Meta(21) +Meta.Title = Meta(0) +Meta.TrackID = Meta(16) Meta.TrackNumber = Meta(5) -Meta.TrackTotal = Meta(17) -Meta.URL = Meta(10) +Meta.TrackTotal = Meta(17) +Meta.URL = Meta(10) + class State(_Enum): '''Note the order of libvlc_state_t enum must match exactly the order of @@ -680,14 +755,17 @@ stopping=5, ended=6, error=7. 6: 'Ended', 7: 'Error', } -State.Buffering = State(2) -State.Ended = State(6) -State.Error = State(7) + + +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) +State.Opening = State(1) +State.Paused = State(4) +State.Playing = State(3) +State.Stopped = State(5) + class TrackType(_Enum): '''N/A @@ -698,10 +776,13 @@ class TrackType(_Enum): 1: 'video', 2: 'ext', } -TrackType.audio = TrackType(0) -TrackType.ext = TrackType(2) + + +TrackType.audio = TrackType(0) +TrackType.ext = TrackType(2) TrackType.unknown = TrackType(-1) -TrackType.video = TrackType(1) +TrackType.video = TrackType(1) + class VideoOrient(_Enum): '''N/A @@ -716,14 +797,17 @@ class VideoOrient(_Enum): 6: 'right_top', 7: 'right_bottom', } -VideoOrient.bottom_left = VideoOrient(2) + + +VideoOrient.bottom_left = VideoOrient(2) VideoOrient.bottom_right = VideoOrient(3) -VideoOrient.left_bottom = VideoOrient(5) -VideoOrient.left_top = VideoOrient(4) +VideoOrient.left_bottom = VideoOrient(5) +VideoOrient.left_top = VideoOrient(4) VideoOrient.right_bottom = VideoOrient(7) -VideoOrient.right_top = VideoOrient(6) -VideoOrient.top_left = VideoOrient(0) -VideoOrient.top_right = VideoOrient(1) +VideoOrient.right_top = VideoOrient(6) +VideoOrient.top_left = VideoOrient(0) +VideoOrient.top_right = VideoOrient(1) + class VideoProjection(_Enum): '''N/A @@ -733,9 +817,12 @@ class VideoProjection(_Enum): 1: 'equirectangular', 0x100: 'cubemap_layout_standard', } + + VideoProjection.cubemap_layout_standard = VideoProjection(0x100) -VideoProjection.equirectangular = VideoProjection(1) -VideoProjection.rectangular = VideoProjection(0) +VideoProjection.equirectangular = VideoProjection(1) +VideoProjection.rectangular = VideoProjection(0) + class MediaType(_Enum): '''Media type @@ -749,12 +836,15 @@ See libvlc_media_get_type. 4: 'stream', 5: 'playlist', } + + MediaType.directory = MediaType(2) -MediaType.disc = MediaType(3) -MediaType.file = MediaType(1) -MediaType.playlist = MediaType(5) -MediaType.stream = MediaType(4) -MediaType.unknown = MediaType(0) +MediaType.disc = MediaType(3) +MediaType.file = MediaType(1) +MediaType.playlist = MediaType(5) +MediaType.stream = MediaType(4) +MediaType.unknown = MediaType(0) + class MediaParseFlag(_Enum): '''Parse flags used by libvlc_media_parse_with_options() @@ -767,11 +857,14 @@ See libvlc_media_parse_with_options. 0x4: 'fetch_network', 0x8: 'do_interact', } -MediaParseFlag.do_interact = MediaParseFlag(0x8) -MediaParseFlag.fetch_local = MediaParseFlag(0x2) + + +MediaParseFlag.do_interact = MediaParseFlag(0x8) +MediaParseFlag.fetch_local = MediaParseFlag(0x2) MediaParseFlag.fetch_network = MediaParseFlag(0x4) -MediaParseFlag.local = MediaParseFlag(0x0) -MediaParseFlag.network = MediaParseFlag(0x1) +MediaParseFlag.local = MediaParseFlag(0x0) +MediaParseFlag.network = MediaParseFlag(0x1) + class MediaParsedStatus(_Enum): '''Parse status used sent by libvlc_media_parse_with_options() or returned by @@ -785,11 +878,14 @@ See libvlc_media_get_parsed_status. 3: 'timeout', 4: 'done', } -MediaParsedStatus.done = MediaParsedStatus(4) -MediaParsedStatus.failed = MediaParsedStatus(2) + + +MediaParsedStatus.done = MediaParsedStatus(4) +MediaParsedStatus.failed = MediaParsedStatus(2) MediaParsedStatus.skipped = MediaParsedStatus(1) MediaParsedStatus.timeout = MediaParsedStatus(3) + class MediaSlaveType(_Enum): '''Type of a media slave: subtitle or audio. ''' @@ -797,9 +893,45 @@ class MediaSlaveType(_Enum): 0: 'subtitle', 1: 'audio', } -MediaSlaveType.audio = MediaSlaveType(1) + + +MediaSlaveType.audio = MediaSlaveType(1) MediaSlaveType.subtitle = MediaSlaveType(0) + +class MediaDiscovererCategory(_Enum): + '''Category of a media discoverer +See libvlc_media_discoverer_list_get(). + ''' + _enum_names_ = { + 0: 'devices', + 1: 'lan', + 2: 'podcasts', + 3: 'localdirs', + } + + +MediaDiscovererCategory.devices = MediaDiscovererCategory(0) +MediaDiscovererCategory.lan = MediaDiscovererCategory(1) +MediaDiscovererCategory.localdirs = MediaDiscovererCategory(3) +MediaDiscovererCategory.podcasts = MediaDiscovererCategory(2) + + +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. ''' @@ -815,16 +947,19 @@ class VideoMarqueeOption(_Enum): 8: 'X', 9: 'Y', } -VideoMarqueeOption.Color = VideoMarqueeOption(2) -VideoMarqueeOption.Enable = VideoMarqueeOption(0) -VideoMarqueeOption.Opacity = VideoMarqueeOption(3) + + +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.X = VideoMarqueeOption(8) -VideoMarqueeOption.Y = VideoMarqueeOption(9) +VideoMarqueeOption.Refresh = VideoMarqueeOption(5) +VideoMarqueeOption.Size = VideoMarqueeOption(6) +VideoMarqueeOption.Text = VideoMarqueeOption(1) +VideoMarqueeOption.Timeout = VideoMarqueeOption(7) +VideoMarqueeOption.X = VideoMarqueeOption(8) +VideoMarqueeOption.Y = VideoMarqueeOption(9) + class NavigateMode(_Enum): '''Navigation mode. @@ -837,12 +972,15 @@ class NavigateMode(_Enum): 4: 'right', 5: 'popup', } + + NavigateMode.activate = NavigateMode(0) -NavigateMode.down = NavigateMode(2) -NavigateMode.left = NavigateMode(3) -NavigateMode.popup = NavigateMode(5) -NavigateMode.right = NavigateMode(4) -NavigateMode.up = NavigateMode(1) +NavigateMode.down = NavigateMode(2) +NavigateMode.left = NavigateMode(3) +NavigateMode.popup = NavigateMode(5) +NavigateMode.right = NavigateMode(4) +NavigateMode.up = NavigateMode(1) + class Position(_Enum): '''Enumeration of values used to set position (e.g. of video title). @@ -859,16 +997,19 @@ class Position(_Enum): 7: 'bottom_left', 8: 'bottom_right', } -Position.bottom = Position(6) -Position.bottom_left = Position(7) + + +Position.bottom = Position(6) +Position.bottom_left = Position(7) Position.bottom_right = Position(8) -Position.center = Position(0) -Position.disable = Position(-1) -Position.left = Position(1) -Position.right = Position(2) -Position.top = Position(3) -Position.top_left = Position(4) -Position.top_right = Position(5) +Position.center = Position(0) +Position.disable = Position(-1) +Position.left = Position(1) +Position.right = Position(2) +Position.top = Position(3) +Position.top_left = Position(4) +Position.top_right = Position(5) + class TeletextKey(_Enum): '''Enumeration of teletext keys than can be passed via @@ -881,12 +1022,15 @@ libvlc_video_set_teletext(). 6422528: 'blue', 6881280: 'index', } -TeletextKey.blue = TeletextKey(6422528) -TeletextKey.green = TeletextKey(6750208) -TeletextKey.index = TeletextKey(6881280) -TeletextKey.red = TeletextKey(7471104) + + +TeletextKey.blue = TeletextKey(6422528) +TeletextKey.green = TeletextKey(6750208) +TeletextKey.index = TeletextKey(6881280) +TeletextKey.red = TeletextKey(7471104) TeletextKey.yellow = TeletextKey(7929856) + class VideoLogoOption(_Enum): '''Option values for libvlc_video_{get,set}_logo_{int,string}. ''' @@ -900,14 +1044,17 @@ class VideoLogoOption(_Enum): 6: 'logo_opacity', 7: 'logo_position', } -VideoLogoOption.logo_delay = VideoLogoOption(4) -VideoLogoOption.logo_enable = VideoLogoOption(0) -VideoLogoOption.logo_file = VideoLogoOption(1) -VideoLogoOption.logo_opacity = VideoLogoOption(6) + + +VideoLogoOption.logo_delay = VideoLogoOption(4) +VideoLogoOption.logo_enable = VideoLogoOption(0) +VideoLogoOption.logo_file = VideoLogoOption(1) +VideoLogoOption.logo_opacity = VideoLogoOption(6) VideoLogoOption.logo_position = VideoLogoOption(7) -VideoLogoOption.logo_repeat = VideoLogoOption(5) -VideoLogoOption.logo_x = VideoLogoOption(2) -VideoLogoOption.logo_y = VideoLogoOption(3) +VideoLogoOption.logo_repeat = VideoLogoOption(5) +VideoLogoOption.logo_x = VideoLogoOption(2) +VideoLogoOption.logo_y = VideoLogoOption(3) + class VideoAdjustOption(_Enum): '''Option values for libvlc_video_{get,set}_adjust_{int,float,bool}. @@ -920,13 +1067,16 @@ class VideoAdjustOption(_Enum): 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.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. ''' @@ -941,15 +1091,18 @@ class AudioOutputDeviceTypes(_Enum): 8: '_7_1', 10: 'SPDIF', } -AudioOutputDeviceTypes.Error = AudioOutputDeviceTypes(-1) -AudioOutputDeviceTypes.Mono = AudioOutputDeviceTypes(1) -AudioOutputDeviceTypes.SPDIF = AudioOutputDeviceTypes(10) + + +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) +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. @@ -962,12 +1115,15 @@ class AudioOutputChannel(_Enum): 4: 'Right', 5: 'Dolbys', } -AudioOutputChannel.Dolbys = AudioOutputChannel(5) -AudioOutputChannel.Error = AudioOutputChannel(-1) -AudioOutputChannel.Left = AudioOutputChannel(3) + + +AudioOutputChannel.Dolbys = AudioOutputChannel(5) +AudioOutputChannel.Error = AudioOutputChannel(-1) +AudioOutputChannel.Left = AudioOutputChannel(3) AudioOutputChannel.RStereo = AudioOutputChannel(2) -AudioOutputChannel.Right = AudioOutputChannel(4) -AudioOutputChannel.Stereo = AudioOutputChannel(1) +AudioOutputChannel.Right = AudioOutputChannel(4) +AudioOutputChannel.Stereo = AudioOutputChannel(1) + class MediaPlayerRole(_Enum): '''Media player roles. @@ -986,374 +1142,308 @@ see \ref libvlc_media_player_set_role(). 8: 'Accessibility', 9: 'Test', } + + MediaPlayerRole.Accessibility = MediaPlayerRole(8) -MediaPlayerRole.Animation = MediaPlayerRole(6) +MediaPlayerRole.Animation = MediaPlayerRole(6) MediaPlayerRole.Communication = MediaPlayerRole(3) -MediaPlayerRole.Game = MediaPlayerRole(4) -MediaPlayerRole.Music = MediaPlayerRole(1) -MediaPlayerRole.Notification = MediaPlayerRole(5) -MediaPlayerRole.Production = MediaPlayerRole(7) -MediaPlayerRole.Test = MediaPlayerRole(9) -MediaPlayerRole.Video = MediaPlayerRole(2) -MediaPlayerRole._None = MediaPlayerRole(0) +MediaPlayerRole.Game = MediaPlayerRole(4) +MediaPlayerRole.Music = MediaPlayerRole(1) +MediaPlayerRole.Notification = MediaPlayerRole(5) +MediaPlayerRole.Production = MediaPlayerRole(7) +MediaPlayerRole.Test = MediaPlayerRole(9) +MediaPlayerRole.Video = MediaPlayerRole(2) +MediaPlayerRole._None = MediaPlayerRole(0) -class PlaybackMode(_Enum): - '''Defines playback modes for playlist. + +# End of generated enum types # + +# Generated structs # +class LogMessage(ctypes.Structure): + '''N/A ''' - _enum_names_ = { - 0: 'default', - 1: 'loop', - 2: 'repeat', - } -PlaybackMode.default = PlaybackMode(0) -PlaybackMode.loop = PlaybackMode(1) -PlaybackMode.repeat = PlaybackMode(2) + pass - # End of generated enum types # - # From libvlc_structures.h +LogMessage._fields_ = ( + ('severity', ctypes.c_int), + ('type', ctypes.c_char_p), + ('name', ctypes.c_char_p), + ('header', ctypes.c_char_p), + ('message', ctypes.c_char_p), +) -class AudioOutput(_Cstruct): - def __str__(self): - return '%s(%s:%s)' % (self.__class__.__name__, self.name, self.description) +class ModuleDescription(ctypes.Structure): + '''Description of a module. + ''' + pass -AudioOutput._fields_ = [ # recursive struct - ('name', ctypes.c_char_p), - ('description', ctypes.c_char_p), - ('next', ctypes.POINTER(AudioOutput)), - ] -class LogMessage(_Cstruct): - _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), - ] +ModuleDescription._fields_ = ( + ('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 __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) +class DialogCbs(ctypes.Structure): + '''Dialog callbacks to be implemented. + ''' + pass -class MediaEvent(_Cstruct): - _fields_ = [ - ('media_name', ctypes.c_char_p), - ('instance_name', ctypes.c_char_p), - ] -class MediaStats(_Cstruct): - _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), - ] +DialogCbs._fields_ = ( +) -class MediaTrackInfo(_Cstruct): - _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 ), - ] -class AudioTrack(_Cstruct): - _fields_ = [ - ('channels', ctypes.c_uint), - ('rate', ctypes.c_uint), - ] +class Event(ctypes.Structure): + '''A libvlc event. + ''' + pass -class VideoTrack(_Cstruct): - _fields_ = [ - ('height', ctypes.c_uint), - ('width', ctypes.c_uint), - ('sar_num', ctypes.c_uint), - ('sar_den', ctypes.c_uint), - ('frame_rate_num', ctypes.c_uint), - ('frame_rate_den', ctypes.c_uint), - ] -class SubtitleTrack(_Cstruct): - _fields_ = [ - ('encoding', ctypes.c_char_p), - ] +Event._fields_ = ( + ('type', ctypes.c_int), + ('obj', ctypes.c_void_p), + ('meta_type', Meta), +) -class MediaTrackTracks(ctypes.Union): - _fields_ = [ - ('audio', ctypes.POINTER(AudioTrack)), - ('video', ctypes.POINTER(VideoTrack)), - ('subtitle', ctypes.POINTER(SubtitleTrack)), - ] -class MediaTrack(_Cstruct): - _anonymous_ = ("u",) - _fields_ = [ - ('codec', ctypes.c_uint32), - ('original_fourcc', ctypes.c_uint32), - ('id', ctypes.c_int ), - ('type', TrackType ), - ('profile', ctypes.c_int ), - ('level', ctypes.c_int ), +class MediaStats(ctypes.Structure): + '''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, playing=3, paused=4, +stopping=5, ended=6, error=7. + ''' + pass - ('u', MediaTrackTracks), - ('bitrate', ctypes.c_uint), - ('language', ctypes.c_char_p), - ('description', ctypes.c_char_p), - ] -class PlaylistItem(_Cstruct): - _fields_ = [ - ('id', ctypes.c_int ), - ('uri', ctypes.c_char_p), - ('name', ctypes.c_char_p), - ] +MediaStats._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): - return '%s #%d %s (uri %s)' % (self.__class__.__name__, self.id, self.name, self.uri) -class Position(object): - """Enum-like, immutable window position constants. +class MediaTrackInfo(ctypes.Structure): + '''N/A + ''' + pass - 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(_Cstruct): - _fields_ = [ - ('top', ctypes.c_int), - ('left', ctypes.c_int), - ('bottom', ctypes.c_int), - ('right', ctypes.c_int), - ] +MediaTrackInfo._fields_ = ( + ('codec', ctypes.c_uint32), + ('id', ctypes.c_int), + ('type', TrackType), + ('profile', ctypes.c_int), + ('level', ctypes.c_int), + ('channels', ctypes.c_uint), + ('rate', ctypes.c_uint), +) -class TrackDescription(_Cstruct): - def __str__(self): - return '%s(%d:%s)' % (self.__class__.__name__, self.id, self.name) +class AudioTrack(ctypes.Structure): + '''N/A + ''' + pass -TrackDescription._fields_ = [ # recursive struct - ('id', ctypes.c_int ), + +AudioTrack._fields_ = ( + ('channels', ctypes.c_uint), + ('rate', ctypes.c_uint), +) + + +class VideoViewpoint(ctypes.Structure): + '''Viewpoint +\warning allocate using libvlc_video_new_viewpoint(). + ''' + pass + + +VideoViewpoint._fields_ = ( + ('yaw', ctypes.c_float), + ('pitch', ctypes.c_float), + ('roll', ctypes.c_float), + ('field_of_view', ctypes.c_float), +) + + +class VideoTrack(ctypes.Structure): + '''N/A + ''' + pass + + +VideoTrack._fields_ = ( + ('height', ctypes.c_uint), + ('width', ctypes.c_uint), + ('sar_num', ctypes.c_uint), + ('sar_den', ctypes.c_uint), + ('frame_rate_num', ctypes.c_uint), + ('frame_rate_den', ctypes.c_uint), + ('orientation', VideoOrient), + ('projection', VideoProjection), + ('pose', VideoViewpoint), +) + + +class SubtitleTrack(ctypes.Structure): + '''N/A + ''' + pass + + +SubtitleTrack._fields_ = ( + ('encoding', ctypes.c_char_p), +) + + +class MediaTrack(ctypes.Structure): + '''N/A + ''' + pass + + +MediaTrack._fields_ = ( + ('codec', ctypes.c_uint32), + ('original_fourcc', ctypes.c_uint32), + ('id', ctypes.c_int), + ('type', TrackType), + ('profile', ctypes.c_int), + ('level', ctypes.c_int), + ('audio', ctypes.POINTER(AudioTrack)), + ('video', ctypes.POINTER(VideoTrack)), + ('subtitle', ctypes.POINTER(SubtitleTrack)), +) + + +class MediaSlave(ctypes.Structure): + '''A slave of a libvlc_media_t +See libvlc_media_slaves_get. + ''' + pass + + +MediaSlave._fields_ = ( + ('uri', ctypes.c_char_p), + ('type', MediaSlaveType), + ('priority', ctypes.c_uint), +) + + +class MediaDiscovererDescription(ctypes.Structure): + '''Media discoverer description +See libvlc_media_discoverer_list_get(). + ''' + pass + + +MediaDiscovererDescription._fields_ = ( + ('name', ctypes.c_char_p), + ('longname', ctypes.c_char_p), + ('cat', MediaDiscovererCategory), +) + + +class TrackDescription(ctypes.Structure): + '''Description for video, audio tracks and subtitles. it contains +id, name (description string) and pointer to next record. + ''' + pass + + +TrackDescription._fields_ = ( + ('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 - try: - libvlc_track_description_release(head) - except NameError: - libvlc_track_description_list_release(head) - return r +class TitleDescription(ctypes.Structure): + '''Description for titles. + ''' + pass -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 ), - # FIXME: Media instance - ('new_cache', ctypes.c_float ), - ('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), - ('new_scrambled', ctypes.c_longlong), - ('new_count', ctypes.c_longlong), - # FIXME: Skipped MediaList and MediaListView... - ('filename', ctypes.c_char_p ), - ('new_length', ctypes.c_longlong), - ('media_event', MediaEvent ), - ] -class Event(_Cstruct): - _fields_ = [ - ('type', EventType ), - ('object', ctypes.c_void_p), - ('u', EventUnion ), - ] +TitleDescription._fields_ = ( + ('duration', ctypes.c_int64), + ('name', ctypes.c_char_p), + ('flags', ctypes.c_uint), +) -class ModuleDescription(_Cstruct): - def __str__(self): - return '%s %s (%s)' % (self.__class__.__name__, self.shortname, self.name) +class ChapterDescription(ctypes.Structure): + '''Description for chapters. + ''' + pass -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 +ChapterDescription._fields_ = ( + ('time_offset', ctypes.c_int64), + ('duration', ctypes.c_int64), + ('name', ctypes.c_char_p), +) -class AudioOutputDevice(_Cstruct): - def __str__(self): - return '%s(%d:%s)' % (self.__class__.__name__, self.id, self.name) +class AudioOutput(ctypes.Structure): + '''Description for audio output. it contains +name, description and pointer to next record. + ''' + pass -AudioOutputDevice._fields_ = [ # recursive struct - ('next', ctypes.POINTER(AudioOutputDevice)), - ('device', ctypes.c_char_p ), + +AudioOutput._fields_ = ( + ('name', ctypes.c_char_p), ('description', ctypes.c_char_p), - ] - -class TitleDescription(_Cstruct): - _fields_ = [ - ('duration', ctypes.c_longlong), - ('name', ctypes.c_char_p), - ('menu', ctypes.c_bool), - ] - -class ChapterDescription(_Cstruct): - _fields_ = [ - ('time_offset', ctypes.c_longlong), - ('duration', ctypes.c_longlong), - ('name', ctypes.c_char_p), - ] - -class VideoViewpoint(_Cstruct): - _fields_ = [ - ('yaw', ctypes.c_float), - ('pitch', ctypes.c_float), - ('roll', ctypes.c_float), - ('field_of_view', ctypes.c_float), - ] - -class MediaDiscovererDescription(_Cstruct): - _fields_ = [ - ('name', ctypes.c_char_p), - ('longname', ctypes.c_char_p), - ('cat', MediaDiscovererCategory), - ] - - def __str__(self): - return '%s %s (%d) - %s' % (self.__class__.__name__, self.name, self.cat, self.longname) - -# This struct depends on the MediaSlaveType enum that is defined only -# in > 2.2 -if 'MediaSlaveType' in locals(): - class MediaSlave(_Cstruct): - _fields_ = [ - ('psz_uri', ctypes.c_char_p), - ('i_type', MediaSlaveType), - ('i_priority', ctypes.c_uint) - ] - -class RDDescription(_Cstruct): - _fields_ = [ - ('name', ctypes.c_char_p), - ('longname', ctypes.c_char_p) - ] + ('next', ctypes.POINTER(AudioOutput)), +) -class MediaThumbnailRequest: - def __new__(cls, *args): - if len(args) == 1 and isinstance(args[0], _Ints): - return _Constructor(cls, args[0]) +class AudioOutputDevice(ctypes.Structure): + '''Description for audio output device. + ''' + pass -class Direct3dDeviceSetup(_Cstruct): - _fields_ = [ - ('device_context', ctypes.c_void_p), - ] -class Direct3dDeviceCfg(_Cstruct): - _fields_ = [ - ('hardware_decoding', ctypes.c_bool), - ] +AudioOutputDevice._fields_ = ( + ('next', ctypes.POINTER(AudioOutputDevice)), + ('device', ctypes.c_char_p), + ('description', ctypes.c_char_p), +) -class Direct3dCfg(_Cstruct): - _fields_ = [ - ('width', ctypes.c_uint), - ('height', ctypes.c_uint), - ('bitdepth', ctypes.c_uint), - ('full_range', ctypes.c_bool), - # FIXME: should be references to enums - ('colorspace', ctypes.c_uint), - ('primaries', ctypes.c_uint), - ('transfer', ctypes.c_uint), - ] -class VideoOutputCfg(_Cstruct): - _fields_ = [ - ('surface_format', ctypes.c_int), - ('full_range', ctypes.c_bool), - # FIXME: should be references to enums - ('colorspace', ctypes.c_uint), - ('primaries', ctypes.c_uint), - ('transfer', ctypes.c_uint), - ] +class RdDescription(ctypes.Structure): + '''Renderer discoverer description +See libvlc_renderer_discoverer_list_get(). + ''' + pass -class Direct3dHdr10Metadata(_Cstruct): - _fields_ = [ - ('RedPrimary ', ctypes.c_uint16 * 2), - ('GreenPrimary', ctypes.c_uint16 * 2), - ('BluePrimary', ctypes.c_uint16 * 2), - ('WhitePoint', ctypes.c_uint16 * 2), - ('MaxMasteringLuminance', ctypes.c_uint), - ('MinMasteringLuminance', ctypes.c_uint), - ('MaxContentLightLevel', ctypes.c_uint16), - ('MaxFrameAverageLightLevel', ctypes.c_uint16), - ] + +RdDescription._fields_ = ( + ('name', ctypes.c_char_p), + ('longname', ctypes.c_char_p), +) + + +# End of generated structs # # Generated callback definitions # class Callback(ctypes.c_void_p): @@ -1361,6 +1451,8 @@ class Callback(ctypes.c_void_p): @param p_event: the event triggering the callback. """ pass + + class LogCb(ctypes.c_void_p): """Callback prototype for LibVLC log message handler. @param data: data pointer as given to L{libvlc_log_set}(). @@ -1370,36 +1462,46 @@ class LogCb(ctypes.c_void_p): @param args: variable argument list for the format @note Log message handlers B{must} be thread-safe. @warning The message context pointer, the format string parameters and the variable arguments are only valid until the callback returns. """ pass + + class MediaOpenCb(ctypes.c_void_p): """Callback prototype to open a custom bitstream input media. The same media item can be opened multiple times. Each time, this callback is invoked. It should allocate and initialize any instance-specific resources, then store them in *datap. The instance resources can be freed - in the @ref libvlc_media_close_cb callback. + in the @ref L{MediaCloseCb} callback. @param opaque: private pointer as passed to L{libvlc_media_new_callbacks}(). @return: datap storage space for a private data pointer, sizep byte length of the bitstream or UINT64_MAX if unknown. """ pass + + class MediaReadCb(ctypes.c_void_p): """Callback prototype to read data from a custom bitstream input media. - @param opaque: private pointer as set by the @ref libvlc_media_open_cb callback. + @param opaque: private pointer as set by the @ref L{MediaOpenCb} callback. @param buf: start address of the buffer to read data into. @param len: bytes length of the buffer. @return: strictly positive number of bytes read, 0 on end-of-stream, or -1 on non-recoverable error @note If no data is immediately available, then the callback should sleep. @warning The application is responsible for avoiding deadlock situations. In particular, the callback should return an error if playback is stopped; if it does not return, then L{libvlc_media_player_stop}() will never return. """ pass + + class MediaSeekCb(ctypes.c_void_p): """Callback prototype to seek a custom bitstream input media. - @param opaque: private pointer as set by the @ref libvlc_media_open_cb callback. + @param opaque: private pointer as set by the @ref L{MediaOpenCb} callback. @param offset: absolute byte offset to seek to. @return: 0 on success, -1 on error. """ pass + + class MediaCloseCb(ctypes.c_void_p): """Callback prototype to close a custom bitstream input media. - @param opaque: private pointer as set by the @ref libvlc_media_open_cb callback. + @param opaque: private pointer as set by the @ref L{MediaOpenCb} callback. """ pass + + class VideoLockCb(ctypes.c_void_p): """Callback prototype to allocate and lock a picture buffer. Whenever a new video frame needs to be decoded, the lock callback is @@ -1411,6 +1513,8 @@ class VideoLockCb(ctypes.c_void_p): @return: a private pointer for the display and unlock callbacks to identify the picture buffers. """ pass + + class VideoUnlockCb(ctypes.c_void_p): """Callback prototype to unlock a picture buffer. When the video frame decoding is complete, the unlock callback is invoked. @@ -1419,18 +1523,22 @@ class VideoUnlockCb(ctypes.c_void_p): @note: A picture buffer is unlocked after the picture is decoded, but before the picture is displayed. @param opaque: private pointer as passed to L{libvlc_video_set_callbacks}() [IN]. - @param picture: private pointer returned from the @ref libvlc_video_lock_cb callback [IN]. - @param planes: pixel planes as defined by the @ref libvlc_video_lock_cb callback (this parameter is only for convenience) [IN]. + @param picture: private pointer returned from the @ref L{VideoLockCb} callback [IN]. + @param planes: pixel planes as defined by the @ref L{VideoLockCb} callback (this parameter is only for convenience) [IN]. """ pass + + class VideoDisplayCb(ctypes.c_void_p): """Callback prototype to display a picture. When the video frame needs to be shown, as determined by the media playback clock, the display callback is invoked. @param opaque: private pointer as passed to L{libvlc_video_set_callbacks}() [IN]. - @param picture: private pointer returned from the @ref libvlc_video_lock_cb callback [IN]. + @param picture: private pointer returned from the @ref L{VideoLockCb} callback [IN]. """ pass + + class VideoFormatCb(ctypes.c_void_p): """Callback prototype to configure picture buffers format. This callback gets the format of the video as output by the video decoder @@ -1445,11 +1553,15 @@ class VideoFormatCb(ctypes.c_void_p): @return: lines table of scanlines count for each plane. """ pass + + class VideoCleanupCb(ctypes.c_void_p): """Callback prototype to configure picture buffers format. - @param opaque: private pointer as passed to L{libvlc_video_set_callbacks}() (and possibly modified by @ref libvlc_video_format_cb) [IN]. + @param opaque: private pointer as passed to L{libvlc_video_set_callbacks}() (and possibly modified by @ref L{VideoFormatCb}) [IN]. """ pass + + class AudioPlayCb(ctypes.c_void_p): """Callback prototype for audio playback. The LibVLC media player decodes and post-processes the audio signal @@ -1469,6 +1581,8 @@ class AudioPlayCb(ctypes.c_void_p): @param pts: expected play time stamp (see libvlc_delay()). """ pass + + class AudioPauseCb(ctypes.c_void_p): """Callback prototype for audio pause. LibVLC invokes this callback to pause audio playback. @@ -1477,6 +1591,8 @@ class AudioPauseCb(ctypes.c_void_p): @param pts: time stamp of the pause request (should be elapsed already). """ pass + + class AudioResumeCb(ctypes.c_void_p): """Callback prototype for audio resumption. LibVLC invokes this callback to resume audio playback after it was @@ -1486,6 +1602,8 @@ class AudioResumeCb(ctypes.c_void_p): @param pts: time stamp of the resumption request (should be elapsed already). """ pass + + class AudioFlushCb(ctypes.c_void_p): """Callback prototype for audio buffer flush. LibVLC invokes this callback if it needs to discard all pending buffers and @@ -1494,6 +1612,8 @@ class AudioFlushCb(ctypes.c_void_p): @param data: data pointer as passed to L{libvlc_audio_set_callbacks}() [IN]. """ pass + + class AudioDrainCb(ctypes.c_void_p): """Callback prototype for audio buffer drain. LibVLC may invoke this callback when the decoded audio track is ending. @@ -1502,6 +1622,8 @@ class AudioDrainCb(ctypes.c_void_p): @param data: data pointer as passed to L{libvlc_audio_set_callbacks}() [IN]. """ pass + + class AudioSetVolumeCb(ctypes.c_void_p): """Callback prototype for audio volume change. @param data: data pointer as passed to L{libvlc_audio_set_callbacks}() [IN]. @@ -1509,6 +1631,8 @@ class AudioSetVolumeCb(ctypes.c_void_p): @param mute: muted flag. """ pass + + class AudioSetupCb(ctypes.c_void_p): """Callback prototype to setup the audio playback. This is called when the media player needs to create a new audio output. @@ -1519,19 +1643,23 @@ class AudioSetupCb(ctypes.c_void_p): @return: 0 on success, anything else to skip audio playback. """ pass + + class AudioCleanupCb(ctypes.c_void_p): """Callback prototype for audio playback cleanup. This is called when the media player no longer needs an audio output. @param opaque: data pointer as passed to L{libvlc_audio_set_callbacks}() [IN]. """ pass + + class CallbackDecorators(object): "Class holding various method decorators for callback functions." - Callback = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p) + Callback = ctypes.CFUNCTYPE(None, ctypes.POINTER(Event), ctypes.c_void_p) Callback.__doc__ = '''Callback function notification. @param p_event: the event triggering the callback. ''' - LogCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_int, Log_ptr, ctypes.c_char_p, ctypes.c_void_p) + LogCb = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.c_int, Log_ptr, ctypes.c_char_p, ctypes.c_void_p) LogCb.__doc__ = '''Callback prototype for LibVLC log message handler. @param data: data pointer as given to L{libvlc_log_set}(). @param level: message level (@ref L{LogLevel}). @@ -1539,33 +1667,34 @@ class CallbackDecorators(object): @param fmt: printf() format string (as defined by ISO C11). @param args: variable argument list for the format @note Log message handlers B{must} be thread-safe. @warning The message context pointer, the format string parameters and the variable arguments are only valid until the callback returns. ''' - MediaOpenCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.POINTER(ctypes.c_void_p), ctypes.POINTER(ctypes.c_uint64)) + MediaOpenCb = ctypes.CFUNCTYPE(ctypes.c_int, ctypes.c_void_p, ctypes.POINTER(ctypes.c_void_p), + ctypes.POINTER(ctypes.c_uint64)) MediaOpenCb.__doc__ = '''Callback prototype to open a custom bitstream input media. The same media item can be opened multiple times. Each time, this callback is invoked. It should allocate and initialize any instance-specific resources, then store them in *datap. The instance resources can be freed - in the @ref libvlc_media_close_cb callback. + in the @ref L{MediaCloseCb} callback. @param opaque: private pointer as passed to L{libvlc_media_new_callbacks}(). @return: datap storage space for a private data pointer, sizep byte length of the bitstream or UINT64_MAX if unknown. ''' - MediaReadCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_char_p, ctypes.c_size_t) + MediaReadCb = ctypes.CFUNCTYPE(ctypes.c_ssize_t, ctypes.c_void_p, ctypes.POINTER(ctypes.c_char), ctypes.c_size_t) MediaReadCb.__doc__ = '''Callback prototype to read data from a custom bitstream input media. - @param opaque: private pointer as set by the @ref libvlc_media_open_cb callback. + @param opaque: private pointer as set by the @ref L{MediaOpenCb} callback. @param buf: start address of the buffer to read data into. @param len: bytes length of the buffer. @return: strictly positive number of bytes read, 0 on end-of-stream, or -1 on non-recoverable error @note If no data is immediately available, then the callback should sleep. @warning The application is responsible for avoiding deadlock situations. In particular, the callback should return an error if playback is stopped; if it does not return, then L{libvlc_media_player_stop}() will never return. ''' - MediaSeekCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_uint64) + MediaSeekCb = ctypes.CFUNCTYPE(ctypes.c_int, ctypes.c_void_p, ctypes.c_uint64) MediaSeekCb.__doc__ = '''Callback prototype to seek a custom bitstream input media. - @param opaque: private pointer as set by the @ref libvlc_media_open_cb callback. + @param opaque: private pointer as set by the @ref L{MediaOpenCb} callback. @param offset: absolute byte offset to seek to. @return: 0 on success, -1 on error. ''' - MediaCloseCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p) + MediaCloseCb = ctypes.CFUNCTYPE(None, ctypes.c_void_p) MediaCloseCb.__doc__ = '''Callback prototype to close a custom bitstream input media. - @param opaque: private pointer as set by the @ref libvlc_media_open_cb callback. + @param opaque: private pointer as set by the @ref L{MediaOpenCb} callback. ''' - VideoLockCb = ctypes.CFUNCTYPE(ctypes.POINTER(ctypes.c_void_p), ctypes.c_void_p, ctypes.POINTER(ctypes.c_void_p)) + VideoLockCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.POINTER(ctypes.c_void_p)) VideoLockCb.__doc__ = '''Callback prototype to allocate and lock a picture buffer. Whenever a new video frame needs to be decoded, the lock callback is invoked. Depending on the video chroma, one or three pixel planes of @@ -1575,7 +1704,7 @@ class CallbackDecorators(object): @param planes: start address of the pixel planes (LibVLC allocates the array of void pointers, this callback must initialize the array) [OUT]. @return: a private pointer for the display and unlock callbacks to identify the picture buffers. ''' - VideoUnlockCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p, ctypes.POINTER(ctypes.c_void_p)) + VideoUnlockCb = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.c_void_p, ctypes.POINTER(ctypes.c_void_p)) VideoUnlockCb.__doc__ = '''Callback prototype to unlock a picture buffer. When the video frame decoding is complete, the unlock callback is invoked. This callback might not be needed at all. It is only an indication that the @@ -1583,17 +1712,19 @@ class CallbackDecorators(object): @note: A picture buffer is unlocked after the picture is decoded, but before the picture is displayed. @param opaque: private pointer as passed to L{libvlc_video_set_callbacks}() [IN]. - @param picture: private pointer returned from the @ref libvlc_video_lock_cb callback [IN]. - @param planes: pixel planes as defined by the @ref libvlc_video_lock_cb callback (this parameter is only for convenience) [IN]. + @param picture: private pointer returned from the @ref L{VideoLockCb} callback [IN]. + @param planes: pixel planes as defined by the @ref L{VideoLockCb} callback (this parameter is only for convenience) [IN]. ''' - VideoDisplayCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p) + VideoDisplayCb = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.c_void_p) VideoDisplayCb.__doc__ = '''Callback prototype to display a picture. When the video frame needs to be shown, as determined by the media playback clock, the display callback is invoked. @param opaque: private pointer as passed to L{libvlc_video_set_callbacks}() [IN]. - @param picture: private pointer returned from the @ref libvlc_video_lock_cb callback [IN]. + @param picture: private pointer returned from the @ref L{VideoLockCb} callback [IN]. ''' - VideoFormatCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.POINTER(ctypes.c_void_p), ctypes.c_char_p, ctypes.POINTER(ctypes.c_uint), ctypes.POINTER(ctypes.c_uint), ctypes.POINTER(ctypes.c_uint), ctypes.POINTER(ctypes.c_uint)) + VideoFormatCb = ctypes.CFUNCTYPE(ctypes.c_uint, ctypes.POINTER(ctypes.c_void_p), ctypes.c_char_p, + ctypes.POINTER(ctypes.c_uint), ctypes.POINTER(ctypes.c_uint), + ctypes.POINTER(ctypes.c_uint), ctypes.POINTER(ctypes.c_uint)) VideoFormatCb.__doc__ = '''Callback prototype to configure picture buffers format. This callback gets the format of the video as output by the video decoder and the chain of video filters (if any). It can opt to change any parameter @@ -1606,11 +1737,11 @@ class CallbackDecorators(object): @param pitches: table of scanline pitches in bytes for each pixel plane (the table is allocated by LibVLC) [OUT]. @return: lines table of scanlines count for each plane. ''' - VideoCleanupCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p) + VideoCleanupCb = ctypes.CFUNCTYPE(None, ctypes.c_void_p) VideoCleanupCb.__doc__ = '''Callback prototype to configure picture buffers format. - @param opaque: private pointer as passed to L{libvlc_video_set_callbacks}() (and possibly modified by @ref libvlc_video_format_cb) [IN]. + @param opaque: private pointer as passed to L{libvlc_video_set_callbacks}() (and possibly modified by @ref L{VideoFormatCb}) [IN]. ''' - AudioPlayCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p, ctypes.c_uint, ctypes.c_int64) + AudioPlayCb = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.c_void_p, ctypes.c_uint, ctypes.c_int64) AudioPlayCb.__doc__ = '''Callback prototype for audio playback. The LibVLC media player decodes and post-processes the audio signal asynchronously (in an internal thread). Whenever audio samples are ready @@ -1628,14 +1759,14 @@ class CallbackDecorators(object): @param count: number of audio samples to play back. @param pts: expected play time stamp (see libvlc_delay()). ''' - AudioPauseCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_int64) + AudioPauseCb = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.c_int64) AudioPauseCb.__doc__ = '''Callback prototype for audio pause. LibVLC invokes this callback to pause audio playback. @note: The pause callback is never called if the audio is already paused. @param data: data pointer as passed to L{libvlc_audio_set_callbacks}() [IN]. @param pts: time stamp of the pause request (should be elapsed already). ''' - AudioResumeCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_int64) + AudioResumeCb = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.c_int64) AudioResumeCb.__doc__ = '''Callback prototype for audio resumption. LibVLC invokes this callback to resume audio playback after it was previously paused. @@ -1643,27 +1774,28 @@ class CallbackDecorators(object): @param data: data pointer as passed to L{libvlc_audio_set_callbacks}() [IN]. @param pts: time stamp of the resumption request (should be elapsed already). ''' - AudioFlushCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_int64) + AudioFlushCb = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.c_int64) AudioFlushCb.__doc__ = '''Callback prototype for audio buffer flush. LibVLC invokes this callback if it needs to discard all pending buffers and stop playback as soon as possible. This typically occurs when the media is stopped. @param data: data pointer as passed to L{libvlc_audio_set_callbacks}() [IN]. ''' - AudioDrainCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p) + AudioDrainCb = ctypes.CFUNCTYPE(None, ctypes.c_void_p) AudioDrainCb.__doc__ = '''Callback prototype for audio buffer drain. LibVLC may invoke this callback when the decoded audio track is ending. There will be no further decoded samples for the track, but playback should nevertheless continue until all already pending buffers are rendered. @param data: data pointer as passed to L{libvlc_audio_set_callbacks}() [IN]. ''' - AudioSetVolumeCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_float, ctypes.c_bool) + AudioSetVolumeCb = ctypes.CFUNCTYPE(None, ctypes.c_void_p, ctypes.c_float, ctypes.c_bool) AudioSetVolumeCb.__doc__ = '''Callback prototype for audio volume change. @param data: data pointer as passed to L{libvlc_audio_set_callbacks}() [IN]. @param volume: software volume (1. = nominal, 0. = mute). @param mute: muted flag. ''' - AudioSetupCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.POINTER(ctypes.c_void_p), ctypes.c_char_p, ctypes.POINTER(ctypes.c_uint), ctypes.POINTER(ctypes.c_uint)) + AudioSetupCb = ctypes.CFUNCTYPE(ctypes.c_int, ctypes.POINTER(ctypes.c_void_p), ctypes.c_char_p, + ctypes.POINTER(ctypes.c_uint), ctypes.POINTER(ctypes.c_uint)) AudioSetupCb.__doc__ = '''Callback prototype to setup the audio playback. This is called when the media player needs to create a new audio output. @param opaque: pointer to the data pointer passed to L{libvlc_audio_set_callbacks}() [IN/OUT]. @@ -1672,12 +1804,16 @@ class CallbackDecorators(object): @param channels: channels count [IN/OUT]. @return: 0 on success, anything else to skip audio playback. ''' - AudioCleanupCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p) + AudioCleanupCb = ctypes.CFUNCTYPE(None, ctypes.c_void_p) AudioCleanupCb.__doc__ = '''Callback prototype for audio playback cleanup. This is called when the media player no longer needs an audio output. @param opaque: data pointer as passed to L{libvlc_audio_set_callbacks}() [IN]. ''' + + cb = CallbackDecorators + + # End of generated enum types # # End of header.py # @@ -1695,7 +1831,6 @@ class AudioEqualizer(_Ctype): return _Constructor(cls, args[0]) return libvlc_audio_equalizer_new() - def release(self): '''Release a previously created equalizer instance. The equalizer was previously created by using L{new}() or @@ -1705,7 +1840,6 @@ class AudioEqualizer(_Ctype): ''' return libvlc_audio_equalizer_release(self) - def set_preamp(self, f_preamp): '''Set a new pre-amplification value for an equalizer. The new equalizer settings are subsequently applied to a media player by invoking @@ -1717,7 +1851,6 @@ class AudioEqualizer(_Ctype): ''' return libvlc_audio_equalizer_set_preamp(self, f_preamp) - def get_preamp(self): '''Get the current pre-amplification value from an equalizer. @return: preamp value (Hz). @@ -1725,7 +1858,6 @@ class AudioEqualizer(_Ctype): ''' return libvlc_audio_equalizer_get_preamp(self) - def set_amp_at_index(self, f_amp, u_band): '''Set a new amplification value for a particular equalizer frequency band. The new equalizer settings are subsequently applied to a media player by invoking @@ -1738,7 +1870,6 @@ class AudioEqualizer(_Ctype): ''' return libvlc_audio_equalizer_set_amp_at_index(self, f_amp, u_band) - def get_amp_at_index(self, u_band): '''Get the amplification value for a particular equalizer frequency band. @param u_band: index, counting from zero, of the frequency band to get. @@ -1747,6 +1878,7 @@ class AudioEqualizer(_Ctype): ''' return libvlc_audio_equalizer_get_amp_at_index(self, u_band) + class EventManager(_Ctype): '''Create an event manager with callback handler. @@ -1770,7 +1902,8 @@ class EventManager(_Ctype): 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.") + 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): @@ -1793,12 +1926,13 @@ class EventManager(_Ctype): 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 + # 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. @@ -1807,13 +1941,14 @@ class EventManager(_Ctype): method since ctypes does not prepend self as the first parameter, hence this closure. """ - try: # retrieve Python callback and arguments + try: # retrieve Python callback and arguments call, args, kwds = self._callbacks[k] except KeyError: # detached? pass else: # deref event.contents to simplify callback code call(event.contents, *args, **kwds) + self._callback_handler = _callback_handler self._callbacks = {} @@ -1833,7 +1968,7 @@ class EventManager(_Ctype): k = eventtype.value if k in self._callbacks: - del self._callbacks[k] # remove, regardless of libvlc return value + del self._callbacks[k] # remove, regardless of libvlc return value libvlc_event_detach(self, k, self._callback_handler, k) @@ -1874,7 +2009,7 @@ class Instance(_Ctype): os.environ.setdefault('VLC_PLUGIN_PATH', plugin_path) if PYTHON3: - args = [ str_to_bytes(a) for a in args ] + args = [str_to_bytes(a) for a in args] return libvlc_new(len(args), args) def media_player_new(self, uri=None): @@ -1940,7 +2075,14 @@ class Instance(_Ctype): """Create a new MediaList instance. @param mrls: optional list of MRL strings, bytes, or PathLike objects. """ - l = libvlc_media_list_new(self) + # API 3 vs 4: libvlc_media_list_new does not take any + # parameter as input anymore. + if len(signature(libvlc_media_list_new).parameters) == 1: + # API <= 3 + l = libvlc_media_list_new(self) + else: + # API >= 4 + l = libvlc_media_list_new() # We should take the lock, but since we did not leak the # reference, nobody else can access it. if mrls: @@ -1977,7 +2119,68 @@ class Instance(_Ctype): """ return module_description_list(libvlc_video_filter_list_get(self)) + def audio_output_device_count(self, psz_audio_output): + '''Backward compatibility stub. Do not use in new code. + \deprecated Use L{audio_output_device_list_get}() instead. + @return: always 0. + ''' + return libvlc_audio_output_device_count(self, str_to_bytes(psz_audio_output)) + def audio_output_device_longname(self, psz_output, i_device): + '''Backward compatibility stub. Do not use in new code. + \deprecated Use L{audio_output_device_list_get}() instead. + @return: always None. + ''' + return libvlc_audio_output_device_longname(self, str_to_bytes(psz_output), i_device) + + def audio_output_device_id(self, psz_audio_output, i_device): + '''Backward compatibility stub. Do not use in new code. + \deprecated Use L{audio_output_device_list_get}() instead. + @return: always None. + ''' + return libvlc_audio_output_device_id(self, str_to_bytes(psz_audio_output), i_device) + + def media_discoverer_new_from_name(self, psz_name): + '''\deprecated Use L{media_discoverer_new}() and L{media_discoverer_start}(). + ''' + return libvlc_media_discoverer_new_from_name(self, str_to_bytes(psz_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 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 None on error. + ''' + return libvlc_log_open(self) + + def playlist_play(self, i_id, i_options, ppsz_options): + '''Start playing (if there is any item in the playlist). + Additionnal playlist item options can be specified for addition to the + item before it is played. + @param i_id: the item to play. If this is a negative number, the next item will be selected. Otherwise, the item with the given ID will be played. + @param i_options: the number of options to add to the item. + @param ppsz_options: the options to add to the item. + ''' + return libvlc_playlist_play(self, i_id, i_options, ppsz_options) def release(self): '''Decrement the reference count of a libvlc instance, and destroy it @@ -1985,14 +2188,12 @@ class Instance(_Ctype): ''' 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 None for default. @@ -2000,7 +2201,6 @@ class Instance(_Ctype): ''' return libvlc_add_intf(self, str_to_bytes(name)) - def set_user_agent(self, name, http): '''Sets the application name. LibVLC passes this as the user agent string when a protocol requires it. @@ -2010,7 +2210,6 @@ class Instance(_Ctype): ''' return libvlc_set_user_agent(self, str_to_bytes(name), str_to_bytes(http)) - def set_app_id(self, id, version, icon): '''Sets some meta-information about the application. See also L{set_user_agent}(). @@ -2021,7 +2220,6 @@ class Instance(_Ctype): ''' return libvlc_set_app_id(self, str_to_bytes(id), str_to_bytes(version), str_to_bytes(icon)) - def log_unset(self): '''Unsets the logging callback. This function deregisters the logging callback for a LibVLC instance. @@ -2033,7 +2231,6 @@ class Instance(_Ctype): ''' return libvlc_log_unset(self) - def log_set(self, cb, data): '''Sets the logging callback for a LibVLC instance. This function is thread-safe: it will wait for any pending callbacks @@ -2044,7 +2241,6 @@ class Instance(_Ctype): ''' return libvlc_log_set(self, cb, data) - def log_set_file(self, stream): '''Sets up logging to a file. @param stream: FILE pointer opened for writing (the FILE pointer must remain valid until L{log_unset}()). @@ -2052,273 +2248,6 @@ class Instance(_Ctype): ''' return libvlc_log_set_file(self, stream) - - def media_discoverer_new(self, psz_name): - '''Create a media discoverer object by name. - After this object is created, you should attach to media_list events in - order to be notified of new items discovered. - You need to call L{media_discoverer_start}() in order to start the - discovery. - See L{media_discoverer_media_list} - See L{media_discoverer_event_manager} - See L{media_discoverer_start}. - @param psz_name: service name; use L{media_discoverer_list_get}() to get a list of the discoverer names available in this libVLC instance. - @return: media discover object or None in case of error. - @version: LibVLC 3.0.0 or later. - ''' - return libvlc_media_discoverer_new(self, str_to_bytes(psz_name)) - - - def media_discoverer_list_get(self, i_cat, ppp_services): - '''Get media discoverer services by category. - @param i_cat: category of services to fetch. - @param ppp_services: address to store an allocated array of media discoverer services (must be freed with L{media_discoverer_list_release}() by the caller) [OUT]. - @return: the number of media discoverer services (0 on error). - @version: LibVLC 3.0.0 and later. - ''' - return libvlc_media_discoverer_list_get(self, i_cat, ppp_services) - - - def media_library_new(self): - '''Create an new Media Library object. - @return: a new object or None on error. - ''' - return libvlc_media_library_new(self) - - - 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, str_to_bytes(psz_name), str_to_bytes(psz_input), str_to_bytes(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, str_to_bytes(psz_name), str_to_bytes(psz_input), i_options, ppsz_options, b_enabled, str_to_bytes(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, str_to_bytes(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, str_to_bytes(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, str_to_bytes(psz_name), str_to_bytes(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, str_to_bytes(psz_name), str_to_bytes(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, str_to_bytes(psz_name), str_to_bytes(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, str_to_bytes(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, str_to_bytes(psz_name), str_to_bytes(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, str_to_bytes(psz_name), str_to_bytes(psz_input), str_to_bytes(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, str_to_bytes(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, str_to_bytes(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, str_to_bytes(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, str_to_bytes(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 None on error. - ''' - return libvlc_vlm_show_media(self, str_to_bytes(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, str_to_bytes(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, str_to_bytes(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, str_to_bytes(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, str_to_bytes(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, str_to_bytes(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, str_to_bytes(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, str_to_bytes(psz_name), i_instance) - - @memoize_parameterless - 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) - - def media_new_location(self, psz_mrl): '''Create a media with a certain given media resource location, for instance a valid URL. @@ -2332,7 +2261,6 @@ class Instance(_Ctype): ''' return libvlc_media_new_location(self, str_to_bytes(psz_mrl)) - 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). @@ -2353,7 +2281,6 @@ class Instance(_Ctype): ''' return libvlc_media_new_fd(self, fd) - def media_new_callbacks(self, open_cb, read_cb, seek_cb, close_cb, opaque): '''Create a media with custom callbacks to read the data from. @param open_cb: callback to open the custom bitstream input media. @@ -2366,7 +2293,6 @@ class Instance(_Ctype): ''' return libvlc_media_new_callbacks(self, open_cb, read_cb, seek_cb, close_cb, opaque) - def media_new_as_node(self, psz_name): '''Create a media as an empty node with a given name. See L{media_release}. @@ -2375,103 +2301,35 @@ class Instance(_Ctype): ''' return libvlc_media_new_as_node(self, str_to_bytes(psz_name)) - - def renderer_discoverer_new(self, psz_name): - '''Create a renderer discoverer object by name - After this object is created, you should attach to events in order to be - notified of the discoverer events. - You need to call L{renderer_discoverer_start}() in order to start the + def media_discoverer_new(self, psz_name): + '''Create a media discoverer object by name. + After this object is created, you should attach to media_list events in + order to be notified of new items discovered. + You need to call L{media_discoverer_start}() in order to start the discovery. - See L{renderer_discoverer_event_manager}() - See L{renderer_discoverer_start}(). - @param psz_name: service name; use L{renderer_discoverer_list_get}() to get a list of the discoverer names available in this libVLC instance. + See L{media_discoverer_media_list} + See L{media_discoverer_event_manager} + See L{media_discoverer_start}. + @param psz_name: service name; use L{media_discoverer_list_get}() to get a list of the discoverer names available in this libVLC instance. @return: media discover object or None in case of error. @version: LibVLC 3.0.0 or later. ''' - return libvlc_renderer_discoverer_new(self, str_to_bytes(psz_name)) + return libvlc_media_discoverer_new(self, str_to_bytes(psz_name)) - - def renderer_discoverer_list_get(self, ppp_services): - '''Get media discoverer services - See libvlc_renderer_list_release(). - @param ppp_services: address to store an allocated array of renderer discoverer services (must be freed with libvlc_renderer_list_release() by the caller) [OUT]. + def media_discoverer_list_get(self, i_cat, ppp_services): + '''Get media discoverer services by category. + @param i_cat: category of services to fetch. + @param ppp_services: address to store an allocated array of media discoverer services (must be freed with L{media_discoverer_list_release}() by the caller) [OUT]. @return: the number of media discoverer services (0 on error). @version: LibVLC 3.0.0 and later. ''' - return libvlc_renderer_discoverer_list_get(self, ppp_services) + return libvlc_media_discoverer_list_get(self, i_cat, ppp_services) - - def audio_output_device_count(self, psz_audio_output): - '''Backward compatibility stub. Do not use in new code. - \deprecated Use L{audio_output_device_list_get}() instead. - @return: always 0. + def media_library_new(self): + '''Create an new Media Library object. + @return: a new object or None on error. ''' - return libvlc_audio_output_device_count(self, str_to_bytes(psz_audio_output)) - - - def audio_output_device_longname(self, psz_output, i_device): - '''Backward compatibility stub. Do not use in new code. - \deprecated Use L{audio_output_device_list_get}() instead. - @return: always None. - ''' - return libvlc_audio_output_device_longname(self, str_to_bytes(psz_output), i_device) - - - def audio_output_device_id(self, psz_audio_output, i_device): - '''Backward compatibility stub. Do not use in new code. - \deprecated Use L{audio_output_device_list_get}() instead. - @return: always None. - ''' - return libvlc_audio_output_device_id(self, str_to_bytes(psz_audio_output), i_device) - - - def media_discoverer_new_from_name(self, psz_name): - '''\deprecated Use L{media_discoverer_new}() and L{media_discoverer_start}(). - ''' - return libvlc_media_discoverer_new_from_name(self, str_to_bytes(psz_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 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 None on error. - ''' - return libvlc_log_open(self) - - - def playlist_play(self, i_id, i_options, ppsz_options): - '''Start playing (if there is any item in the playlist). - Additionnal playlist item options can be specified for addition to the - item before it is played. - @param i_id: the item to play. If this is a negative number, the next item will be selected. Otherwise, the item with the given ID will be played. - @param i_options: the number of options to add to the item. - @param ppsz_options: the options to add to the item. - ''' - return libvlc_playlist_play(self, i_id, i_options, ppsz_options) - + return libvlc_media_library_new(self) def audio_output_list_get(self): '''Gets the list of available audio output modules. @@ -2479,7 +2337,6 @@ class Instance(_Ctype): ''' return libvlc_audio_output_list_get(self) - def audio_output_device_list_get(self, aout): '''Gets a list of audio output devices for a given audio output module, See L{audio_output_device_set}(). @@ -2496,6 +2353,243 @@ class Instance(_Ctype): ''' return libvlc_audio_output_device_list_get(self, str_to_bytes(aout)) + def renderer_discoverer_new(self, psz_name): + '''Create a renderer discoverer object by name + After this object is created, you should attach to events in order to be + notified of the discoverer events. + You need to call L{renderer_discoverer_start}() in order to start the + discovery. + See L{renderer_discoverer_event_manager}() + See L{renderer_discoverer_start}(). + @param psz_name: service name; use L{renderer_discoverer_list_get}() to get a list of the discoverer names available in this libVLC instance. + @return: media discover object or None in case of error. + @version: LibVLC 3.0.0 or later. + ''' + return libvlc_renderer_discoverer_new(self, str_to_bytes(psz_name)) + + def renderer_discoverer_list_get(self, ppp_services): + '''Get media discoverer services + See libvlc_renderer_list_release(). + @param ppp_services: address to store an allocated array of renderer discoverer services (must be freed with libvlc_renderer_list_release() by the caller) [OUT]. + @return: the number of media discoverer services (0 on error). + @version: LibVLC 3.0.0 and later. + ''' + return libvlc_renderer_discoverer_list_get(self, ppp_services) + + 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, str_to_bytes(psz_name), str_to_bytes(psz_input), str_to_bytes(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, str_to_bytes(psz_name), str_to_bytes(psz_input), i_options, ppsz_options, + b_enabled, str_to_bytes(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, str_to_bytes(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, str_to_bytes(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, str_to_bytes(psz_name), str_to_bytes(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, str_to_bytes(psz_name), str_to_bytes(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, str_to_bytes(psz_name), str_to_bytes(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, str_to_bytes(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, str_to_bytes(psz_name), str_to_bytes(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, str_to_bytes(psz_name), str_to_bytes(psz_input), str_to_bytes(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, str_to_bytes(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, str_to_bytes(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, str_to_bytes(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, str_to_bytes(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 None on error. + ''' + return libvlc_vlm_show_media(self, str_to_bytes(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, str_to_bytes(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, str_to_bytes(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, str_to_bytes(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, str_to_bytes(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, str_to_bytes(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, str_to_bytes(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, str_to_bytes(psz_name), i_instance) + + @memoize_parameterless + 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 LogIterator(_Ctype): '''Create a new VLC log iterator. @@ -2519,14 +2613,11 @@ class LogIterator(_Ctype): def __next__(self): return self.next() - - 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. @@ -2534,6 +2625,7 @@ class LogIterator(_Ctype): ''' return libvlc_log_iterator_has_next(self) + class Media(_Ctype): '''Create a new Media instance. @@ -2586,11 +2678,58 @@ class Media(_Ctype): except ValueError: # Media not parsed, no info. return None - tracks = ( contents[i].contents for i in range(len(contents)) ) + tracks = (contents[i].contents for i in range(len(contents))) # libvlc_media_tracks_release(mediaTrack_pp, n) return tracks + def parse(self): + '''Parse a media. + This fetches (local) art, meta data and tracks information. + The method is synchronous. + \deprecated This function could block indefinitely. + Use L{parse_with_options}() instead + See L{parse_with_options} + See L{get_meta} + See L{get_tracks_info}. + ''' + return libvlc_media_parse(self) + def parse_async(self): + '''Parse a media. + This fetches (local) art, 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. + \deprecated You can't be sure to receive the libvlc_MediaParsedChanged + event (you can wait indefinitely for this event). + Use L{parse_with_options}() instead + 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): + '''Return true is the media descriptor object is parsed + \deprecated This can return true in case of failure. + Use L{get_parsed_status}() instead + 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 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. + \deprecated Use L{tracks_get}() instead. + @param tracks: address to store an allocated array of Elementary Streams descriptions (must be freed by the caller) [OUT]. + @return: the number of Elementary Streams. + ''' + return libvlc_media_get_tracks_info(self) def add_option(self, psz_options): '''Add an option to the media. @@ -2608,7 +2747,6 @@ class Media(_Ctype): ''' return libvlc_media_add_option(self, str_to_bytes(psz_options)) - def add_option_flag(self, psz_options, i_flags): '''Add an option to the media with configurable flags. This option will be used to determine how the media_player will @@ -2624,7 +2762,6 @@ class Media(_Ctype): ''' return libvlc_media_add_option_flag(self, str_to_bytes(psz_options), i_flags) - def retain(self): '''Retain a reference to a media descriptor object (L{Media}). Use L{release}() to decrement the reference count of a @@ -2632,7 +2769,6 @@ class Media(_Ctype): ''' 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 @@ -2642,20 +2778,17 @@ class Media(_Ctype): ''' 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 None. @@ -2667,7 +2800,6 @@ class Media(_Ctype): ''' 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). @@ -2676,14 +2808,12 @@ class Media(_Ctype): ''' return libvlc_media_set_meta(self, e_meta, str_to_bytes(psz_value)) - def save_meta(self): '''Save the meta previously set. @return: true if the write operation was successful. ''' return libvlc_media_save_meta(self) - def get_state(self): '''Get current state of media descriptor object. Possible media states are libvlc_NothingSpecial=0, libvlc_Opening, libvlc_Playing, libvlc_Paused, @@ -2693,7 +2823,6 @@ class Media(_Ctype): ''' 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). @@ -2701,7 +2830,6 @@ class Media(_Ctype): ''' return libvlc_media_get_stats(self, p_stats) - def subitems(self): '''Get subitems of media descriptor object. This will increment the reference count of supplied media descriptor object. Use @@ -2718,14 +2846,12 @@ class Media(_Ctype): ''' 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_with_options(self, parse_flag, timeout): '''Parse the media asynchronously with options. This fetches (local or network) art, meta data and/or tracks information. @@ -2749,7 +2875,6 @@ class Media(_Ctype): ''' return libvlc_media_parse_with_options(self, parse_flag, timeout) - def parse_stop(self): '''Stop the parsing of the media When the media parsing is stopped, the libvlc_MediaParsedChanged event will @@ -2759,7 +2884,6 @@ class Media(_Ctype): ''' return libvlc_media_parse_stop(self) - def get_parsed_status(self): '''Get Parsed status for media descriptor object. See libvlc_MediaParsedChanged @@ -2769,7 +2893,6 @@ class Media(_Ctype): ''' return libvlc_media_get_parsed_status(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 @@ -2778,7 +2901,6 @@ class Media(_Ctype): ''' 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 @@ -2786,7 +2908,6 @@ class Media(_Ctype): ''' return libvlc_media_get_user_data(self) - def get_type(self): '''Get the media type of the media descriptor object. @return: media type. @@ -2794,7 +2915,6 @@ class Media(_Ctype): ''' return libvlc_media_get_type(self) - def slaves_add(self, i_type, i_priority, psz_uri): '''Add a slave to the current media. A slave is an external input source that may contains an additional subtitle @@ -2810,7 +2930,6 @@ class Media(_Ctype): ''' return libvlc_media_slaves_add(self, i_type, i_priority, str_to_bytes(psz_uri)) - def slaves_clear(self): '''Clear all slaves previously added by L{slaves_add}() or internally. @@ -2818,7 +2937,6 @@ class Media(_Ctype): ''' return libvlc_media_slaves_clear(self) - def slaves_get(self, ppp_slaves): '''Get a media descriptor's slave list The list will contain slaves parsed by VLC or previously added by @@ -2830,66 +2948,13 @@ class Media(_Ctype): ''' return libvlc_media_slaves_get(self, ppp_slaves) - - def parse(self): - '''Parse a media. - This fetches (local) art, meta data and tracks information. - The method is synchronous. - \deprecated This function could block indefinitely. - Use L{parse_with_options}() instead - See L{parse_with_options} - See L{get_meta} - See L{get_tracks_info}. - ''' - return libvlc_media_parse(self) - - - def parse_async(self): - '''Parse a media. - This fetches (local) art, 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. - \deprecated You can't be sure to receive the libvlc_MediaParsedChanged - event (you can wait indefinitely for this event). - Use L{parse_with_options}() instead - 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): - '''Return true is the media descriptor object is parsed - \deprecated This can return true in case of failure. - Use L{get_parsed_status}() instead - 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 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. - \deprecated Use L{tracks_get}() instead. - @param tracks: address to store an allocated array of Elementary Streams descriptions (must be freed by the caller) [OUT]. - @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 None on error. ''' return libvlc_media_player_new_from_media(self) + class MediaDiscoverer(_Ctype): '''N/A ''' @@ -2899,46 +2964,6 @@ class MediaDiscoverer(_Ctype): ''' return _Constructor(cls, ptr) - def start(self): - '''Start media discovery. - To stop it, call L{stop}() or - L{list_release}() directly. - See L{stop}. - @return: -1 in case of error, 0 otherwise. - @version: LibVLC 3.0.0 or later. - ''' - return libvlc_media_discoverer_start(self) - - - def stop(self): - '''Stop media discovery. - See L{start}. - @version: LibVLC 3.0.0 or later. - ''' - return libvlc_media_discoverer_stop(self) - - - 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 media_list(self): - '''Get media service discover media list. - @return: list of media items. - ''' - return libvlc_media_discoverer_media_list(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) - - def localized_name(self): '''Get media service discover object its localized name. \deprecated Useless, use L{list_get}() to get the @@ -2956,6 +2981,42 @@ class MediaDiscoverer(_Ctype): ''' return libvlc_media_discoverer_event_manager(self) + def start(self): + '''Start media discovery. + To stop it, call L{stop}() or + L{list_release}() directly. + See L{stop}. + @return: -1 in case of error, 0 otherwise. + @version: LibVLC 3.0.0 or later. + ''' + return libvlc_media_discoverer_start(self) + + def stop(self): + '''Stop media discovery. + See L{start}. + @version: LibVLC 3.0.0 or later. + ''' + return libvlc_media_discoverer_stop(self) + + 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 media_list(self): + '''Get media service discover media list. + @return: list of media items. + ''' + return libvlc_media_discoverer_media_list(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 ''' @@ -2972,7 +3033,6 @@ class MediaLibrary(_Ctype): ''' 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 @@ -2980,20 +3040,19 @@ class MediaLibrary(_Ctype): ''' 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. @@ -3029,20 +3088,16 @@ class MediaList(_Ctype): 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. @@ -3051,7 +3106,6 @@ class MediaList(_Ctype): ''' 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. @@ -3060,7 +3114,6 @@ class MediaList(_Ctype): ''' 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. @@ -3070,7 +3123,6 @@ class MediaList(_Ctype): ''' 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. @@ -3079,7 +3131,6 @@ class MediaList(_Ctype): ''' 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. @@ -3090,7 +3141,6 @@ class MediaList(_Ctype): 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. @@ -3106,7 +3156,6 @@ class MediaList(_Ctype): 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. @@ -3116,20 +3165,17 @@ class MediaList(_Ctype): ''' 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. @@ -3144,6 +3190,7 @@ class MediaList(_Ctype): ''' return libvlc_media_list_event_manager(self) + class MediaListPlayer(_Ctype): '''Create a new MediaListPlayer instance. @@ -3168,9 +3215,7 @@ class MediaListPlayer(_Ctype): def get_instance(self): """Return the associated Instance. """ - return self._instance #PYCHOK expected - - + return self._instance # PYCHOK expected def release(self): '''Release a media_list_player after use @@ -3181,7 +3226,6 @@ class MediaListPlayer(_Ctype): ''' 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. @@ -3195,40 +3239,34 @@ class MediaListPlayer(_Ctype): ''' 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 get_media_player(self): '''Get media player of the media_list_player instance. @return: media player instance @note the caller is responsible for releasing the returned instance. ''' return libvlc_media_list_player_get_media_player(self) - 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): '''Toggle pause (or resume) media list. ''' return libvlc_media_list_player_pause(self) - def set_pause(self, do_pause): '''Pause or resume media list. @param do_pause: play/resume if zero, pause if non-zero. @@ -3236,21 +3274,18 @@ class MediaListPlayer(_Ctype): ''' return libvlc_media_list_player_set_pause(self, do_pause) - 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: L{State} 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. @@ -3265,7 +3300,6 @@ class MediaListPlayer(_Ctype): 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. @@ -3273,33 +3307,30 @@ class MediaListPlayer(_Ctype): ''' 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. @@ -3327,7 +3358,7 @@ class MediaPlayer(_Ctype): def get_instance(self): """Return the associated Instance. """ - return self._instance #PYCHOK expected + return self._instance # PYCHOK expected def set_mrl(self, mrl, *options): """Set the MRL to play. @@ -3372,7 +3403,7 @@ class MediaPlayer(_Ctype): except ValueError: # Media not parsed, no info. return None - descr = ( contents[i].contents for i in range(len(contents)) ) + descr = (contents[i].contents for i in range(len(contents))) return descr def get_full_chapter_descriptions(self, i_chapters_of_title): @@ -3389,7 +3420,7 @@ class MediaPlayer(_Ctype): except ValueError: # Media not parsed, no info. return None - descr = ( contents[i].contents for i in range(len(contents)) ) + descr = (contents[i].contents for i in range(len(contents))) return descr def video_get_size(self, num=0): @@ -3454,8 +3485,6 @@ class MediaPlayer(_Ctype): return r raise VLCException('invalid video number (%s)' % (num,)) - - def get_fps(self): '''Get movie fps rate This function is provided for backward compatibility. It cannot deal with @@ -3466,26 +3495,22 @@ class MediaPlayer(_Ctype): ''' return libvlc_media_player_get_fps(self) - def set_agl(self, drawable): '''\deprecated Use L{set_nsobject}() instead. ''' return libvlc_media_player_set_agl(self, drawable) - def get_agl(self): '''\deprecated Use L{get_nsobject}() instead. ''' return libvlc_media_player_get_agl(self) - def video_get_title_description(self): '''Get the description of available titles. @return: list containing description of available titles. It must be freed with L{track_description_list_release}(). ''' return libvlc_video_get_title_description(self) - def video_get_chapter_description(self, i_title): '''Get the description of available chapters for specific title. @param i_title: selected title. @@ -3493,7 +3518,6 @@ class MediaPlayer(_Ctype): ''' return libvlc_video_get_chapter_description(self, i_title) - def video_set_subtitle_file(self, psz_subtitle): '''Set new video subtitle file. \deprecated Use L{add_slave}() instead. @@ -3502,14 +3526,12 @@ class MediaPlayer(_Ctype): ''' return libvlc_video_set_subtitle_file(self, str_to_bytes(psz_subtitle)) - def toggle_teletext(self): '''Toggle teletext transparent status on video output. \deprecated use L{video_set_teletext}() instead. ''' return libvlc_toggle_teletext(self) - def release(self): '''Release a media_player after use Decrement the reference count of a media player object. If the @@ -3519,14 +3541,12 @@ class MediaPlayer(_Ctype): ''' 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. @@ -3534,7 +3554,6 @@ class MediaPlayer(_Ctype): ''' 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 None if no media is associated. @@ -3548,21 +3567,18 @@ class MediaPlayer(_Ctype): ''' 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. @@ -3570,19 +3586,16 @@ class MediaPlayer(_Ctype): ''' 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 set_renderer(self, p_item): '''Set a renderer to the media player @note: must be called before the first call of L{play}() to @@ -3594,7 +3607,6 @@ class MediaPlayer(_Ctype): ''' return libvlc_media_player_set_renderer(self, p_item) - def video_set_callbacks(self, lock, unlock, display, opaque): '''Set callbacks and private data to render decoded video to a custom area in memory. @@ -3628,7 +3640,6 @@ class MediaPlayer(_Ctype): ''' return libvlc_video_set_callbacks(self, lock, unlock, display, opaque) - def video_set_format(self, chroma, width, height, pitch): '''Set decoded video chroma and dimensions. This only works in combination with L{video_set_callbacks}(), @@ -3642,7 +3653,6 @@ class MediaPlayer(_Ctype): ''' return libvlc_video_set_format(self, str_to_bytes(chroma), width, height, pitch) - def video_set_format_callbacks(self, setup, cleanup): '''Set decoded video chroma and dimensions. This only works in combination with L{video_set_callbacks}(). @@ -3652,7 +3662,6 @@ class MediaPlayer(_Ctype): ''' return libvlc_video_set_format_callbacks(self, setup, cleanup) - def set_nsobject(self, drawable): '''Set the NSView handler where the media player should render its video output. Use the vout called "macosx". @@ -3680,14 +3689,12 @@ class MediaPlayer(_Ctype): ''' 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_xwindow(self, drawable): '''Set an X Window System drawable where the media player should render its video output. The call takes effect when the playback starts. If it is @@ -3710,7 +3717,6 @@ class MediaPlayer(_Ctype): ''' 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 @@ -3720,7 +3726,6 @@ class MediaPlayer(_Ctype): ''' 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 @@ -3729,7 +3734,6 @@ class MediaPlayer(_Ctype): ''' return libvlc_media_player_get_hwnd(self) - def set_android_context(self, p_awindow_handler): '''Set the android context. @param p_awindow_handler: org.videolan.libvlc.AWindow jobject owned by the org.videolan.libvlc.MediaPlayer class from the libvlc-android project. @@ -3737,7 +3741,6 @@ class MediaPlayer(_Ctype): ''' return libvlc_media_player_set_android_context(self, p_awindow_handler) - def set_evas_object(self, p_evas_object): '''Set the EFL Evas Object. @param p_evas_object: a valid EFL Evas Object (Evas_Object). @@ -3746,7 +3749,6 @@ class MediaPlayer(_Ctype): ''' return libvlc_media_player_set_evas_object(self, p_evas_object) - def audio_set_callbacks(self, play, pause, resume, flush, drain, opaque): '''Sets callbacks and private data for decoded audio. Use L{audio_set_format}() or L{audio_set_format_callbacks}() @@ -3763,7 +3765,6 @@ class MediaPlayer(_Ctype): ''' return libvlc_audio_set_callbacks(self, play, pause, resume, flush, drain, opaque) - def audio_set_volume_callback(self, set_volume): '''Set callbacks and private data for decoded audio. This only works in combination with L{audio_set_callbacks}(). @@ -3774,7 +3775,6 @@ class MediaPlayer(_Ctype): ''' return libvlc_audio_set_volume_callback(self, set_volume) - def audio_set_format_callbacks(self, setup, cleanup): '''Sets decoded audio format via callbacks. This only works in combination with L{audio_set_callbacks}(). @@ -3784,7 +3784,6 @@ class MediaPlayer(_Ctype): ''' return libvlc_audio_set_format_callbacks(self, setup, cleanup) - def audio_set_format(self, format, rate, channels): '''Sets a fixed decoded audio format. This only works in combination with L{audio_set_callbacks}(), @@ -3796,21 +3795,18 @@ class MediaPlayer(_Ctype): ''' return libvlc_audio_set_format(self, str_to_bytes(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. @@ -3818,14 +3814,12 @@ class MediaPlayer(_Ctype): ''' return libvlc_media_player_set_time(self, i_time) - def get_position(self): '''Get movie position as percentage between 0.0 and 1.0. @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 as percentage between 0.0 and 1.0. This has no effect if playback is not enabled. @@ -3834,35 +3828,30 @@ class MediaPlayer(_Ctype): ''' 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. @@ -3870,40 +3859,34 @@ class MediaPlayer(_Ctype): ''' 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 @@ -3912,7 +3895,6 @@ class MediaPlayer(_Ctype): ''' return libvlc_media_player_get_rate(self) - def set_rate(self, rate): '''Set movie play rate. @param rate: movie play rate to set. @@ -3920,35 +3902,30 @@ class MediaPlayer(_Ctype): ''' 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 L{State}. ''' return libvlc_media_player_get_state(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 program_scrambled(self): '''Check if the current program is scrambled. @return: true if the current program is scrambled \libvlc_return_bool. @@ -3956,13 +3933,11 @@ class MediaPlayer(_Ctype): ''' return libvlc_media_player_program_scrambled(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. @@ -3970,7 +3945,6 @@ class MediaPlayer(_Ctype): ''' return libvlc_media_player_navigate(self, navigate) - def set_video_title_display(self, position, timeout): '''Set if, and how, the video title will be shown when media is played. @param position: position at which to display the title, or libvlc_position_disable to prevent the title from being displayed. @@ -3979,7 +3953,6 @@ class MediaPlayer(_Ctype): ''' return libvlc_media_player_set_video_title_display(self, position, timeout) - def add_slave(self, i_type, psz_uri, b_select): '''Add a slave to the current media player. @note: If the player is playing, the slave will be added directly. This call @@ -3992,7 +3965,6 @@ class MediaPlayer(_Ctype): ''' return libvlc_media_player_add_slave(self, i_type, str_to_bytes(psz_uri), b_select) - def toggle_fullscreen(self): '''Toggle fullscreen status on non-embedded video outputs. @warning: The same limitations applies to this function @@ -4000,7 +3972,6 @@ class MediaPlayer(_Ctype): ''' 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 @@ -4013,14 +3984,12 @@ class MediaPlayer(_Ctype): ''' 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 @@ -4034,7 +4003,6 @@ class MediaPlayer(_Ctype): ''' 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 @@ -4045,7 +4013,6 @@ class MediaPlayer(_Ctype): ''' 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}(). @@ -4053,7 +4020,6 @@ class MediaPlayer(_Ctype): ''' 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 @@ -4064,21 +4030,18 @@ class MediaPlayer(_Ctype): ''' 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 None 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 None to reset to default @note Invalid aspect ratios are ignored. ''' return libvlc_video_set_aspect_ratio(self, str_to_bytes(psz_aspect)) - def video_update_viewpoint(self, p_viewpoint, b_absolute): '''Update the video viewpoint information. @note: It is safe to call this function before the media player is started. @@ -4089,21 +4052,18 @@ class MediaPlayer(_Ctype): ''' return libvlc_video_update_viewpoint(self, p_viewpoint, b_absolute) - 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: video subtitle track to select (i_id from track description). @@ -4111,7 +4071,6 @@ class MediaPlayer(_Ctype): ''' return libvlc_video_set_spu(self, i_spu) - def video_get_spu_delay(self): '''Get the current subtitle delay. Positive values means subtitles are being displayed later, negative values earlier. @@ -4120,7 +4079,6 @@ class MediaPlayer(_Ctype): ''' return libvlc_video_get_spu_delay(self) - def video_set_spu_delay(self, i_delay): '''Set the subtitle delay. This affects the timing of when the subtitle will be displayed. Positive values result in subtitles being displayed later, @@ -4132,21 +4090,18 @@ class MediaPlayer(_Ctype): ''' return libvlc_video_set_spu_delay(self, i_delay) - def video_get_crop_geometry(self): '''Get current crop filter geometry. @return: the crop filter geometry or None 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 (None to unset). ''' return libvlc_video_set_crop_geometry(self, str_to_bytes(psz_geometry)) - def video_get_teletext(self): '''Get current teletext page requested or 0 if it's disabled. Teletext is disabled by default, call L{video_set_teletext}() to enable @@ -4155,7 +4110,6 @@ class MediaPlayer(_Ctype): ''' return libvlc_video_get_teletext(self) - def video_set_teletext(self, i_page): '''Set new teletext page to retrieve. This function can also be used to send a teletext key. @@ -4163,21 +4117,18 @@ class MediaPlayer(_Ctype): ''' return libvlc_video_set_teletext(self, i_page) - 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 ID (int) or -1 if no active input. ''' return libvlc_video_get_track(self) - def video_set_track(self, i_track): '''Set video track. @param i_track: the track ID (i_id field from track description). @@ -4185,7 +4136,6 @@ class MediaPlayer(_Ctype): ''' 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. @@ -4198,28 +4148,24 @@ class MediaPlayer(_Ctype): ''' return libvlc_video_take_snapshot(self, num, str_to_bytes(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, None to disable. ''' return libvlc_video_set_deinterlace(self, str_to_bytes(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) @@ -4229,7 +4175,6 @@ class MediaPlayer(_Ctype): ''' 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. @@ -4237,14 +4182,12 @@ class MediaPlayer(_Ctype): ''' return libvlc_video_set_marquee_string(self, option, str_to_bytes(psz_text)) - def video_get_logo_int(self, option): '''Get integer logo option. @param option: logo option to get, values of L{VideoLogoOption}. ''' 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. @@ -4255,7 +4198,6 @@ class MediaPlayer(_Ctype): ''' 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. @@ -4264,7 +4206,6 @@ class MediaPlayer(_Ctype): ''' return libvlc_video_set_logo_string(self, option, str_to_bytes(psz_value)) - def video_get_adjust_int(self, option): '''Get integer adjust option. @param option: adjust option to get, values of L{VideoAdjustOption}. @@ -4272,7 +4213,6 @@ class MediaPlayer(_Ctype): ''' 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. @@ -4284,7 +4224,6 @@ class MediaPlayer(_Ctype): ''' 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 L{VideoAdjustOption}. @@ -4292,7 +4231,6 @@ class MediaPlayer(_Ctype): ''' 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. @@ -4302,7 +4240,6 @@ class MediaPlayer(_Ctype): ''' return libvlc_video_set_adjust_float(self, option, value) - def audio_output_set(self, psz_name): '''Selects an audio output module. @note: Any change will take be effect only after playback is stopped and @@ -4312,7 +4249,6 @@ class MediaPlayer(_Ctype): ''' return libvlc_audio_output_set(self, str_to_bytes(psz_name)) - def audio_output_device_enum(self): '''Gets a list of potential audio output devices, See L{audio_output_device_set}(). @@ -4327,7 +4263,6 @@ class MediaPlayer(_Ctype): ''' return libvlc_audio_output_device_enum(self) - def audio_output_device_set(self, module, device_id): '''Configures an explicit audio output device. If the module paramater is None, audio output will be moved to the device @@ -4355,7 +4290,6 @@ class MediaPlayer(_Ctype): ''' return libvlc_audio_output_device_set(self, str_to_bytes(module), str_to_bytes(device_id)) - def audio_output_device_get(self): '''Get the current audio output device identifier. This complements L{audio_output_device_set}(). @@ -4373,34 +4307,29 @@ class MediaPlayer(_Ctype): ''' return libvlc_audio_output_device_get(self) - 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) if defined, -1 if undefined/unapplicable. ''' 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 @warning This function does not always work. If there are no active audio playback stream, the mute status might not be available. If digital pass-through (S/PDIF, HDMI...) is in use, muting may be unapplicable. Also some audio output plugins do not support muting at all. @note To force silent playback, disable all audio tracks. This is more efficient and reliable than mute. ''' 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). @@ -4408,21 +4337,18 @@ class MediaPlayer(_Ctype): ''' 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 ID or -1 if no active input. ''' return libvlc_audio_get_track(self) - def audio_set_track(self, i_track): '''Set current audio track. @param i_track: the track ID (i_id field from track description). @@ -4430,14 +4356,12 @@ class MediaPlayer(_Ctype): ''' return libvlc_audio_set_track(self, i_track) - def audio_get_channel(self): '''Get current audio channel. @return: the audio channel See L{AudioOutputChannel}. ''' return libvlc_audio_get_channel(self) - def audio_set_channel(self, channel): '''Set current audio channel. @param channel: the audio channel, See L{AudioOutputChannel}. @@ -4445,7 +4369,6 @@ class MediaPlayer(_Ctype): ''' return libvlc_audio_set_channel(self, channel) - def audio_get_delay(self): '''Get current audio delay. @return: the audio delay (microseconds). @@ -4453,7 +4376,6 @@ class MediaPlayer(_Ctype): ''' 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). @@ -4462,7 +4384,6 @@ class MediaPlayer(_Ctype): ''' return libvlc_audio_set_delay(self, i_delay) - def set_equalizer(self, p_equalizer): '''Apply new equalizer settings to a media player. The equalizer is first created by invoking L{audio_equalizer_new}() or @@ -4485,7 +4406,6 @@ class MediaPlayer(_Ctype): ''' return libvlc_media_player_set_equalizer(self, p_equalizer) - def get_role(self): '''Gets the media role. @return: the media player role (\ref libvlc_media_player_role_t). @@ -4493,7 +4413,6 @@ class MediaPlayer(_Ctype): ''' return libvlc_media_player_get_role(self) - def set_role(self, role): '''Sets the media role. @param role: the media player role (\ref libvlc_media_player_role_t). @@ -4501,6 +4420,7 @@ class MediaPlayer(_Ctype): ''' return libvlc_media_player_set_role(self, role) + class Renderer(_Ctype): '''N/A ''' @@ -4520,14 +4440,12 @@ class Renderer(_Ctype): ''' return libvlc_renderer_item_hold(self) - def release(self): '''Releases a renderer item, i.e. decrements its reference counter. @version: LibVLC 3.0.0 or later. ''' return libvlc_renderer_item_release(self) - def name(self): '''Get the human readable name of a renderer item. @return: the name of the item (can't be None, must *not* be freed). @@ -4535,7 +4453,6 @@ class Renderer(_Ctype): ''' return libvlc_renderer_item_name(self) - def type(self): '''Get the type (not translated) of a renderer item. For now, the type can only be "chromecast" ("upnp", "airplay" may come later). @@ -4544,7 +4461,6 @@ class Renderer(_Ctype): ''' return libvlc_renderer_item_type(self) - def icon_uri(self): '''Get the icon uri of a renderer item. @return: the uri of the item's icon (can be None, must *not* be freed). @@ -4552,7 +4468,6 @@ class Renderer(_Ctype): ''' return libvlc_renderer_item_icon_uri(self) - def flags(self): '''Get the flags of a renderer item See LIBVLC_RENDERER_CAN_AUDIO @@ -4562,6 +4477,7 @@ class Renderer(_Ctype): ''' return libvlc_renderer_item_flags(self) + class RendererDiscoverer(_Ctype): '''N/A ''' @@ -4577,7 +4493,6 @@ class RendererDiscoverer(_Ctype): ''' return libvlc_renderer_discoverer_release(self) - def start(self): '''Start renderer discovery To stop it, call L{stop}() or @@ -4588,7 +4503,6 @@ class RendererDiscoverer(_Ctype): ''' return libvlc_renderer_discoverer_start(self) - def stop(self): '''Stop renderer discovery. See L{start}(). @@ -4604,15 +4518,407 @@ class RendererDiscoverer(_Ctype): The @ref L{Renderer} struct passed to event callbacks is owned by VLC, users should take care of holding/releasing this struct for their internal usage. - See libvlc_event_t.u.renderer_discoverer_item_added.item - See libvlc_event_t.u.renderer_discoverer_item_removed.item. + See L{Event}.u.renderer_discoverer_item_added.item + See L{Event}.u.renderer_discoverer_item_removed.item. @return: a valid event manager (can't fail). @version: LibVLC 3.0.0 or later. ''' return libvlc_renderer_discoverer_event_manager(self) - # LibVLC __version__ functions # +# LibVLC __version__ functions # + +def libvlc_media_player_get_fps(p_mi): + '''Get movie fps rate + This function is provided for backward compatibility. It cannot deal with + multiple video tracks. In LibVLC versions prior to 3.0, it would also fail + if the file format did not convey the frame rate explicitly. + \deprecated Consider using L{libvlc_media_tracks_get}() instead. + @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) + return f(p_mi) + + +def libvlc_media_player_set_agl(p_mi, drawable): + '''\deprecated Use L{libvlc_media_player_set_nsobject}() instead. + ''' + f = _Cfunctions.get('libvlc_media_player_set_agl', None) or \ + _Cfunction('libvlc_media_player_set_agl', ((1,), (1,),), None, + None, MediaPlayer, ctypes.c_uint32) + return f(p_mi, drawable) + + +def libvlc_media_player_get_agl(p_mi): + '''\deprecated Use L{libvlc_media_player_get_nsobject}() instead. + ''' + f = _Cfunctions.get('libvlc_media_player_get_agl', None) or \ + _Cfunction('libvlc_media_player_get_agl', ((1,),), None, + ctypes.c_uint32, MediaPlayer) + return f(p_mi) + + +def libvlc_track_description_release(p_track_description): + '''\deprecated Use L{libvlc_track_description_list_release}() instead. + ''' + f = _Cfunctions.get('libvlc_track_description_release', None) or \ + _Cfunction('libvlc_track_description_release', ((1,),), None, + None, ctypes.POINTER(TrackDescription)) + return f(p_track_description) + + +def libvlc_video_get_height(p_mi): + '''Get current video height. + \deprecated Use L{libvlc_video_get_size}() instead. + @param p_mi: the media player. + @return: the video pixel height or 0 if not applicable. + ''' + f = _Cfunctions.get('libvlc_video_get_height', None) or \ + _Cfunction('libvlc_video_get_height', ((1,),), None, + ctypes.c_int, MediaPlayer) + return f(p_mi) + + +def libvlc_video_get_width(p_mi): + '''Get current video width. + \deprecated Use L{libvlc_video_get_size}() instead. + @param p_mi: the media player. + @return: the video pixel width or 0 if not applicable. + ''' + f = _Cfunctions.get('libvlc_video_get_width', None) or \ + _Cfunction('libvlc_video_get_width', ((1,),), None, + ctypes.c_int, MediaPlayer) + return f(p_mi) + + +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. It must be freed with L{libvlc_track_description_list_release}(). + ''' + f = _Cfunctions.get('libvlc_video_get_title_description', None) or \ + _Cfunction('libvlc_video_get_title_description', ((1,),), None, + ctypes.POINTER(TrackDescription), MediaPlayer) + 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. It must be freed with L{libvlc_track_description_list_release}(). + ''' + 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) + return f(p_mi, i_title) + + +def libvlc_video_set_subtitle_file(p_mi, psz_subtitle): + '''Set new video subtitle file. + \deprecated Use L{libvlc_media_player_add_slave}() instead. + @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) + return f(p_mi, psz_subtitle) + + +def libvlc_toggle_teletext(p_mi): + '''Toggle teletext transparent status on video output. + \deprecated use L{libvlc_video_set_teletext}() instead. + @param p_mi: the media player. + ''' + f = _Cfunctions.get('libvlc_toggle_teletext', None) or \ + _Cfunction('libvlc_toggle_teletext', ((1,),), None, + None, MediaPlayer) + return f(p_mi) + + +def libvlc_audio_output_device_count(p_instance, psz_audio_output): + '''Backward compatibility stub. Do not use in new code. + \deprecated Use L{libvlc_audio_output_device_list_get}() instead. + @return: always 0. + ''' + 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) + return f(p_instance, psz_audio_output) + + +def libvlc_audio_output_device_longname(p_instance, psz_output, i_device): + '''Backward compatibility stub. Do not use in new code. + \deprecated Use L{libvlc_audio_output_device_list_get}() instead. + @return: always None. + ''' + 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) + return f(p_instance, psz_output, i_device) + + +def libvlc_audio_output_device_id(p_instance, psz_audio_output, i_device): + '''Backward compatibility stub. Do not use in new code. + \deprecated Use L{libvlc_audio_output_device_list_get}() instead. + @return: always None. + ''' + 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) + return f(p_instance, psz_audio_output, i_device) + + +def libvlc_media_parse(p_md): + '''Parse a media. + This fetches (local) art, meta data and tracks information. + The method is synchronous. + \deprecated This function could block indefinitely. + Use L{libvlc_media_parse_with_options}() instead + See L{libvlc_media_parse_with_options} + 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) + return f(p_md) + + +def libvlc_media_parse_async(p_md): + '''Parse a media. + This fetches (local) art, 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. + \deprecated You can't be sure to receive the libvlc_MediaParsedChanged + event (you can wait indefinitely for this event). + Use L{libvlc_media_parse_with_options}() instead + 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) + return f(p_md) + + +def libvlc_media_is_parsed(p_md): + '''Return true is the media descriptor object is parsed + \deprecated This can return true in case of failure. + Use L{libvlc_media_get_parsed_status}() instead + 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) + 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. + \deprecated Use L{libvlc_media_tracks_get}() instead. + @param p_md: media descriptor object. + @param tracks: address to store an allocated array of Elementary Streams descriptions (must be freed by the caller) [OUT]. + @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.POINTER(MediaTrackInfo))) + return f(p_md) + + +def libvlc_media_discoverer_new_from_name(p_inst, psz_name): + '''\deprecated Use L{libvlc_media_discoverer_new}() and L{libvlc_media_discoverer_start}(). + ''' + 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) + return f(p_inst, psz_name) + + +def libvlc_media_discoverer_localized_name(p_mdis): + '''Get media service discover object its localized name. + \deprecated Useless, use L{libvlc_media_discoverer_list_get}() to get the + longname of the service discovery. + @param p_mdis: media discover object. + @return: localized name or None if the media_discoverer is not started. + ''' + f = _Cfunctions.get('libvlc_media_discoverer_localized_name', None) or \ + _Cfunction('libvlc_media_discoverer_localized_name', ((1,),), string_result, + ctypes.c_void_p, MediaDiscoverer) + return f(p_mdis) + + +def libvlc_media_discoverer_event_manager(p_mdis): + '''Get event manager from media service discover object. + \deprecated Useless, media_discoverer events are only triggered when calling + L{libvlc_media_discoverer_start}() and L{libvlc_media_discoverer_stop}(). + @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) + return f(p_mdis) + + +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 @warning This function wastes one thread doing basically nothing. libvlc_set_exit_handler() should be used instead. + ''' + f = _Cfunctions.get('libvlc_wait', None) or \ + _Cfunction('libvlc_wait', ((1,),), None, + None, Instance) + return f(p_instance) + + +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) + 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) + 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 None on error. + ''' + f = _Cfunctions.get('libvlc_log_open', None) or \ + _Cfunction('libvlc_log_open', ((1,),), None, + Log_ptr, Instance) + 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 None. + ''' + f = _Cfunctions.get('libvlc_log_close', None) or \ + _Cfunction('libvlc_log_close', ((1,),), None, + None, Log_ptr) + 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_ptr) + 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_ptr) + 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 None on error or if the parameter was None. + ''' + f = _Cfunctions.get('libvlc_log_get_iterator', None) or \ + _Cfunction('libvlc_log_get_iterator', ((1,),), class_result(LogIterator), + ctypes.c_void_p, Log_ptr) + 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 None. + ''' + f = _Cfunctions.get('libvlc_log_iterator_free', None) or \ + _Cfunction('libvlc_log_iterator_free', ((1,),), None, + None, LogIterator) + 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) + return f(p_iter) + + +def libvlc_log_iterator_next(p_iter, p_buf): + '''Always returns None. + This function is only provided for backward compatibility. + @param p_iter: libvlc log iterator or None. + @param p_buf: ignored. + @return: always None. + ''' + f = _Cfunctions.get('libvlc_log_iterator_next', None) or \ + _Cfunction('libvlc_log_iterator_next', ((1,), (1,),), None, + ctypes.POINTER(LogMessage), LogIterator, ctypes.POINTER(LogMessage)) + return f(p_iter, p_buf) + + +def libvlc_playlist_play(p_instance, i_id, i_options, ppsz_options): + '''Start playing (if there is any item in the playlist). + Additionnal playlist item options can be specified for addition to the + item before it is played. + @param p_instance: the playlist instance. + @param i_id: the item to play. If this is a negative number, the next item will be selected. Otherwise, the item with the given ID will be played. + @param i_options: the number of options to add to the item. + @param ppsz_options: the options to add to the item. + ''' + f = _Cfunctions.get('libvlc_playlist_play', None) or \ + _Cfunction('libvlc_playlist_play', ((1,), (1,), (1,), (1,),), None, + None, Instance, ctypes.c_int, ctypes.c_int, ListPOINTER(ctypes.c_char_p)) + return f(p_instance, i_id, i_options, ppsz_options) + def libvlc_clearerr(): '''Clears the LibVLC error status for the current thread. This is optional. @@ -4621,9 +4927,10 @@ def libvlc_clearerr(): ''' f = _Cfunctions.get('libvlc_clearerr', None) or \ _Cfunction('libvlc_clearerr', (), None, - None) + None) return f() + def libvlc_vprinterr(fmt, ap): '''Sets the LibVLC error status and message for the current thread. Any previous error is overridden. @@ -4633,9 +4940,10 @@ def libvlc_vprinterr(fmt, ap): ''' f = _Cfunctions.get('libvlc_vprinterr', None) or \ _Cfunction('libvlc_vprinterr', ((1,), (1,),), None, - ctypes.c_char_p, ctypes.c_char_p, ctypes.c_void_p) + ctypes.c_char_p, ctypes.c_char_p, ctypes.c_void_p) return f(fmt, ap) + def libvlc_new(argc, argv): '''Create and initialize a libvlc instance. This functions accept a list of "command line" arguments similar to the @@ -4675,9 +4983,10 @@ def libvlc_new(argc, argv): ''' 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)) + ctypes.c_void_p, ctypes.c_int, ListPOINTER(ctypes.c_char_p)) return f(argc, argv) + def libvlc_release(p_instance): '''Decrement the reference count of a libvlc instance, and destroy it if it reaches zero. @@ -4685,9 +4994,10 @@ def libvlc_release(p_instance): ''' f = _Cfunctions.get('libvlc_release', None) or \ _Cfunction('libvlc_release', ((1,),), None, - None, Instance) + None, Instance) 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. @@ -4695,9 +5005,10 @@ def libvlc_retain(p_instance): ''' f = _Cfunctions.get('libvlc_retain', None) or \ _Cfunction('libvlc_retain', ((1,),), None, - None, Instance) + None, Instance) 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. @@ -4706,9 +5017,10 @@ def libvlc_add_intf(p_instance, name): ''' f = _Cfunctions.get('libvlc_add_intf', None) or \ _Cfunction('libvlc_add_intf', ((1,), (1,),), None, - ctypes.c_int, Instance, ctypes.c_char_p) + ctypes.c_int, Instance, ctypes.c_char_p) return f(p_instance, name) + 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. @@ -4719,9 +5031,10 @@ def libvlc_set_user_agent(p_instance, name, http): ''' 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) + None, Instance, ctypes.c_char_p, ctypes.c_char_p) return f(p_instance, name, http) + def libvlc_set_app_id(p_instance, id, version, icon): '''Sets some meta-information about the application. See also L{libvlc_set_user_agent}(). @@ -4733,9 +5046,10 @@ def libvlc_set_app_id(p_instance, id, version, icon): ''' f = _Cfunctions.get('libvlc_set_app_id', None) or \ _Cfunction('libvlc_set_app_id', ((1,), (1,), (1,), (1,),), None, - None, Instance, ctypes.c_char_p, ctypes.c_char_p, ctypes.c_char_p) + None, Instance, ctypes.c_char_p, ctypes.c_char_p, ctypes.c_char_p) return f(p_instance, id, version, icon) + def libvlc_get_version(): '''Retrieve libvlc version. Example: "1.1.0-git The Luggage". @@ -4743,9 +5057,10 @@ def libvlc_get_version(): ''' f = _Cfunctions.get('libvlc_get_version', None) or \ _Cfunction('libvlc_get_version', (), None, - ctypes.c_char_p) + ctypes.c_char_p) return f() + def libvlc_get_compiler(): '''Retrieve libvlc compiler version. Example: "gcc version 4.2.3 (Ubuntu 4.2.3-2ubuntu6)". @@ -4753,9 +5068,10 @@ def libvlc_get_compiler(): ''' f = _Cfunctions.get('libvlc_get_compiler', None) or \ _Cfunction('libvlc_get_compiler', (), None, - ctypes.c_char_p) + ctypes.c_char_p) return f() + def libvlc_get_changeset(): '''Retrieve libvlc changeset. Example: "aa9bce0bc4". @@ -4763,9 +5079,10 @@ def libvlc_get_changeset(): ''' f = _Cfunctions.get('libvlc_get_changeset', None) or \ _Cfunction('libvlc_get_changeset', (), None, - ctypes.c_char_p) + ctypes.c_char_p) 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 @@ -4774,9 +5091,10 @@ def libvlc_free(ptr): ''' f = _Cfunctions.get('libvlc_free', None) or \ _Cfunction('libvlc_free', ((1,),), None, - None, ctypes.c_void_p) + None, ctypes.c_void_p) 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. @@ -4787,9 +5105,10 @@ def libvlc_event_attach(p_event_manager, i_event_type, f_callback, user_data): ''' f = _Cfunctions.get('libvlc_event_attach', None) or \ _Cfunction('libvlc_event_attach', ((1,), (1,), (1,), (1,),), None, - ctypes.c_int, EventManager, ctypes.c_uint, Callback, ctypes.c_void_p) + ctypes.c_int, EventManager, ctypes.c_uint, Callback, ctypes.c_void_p) 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. @@ -4799,18 +5118,20 @@ def libvlc_event_detach(p_event_manager, i_event_type, f_callback, p_user_data): ''' f = _Cfunctions.get('libvlc_event_detach', None) or \ _Cfunction('libvlc_event_detach', ((1,), (1,), (1,), (1,),), None, - None, EventManager, ctypes.c_uint, Callback, ctypes.c_void_p) + None, EventManager, ctypes.c_uint, Callback, ctypes.c_void_p) 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) + ctypes.c_char_p, ctypes.c_uint) return f(event_type) + def libvlc_log_get_context(ctx): '''Gets log message debug infos. This function retrieves self-debug information about a log message: @@ -4819,15 +5140,17 @@ def libvlc_log_get_context(ctx): - the line number within the source code module. The returned module name and file name will be None if unknown. The returned line number will similarly be zero if unknown. - @param ctx: message context (as passed to the @ref libvlc_log_cb callback). + @param ctx: message context (as passed to the @ref L{LogCb} callback). @return: module module name storage (or None), file source code file name storage (or None), line source code file line number storage (or None). @version: LibVLC 2.1.0 or later. ''' f = _Cfunctions.get('libvlc_log_get_context', None) or \ _Cfunction('libvlc_log_get_context', ((1,), (2,), (2,), (2,),), None, - None, Log_ptr, ctypes.POINTER(ctypes.c_char_p), ctypes.POINTER(ctypes.c_char_p), ctypes.POINTER(ctypes.c_uint)) + None, Log_ptr, ctypes.POINTER(ctypes.c_char_p), ctypes.POINTER(ctypes.c_char_p), + ctypes.POINTER(ctypes.c_uint)) return f(ctx) + def libvlc_log_get_object(ctx, id): '''Gets log message info. This function retrieves meta-information about a log message: @@ -4840,15 +5163,17 @@ def libvlc_log_get_object(ctx, id): is used to distinguish for VLM inputs. The returned object ID will be zero if the message is not associated with any VLC object. - @param ctx: message context (as passed to the @ref libvlc_log_cb callback). + @param ctx: message context (as passed to the @ref L{LogCb} callback). @return: name object name storage (or None), header object header (or None), line source code file line number storage (or None). @version: LibVLC 2.1.0 or later. ''' f = _Cfunctions.get('libvlc_log_get_object', None) or \ _Cfunction('libvlc_log_get_object', ((1,), (2,), (2,), (1,),), None, - None, Log_ptr, ctypes.POINTER(ctypes.c_char_p), ctypes.POINTER(ctypes.c_char_p), ctypes.POINTER(ctypes.c_uint)) + None, Log_ptr, ctypes.POINTER(ctypes.c_char_p), ctypes.POINTER(ctypes.c_char_p), + ctypes.POINTER(ctypes.c_uint)) return f(ctx, id) + def libvlc_log_unset(p_instance): '''Unsets the logging callback. This function deregisters the logging callback for a LibVLC instance. @@ -4861,9 +5186,10 @@ def libvlc_log_unset(p_instance): ''' f = _Cfunctions.get('libvlc_log_unset', None) or \ _Cfunction('libvlc_log_unset', ((1,),), None, - None, Instance) + None, Instance) return f(p_instance) + def libvlc_log_set(p_instance, cb, data): '''Sets the logging callback for a LibVLC instance. This function is thread-safe: it will wait for any pending callbacks @@ -4875,9 +5201,10 @@ def libvlc_log_set(p_instance, cb, data): ''' f = _Cfunctions.get('libvlc_log_set', None) or \ _Cfunction('libvlc_log_set', ((1,), (1,), (1,),), None, - None, Instance, LogCb, ctypes.c_void_p) + None, Instance, LogCb, ctypes.c_void_p) return f(p_instance, cb, data) + def libvlc_log_set_file(p_instance, stream): '''Sets up logging to a file. @param p_instance: libvlc instance. @@ -4886,18 +5213,20 @@ def libvlc_log_set_file(p_instance, stream): ''' f = _Cfunctions.get('libvlc_log_set_file', None) or \ _Cfunction('libvlc_log_set_file', ((1,), (1,),), None, - None, Instance, FILE_ptr) + None, Instance, FILE_ptr) return f(p_instance, stream) + 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)) + None, ctypes.POINTER(ModuleDescription)) 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. @@ -4905,9 +5234,10 @@ def libvlc_audio_filter_list_get(p_instance): ''' f = _Cfunctions.get('libvlc_audio_filter_list_get', None) or \ _Cfunction('libvlc_audio_filter_list_get', ((1,),), None, - ctypes.POINTER(ModuleDescription), Instance) + ctypes.POINTER(ModuleDescription), Instance) 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. @@ -4915,9 +5245,10 @@ def libvlc_video_filter_list_get(p_instance): ''' f = _Cfunctions.get('libvlc_video_filter_list_get', None) or \ _Cfunction('libvlc_video_filter_list_get', ((1,),), None, - ctypes.POINTER(ModuleDescription), Instance) + ctypes.POINTER(ModuleDescription), Instance) 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 @@ -4928,106 +5259,9 @@ def libvlc_clock(): ''' f = _Cfunctions.get('libvlc_clock', None) or \ _Cfunction('libvlc_clock', (), None, - ctypes.c_int64) + ctypes.c_int64) return f() -def libvlc_media_discoverer_new(p_inst, psz_name): - '''Create a media discoverer object by name. - After this object is created, you should attach to media_list events in - order to be notified of new items discovered. - You need to call L{libvlc_media_discoverer_start}() in order to start the - discovery. - See L{libvlc_media_discoverer_media_list} - See L{libvlc_media_discoverer_event_manager} - See L{libvlc_media_discoverer_start}. - @param p_inst: libvlc instance. - @param psz_name: service name; use L{libvlc_media_discoverer_list_get}() to get a list of the discoverer names available in this libVLC instance. - @return: media discover object or None in case of error. - @version: LibVLC 3.0.0 or later. - ''' - f = _Cfunctions.get('libvlc_media_discoverer_new', None) or \ - _Cfunction('libvlc_media_discoverer_new', ((1,), (1,),), class_result(MediaDiscoverer), - ctypes.c_void_p, Instance, ctypes.c_char_p) - return f(p_inst, psz_name) - -def libvlc_media_discoverer_start(p_mdis): - '''Start media discovery. - To stop it, call L{libvlc_media_discoverer_stop}() or - L{libvlc_media_discoverer_list_release}() directly. - See L{libvlc_media_discoverer_stop}. - @param p_mdis: media discover object. - @return: -1 in case of error, 0 otherwise. - @version: LibVLC 3.0.0 or later. - ''' - f = _Cfunctions.get('libvlc_media_discoverer_start', None) or \ - _Cfunction('libvlc_media_discoverer_start', ((1,),), None, - ctypes.c_int, MediaDiscoverer) - return f(p_mdis) - -def libvlc_media_discoverer_stop(p_mdis): - '''Stop media discovery. - See L{libvlc_media_discoverer_start}. - @param p_mdis: media discover object. - @version: LibVLC 3.0.0 or later. - ''' - f = _Cfunctions.get('libvlc_media_discoverer_stop', None) or \ - _Cfunction('libvlc_media_discoverer_stop', ((1,),), None, - None, MediaDiscoverer) - return f(p_mdis) - -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) - 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) - 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) - return f(p_mdis) - -def libvlc_media_discoverer_list_get(p_inst, i_cat, ppp_services): - '''Get media discoverer services by category. - @param p_inst: libvlc instance. - @param i_cat: category of services to fetch. - @param ppp_services: address to store an allocated array of media discoverer services (must be freed with L{libvlc_media_discoverer_list_release}() by the caller) [OUT]. - @return: the number of media discoverer services (0 on error). - @version: LibVLC 3.0.0 and later. - ''' - f = _Cfunctions.get('libvlc_media_discoverer_list_get', None) or \ - _Cfunction('libvlc_media_discoverer_list_get', ((1,), (1,), (1,),), None, - ctypes.c_size_t, Instance, MediaDiscovererCategory, ctypes.POINTER(ctypes.POINTER(MediaDiscovererDescription))) - return f(p_inst, i_cat, ppp_services) - -def libvlc_media_discoverer_list_release(pp_services, i_count): - '''Release an array of media discoverer services. - @param pp_services: array to release. - @param i_count: number of elements in the array. - @version: LibVLC 3.0.0 and later. See L{libvlc_media_discoverer_list_get}(). - ''' - f = _Cfunctions.get('libvlc_media_discoverer_list_release', None) or \ - _Cfunction('libvlc_media_discoverer_list_release', ((1,), (1,),), None, - None, ctypes.POINTER(MediaDiscovererDescription), ctypes.c_size_t) - return f(pp_services, i_count) def libvlc_dialog_set_context(p_id, p_context): '''Associate an opaque pointer with the dialog id. @@ -5035,22 +5269,24 @@ def libvlc_dialog_set_context(p_id, p_context): ''' f = _Cfunctions.get('libvlc_dialog_set_context', None) or \ _Cfunction('libvlc_dialog_set_context', ((1,), (1,),), None, - None, ctypes.c_void_p, ctypes.c_void_p) + None, ctypes.c_void_p, ctypes.c_void_p) return f(p_id, p_context) + def libvlc_dialog_get_context(p_id): '''Return the opaque pointer associated with the dialog id. @version: LibVLC 3.0.0 and later. ''' f = _Cfunctions.get('libvlc_dialog_get_context', None) or \ _Cfunction('libvlc_dialog_get_context', ((1,),), None, - ctypes.c_void_p, ctypes.c_void_p) + ctypes.c_void_p, ctypes.c_void_p) return f(p_id) + def libvlc_dialog_post_login(p_id, psz_username, psz_password, b_store): '''Post a login answer After this call, p_id won't be valid anymore - See libvlc_dialog_cbs.pf_display_login. + See L{DialogCbs}.pf_display_login. @param p_id: id of the dialog. @param psz_username: valid and non empty string. @param psz_password: valid string (can be empty). @@ -5060,13 +5296,14 @@ def libvlc_dialog_post_login(p_id, psz_username, psz_password, b_store): ''' f = _Cfunctions.get('libvlc_dialog_post_login', None) or \ _Cfunction('libvlc_dialog_post_login', ((1,), (1,), (1,), (1,),), None, - ctypes.c_int, ctypes.c_void_p, ctypes.c_char_p, ctypes.c_char_p, ctypes.c_bool) + ctypes.c_int, ctypes.c_void_p, ctypes.c_char_p, ctypes.c_char_p, ctypes.c_bool) return f(p_id, psz_username, psz_password, b_store) + def libvlc_dialog_post_action(p_id, i_action): '''Post a question answer After this call, p_id won't be valid anymore - See libvlc_dialog_cbs.pf_display_question. + See L{DialogCbs}.pf_display_question. @param p_id: id of the dialog. @param i_action: 1 for action1, 2 for action2. @return: 0 on success, or -1 on error. @@ -5074,378 +5311,23 @@ def libvlc_dialog_post_action(p_id, i_action): ''' f = _Cfunctions.get('libvlc_dialog_post_action', None) or \ _Cfunction('libvlc_dialog_post_action', ((1,), (1,),), None, - ctypes.c_int, ctypes.c_void_p, ctypes.c_int) + ctypes.c_int, ctypes.c_void_p, ctypes.c_int) return f(p_id, i_action) + def libvlc_dialog_dismiss(p_id): '''Dismiss a dialog After this call, p_id won't be valid anymore - See libvlc_dialog_cbs.pf_cancel. + See L{DialogCbs}.pf_cancel. @param p_id: id of the dialog. @return: 0 on success, or -1 on error. @version: LibVLC 3.0.0 and later. ''' f = _Cfunctions.get('libvlc_dialog_dismiss', None) or \ _Cfunction('libvlc_dialog_dismiss', ((1,),), None, - ctypes.c_int, ctypes.c_void_p) + ctypes.c_int, ctypes.c_void_p) return f(p_id) -def libvlc_media_library_new(p_instance): - '''Create an new Media Library object. - @param p_instance: the libvlc instance. - @return: a new object or None 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) - 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) - 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) - 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) - 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) - return f(p_mlib) - -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) - 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) - 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) - 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) - 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) - 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) - 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) - 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) - 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) - 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) - 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) - 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) - 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) - 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) - 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) - 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 None 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) - 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) - 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) - 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) - 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) - 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) - 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) - 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) - 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) - return f(p_instance) def libvlc_media_new_location(p_instance, psz_mrl): '''Create a media with a certain given media resource location, @@ -5461,9 +5343,10 @@ def libvlc_media_new_location(p_instance, psz_mrl): ''' 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) + ctypes.c_void_p, Instance, ctypes.c_char_p) 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}. @@ -5473,9 +5356,10 @@ def libvlc_media_new_path(p_instance, path): ''' 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) + ctypes.c_void_p, Instance, ctypes.c_char_p) 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). @@ -5497,9 +5381,10 @@ def libvlc_media_new_fd(p_instance, fd): ''' 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) + ctypes.c_void_p, Instance, ctypes.c_int) return f(p_instance, fd) + def libvlc_media_new_callbacks(instance, open_cb, read_cb, seek_cb, close_cb, opaque): '''Create a media with custom callbacks to read the data from. @param instance: LibVLC instance. @@ -5513,9 +5398,10 @@ def libvlc_media_new_callbacks(instance, open_cb, read_cb, seek_cb, close_cb, op ''' f = _Cfunctions.get('libvlc_media_new_callbacks', None) or \ _Cfunction('libvlc_media_new_callbacks', ((1,), (1,), (1,), (1,), (1,), (1,),), class_result(Media), - ctypes.c_void_p, Instance, MediaOpenCb, MediaReadCb, MediaSeekCb, MediaCloseCb, ctypes.c_void_p) + ctypes.c_void_p, Instance, MediaOpenCb, MediaReadCb, MediaSeekCb, MediaCloseCb, ctypes.c_void_p) return f(instance, open_cb, read_cb, seek_cb, close_cb, opaque) + 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}. @@ -5525,9 +5411,10 @@ def libvlc_media_new_as_node(p_instance, psz_name): ''' 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) + ctypes.c_void_p, Instance, ctypes.c_char_p) return f(p_instance, psz_name) + def libvlc_media_add_option(p_md, psz_options): '''Add an option to the media. This option will be used to determine how the media_player will @@ -5545,9 +5432,10 @@ def libvlc_media_add_option(p_md, psz_options): ''' f = _Cfunctions.get('libvlc_media_add_option', None) or \ _Cfunction('libvlc_media_add_option', ((1,), (1,),), None, - None, Media, ctypes.c_char_p) + None, Media, ctypes.c_char_p) return f(p_md, psz_options) + def libvlc_media_add_option_flag(p_md, psz_options, i_flags): '''Add an option to the media with configurable flags. This option will be used to determine how the media_player will @@ -5564,9 +5452,10 @@ def libvlc_media_add_option_flag(p_md, psz_options, i_flags): ''' 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) + None, Media, ctypes.c_char_p, ctypes.c_uint) return f(p_md, psz_options, i_flags) + def libvlc_media_retain(p_md): '''Retain a reference to a media descriptor object (L{Media}). Use L{libvlc_media_release}() to decrement the reference count of a @@ -5575,9 +5464,10 @@ def libvlc_media_retain(p_md): ''' f = _Cfunctions.get('libvlc_media_retain', None) or \ _Cfunction('libvlc_media_retain', ((1,),), None, - None, Media) + None, Media) 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 @@ -5588,9 +5478,10 @@ def libvlc_media_release(p_md): ''' f = _Cfunctions.get('libvlc_media_release', None) or \ _Cfunction('libvlc_media_release', ((1,),), None, - None, Media) + None, Media) 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. @@ -5598,18 +5489,20 @@ def libvlc_media_get_mrl(p_md): ''' f = _Cfunctions.get('libvlc_media_get_mrl', None) or \ _Cfunction('libvlc_media_get_mrl', ((1,),), string_result, - ctypes.c_void_p, Media) + ctypes.c_void_p, Media) 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) + ctypes.c_void_p, Media) 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 None. @@ -5622,9 +5515,10 @@ def libvlc_media_get_meta(p_md, e_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) + ctypes.c_void_p, Media, Meta) 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). @@ -5634,9 +5528,10 @@ def libvlc_media_set_meta(p_md, e_meta, psz_value): ''' 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) + None, Media, Meta, ctypes.c_char_p) 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. @@ -5644,9 +5539,10 @@ def libvlc_media_save_meta(p_md): ''' f = _Cfunctions.get('libvlc_media_save_meta', None) or \ _Cfunction('libvlc_media_save_meta', ((1,),), None, - ctypes.c_int, Media) + ctypes.c_int, Media) return f(p_md) + def libvlc_media_get_state(p_md): '''Get current state of media descriptor object. Possible media states are libvlc_NothingSpecial=0, libvlc_Opening, libvlc_Playing, libvlc_Paused, @@ -5657,9 +5553,10 @@ def libvlc_media_get_state(p_md): ''' f = _Cfunctions.get('libvlc_media_get_state', None) or \ _Cfunction('libvlc_media_get_state', ((1,),), None, - State, Media) + State, Media) 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. @@ -5668,9 +5565,10 @@ def libvlc_media_get_stats(p_md, p_stats): ''' f = _Cfunctions.get('libvlc_media_get_stats', None) or \ _Cfunction('libvlc_media_get_stats', ((1,), (1,),), None, - ctypes.c_int, Media, ctypes.POINTER(MediaStats)) + ctypes.c_int, Media, ctypes.POINTER(MediaStats)) return f(p_md, p_stats) + def libvlc_media_subitems(p_md): '''Get subitems of media descriptor object. This will increment the reference count of supplied media descriptor object. Use @@ -5680,9 +5578,10 @@ def libvlc_media_subitems(p_md): ''' f = _Cfunctions.get('libvlc_media_subitems', None) or \ _Cfunction('libvlc_media_subitems', ((1,),), class_result(MediaList), - ctypes.c_void_p, Media) + ctypes.c_void_p, Media) return f(p_md) + def libvlc_media_event_manager(p_md): '''Get event manager from media descriptor object. NOTE: this function doesn't increment reference counting. @@ -5691,9 +5590,10 @@ def libvlc_media_event_manager(p_md): ''' f = _Cfunctions.get('libvlc_media_event_manager', None) or \ _Cfunction('libvlc_media_event_manager', ((1,),), class_result(EventManager), - ctypes.c_void_p, Media) + ctypes.c_void_p, Media) 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. @@ -5701,9 +5601,10 @@ def libvlc_media_get_duration(p_md): ''' f = _Cfunctions.get('libvlc_media_get_duration', None) or \ _Cfunction('libvlc_media_get_duration', ((1,),), None, - ctypes.c_longlong, Media) + ctypes.c_longlong, Media) return f(p_md) + def libvlc_media_parse_with_options(p_md, parse_flag, timeout): '''Parse the media asynchronously with options. This fetches (local or network) art, meta data and/or tracks information. @@ -5728,9 +5629,10 @@ def libvlc_media_parse_with_options(p_md, parse_flag, timeout): ''' f = _Cfunctions.get('libvlc_media_parse_with_options', None) or \ _Cfunction('libvlc_media_parse_with_options', ((1,), (1,), (1,),), None, - ctypes.c_int, Media, MediaParseFlag, ctypes.c_int) + ctypes.c_int, Media, MediaParseFlag, ctypes.c_int) return f(p_md, parse_flag, timeout) + def libvlc_media_parse_stop(p_md): '''Stop the parsing of the media When the media parsing is stopped, the libvlc_MediaParsedChanged event will @@ -5741,9 +5643,10 @@ def libvlc_media_parse_stop(p_md): ''' f = _Cfunctions.get('libvlc_media_parse_stop', None) or \ _Cfunction('libvlc_media_parse_stop', ((1,),), None, - None, Media) + None, Media) return f(p_md) + def libvlc_media_get_parsed_status(p_md): '''Get Parsed status for media descriptor object. See libvlc_MediaParsedChanged @@ -5754,9 +5657,10 @@ def libvlc_media_get_parsed_status(p_md): ''' f = _Cfunctions.get('libvlc_media_get_parsed_status', None) or \ _Cfunction('libvlc_media_get_parsed_status', ((1,),), None, - MediaParsedStatus, Media) + MediaParsedStatus, Media) 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 @@ -5766,9 +5670,10 @@ def libvlc_media_set_user_data(p_md, p_new_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) + None, Media, ctypes.c_void_p) 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 @@ -5777,9 +5682,10 @@ def libvlc_media_get_user_data(p_md): ''' f = _Cfunctions.get('libvlc_media_get_user_data', None) or \ _Cfunction('libvlc_media_get_user_data', ((1,),), None, - ctypes.c_void_p, Media) + ctypes.c_void_p, Media) return f(p_md) + def libvlc_media_tracks_get(p_md, tracks): '''Get media descriptor's elementary streams description Note, you need to call L{libvlc_media_parse}() or play the media at least once @@ -5792,9 +5698,10 @@ def libvlc_media_tracks_get(p_md, tracks): ''' f = _Cfunctions.get('libvlc_media_tracks_get', None) or \ _Cfunction('libvlc_media_tracks_get', ((1,), (1,),), None, - ctypes.c_uint, Media, ctypes.POINTER(ctypes.POINTER(MediaTrack))) + ctypes.c_uint, Media, ctypes.POINTER(ctypes.POINTER(MediaTrack))) return f(p_md, tracks) + def libvlc_media_get_codec_description(i_type, i_codec): '''Get codec description from media elementary stream. @param i_type: i_type from L{MediaTrack}. @@ -5804,9 +5711,10 @@ def libvlc_media_get_codec_description(i_type, i_codec): ''' f = _Cfunctions.get('libvlc_media_get_codec_description', None) or \ _Cfunction('libvlc_media_get_codec_description', ((1,), (1,),), None, - ctypes.c_char_p, TrackType, ctypes.c_uint32) + ctypes.c_char_p, TrackType, ctypes.c_uint32) return f(i_type, i_codec) + def libvlc_media_tracks_release(p_tracks, i_count): '''Release media descriptor's elementary streams description array. @param p_tracks: tracks info array to release. @@ -5815,9 +5723,10 @@ def libvlc_media_tracks_release(p_tracks, i_count): ''' f = _Cfunctions.get('libvlc_media_tracks_release', None) or \ _Cfunction('libvlc_media_tracks_release', ((1,), (1,),), None, - None, ctypes.POINTER(MediaTrack), ctypes.c_uint) + None, ctypes.POINTER(ctypes.POINTER(MediaTrack)), ctypes.c_uint) return f(p_tracks, i_count) + def libvlc_media_get_type(p_md): '''Get the media type of the media descriptor object. @param p_md: media descriptor object. @@ -5826,9 +5735,10 @@ def libvlc_media_get_type(p_md): ''' f = _Cfunctions.get('libvlc_media_get_type', None) or \ _Cfunction('libvlc_media_get_type', ((1,),), None, - MediaType, Media) + MediaType, Media) return f(p_md) + def libvlc_media_slaves_add(p_md, i_type, i_priority, psz_uri): '''Add a slave to the current media. A slave is an external input source that may contains an additional subtitle @@ -5845,9 +5755,10 @@ def libvlc_media_slaves_add(p_md, i_type, i_priority, psz_uri): ''' f = _Cfunctions.get('libvlc_media_slaves_add', None) or \ _Cfunction('libvlc_media_slaves_add', ((1,), (1,), (1,), (1,),), None, - ctypes.c_int, Media, MediaSlaveType, ctypes.c_int, ctypes.c_char_p) + ctypes.c_int, Media, MediaSlaveType, ctypes.c_uint, ctypes.c_char_p) return f(p_md, i_type, i_priority, psz_uri) + def libvlc_media_slaves_clear(p_md): '''Clear all slaves previously added by L{libvlc_media_slaves_add}() or internally. @@ -5856,9 +5767,10 @@ def libvlc_media_slaves_clear(p_md): ''' f = _Cfunctions.get('libvlc_media_slaves_clear', None) or \ _Cfunction('libvlc_media_slaves_clear', ((1,),), None, - None, Media) + None, Media) return f(p_md) + def libvlc_media_slaves_get(p_md, ppp_slaves): '''Get a media descriptor's slave list The list will contain slaves parsed by VLC or previously added by @@ -5871,9 +5783,10 @@ def libvlc_media_slaves_get(p_md, ppp_slaves): ''' f = _Cfunctions.get('libvlc_media_slaves_get', None) or \ _Cfunction('libvlc_media_slaves_get', ((1,), (1,),), None, - ctypes.c_int, Media, ctypes.POINTER(ctypes.POINTER(MediaSlave))) + ctypes.c_uint, Media, ctypes.POINTER(ctypes.POINTER(MediaSlave))) return f(p_md, ppp_slaves) + def libvlc_media_slaves_release(pp_slaves, i_count): '''Release a media descriptor's slave list. @param pp_slaves: slave array to release. @@ -5882,169 +5795,174 @@ def libvlc_media_slaves_release(pp_slaves, i_count): ''' f = _Cfunctions.get('libvlc_media_slaves_release', None) or \ _Cfunction('libvlc_media_slaves_release', ((1,), (1,),), None, - None, ctypes.POINTER(MediaSlave), ctypes.c_int) + None, ctypes.POINTER(ctypes.POINTER(MediaSlave)), ctypes.c_uint) return f(pp_slaves, i_count) -def libvlc_renderer_item_hold(p_item): - '''Hold a renderer item, i.e. creates a new reference - This functions need to called from the libvlc_RendererDiscovererItemAdded - callback if the libvlc user wants to use this item after. (for display or - for passing it to the mediaplayer for example). - @return: the current item. - @version: LibVLC 3.0.0 or later. - ''' - f = _Cfunctions.get('libvlc_renderer_item_hold', None) or \ - _Cfunction('libvlc_renderer_item_hold', ((1,),), class_result(Renderer), - ctypes.c_void_p, Renderer) - return f(p_item) -def libvlc_renderer_item_release(p_item): - '''Releases a renderer item, i.e. decrements its reference counter. - @version: LibVLC 3.0.0 or later. - ''' - f = _Cfunctions.get('libvlc_renderer_item_release', None) or \ - _Cfunction('libvlc_renderer_item_release', ((1,),), None, - None, Renderer) - return f(p_item) - -def libvlc_renderer_item_name(p_item): - '''Get the human readable name of a renderer item. - @return: the name of the item (can't be None, must *not* be freed). - @version: LibVLC 3.0.0 or later. - ''' - f = _Cfunctions.get('libvlc_renderer_item_name', None) or \ - _Cfunction('libvlc_renderer_item_name', ((1,),), None, - ctypes.c_char_p, Renderer) - return f(p_item) - -def libvlc_renderer_item_type(p_item): - '''Get the type (not translated) of a renderer item. For now, the type can only - be "chromecast" ("upnp", "airplay" may come later). - @return: the type of the item (can't be None, must *not* be freed). - @version: LibVLC 3.0.0 or later. - ''' - f = _Cfunctions.get('libvlc_renderer_item_type', None) or \ - _Cfunction('libvlc_renderer_item_type', ((1,),), None, - ctypes.c_char_p, Renderer) - return f(p_item) - -def libvlc_renderer_item_icon_uri(p_item): - '''Get the icon uri of a renderer item. - @return: the uri of the item's icon (can be None, must *not* be freed). - @version: LibVLC 3.0.0 or later. - ''' - f = _Cfunctions.get('libvlc_renderer_item_icon_uri', None) or \ - _Cfunction('libvlc_renderer_item_icon_uri', ((1,),), None, - ctypes.c_char_p, Renderer) - return f(p_item) - -def libvlc_renderer_item_flags(p_item): - '''Get the flags of a renderer item - See LIBVLC_RENDERER_CAN_AUDIO - See LIBVLC_RENDERER_CAN_VIDEO. - @return: bitwise flag: capabilities of the renderer, see. - @version: LibVLC 3.0.0 or later. - ''' - f = _Cfunctions.get('libvlc_renderer_item_flags', None) or \ - _Cfunction('libvlc_renderer_item_flags', ((1,),), None, - ctypes.c_int, Renderer) - return f(p_item) - -def libvlc_renderer_discoverer_new(p_inst, psz_name): - '''Create a renderer discoverer object by name - After this object is created, you should attach to events in order to be - notified of the discoverer events. - You need to call L{libvlc_renderer_discoverer_start}() in order to start the +def libvlc_media_discoverer_new(p_inst, psz_name): + '''Create a media discoverer object by name. + After this object is created, you should attach to media_list events in + order to be notified of new items discovered. + You need to call L{libvlc_media_discoverer_start}() in order to start the discovery. - See L{libvlc_renderer_discoverer_event_manager}() - See L{libvlc_renderer_discoverer_start}(). + See L{libvlc_media_discoverer_media_list} + See L{libvlc_media_discoverer_event_manager} + See L{libvlc_media_discoverer_start}. @param p_inst: libvlc instance. - @param psz_name: service name; use L{libvlc_renderer_discoverer_list_get}() to get a list of the discoverer names available in this libVLC instance. + @param psz_name: service name; use L{libvlc_media_discoverer_list_get}() to get a list of the discoverer names available in this libVLC instance. @return: media discover object or None in case of error. @version: LibVLC 3.0.0 or later. ''' - f = _Cfunctions.get('libvlc_renderer_discoverer_new', None) or \ - _Cfunction('libvlc_renderer_discoverer_new', ((1,), (1,),), class_result(RendererDiscoverer), - ctypes.c_void_p, Instance, ctypes.c_char_p) + f = _Cfunctions.get('libvlc_media_discoverer_new', None) or \ + _Cfunction('libvlc_media_discoverer_new', ((1,), (1,),), class_result(MediaDiscoverer), + ctypes.c_void_p, Instance, ctypes.c_char_p) return f(p_inst, psz_name) -def libvlc_renderer_discoverer_release(p_rd): - '''Release a renderer discoverer object. - @param p_rd: renderer discoverer object. - @version: LibVLC 3.0.0 or later. - ''' - f = _Cfunctions.get('libvlc_renderer_discoverer_release', None) or \ - _Cfunction('libvlc_renderer_discoverer_release', ((1,),), None, - None, RendererDiscoverer) - return f(p_rd) -def libvlc_renderer_discoverer_start(p_rd): - '''Start renderer discovery - To stop it, call L{libvlc_renderer_discoverer_stop}() or - L{libvlc_renderer_discoverer_release}() directly. - See L{libvlc_renderer_discoverer_stop}(). - @param p_rd: renderer discoverer object. +def libvlc_media_discoverer_start(p_mdis): + '''Start media discovery. + To stop it, call L{libvlc_media_discoverer_stop}() or + L{libvlc_media_discoverer_list_release}() directly. + See L{libvlc_media_discoverer_stop}. + @param p_mdis: media discover object. @return: -1 in case of error, 0 otherwise. @version: LibVLC 3.0.0 or later. ''' - f = _Cfunctions.get('libvlc_renderer_discoverer_start', None) or \ - _Cfunction('libvlc_renderer_discoverer_start', ((1,),), None, - ctypes.c_int, RendererDiscoverer) - return f(p_rd) + f = _Cfunctions.get('libvlc_media_discoverer_start', None) or \ + _Cfunction('libvlc_media_discoverer_start', ((1,),), None, + ctypes.c_int, MediaDiscoverer) + return f(p_mdis) -def libvlc_renderer_discoverer_stop(p_rd): - '''Stop renderer discovery. - See L{libvlc_renderer_discoverer_start}(). - @param p_rd: renderer discoverer object. + +def libvlc_media_discoverer_stop(p_mdis): + '''Stop media discovery. + See L{libvlc_media_discoverer_start}. + @param p_mdis: media discover object. @version: LibVLC 3.0.0 or later. ''' - f = _Cfunctions.get('libvlc_renderer_discoverer_stop', None) or \ - _Cfunction('libvlc_renderer_discoverer_stop', ((1,),), None, - None, RendererDiscoverer) - return f(p_rd) + f = _Cfunctions.get('libvlc_media_discoverer_stop', None) or \ + _Cfunction('libvlc_media_discoverer_stop', ((1,),), None, + None, MediaDiscoverer) + return f(p_mdis) -def libvlc_renderer_discoverer_event_manager(p_rd): - '''Get the event manager of the renderer discoverer - The possible events to attach are @ref libvlc_RendererDiscovererItemAdded - and @ref libvlc_RendererDiscovererItemDeleted. - The @ref L{Renderer} struct passed to event callbacks is owned by - VLC, users should take care of holding/releasing this struct for their - internal usage. - See libvlc_event_t.u.renderer_discoverer_item_added.item - See libvlc_event_t.u.renderer_discoverer_item_removed.item. - @return: a valid event manager (can't fail). - @version: LibVLC 3.0.0 or later. + +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_renderer_discoverer_event_manager', None) or \ - _Cfunction('libvlc_renderer_discoverer_event_manager', ((1,),), class_result(EventManager), - ctypes.c_void_p, RendererDiscoverer) - return f(p_rd) + f = _Cfunctions.get('libvlc_media_discoverer_release', None) or \ + _Cfunction('libvlc_media_discoverer_release', ((1,),), None, + None, MediaDiscoverer) + return f(p_mdis) -def libvlc_renderer_discoverer_list_get(p_inst, ppp_services): - '''Get media discoverer services - See libvlc_renderer_list_release(). + +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) + 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) + return f(p_mdis) + + +def libvlc_media_discoverer_list_get(p_inst, i_cat, ppp_services): + '''Get media discoverer services by category. @param p_inst: libvlc instance. - @param ppp_services: address to store an allocated array of renderer discoverer services (must be freed with libvlc_renderer_list_release() by the caller) [OUT]. + @param i_cat: category of services to fetch. + @param ppp_services: address to store an allocated array of media discoverer services (must be freed with L{libvlc_media_discoverer_list_release}() by the caller) [OUT]. @return: the number of media discoverer services (0 on error). @version: LibVLC 3.0.0 and later. ''' - f = _Cfunctions.get('libvlc_renderer_discoverer_list_get', None) or \ - _Cfunction('libvlc_renderer_discoverer_list_get', ((1,), (1,),), None, - ctypes.c_size_t, Instance, ctypes.POINTER(ctypes.POINTER(RDDescription))) - return f(p_inst, ppp_services) + f = _Cfunctions.get('libvlc_media_discoverer_list_get', None) or \ + _Cfunction('libvlc_media_discoverer_list_get', ((1,), (1,), (1,),), None, + ctypes.c_size_t, Instance, MediaDiscovererCategory, + ctypes.POINTER(ctypes.POINTER(ctypes.POINTER(MediaDiscovererDescription)))) + return f(p_inst, i_cat, ppp_services) -def libvlc_renderer_discoverer_list_release(pp_services, i_count): - '''Release an array of media discoverer services - See L{libvlc_renderer_discoverer_list_get}(). + +def libvlc_media_discoverer_list_release(pp_services, i_count): + '''Release an array of media discoverer services. @param pp_services: array to release. @param i_count: number of elements in the array. - @version: LibVLC 3.0.0 and later. + @version: LibVLC 3.0.0 and later. See L{libvlc_media_discoverer_list_get}(). ''' - f = _Cfunctions.get('libvlc_renderer_discoverer_list_release', None) or \ - _Cfunction('libvlc_renderer_discoverer_list_release', ((1,), (1,),), None, - None, ctypes.POINTER(RDDescription), ctypes.c_size_t) + f = _Cfunctions.get('libvlc_media_discoverer_list_release', None) or \ + _Cfunction('libvlc_media_discoverer_list_release', ((1,), (1,),), None, + None, ctypes.POINTER(ctypes.POINTER(MediaDiscovererDescription)), ctypes.c_size_t) return f(pp_services, i_count) + +def libvlc_media_library_new(p_instance): + '''Create an new Media Library object. + @param p_instance: the libvlc instance. + @return: a new object or None 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) + 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) + 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) + 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) + 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) + return f(p_mlib) + + def libvlc_media_list_new(p_instance): '''Create an empty media list. @param p_instance: libvlc instance. @@ -6052,27 +5970,30 @@ def libvlc_media_list_new(p_instance): ''' f = _Cfunctions.get('libvlc_media_list_new', None) or \ _Cfunction('libvlc_media_list_new', ((1,),), class_result(MediaList), - ctypes.c_void_p, Instance) + ctypes.c_void_p, Instance) 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) + None, MediaList) 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) + None, MediaList) 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. @@ -6082,9 +6003,10 @@ def libvlc_media_list_set_media(p_ml, p_md): ''' f = _Cfunctions.get('libvlc_media_list_set_media', None) or \ _Cfunction('libvlc_media_list_set_media', ((1,), (1,),), None, - None, MediaList, Media) + None, MediaList, Media) 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. @@ -6094,9 +6016,10 @@ def libvlc_media_list_media(p_ml): ''' f = _Cfunctions.get('libvlc_media_list_media', None) or \ _Cfunction('libvlc_media_list_media', ((1,),), class_result(Media), - ctypes.c_void_p, MediaList) + ctypes.c_void_p, MediaList) 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. @@ -6106,9 +6029,10 @@ def libvlc_media_list_add_media(p_ml, p_md): ''' f = _Cfunctions.get('libvlc_media_list_add_media', None) or \ _Cfunction('libvlc_media_list_add_media', ((1,), (1,),), None, - ctypes.c_int, MediaList, Media) + ctypes.c_int, MediaList, Media) 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. @@ -6119,9 +6043,10 @@ def libvlc_media_list_insert_media(p_ml, p_md, i_pos): ''' 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) + ctypes.c_int, MediaList, Media, ctypes.c_int) 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. @@ -6131,9 +6056,10 @@ def libvlc_media_list_remove_index(p_ml, i_pos): ''' 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) + ctypes.c_int, MediaList, ctypes.c_int) 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. @@ -6142,9 +6068,10 @@ def libvlc_media_list_count(p_ml): ''' f = _Cfunctions.get('libvlc_media_list_count', None) or \ _Cfunction('libvlc_media_list_count', ((1,),), None, - ctypes.c_int, MediaList) + ctypes.c_int, MediaList) 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. @@ -6154,9 +6081,10 @@ def libvlc_media_list_item_at_index(p_ml, i_pos): ''' 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) + ctypes.c_void_p, MediaList, ctypes.c_int) 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. @@ -6167,9 +6095,10 @@ def libvlc_media_list_index_of_item(p_ml, p_md): ''' 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) + ctypes.c_int, MediaList, Media) 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. @@ -6177,18 +6106,20 @@ def libvlc_media_list_is_readonly(p_ml): ''' f = _Cfunctions.get('libvlc_media_list_is_readonly', None) or \ _Cfunction('libvlc_media_list_is_readonly', ((1,),), None, - ctypes.c_int, MediaList) + ctypes.c_int, MediaList) 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) + None, MediaList) 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. @@ -6196,9 +6127,10 @@ def libvlc_media_list_unlock(p_ml): ''' f = _Cfunctions.get('libvlc_media_list_unlock', None) or \ _Cfunction('libvlc_media_list_unlock', ((1,),), None, - None, MediaList) + None, MediaList) 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. @@ -6207,368 +6139,210 @@ def libvlc_media_list_event_manager(p_ml): ''' 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) + ctypes.c_void_p, MediaList) return f(p_ml) -def libvlc_media_player_get_fps(p_mi): - '''Get movie fps rate - This function is provided for backward compatibility. It cannot deal with - multiple video tracks. In LibVLC versions prior to 3.0, it would also fail - if the file format did not convey the frame rate explicitly. - \deprecated Consider using L{libvlc_media_tracks_get}() instead. - @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) - return f(p_mi) -def libvlc_media_player_set_agl(p_mi, drawable): - '''\deprecated Use L{libvlc_media_player_set_nsobject}() instead. - ''' - f = _Cfunctions.get('libvlc_media_player_set_agl', None) or \ - _Cfunction('libvlc_media_player_set_agl', ((1,), (1,),), None, - None, MediaPlayer, ctypes.c_uint32) - return f(p_mi, drawable) - -def libvlc_media_player_get_agl(p_mi): - '''\deprecated Use L{libvlc_media_player_get_nsobject}() instead. - ''' - f = _Cfunctions.get('libvlc_media_player_get_agl', None) or \ - _Cfunction('libvlc_media_player_get_agl', ((1,),), None, - ctypes.c_uint32, MediaPlayer) - return f(p_mi) - -def libvlc_track_description_release(p_track_description): - '''\deprecated Use L{libvlc_track_description_list_release}() instead. - ''' - f = _Cfunctions.get('libvlc_track_description_release', None) or \ - _Cfunction('libvlc_track_description_release', ((1,),), None, - None, ctypes.POINTER(TrackDescription)) - return f(p_track_description) - -def libvlc_video_get_height(p_mi): - '''Get current video height. - \deprecated Use L{libvlc_video_get_size}() instead. - @param p_mi: the media player. - @return: the video pixel height or 0 if not applicable. - ''' - f = _Cfunctions.get('libvlc_video_get_height', None) or \ - _Cfunction('libvlc_video_get_height', ((1,),), None, - ctypes.c_int, MediaPlayer) - return f(p_mi) - -def libvlc_video_get_width(p_mi): - '''Get current video width. - \deprecated Use L{libvlc_video_get_size}() instead. - @param p_mi: the media player. - @return: the video pixel width or 0 if not applicable. - ''' - f = _Cfunctions.get('libvlc_video_get_width', None) or \ - _Cfunction('libvlc_video_get_width', ((1,),), None, - ctypes.c_int, MediaPlayer) - return f(p_mi) - -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. It must be freed with L{libvlc_track_description_list_release}(). - ''' - f = _Cfunctions.get('libvlc_video_get_title_description', None) or \ - _Cfunction('libvlc_video_get_title_description', ((1,),), None, - ctypes.POINTER(TrackDescription), MediaPlayer) - 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. It must be freed with L{libvlc_track_description_list_release}(). - ''' - 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) - return f(p_mi, i_title) - -def libvlc_video_set_subtitle_file(p_mi, psz_subtitle): - '''Set new video subtitle file. - \deprecated Use L{libvlc_media_player_add_slave}() instead. - @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) - return f(p_mi, psz_subtitle) - -def libvlc_toggle_teletext(p_mi): - '''Toggle teletext transparent status on video output. - \deprecated use L{libvlc_video_set_teletext}() instead. - @param p_mi: the media player. - ''' - f = _Cfunctions.get('libvlc_toggle_teletext', None) or \ - _Cfunction('libvlc_toggle_teletext', ((1,),), None, - None, MediaPlayer) - return f(p_mi) - -def libvlc_audio_output_device_count(p_instance, psz_audio_output): - '''Backward compatibility stub. Do not use in new code. - \deprecated Use L{libvlc_audio_output_device_list_get}() instead. - @return: always 0. - ''' - 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) - return f(p_instance, psz_audio_output) - -def libvlc_audio_output_device_longname(p_instance, psz_output, i_device): - '''Backward compatibility stub. Do not use in new code. - \deprecated Use L{libvlc_audio_output_device_list_get}() instead. - @return: always None. - ''' - 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) - return f(p_instance, psz_output, i_device) - -def libvlc_audio_output_device_id(p_instance, psz_audio_output, i_device): - '''Backward compatibility stub. Do not use in new code. - \deprecated Use L{libvlc_audio_output_device_list_get}() instead. - @return: always None. - ''' - 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) - return f(p_instance, psz_audio_output, i_device) - -def libvlc_media_parse(p_md): - '''Parse a media. - This fetches (local) art, meta data and tracks information. - The method is synchronous. - \deprecated This function could block indefinitely. - Use L{libvlc_media_parse_with_options}() instead - See L{libvlc_media_parse_with_options} - 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) - return f(p_md) - -def libvlc_media_parse_async(p_md): - '''Parse a media. - This fetches (local) art, 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. - \deprecated You can't be sure to receive the libvlc_MediaParsedChanged - event (you can wait indefinitely for this event). - Use L{libvlc_media_parse_with_options}() instead - 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) - return f(p_md) - -def libvlc_media_is_parsed(p_md): - '''Return true is the media descriptor object is parsed - \deprecated This can return true in case of failure. - Use L{libvlc_media_get_parsed_status}() instead - 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) - 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. - \deprecated Use L{libvlc_media_tracks_get}() instead. - @param p_md: media descriptor object. - @param tracks: address to store an allocated array of Elementary Streams descriptions (must be freed by the caller) [OUT]. - @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)) - return f(p_md) - -def libvlc_media_discoverer_new_from_name(p_inst, psz_name): - '''\deprecated Use L{libvlc_media_discoverer_new}() and L{libvlc_media_discoverer_start}(). - ''' - 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) - return f(p_inst, psz_name) - -def libvlc_media_discoverer_localized_name(p_mdis): - '''Get media service discover object its localized name. - \deprecated Useless, use L{libvlc_media_discoverer_list_get}() to get the - longname of the service discovery. - @param p_mdis: media discover object. - @return: localized name or None if the media_discoverer is not started. - ''' - f = _Cfunctions.get('libvlc_media_discoverer_localized_name', None) or \ - _Cfunction('libvlc_media_discoverer_localized_name', ((1,),), string_result, - ctypes.c_void_p, MediaDiscoverer) - return f(p_mdis) - -def libvlc_media_discoverer_event_manager(p_mdis): - '''Get event manager from media service discover object. - \deprecated Useless, media_discoverer events are only triggered when calling - L{libvlc_media_discoverer_start}() and L{libvlc_media_discoverer_stop}(). - @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) - return f(p_mdis) - -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 @warning This function wastes one thread doing basically nothing. libvlc_set_exit_handler() should be used instead. - ''' - f = _Cfunctions.get('libvlc_wait', None) or \ - _Cfunction('libvlc_wait', ((1,),), None, - None, Instance) - return f(p_instance) - -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) - 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) - return f(p_instance, level) - -def libvlc_log_open(p_instance): - '''This function does nothing useful. - It is only provided for backward compatibility. +def libvlc_media_list_player_new(p_instance): + '''Create new media_list_player. @param p_instance: libvlc instance. - @return: an unique pointer or None on error. + @return: media list player instance or None on error. ''' - f = _Cfunctions.get('libvlc_log_open', None) or \ - _Cfunction('libvlc_log_open', ((1,),), None, - Log_ptr, Instance) + 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) 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 None. - ''' - f = _Cfunctions.get('libvlc_log_close', None) or \ - _Cfunction('libvlc_log_close', ((1,),), None, - None, Log_ptr) - 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. +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_log_count', None) or \ - _Cfunction('libvlc_log_count', ((1,),), None, - ctypes.c_uint, Log_ptr) - return f(p_log) + f = _Cfunctions.get('libvlc_media_list_player_release', None) or \ + _Cfunction('libvlc_media_list_player_release', ((1,),), None, + None, MediaListPlayer) + return f(p_mlp) -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_ptr) - 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 None on error or if the parameter was None. +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_log_get_iterator', None) or \ - _Cfunction('libvlc_log_get_iterator', ((1,),), class_result(LogIterator), - ctypes.c_void_p, Log_ptr) - return f(p_log) + f = _Cfunctions.get('libvlc_media_list_player_retain', None) or \ + _Cfunction('libvlc_media_list_player_retain', ((1,),), None, + None, MediaListPlayer) + return f(p_mlp) -def libvlc_log_iterator_free(p_iter): - '''Frees memory allocated by L{libvlc_log_get_iterator}(). - @param p_iter: libvlc log iterator or None. - ''' - f = _Cfunctions.get('libvlc_log_iterator_free', None) or \ - _Cfunction('libvlc_log_iterator_free', ((1,),), None, - None, LogIterator) - 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. +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_log_iterator_has_next', None) or \ - _Cfunction('libvlc_log_iterator_has_next', ((1,),), None, - ctypes.c_int, LogIterator) - return f(p_iter) + 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) + return f(p_mlp) -def libvlc_log_iterator_next(p_iter, p_buf): - '''Always returns None. - This function is only provided for backward compatibility. - @param p_iter: libvlc log iterator or None. - @param p_buf: ignored. - @return: always None. - ''' - f = _Cfunctions.get('libvlc_log_iterator_next', None) or \ - _Cfunction('libvlc_log_iterator_next', ((1,), (1,),), None, - ctypes.POINTER(LogMessage), LogIterator, ctypes.POINTER(LogMessage)) - return f(p_iter, p_buf) -def libvlc_playlist_play(p_instance, i_id, i_options, ppsz_options): - '''Start playing (if there is any item in the playlist). - Additionnal playlist item options can be specified for addition to the - item before it is played. - @param p_instance: the playlist instance. - @param i_id: the item to play. If this is a negative number, the next item will be selected. Otherwise, the item with the given ID will be played. - @param i_options: the number of options to add to the item. - @param ppsz_options: the options to add to the item. +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_playlist_play', None) or \ - _Cfunction('libvlc_playlist_play', ((1,), (1,), (1,), (1,),), None, - None, Instance, ctypes.c_int, ctypes.c_int, ListPOINTER(ctypes.c_char_p)) - return f(p_instance, i_id, i_options, ppsz_options) + 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) + return f(p_mlp, p_mi) + + +def libvlc_media_list_player_get_media_player(p_mlp): + '''Get media player of the media_list_player instance. + @param p_mlp: media list player instance. + @return: media player instance @note the caller is responsible for releasing the returned instance. + ''' + f = _Cfunctions.get('libvlc_media_list_player_get_media_player', None) or \ + _Cfunction('libvlc_media_list_player_get_media_player', ((1,),), class_result(MediaPlayer), + ctypes.c_void_p, MediaListPlayer) + return f(p_mlp) + + +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) + 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) + return f(p_mlp) + + +def libvlc_media_list_player_pause(p_mlp): + '''Toggle pause (or resume) 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) + return f(p_mlp) + + +def libvlc_media_list_player_set_pause(p_mlp, do_pause): + '''Pause or resume media list. + @param p_mlp: media list player instance. + @param do_pause: play/resume if zero, pause if non-zero. + @version: LibVLC 3.0.0 or later. + ''' + f = _Cfunctions.get('libvlc_media_list_player_set_pause', None) or \ + _Cfunction('libvlc_media_list_player_set_pause', ((1,), (1,),), None, + None, MediaListPlayer, ctypes.c_int) + return f(p_mlp, do_pause) + + +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) + 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: L{State} 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) + 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) + 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) + 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) + 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) + 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) + 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) + return f(p_mlp, e_mode) + def libvlc_media_player_new(p_libvlc_instance): '''Create an empty Media Player object. @@ -6577,9 +6351,10 @@ def libvlc_media_player_new(p_libvlc_instance): ''' f = _Cfunctions.get('libvlc_media_player_new', None) or \ _Cfunction('libvlc_media_player_new', ((1,),), class_result(MediaPlayer), - ctypes.c_void_p, Instance) + ctypes.c_void_p, Instance) 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. @@ -6587,9 +6362,10 @@ def libvlc_media_player_new_from_media(p_md): ''' 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) + ctypes.c_void_p, Media) 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 @@ -6600,9 +6376,10 @@ def libvlc_media_player_release(p_mi): ''' f = _Cfunctions.get('libvlc_media_player_release', None) or \ _Cfunction('libvlc_media_player_release', ((1,),), None, - None, MediaPlayer) + None, MediaPlayer) 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. @@ -6610,9 +6387,10 @@ def libvlc_media_player_retain(p_mi): ''' f = _Cfunctions.get('libvlc_media_player_retain', None) or \ _Cfunction('libvlc_media_player_retain', ((1,),), None, - None, MediaPlayer) + None, MediaPlayer) 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. @@ -6621,9 +6399,10 @@ def libvlc_media_player_set_media(p_mi, p_md): ''' f = _Cfunctions.get('libvlc_media_player_set_media', None) or \ _Cfunction('libvlc_media_player_set_media', ((1,), (1,),), None, - None, MediaPlayer, Media) + None, MediaPlayer, Media) 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. @@ -6631,9 +6410,10 @@ def libvlc_media_player_get_media(p_mi): ''' 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) + ctypes.c_void_p, MediaPlayer) 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. @@ -6641,9 +6421,10 @@ def libvlc_media_player_event_manager(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) + ctypes.c_void_p, MediaPlayer) return f(p_mi) + def libvlc_media_player_is_playing(p_mi): '''is_playing. @param p_mi: the Media Player. @@ -6651,9 +6432,10 @@ def libvlc_media_player_is_playing(p_mi): ''' f = _Cfunctions.get('libvlc_media_player_is_playing', None) or \ _Cfunction('libvlc_media_player_is_playing', ((1,),), None, - ctypes.c_int, MediaPlayer) + ctypes.c_int, MediaPlayer) return f(p_mi) + def libvlc_media_player_play(p_mi): '''Play. @param p_mi: the Media Player. @@ -6661,9 +6443,10 @@ def libvlc_media_player_play(p_mi): ''' f = _Cfunctions.get('libvlc_media_player_play', None) or \ _Cfunction('libvlc_media_player_play', ((1,),), None, - ctypes.c_int, MediaPlayer) + ctypes.c_int, MediaPlayer) 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. @@ -6672,27 +6455,30 @@ def libvlc_media_player_set_pause(mp, do_pause): ''' f = _Cfunctions.get('libvlc_media_player_set_pause', None) or \ _Cfunction('libvlc_media_player_set_pause', ((1,), (1,),), None, - None, MediaPlayer, ctypes.c_int) + None, MediaPlayer, ctypes.c_int) 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) + None, MediaPlayer) 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) + None, MediaPlayer) return f(p_mi) + def libvlc_media_player_set_renderer(p_mi, p_item): '''Set a renderer to the media player @note: must be called before the first call of L{libvlc_media_player_play}() to @@ -6705,9 +6491,10 @@ def libvlc_media_player_set_renderer(p_mi, p_item): ''' f = _Cfunctions.get('libvlc_media_player_set_renderer', None) or \ _Cfunction('libvlc_media_player_set_renderer', ((1,), (1,),), None, - ctypes.c_int, MediaPlayer, Renderer) + ctypes.c_int, MediaPlayer, Renderer) return f(p_mi, p_item) + def libvlc_video_set_callbacks(mp, lock, unlock, display, opaque): '''Set callbacks and private data to render decoded video to a custom area in memory. @@ -6742,9 +6529,10 @@ def libvlc_video_set_callbacks(mp, lock, unlock, display, opaque): ''' f = _Cfunctions.get('libvlc_video_set_callbacks', None) or \ _Cfunction('libvlc_video_set_callbacks', ((1,), (1,), (1,), (1,), (1,),), None, - None, MediaPlayer, VideoLockCb, VideoUnlockCb, VideoDisplayCb, ctypes.c_void_p) + None, MediaPlayer, VideoLockCb, VideoUnlockCb, VideoDisplayCb, ctypes.c_void_p) return f(mp, lock, unlock, display, opaque) + def libvlc_video_set_format(mp, chroma, width, height, pitch): '''Set decoded video chroma and dimensions. This only works in combination with L{libvlc_video_set_callbacks}(), @@ -6759,9 +6547,10 @@ def libvlc_video_set_format(mp, chroma, width, height, pitch): ''' 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) + None, MediaPlayer, ctypes.c_char_p, ctypes.c_uint, ctypes.c_uint, ctypes.c_uint) return f(mp, chroma, width, height, pitch) + def libvlc_video_set_format_callbacks(mp, setup, cleanup): '''Set decoded video chroma and dimensions. This only works in combination with L{libvlc_video_set_callbacks}(). @@ -6772,9 +6561,10 @@ def libvlc_video_set_format_callbacks(mp, setup, cleanup): ''' f = _Cfunctions.get('libvlc_video_set_format_callbacks', None) or \ _Cfunction('libvlc_video_set_format_callbacks', ((1,), (1,), (1,),), None, - None, MediaPlayer, VideoFormatCb, VideoCleanupCb) + None, MediaPlayer, VideoFormatCb, VideoCleanupCb) return f(mp, setup, cleanup) + 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". @@ -6803,9 +6593,10 @@ def libvlc_media_player_set_nsobject(p_mi, drawable): ''' 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) + None, MediaPlayer, ctypes.c_void_p) 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. @@ -6813,9 +6604,10 @@ def libvlc_media_player_get_nsobject(p_mi): ''' f = _Cfunctions.get('libvlc_media_player_get_nsobject', None) or \ _Cfunction('libvlc_media_player_get_nsobject', ((1,),), None, - ctypes.c_void_p, MediaPlayer) + ctypes.c_void_p, MediaPlayer) 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. The call takes effect when the playback starts. If it is @@ -6839,9 +6631,10 @@ def libvlc_media_player_set_xwindow(p_mi, drawable): ''' f = _Cfunctions.get('libvlc_media_player_set_xwindow', None) or \ _Cfunction('libvlc_media_player_set_xwindow', ((1,), (1,),), None, - None, MediaPlayer, ctypes.c_uint32) + None, MediaPlayer, ctypes.c_uint32) 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 @@ -6852,9 +6645,10 @@ def libvlc_media_player_get_xwindow(p_mi): ''' f = _Cfunctions.get('libvlc_media_player_get_xwindow', None) or \ _Cfunction('libvlc_media_player_get_xwindow', ((1,),), None, - ctypes.c_uint32, MediaPlayer) + ctypes.c_uint32, MediaPlayer) 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 @@ -6864,9 +6658,10 @@ def libvlc_media_player_set_hwnd(p_mi, 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) + None, MediaPlayer, ctypes.c_void_p) 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 @@ -6876,9 +6671,10 @@ def libvlc_media_player_get_hwnd(p_mi): ''' f = _Cfunctions.get('libvlc_media_player_get_hwnd', None) or \ _Cfunction('libvlc_media_player_get_hwnd', ((1,),), None, - ctypes.c_void_p, MediaPlayer) + ctypes.c_void_p, MediaPlayer) return f(p_mi) + def libvlc_media_player_set_android_context(p_mi, p_awindow_handler): '''Set the android context. @param p_mi: the media player. @@ -6887,9 +6683,10 @@ def libvlc_media_player_set_android_context(p_mi, p_awindow_handler): ''' f = _Cfunctions.get('libvlc_media_player_set_android_context', None) or \ _Cfunction('libvlc_media_player_set_android_context', ((1,), (1,),), None, - None, MediaPlayer, ctypes.c_void_p) + None, MediaPlayer, ctypes.c_void_p) return f(p_mi, p_awindow_handler) + def libvlc_media_player_set_evas_object(p_mi, p_evas_object): '''Set the EFL Evas Object. @param p_mi: the media player. @@ -6899,9 +6696,10 @@ def libvlc_media_player_set_evas_object(p_mi, p_evas_object): ''' f = _Cfunctions.get('libvlc_media_player_set_evas_object', None) or \ _Cfunction('libvlc_media_player_set_evas_object', ((1,), (1,),), None, - ctypes.c_int, MediaPlayer, ctypes.c_void_p) + ctypes.c_int, MediaPlayer, ctypes.c_void_p) return f(p_mi, p_evas_object) + def libvlc_audio_set_callbacks(mp, play, pause, resume, flush, drain, opaque): '''Sets callbacks and private data for decoded audio. Use L{libvlc_audio_set_format}() or L{libvlc_audio_set_format_callbacks}() @@ -6919,9 +6717,11 @@ def libvlc_audio_set_callbacks(mp, play, pause, resume, flush, drain, opaque): ''' f = _Cfunctions.get('libvlc_audio_set_callbacks', None) or \ _Cfunction('libvlc_audio_set_callbacks', ((1,), (1,), (1,), (1,), (1,), (1,), (1,),), None, - None, MediaPlayer, AudioPlayCb, AudioPauseCb, AudioResumeCb, AudioFlushCb, AudioDrainCb, ctypes.c_void_p) + None, MediaPlayer, AudioPlayCb, AudioPauseCb, AudioResumeCb, AudioFlushCb, AudioDrainCb, + ctypes.c_void_p) return f(mp, play, pause, resume, flush, drain, opaque) + def libvlc_audio_set_volume_callback(mp, set_volume): '''Set callbacks and private data for decoded audio. This only works in combination with L{libvlc_audio_set_callbacks}(). @@ -6933,9 +6733,10 @@ def libvlc_audio_set_volume_callback(mp, set_volume): ''' f = _Cfunctions.get('libvlc_audio_set_volume_callback', None) or \ _Cfunction('libvlc_audio_set_volume_callback', ((1,), (1,),), None, - None, MediaPlayer, AudioSetVolumeCb) + None, MediaPlayer, AudioSetVolumeCb) return f(mp, set_volume) + def libvlc_audio_set_format_callbacks(mp, setup, cleanup): '''Sets decoded audio format via callbacks. This only works in combination with L{libvlc_audio_set_callbacks}(). @@ -6946,9 +6747,10 @@ def libvlc_audio_set_format_callbacks(mp, setup, cleanup): ''' f = _Cfunctions.get('libvlc_audio_set_format_callbacks', None) or \ _Cfunction('libvlc_audio_set_format_callbacks', ((1,), (1,), (1,),), None, - None, MediaPlayer, AudioSetupCb, AudioCleanupCb) + None, MediaPlayer, AudioSetupCb, AudioCleanupCb) return f(mp, setup, cleanup) + def libvlc_audio_set_format(mp, format, rate, channels): '''Sets a fixed decoded audio format. This only works in combination with L{libvlc_audio_set_callbacks}(), @@ -6961,9 +6763,10 @@ def libvlc_audio_set_format(mp, format, rate, channels): ''' 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) + None, MediaPlayer, ctypes.c_char_p, ctypes.c_uint, ctypes.c_uint) 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. @@ -6971,9 +6774,10 @@ def libvlc_media_player_get_length(p_mi): ''' f = _Cfunctions.get('libvlc_media_player_get_length', None) or \ _Cfunction('libvlc_media_player_get_length', ((1,),), None, - ctypes.c_longlong, MediaPlayer) + ctypes.c_longlong, MediaPlayer) 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. @@ -6981,9 +6785,10 @@ def libvlc_media_player_get_time(p_mi): ''' f = _Cfunctions.get('libvlc_media_player_get_time', None) or \ _Cfunction('libvlc_media_player_get_time', ((1,),), None, - ctypes.c_longlong, MediaPlayer) + ctypes.c_longlong, MediaPlayer) 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. @@ -6992,9 +6797,10 @@ def libvlc_media_player_set_time(p_mi, i_time): ''' f = _Cfunctions.get('libvlc_media_player_set_time', None) or \ _Cfunction('libvlc_media_player_set_time', ((1,), (1,),), None, - None, MediaPlayer, ctypes.c_longlong) + None, MediaPlayer, ctypes.c_longlong) return f(p_mi, i_time) + def libvlc_media_player_get_position(p_mi): '''Get movie position as percentage between 0.0 and 1.0. @param p_mi: the Media Player. @@ -7002,9 +6808,10 @@ def libvlc_media_player_get_position(p_mi): ''' f = _Cfunctions.get('libvlc_media_player_get_position', None) or \ _Cfunction('libvlc_media_player_get_position', ((1,),), None, - ctypes.c_float, MediaPlayer) + ctypes.c_float, MediaPlayer) return f(p_mi) + def libvlc_media_player_set_position(p_mi, f_pos): '''Set movie position as percentage between 0.0 and 1.0. This has no effect if playback is not enabled. @@ -7014,9 +6821,10 @@ def libvlc_media_player_set_position(p_mi, f_pos): ''' f = _Cfunctions.get('libvlc_media_player_set_position', None) or \ _Cfunction('libvlc_media_player_set_position', ((1,), (1,),), None, - None, MediaPlayer, ctypes.c_float) + None, MediaPlayer, ctypes.c_float) 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. @@ -7024,9 +6832,10 @@ def libvlc_media_player_set_chapter(p_mi, i_chapter): ''' f = _Cfunctions.get('libvlc_media_player_set_chapter', None) or \ _Cfunction('libvlc_media_player_set_chapter', ((1,), (1,),), None, - None, MediaPlayer, ctypes.c_int) + None, MediaPlayer, ctypes.c_int) return f(p_mi, i_chapter) + def libvlc_media_player_get_chapter(p_mi): '''Get movie chapter. @param p_mi: the Media Player. @@ -7034,9 +6843,10 @@ def libvlc_media_player_get_chapter(p_mi): ''' f = _Cfunctions.get('libvlc_media_player_get_chapter', None) or \ _Cfunction('libvlc_media_player_get_chapter', ((1,),), None, - ctypes.c_int, MediaPlayer) + ctypes.c_int, MediaPlayer) return f(p_mi) + def libvlc_media_player_get_chapter_count(p_mi): '''Get movie chapter count. @param p_mi: the Media Player. @@ -7044,9 +6854,10 @@ def libvlc_media_player_get_chapter_count(p_mi): ''' f = _Cfunctions.get('libvlc_media_player_get_chapter_count', None) or \ _Cfunction('libvlc_media_player_get_chapter_count', ((1,),), None, - ctypes.c_int, MediaPlayer) + ctypes.c_int, MediaPlayer) return f(p_mi) + def libvlc_media_player_will_play(p_mi): '''Is the player able to play. @param p_mi: the Media Player. @@ -7054,9 +6865,10 @@ def libvlc_media_player_will_play(p_mi): ''' f = _Cfunctions.get('libvlc_media_player_will_play', None) or \ _Cfunction('libvlc_media_player_will_play', ((1,),), None, - ctypes.c_int, MediaPlayer) + ctypes.c_int, MediaPlayer) 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. @@ -7065,9 +6877,10 @@ def libvlc_media_player_get_chapter_count_for_title(p_mi, i_title): ''' 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) + ctypes.c_int, MediaPlayer, ctypes.c_int) 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. @@ -7075,9 +6888,10 @@ def libvlc_media_player_set_title(p_mi, i_title): ''' f = _Cfunctions.get('libvlc_media_player_set_title', None) or \ _Cfunction('libvlc_media_player_set_title', ((1,), (1,),), None, - None, MediaPlayer, ctypes.c_int) + None, MediaPlayer, ctypes.c_int) return f(p_mi, i_title) + def libvlc_media_player_get_title(p_mi): '''Get movie title. @param p_mi: the Media Player. @@ -7085,9 +6899,10 @@ def libvlc_media_player_get_title(p_mi): ''' f = _Cfunctions.get('libvlc_media_player_get_title', None) or \ _Cfunction('libvlc_media_player_get_title', ((1,),), None, - ctypes.c_int, MediaPlayer) + ctypes.c_int, MediaPlayer) return f(p_mi) + def libvlc_media_player_get_title_count(p_mi): '''Get movie title count. @param p_mi: the Media Player. @@ -7095,27 +6910,30 @@ def libvlc_media_player_get_title_count(p_mi): ''' f = _Cfunctions.get('libvlc_media_player_get_title_count', None) or \ _Cfunction('libvlc_media_player_get_title_count', ((1,),), None, - ctypes.c_int, MediaPlayer) + ctypes.c_int, MediaPlayer) 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) + None, MediaPlayer) 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) + None, MediaPlayer) 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 @@ -7125,9 +6943,10 @@ def libvlc_media_player_get_rate(p_mi): ''' f = _Cfunctions.get('libvlc_media_player_get_rate', None) or \ _Cfunction('libvlc_media_player_get_rate', ((1,),), None, - ctypes.c_float, MediaPlayer) + ctypes.c_float, MediaPlayer) return f(p_mi) + def libvlc_media_player_set_rate(p_mi, rate): '''Set movie play rate. @param p_mi: the Media Player. @@ -7136,9 +6955,10 @@ def libvlc_media_player_set_rate(p_mi, rate): ''' 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) + ctypes.c_int, MediaPlayer, ctypes.c_float) return f(p_mi, rate) + def libvlc_media_player_get_state(p_mi): '''Get current movie state. @param p_mi: the Media Player. @@ -7146,9 +6966,10 @@ def libvlc_media_player_get_state(p_mi): ''' f = _Cfunctions.get('libvlc_media_player_get_state', None) or \ _Cfunction('libvlc_media_player_get_state', ((1,),), None, - State, MediaPlayer) + State, MediaPlayer) 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. @@ -7156,9 +6977,10 @@ def libvlc_media_player_has_vout(p_mi): ''' f = _Cfunctions.get('libvlc_media_player_has_vout', None) or \ _Cfunction('libvlc_media_player_has_vout', ((1,),), None, - ctypes.c_uint, MediaPlayer) + ctypes.c_uint, MediaPlayer) return f(p_mi) + def libvlc_media_player_is_seekable(p_mi): '''Is this media player seekable? @param p_mi: the media player. @@ -7166,9 +6988,10 @@ def libvlc_media_player_is_seekable(p_mi): ''' f = _Cfunctions.get('libvlc_media_player_is_seekable', None) or \ _Cfunction('libvlc_media_player_is_seekable', ((1,),), None, - ctypes.c_int, MediaPlayer) + ctypes.c_int, MediaPlayer) return f(p_mi) + def libvlc_media_player_can_pause(p_mi): '''Can this media player be paused? @param p_mi: the media player. @@ -7176,9 +6999,10 @@ def libvlc_media_player_can_pause(p_mi): ''' f = _Cfunctions.get('libvlc_media_player_can_pause', None) or \ _Cfunction('libvlc_media_player_can_pause', ((1,),), None, - ctypes.c_int, MediaPlayer) + ctypes.c_int, MediaPlayer) return f(p_mi) + def libvlc_media_player_program_scrambled(p_mi): '''Check if the current program is scrambled. @param p_mi: the media player. @@ -7187,18 +7011,20 @@ def libvlc_media_player_program_scrambled(p_mi): ''' f = _Cfunctions.get('libvlc_media_player_program_scrambled', None) or \ _Cfunction('libvlc_media_player_program_scrambled', ((1,),), None, - ctypes.c_int, MediaPlayer) + ctypes.c_int, MediaPlayer) 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) + None, MediaPlayer) return f(p_mi) + def libvlc_media_player_navigate(p_mi, navigate): '''Navigate through DVD Menu. @param p_mi: the Media Player. @@ -7207,9 +7033,10 @@ def libvlc_media_player_navigate(p_mi, navigate): ''' f = _Cfunctions.get('libvlc_media_player_navigate', None) or \ _Cfunction('libvlc_media_player_navigate', ((1,), (1,),), None, - None, MediaPlayer, ctypes.c_uint) + None, MediaPlayer, ctypes.c_uint) return f(p_mi, navigate) + def libvlc_media_player_set_video_title_display(p_mi, position, timeout): '''Set if, and how, the video title will be shown when media is played. @param p_mi: the media player. @@ -7219,9 +7046,10 @@ def libvlc_media_player_set_video_title_display(p_mi, position, timeout): ''' f = _Cfunctions.get('libvlc_media_player_set_video_title_display', None) or \ _Cfunction('libvlc_media_player_set_video_title_display', ((1,), (1,), (1,),), None, - None, MediaPlayer, Position, ctypes.c_int) + None, MediaPlayer, Position, ctypes.c_uint) return f(p_mi, position, timeout) + def libvlc_media_player_add_slave(p_mi, i_type, psz_uri, b_select): '''Add a slave to the current media player. @note: If the player is playing, the slave will be added directly. This call @@ -7235,18 +7063,20 @@ def libvlc_media_player_add_slave(p_mi, i_type, psz_uri, b_select): ''' f = _Cfunctions.get('libvlc_media_player_add_slave', None) or \ _Cfunction('libvlc_media_player_add_slave', ((1,), (1,), (1,), (1,),), None, - ctypes.c_int, MediaPlayer, MediaSlaveType, ctypes.c_char_p, ctypes.c_bool) + ctypes.c_int, MediaPlayer, MediaSlaveType, ctypes.c_char_p, ctypes.c_bool) return f(p_mi, i_type, psz_uri, b_select) + def libvlc_track_description_list_release(p_track_description): '''Release (free) L{TrackDescription}. @param p_track_description: the structure to release. ''' f = _Cfunctions.get('libvlc_track_description_list_release', None) or \ _Cfunction('libvlc_track_description_list_release', ((1,),), None, - None, ctypes.POINTER(TrackDescription)) + None, ctypes.POINTER(TrackDescription)) 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 @@ -7255,9 +7085,10 @@ def libvlc_toggle_fullscreen(p_mi): ''' f = _Cfunctions.get('libvlc_toggle_fullscreen', None) or \ _Cfunction('libvlc_toggle_fullscreen', ((1,),), None, - None, MediaPlayer) + None, MediaPlayer) 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 @@ -7271,9 +7102,10 @@ def libvlc_set_fullscreen(p_mi, b_fullscreen): ''' f = _Cfunctions.get('libvlc_set_fullscreen', None) or \ _Cfunction('libvlc_set_fullscreen', ((1,), (1,),), None, - None, MediaPlayer, ctypes.c_int) + None, MediaPlayer, ctypes.c_int) return f(p_mi, b_fullscreen) + def libvlc_get_fullscreen(p_mi): '''Get current fullscreen status. @param p_mi: the media player. @@ -7281,9 +7113,10 @@ def libvlc_get_fullscreen(p_mi): ''' f = _Cfunctions.get('libvlc_get_fullscreen', None) or \ _Cfunction('libvlc_get_fullscreen', ((1,),), None, - ctypes.c_int, MediaPlayer) + ctypes.c_int, MediaPlayer) 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 @@ -7298,9 +7131,10 @@ def libvlc_video_set_key_input(p_mi, on): ''' f = _Cfunctions.get('libvlc_video_set_key_input', None) or \ _Cfunction('libvlc_video_set_key_input', ((1,), (1,),), None, - None, MediaPlayer, ctypes.c_uint) + None, MediaPlayer, ctypes.c_uint) 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 @@ -7312,9 +7146,10 @@ def libvlc_video_set_mouse_input(p_mi, on): ''' f = _Cfunctions.get('libvlc_video_set_mouse_input', None) or \ _Cfunction('libvlc_video_set_mouse_input', ((1,), (1,),), None, - None, MediaPlayer, ctypes.c_uint) + None, MediaPlayer, ctypes.c_uint) 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. @@ -7323,9 +7158,11 @@ def libvlc_video_get_size(p_mi, num): ''' 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)) + ctypes.c_int, MediaPlayer, ctypes.c_uint, ctypes.POINTER(ctypes.c_uint), + ctypes.POINTER(ctypes.c_uint)) 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, @@ -7344,9 +7181,10 @@ def libvlc_video_get_cursor(p_mi, num): ''' 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)) + ctypes.c_int, MediaPlayer, ctypes.c_uint, ctypes.POINTER(ctypes.c_int), ctypes.POINTER(ctypes.c_int)) 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}(). @@ -7355,9 +7193,10 @@ def libvlc_video_get_scale(p_mi): ''' f = _Cfunctions.get('libvlc_video_get_scale', None) or \ _Cfunction('libvlc_video_get_scale', ((1,),), None, - ctypes.c_float, MediaPlayer) + ctypes.c_float, MediaPlayer) 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 @@ -7369,9 +7208,10 @@ def libvlc_video_set_scale(p_mi, f_factor): ''' f = _Cfunctions.get('libvlc_video_set_scale', None) or \ _Cfunction('libvlc_video_set_scale', ((1,), (1,),), None, - None, MediaPlayer, ctypes.c_float) + None, MediaPlayer, ctypes.c_float) 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. @@ -7379,9 +7219,10 @@ def libvlc_video_get_aspect_ratio(p_mi): ''' f = _Cfunctions.get('libvlc_video_get_aspect_ratio', None) or \ _Cfunction('libvlc_video_get_aspect_ratio', ((1,),), string_result, - ctypes.c_void_p, MediaPlayer) + ctypes.c_void_p, MediaPlayer) 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. @@ -7389,9 +7230,10 @@ def libvlc_video_set_aspect_ratio(p_mi, psz_aspect): ''' 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) + None, MediaPlayer, ctypes.c_char_p) return f(p_mi, psz_aspect) + def libvlc_video_new_viewpoint(): '''Create a video viewpoint structure. @return: video viewpoint or None (the result must be released with free() or L{libvlc_free}()). @@ -7399,9 +7241,10 @@ def libvlc_video_new_viewpoint(): ''' f = _Cfunctions.get('libvlc_video_new_viewpoint', None) or \ _Cfunction('libvlc_video_new_viewpoint', (), None, - ctypes.POINTER(VideoViewpoint)) + ctypes.POINTER(VideoViewpoint)) return f() + def libvlc_video_update_viewpoint(p_mi, p_viewpoint, b_absolute): '''Update the video viewpoint information. @note: It is safe to call this function before the media player is started. @@ -7413,9 +7256,10 @@ def libvlc_video_update_viewpoint(p_mi, p_viewpoint, b_absolute): ''' f = _Cfunctions.get('libvlc_video_update_viewpoint', None) or \ _Cfunction('libvlc_video_update_viewpoint', ((1,), (1,), (1,),), None, - ctypes.c_int, MediaPlayer, ctypes.POINTER(VideoViewpoint), ctypes.c_bool) + ctypes.c_int, MediaPlayer, ctypes.POINTER(VideoViewpoint), ctypes.c_bool) return f(p_mi, p_viewpoint, b_absolute) + def libvlc_video_get_spu(p_mi): '''Get current video subtitle. @param p_mi: the media player. @@ -7423,9 +7267,10 @@ def libvlc_video_get_spu(p_mi): ''' f = _Cfunctions.get('libvlc_video_get_spu', None) or \ _Cfunction('libvlc_video_get_spu', ((1,),), None, - ctypes.c_int, MediaPlayer) + ctypes.c_int, MediaPlayer) 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. @@ -7433,9 +7278,10 @@ def libvlc_video_get_spu_count(p_mi): ''' f = _Cfunctions.get('libvlc_video_get_spu_count', None) or \ _Cfunction('libvlc_video_get_spu_count', ((1,),), None, - ctypes.c_int, MediaPlayer) + ctypes.c_int, MediaPlayer) 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. @@ -7443,9 +7289,10 @@ def libvlc_video_get_spu_description(p_mi): ''' f = _Cfunctions.get('libvlc_video_get_spu_description', None) or \ _Cfunction('libvlc_video_get_spu_description', ((1,),), None, - ctypes.POINTER(TrackDescription), MediaPlayer) + ctypes.POINTER(TrackDescription), MediaPlayer) return f(p_mi) + def libvlc_video_set_spu(p_mi, i_spu): '''Set new video subtitle. @param p_mi: the media player. @@ -7454,9 +7301,10 @@ def libvlc_video_set_spu(p_mi, i_spu): ''' f = _Cfunctions.get('libvlc_video_set_spu', None) or \ _Cfunction('libvlc_video_set_spu', ((1,), (1,),), None, - ctypes.c_int, MediaPlayer, ctypes.c_int) + ctypes.c_int, MediaPlayer, ctypes.c_int) return f(p_mi, i_spu) + def libvlc_video_get_spu_delay(p_mi): '''Get the current subtitle delay. Positive values means subtitles are being displayed later, negative values earlier. @@ -7466,9 +7314,10 @@ def libvlc_video_get_spu_delay(p_mi): ''' f = _Cfunctions.get('libvlc_video_get_spu_delay', None) or \ _Cfunction('libvlc_video_get_spu_delay', ((1,),), None, - ctypes.c_int64, MediaPlayer) + ctypes.c_int64, MediaPlayer) return f(p_mi) + def libvlc_video_set_spu_delay(p_mi, i_delay): '''Set the subtitle delay. This affects the timing of when the subtitle will be displayed. Positive values result in subtitles being displayed later, @@ -7481,9 +7330,10 @@ def libvlc_video_set_spu_delay(p_mi, i_delay): ''' f = _Cfunctions.get('libvlc_video_set_spu_delay', None) or \ _Cfunction('libvlc_video_set_spu_delay', ((1,), (1,),), None, - ctypes.c_int, MediaPlayer, ctypes.c_int64) + ctypes.c_int, MediaPlayer, ctypes.c_int64) return f(p_mi, i_delay) + def libvlc_media_player_get_full_title_descriptions(p_mi, titles): '''Get the full description of available titles. @param p_mi: the media player. @@ -7493,9 +7343,10 @@ def libvlc_media_player_get_full_title_descriptions(p_mi, titles): ''' f = _Cfunctions.get('libvlc_media_player_get_full_title_descriptions', None) or \ _Cfunction('libvlc_media_player_get_full_title_descriptions', ((1,), (1,),), None, - ctypes.c_int, MediaPlayer, ctypes.POINTER(ctypes.POINTER(TitleDescription))) + ctypes.c_int, MediaPlayer, ctypes.POINTER(ctypes.POINTER(TitleDescription))) return f(p_mi, titles) + def libvlc_title_descriptions_release(p_titles, i_count): '''Release a title description. @param p_titles: title description array to release. @@ -7504,9 +7355,10 @@ def libvlc_title_descriptions_release(p_titles, i_count): ''' f = _Cfunctions.get('libvlc_title_descriptions_release', None) or \ _Cfunction('libvlc_title_descriptions_release', ((1,), (1,),), None, - None, ctypes.POINTER(TitleDescription), ctypes.c_uint) + None, ctypes.POINTER(ctypes.POINTER(TitleDescription)), ctypes.c_uint) return f(p_titles, i_count) + def libvlc_media_player_get_full_chapter_descriptions(p_mi, i_chapters_of_title, pp_chapters): '''Get the full description of available chapters. @param p_mi: the media player. @@ -7517,9 +7369,10 @@ def libvlc_media_player_get_full_chapter_descriptions(p_mi, i_chapters_of_title, ''' f = _Cfunctions.get('libvlc_media_player_get_full_chapter_descriptions', None) or \ _Cfunction('libvlc_media_player_get_full_chapter_descriptions', ((1,), (1,), (1,),), None, - ctypes.c_int, MediaPlayer, ctypes.c_int, ctypes.POINTER(ctypes.POINTER(ChapterDescription))) + ctypes.c_int, MediaPlayer, ctypes.c_int, ctypes.POINTER(ctypes.POINTER(ChapterDescription))) return f(p_mi, i_chapters_of_title, pp_chapters) + def libvlc_chapter_descriptions_release(p_chapters, i_count): '''Release a chapter description. @param p_chapters: chapter description array to release. @@ -7528,9 +7381,10 @@ def libvlc_chapter_descriptions_release(p_chapters, i_count): ''' f = _Cfunctions.get('libvlc_chapter_descriptions_release', None) or \ _Cfunction('libvlc_chapter_descriptions_release', ((1,), (1,),), None, - None, ctypes.POINTER(ChapterDescription), ctypes.c_uint) + None, ctypes.POINTER(ctypes.POINTER(ChapterDescription)), ctypes.c_uint) return f(p_chapters, i_count) + def libvlc_video_get_crop_geometry(p_mi): '''Get current crop filter geometry. @param p_mi: the media player. @@ -7538,9 +7392,10 @@ def libvlc_video_get_crop_geometry(p_mi): ''' f = _Cfunctions.get('libvlc_video_get_crop_geometry', None) or \ _Cfunction('libvlc_video_get_crop_geometry', ((1,),), string_result, - ctypes.c_void_p, MediaPlayer) + ctypes.c_void_p, MediaPlayer) 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. @@ -7548,9 +7403,10 @@ def libvlc_video_set_crop_geometry(p_mi, psz_geometry): ''' 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) + None, MediaPlayer, ctypes.c_char_p) return f(p_mi, psz_geometry) + def libvlc_video_get_teletext(p_mi): '''Get current teletext page requested or 0 if it's disabled. Teletext is disabled by default, call L{libvlc_video_set_teletext}() to enable @@ -7560,9 +7416,10 @@ def libvlc_video_get_teletext(p_mi): ''' f = _Cfunctions.get('libvlc_video_get_teletext', None) or \ _Cfunction('libvlc_video_get_teletext', ((1,),), None, - ctypes.c_int, MediaPlayer) + ctypes.c_int, MediaPlayer) return f(p_mi) + def libvlc_video_set_teletext(p_mi, i_page): '''Set new teletext page to retrieve. This function can also be used to send a teletext key. @@ -7571,9 +7428,10 @@ def libvlc_video_set_teletext(p_mi, i_page): ''' f = _Cfunctions.get('libvlc_video_set_teletext', None) or \ _Cfunction('libvlc_video_set_teletext', ((1,), (1,),), None, - None, MediaPlayer, ctypes.c_int) + None, MediaPlayer, ctypes.c_int) return f(p_mi, i_page) + def libvlc_video_get_track_count(p_mi): '''Get number of available video tracks. @param p_mi: media player. @@ -7581,9 +7439,10 @@ def libvlc_video_get_track_count(p_mi): ''' f = _Cfunctions.get('libvlc_video_get_track_count', None) or \ _Cfunction('libvlc_video_get_track_count', ((1,),), None, - ctypes.c_int, MediaPlayer) + ctypes.c_int, MediaPlayer) return f(p_mi) + def libvlc_video_get_track_description(p_mi): '''Get the description of available video tracks. @param p_mi: media player. @@ -7591,9 +7450,10 @@ def libvlc_video_get_track_description(p_mi): ''' f = _Cfunctions.get('libvlc_video_get_track_description', None) or \ _Cfunction('libvlc_video_get_track_description', ((1,),), None, - ctypes.POINTER(TrackDescription), MediaPlayer) + ctypes.POINTER(TrackDescription), MediaPlayer) return f(p_mi) + def libvlc_video_get_track(p_mi): '''Get current video track. @param p_mi: media player. @@ -7601,9 +7461,10 @@ def libvlc_video_get_track(p_mi): ''' f = _Cfunctions.get('libvlc_video_get_track', None) or \ _Cfunction('libvlc_video_get_track', ((1,),), None, - ctypes.c_int, MediaPlayer) + ctypes.c_int, MediaPlayer) return f(p_mi) + def libvlc_video_set_track(p_mi, i_track): '''Set video track. @param p_mi: media player. @@ -7612,9 +7473,10 @@ def libvlc_video_set_track(p_mi, i_track): ''' f = _Cfunctions.get('libvlc_video_set_track', None) or \ _Cfunction('libvlc_video_set_track', ((1,), (1,),), None, - ctypes.c_int, MediaPlayer, ctypes.c_int) + ctypes.c_int, MediaPlayer, ctypes.c_int) 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. @@ -7628,9 +7490,10 @@ def libvlc_video_take_snapshot(p_mi, num, psz_filepath, i_width, i_height): ''' 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) + ctypes.c_int, MediaPlayer, ctypes.c_uint, ctypes.c_char_p, ctypes.c_uint, ctypes.c_uint) 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. @@ -7638,9 +7501,10 @@ def libvlc_video_set_deinterlace(p_mi, psz_mode): ''' f = _Cfunctions.get('libvlc_video_set_deinterlace', None) or \ _Cfunction('libvlc_video_set_deinterlace', ((1,), (1,),), None, - None, MediaPlayer, ctypes.c_char_p) + None, MediaPlayer, ctypes.c_char_p) 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. @@ -7648,9 +7512,10 @@ def libvlc_video_get_marquee_int(p_mi, option): ''' 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) + ctypes.c_int, MediaPlayer, ctypes.c_uint) 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. @@ -7658,9 +7523,10 @@ def libvlc_video_get_marquee_string(p_mi, option): ''' 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) + ctypes.c_void_p, MediaPlayer, ctypes.c_uint) 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) @@ -7671,9 +7537,10 @@ def libvlc_video_set_marquee_int(p_mi, option, i_val): ''' 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) + None, MediaPlayer, ctypes.c_uint, ctypes.c_int) 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. @@ -7682,9 +7549,10 @@ def libvlc_video_set_marquee_string(p_mi, option, psz_text): ''' 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) + None, MediaPlayer, ctypes.c_uint, ctypes.c_char_p) 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. @@ -7692,9 +7560,10 @@ def libvlc_video_get_logo_int(p_mi, option): ''' 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) + ctypes.c_int, MediaPlayer, ctypes.c_uint) 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. @@ -7706,9 +7575,10 @@ def libvlc_video_set_logo_int(p_mi, 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) + None, MediaPlayer, ctypes.c_uint, ctypes.c_int) 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. @@ -7718,9 +7588,10 @@ def libvlc_video_set_logo_string(p_mi, option, psz_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) + None, MediaPlayer, ctypes.c_uint, ctypes.c_char_p) 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. @@ -7729,9 +7600,10 @@ def libvlc_video_get_adjust_int(p_mi, option): ''' 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) + ctypes.c_int, MediaPlayer, ctypes.c_uint) 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. @@ -7744,9 +7616,10 @@ def libvlc_video_set_adjust_int(p_mi, option, value): ''' 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) + None, MediaPlayer, ctypes.c_uint, ctypes.c_int) 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. @@ -7755,9 +7628,10 @@ def libvlc_video_get_adjust_float(p_mi, option): ''' 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) + ctypes.c_float, MediaPlayer, ctypes.c_uint) 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. @@ -7768,9 +7642,10 @@ def libvlc_video_set_adjust_float(p_mi, option, value): ''' 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) + None, MediaPlayer, ctypes.c_uint, ctypes.c_float) return f(p_mi, option, value) + def libvlc_audio_output_list_get(p_instance): '''Gets the list of available audio output modules. @param p_instance: libvlc instance. @@ -7778,18 +7653,20 @@ def libvlc_audio_output_list_get(p_instance): ''' f = _Cfunctions.get('libvlc_audio_output_list_get', None) or \ _Cfunction('libvlc_audio_output_list_get', ((1,),), None, - ctypes.POINTER(AudioOutput), Instance) + ctypes.POINTER(AudioOutput), Instance) return f(p_instance) + def libvlc_audio_output_list_release(p_list): '''Frees the list of available audio output modules. @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)) + None, ctypes.POINTER(AudioOutput)) return f(p_list) + def libvlc_audio_output_set(p_mi, psz_name): '''Selects an audio output module. @note: Any change will take be effect only after playback is stopped and @@ -7800,9 +7677,10 @@ def libvlc_audio_output_set(p_mi, psz_name): ''' 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) + ctypes.c_int, MediaPlayer, ctypes.c_char_p) return f(p_mi, psz_name) + def libvlc_audio_output_device_enum(mp): '''Gets a list of potential audio output devices, See L{libvlc_audio_output_device_set}(). @@ -7818,9 +7696,10 @@ def libvlc_audio_output_device_enum(mp): ''' f = _Cfunctions.get('libvlc_audio_output_device_enum', None) or \ _Cfunction('libvlc_audio_output_device_enum', ((1,),), None, - ctypes.POINTER(AudioOutputDevice), MediaPlayer) + ctypes.POINTER(AudioOutputDevice), MediaPlayer) return f(mp) + def libvlc_audio_output_device_list_get(p_instance, aout): '''Gets a list of audio output devices for a given audio output module, See L{libvlc_audio_output_device_set}(). @@ -7838,9 +7717,10 @@ def libvlc_audio_output_device_list_get(p_instance, aout): ''' f = _Cfunctions.get('libvlc_audio_output_device_list_get', None) or \ _Cfunction('libvlc_audio_output_device_list_get', ((1,), (1,),), None, - ctypes.POINTER(AudioOutputDevice), Instance, ctypes.c_char_p) + ctypes.POINTER(AudioOutputDevice), Instance, ctypes.c_char_p) return f(p_instance, aout) + def libvlc_audio_output_device_list_release(p_list): '''Frees a list of available audio output devices. @param p_list: list with audio outputs for release. @@ -7848,9 +7728,10 @@ def libvlc_audio_output_device_list_release(p_list): ''' f = _Cfunctions.get('libvlc_audio_output_device_list_release', None) or \ _Cfunction('libvlc_audio_output_device_list_release', ((1,),), None, - None, ctypes.POINTER(AudioOutputDevice)) + None, ctypes.POINTER(AudioOutputDevice)) return f(p_list) + def libvlc_audio_output_device_set(mp, module, device_id): '''Configures an explicit audio output device. If the module paramater is None, audio output will be moved to the device @@ -7879,9 +7760,10 @@ def libvlc_audio_output_device_set(mp, module, device_id): ''' 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) + None, MediaPlayer, ctypes.c_char_p, ctypes.c_char_p) return f(mp, module, device_id) + def libvlc_audio_output_device_get(mp): '''Get the current audio output device identifier. This complements L{libvlc_audio_output_device_set}(). @@ -7900,18 +7782,20 @@ def libvlc_audio_output_device_get(mp): ''' f = _Cfunctions.get('libvlc_audio_output_device_get', None) or \ _Cfunction('libvlc_audio_output_device_get', ((1,),), string_result, - ctypes.c_void_p, MediaPlayer) + ctypes.c_void_p, MediaPlayer) return f(mp) + def libvlc_audio_toggle_mute(p_mi): '''Toggle mute status. @param p_mi: media player @warning Toggling mute atomically is not always possible: On some platforms, other processes can mute the VLC audio playback stream asynchronously. Thus, there is a small race condition where toggling will not work. See also the limitations of L{libvlc_audio_set_mute}(). ''' f = _Cfunctions.get('libvlc_audio_toggle_mute', None) or \ _Cfunction('libvlc_audio_toggle_mute', ((1,),), None, - None, MediaPlayer) + None, MediaPlayer) return f(p_mi) + def libvlc_audio_get_mute(p_mi): '''Get current mute status. @param p_mi: media player. @@ -7919,9 +7803,10 @@ def libvlc_audio_get_mute(p_mi): ''' f = _Cfunctions.get('libvlc_audio_get_mute', None) or \ _Cfunction('libvlc_audio_get_mute', ((1,),), None, - ctypes.c_int, MediaPlayer) + ctypes.c_int, MediaPlayer) return f(p_mi) + def libvlc_audio_set_mute(p_mi, status): '''Set mute status. @param p_mi: media player. @@ -7929,9 +7814,10 @@ def libvlc_audio_set_mute(p_mi, status): ''' f = _Cfunctions.get('libvlc_audio_set_mute', None) or \ _Cfunction('libvlc_audio_set_mute', ((1,), (1,),), None, - None, MediaPlayer, ctypes.c_int) + None, MediaPlayer, ctypes.c_int) return f(p_mi, status) + def libvlc_audio_get_volume(p_mi): '''Get current software audio volume. @param p_mi: media player. @@ -7939,9 +7825,10 @@ def libvlc_audio_get_volume(p_mi): ''' f = _Cfunctions.get('libvlc_audio_get_volume', None) or \ _Cfunction('libvlc_audio_get_volume', ((1,),), None, - ctypes.c_int, MediaPlayer) + ctypes.c_int, MediaPlayer) return f(p_mi) + def libvlc_audio_set_volume(p_mi, i_volume): '''Set current software audio volume. @param p_mi: media player. @@ -7950,9 +7837,10 @@ def libvlc_audio_set_volume(p_mi, i_volume): ''' f = _Cfunctions.get('libvlc_audio_set_volume', None) or \ _Cfunction('libvlc_audio_set_volume', ((1,), (1,),), None, - ctypes.c_int, MediaPlayer, ctypes.c_int) + ctypes.c_int, MediaPlayer, ctypes.c_int) 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. @@ -7960,9 +7848,10 @@ def libvlc_audio_get_track_count(p_mi): ''' f = _Cfunctions.get('libvlc_audio_get_track_count', None) or \ _Cfunction('libvlc_audio_get_track_count', ((1,),), None, - ctypes.c_int, MediaPlayer) + ctypes.c_int, MediaPlayer) return f(p_mi) + def libvlc_audio_get_track_description(p_mi): '''Get the description of available audio tracks. @param p_mi: media player. @@ -7970,9 +7859,10 @@ def libvlc_audio_get_track_description(p_mi): ''' f = _Cfunctions.get('libvlc_audio_get_track_description', None) or \ _Cfunction('libvlc_audio_get_track_description', ((1,),), None, - ctypes.POINTER(TrackDescription), MediaPlayer) + ctypes.POINTER(TrackDescription), MediaPlayer) return f(p_mi) + def libvlc_audio_get_track(p_mi): '''Get current audio track. @param p_mi: media player. @@ -7980,9 +7870,10 @@ def libvlc_audio_get_track(p_mi): ''' f = _Cfunctions.get('libvlc_audio_get_track', None) or \ _Cfunction('libvlc_audio_get_track', ((1,),), None, - ctypes.c_int, MediaPlayer) + ctypes.c_int, MediaPlayer) return f(p_mi) + def libvlc_audio_set_track(p_mi, i_track): '''Set current audio track. @param p_mi: media player. @@ -7991,9 +7882,10 @@ def libvlc_audio_set_track(p_mi, i_track): ''' f = _Cfunctions.get('libvlc_audio_set_track', None) or \ _Cfunction('libvlc_audio_set_track', ((1,), (1,),), None, - ctypes.c_int, MediaPlayer, ctypes.c_int) + ctypes.c_int, MediaPlayer, ctypes.c_int) return f(p_mi, i_track) + def libvlc_audio_get_channel(p_mi): '''Get current audio channel. @param p_mi: media player. @@ -8001,9 +7893,10 @@ def libvlc_audio_get_channel(p_mi): ''' f = _Cfunctions.get('libvlc_audio_get_channel', None) or \ _Cfunction('libvlc_audio_get_channel', ((1,),), None, - ctypes.c_int, MediaPlayer) + ctypes.c_int, MediaPlayer) return f(p_mi) + def libvlc_audio_set_channel(p_mi, channel): '''Set current audio channel. @param p_mi: media player. @@ -8012,9 +7905,10 @@ def libvlc_audio_set_channel(p_mi, channel): ''' f = _Cfunctions.get('libvlc_audio_set_channel', None) or \ _Cfunction('libvlc_audio_set_channel', ((1,), (1,),), None, - ctypes.c_int, MediaPlayer, ctypes.c_int) + ctypes.c_int, MediaPlayer, ctypes.c_int) return f(p_mi, channel) + def libvlc_audio_get_delay(p_mi): '''Get current audio delay. @param p_mi: media player. @@ -8023,9 +7917,10 @@ def libvlc_audio_get_delay(p_mi): ''' f = _Cfunctions.get('libvlc_audio_get_delay', None) or \ _Cfunction('libvlc_audio_get_delay', ((1,),), None, - ctypes.c_int64, MediaPlayer) + ctypes.c_int64, MediaPlayer) 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. @@ -8035,9 +7930,10 @@ def libvlc_audio_set_delay(p_mi, i_delay): ''' f = _Cfunctions.get('libvlc_audio_set_delay', None) or \ _Cfunction('libvlc_audio_set_delay', ((1,), (1,),), None, - ctypes.c_int, MediaPlayer, ctypes.c_int64) + ctypes.c_int, MediaPlayer, ctypes.c_int64) return f(p_mi, i_delay) + def libvlc_audio_equalizer_get_preset_count(): '''Get the number of equalizer presets. @return: number of presets. @@ -8045,9 +7941,10 @@ def libvlc_audio_equalizer_get_preset_count(): ''' f = _Cfunctions.get('libvlc_audio_equalizer_get_preset_count', None) or \ _Cfunction('libvlc_audio_equalizer_get_preset_count', (), None, - ctypes.c_uint) + ctypes.c_uint) return f() + def libvlc_audio_equalizer_get_preset_name(u_index): '''Get the name of a particular equalizer preset. This name can be used, for example, to prepare a preset label or menu in a user @@ -8058,9 +7955,10 @@ def libvlc_audio_equalizer_get_preset_name(u_index): ''' f = _Cfunctions.get('libvlc_audio_equalizer_get_preset_name', None) or \ _Cfunction('libvlc_audio_equalizer_get_preset_name', ((1,),), None, - ctypes.c_char_p, ctypes.c_uint) + ctypes.c_char_p, ctypes.c_uint) return f(u_index) + def libvlc_audio_equalizer_get_band_count(): '''Get the number of distinct frequency bands for an equalizer. @return: number of frequency bands. @@ -8068,9 +7966,10 @@ def libvlc_audio_equalizer_get_band_count(): ''' f = _Cfunctions.get('libvlc_audio_equalizer_get_band_count', None) or \ _Cfunction('libvlc_audio_equalizer_get_band_count', (), None, - ctypes.c_uint) + ctypes.c_uint) return f() + def libvlc_audio_equalizer_get_band_frequency(u_index): '''Get a particular equalizer band frequency. This value can be used, for example, to create a label for an equalizer band control @@ -8081,9 +7980,10 @@ def libvlc_audio_equalizer_get_band_frequency(u_index): ''' f = _Cfunctions.get('libvlc_audio_equalizer_get_band_frequency', None) or \ _Cfunction('libvlc_audio_equalizer_get_band_frequency', ((1,),), None, - ctypes.c_float, ctypes.c_uint) + ctypes.c_float, ctypes.c_uint) return f(u_index) + def libvlc_audio_equalizer_new(): '''Create a new default equalizer, with all frequency values zeroed. The new equalizer can subsequently be applied to a media player by invoking @@ -8095,9 +7995,10 @@ def libvlc_audio_equalizer_new(): ''' f = _Cfunctions.get('libvlc_audio_equalizer_new', None) or \ _Cfunction('libvlc_audio_equalizer_new', (), class_result(AudioEqualizer), - ctypes.c_void_p) + ctypes.c_void_p) return f() + def libvlc_audio_equalizer_new_from_preset(u_index): '''Create a new equalizer, with initial frequency values copied from an existing preset. @@ -8111,9 +8012,10 @@ def libvlc_audio_equalizer_new_from_preset(u_index): ''' f = _Cfunctions.get('libvlc_audio_equalizer_new_from_preset', None) or \ _Cfunction('libvlc_audio_equalizer_new_from_preset', ((1,),), class_result(AudioEqualizer), - ctypes.c_void_p, ctypes.c_uint) + ctypes.c_void_p, ctypes.c_uint) return f(u_index) + def libvlc_audio_equalizer_release(p_equalizer): '''Release a previously created equalizer instance. The equalizer was previously created by using L{libvlc_audio_equalizer_new}() or @@ -8124,9 +8026,10 @@ def libvlc_audio_equalizer_release(p_equalizer): ''' f = _Cfunctions.get('libvlc_audio_equalizer_release', None) or \ _Cfunction('libvlc_audio_equalizer_release', ((1,),), None, - None, AudioEqualizer) + None, AudioEqualizer) return f(p_equalizer) + def libvlc_audio_equalizer_set_preamp(p_equalizer, f_preamp): '''Set a new pre-amplification value for an equalizer. The new equalizer settings are subsequently applied to a media player by invoking @@ -8139,9 +8042,10 @@ def libvlc_audio_equalizer_set_preamp(p_equalizer, f_preamp): ''' f = _Cfunctions.get('libvlc_audio_equalizer_set_preamp', None) or \ _Cfunction('libvlc_audio_equalizer_set_preamp', ((1,), (1,),), None, - ctypes.c_int, AudioEqualizer, ctypes.c_float) + ctypes.c_int, AudioEqualizer, ctypes.c_float) return f(p_equalizer, f_preamp) + def libvlc_audio_equalizer_get_preamp(p_equalizer): '''Get the current pre-amplification value from an equalizer. @param p_equalizer: valid equalizer handle, must not be None. @@ -8150,9 +8054,10 @@ def libvlc_audio_equalizer_get_preamp(p_equalizer): ''' f = _Cfunctions.get('libvlc_audio_equalizer_get_preamp', None) or \ _Cfunction('libvlc_audio_equalizer_get_preamp', ((1,),), None, - ctypes.c_float, AudioEqualizer) + ctypes.c_float, AudioEqualizer) return f(p_equalizer) + def libvlc_audio_equalizer_set_amp_at_index(p_equalizer, f_amp, u_band): '''Set a new amplification value for a particular equalizer frequency band. The new equalizer settings are subsequently applied to a media player by invoking @@ -8166,9 +8071,10 @@ def libvlc_audio_equalizer_set_amp_at_index(p_equalizer, f_amp, u_band): ''' f = _Cfunctions.get('libvlc_audio_equalizer_set_amp_at_index', None) or \ _Cfunction('libvlc_audio_equalizer_set_amp_at_index', ((1,), (1,), (1,),), None, - ctypes.c_int, AudioEqualizer, ctypes.c_float, ctypes.c_uint) + ctypes.c_int, AudioEqualizer, ctypes.c_float, ctypes.c_uint) return f(p_equalizer, f_amp, u_band) + def libvlc_audio_equalizer_get_amp_at_index(p_equalizer, u_band): '''Get the amplification value for a particular equalizer frequency band. @param p_equalizer: valid equalizer handle, must not be None. @@ -8178,9 +8084,10 @@ def libvlc_audio_equalizer_get_amp_at_index(p_equalizer, u_band): ''' f = _Cfunctions.get('libvlc_audio_equalizer_get_amp_at_index', None) or \ _Cfunction('libvlc_audio_equalizer_get_amp_at_index', ((1,), (1,),), None, - ctypes.c_float, AudioEqualizer, ctypes.c_uint) + ctypes.c_float, AudioEqualizer, ctypes.c_uint) return f(p_equalizer, u_band) + def libvlc_media_player_set_equalizer(p_mi, p_equalizer): '''Apply new equalizer settings to a media player. The equalizer is first created by invoking L{libvlc_audio_equalizer_new}() or @@ -8204,9 +8111,10 @@ def libvlc_media_player_set_equalizer(p_mi, p_equalizer): ''' f = _Cfunctions.get('libvlc_media_player_set_equalizer', None) or \ _Cfunction('libvlc_media_player_set_equalizer', ((1,), (1,),), None, - ctypes.c_int, MediaPlayer, AudioEqualizer) + ctypes.c_int, MediaPlayer, AudioEqualizer) return f(p_mi, p_equalizer) + def libvlc_media_player_get_role(p_mi): '''Gets the media role. @param p_mi: media player. @@ -8215,9 +8123,10 @@ def libvlc_media_player_get_role(p_mi): ''' f = _Cfunctions.get('libvlc_media_player_get_role', None) or \ _Cfunction('libvlc_media_player_get_role', ((1,),), None, - ctypes.c_int, MediaPlayer) + ctypes.c_int, MediaPlayer) return f(p_mi) + def libvlc_media_player_set_role(p_mi, role): '''Sets the media role. @param p_mi: media player. @@ -8226,191 +8135,513 @@ def libvlc_media_player_set_role(p_mi, role): ''' f = _Cfunctions.get('libvlc_media_player_set_role', None) or \ _Cfunction('libvlc_media_player_set_role', ((1,), (1,),), None, - ctypes.c_int, MediaPlayer, ctypes.c_uint) + ctypes.c_int, MediaPlayer, ctypes.c_uint) return f(p_mi, role) -def libvlc_media_list_player_new(p_instance): - '''Create new media_list_player. - @param p_instance: libvlc instance. - @return: media list player instance or None 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) - 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) - 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) - 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) - 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) - return f(p_mlp, p_mi) - -def libvlc_media_list_player_get_media_player(p_mlp): - '''Get media player of the media_list_player instance. - @param p_mlp: media list player instance. - @return: media player instance @note the caller is responsible for releasing the returned instance. - ''' - f = _Cfunctions.get('libvlc_media_list_player_get_media_player', None) or \ - _Cfunction('libvlc_media_list_player_get_media_player', ((1,),), class_result(MediaPlayer), - ctypes.c_void_p, MediaListPlayer) - return f(p_mlp) - -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) - 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) - return f(p_mlp) - -def libvlc_media_list_player_pause(p_mlp): - '''Toggle pause (or resume) 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) - return f(p_mlp) - -def libvlc_media_list_player_set_pause(p_mlp, do_pause): - '''Pause or resume media list. - @param p_mlp: media list player instance. - @param do_pause: play/resume if zero, pause if non-zero. +def libvlc_renderer_item_hold(p_item): + '''Hold a renderer item, i.e. creates a new reference + This functions need to called from the libvlc_RendererDiscovererItemAdded + callback if the libvlc user wants to use this item after. (for display or + for passing it to the mediaplayer for example). + @return: the current item. @version: LibVLC 3.0.0 or later. ''' - f = _Cfunctions.get('libvlc_media_list_player_set_pause', None) or \ - _Cfunction('libvlc_media_list_player_set_pause', ((1,), (1,),), None, - None, MediaListPlayer, ctypes.c_int) - return f(p_mlp, do_pause) + f = _Cfunctions.get('libvlc_renderer_item_hold', None) or \ + _Cfunction('libvlc_renderer_item_hold', ((1,),), class_result(Renderer), + ctypes.c_void_p, Renderer) + return f(p_item) -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) - 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: L{State} for media list player. +def libvlc_renderer_item_release(p_item): + '''Releases a renderer item, i.e. decrements its reference counter. + @version: LibVLC 3.0.0 or later. ''' - f = _Cfunctions.get('libvlc_media_list_player_get_state', None) or \ - _Cfunction('libvlc_media_list_player_get_state', ((1,),), None, - State, MediaListPlayer) - return f(p_mlp) + f = _Cfunctions.get('libvlc_renderer_item_release', None) or \ + _Cfunction('libvlc_renderer_item_release', ((1,),), None, + None, Renderer) + return f(p_item) -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) - 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. +def libvlc_renderer_item_name(p_item): + '''Get the human readable name of a renderer item. + @return: the name of the item (can't be None, must *not* be freed). + @version: LibVLC 3.0.0 or later. ''' - 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) - return f(p_mlp, p_md) + f = _Cfunctions.get('libvlc_renderer_item_name', None) or \ + _Cfunction('libvlc_renderer_item_name', ((1,),), None, + ctypes.c_char_p, Renderer) + return f(p_item) -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) - 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. +def libvlc_renderer_item_type(p_item): + '''Get the type (not translated) of a renderer item. For now, the type can only + be "chromecast" ("upnp", "airplay" may come later). + @return: the type of the item (can't be None, must *not* be freed). + @version: LibVLC 3.0.0 or later. ''' - f = _Cfunctions.get('libvlc_media_list_player_next', None) or \ - _Cfunction('libvlc_media_list_player_next', ((1,),), None, - ctypes.c_int, MediaListPlayer) - return f(p_mlp) + f = _Cfunctions.get('libvlc_renderer_item_type', None) or \ + _Cfunction('libvlc_renderer_item_type', ((1,),), None, + ctypes.c_char_p, Renderer) + return f(p_item) -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) - 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. +def libvlc_renderer_item_icon_uri(p_item): + '''Get the icon uri of a renderer item. + @return: the uri of the item's icon (can be None, must *not* be freed). + @version: LibVLC 3.0.0 or later. ''' - 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) - return f(p_mlp, e_mode) + f = _Cfunctions.get('libvlc_renderer_item_icon_uri', None) or \ + _Cfunction('libvlc_renderer_item_icon_uri', ((1,),), None, + ctypes.c_char_p, Renderer) + return f(p_item) + + +def libvlc_renderer_item_flags(p_item): + '''Get the flags of a renderer item + See LIBVLC_RENDERER_CAN_AUDIO + See LIBVLC_RENDERER_CAN_VIDEO. + @return: bitwise flag: capabilities of the renderer, see. + @version: LibVLC 3.0.0 or later. + ''' + f = _Cfunctions.get('libvlc_renderer_item_flags', None) or \ + _Cfunction('libvlc_renderer_item_flags', ((1,),), None, + ctypes.c_int, Renderer) + return f(p_item) + + +def libvlc_renderer_discoverer_new(p_inst, psz_name): + '''Create a renderer discoverer object by name + After this object is created, you should attach to events in order to be + notified of the discoverer events. + You need to call L{libvlc_renderer_discoverer_start}() in order to start the + discovery. + See L{libvlc_renderer_discoverer_event_manager}() + See L{libvlc_renderer_discoverer_start}(). + @param p_inst: libvlc instance. + @param psz_name: service name; use L{libvlc_renderer_discoverer_list_get}() to get a list of the discoverer names available in this libVLC instance. + @return: media discover object or None in case of error. + @version: LibVLC 3.0.0 or later. + ''' + f = _Cfunctions.get('libvlc_renderer_discoverer_new', None) or \ + _Cfunction('libvlc_renderer_discoverer_new', ((1,), (1,),), class_result(RendererDiscoverer), + ctypes.c_void_p, Instance, ctypes.c_char_p) + return f(p_inst, psz_name) + + +def libvlc_renderer_discoverer_release(p_rd): + '''Release a renderer discoverer object. + @param p_rd: renderer discoverer object. + @version: LibVLC 3.0.0 or later. + ''' + f = _Cfunctions.get('libvlc_renderer_discoverer_release', None) or \ + _Cfunction('libvlc_renderer_discoverer_release', ((1,),), None, + None, RendererDiscoverer) + return f(p_rd) + + +def libvlc_renderer_discoverer_start(p_rd): + '''Start renderer discovery + To stop it, call L{libvlc_renderer_discoverer_stop}() or + L{libvlc_renderer_discoverer_release}() directly. + See L{libvlc_renderer_discoverer_stop}(). + @param p_rd: renderer discoverer object. + @return: -1 in case of error, 0 otherwise. + @version: LibVLC 3.0.0 or later. + ''' + f = _Cfunctions.get('libvlc_renderer_discoverer_start', None) or \ + _Cfunction('libvlc_renderer_discoverer_start', ((1,),), None, + ctypes.c_int, RendererDiscoverer) + return f(p_rd) + + +def libvlc_renderer_discoverer_stop(p_rd): + '''Stop renderer discovery. + See L{libvlc_renderer_discoverer_start}(). + @param p_rd: renderer discoverer object. + @version: LibVLC 3.0.0 or later. + ''' + f = _Cfunctions.get('libvlc_renderer_discoverer_stop', None) or \ + _Cfunction('libvlc_renderer_discoverer_stop', ((1,),), None, + None, RendererDiscoverer) + return f(p_rd) + + +def libvlc_renderer_discoverer_event_manager(p_rd): + '''Get the event manager of the renderer discoverer + The possible events to attach are @ref libvlc_RendererDiscovererItemAdded + and @ref libvlc_RendererDiscovererItemDeleted. + The @ref L{Renderer} struct passed to event callbacks is owned by + VLC, users should take care of holding/releasing this struct for their + internal usage. + See L{Event}.u.renderer_discoverer_item_added.item + See L{Event}.u.renderer_discoverer_item_removed.item. + @return: a valid event manager (can't fail). + @version: LibVLC 3.0.0 or later. + ''' + f = _Cfunctions.get('libvlc_renderer_discoverer_event_manager', None) or \ + _Cfunction('libvlc_renderer_discoverer_event_manager', ((1,),), class_result(EventManager), + ctypes.c_void_p, RendererDiscoverer) + return f(p_rd) + + +def libvlc_renderer_discoverer_list_get(p_inst, ppp_services): + '''Get media discoverer services + See libvlc_renderer_list_release(). + @param p_inst: libvlc instance. + @param ppp_services: address to store an allocated array of renderer discoverer services (must be freed with libvlc_renderer_list_release() by the caller) [OUT]. + @return: the number of media discoverer services (0 on error). + @version: LibVLC 3.0.0 and later. + ''' + f = _Cfunctions.get('libvlc_renderer_discoverer_list_get', None) or \ + _Cfunction('libvlc_renderer_discoverer_list_get', ((1,), (1,),), None, + ctypes.c_size_t, Instance, ctypes.POINTER(ctypes.POINTER(ctypes.POINTER(RdDescription)))) + return f(p_inst, ppp_services) + + +def libvlc_renderer_discoverer_list_release(pp_services, i_count): + '''Release an array of media discoverer services + See L{libvlc_renderer_discoverer_list_get}(). + @param pp_services: array to release. + @param i_count: number of elements in the array. + @version: LibVLC 3.0.0 and later. + ''' + f = _Cfunctions.get('libvlc_renderer_discoverer_list_release', None) or \ + _Cfunction('libvlc_renderer_discoverer_list_release', ((1,), (1,),), None, + None, ctypes.POINTER(ctypes.POINTER(RdDescription)), ctypes.c_size_t) + return f(pp_services, i_count) + + +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) + 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) + 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) + 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) + 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) + 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) + 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) + 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) + 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) + 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) + 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) + 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) + 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) + 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) + 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) + 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 None 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) + 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) + 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) + 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) + 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) + 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) + 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) + 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) + 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) + return f(p_instance) # 5 function(s) blacklisted: @@ -8468,6 +8699,7 @@ 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'): @@ -8487,7 +8719,8 @@ if not hasattr(dll, 'libvlc_free'): # ensure argtypes is right, because default type of int won't # work on 64-bit systems - libvlc_free.argtypes = [ ctypes.c_void_p ] + libvlc_free.argtypes = [ctypes.c_void_p] + # Version functions def _dot2int(v): @@ -8508,6 +8741,7 @@ def _dot2int(v): i = (i << 8) + t.pop(0) return i + def hex_version(): """Return the version of these bindings in hex or 0 if unavailable. """ @@ -8516,6 +8750,7 @@ def hex_version(): except (NameError, ValueError): return 0 + def libvlc_hex_version(): """Return the libvlc version in hex or 0 if unavailable. """ @@ -8524,6 +8759,7 @@ def libvlc_hex_version(): except ValueError: return 0 + def debug_callback(event, *args, **kwds): '''Example callback, useful for debugging. ''' @@ -8543,6 +8779,7 @@ if __name__ == '__main__': import termios import tty + def getch(): # getchar(), getc(stdin) #PYCHOK flake fd = sys.stdin.fileno() old = termios.tcgetattr(fd) @@ -8553,11 +8790,15 @@ if __name__ == '__main__': 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, @@ -8565,6 +8806,7 @@ if __name__ == '__main__': player.get_position() * 100)) sys.stdout.flush() + def print_python(): from platform import architecture, mac_ver, uname, win32_ver if 'intelpython' in sys.executable: @@ -8586,6 +8828,7 @@ if __name__ == '__main__': t = (t,) + uname()[0:3:2] print(' '.join(t)) + def print_version(): """Print version of this vlc.py and of the libvlc""" try: @@ -8597,6 +8840,7 @@ if __name__ == '__main__': except Exception: print('Error: %s' % sys.exc_info()[1]) + if '-h' in sys.argv[:2] or '--help' in sys.argv[:2]: print('Usage: %s [options] ' % sys.argv[0]) print('Once launched, type ? for help.') @@ -8646,13 +8890,15 @@ if __name__ == '__main__': # 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.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: @@ -8668,26 +8914,31 @@ if __name__ == '__main__': 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() + # 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:') @@ -8696,15 +8947,18 @@ if __name__ == '__main__': 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, @@ -8716,7 +8970,7 @@ if __name__ == '__main__': 'p': toggle_echo_position, 'q': quit_app, '?': print_help, - } + } print('Press q to quit, ? to get help.%s' % os.linesep) while True: @@ -8725,5 +8979,5 @@ if __name__ == '__main__': if k in keybindings: keybindings[k]() elif k.isdigit(): - # jump to fraction of the movie. - player.set_position(float('0.'+k)) + # jump to fraction of the movie. + player.set_position(float('0.' + k))