Old Python bindings - Revision history

DoesItReallyMatter: Demote headings, syntaxhighlight

2019-03-29T05:48:24Z

Demote headings, syntaxhighlight

← Older revision		Revision as of 05:48, 29 March 2019
Line 1:		Line 1:
	{{Historical\|Use [[Python bindings]]}}		{{Historical\|Use [[Python bindings]]}}
	= Python binding documentation =		== Python binding documentation ==
	'''NOTE: this version of python bindings (compiled C-module) is deprecated in favor of the new [[PythonBinding]].'''		'''NOTE: this version of python bindings (compiled C-module) is deprecated in favor of the new [[PythonBinding]].'''

Line 7:		Line 7:
	It has been compiled, and is being used, on Linux, Windows and Mac OS X.		It has been compiled, and is being used, on Linux, Windows and Mac OS X.

	= Compile HOWTO =		== Compile HOWTO ==

	Only for < 0.9.0 versions: If you want to include the python bindings in your build, you must pass --enable-python-bindings (svn version) or --enable-mediacontrol-python-bindings (0.8.6* versions) to ./configure as it is disabled by default.		Only for < 0.9.0 versions: If you want to include the python bindings in your build, you must pass --enable-python-bindings (svn version) or --enable-mediacontrol-python-bindings (0.8.6* versions) to ./configure as it is disabled by default.
Line 13:		Line 13:
	For >= 0.9.0 versions, python bindings cannot be compiled at the same time as the main VLC tree. They can (and event must) be compiled from a compiled VLC, provided that appropriate headers and libraries (libvlc.so/.dll) are available.		For >= 0.9.0 versions, python bindings cannot be compiled at the same time as the main VLC tree. They can (and event must) be compiled from a compiled VLC, provided that appropriate headers and libraries (libvlc.so/.dll) are available.

	== Linux/Debian ==		=== Linux/Debian ===

	On Debian:		On Debian:
Line 26:		Line 26:
	or simply copy the vlc.so file to some appropriate directory.		or simply copy the vlc.so file to some appropriate directory.

	== Windows ==		=== Windows ===

	* Get and install a nighty-built package from http://nightlies.videolan.org/build/windows/		* Get and install a nighty-built package from http://nightlies.videolan.org/build/windows/
Line 36:		Line 36:
	You should get a vlc.pyd (or vlc.dll) file in the build/ subdirectory.		You should get a vlc.pyd (or vlc.dll) file in the build/ subdirectory.

	= Basics =		== Basics ==

	The vlc python module provides 4 main classes : MediaControl, Instance, MediaPlayer and Media.		The vlc python module provides 4 main classes : MediaControl, Instance, MediaPlayer and Media.
Line 44:		Line 44:
	'''vlc.Instance''', '''vlc.MediaPlayer''' and '''vlc.Media''' match the new [[LibVLC]] API. Refer (for now) to the docstrings provided by the python objects to get their usage.		'''vlc.Instance''', '''vlc.MediaPlayer''' and '''vlc.Media''' match the new [[LibVLC]] API. Refer (for now) to the docstrings provided by the python objects to get their usage.

	= Tips and tricks =		== Tips and tricks ==

	== Building notes ==		=== Building notes ===

	* on 0.8.6(a), the --enable-mediacontrol-python-bindings option is not compatible with --enable-libtool. If you need libtool support, please use the svn version.		* on 0.8.6(a), the --enable-mediacontrol-python-bindings option is not compatible with --enable-libtool. If you need libtool support, please use the svn version.

	== Python specificities ==		=== Python specificities ===

	The python bindings provide a binding for the [[MediaControlAPI]], with some variations :		The python bindings provide a binding for the [[MediaControlAPI]], with some variations :
Line 58:		Line 58:
	* RGBPicture (returned by snapshot) and StreamInformation (returned by get_stream_information) are not objects with attributes, but instead dictionaries.		* RGBPicture (returned by snapshot) and StreamInformation (returned by get_stream_information) are not objects with attributes, but instead dictionaries.

	== Snapshot support ==		=== Snapshot support ===

	In the current svn revision, we use the core snapshot functionality of vlc, which is simpler to setup (no additional module, see below) and directly returns PNG, but less precise.		In the current svn revision, we use the core snapshot functionality of vlc, which is simpler to setup (no additional module, see below) and directly returns PNG, but less precise.
