View source for Python bindings

= Python bindings =

You can find two versions of python bindings: a up-to-date one, which is ctypes-based and is automatically generated.
You can also find an old one (see [[Old Python bindings]]), hand-written C-module, and deprecated. It will be removed in some future version.

== Features ==

The new module features :
* a complete cover of the libvlc API, since it is automatically generated from the include files.
* no compilation hassle: the generated module is pure python.
* no versioning hassle: the same module works with multiple VLC versions.
* a [http://www.advene.org/download/python-ctypes/doc/ complete documentation].

== Download ==

You can download the [http://git.videolan.org/?p=vlc/bindings/python.git;a=tree;f=generated;b=HEAD vlc.py] module from the Git repository. It only depends on ctypes (standard module in python >= 2.5). Put the module in some place accessible by python (either next to your application, or in a directory from sys.path).

Alternatively, you can generate it by yourself using the generate.py program and accompanying files in the vlc source tree (see [http://git.videolan.org/?p=vlc/bindings/python.git;a=tree]).

== Usage ==

The vlc.py module also contains a runnable example player application (see code at the end of the module, starting from the line "if __name__ == '__main__'). 

A set of helper examples [http://git.videolan.org/?p=vlc/bindings/python.git;a=tree;f=examples;hb=HEAD examples] provide a pyGtk, a pyQt and a pyWx player to ease integration.

There is also a [http://git.videolan.org/?p=vlc/bindings/python.git;a=blob;f=README README]

== Projects using this binding ==

http://code.google.com/p/movie-content-editor/ See also [[LibVLC_Users]]

== FAQ ==

===  Win32 initialization === 

If the vlc modules are not installed in their standard location (e.g. c:\\Program Files\\Videolan on Windows, or /usr/lib/vlc on linux), the VLC module cannot find them.

When instanciating vlc.Instance() with no parameter, it tries to guess the location of the modules. However, if you pass any argument to vlc.Instance(), you will need to supply the appropriate "--plugin-path=/path/to/the/modules" yourself.

To run the file "vlc.py" from the command line, you'll need to pass it an argument, like "python vlc.py e:\" for it to play something.