openlp-core team mailing list archive
-
openlp-core team
-
Mailing list archive
-
Message #33115
[Merge] lp:~bastian-germann/openlp/vlc-update into lp:openlp
Bastian Germann has proposed merging lp:~bastian-germann/openlp/vlc-update into lp:openlp.
Commit message:
Import https://pypi.org/project/python-vlc/3.0.4106/
Requested reviews:
OpenLP Core (openlp-core)
For more details, see:
https://code.launchpad.net/~bastian-germann/openlp/vlc-update/+merge/356569
Import the latest python-vlc release from PyPI.
--
Your team OpenLP Core is requested to review the proposed merge of lp:~bastian-germann/openlp/vlc-update into lp:openlp.
=== modified file 'openlp/core/lib/__init__.py'
--- openlp/core/lib/__init__.py 2018-08-25 14:08:19 +0000
+++ openlp/core/lib/__init__.py 2018-10-11 11:45:39 +0000
@@ -609,4 +609,4 @@
last=string_list[-1])
else:
list_to_string = ''
- return list_to_string
\ No newline at end of file
+ return list_to_string
=== modified file 'openlp/core/ui/media/vendor/vlc.py'
--- openlp/core/ui/media/vendor/vlc.py 2017-12-28 08:27:44 +0000
+++ openlp/core/ui/media/vendor/vlc.py 2018-10-11 11:45:39 +0000
@@ -1,8 +1,9 @@
#! /usr/bin/python
+# -*- coding: utf-8 -*-
# Python ctypes bindings for VLC
#
-# Copyright (C) 2009-2012 the VideoLAN team
+# Copyright (C) 2009-2017 the VideoLAN team
# $Id: $
#
# Authors: Olivier Aubert <contact at olivieraubert.net>
@@ -27,7 +28,7 @@
U{http://wiki.videolan.org/LibVLC}.
You can find the documentation and a README file with some examples
-at U{http://www.advene.org/download/python-ctypes/}.
+at U{http://www.olivieraubert.net/vlc/python-ctypes/}.
Basically, the most important class is L{Instance}, which is used
to create a libvlc instance. From this instance, you then create
@@ -40,15 +41,21 @@
"""
import ctypes
-import functools
+from ctypes.util import find_library
import os
import sys
-from ctypes.util import find_library
+import functools
+
# Used by EventManager in override.py
from inspect import getargspec
-__version__ = "N/A"
-build_date = "Mon Jan 25 19:40:05 2016"
+import logging
+logger = logging.getLogger(__name__)
+
+__version__ = "3.0.4106"
+__libvlc_version__ = "3.0.4"
+__generator_version__ = "1.6"
+build_date = "Sun Oct 7 00:09:54 2018 3.0.4"
# The libvlc doc states that filenames are expected to be in UTF8, do
# not rely on sys.getfilesystemencoding() which will be confused,
@@ -104,7 +111,19 @@
def find_lib():
dll = None
- plugin_path = None
+ plugin_path = os.environ.get('PYTHON_VLC_MODULE_PATH', None)
+ if 'PYTHON_VLC_LIB_PATH' in os.environ:
+ try:
+ dll = ctypes.CDLL(os.environ['PYTHON_VLC_LIB_PATH'])
+ except OSError:
+ logger.error("Cannot load lib specified by PYTHON_VLC_LIB_PATH env. variable")
+ sys.exit(1)
+ if plugin_path and not os.path.isdir(plugin_path):
+ logger.error("Invalid PYTHON_VLC_MODULE_PATH specified. Please fix.")
+ sys.exit(1)
+ if dll is not None:
+ return dll, plugin_path
+
if sys.platform.startswith('linux'):
p = find_library('vlc')
try:
@@ -112,7 +131,8 @@
except OSError: # may fail
dll = ctypes.CDLL('libvlc.so.5')
elif sys.platform.startswith('win'):
- p = find_library('libvlc.dll')
+ libname = 'libvlc.dll'
+ p = find_library(libname)
if p is None:
try: # some registry settings
# leaner than win32api, win32con
@@ -131,10 +151,14 @@
except ImportError: # no PyWin32
pass
if plugin_path is None:
- # try some standard locations.
- for p in ('Program Files\\VideoLan\\', 'VideoLan\\',
- 'Program Files\\', ''):
- p = 'C:\\' + p + 'VLC\\libvlc.dll'
+ # try some standard locations.
+ 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)
if os.path.exists(p):
plugin_path = os.path.dirname(p)
break
@@ -142,11 +166,11 @@
p = os.getcwd()
os.chdir(plugin_path)
# if chdir failed, this will raise an exception
- dll = ctypes.CDLL('libvlc.dll')
+ dll = ctypes.CDLL(libname)
# restore cwd after dll has been loaded
os.chdir(p)
else: # may fail
- dll = ctypes.CDLL('libvlc.dll')
+ dll = ctypes.CDLL(libname)
else:
plugin_path = os.path.dirname(p)
dll = ctypes.CDLL(p)
@@ -154,13 +178,20 @@
elif sys.platform.startswith('darwin'):
# FIXME: should find a means to configure path
d = '/Applications/VLC.app/Contents/MacOS/'
+ c = d + 'lib/libvlccore.dylib'
p = d + 'lib/libvlc.dylib'
- if os.path.exists(p):
+ if os.path.exists(p) and os.path.exists(c):
+ # pre-load libvlccore VLC 2.2.8+
+ ctypes.CDLL(c)
dll = ctypes.CDLL(p)
- d += 'modules'
- if os.path.isdir(d):
- plugin_path = d
- else: # hope, some PATH is set...
+ for p in ('modules', 'plugins'):
+ p = d + p
+ if os.path.isdir(p):
+ plugin_path = p
+ break
+ else: # hope, some [DY]LD_LIBRARY_PATH is set...
+ # pre-load libvlccore VLC 2.2.8+
+ ctypes.CDLL('libvlccore.dylib')
dll = ctypes.CDLL('libvlc.dylib')
else:
@@ -292,6 +323,8 @@
def from_param(self, param):
if isinstance(param, _Seqs):
return (self.etype * len(param))(*param)
+ else:
+ return ctypes.POINTER(param)
# errcheck functions for some native functions.
def string_result(result, func, arguments):
@@ -393,6 +426,37 @@
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
+@ingroup libvlc
+@{
+@file
+libvlc dialog external api.
+ '''
+ _enum_names_ = {
+ 0: 'NORMAL',
+ 1: 'WARNING',
+ 2: 'CRITICAL',
+ }
+DialogQuestionType.CRITICAL = DialogQuestionType(2)
+DialogQuestionType.NORMAL = DialogQuestionType(0)
+DialogQuestionType.WARNING = DialogQuestionType(1)
+
class EventType(_Enum):
'''Event types.
'''
@@ -424,10 +488,21 @@
273: 'MediaPlayerLengthChanged',
274: 'MediaPlayerVout',
275: 'MediaPlayerScrambledChanged',
+ 276: 'MediaPlayerESAdded',
+ 277: 'MediaPlayerESDeleted',
+ 278: 'MediaPlayerESSelected',
+ 279: 'MediaPlayerCorked',
+ 280: 'MediaPlayerUncorked',
+ 281: 'MediaPlayerMuted',
+ 282: 'MediaPlayerUnmuted',
+ 283: 'MediaPlayerAudioVolume',
+ 284: 'MediaPlayerAudioDevice',
+ 285: 'MediaPlayerChapterChanged',
0x200: 'MediaListItemAdded',
513: 'MediaListWillAddItem',
514: 'MediaListItemDeleted',
515: 'MediaListWillDeleteItem',
+ 516: 'MediaListEndReached',
0x300: 'MediaListViewItemAdded',
769: 'MediaListViewWillAddItem',
770: 'MediaListViewItemDeleted',
@@ -437,6 +512,8 @@
1026: 'MediaListPlayerStopped',
0x500: 'MediaDiscovererStarted',
1281: 'MediaDiscovererEnded',
+ 1282: 'RendererDiscovererItemAdded',
+ 1283: 'RendererDiscovererItemDeleted',
0x600: 'VlmMediaAdded',
1537: 'VlmMediaRemoved',
1538: 'VlmMediaChanged',
@@ -453,6 +530,7 @@
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)
@@ -466,13 +544,21 @@
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)
@@ -485,10 +571,14 @@
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)
@@ -528,15 +618,21 @@
20: 'Episode',
21: 'ShowName',
22: 'Actors',
+ 23: 'AlbumArtist',
+ 24: 'DiscNumber',
+ 25: 'DiscTotal',
}
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.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)
@@ -558,7 +654,7 @@
See mediacontrol_playerstatus, See input_state_e enums,
and videolan.libvlc.state (at bindings/cil/src/media.cs).
expected states by web plugins are:
-idle/close=0, opening=1, buffering=2, playing=3, paused=4,
+idle/close=0, opening=1, playing=3, paused=4,
stopping=5, ended=6, error=7.
'''
_enum_names_ = {
@@ -594,17 +690,102 @@
TrackType.unknown = TrackType(-1)
TrackType.video = TrackType(1)
-class PlaybackMode(_Enum):
- '''Defines playback modes for playlist.
- '''
- _enum_names_ = {
- 0: 'default',
- 1: 'loop',
- 2: 'repeat',
- }
-PlaybackMode.default = PlaybackMode(0)
-PlaybackMode.loop = PlaybackMode(1)
-PlaybackMode.repeat = PlaybackMode(2)
+class VideoOrient(_Enum):
+ '''N/A
+ '''
+ _enum_names_ = {
+ 0: 'left',
+ 1: 'right',
+ 2: 'left',
+ 3: 'right',
+ 4: 'top',
+ 5: 'bottom',
+ 6: 'top',
+ 7: 'bottom',
+ }
+VideoOrient.bottom = VideoOrient(5)
+VideoOrient.bottom = VideoOrient(7)
+VideoOrient.left = VideoOrient(0)
+VideoOrient.left = VideoOrient(2)
+VideoOrient.right = VideoOrient(1)
+VideoOrient.right = VideoOrient(3)
+VideoOrient.top = VideoOrient(4)
+VideoOrient.top = VideoOrient(6)
+
+class VideoProjection(_Enum):
+ '''N/A
+ '''
+ _enum_names_ = {
+ 0: 'rectangular',
+ 1: 'equirectangular',
+ 0x100: 'standard',
+ }
+VideoProjection.equirectangular = VideoProjection(1)
+VideoProjection.rectangular = VideoProjection(0)
+VideoProjection.standard = VideoProjection(0x100)
+
+class MediaType(_Enum):
+ '''Media type
+See libvlc_media_get_type.
+ '''
+ _enum_names_ = {
+ 0: 'unknown',
+ 1: 'file',
+ 2: 'directory',
+ 3: 'disc',
+ 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)
+
+class MediaParseFlag(_Enum):
+ '''Parse flags used by libvlc_media_parse_with_options()
+See libvlc_media_parse_with_options.
+ '''
+ _enum_names_ = {
+ 0x0: 'local',
+ 0x1: 'network',
+ 0x2: 'local',
+ 0x4: 'network',
+ 0x8: 'interact',
+ }
+MediaParseFlag.interact = MediaParseFlag(0x8)
+MediaParseFlag.local = MediaParseFlag(0x0)
+MediaParseFlag.local = MediaParseFlag(0x2)
+MediaParseFlag.network = MediaParseFlag(0x1)
+MediaParseFlag.network = MediaParseFlag(0x4)
+
+class MediaParsedStatus(_Enum):
+ '''Parse status used sent by libvlc_media_parse_with_options() or returned by
+libvlc_media_get_parsed_status()
+See libvlc_media_parse_with_options
+See libvlc_media_get_parsed_status.
+ '''
+ _enum_names_ = {
+ 1: 'skipped',
+ 2: 'failed',
+ 3: 'timeout',
+ 4: 'done',
+ }
+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.
+ '''
+ _enum_names_ = {
+ 0: 'subtitle',
+ 1: 'audio',
+ }
+MediaSlaveType.audio = MediaSlaveType(1)
+MediaSlaveType.subtitle = MediaSlaveType(0)
class VideoMarqueeOption(_Enum):
'''Marq options definition.
@@ -641,10 +822,12 @@
2: 'down',
3: 'left',
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)
@@ -674,6 +857,23 @@
Position.right = Position(8)
Position.top = Position(3)
+class TeletextKey(_Enum):
+ '''Enumeration of teletext keys than can be passed via
+libvlc_video_set_teletext().
+ '''
+ _enum_names_ = {
+ 7471104: 'red',
+ 6750208: 'green',
+ 7929856: 'yellow',
+ 6422528: 'blue',
+ 6881280: 'index',
+ }
+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}.
'''
@@ -756,277 +956,367 @@
AudioOutputChannel.Right = AudioOutputChannel(4)
AudioOutputChannel.Stereo = AudioOutputChannel(1)
+class MediaPlayerRole(_Enum):
+ '''Media player roles.
+\version libvlc 3.0.0 and later.
+see \ref libvlc_media_player_set_role().
+ '''
+ _enum_names_ = {
+ 0: '_None',
+ 1: 'Music',
+ 2: 'Video',
+ 3: 'Communication',
+ 4: 'Game',
+ 5: 'Notification',
+ 6: 'Animation',
+ 7: 'Production',
+ 8: 'Accessibility',
+ 9: 'Test',
+ }
+MediaPlayerRole.Accessibility = MediaPlayerRole(8)
+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)
+
+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 Callback(ctypes.c_void_p):
- """Callback function notification
-\param p_event the event triggering the callback
+ """Callback function notification.
+ @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}()
-\param level message level (@ref enum libvlc_log_level)
-\param ctx message context (meta-information about the message)
-\param fmt printf() format string (as defined by ISO C11)
-\param args variable argument list for the format
-\note Log message handlers <b>must</b> be thread-safe.
-\warning The message context pointer, the format string parameters and the
- variable arguments are only valid until the callback returns.
+ @param data: data pointer as given to L{libvlc_log_set}().
+ @param level: message level (@ref L{LogLevel}).
+ @param ctx: message context (meta-information about the message).
+ @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.
+ """
+ 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.
+ @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 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 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.
"""
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
-invoked. Depending on the video chroma, one or three pixel planes of
-adequate dimensions must be returned via the second parameter. Those
-planes must be aligned on 32-bytes boundaries.
-\param opaque private pointer as passed to L{libvlc_video_set_callbacks}() [IN]
-\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
+ 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
+ adequate dimensions must be returned via the second parameter. Those
+ planes must be aligned on 32-bytes boundaries.
+ @param opaque: private pointer as passed to L{libvlc_video_set_callbacks}() [IN].
+ @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.
"""
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.
-This callback might not be needed at all. It is only an indication that the
-application can now read the pixel values if it needs to.
-\warning 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]
+ 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
+ application can now read the pixel values if it needs to.
+ @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].
"""
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]
+ 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].
"""
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
-and the chain of video filters (if any). It can opt to change any parameter
-as it needs. In that case, LibVLC will attempt to convert the video format
-(rescaling and chroma conversion) but these operations can be CPU intensive.
-\param opaque pointer to the private pointer passed to
- L{libvlc_video_set_callbacks}() [IN/OUT]
-\param chroma pointer to the 4 bytes video format identifier [IN/OUT]
-\param width pointer to the pixel width [IN/OUT]
-\param height pointer to the pixel height [IN/OUT]
-\param pitches table of scanline pitches in bytes for each pixel plane
- (the table is allocated by LibVLC) [OUT]
-\param lines table of scanlines count for each plane [OUT]
-\return the number of picture buffers allocated, 0 indicates failure
-\note
-For each pixels plane, the scanline pitch must be bigger than or equal to
-the number of bytes per pixel multiplied by the pixel width.
-Similarly, the number of scanlines must be bigger than of equal to
-the pixel height.
-Furthermore, we recommend that pitches and lines be multiple of 32
-to not break assumption that might be made by various optimizations
-in the video decoders, video filters and/or video converters.
+ 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
+ as it needs. In that case, LibVLC will attempt to convert the video format
+ (rescaling and chroma conversion) but these operations can be CPU intensive.
+ @param opaque: pointer to the private pointer passed to L{libvlc_video_set_callbacks}() [IN/OUT].
+ @param chroma: pointer to the 4 bytes video format identifier [IN/OUT].
+ @param width: pointer to the pixel width [IN/OUT].
+ @param height: pointer to the pixel height [IN/OUT].
+ @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.
"""
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 libvlc_video_format_cb) [IN].
"""
pass
class AudioPlayCb(ctypes.c_void_p):
"""Callback prototype for audio playback.
-\param data data pointer as passed to L{libvlc_audio_set_callbacks}() [IN]
-\param samples pointer to the first audio sample to play back [IN]
-\param count number of audio samples to play back
-\param pts expected play time stamp (see libvlc_delay())
+ The LibVLC media player decodes and post-processes the audio signal
+ asynchronously (in an internal thread). Whenever audio samples are ready
+ to be queued to the output, this callback is invoked.
+ The number of samples provided per invocation may depend on the file format,
+ the audio coding algorithm, the decoder plug-in, the post-processing
+ filters and timing. Application must not assume a certain number of samples.
+ The exact format of audio samples is determined by L{libvlc_audio_set_format}()
+ or L{libvlc_audio_set_format_callbacks}() as is the channels layout.
+ Note that the number of samples is per channel. For instance, if the audio
+ track sampling rate is 48000 Hz, then 1200 samples represent 25 milliseconds
+ of audio signal - regardless of the number of audio channels.
+ @param data: data pointer as passed to L{libvlc_audio_set_callbacks}() [IN].
+ @param samples: pointer to a table of audio samples to play back [IN].
+ @param count: number of audio samples to play back.
+ @param pts: expected play time stamp (see libvlc_delay()).
"""
pass
class AudioPauseCb(ctypes.c_void_p):
"""Callback prototype for audio pause.
-\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)
+ 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).
"""
pass
class AudioResumeCb(ctypes.c_void_p):
- """Callback prototype for audio resumption (i.e. restart from pause).
-\note The resume callback is never called if the audio is not paused.
-\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)
+ """Callback prototype for audio resumption.
+ LibVLC invokes this callback to resume audio playback after it was
+ previously paused.
+ @note: The resume callback is never called if the audio is not paused.
+ @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).
"""
pass
class AudioFlushCb(ctypes.c_void_p):
- """Callback prototype for audio buffer flush
-(i.e. discard all pending buffers and stop playback as soon as possible).
-\param data data pointer as passed to L{libvlc_audio_set_callbacks}() [IN]
+ """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].
"""
pass
class AudioDrainCb(ctypes.c_void_p):
- """Callback prototype for audio buffer drain
-(i.e. wait for pending buffers to be played).
-\param data data pointer as passed to L{libvlc_audio_set_callbacks}() [IN]
+ """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].
"""
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]
-\param volume software volume (1. = nominal, 0. = mute)
-\param mute muted flag
+ @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.
"""
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.
-\param opaque pointer to the data pointer passed to
- L{libvlc_audio_set_callbacks}() [IN/OUT]
-\param format 4 bytes sample format [IN/OUT]
-\param rate sample rate [IN/OUT]
-\param channels channels count [IN/OUT]
-\return 0 on success, anything else to skip 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].
+ @param format: 4 bytes sample format [IN/OUT].
+ @param rate: sample rate [IN/OUT].
+ @param channels: channels count [IN/OUT].
+ @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]
+ 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.__doc__ = '''Callback function notification
-\param p_event the event triggering the callback
- '''
+ 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.__doc__ = '''Callback prototype for LibVLC log message handler.
-\param data data pointer as given to L{libvlc_log_set}()
-\param level message level (@ref enum libvlc_log_level)
-\param ctx message context (meta-information about the message)
-\param fmt printf() format string (as defined by ISO C11)
-\param args variable argument list for the format
-\note Log message handlers <b>must</b> be thread-safe.
-\warning The message context pointer, the format string parameters and the
- variable arguments are only valid until the callback returns.
- '''
- VideoLockCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ListPOINTER(ctypes.c_void_p))
+ @param data: data pointer as given to L{libvlc_log_set}().
+ @param level: message level (@ref L{LogLevel}).
+ @param ctx: message context (meta-information about the message).
+ @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.POINTER(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.
+ @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.POINTER(ctypes.c_ssize_t), ctypes.c_void_p, ctypes.c_char_p, 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 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.POINTER(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 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.__doc__ = '''Callback prototype to close a custom bitstream input media.
+ @param opaque: private pointer as set by the @ref libvlc_media_open_cb callback.
+ '''
+ 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
-adequate dimensions must be returned via the second parameter. Those
-planes must be aligned on 32-bytes boundaries.
-\param opaque private pointer as passed to L{libvlc_video_set_callbacks}() [IN]
-\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, ListPOINTER(ctypes.c_void_p))
+ 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
+ adequate dimensions must be returned via the second parameter. Those
+ planes must be aligned on 32-bytes boundaries.
+ @param opaque: private pointer as passed to L{libvlc_video_set_callbacks}() [IN].
+ @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.__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
-application can now read the pixel values if it needs to.
-\warning 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]
- '''
+ 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
+ application can now read the pixel values if it needs to.
+ @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].
+ '''
VideoDisplayCb = ctypes.CFUNCTYPE(ctypes.c_void_p, 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]
- '''
- VideoFormatCb = ctypes.CFUNCTYPE(ctypes.POINTER(ctypes.c_uint), ListPOINTER(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))
+ 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].
+ '''
+ VideoFormatCb = ctypes.CFUNCTYPE(ctypes.POINTER(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
-as it needs. In that case, LibVLC will attempt to convert the video format
-(rescaling and chroma conversion) but these operations can be CPU intensive.
-\param opaque pointer to the private pointer passed to
- L{libvlc_video_set_callbacks}() [IN/OUT]
-\param chroma pointer to the 4 bytes video format identifier [IN/OUT]
-\param width pointer to the pixel width [IN/OUT]
-\param height pointer to the pixel height [IN/OUT]
-\param pitches table of scanline pitches in bytes for each pixel plane
- (the table is allocated by LibVLC) [OUT]
-\param lines table of scanlines count for each plane [OUT]
-\return the number of picture buffers allocated, 0 indicates failure
-\note
-For each pixels plane, the scanline pitch must be bigger than or equal to
-the number of bytes per pixel multiplied by the pixel width.
-Similarly, the number of scanlines must be bigger than of equal to
-the pixel height.
-Furthermore, we recommend that pitches and lines be multiple of 32
-to not break assumption that might be made by various optimizations
-in the video decoders, video filters and/or video converters.
- '''
+ 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
+ as it needs. In that case, LibVLC will attempt to convert the video format
+ (rescaling and chroma conversion) but these operations can be CPU intensive.
+ @param opaque: pointer to the private pointer passed to L{libvlc_video_set_callbacks}() [IN/OUT].
+ @param chroma: pointer to the 4 bytes video format identifier [IN/OUT].
+ @param width: pointer to the pixel width [IN/OUT].
+ @param height: pointer to the pixel height [IN/OUT].
+ @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.__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 libvlc_video_format_cb) [IN].
+ '''
AudioPlayCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p, ctypes.c_uint, ctypes.c_int64)
AudioPlayCb.__doc__ = '''Callback prototype for audio playback.
-\param data data pointer as passed to L{libvlc_audio_set_callbacks}() [IN]
-\param samples pointer to the first audio sample to play back [IN]
-\param count number of audio samples to play back
-\param pts expected play time stamp (see libvlc_delay())
- '''
+ The LibVLC media player decodes and post-processes the audio signal
+ asynchronously (in an internal thread). Whenever audio samples are ready
+ to be queued to the output, this callback is invoked.
+ The number of samples provided per invocation may depend on the file format,
+ the audio coding algorithm, the decoder plug-in, the post-processing
+ filters and timing. Application must not assume a certain number of samples.
+ The exact format of audio samples is determined by L{libvlc_audio_set_format}()
+ or L{libvlc_audio_set_format_callbacks}() as is the channels layout.
+ Note that the number of samples is per channel. For instance, if the audio
+ track sampling rate is 48000 Hz, then 1200 samples represent 25 milliseconds
+ of audio signal - regardless of the number of audio channels.
+ @param data: data pointer as passed to L{libvlc_audio_set_callbacks}() [IN].
+ @param samples: pointer to a table of audio samples to play back [IN].
+ @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.__doc__ = '''Callback prototype for audio pause.
-\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)
- '''
+ 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.__doc__ = '''Callback prototype for audio resumption (i.e. restart from pause).
-\note The resume callback is never called if the audio is not paused.
-\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)
- '''
+ AudioResumeCb.__doc__ = '''Callback prototype for audio resumption.
+ LibVLC invokes this callback to resume audio playback after it was
+ previously paused.
+ @note: The resume callback is never called if the audio is not paused.
+ @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.__doc__ = '''Callback prototype for audio buffer flush
-(i.e. discard all pending buffers and stop playback as soon as possible).
-\param data data pointer as passed to L{libvlc_audio_set_callbacks}() [IN]
- '''
+ 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.__doc__ = '''Callback prototype for audio buffer drain
-(i.e. wait for pending buffers to be played).
-\param data data pointer as passed to L{libvlc_audio_set_callbacks}() [IN]
- '''
+ 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.__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.POINTER(ctypes.c_int), ListPOINTER(ctypes.c_void_p), ctypes.c_char_p, ctypes.POINTER(ctypes.c_uint), ctypes.POINTER(ctypes.c_uint))
+ @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.POINTER(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]
-\param format 4 bytes sample format [IN/OUT]
-\param rate sample rate [IN/OUT]
-\param channels channels count [IN/OUT]
-\return 0 on success, anything else to skip 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].
+ @param format: 4 bytes sample format [IN/OUT].
+ @param rate: sample rate [IN/OUT].
+ @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.__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]
- '''
+ 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 #
@@ -1277,21 +1567,54 @@
]
class TitleDescription(_Cstruct):
- _fields = [
+ _fields_ = [
('duration', ctypes.c_longlong),
('name', ctypes.c_char_p),
('menu', ctypes.c_bool),
]
class ChapterDescription(_Cstruct):
- _fields = [
+ _fields_ = [
('time_offset', ctypes.c_longlong),
('duration', ctypes.c_longlong),
('name', ctypes.c_char_p),
]
- # End of header.py #
-
+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)
+ ]
+
+# End of header.py #
class EventManager(_Ctype):
'''Create an event manager with callback handler.
@@ -1397,14 +1720,22 @@
elif isinstance(i, basestring):
args = i.strip().split()
elif isinstance(i, _Seqs):
- args = i
+ args = list(i)
else:
raise VLCException('Instance %r' % (args,))
-
- if not args and plugin_path is not None:
- # no parameters passed, for win32 and MacOS,
- # specify the plugin_path if detected earlier
- args = ['vlc', '--plugin-path=' + plugin_path]
+ else:
+ args = list(args)
+
+ if not args: # no parameters passed
+ args = ['vlc']
+ elif args[0] != 'vlc':
+ args.insert(0, 'vlc')
+
+ if plugin_path is not None:
+ # set plugin_path if detected, win32 and MacOS,
+ # if the user did not specify it itself.
+ os.environ.setdefault('VLC_PLUGIN_PATH', plugin_path)
+
if PYTHON3:
args = [ str_to_bytes(a) for a in args ]
return libvlc_new(len(args), args)
@@ -1481,10 +1812,7 @@
i = head
while i:
i = i.contents
- d = [{'id': libvlc_audio_output_device_id (self, i.name, d),
- 'longname': libvlc_audio_output_device_longname(self, i.name, d)}
- for d in range(libvlc_audio_output_device_count (self, i.name))]
- r.append({'name': i.name, 'description': i.description, 'devices': d})
+ r.append({'name': i.name, 'description': i.description})
i = i.next
libvlc_audio_output_list_release(head)
return r
@@ -1502,21 +1830,21 @@
return module_description_list(libvlc_video_filter_list_get(self))
-
+
def release(self):
'''Decrement the reference count of a libvlc instance, and destroy it
if it reaches zero.
'''
return libvlc_release(self)
-
+
def retain(self):
'''Increments the reference count of a libvlc instance.
The initial reference count is 1 after L{new}() returns.
'''
return libvlc_retain(self)
-
+
def add_intf(self, name):
'''Try to start a user interface for the libvlc instance.
@param name: interface name, or None for default.
@@ -1524,7 +1852,7 @@
'''
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.
@@ -1534,7 +1862,7 @@
'''
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}().
@@ -1545,18 +1873,20 @@
'''
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 for a LibVLC instance. This is rarely needed:
- the callback is implicitly unset when the instance is destroyed.
- This function will wait for any pending callbacks invocation to complete
- (causing a deadlock if called from within the callback).
+ '''Unsets the logging callback.
+ This function deregisters the logging callback for a LibVLC instance.
+ This is rarely needed as the callback is implicitly unset when the instance
+ is destroyed.
+ @note: This function will wait for any pending callbacks invocation to
+ complete (causing a deadlock if called from within the callback).
@version: LibVLC 2.1.0 or later.
'''
return libvlc_log_unset(self)
-
- def log_set(self, data, p_instance):
+
+ 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
invocation to complete.
@@ -1564,9 +1894,9 @@
@param p_instance: libvlc instance.
@version: LibVLC 2.1.0 or later.
'''
- return libvlc_log_set(self, data, p_instance)
-
-
+ 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}()).
@@ -1574,105 +1904,46 @@
'''
return libvlc_log_set_file(self, stream)
-
- def media_new_location(self, psz_mrl):
- '''Create a media with a certain given media resource location,
- for instance a valid URL.
- @note: To refer to a local file with this function,
- the file://... URI syntax B{must} be used (see IETF RFC3986).
- We recommend using L{media_new_path}() instead when dealing with
- local files.
- See L{media_release}.
- @param psz_mrl: the media location.
- @return: the newly created media or None on error.
- '''
- return libvlc_media_new_location(self, str_to_bytes(psz_mrl))
-
-
- def media_new_path(self, path):
- '''Create a media for a certain file path.
- See L{media_release}.
- @param path: local filesystem path.
- @return: the newly created media or None on error.
- '''
- return libvlc_media_new_path(self, str_to_bytes(path))
-
-
- def media_new_fd(self, fd):
- '''Create a media for an already open file descriptor.
- The file descriptor shall be open for reading (or reading and writing).
- Regular file descriptors, pipe read descriptors and character device
- descriptors (including TTYs) are supported on all platforms.
- Block device descriptors are supported where available.
- Directory descriptors are supported on systems that provide fdopendir().
- Sockets are supported on all platforms where they are file descriptors,
- i.e. all except Windows.
- @note: This library will B{not} automatically close the file descriptor
- under any circumstance. Nevertheless, a file descriptor can usually only be
- rendered once in a media player. To render it a second time, the file
- descriptor should probably be rewound to the beginning with lseek().
- See L{media_release}.
- @param fd: open file descriptor.
- @return: the newly created media or None on error.
- @version: LibVLC 1.1.5 and later.
- '''
- return libvlc_media_new_fd(self, fd)
-
-
- def media_new_as_node(self, psz_name):
- '''Create a media as an empty node with a given name.
- See L{media_release}.
- @param psz_name: the name of the node.
- @return: the new empty media or None on error.
- '''
- return libvlc_media_new_as_node(self, str_to_bytes(psz_name))
-
-
- def media_discoverer_new_from_name(self, psz_name):
- '''Discover media service by name.
- @param psz_name: service name.
+
+ 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.
- '''
- return libvlc_media_discoverer_new_from_name(self, str_to_bytes(psz_name))
-
-
+ @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 audio_output_list_get(self):
- '''Gets the list of available audio output modules.
- @return: list of available audio outputs. It must be freed it with In case of error, None is returned.
- '''
- 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}().
- @note: Not all audio outputs support this. In particular, an empty (None)
- list of devices does B{not} imply that the specified audio output does
- not work.
- @note: The list might not be exhaustive.
- @warning: Some audio output devices in the list might not actually work in
- some circumstances. By default, it is recommended to not specify any
- explicit audio device.
- @param psz_aout: audio output name (as returned by L{audio_output_list_get}()).
- @return: A None-terminated linked list of potential audio output devices. It must be freed it with L{audio_output_device_list_release}().
- @version: LibVLC 2.1.0 or later.
- '''
- return libvlc_audio_output_device_list_get(self, str_to_bytes(aout))
-
-
+
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.
@@ -1686,7 +1957,7 @@
'''
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.
@@ -1699,7 +1970,7 @@
'''
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.
@@ -1707,7 +1978,7 @@
'''
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.
@@ -1716,7 +1987,7 @@
'''
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.
@@ -1725,7 +1996,7 @@
'''
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.
@@ -1735,7 +2006,7 @@
'''
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.
@@ -1744,7 +2015,7 @@
'''
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.
@@ -1753,7 +2024,7 @@
'''
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.
@@ -1762,7 +2033,7 @@
'''
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.
@@ -1777,7 +2048,7 @@
'''
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.
@@ -1785,7 +2056,7 @@
'''
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.
@@ -1793,7 +2064,7 @@
'''
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.
@@ -1801,7 +2072,7 @@
'''
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.
@@ -1810,7 +2081,7 @@
'''
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.
@@ -1825,7 +2096,7 @@
'''
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.
@@ -1834,7 +2105,7 @@
'''
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.
@@ -1843,7 +2114,7 @@
'''
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.
@@ -1852,7 +2123,7 @@
'''
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.
@@ -1861,7 +2132,7 @@
'''
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.
@@ -1871,7 +2142,7 @@
'''
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.
@@ -1881,7 +2152,7 @@
'''
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.
@@ -1899,9 +2170,234 @@
'''
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.
+ @note: To refer to a local file with this function,
+ the file://... URI syntax B{must} be used (see IETF RFC3986).
+ We recommend using L{media_new_path}() instead when dealing with
+ local files.
+ See L{media_release}.
+ @param psz_mrl: the media location.
+ @return: the newly created media or None on error.
+ '''
+ return libvlc_media_new_location(self, str_to_bytes(psz_mrl))
+
+
+ def media_new_path(self, path):
+ '''Create a media for a certain file path.
+ See L{media_release}.
+ @param path: local filesystem path.
+ @return: the newly created media or None on error.
+ '''
+ return libvlc_media_new_path(self, str_to_bytes(path))
+
+
+ def media_new_fd(self, fd):
+ '''Create a media for an already open file descriptor.
+ The file descriptor shall be open for reading (or reading and writing).
+ Regular file descriptors, pipe read descriptors and character device
+ descriptors (including TTYs) are supported on all platforms.
+ Block device descriptors are supported where available.
+ Directory descriptors are supported on systems that provide fdopendir().
+ Sockets are supported on all platforms where they are file descriptors,
+ i.e. all except Windows.
+ @note: This library will B{not} automatically close the file descriptor
+ under any circumstance. Nevertheless, a file descriptor can usually only be
+ rendered once in a media player. To render it a second time, the file
+ descriptor should probably be rewound to the beginning with lseek().
+ See L{media_release}.
+ @param fd: open file descriptor.
+ @return: the newly created media or None on error.
+ @version: LibVLC 1.1.5 and later.
+ '''
+ 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.
+ @param read_cb: callback to read data (must not be None).
+ @param seek_cb: callback to seek, or None if seeking is not supported.
+ @param close_cb: callback to close the media, or None if unnecessary.
+ @param opaque: data pointer for the open callback.
+ @return: the newly created media or None on error @note If open_cb is None, the opaque pointer will be passed to read_cb, seek_cb and close_cb, and the stream size will be treated as unknown. @note The callbacks may be called asynchronously (from another thread). A single stream instance need not be reentrant. However the open_cb needs to be reentrant if the media is used by multiple player instances. @warning The callbacks may be used until all or any player instances that were supplied the media item are stopped. See L{media_release}.
+ @version: LibVLC 3.0.0 and later.
+ '''
+ 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}.
+ @param psz_name: the name of the node.
+ @return: the new empty media or None on error.
+ '''
+ 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
+ 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 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 audio_output_list_get(self):
+ '''Gets the list of available audio output modules.
+ @return: list of available audio outputs. It must be freed with In case of error, None is returned.
+ '''
+ 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}().
+ @note: Not all audio outputs support this. In particular, an empty (None)
+ list of devices does B{not} imply that the specified audio output does
+ not work.
+ @note: The list might not be exhaustive.
+ @warning: Some audio output devices in the list might not actually work in
+ some circumstances. By default, it is recommended to not specify any
+ explicit audio device.
+ @param aout: audio output name (as returned by L{audio_output_list_get}()).
+ @return: A None-terminated linked list of potential audio output devices. It must be freed with L{audio_output_device_list_release}().
+ @version: LibVLC 2.1.0 or later.
+ '''
+ return libvlc_audio_output_device_list_get(self, str_to_bytes(aout))
+
+class LogIterator(_Ctype):
+ '''Create a new VLC log iterator.
+
+ '''
+
+ def __new__(cls, ptr=_internal_guard):
+ '''(INTERNAL) ctypes wrapper constructor.
+ '''
+ return _Constructor(cls, ptr)
+
+ def __iter__(self):
+ return self
+
+ def next(self):
+ if self.has_next():
+ b = LogMessage()
+ i = libvlc_log_iterator_next(self, b)
+ return i.contents
+ raise StopIteration
+
+ def __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.
+ @return: always zero.
+ '''
+ return libvlc_log_iterator_has_next(self)
+
class Media(_Ctype):
'''Create a new Media instance.
-
+
Usage: Media(MRL, *options)
See vlc.Instance.media_new documentation for details.
@@ -1945,11 +2441,18 @@
"""
mediaTrack_pp = ctypes.POINTER(MediaTrack)()
n = libvlc_media_tracks_get(self, ctypes.byref(mediaTrack_pp))
- info = ctypes.cast(ctypes.mediaTrack_pp, ctypes.POINTER(ctypes.POINTER(MediaTrack) * n))
- return info
-
-
-
+ info = ctypes.cast(mediaTrack_pp, ctypes.POINTER(ctypes.POINTER(MediaTrack) * n))
+ try:
+ contents = info.contents
+ except ValueError:
+ # Media not parsed, no info.
+ return None
+ tracks = ( contents[i].contents for i in range(len(contents)) )
+ # libvlc_media_tracks_release(mediaTrack_pp, n)
+ return tracks
+
+
+
def add_option(self, psz_options):
'''Add an option to the media.
This option will be used to determine how the media_player will
@@ -1966,7 +2469,7 @@
'''
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
@@ -1982,15 +2485,15 @@
'''
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 (libvlc_media_t). Use
+ '''Retain a reference to a media descriptor object (L{Media}). Use
L{release}() to decrement the reference count of a
media descriptor object.
'''
return libvlc_media_retain(self)
-
+
def release(self):
'''Decrement the reference count of a media descriptor object. If the
reference count is 0, then L{release}() will release the
@@ -2000,35 +2503,32 @@
'''
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.
- This methods automatically calls L{parse_async}(), so after calling
- it you may receive a libvlc_MediaMetaChanged event. If you prefer a synchronous
- version ensure that you call L{parse}() before get_meta().
See L{parse}
- See L{parse_async}
+ See L{parse_with_options}
See libvlc_MediaMetaChanged.
@param e_meta: the meta to read.
@return: the media's meta.
'''
return libvlc_media_get_meta(self, e_meta)
-
+
def set_meta(self, e_meta, psz_value):
'''Set the meta of the media (this function will not save the meta, call
L{save_meta} in order to save the meta).
@@ -2037,26 +2537,24 @@
'''
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 defined in libvlc_structures.c ( libvlc_NothingSpecial=0,
- libvlc_Opening, libvlc_Buffering, libvlc_Playing, libvlc_Paused,
- libvlc_Stopped, libvlc_Ended,
- libvlc_Error).
- See libvlc_state_t.
+ '''Get current state of media descriptor object. Possible media states are
+ libvlc_NothingSpecial=0, libvlc_Opening, libvlc_Playing, libvlc_Paused,
+ libvlc_Stopped, libvlc_Ended, libvlc_Error.
+ See L{State}.
@return: state of media descriptor object.
'''
return libvlc_media_get_state(self)
-
+
def get_stats(self, p_stats):
'''Get the current statistics about the media.
@param p_stats:: structure that contain the statistics about the media (this structure must be allocated by the caller).
@@ -2064,7 +2562,7 @@
'''
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
@@ -2081,65 +2579,172 @@
'''
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.
+ This method is the extended version of L{parse_with_options}().
+ To track when this is over you can listen to libvlc_MediaParsedChanged
+ event. However if this functions returns an error, you will not receive any
+ events.
+ It uses a flag to specify parse options (see L{MediaParseFlag}). All
+ these flags can be combined. By default, media is parsed if it's a local
+ file.
+ @note: Parsing can be aborted with L{parse_stop}().
+ See libvlc_MediaParsedChanged
+ See L{get_meta}
+ See L{tracks_get}
+ See L{get_parsed_status}
+ See L{MediaParseFlag}.
+ @param parse_flag: parse options:
+ @param timeout: maximum time allowed to preparse the media. If -1, the default "preparse-timeout" option will be used as a timeout. If 0, it will wait indefinitely. If > 0, the timeout will be used (in milliseconds).
+ @return: -1 in case of error, 0 otherwise.
+ @version: LibVLC 3.0.0 or later.
+ '''
+ 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
+ be sent with the libvlc_media_parsed_status_timeout status.
+ See L{parse_with_options}.
+ @version: LibVLC 3.0.0 or later.
+ '''
+ return libvlc_media_parse_stop(self)
+
+
+ def get_parsed_status(self):
+ '''Get Parsed status for media descriptor object.
+ See libvlc_MediaParsedChanged
+ See L{MediaParsedStatus}.
+ @return: a value of the L{MediaParsedStatus} enum.
+ @version: LibVLC 3.0.0 or later.
+ '''
+ 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
+ an native object that references a L{Media} pointer.
+ @param p_new_user_data: pointer to user data.
+ '''
+ return libvlc_media_set_user_data(self, p_new_user_data)
+
+
+ def get_user_data(self):
+ '''Get media descriptor's user_data. user_data is specialized data
+ accessed by the host application, VLC.framework uses it as a pointer to
+ an native object that references a L{Media} pointer.
+ '''
+ return libvlc_media_get_user_data(self)
+
+
+ def get_type(self):
+ '''Get the media type of the media descriptor object.
+ @return: media type.
+ @version: LibVLC 3.0.0 and later. See L{MediaType}.
+ '''
+ 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
+ track (like a .srt) or an additional audio track (like a .ac3).
+ @note: This function must be called before the media is parsed (via
+ L{parse_with_options}()) or before the media is played (via
+ L{player_play}()).
+ @param i_type: subtitle or audio.
+ @param i_priority: from 0 (low priority) to 4 (high priority).
+ @param psz_uri: Uri of the slave (should contain a valid scheme).
+ @return: 0 on success, -1 on error.
+ @version: LibVLC 3.0.0 and later.
+ '''
+ 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.
+ @version: LibVLC 3.0.0 and later.
+ '''
+ 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
+ L{slaves_add}(). The typical use case of this function is to save
+ a list of slave in a database for a later use.
+ @param ppp_slaves: address to store an allocated array of slaves (must be freed with L{slaves_release}()) [OUT].
+ @return: the number of slaves (zero on error).
+ @version: LibVLC 3.0.0 and later. See L{slaves_add}.
+ '''
+ return libvlc_media_slaves_get(self, ppp_slaves)
+
+
def parse(self):
'''Parse a media.
- This fetches (local) meta data and tracks information.
+ This fetches (local) art, meta data and tracks information.
The method is synchronous.
- See L{parse_async}
+ \deprecated This function could block indefinitely.
+ Use L{parse_with_options}() instead
+ See L{parse_with_options}
See L{get_meta}
- See libvlc_media_get_tracks_info.
+ See L{get_tracks_info}.
'''
return libvlc_media_parse(self)
-
+
def parse_async(self):
'''Parse a media.
- This fetches (local) meta data and tracks information.
+ 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 libvlc_media_get_tracks_info.
+ See L{get_tracks_info}.
'''
return libvlc_media_parse_async(self)
-
+
def is_parsed(self):
- '''Get Parsed status for media descriptor object.
+ '''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 set_user_data(self, p_new_user_data):
- '''Sets media descriptor's user_data. user_data is specialized data
- accessed by the host application, VLC.framework uses it as a pointer to
- an native object that references a L{Media} pointer.
- @param p_new_user_data: pointer to user data.
- '''
- return libvlc_media_set_user_data(self, p_new_user_data)
-
-
- def get_user_data(self):
- '''Get media descriptor's user_data. user_data is specialized data
- accessed by the host application, VLC.framework uses it as a pointer to
- an native object that references a L{Media} pointer.
- '''
- return libvlc_media_get_user_data(self)
-
-
+
+ def get_tracks_info(self):
+ '''Get media descriptor's elementary streams description
+ Note, you need to call L{parse}() or play the media at least once
+ before calling this function.
+ Not doing this will result in an empty array.
+ \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.
@@ -2154,41 +2759,64 @@
'''(INTERNAL) ctypes wrapper constructor.
'''
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 localized_name(self):
- '''Get media service discover object its localized name.
- @return: localized name.
- '''
- return libvlc_media_discoverer_localized_name(self)
-
def media_list(self):
'''Get media service discover media list.
@return: list of media items.
'''
return libvlc_media_discoverer_media_list(self)
- @memoize_parameterless
- def event_manager(self):
- '''Get event manager from media service discover object.
- @return: event manager object.
- '''
- return libvlc_media_discoverer_event_manager(self)
-
def is_running(self):
'''Query if media service discover object is running.
@return: true if running, false if not \libvlc_return_bool.
'''
return libvlc_media_discoverer_is_running(self)
+
+ def localized_name(self):
+ '''Get media service discover object its localized name.
+ \deprecated Useless, use L{list_get}() to get the
+ longname of the service discovery.
+ @return: localized name or None if the media_discoverer is not started.
+ '''
+ return libvlc_media_discoverer_localized_name(self)
+
+ @memoize_parameterless
+ def event_manager(self):
+ '''Get event manager from media service discover object.
+ \deprecated Useless, media_discoverer events are only triggered when calling
+ L{start}() and L{stop}().
+ @return: event manager object.
+ '''
+ return libvlc_media_discoverer_event_manager(self)
+
class MediaLibrary(_Ctype):
'''N/A
'''
@@ -2197,7 +2825,7 @@
'''(INTERNAL) ctypes wrapper constructor.
'''
return _Constructor(cls, ptr)
-
+
def release(self):
'''Release media library object. This functions decrements the
reference count of the media library object. If it reaches 0,
@@ -2205,7 +2833,7 @@
'''
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
@@ -2213,14 +2841,14 @@
'''
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.
@@ -2229,7 +2857,7 @@
class MediaList(_Ctype):
'''Create a new MediaList instance.
-
+
Usage: MediaList(list_of_MRLs)
See vlc.Instance.media_list_new documentation for details.
@@ -2249,10 +2877,10 @@
def get_instance(self):
return getattr(self, '_instance', None)
-
+
def add_media(self, mrl):
"""Add media instance to media list.
-
+
The L{lock} should be held upon entering this function.
@param mrl: a media instance or a MRL.
@return: 0 on success, -1 if the media list is read-only.
@@ -2262,19 +2890,19 @@
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.
@@ -2283,7 +2911,7 @@
'''
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.
@@ -2292,7 +2920,7 @@
'''
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.
@@ -2302,7 +2930,7 @@
'''
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.
@@ -2311,7 +2939,7 @@
'''
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.
@@ -2322,7 +2950,7 @@
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.
@@ -2338,7 +2966,7 @@
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.
@@ -2348,20 +2976,20 @@
'''
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.
@@ -2403,7 +3031,7 @@
return self._instance #PYCHOK expected
-
+
def release(self):
'''Release a media_list_player after use
Decrement the reference count of a media player object. If the
@@ -2413,7 +3041,7 @@
'''
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.
@@ -2427,47 +3055,62 @@
'''
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.
+ @version: LibVLC 3.0.0 or later.
+ '''
+ 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: libvlc_state_t for 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.
@@ -2482,7 +3125,7 @@
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.
@@ -2490,27 +3133,27 @@
'''
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.
@@ -2529,7 +3172,7 @@
def __new__(cls, *args):
if len(args) == 1 and isinstance(args[0], _Ints):
return _Constructor(cls, args[0])
-
+
if args and isinstance(args[0], Instance):
instance = args[0]
args = args[1:]
@@ -2566,18 +3209,6 @@
"""
return track_description_list(libvlc_video_get_spu_description(self))
- def video_get_title_description(self):
- """Get the description of available titles.
- """
- return track_description_list(libvlc_video_get_title_description(self))
-
- def video_get_chapter_description(self, title):
- """Get the description of available chapters for specific title.
-
- @param title: selected title (int)
- """
- return track_description_list(libvlc_video_get_chapter_description(self, title))
-
def video_get_track_description(self):
"""Get the description of available video tracks.
"""
@@ -2595,19 +3226,31 @@
'''
titleDescription_pp = ctypes.POINTER(TitleDescription)()
n = libvlc_media_player_get_full_title_descriptions(self, ctypes.byref(titleDescription_pp))
- info = ctypes.cast(ctypes.titleDescription_pp, ctypes.POINTER(ctypes.POINTER(TitleDescription) * n))
- return info
+ info = ctypes.cast(titleDescription_pp, ctypes.POINTER(ctypes.POINTER(TitleDescription) * n))
+ try:
+ contents = info.contents
+ except ValueError:
+ # Media not parsed, no info.
+ return None
+ descr = ( contents[i].contents for i in range(len(contents)) )
+ return descr
def get_full_chapter_descriptions(self, i_chapters_of_title):
'''Get the full description of available chapters.
- @param index: of the title to query for chapters.
- @return: the chapter list
+ @param i_chapters_of_title: index of the title to query for chapters (uses current title if set to -1).
+ @return: the chapters list
@version: LibVLC 3.0.0 and later.
'''
chapterDescription_pp = ctypes.POINTER(ChapterDescription)()
n = libvlc_media_player_get_full_chapter_descriptions(self, ctypes.byref(chapterDescription_pp))
- info = ctypes.cast(ctypes.chapterDescription_pp, ctypes.POINTER(ctypes.POINTER(ChapterDescription) * n))
- return info
+ info = ctypes.cast(chapterDescription_pp, ctypes.POINTER(ctypes.POINTER(ChapterDescription) * n))
+ try:
+ contents = info.contents
+ except ValueError:
+ # Media not parsed, no info.
+ return None
+ descr = ( contents[i].contents for i in range(len(contents)) )
+ return descr
def video_get_size(self, num=0):
"""Get the video size in pixels as 2-tuple (width, height).
@@ -2626,13 +3269,13 @@
Specify where the media player should render its video
output. If LibVLC was built without Win32/Win64 API output
support, then this has no effects.
-
+
@param drawable: windows handle of the drawable.
"""
if not isinstance(drawable, ctypes.c_void_p):
drawable = ctypes.c_void_p(int(drawable))
libvlc_media_player_set_hwnd(self, drawable)
-
+
def video_get_width(self, num=0):
"""Get the width of a video in pixels.
@@ -2672,7 +3315,61 @@
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
+ 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{media_tracks_get}() instead.
+ @return: frames per second (fps) for this playing movie, or 0 if unspecified.
+ '''
+ 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.
+ @return: list containing description of available chapter for title i_title. It must be freed with L{track_description_list_release}().
+ '''
+ 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.
+ @param psz_subtitle: new video subtitle file.
+ @return: the success status (boolean).
+ '''
+ 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
@@ -2682,14 +3379,14 @@
'''
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.
@@ -2697,7 +3394,7 @@
'''
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.
@@ -2711,21 +3408,21 @@
'''
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.
@@ -2733,24 +3430,56 @@
'''
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
+ take effect.
+ See L{renderer_discoverer_new}.
+ @param p_item: an item discovered by L{renderer_discoverer_start}().
+ @return: 0 on success, -1 on error.
+ @version: LibVLC 3.0.0 or later.
+ '''
+ 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.
Use L{video_set_format}() or L{video_set_format_callbacks}()
to configure the decoded format.
+ @warning: Rendering video into custom memory buffers is considerably less
+ efficient than rendering in a custom window as normal.
+ For optimal perfomances, VLC media player renders into a custom window, and
+ does not use this function and associated callbacks. It is B{highly
+ recommended} that other LibVLC-based application do likewise.
+ To embed video in a window, use libvlc_media_player_set_xid() or equivalent
+ depending on the operating system.
+ If window embedding does not fit the application use case, then a custom
+ LibVLC video output display plugin is required to maintain optimal video
+ rendering performances.
+ The following limitations affect performance:
+ - Hardware video decoding acceleration will either be disabled completely,
+ or require (relatively slow) copy from video/DSP memory to main memory.
+ - Sub-pictures (subtitles, on-screen display, etc.) must be blent into the
+ main picture by the CPU instead of the GPU.
+ - Depending on the video format, pixel format conversion, picture scaling,
+ cropping and/or picture re-orientation, must be performed by the CPU
+ instead of the GPU.
+ - Memory copying is required between LibVLC reference picture buffers and
+ application buffers (between lock and unlock callbacks).
@param lock: callback to lock video memory (must not be None).
@param unlock: callback to unlock video memory (or None if not needed).
@param display: callback to display video (or None if not needed).
@@ -2759,7 +3488,7 @@
'''
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}(),
@@ -2773,7 +3502,7 @@
'''
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}().
@@ -2783,22 +3512,22 @@
'''
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".
The drawable is an NSObject that follow the VLCOpenGLVideoViewEmbedding
protocol:
- @begincode
+ @code.m
\@protocol VLCOpenGLVideoViewEmbedding <NSObject>
- (void)addVoutSubview:(NSView *)view;
- (void)removeVoutSubview:(NSView *)view;
\@end
@endcode
Or it can be an NSView object.
- If you want to use it along with Qt4 see the QMacCocoaViewContainer. Then
+ If you want to use it along with Qt see the QMacCocoaViewContainer. Then
the following code should work:
- @begincode
+ @code.mm
NSView *video = [[NSView alloc] init];
QMacCocoaViewContainer *container = new QMacCocoaViewContainer(video, parent);
@@ -2811,42 +3540,37 @@
'''
return libvlc_media_player_set_nsobject(self, drawable)
-
+
def get_nsobject(self):
'''Get the NSView handler previously set with L{set_nsobject}().
@return: the NSView handler or 0 if none where set.
'''
return libvlc_media_player_get_nsobject(self)
-
- def set_agl(self, drawable):
- '''Set the agl handler where the media player should render its video output.
- @param drawable: the agl handler.
- '''
- return libvlc_media_player_set_agl(self, drawable)
-
-
- def get_agl(self):
- '''Get the agl handler previously set with L{set_agl}().
- @return: the agl handler or 0 if none where set.
- '''
- return libvlc_media_player_get_agl(self)
-
-
+
def set_xwindow(self, drawable):
'''Set an X Window System drawable where the media player should render its
- video output. If LibVLC was built without X11 output support, then this has
- no effects.
- The specified identifier must correspond to an existing Input/Output class
- X11 window. Pixmaps are B{not} supported. The caller shall ensure that
- the X11 server is the same as the one the VLC instance has been configured
- with. This function must be called before video playback is started;
- otherwise it will only take effect after playback stop and restart.
- @param drawable: the ID of the X window.
+ video output. The call takes effect when the playback starts. If it is
+ already started, it might need to be stopped before changes apply.
+ If LibVLC was built without X11 output support, then this function has no
+ effects.
+ By default, LibVLC will capture input events on the video rendering area.
+ Use L{video_set_mouse_input}() and L{video_set_key_input}() to
+ disable that and deliver events to the parent window / to the application
+ instead. By design, the X11 protocol delivers input events to only one
+ recipient.
+ @warning
+ The application must call the XInitThreads() function from Xlib before
+ L{new}(), and before any call to XOpenDisplay() directly or via any
+ other library. Failure to call XInitThreads() will seriously impede LibVLC
+ performance. Calling XOpenDisplay() before XInitThreads() will eventually
+ crash the process. That is a limitation of Xlib.
+ @param drawable: X11 window ID @note The specified identifier must correspond to an existing Input/Output class X11 window. Pixmaps are B{not} currently supported. The default X11 server is assumed, i.e. that specified in the DISPLAY environment variable. @warning LibVLC can deal with invalid X11 handle errors, however some display drivers (EGL, GLX, VA and/or VDPAU) can unfortunately not. Thus the window handle must remain valid until playback is stopped, otherwise the process may abort or crash.
+ @bug No more than one window handle per media player instance can be specified. If the media has multiple simultaneously active video tracks, extra tracks will be rendered into external windows beyond the control of the application.
'''
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
@@ -2856,7 +3580,7 @@
'''
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
@@ -2865,11 +3589,30 @@
'''
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.
+ @version: LibVLC 3.0.0 and later.
+ '''
+ 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).
+ @return: -1 if an error was detected, 0 otherwise.
+ @version: LibVLC 3.0.0 and later.
+ '''
+ return libvlc_media_player_set_evas_object(self, p_evas_object)
+
+
def audio_set_callbacks(self, play, pause, resume, flush, drain, opaque):
- '''Set callbacks and private data for decoded audio.
+ '''Sets callbacks and private data for decoded audio.
Use L{audio_set_format}() or L{audio_set_format_callbacks}()
to configure the decoded audio format.
+ @note: The audio callbacks override any other audio output mechanism.
+ If the callbacks are set, LibVLC will B{not} output audio in any way.
@param play: callback to play audio samples (must not be None).
@param pause: callback to pause playback (or None to ignore).
@param resume: callback to resume playback (or None to ignore).
@@ -2880,7 +3623,7 @@
'''
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}().
@@ -2891,19 +3634,19 @@
'''
return libvlc_audio_set_volume_callback(self, set_volume)
-
+
def audio_set_format_callbacks(self, setup, cleanup):
- '''Set decoded audio format. This only works in combination with
- L{audio_set_callbacks}().
+ '''Sets decoded audio format via callbacks.
+ This only works in combination with L{audio_set_callbacks}().
@param setup: callback to select the audio format (cannot be None).
@param cleanup: callback to release any allocated resources (or None).
@version: LibVLC 2.0.0 or later.
'''
return libvlc_audio_set_format_callbacks(self, setup, cleanup)
-
+
def audio_set_format(self, format, rate, channels):
- '''Set decoded audio format.
+ '''Sets a fixed decoded audio format.
This only works in combination with L{audio_set_callbacks}(),
and is mutually exclusive with L{audio_set_format_callbacks}().
@param format: a four-characters string identifying the sample format (e.g. "S16N" or "FL32").
@@ -2913,21 +3656,21 @@
'''
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.
@@ -2935,14 +3678,14 @@
'''
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.
@@ -2951,35 +3694,35 @@
'''
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.
@@ -2987,40 +3730,40 @@
'''
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
@@ -3029,7 +3772,7 @@
'''
return libvlc_media_player_get_rate(self)
-
+
def set_rate(self, rate):
'''Set movie play rate.
@param rate: movie play rate to set.
@@ -3037,42 +3780,35 @@
'''
return libvlc_media_player_set_rate(self, rate)
-
+
def get_state(self):
'''Get current movie state.
- @return: the current state of the media player (playing, paused, ...) See libvlc_state_t.
+ @return: the current state of the media player (playing, paused, ...) See L{State}.
'''
return libvlc_media_player_get_state(self)
-
- def get_fps(self):
- '''Get movie fps rate.
- @return: frames per second (fps) for this playing movie, or 0 if unspecified.
- '''
- return libvlc_media_player_get_fps(self)
-
def has_vout(self):
'''How many video outputs does this media player have?
@return: the number of video outputs.
'''
return libvlc_media_player_has_vout(self)
-
+
def is_seekable(self):
'''Is this media player seekable?
@return: true if the media player can seek \libvlc_return_bool.
'''
return libvlc_media_player_is_seekable(self)
-
+
def can_pause(self):
'''Can this media player be paused?
@return: true if the media player can pause \libvlc_return_bool.
'''
return libvlc_media_player_can_pause(self)
-
+
def program_scrambled(self):
'''Check if the current program is scrambled.
@return: true if the current program is scrambled \libvlc_return_bool.
@@ -3080,13 +3816,13 @@
'''
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.
@@ -3094,7 +3830,7 @@
'''
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.
@@ -3103,7 +3839,20 @@
'''
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
+ will also update the slave list of the attached L{Media}.
+ @param i_type: subtitle or audio.
+ @param psz_uri: Uri of the slave (should contain a valid scheme).
+ @param b_select: True if this slave should be selected when it's loaded.
+ @return: 0 on success, -1 on error.
+ @version: LibVLC 3.0.0 and later. See L{media_slaves_add}.
+ '''
+ 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
@@ -3111,7 +3860,7 @@
'''
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
@@ -3124,14 +3873,14 @@
'''
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
@@ -3145,7 +3894,7 @@
'''
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
@@ -3156,7 +3905,7 @@
'''
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}().
@@ -3164,7 +3913,7 @@
'''
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
@@ -3175,35 +3924,46 @@
'''
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.
+ @param p_viewpoint: video viewpoint allocated via L{video_new_viewpoint}().
+ @param b_absolute: if true replace the old viewpoint with the new one. If false, increase/decrease it.
+ @return: -1 in case of error, 0 otherwise @note the values are set asynchronously, it will be used by the next frame displayed.
+ @version: LibVLC 3.0.0 and later.
+ '''
+ 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).
@@ -3211,15 +3971,7 @@
'''
return libvlc_video_set_spu(self, i_spu)
-
- def video_set_subtitle_file(self, psz_subtitle):
- '''Set new video subtitle file.
- @param psz_subtitle: new video subtitle file.
- @return: the success status (boolean).
- '''
- return libvlc_video_set_subtitle_file(self, str_to_bytes(psz_subtitle))
-
def video_get_spu_delay(self):
'''Get the current subtitle delay. Positive values means subtitles are being
displayed later, negative values earlier.
@@ -3228,7 +3980,7 @@
'''
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,
@@ -3240,55 +3992,52 @@
'''
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.
+ '''Get current teletext page requested or 0 if it's disabled.
+ Teletext is disabled by default, call L{video_set_teletext}() to enable
+ it.
@return: the current teletext page requested.
'''
return libvlc_video_get_teletext(self)
-
+
def video_set_teletext(self, i_page):
'''Set new teletext page to retrieve.
- @param i_page: teletex page number requested.
+ This function can also be used to send a teletext key.
+ @param i_page: teletex page number requested. This value can be 0 to disable teletext, a number in the range ]0;1000[ to show the requested page, or a \ref L{TeletextKey}. 100 is the default teletext page.
'''
return libvlc_video_set_teletext(self, i_page)
-
- def toggle_teletext(self):
- '''Toggle teletext transparent status on video output.
- '''
- return libvlc_toggle_teletext(self)
-
def video_get_track_count(self):
'''Get number of available video tracks.
@return: the number of available video tracks (int).
'''
return libvlc_video_get_track_count(self)
-
+
def video_get_track(self):
'''Get current video track.
@return: the video track 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).
@@ -3296,41 +4045,41 @@
'''
return libvlc_video_set_track(self, i_track)
-
+
def video_take_snapshot(self, num, psz_filepath, i_width, i_height):
'''Take a snapshot of the current video window.
If i_width AND i_height is 0, original size is used.
If i_width XOR i_height is 0, original aspect-ratio is preserved.
@param num: number of video output (typically 0 for the first/only one).
- @param psz_filepath: the path where to save the screenshot to.
+ @param psz_filepath: the path of a file or a folder to save the screenshot into.
@param i_width: the snapshot's width.
@param i_height: the snapshot's height.
@return: 0 on success, -1 if the video was not found.
'''
return libvlc_video_take_snapshot(self, num, 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)
@@ -3340,7 +4089,7 @@
'''
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.
@@ -3348,82 +4097,82 @@
'''
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 libvlc_video_logo_option_t.
+ @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.
Passing libvlc_logo_enable as option value has the side effect of
starting (arg !0) or stopping (arg 0) the logo filter.
- @param option: logo option to set, values of libvlc_video_logo_option_t.
+ @param option: logo option to set, values of L{VideoLogoOption}.
@param value: logo option value.
'''
return libvlc_video_set_logo_int(self, option, value)
-
+
def video_set_logo_string(self, option, psz_value):
'''Set logo option as string. Options that take a different type value
are ignored.
- @param option: logo option to set, values of libvlc_video_logo_option_t.
+ @param option: logo option to set, values of L{VideoLogoOption}.
@param psz_value: logo option value.
'''
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 libvlc_video_adjust_option_t.
+ @param option: adjust option to get, values of L{VideoAdjustOption}.
@version: LibVLC 1.1.1 and later.
'''
return libvlc_video_get_adjust_int(self, option)
-
+
def video_set_adjust_int(self, option, value):
'''Set adjust option as integer. Options that take a different type value
are ignored.
Passing libvlc_adjust_enable as option value has the side effect of
starting (arg !0) or stopping (arg 0) the adjust filter.
- @param option: adust option to set, values of libvlc_video_adjust_option_t.
+ @param option: adust option to set, values of L{VideoAdjustOption}.
@param value: adjust option value.
@version: LibVLC 1.1.1 and later.
'''
return libvlc_video_set_adjust_int(self, option, value)
-
+
def video_get_adjust_float(self, option):
'''Get float adjust option.
- @param option: adjust option to get, values of libvlc_video_adjust_option_t.
+ @param option: adjust option to get, values of L{VideoAdjustOption}.
@version: LibVLC 1.1.1 and later.
'''
return libvlc_video_get_adjust_float(self, option)
-
+
def video_set_adjust_float(self, option, value):
'''Set adjust option as float. Options that take a different type value
are ignored.
- @param option: adust option to set, values of libvlc_video_adjust_option_t.
+ @param option: adust option to set, values of L{VideoAdjustOption}.
@param value: adjust option value.
@version: LibVLC 1.1.1 and later.
'''
return libvlc_video_set_adjust_float(self, option, value)
-
+
def audio_output_set(self, psz_name):
'''Selects an audio output module.
@note: Any change will take be effect only after playback is stopped and
restarted. Audio output cannot be changed while playing.
@param psz_name: name of audio output, use psz_name of See L{AudioOutput}.
- @return: 0 if function succeded, -1 on error.
+ @return: 0 if function succeeded, -1 on error.
'''
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}().
@@ -3433,12 +4182,12 @@
@warning: Some audio output devices in the list might not actually work in
some circumstances. By default, it is recommended to not specify any
explicit audio device.
- @return: A None-terminated linked list of potential audio output devices. It must be freed it with L{audio_output_device_list_release}().
+ @return: A None-terminated linked list of potential audio output devices. It must be freed with L{audio_output_device_list_release}().
@version: LibVLC 2.2.0 or later.
'''
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
@@ -3466,34 +4215,52 @@
'''
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}().
+ @warning: The initial value for the current audio output device identifier
+ may not be set or may be some unknown value. A LibVLC application should
+ compare this value against the known device identifiers (e.g. those that
+ were previously retrieved by a call to L{audio_output_device_enum} or
+ L{audio_output_device_list_get}) to find the current audio output device.
+ It is possible that the selected audio output device changes (an external
+ change) without a call to L{audio_output_device_set}. That may make this
+ method unsuitable to use if a LibVLC application is attempting to track
+ dynamic audio device changes as they happen.
+ @return: the current audio output device identifier None if no device is selected or in case of error (the result must be released with free() or L{free}()).
+ @version: LibVLC 3.0.0 or later.
+ '''
+ 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).
@@ -3501,21 +4268,21 @@
'''
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).
@@ -3523,22 +4290,22 @@
'''
return libvlc_audio_set_track(self, i_track)
-
+
def audio_get_channel(self):
'''Get current audio channel.
- @return: the audio channel See libvlc_audio_output_channel_t.
+ @return: 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 libvlc_audio_output_channel_t.
+ @param channel: the audio channel, See L{AudioOutputChannel}.
@return: 0 on success, -1 on error.
'''
return libvlc_audio_set_channel(self, channel)
-
+
def audio_get_delay(self):
'''Get current audio delay.
@return: the audio delay (microseconds).
@@ -3546,7 +4313,7 @@
'''
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).
@@ -3555,7 +4322,7 @@
'''
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
@@ -3579,20 +4346,24 @@
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).
+ @version: LibVLC 3.0.0 and later.
+ '''
+ 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).
+ @return: 0 on success, -1 on error.
+ '''
+ return libvlc_media_player_set_role(self, role)
+
+
# LibVLC __version__ functions #
-def libvlc_errmsg():
- '''A human-readable error message for the last LibVLC error in the calling
- thread. The resulting string is valid until another error occurs (at least
- until the next LibVLC call).
- @warning
- This will be None if there was no error.
- '''
- f = _Cfunctions.get('libvlc_errmsg', None) or \
- _Cfunction('libvlc_errmsg', (), None,
- ctypes.c_char_p)
- return f()
-
def libvlc_clearerr():
'''Clears the LibVLC error status for the current thread. This is optional.
By default, the error status is automatically overridden when a new error
@@ -3619,6 +4390,34 @@
'''Create and initialize a libvlc instance.
This functions accept a list of "command line" arguments similar to the
main(). These arguments affect the LibVLC instance default configuration.
+ @note
+ LibVLC may create threads. Therefore, any thread-unsafe process
+ initialization must be performed before calling L{libvlc_new}(). In particular
+ and where applicable:
+ - setlocale() and textdomain(),
+ - setenv(), unsetenv() and putenv(),
+ - with the X11 display system, XInitThreads()
+ (see also L{libvlc_media_player_set_xwindow}()) and
+ - on Microsoft Windows, SetErrorMode().
+ - sigprocmask() shall never be invoked; pthread_sigmask() can be used.
+ On POSIX systems, the SIGCHLD signal B{must not} be ignored, i.e. the
+ signal handler must set to SIG_DFL or a function pointer, not SIG_IGN.
+ Also while LibVLC is active, the wait() function shall not be called, and
+ any call to waitpid() shall use a strictly positive value for the first
+ parameter (i.e. the PID). Failure to follow those rules may lead to a
+ deadlock or a busy loop.
+ Also on POSIX systems, it is recommended that the SIGPIPE signal be blocked,
+ even if it is not, in principles, necessary, e.g.:
+ @code
+ @endcode
+ On Microsoft Windows Vista/2008, the process error mode
+ SEM_FAILCRITICALERRORS flag B{must} be set before using LibVLC.
+ On later versions, that is optional and unnecessary.
+ Also on Microsoft Windows (Vista and any later version), setting the default
+ DLL directories to SYSTEM32 exclusively is strongly recommended for
+ security reasons:
+ @code
+ @endcode.
@param argc: the number of arguments (should be 0).
@param argv: list of arguments (should be None).
@return: the libvlc instance or None in case of error.
@@ -3763,8 +4562,11 @@
return f(event_type)
def libvlc_log_get_context(ctx):
- '''Gets debugging information about a log message: the name of the VLC module
- emitting the message and the message location within the source code.
+ '''Gets log message debug infos.
+ This function retrieves self-debug information about a log message:
+ - the name of the VLC module emitting the message,
+ - the name of the source code module (i.e. file) and
+ - 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).
@@ -3777,10 +4579,12 @@
return f(ctx)
def libvlc_log_get_object(ctx, id):
- '''Gets VLC object information about a log message: the type name of the VLC
- object emitting the message, the object header if any and a temporaly-unique
- object identifier. This information is mainly meant for B{manual}
- troubleshooting.
+ '''Gets log message info.
+ This function retrieves meta-information about a log message:
+ - the type name of the VLC object emitting the message,
+ - the object header if any, and
+ - a temporaly-unique object identifier.
+ This information is mainly meant for B{manual} troubleshooting.
The returned type name may be "generic" if unknown, but it cannot be None.
The returned header will be None if unset; in current versions, the header
is used to distinguish for VLM inputs.
@@ -3796,10 +4600,12 @@
return f(ctx, id)
def libvlc_log_unset(p_instance):
- '''Unsets the logging callback for a LibVLC instance. This is rarely needed:
- the callback is implicitly unset when the instance is destroyed.
- This function will wait for any pending callbacks invocation to complete
- (causing a deadlock if called from within the callback).
+ '''Unsets the logging callback.
+ This function deregisters the logging callback for a LibVLC instance.
+ This is rarely needed as the callback is implicitly unset when the instance
+ is destroyed.
+ @note: This function will wait for any pending callbacks invocation to
+ complete (causing a deadlock if called from within the callback).
@param p_instance: libvlc instance.
@version: LibVLC 2.1.0 or later.
'''
@@ -3808,7 +4614,7 @@
None, Instance)
return f(p_instance)
-def libvlc_log_set(cb, data, 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
invocation to complete.
@@ -3820,7 +4626,7 @@
f = _Cfunctions.get('libvlc_log_set', None) or \
_Cfunction('libvlc_log_set', ((1,), (1,), (1,),), None,
None, Instance, LogCb, ctypes.c_void_p)
- return f(cb, data, p_instance)
+ return f(p_instance, cb, data)
def libvlc_log_set_file(p_instance, stream):
'''Sets up logging to a file.
@@ -3875,6 +4681,522 @@
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.
+ @version: LibVLC 3.0.0 and later.
+ '''
+ 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)
+ 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)
+ 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.
+ @param p_id: id of the dialog.
+ @param psz_username: valid and non empty string.
+ @param psz_password: valid string (can be empty).
+ @param b_store: if true, store the credentials.
+ @return: 0 on success, or -1 on error.
+ @version: LibVLC 3.0.0 and later.
+ '''
+ 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)
+ 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.
+ @param p_id: id of the dialog.
+ @param i_action: 1 for action1, 2 for action2.
+ @return: 0 on success, or -1 on error.
+ @version: LibVLC 3.0.0 and later.
+ '''
+ 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)
+ 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.
+ @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)
+ 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,
for instance a valid URL.
@@ -3928,6 +5250,22 @@
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.
+ @param open_cb: callback to open the custom bitstream input media.
+ @param read_cb: callback to read data (must not be None).
+ @param seek_cb: callback to seek, or None if seeking is not supported.
+ @param close_cb: callback to close the media, or None if unnecessary.
+ @param opaque: data pointer for the open callback.
+ @return: the newly created media or None on error @note If open_cb is None, the opaque pointer will be passed to read_cb, seek_cb and close_cb, and the stream size will be treated as unknown. @note The callbacks may be called asynchronously (from another thread). A single stream instance need not be reentrant. However the open_cb needs to be reentrant if the media is used by multiple player instances. @warning The callbacks may be used until all or any player instances that were supplied the media item are stopped. See L{libvlc_media_release}.
+ @version: LibVLC 3.0.0 and later.
+ '''
+ 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)
+ 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}.
@@ -3980,7 +5318,7 @@
return f(p_md, psz_options, i_flags)
def libvlc_media_retain(p_md):
- '''Retain a reference to a media descriptor object (libvlc_media_t). Use
+ '''Retain a reference to a media descriptor object (L{Media}). Use
L{libvlc_media_release}() to decrement the reference count of a
media descriptor object.
@param p_md: the media descriptor.
@@ -4025,11 +5363,8 @@
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.
- This methods automatically calls L{libvlc_media_parse_async}(), so after calling
- it you may receive a libvlc_MediaMetaChanged event. If you prefer a synchronous
- version ensure that you call L{libvlc_media_parse}() before get_meta().
See L{libvlc_media_parse}
- See L{libvlc_media_parse_async}
+ See L{libvlc_media_parse_with_options}
See libvlc_MediaMetaChanged.
@param p_md: the media descriptor.
@param e_meta: the meta to read.
@@ -4063,12 +5398,10 @@
return f(p_md)
def libvlc_media_get_state(p_md):
- '''Get current state of media descriptor object. Possible media states
- are defined in libvlc_structures.c ( libvlc_NothingSpecial=0,
- libvlc_Opening, libvlc_Buffering, libvlc_Playing, libvlc_Paused,
- libvlc_Stopped, libvlc_Ended,
- libvlc_Error).
- See libvlc_state_t.
+ '''Get current state of media descriptor object. Possible media states are
+ libvlc_NothingSpecial=0, libvlc_Opening, libvlc_Playing, libvlc_Paused,
+ libvlc_Stopped, libvlc_Ended, libvlc_Error.
+ See L{State}.
@param p_md: a media descriptor object.
@return: state of media descriptor object.
'''
@@ -4121,47 +5454,57 @@
ctypes.c_longlong, Media)
return f(p_md)
-def libvlc_media_parse(p_md):
- '''Parse a media.
- This fetches (local) meta data and tracks information.
- The method is synchronous.
- See L{libvlc_media_parse_async}
- See L{libvlc_media_get_meta}
- See 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) meta data and tracks information.
- The method is the asynchronous of L{libvlc_media_parse}().
+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.
+ This method is the extended version of L{libvlc_media_parse_with_options}().
To track when this is over you can listen to libvlc_MediaParsedChanged
- event. However if the media was already parsed you will not receive this
- event.
- See L{libvlc_media_parse}
+ event. However if this functions returns an error, you will not receive any
+ events.
+ It uses a flag to specify parse options (see L{MediaParseFlag}). All
+ these flags can be combined. By default, media is parsed if it's a local
+ file.
+ @note: Parsing can be aborted with L{libvlc_media_parse_stop}().
See libvlc_MediaParsedChanged
See L{libvlc_media_get_meta}
- See 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,
+ See L{libvlc_media_tracks_get}
+ See L{libvlc_media_get_parsed_status}
+ See L{MediaParseFlag}.
+ @param p_md: media descriptor object.
+ @param parse_flag: parse options:
+ @param timeout: maximum time allowed to preparse the media. If -1, the default "preparse-timeout" option will be used as a timeout. If 0, it will wait indefinitely. If > 0, the timeout will be used (in milliseconds).
+ @return: -1 in case of error, 0 otherwise.
+ @version: LibVLC 3.0.0 or later.
+ '''
+ 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)
+ 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
+ be sent with the libvlc_media_parsed_status_timeout status.
+ See L{libvlc_media_parse_with_options}.
+ @param p_md: media descriptor object.
+ @version: LibVLC 3.0.0 or later.
+ '''
+ f = _Cfunctions.get('libvlc_media_parse_stop', None) or \
+ _Cfunction('libvlc_media_parse_stop', ((1,),), None,
None, Media)
return f(p_md)
-def libvlc_media_is_parsed(p_md):
+def libvlc_media_get_parsed_status(p_md):
'''Get Parsed status for media descriptor object.
- See libvlc_MediaParsedChanged.
+ See libvlc_MediaParsedChanged
+ See L{MediaParsedStatus}.
@param p_md: media descriptor object.
- @return: true if media object has been parsed otherwise it returns false \libvlc_return_bool.
+ @return: a value of the L{MediaParsedStatus} enum.
+ @version: LibVLC 3.0.0 or later.
'''
- f = _Cfunctions.get('libvlc_media_is_parsed', None) or \
- _Cfunction('libvlc_media_is_parsed', ((1,),), None,
- ctypes.c_int, Media)
+ f = _Cfunctions.get('libvlc_media_get_parsed_status', None) or \
+ _Cfunction('libvlc_media_get_parsed_status', ((1,),), None,
+ MediaParsedStatus, Media)
return f(p_md)
def libvlc_media_set_user_data(p_md, p_new_user_data):
@@ -4202,6 +5545,18 @@
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}.
+ @param i_codec: i_codec or i_original_fourcc from L{MediaTrack}.
+ @return: codec description.
+ @version: LibVLC 3.0.0 and later. See L{MediaTrack}.
+ '''
+ 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)
+ 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.
@@ -4213,118 +5568,232 @@
None, ctypes.POINTER(MediaTrack), ctypes.c_uint)
return f(p_tracks, i_count)
-def libvlc_media_discoverer_new_from_name(p_inst, psz_name):
- '''Discover media service by name.
+def libvlc_media_get_type(p_md):
+ '''Get the media type of the media descriptor object.
+ @param p_md: media descriptor object.
+ @return: media type.
+ @version: LibVLC 3.0.0 and later. See L{MediaType}.
+ '''
+ f = _Cfunctions.get('libvlc_media_get_type', None) or \
+ _Cfunction('libvlc_media_get_type', ((1,),), None,
+ 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
+ track (like a .srt) or an additional audio track (like a .ac3).
+ @note: This function must be called before the media is parsed (via
+ L{libvlc_media_parse_with_options}()) or before the media is played (via
+ L{libvlc_media_player_play}()).
+ @param p_md: media descriptor object.
+ @param i_type: subtitle or audio.
+ @param i_priority: from 0 (low priority) to 4 (high priority).
+ @param psz_uri: Uri of the slave (should contain a valid scheme).
+ @return: 0 on success, -1 on error.
+ @version: LibVLC 3.0.0 and later.
+ '''
+ 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)
+ 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.
+ @param p_md: media descriptor object.
+ @version: LibVLC 3.0.0 and later.
+ '''
+ f = _Cfunctions.get('libvlc_media_slaves_clear', None) or \
+ _Cfunction('libvlc_media_slaves_clear', ((1,),), None,
+ 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
+ L{libvlc_media_slaves_add}(). The typical use case of this function is to save
+ a list of slave in a database for a later use.
+ @param p_md: media descriptor object.
+ @param ppp_slaves: address to store an allocated array of slaves (must be freed with L{libvlc_media_slaves_release}()) [OUT].
+ @return: the number of slaves (zero on error).
+ @version: LibVLC 3.0.0 and later. See L{libvlc_media_slaves_add}.
+ '''
+ 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)))
+ 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.
+ @param i_count: number of elements in the array.
+ @version: LibVLC 3.0.0 and later.
+ '''
+ f = _Cfunctions.get('libvlc_media_slaves_release', None) or \
+ _Cfunction('libvlc_media_slaves_release', ((1,), (1,),), None,
+ None, ctypes.POINTER(MediaSlave), ctypes.c_int)
+ 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,),), None,
+ ctypes.c_void_p, ctypes.c_void_p)
+ 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, ctypes.c_void_p)
+ 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, ctypes.c_void_p)
+ 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, ctypes.c_void_p)
+ 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, ctypes.c_void_p)
+ 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, ctypes.c_void_p)
+ 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.
+ @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_media_discoverer_new_from_name', None) or \
- _Cfunction('libvlc_media_discoverer_new_from_name', ((1,), (1,),), class_result(MediaDiscoverer),
+ f = _Cfunctions.get('libvlc_renderer_discoverer_new', None) or \
+ _Cfunction('libvlc_renderer_discoverer_new', ((1,), (1,),), None,
ctypes.c_void_p, Instance, ctypes.c_char_p)
return f(p_inst, psz_name)
-def libvlc_media_discoverer_release(p_mdis):
- '''Release media discover object. If the reference count reaches 0, then
- the object will be released.
- @param p_mdis: media service discover object.
- '''
- f = _Cfunctions.get('libvlc_media_discoverer_release', None) or \
- _Cfunction('libvlc_media_discoverer_release', ((1,),), None,
- None, MediaDiscoverer)
- return f(p_mdis)
-
-def libvlc_media_discoverer_localized_name(p_mdis):
- '''Get media service discover object its localized name.
- @param p_mdis: media discover object.
- @return: localized name.
- '''
- f = _Cfunctions.get('libvlc_media_discoverer_localized_name', None) or \
- _Cfunction('libvlc_media_discoverer_localized_name', ((1,),), string_result,
- ctypes.c_void_p, MediaDiscoverer)
- 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_event_manager(p_mdis):
- '''Get event manager from media service discover object.
- @param p_mdis: media service discover object.
- @return: event manager object.
- '''
- f = _Cfunctions.get('libvlc_media_discoverer_event_manager', None) or \
- _Cfunction('libvlc_media_discoverer_event_manager', ((1,),), class_result(EventManager),
- ctypes.c_void_p, MediaDiscoverer)
- 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_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_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, ctypes.c_void_p)
+ 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, ctypes.c_void_p)
+ 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, ctypes.c_void_p)
+ 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 libvlc_renderer_item_t 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.
+ '''
+ f = _Cfunctions.get('libvlc_renderer_discoverer_event_manager', None) or \
+ _Cfunction('libvlc_renderer_discoverer_event_manager', ((1,),), class_result(EventManager),
+ ctypes.c_void_p, ctypes.c_void_p)
+ 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(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(RDDescription), ctypes.c_size_t)
+ return f(pp_services, i_count)
def libvlc_media_list_new(p_instance):
'''Create an empty media list.
@@ -4491,167 +5960,365 @@
ctypes.c_void_p, MediaList)
return f(p_ml)
-def libvlc_media_list_player_new(p_instance):
- '''Create new media_list_player.
+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.
@param p_instance: libvlc instance.
- @return: media list player instance or None on error.
+ @return: an unique pointer 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)
+ f = _Cfunctions.get('libvlc_log_open', None) or \
+ _Cfunction('libvlc_log_open', ((1,),), None,
+ Log_ptr, 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_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_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: libvlc_state_t for media list player.
- '''
- f = _Cfunctions.get('libvlc_media_list_player_get_state', None) or \
- _Cfunction('libvlc_media_list_player_get_state', ((1,),), None,
- State, MediaListPlayer)
- 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_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_media_player_new(p_libvlc_instance):
'''Create an empty Media Player object.
@@ -4776,11 +6443,46 @@
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
+ take effect.
+ See L{libvlc_renderer_discoverer_new}.
+ @param p_mi: the Media Player.
+ @param p_item: an item discovered by L{libvlc_renderer_discoverer_start}().
+ @return: 0 on success, -1 on error.
+ @version: LibVLC 3.0.0 or later.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_set_renderer', None) or \
+ _Cfunction('libvlc_media_player_set_renderer', ((1,), (1,),), None,
+ ctypes.c_int, MediaPlayer, ctypes.c_void_p)
+ 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.
Use L{libvlc_video_set_format}() or L{libvlc_video_set_format_callbacks}()
to configure the decoded format.
+ @warning: Rendering video into custom memory buffers is considerably less
+ efficient than rendering in a custom window as normal.
+ For optimal perfomances, VLC media player renders into a custom window, and
+ does not use this function and associated callbacks. It is B{highly
+ recommended} that other LibVLC-based application do likewise.
+ To embed video in a window, use libvlc_media_player_set_xid() or equivalent
+ depending on the operating system.
+ If window embedding does not fit the application use case, then a custom
+ LibVLC video output display plugin is required to maintain optimal video
+ rendering performances.
+ The following limitations affect performance:
+ - Hardware video decoding acceleration will either be disabled completely,
+ or require (relatively slow) copy from video/DSP memory to main memory.
+ - Sub-pictures (subtitles, on-screen display, etc.) must be blent into the
+ main picture by the CPU instead of the GPU.
+ - Depending on the video format, pixel format conversion, picture scaling,
+ cropping and/or picture re-orientation, must be performed by the CPU
+ instead of the GPU.
+ - Memory copying is required between LibVLC reference picture buffers and
+ application buffers (between lock and unlock callbacks).
@param mp: the media player.
@param lock: callback to lock video memory (must not be None).
@param unlock: callback to unlock video memory (or None if not needed).
@@ -4828,16 +6530,16 @@
Use the vout called "macosx".
The drawable is an NSObject that follow the VLCOpenGLVideoViewEmbedding
protocol:
- @begincode
+ @code.m
\@protocol VLCOpenGLVideoViewEmbedding <NSObject>
- (void)addVoutSubview:(NSView *)view;
- (void)removeVoutSubview:(NSView *)view;
\@end
@endcode
Or it can be an NSView object.
- If you want to use it along with Qt4 see the QMacCocoaViewContainer. Then
+ If you want to use it along with Qt see the QMacCocoaViewContainer. Then
the following code should work:
- @begincode
+ @code.mm
NSView *video = [[NSView alloc] init];
QMacCocoaViewContainer *container = new QMacCocoaViewContainer(video, parent);
@@ -4864,37 +6566,26 @@
ctypes.c_void_p, MediaPlayer)
return f(p_mi)
-def libvlc_media_player_set_agl(p_mi, drawable):
- '''Set the agl handler where the media player should render its video output.
- @param p_mi: the Media Player.
- @param drawable: the agl handler.
- '''
- f = _Cfunctions.get('libvlc_media_player_set_agl', None) or \
- _Cfunction('libvlc_media_player_set_agl', ((1,), (1,),), None,
- None, MediaPlayer, ctypes.c_uint32)
- return f(p_mi, drawable)
-
-def libvlc_media_player_get_agl(p_mi):
- '''Get the agl handler previously set with L{libvlc_media_player_set_agl}().
- @param p_mi: the Media Player.
- @return: the agl handler or 0 if none where set.
- '''
- f = _Cfunctions.get('libvlc_media_player_get_agl', None) or \
- _Cfunction('libvlc_media_player_get_agl', ((1,),), None,
- ctypes.c_uint32, MediaPlayer)
- return f(p_mi)
-
def libvlc_media_player_set_xwindow(p_mi, drawable):
'''Set an X Window System drawable where the media player should render its
- video output. If LibVLC was built without X11 output support, then this has
- no effects.
- The specified identifier must correspond to an existing Input/Output class
- X11 window. Pixmaps are B{not} supported. The caller shall ensure that
- the X11 server is the same as the one the VLC instance has been configured
- with. This function must be called before video playback is started;
- otherwise it will only take effect after playback stop and restart.
- @param p_mi: the Media Player.
- @param drawable: the ID of the X window.
+ video output. The call takes effect when the playback starts. If it is
+ already started, it might need to be stopped before changes apply.
+ If LibVLC was built without X11 output support, then this function has no
+ effects.
+ By default, LibVLC will capture input events on the video rendering area.
+ Use L{libvlc_video_set_mouse_input}() and L{libvlc_video_set_key_input}() to
+ disable that and deliver events to the parent window / to the application
+ instead. By design, the X11 protocol delivers input events to only one
+ recipient.
+ @warning
+ The application must call the XInitThreads() function from Xlib before
+ L{libvlc_new}(), and before any call to XOpenDisplay() directly or via any
+ other library. Failure to call XInitThreads() will seriously impede LibVLC
+ performance. Calling XOpenDisplay() before XInitThreads() will eventually
+ crash the process. That is a limitation of Xlib.
+ @param p_mi: media player.
+ @param drawable: X11 window ID @note The specified identifier must correspond to an existing Input/Output class X11 window. Pixmaps are B{not} currently supported. The default X11 server is assumed, i.e. that specified in the DISPLAY environment variable. @warning LibVLC can deal with invalid X11 handle errors, however some display drivers (EGL, GLX, VA and/or VDPAU) can unfortunately not. Thus the window handle must remain valid until playback is stopped, otherwise the process may abort or crash.
+ @bug No more than one window handle per media player instance can be specified. If the media has multiple simultaneously active video tracks, extra tracks will be rendered into external windows beyond the control of the application.
'''
f = _Cfunctions.get('libvlc_media_player_set_xwindow', None) or \
_Cfunction('libvlc_media_player_set_xwindow', ((1,), (1,),), None,
@@ -4938,10 +6629,35 @@
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.
+ @param p_awindow_handler: org.videolan.libvlc.AWindow jobject owned by the org.videolan.libvlc.MediaPlayer class from the libvlc-android project.
+ @version: LibVLC 3.0.0 and later.
+ '''
+ 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)
+ 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.
+ @param p_evas_object: a valid EFL Evas Object (Evas_Object).
+ @return: -1 if an error was detected, 0 otherwise.
+ @version: LibVLC 3.0.0 and later.
+ '''
+ 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)
+ return f(p_mi, p_evas_object)
+
def libvlc_audio_set_callbacks(mp, play, pause, resume, flush, drain, opaque):
- '''Set callbacks and private data for decoded audio.
+ '''Sets callbacks and private data for decoded audio.
Use L{libvlc_audio_set_format}() or L{libvlc_audio_set_format_callbacks}()
to configure the decoded audio format.
+ @note: The audio callbacks override any other audio output mechanism.
+ If the callbacks are set, LibVLC will B{not} output audio in any way.
@param mp: the media player.
@param play: callback to play audio samples (must not be None).
@param pause: callback to pause playback (or None to ignore).
@@ -4971,8 +6687,8 @@
return f(mp, set_volume)
def libvlc_audio_set_format_callbacks(mp, setup, cleanup):
- '''Set decoded audio format. This only works in combination with
- L{libvlc_audio_set_callbacks}().
+ '''Sets decoded audio format via callbacks.
+ This only works in combination with L{libvlc_audio_set_callbacks}().
@param mp: the media player.
@param setup: callback to select the audio format (cannot be None).
@param cleanup: callback to release any allocated resources (or None).
@@ -4984,7 +6700,7 @@
return f(mp, setup, cleanup)
def libvlc_audio_set_format(mp, format, rate, channels):
- '''Set decoded audio format.
+ '''Sets a fixed decoded audio format.
This only works in combination with L{libvlc_audio_set_callbacks}(),
and is mutually exclusive with L{libvlc_audio_set_format_callbacks}().
@param mp: the media player.
@@ -5176,23 +6892,13 @@
def libvlc_media_player_get_state(p_mi):
'''Get current movie state.
@param p_mi: the Media Player.
- @return: the current state of the media player (playing, paused, ...) See libvlc_state_t.
+ @return: the current state of the media player (playing, paused, ...) See L{State}.
'''
f = _Cfunctions.get('libvlc_media_player_get_state', None) or \
_Cfunction('libvlc_media_player_get_state', ((1,),), None,
State, MediaPlayer)
return f(p_mi)
-def libvlc_media_player_get_fps(p_mi):
- '''Get movie fps rate.
- @param p_mi: the Media Player.
- @return: frames per second (fps) for this playing movie, or 0 if unspecified.
- '''
- f = _Cfunctions.get('libvlc_media_player_get_fps', None) or \
- _Cfunction('libvlc_media_player_get_fps', ((1,),), None,
- ctypes.c_float, MediaPlayer)
- 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.
@@ -5266,6 +6972,22 @@
None, MediaPlayer, Position, ctypes.c_int)
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
+ will also update the slave list of the attached L{Media}.
+ @param p_mi: the media player.
+ @param i_type: subtitle or audio.
+ @param psz_uri: Uri of the slave (should contain a valid scheme).
+ @param b_select: True if this slave should be selected when it's loaded.
+ @return: 0 on success, -1 on error.
+ @version: LibVLC 3.0.0 and later. See L{libvlc_media_slaves_add}.
+ '''
+ 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)
+ 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.
@@ -5420,6 +7142,30 @@
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}()).
+ @version: LibVLC 3.0.0 and later.
+ '''
+ f = _Cfunctions.get('libvlc_video_new_viewpoint', None) or \
+ _Cfunction('libvlc_video_new_viewpoint', (), None,
+ 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.
+ @param p_mi: the media player.
+ @param p_viewpoint: video viewpoint allocated via L{libvlc_video_new_viewpoint}().
+ @param b_absolute: if true replace the old viewpoint with the new one. If false, increase/decrease it.
+ @return: -1 in case of error, 0 otherwise @note the values are set asynchronously, it will be used by the next frame displayed.
+ @version: LibVLC 3.0.0 and later.
+ '''
+ 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)
+ 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.
@@ -5443,7 +7189,7 @@
def libvlc_video_get_spu_description(p_mi):
'''Get the description of available video subtitles.
@param p_mi: the media player.
- @return: list containing description of available video subtitles.
+ @return: list containing description of available video subtitles. It must be freed with L{libvlc_track_description_list_release}().
'''
f = _Cfunctions.get('libvlc_video_get_spu_description', None) or \
_Cfunction('libvlc_video_get_spu_description', ((1,),), None,
@@ -5461,17 +7207,6 @@
ctypes.c_int, MediaPlayer, ctypes.c_int)
return f(p_mi, i_spu)
-def libvlc_video_set_subtitle_file(p_mi, psz_subtitle):
- '''Set new video subtitle file.
- @param p_mi: the media player.
- @param psz_subtitle: new video subtitle file.
- @return: the success status (boolean).
- '''
- f = _Cfunctions.get('libvlc_video_set_subtitle_file', None) or \
- _Cfunction('libvlc_video_set_subtitle_file', ((1,), (1,),), None,
- ctypes.c_int, MediaPlayer, ctypes.c_char_p)
- return f(p_mi, psz_subtitle)
-
def libvlc_video_get_spu_delay(p_mi):
'''Get the current subtitle delay. Positive values means subtitles are being
displayed later, negative values earlier.
@@ -5499,26 +7234,52 @@
ctypes.c_int, MediaPlayer, ctypes.c_int64)
return f(p_mi, i_delay)
-def libvlc_video_get_title_description(p_mi):
- '''Get the description of available titles.
- @param p_mi: the media player.
- @return: list containing description of available titles.
- '''
- f = _Cfunctions.get('libvlc_video_get_title_description', None) or \
- _Cfunction('libvlc_video_get_title_description', ((1,),), None,
- ctypes.POINTER(TrackDescription), MediaPlayer)
- return f(p_mi)
-
-def libvlc_video_get_chapter_description(p_mi, i_title):
- '''Get the description of available chapters for specific title.
- @param p_mi: the media player.
- @param i_title: selected title.
- @return: list containing description of available chapter for title i_title.
- '''
- f = _Cfunctions.get('libvlc_video_get_chapter_description', None) or \
- _Cfunction('libvlc_video_get_chapter_description', ((1,), (1,),), None,
- ctypes.POINTER(TrackDescription), MediaPlayer, ctypes.c_int)
- return f(p_mi, i_title)
+def libvlc_media_player_get_full_title_descriptions(p_mi, titles):
+ '''Get the full description of available titles.
+ @param p_mi: the media player.
+ @param titles: address to store an allocated array of title descriptions descriptions (must be freed with L{libvlc_title_descriptions_release}() by the caller) [OUT].
+ @return: the number of titles (-1 on error).
+ @version: LibVLC 3.0.0 and later.
+ '''
+ 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)))
+ 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.
+ @param i_count: number of title descriptions to release.
+ @version: LibVLC 3.0.0 and later.
+ '''
+ f = _Cfunctions.get('libvlc_title_descriptions_release', None) or \
+ _Cfunction('libvlc_title_descriptions_release', ((1,), (1,),), None,
+ None, 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.
+ @param i_chapters_of_title: index of the title to query for chapters (uses current title if set to -1).
+ @param pp_chapters: address to store an allocated array of chapter descriptions descriptions (must be freed with L{libvlc_chapter_descriptions_release}() by the caller) [OUT].
+ @return: the number of chapters (-1 on error).
+ @version: LibVLC 3.0.0 and later.
+ '''
+ 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)))
+ 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.
+ @param i_count: number of chapter descriptions to release.
+ @version: LibVLC 3.0.0 and later.
+ '''
+ f = _Cfunctions.get('libvlc_chapter_descriptions_release', None) or \
+ _Cfunction('libvlc_chapter_descriptions_release', ((1,), (1,),), None,
+ None, 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.
@@ -5541,7 +7302,9 @@
return f(p_mi, psz_geometry)
def libvlc_video_get_teletext(p_mi):
- '''Get current teletext page requested.
+ '''Get current teletext page requested or 0 if it's disabled.
+ Teletext is disabled by default, call L{libvlc_video_set_teletext}() to enable
+ it.
@param p_mi: the media player.
@return: the current teletext page requested.
'''
@@ -5552,23 +7315,15 @@
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.
@param p_mi: the media player.
- @param i_page: teletex page number requested.
+ @param i_page: teletex page number requested. This value can be 0 to disable teletext, a number in the range ]0;1000[ to show the requested page, or a \ref L{TeletextKey}. 100 is the default teletext page.
'''
f = _Cfunctions.get('libvlc_video_set_teletext', None) or \
_Cfunction('libvlc_video_set_teletext', ((1,), (1,),), None,
None, MediaPlayer, ctypes.c_int)
return f(p_mi, i_page)
-def libvlc_toggle_teletext(p_mi):
- '''Toggle teletext transparent status on video output.
- @param p_mi: the media player.
- '''
- f = _Cfunctions.get('libvlc_toggle_teletext', None) or \
- _Cfunction('libvlc_toggle_teletext', ((1,),), None,
- None, MediaPlayer)
- return f(p_mi)
-
def libvlc_video_get_track_count(p_mi):
'''Get number of available video tracks.
@param p_mi: media player.
@@ -5582,7 +7337,7 @@
def libvlc_video_get_track_description(p_mi):
'''Get the description of available video tracks.
@param p_mi: media player.
- @return: list with description of available video tracks, or None on error.
+ @return: list with description of available video tracks, or None on error. It must be freed with L{libvlc_track_description_list_release}().
'''
f = _Cfunctions.get('libvlc_video_get_track_description', None) or \
_Cfunction('libvlc_video_get_track_description', ((1,),), None,
@@ -5616,7 +7371,7 @@
If i_width XOR i_height is 0, original aspect-ratio is preserved.
@param p_mi: media player instance.
@param num: number of video output (typically 0 for the first/only one).
- @param psz_filepath: the path where to save the screenshot to.
+ @param psz_filepath: the path of a file or a folder to save the screenshot into.
@param i_width: the snapshot's width.
@param i_height: the snapshot's height.
@return: 0 on success, -1 if the video was not found.
@@ -5683,7 +7438,7 @@
def libvlc_video_get_logo_int(p_mi, option):
'''Get integer logo option.
@param p_mi: libvlc media player instance.
- @param option: logo option to get, values of libvlc_video_logo_option_t.
+ @param option: logo option to get, values of L{VideoLogoOption}.
'''
f = _Cfunctions.get('libvlc_video_get_logo_int', None) or \
_Cfunction('libvlc_video_get_logo_int', ((1,), (1,),), None,
@@ -5696,7 +7451,7 @@
Passing libvlc_logo_enable as option value has the side effect of
starting (arg !0) or stopping (arg 0) the logo filter.
@param p_mi: libvlc media player instance.
- @param option: logo option to set, values of libvlc_video_logo_option_t.
+ @param option: logo option to set, values of L{VideoLogoOption}.
@param value: logo option value.
'''
f = _Cfunctions.get('libvlc_video_set_logo_int', None) or \
@@ -5708,7 +7463,7 @@
'''Set logo option as string. Options that take a different type value
are ignored.
@param p_mi: libvlc media player instance.
- @param option: logo option to set, values of libvlc_video_logo_option_t.
+ @param option: logo option to set, values of L{VideoLogoOption}.
@param psz_value: logo option value.
'''
f = _Cfunctions.get('libvlc_video_set_logo_string', None) or \
@@ -5719,7 +7474,7 @@
def libvlc_video_get_adjust_int(p_mi, option):
'''Get integer adjust option.
@param p_mi: libvlc media player instance.
- @param option: adjust option to get, values of libvlc_video_adjust_option_t.
+ @param option: adjust option to get, values of L{VideoAdjustOption}.
@version: LibVLC 1.1.1 and later.
'''
f = _Cfunctions.get('libvlc_video_get_adjust_int', None) or \
@@ -5733,7 +7488,7 @@
Passing libvlc_adjust_enable as option value has the side effect of
starting (arg !0) or stopping (arg 0) the adjust filter.
@param p_mi: libvlc media player instance.
- @param option: adust option to set, values of libvlc_video_adjust_option_t.
+ @param option: adust option to set, values of L{VideoAdjustOption}.
@param value: adjust option value.
@version: LibVLC 1.1.1 and later.
'''
@@ -5745,7 +7500,7 @@
def libvlc_video_get_adjust_float(p_mi, option):
'''Get float adjust option.
@param p_mi: libvlc media player instance.
- @param option: adjust option to get, values of libvlc_video_adjust_option_t.
+ @param option: adjust option to get, values of L{VideoAdjustOption}.
@version: LibVLC 1.1.1 and later.
'''
f = _Cfunctions.get('libvlc_video_get_adjust_float', None) or \
@@ -5757,7 +7512,7 @@
'''Set adjust option as float. Options that take a different type value
are ignored.
@param p_mi: libvlc media player instance.
- @param option: adust option to set, values of libvlc_video_adjust_option_t.
+ @param option: adust option to set, values of L{VideoAdjustOption}.
@param value: adjust option value.
@version: LibVLC 1.1.1 and later.
'''
@@ -5769,7 +7524,7 @@
def libvlc_audio_output_list_get(p_instance):
'''Gets the list of available audio output modules.
@param p_instance: libvlc instance.
- @return: list of available audio outputs. It must be freed it with In case of error, None is returned.
+ @return: list of available audio outputs. It must be freed with In case of error, None is returned.
'''
f = _Cfunctions.get('libvlc_audio_output_list_get', None) or \
_Cfunction('libvlc_audio_output_list_get', ((1,),), None,
@@ -5791,7 +7546,7 @@
restarted. Audio output cannot be changed while playing.
@param p_mi: media player.
@param psz_name: name of audio output, use psz_name of See L{AudioOutput}.
- @return: 0 if function succeded, -1 on error.
+ @return: 0 if function succeeded, -1 on error.
'''
f = _Cfunctions.get('libvlc_audio_output_set', None) or \
_Cfunction('libvlc_audio_output_set', ((1,), (1,),), None,
@@ -5808,7 +7563,7 @@
some circumstances. By default, it is recommended to not specify any
explicit audio device.
@param mp: media player.
- @return: A None-terminated linked list of potential audio output devices. It must be freed it with L{libvlc_audio_output_device_list_release}().
+ @return: A None-terminated linked list of potential audio output devices. It must be freed with L{libvlc_audio_output_device_list_release}().
@version: LibVLC 2.2.0 or later.
'''
f = _Cfunctions.get('libvlc_audio_output_device_enum', None) or \
@@ -5827,8 +7582,8 @@
some circumstances. By default, it is recommended to not specify any
explicit audio device.
@param p_instance: libvlc instance.
- @param psz_aout: audio output name (as returned by L{libvlc_audio_output_list_get}()).
- @return: A None-terminated linked list of potential audio output devices. It must be freed it with L{libvlc_audio_output_device_list_release}().
+ @param aout: audio output name (as returned by L{libvlc_audio_output_list_get}()).
+ @return: A None-terminated linked list of potential audio output devices. It must be freed with L{libvlc_audio_output_device_list_release}().
@version: LibVLC 2.1.0 or later.
'''
f = _Cfunctions.get('libvlc_audio_output_device_list_get', None) or \
@@ -5877,6 +7632,27 @@
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}().
+ @warning: The initial value for the current audio output device identifier
+ may not be set or may be some unknown value. A LibVLC application should
+ compare this value against the known device identifiers (e.g. those that
+ were previously retrieved by a call to L{libvlc_audio_output_device_enum} or
+ L{libvlc_audio_output_device_list_get}) to find the current audio output device.
+ It is possible that the selected audio output device changes (an external
+ change) without a call to L{libvlc_audio_output_device_set}. That may make this
+ method unsuitable to use if a LibVLC application is attempting to track
+ dynamic audio device changes as they happen.
+ @param mp: media player.
+ @return: the current audio output device identifier None if no device is selected or in case of error (the result must be released with free() or L{libvlc_free}()).
+ @version: LibVLC 3.0.0 or later.
+ '''
+ f = _Cfunctions.get('libvlc_audio_output_device_get', None) or \
+ _Cfunction('libvlc_audio_output_device_get', ((1,),), string_result,
+ 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}().
@@ -5940,7 +7716,7 @@
def libvlc_audio_get_track_description(p_mi):
'''Get the description of available audio tracks.
@param p_mi: media player.
- @return: list with description of available audio tracks, or None.
+ @return: list with description of available audio tracks, or None. It must be freed with L{libvlc_track_description_list_release}().
'''
f = _Cfunctions.get('libvlc_audio_get_track_description', None) or \
_Cfunction('libvlc_audio_get_track_description', ((1,),), None,
@@ -5971,7 +7747,7 @@
def libvlc_audio_get_channel(p_mi):
'''Get current audio channel.
@param p_mi: media player.
- @return: the audio channel See libvlc_audio_output_channel_t.
+ @return: the audio channel See L{AudioOutputChannel}.
'''
f = _Cfunctions.get('libvlc_audio_get_channel', None) or \
_Cfunction('libvlc_audio_get_channel', ((1,),), None,
@@ -5981,7 +7757,7 @@
def libvlc_audio_set_channel(p_mi, channel):
'''Set current audio channel.
@param p_mi: media player.
- @param channel: the audio channel, See libvlc_audio_output_channel_t.
+ @param channel: the audio channel, See L{AudioOutputChannel}.
@return: 0 on success, -1 on error.
'''
f = _Cfunctions.get('libvlc_audio_set_channel', None) or \
@@ -6181,319 +7957,220 @@
ctypes.c_int, MediaPlayer, ctypes.c_void_p)
return f(p_mi, p_equalizer)
-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),
+def libvlc_media_player_get_role(p_mi):
+ '''Gets the media role.
+ @param p_mi: media player.
+ @return: the media player role (\ref libvlc_media_player_role_t).
+ @version: LibVLC 3.0.0 and later.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_get_role', None) or \
+ _Cfunction('libvlc_media_player_get_role', ((1,),), None,
+ 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.
+ @param role: the media player role (\ref libvlc_media_player_role_t).
+ @return: 0 on success, -1 on error.
+ '''
+ 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)
+ 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)
-
-# 4 function(s) blacklisted:
+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.
+ @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)
+
+
+# 5 function(s) blacklisted:
# libvlc_audio_output_get_device_type
# libvlc_audio_output_set_device_type
+# libvlc_dialog_set_callbacks
# libvlc_printerr
# libvlc_set_exit_handler
-# 28 function(s) not wrapped as methods:
+# 54 function(s) not wrapped as methods:
# libvlc_audio_equalizer_get_amp_at_index
# libvlc_audio_equalizer_get_band_count
# libvlc_audio_equalizer_get_band_frequency
@@ -6507,20 +8184,46 @@
# libvlc_audio_equalizer_set_preamp
# libvlc_audio_output_device_list_release
# libvlc_audio_output_list_release
+# libvlc_chapter_descriptions_release
# libvlc_clearerr
# libvlc_clock
-# libvlc_errmsg
+# libvlc_dialog_dismiss
+# libvlc_dialog_get_context
+# libvlc_dialog_post_action
+# libvlc_dialog_post_login
+# libvlc_dialog_set_context
# libvlc_event_type_name
# libvlc_free
# libvlc_get_changeset
# libvlc_get_compiler
# libvlc_get_version
+# libvlc_log_clear
+# libvlc_log_close
+# libvlc_log_count
# libvlc_log_get_context
+# libvlc_log_get_iterator
# libvlc_log_get_object
+# libvlc_media_discoverer_list_release
+# libvlc_media_get_codec_description
+# libvlc_media_slaves_release
# libvlc_media_tracks_release
# libvlc_module_description_list_release
# libvlc_new
+# libvlc_renderer_discoverer_event_manager
+# libvlc_renderer_discoverer_list_release
+# libvlc_renderer_discoverer_release
+# libvlc_renderer_discoverer_start
+# libvlc_renderer_discoverer_stop
+# libvlc_renderer_item_flags
+# libvlc_renderer_item_hold
+# libvlc_renderer_item_icon_uri
+# libvlc_renderer_item_name
+# libvlc_renderer_item_release
+# libvlc_renderer_item_type
+# libvlc_title_descriptions_release
# libvlc_track_description_list_release
+# libvlc_track_description_release
+# libvlc_video_new_viewpoint
# libvlc_vprinterr
# Start of footer.py #
@@ -6547,8 +8250,8 @@
def libvlc_free(p):
pass
- # ensure argtypes is right, because default type of int won't work
- # on 64-bit systems
+ # ensure argtypes is right, because default type of int won't
+ # work on 64-bit systems
libvlc_free.argtypes = [ ctypes.c_void_p ]
# Version functions
@@ -6557,7 +8260,10 @@
'''
t = [int(i) for i in v.split('.')]
if len(t) == 3:
- t.append(0)
+ if t[2] < 100:
+ t.append(0)
+ else: # 100 is arbitrary
+ t[2:4] = divmod(t[2], 100)
elif len(t) != 4:
raise ValueError('"i.i.i[.i]": %r' % (v,))
if min(t) < 0 or max(t) > 255:
@@ -6571,7 +8277,7 @@
"""Return the version of these bindings in hex or 0 if unavailable.
"""
try:
- return _dot2int(__version__.split('-')[-1])
+ return _dot2int(__version__)
except (NameError, ValueError):
return 0
@@ -6583,7 +8289,6 @@
except ValueError:
return 0
-
def debug_callback(event, *args, **kwds):
'''Example callback, useful for debugging.
'''
@@ -6594,8 +8299,9 @@
l.extend(sorted('%s=%s' % t for t in kwds.items()))
print('Debug callback (%s)' % ', '.join(l))
+
if __name__ == '__main__':
-
+ logging.basicConfig(level=logging.DEBUG)
try:
from msvcrt import getch
except ImportError:
@@ -6624,38 +8330,69 @@
player.get_position() * 100))
sys.stdout.flush()
+ def print_python():
+ from platform import architecture, mac_ver, uname, win32_ver
+ if 'intelpython' in sys.executable:
+ t = 'Intel-'
+ # elif 'PyPy ' in sys.version:
+ # t = 'PyPy-'
+ else:
+ t = ''
+ t = '%sPython: %s (%s)' % (t, sys.version.split()[0], architecture()[0])
+ if win32_ver()[0]:
+ t = t, 'Windows', win32_ver()[0]
+ elif mac_ver()[0]:
+ t = t, ('iOS' if sys.platform == 'ios' else 'macOS'), mac_ver()[0]
+ else:
+ try:
+ import distro # <http://GitHub.com/nir0s/distro>
+ t = t, bytes_to_str(distro.name()), bytes_to_str(distro.version())
+ except ImportError:
+ t = (t,) + uname()[0:3:2]
+ print(' '.join(t))
+
def print_version():
- """Print libvlc version"""
+ """Print version of this vlc.py and of the libvlc"""
try:
- print('Build date: %s (%#x)' % (build_date, hex_version()))
+ print('%s: %s (%s)' % (os.path.basename(__file__), __version__, build_date))
print('LibVLC version: %s (%#x)' % (bytes_to_str(libvlc_get_version()), libvlc_hex_version()))
print('LibVLC compiler: %s' % bytes_to_str(libvlc_get_compiler()))
if plugin_path:
print('Plugin path: %s' % plugin_path)
- except:
+ except Exception:
print('Error: %s' % sys.exc_info()[1])
- if sys.argv[1:] and sys.argv[1] not in ('-h', '--help'):
-
- movie = os.path.expanduser(sys.argv[1])
+ if '-h' in sys.argv[:2] or '--help' in sys.argv[:2]:
+ print('Usage: %s [options] <movie_filename>' % sys.argv[0])
+ print('Once launched, type ? for help.')
+ print('')
+
+ elif '-v' in sys.argv[:2] or '--version' in sys.argv[:2]:
+ print_version()
+ print_python()
+ print('')
+
+ else:
+ movie = os.path.expanduser(sys.argv.pop())
if not os.access(movie, os.R_OK):
print('Error: %s file not readable' % movie)
sys.exit(1)
- instance = Instance("--sub-source marq")
+ # Need --sub-source=marq in order to use marquee below
+ instance = Instance(["--sub-source=marq"] + sys.argv[1:])
try:
media = instance.media_new(movie)
- except NameError:
- print('NameError: %s (%s vs LibVLC %s)' % (sys.exc_info()[1],
- __version__,
- libvlc_get_version()))
+ except (AttributeError, NameError) as e:
+ print('%s: %s (%s %s vs LibVLC %s)' % (e.__class__.__name__, e,
+ sys.argv[0], __version__,
+ libvlc_get_version()))
sys.exit(1)
player = instance.media_player_new()
player.set_media(media)
player.play()
# Some marquee examples. Marquee requires '--sub-source marq' in the
- # Instance() call above. See <http://www.videolan.org/doc/play-howto/en/ch04.html>
+ # Instance() call above, see <http://www.videolan.org/doc/play-howto/en/ch04.html>
player.video_set_marquee_int(VideoMarqueeOption.Enable, 1)
player.video_set_marquee_int(VideoMarqueeOption.Size, 24) # pixels
player.video_set_marquee_int(VideoMarqueeOption.Position, Position.Bottom)
@@ -6678,7 +8415,7 @@
event_manager.event_attach(EventType.MediaPlayerPositionChanged, pos_callback, player)
def mspf():
- """Milliseconds per frame."""
+ """Milliseconds per frame"""
return int(1000 // (player.get_fps() or 25))
def print_info():
@@ -6755,9 +8492,3 @@
elif k.isdigit():
# jump to fraction of the movie.
player.set_position(float('0.'+k))
-
- else:
- print('Usage: %s <movie_filename>' % sys.argv[0])
- print('Once launched, type ? for help.')
- print('')
- print_version()
=== modified file 'tests/functional/openlp_core/common/test_i18n.py'
--- tests/functional/openlp_core/common/test_i18n.py 2018-08-27 14:16:26 +0000
+++ tests/functional/openlp_core/common/test_i18n.py 2018-10-11 11:45:39 +0000
@@ -162,6 +162,7 @@
def test_get_language_from_settings():
assert LanguageManager.get_language() == 'en'
+
def test_get_language_from_settings_returns_unchanged_if_unknown_format():
Settings().setValue('core/language', '(foobar)')
assert LanguageManager.get_language() == '(foobar)'
Follow ups