Line 69:		Line 69:
	* the snapshot vout module holds a cache of reduced-size snapshots, that allow to take into account the reaction time of the user (around 200ms) and also to precisely select the more appropriate snapshot from the cache.		* the snapshot vout module holds a cache of reduced-size snapshots, that allow to take into account the reaction time of the user (around 200ms) and also to precisely select the more appropriate snapshot from the cache.

	== Win32 initialization ==		=== Win32 initialization ===

	If the vlc module was not compiled with the exact same prefix as the VLC installation (e.g. c:\\Program Files\\Videolan), then it cannot find itself the installation directory (stored in the registry Software\VideoLAN\VLC\InstallDir), and the MediaControl instanciation will fail with a message like "Cannot find interface plugins".		If the vlc module was not compiled with the exact same prefix as the VLC installation (e.g. c:\\Program Files\\Videolan), then it cannot find itself the installation directory (stored in the registry Software\VideoLAN\VLC\InstallDir), and the MediaControl instanciation will fail with a message like "Cannot find interface plugins".

	The workaround consists in changing directory to the VLC installation directory before instanciating the MediaControl object, since VLC will look for its plugins in the current directory. Another way is to pass the correct --plugin-path option.		The workaround consists in changing directory to the VLC installation directory before instanciating the MediaControl object, since VLC will look for its plugins in the current directory. Another way is to pass the correct --plugin-path option.
			<syntaxhighlight lang="python">
	def get_registry_value (self, subkey, name):		def get_registry_value (self, subkey, name):
	import _winreg		import _winreg
Line 93:		Line 93:
	os.chdir(vlcpath)		os.chdir(vlcpath)
	mc=vlc.MediaControl()		mc=vlc.MediaControl()
			</syntaxhighlight>

	= Source code =		== Source code ==
	Formerly located at bindings/python/		Formerly located at bindings/python/

	[[Category:Bindings]]		[[Category:Bindings]]

Edwardw: mark as historical

2013-08-16T01:27:26Z

mark as historical

← Older revision		Revision as of 01:27, 16 August 2013
Line 1:		Line 1:
			{{Historical\|Use [[Python bindings]]}}
	= Python binding documentation =		= Python binding documentation =

	'''NOTE: this version of python bindings (compiled C-module) is deprecated in favor of the new [[PythonBinding]].'''		'''NOTE: this version of python bindings (compiled C-module) is deprecated in favor of the new [[PythonBinding]].'''

Line 95:		Line 95:

	= Source code =		= Source code =
	~~{{file\|~~bindings/python~~\|bindings}}~~		Formerly located at bindings/python/

	[[Category:Bindings]]		[[Category:Bindings]]

Courmisch: /* Basics */

2010-07-11T13:53:37Z

Basics

← Older revision		Revision as of 13:53, 11 July 2010
Line 42:		Line 42:
	'''vlc.MediaControl''' implements the [[MediaControlAPI]]. Methods taking positions as parameters expect a '''vlc.Position''' object, that provides a very flexible way to address absolute or relative positions, in a number of units (milliseconds, frames or bytes). For convenience, the python binding automatically converts integer positions into milliseconds '''vlc.Position''' objects.		'''vlc.MediaControl''' implements the [[MediaControlAPI]]. Methods taking positions as parameters expect a '''vlc.Position''' object, that provides a very flexible way to address absolute or relative positions, in a number of units (milliseconds, frames or bytes). For convenience, the python binding automatically converts integer positions into milliseconds '''vlc.Position''' objects.

	'''vlc.Instance''', '''vlc.MediaPlayer''' and '''vlc.Media''' match the new [[~~ExternalAPI\|~~LibVLC ~~API~~]]. Refer (for now) to the docstrings provided by the python objects to get their usage.		'''vlc.Instance''', '''vlc.MediaPlayer''' and '''vlc.Media''' match the new [[LibVLC]] API. Refer (for now) to the docstrings provided by the python objects to get their usage.

	= Tips and tricks =		= Tips and tricks =

OlivierAubert: /* Python binding documentation */

2009-09-04T14:35:39Z

Python binding documentation

← Older revision		Revision as of 14:35, 4 September 2009
Line 1:		Line 1:
	= Python binding documentation =		= Python binding documentation =

	'''NOTE: this version of python bindings (compiled C-module) is deprecated in favor of the new [[~~Python Binding~~]].'''		'''NOTE: this version of python bindings (compiled C-module) is deprecated in favor of the new [[PythonBinding]].'''

	The old version of python bindings, which can be found in <code>bindings/python</code>, is a python C-based module. Sources are browsable from [http://trac.videolan.org/vlc/browser/bindings/python python binding] and a code sample can be found in the sources (file [http://trac.videolan.org/vlc/browser/bindings/python/vlcwidget.py vlcwidget.py]).		The old version of python bindings, which can be found in <code>bindings/python</code>, is a python C-based module. Sources are browsable from [http://trac.videolan.org/vlc/browser/bindings/python python binding] and a code sample can be found in the sources (file [http://trac.videolan.org/vlc/browser/bindings/python/vlcwidget.py vlcwidget.py]).

OlivierAubert: /* Python binding documentation */

2009-09-04T14:34:47Z

Python binding documentation

← Older revision		Revision as of 14:34, 4 September 2009
Line 1:		Line 1:
	= Python binding documentation =		= Python binding documentation =

	~~For a while, there has been a basic~~ python ~~binding for [[Wikipedia:libvlc\|libvlc]]~~ (~~located~~ in ~~<code>vlc/pyvlc</code>), that was used for streaming. A more complete (with a hopefully generic API that can be reused by other players) has been developed, based on~~ the [[~~MediaControlAPI~~]]. ~~It can be found in <code>bindings/python</code>.~~		'''NOTE: this version of python bindings (compiled C-module) is deprecated in favor of the new [[Python Binding]].'''

	Sources are browsable from [http://trac.videolan.org/vlc/browser/bindings/python python binding] and a code sample can be found in the sources (file [http://trac.videolan.org/vlc/browser/bindings/python/vlcwidget.py vlcwidget.py]).		The old version of python bindings, which can be found in <code>bindings/python</code>, is a python C-based module. Sources are browsable from [http://trac.videolan.org/vlc/browser/bindings/python python binding] and a code sample can be found in the sources (file [http://trac.videolan.org/vlc/browser/bindings/python/vlcwidget.py vlcwidget.py]).

	It has been compiled, and is being used, on Linux, Windows and Mac OS X.		It has been compiled, and is being used, on Linux, Windows and Mac OS X.

OlivierAubert: moved Python bindings to Old Python bindings: There are new python bindings (ctypes-based). Preserve this information for the moment, as the old bindings are still used.

2009-09-04T13:57:25Z

moved Python bindings to Old Python bindings: There are new python bindings (ctypes-based). Preserve this information for the moment, as the old bindings are still used.

← Older revision		Revision as of 13:57, 4 September 2009
(No difference)

OlivierAubert: /* Snapshot support */

2009-07-20T09:42:30Z

Snapshot support

← Older revision		Revision as of 09:42, 20 July 2009
Line 64:		Line 64:
	Prior to revision 13881, in order to get snapshot support, you had to activate the snapshot vout module through a clone video filter. The following code gives a way to achieve this :		Prior to revision 13881, in order to get snapshot support, you had to activate the snapshot vout module through a clone video filter. The following code gives a way to achieve this :

	mc=vlc.MediaControl([ "--vout-filter~~", "~~clone~~" ])~~		mc=vlc.MediaControl("--vout-filter clone --clone-vout-list default,snapshot --snapshot-width 320 --snapshot-height 200".split())
	~~o=VLC.Object(0)~~
	~~o.config_set("~~clone-vout-list~~", "~~default,snapshot")
	~~o.config_set("~~snapshot-width", 320)
	~~o.config_set("~~snapshot-height"~~, 200~~)

	~~Note that all config options could have been given on the command line, but this illustrates the use of the vlc.Object API.~~

	Advantages of the old (filter-based) approach:		Advantages of the old (filter-based) approach:
	* the snapshot vout module holds a cache of reduced-size snapshots, that allow to take into account the reaction time of the user (around 200ms) and also to precisely select the more appropriate snapshot from the cache.		* the snapshot vout module holds a cache of reduced-size snapshots, that allow to take into account the reaction time of the user (around 200ms) and also to precisely select the more appropriate snapshot from the cache.
	* the builtin snapshot functionality is oriented towards interactive use (hotkey activation, saving into a file) and should be revamped to take into accound a more programmatic use [Note: this is now implemented, cf src/video_output/vout_intf.c, and look for "object-id"]

	== Win32 initialization ==		== Win32 initialization ==

OlivierAubert: /* Linux/Debian */

2008-07-07T12:42:53Z

Linux/Debian

@@ Line 25: / Line 25: @@
    python setup.py install
 or simply copy the vlc.so file to some appropriate directory.
 = Basics =

OlivierAubert: /* Python binding documentation */

2008-07-07T12:19:37Z

Python binding documentation

← Older revision		Revision as of 12:19, 7 July 2008
Line 3:		Line 3:
	For a while, there has been a basic python binding for [[Wikipedia:libvlc\|libvlc]] (located in <code>vlc/pyvlc</code>), that was used for streaming. A more complete (with a hopefully generic API that can be reused by other players) has been developed, based on the [[MediaControlAPI]]. It can be found in <code>bindings/python</code>.		For a while, there has been a basic python binding for [[Wikipedia:libvlc\|libvlc]] (located in <code>vlc/pyvlc</code>), that was used for streaming. A more complete (with a hopefully generic API that can be reused by other players) has been developed, based on the [[MediaControlAPI]]. It can be found in <code>bindings/python</code>.

	Sources are browsable from [http://trac.videolan.org/vlc/browser~~/trunk~~/bindings/python python binding] and a code sample can be found in [http://~~liris~~.~~cnrs~~.fr/~~advene~~/~~download~~.~~html~~].		Sources are browsable from [http://trac.videolan.org/vlc/browser/bindings/python python binding] and a code sample can be found in the sources (file [http://trac.videolan.org/vlc/browser/bindings/python/vlcwidget.py vlcwidget.py]).

	It has been compiled, and is being used, on Linux, Windows and Mac OS X.		It has been compiled, and is being used, on Linux, Windows and Mac OS X.

	= Compile HOWTO =		= Compile HOWTO =

OlivierAubert: /* Python binding documentation */

2008-07-07T12:04:23Z

Python binding documentation

← Older revision		Revision as of 12:04, 7 July 2008
Line 6:		Line 6:

	It has been compiled, and is being used, on Linux, Windows and Mac OS X.		It has been compiled, and is being used, on Linux, Windows and Mac OS X.

			= Compile HOWTO =

	Only for < 0.9.0 versions: If you want to include the python bindings in your build, you must pass --enable-python-bindings (svn version) or --enable-mediacontrol-python-bindings (0.8.6* versions) to ./configure as it is disabled by default.		Only for < 0.9.0 versions: If you want to include the python bindings in your build, you must pass --enable-python-bindings (svn version) or --enable-mediacontrol-python-bindings (0.8.6* versions) to ./configure as it is disabled by default.

	For >= 0.9.0 versions, python bindings cannot be compiled at the same time as the main VLC tree. They can (and event must) be compiled from a compiled VLC, provided that appropriate headers and libraries (libvlc.so/.dll) are available.		For >= 0.9.0 versions, python bindings cannot be compiled at the same time as the main VLC tree. They can (and event must) be compiled from a compiled VLC, provided that appropriate headers and libraries (libvlc.so/.dll) are available.

			== Linux/Debian ==

			On Debian:
			* install the libvlc2-dev package
			* Get the python bindings sources from the Git repository :
			* in the python directory, launch
			python setup.py build
			The module will be built in
			build/lib.linux-i686-2.5
			* install the module through (as root)
			python setup.py install
			or simply copy the vlc.so file to some appropriate directory.

	= Basics =		= Basics =