VideoLAN Wiki - User contributions [en]

Mirrors

2018-02-12T10:27:51Z

Etix:

= Mirrors =

Our mirrors are kindly operated by sponsors, you can find the complete list [http://www.videolan.org/videolan/mirrors.html here]. If you would like to provide a mirror to the VideoLAN project please read the following sections.

== Requirements ==

* A public mirror in '''HTTPS''' (we won't accept new mirrors in HTTP)
* About 70 GB of disk space at this time
* At least 1 Gbps connectivity
* At '''least''' 4 rsync per day (once every hour is better!)
* Either an rsync or FTP server access to scan the actual state of your mirror (rsync is preferred)

== Setting up a mirror ==

The first step is to clone the rsync repository using the following command:<br />
'''rsync --verbose --recursive --times --links --hard-links --perms --stats --delete-after --timeout=300 rsync://rsync.videolan.org/videolan-ftp ''/path/to/repository/destination'''''

Edit your crontab (crontab -e) to sync the cron every hour:<br />
'''11 * * * * sleep $(($RANDOM/1024)); rsync --verbose --recursive --times --links --hard-links --perms --stats --delete-after --timeout=300 rsync://rsync.videolan.org/videolan-ftp ''/path/to/repository/destination'''''

Setup a web server to serve the repository preferably with [http://wiki.nginx.org/ nginx] or [http://httpd.apache.org/ Apache].

Finally setup a read-only rsync daemon using a similar configuration:
<nowiki>
[videolan]
path = /path/to/repository/destination
comment = VideoLAN repository
uid = nobody
gid = nogroup
read only = yes</nowiki>

Finally make sure the rsync server daemon is started during system startup!

NOTE: if you're using a CDN in front of the repository be sure to clear the cache at least once a day!

== How do we manage mirrors ==

On the VideoLAN side, in order to provide the best service to our users we're running [https://github.com/etix/mirrorbits Mirrorbits], a mirror management software that will transparently redirect users to the closest mirror.

It is also in charge of scanning the mirrors, ensuring they are up and running and it knows which files are served by your mirror. The system will automatically scan you mirror (using rsync or FTP) every now and then and do some health checks on the HTTP side every minute. If you have any concern related to a high bandwidth usage please tell us, we will reduce the weight of your mirror.

== Contact us ==

Once your mirror is setup, please [mailto:mirrors@videolan.org contact us] and be sure to send:
* A name and contact email address
* HTTP, FTP (if applicable) and rsync URLs to the file tree on your server
* The name, URL and logo of the operator / organization / sponsor you represent (preferably in 137x54)

After reviewing your application your mirror will be added to our load balancer.

[[Category:About VideoLAN]]

Mirrors

2017-07-24T11:02:07Z

Etix: HTTPS requirement

= Mirrors =

Our mirrors are kindly operated by sponsors, you can find the complete list [http://www.videolan.org/videolan/mirrors.html here]. If you would like to provide a mirror to the VideoLAN project please read the following sections.

== Requirements ==

* A public mirror in '''HTTPS''' (we won't accept new mirrors in HTTP)
* About 45 GB of disk space at this time
* At least 1 Gbps connectivity
* At '''least''' 4 rsync per day (once every hour is better!)
* Either an rsync or FTP server access to scan the actual state of your mirror (rsync is preferred)

== Setting up a mirror ==

The first step is to clone the rsync repository using the following command:<br />
'''rsync --verbose --recursive --times --links --hard-links --perms --stats --delete-after --timeout=300 rsync://rsync.videolan.org/videolan-ftp ''/path/to/repository/destination'''''

Edit your crontab (crontab -e) to sync the cron every hour:<br />
'''11 * * * * sleep $(($RANDOM/1024)); rsync --verbose --recursive --times --links --hard-links --perms --stats --delete-after --timeout=300 rsync://rsync.videolan.org/videolan-ftp ''/path/to/repository/destination'''''

Setup a web server to serve the repository preferably with [http://wiki.nginx.org/ nginx] or [http://httpd.apache.org/ Apache].

Finally setup a read-only rsync daemon using a similar configuration:
<nowiki>
[videolan]
path = /path/to/repository/destination
comment = VideoLAN repository
uid = nobody
gid = nogroup
read only = yes</nowiki>

Finally make sure the rsync server daemon is started during system startup!

NOTE: if you're using a CDN in front of the repository be sure to clear the cache at least once a day!

== How do we manage mirrors ==

On the VideoLAN side, in order to provide the best service to our users we're running [https://github.com/etix/mirrorbits Mirrorbits], a mirror management software that will transparently redirect users to the closest mirror.

It is also in charge of scanning the mirrors, ensuring they are up and running and it knows which files are served by your mirror. The system will automatically scan you mirror (using rsync or FTP) every now and then and do some health checks on the HTTP side every minute. If you have any concern related to a high bandwidth usage please tell us, we will reduce the weight of your mirror.

== Contact us ==

Once your mirror is setup, please [mailto:mirrors@videolan.org contact us] and be sure to send:
* A name and contact email address
* HTTP, FTP (if applicable) and rsync URLs to the file tree on your server
* The name, URL and logo of the operator / organization / sponsor you represent (preferably in 137x54)

After reviewing your application your mirror will be added to our load balancer.

[[Category:About VideoLAN]]

Mirrors

2017-07-05T14:53:26Z

Etix: /* Requirements */

= Mirrors =

Our mirrors are kindly operated by sponsors, you can find the complete list [http://www.videolan.org/videolan/mirrors.html here]. If you would like to provide a mirror to the VideoLAN project please read the following sections.

== Requirements ==

* A public mirror available in HTTP
* About 45 GB of disk space at this time
* At least 1 Gbps connectivity
* At '''least''' 4 rsync per day (once every hour is better!)
* Either an rsync or FTP server access to scan the actual state of your mirror (rsync is preferred)

== Setting up a mirror ==

The first step is to clone the rsync repository using the following command:<br />
'''rsync --verbose --recursive --times --links --hard-links --perms --stats --delete-after --timeout=300 rsync://rsync.videolan.org/videolan-ftp ''/path/to/repository/destination'''''

Edit your crontab (crontab -e) to sync the cron every hour:<br />
'''11 * * * * sleep $(($RANDOM/1024)); rsync --verbose --recursive --times --links --hard-links --perms --stats --delete-after --timeout=300 rsync://rsync.videolan.org/videolan-ftp ''/path/to/repository/destination'''''

Setup a web server to serve the repository preferably with [http://wiki.nginx.org/ nginx] or [http://httpd.apache.org/ Apache].

Finally setup a read-only rsync daemon using a similar configuration:
<nowiki>
[videolan]
path = /path/to/repository/destination
comment = VideoLAN repository
uid = nobody
gid = nogroup
read only = yes</nowiki>

Finally make sure the rsync server daemon is started during system startup!

NOTE: if you're using a CDN in front of the repository be sure to clear the cache at least once a day!

== How do we manage mirrors ==

On the VideoLAN side, in order to provide the best service to our users we're running [https://github.com/etix/mirrorbits Mirrorbits], a mirror management software that will transparently redirect users to the closest mirror.

It is also in charge of scanning the mirrors, ensuring they are up and running and it knows which files are served by your mirror. The system will automatically scan you mirror (using rsync or FTP) every now and then and do some health checks on the HTTP side every minute. If you have any concern related to a high bandwidth usage please tell us, we will reduce the weight of your mirror.

== Contact us ==

Once your mirror is setup, please [mailto:mirrors@videolan.org contact us] and be sure to send:
* A name and contact email address
* HTTP, FTP (if applicable) and rsync URLs to the file tree on your server
* The name, URL and logo of the operator / organization / sponsor you represent (preferably in 137x54)

After reviewing your application your mirror will be added to our load balancer.

[[Category:About VideoLAN]]

Mirrors

2017-04-27T10:02:47Z

Etix: /* Requirements */

= Mirrors =

Our mirrors are kindly operated by sponsors, you can find the complete list [http://www.videolan.org/videolan/mirrors.html here]. If you would like to provide a mirror to the VideoLAN project please read the following sections.

== Requirements ==

* A public mirror available in HTTP
* About 45 GB of disk space at this time
* At least 1 Gbps connectivity
* At '''least''' 4 rsync per day (more is better!)
* Either an rsync or FTP server access to scan the actual state of your mirror (rsync is preferred)

== Setting up a mirror ==

The first step is to clone the rsync repository using the following command:<br />
'''rsync --verbose --recursive --times --links --hard-links --perms --stats --delete-after --timeout=300 rsync://rsync.videolan.org/videolan-ftp ''/path/to/repository/destination'''''

Edit your crontab (crontab -e) to sync the cron every hour:<br />
'''11 * * * * sleep $(($RANDOM/1024)); rsync --verbose --recursive --times --links --hard-links --perms --stats --delete-after --timeout=300 rsync://rsync.videolan.org/videolan-ftp ''/path/to/repository/destination'''''

Setup a web server to serve the repository preferably with [http://wiki.nginx.org/ nginx] or [http://httpd.apache.org/ Apache].

Finally setup a read-only rsync daemon using a similar configuration:
<nowiki>
[videolan]
path = /path/to/repository/destination
comment = VideoLAN repository
uid = nobody
gid = nogroup
read only = yes</nowiki>

Finally make sure the rsync server daemon is started during system startup!

NOTE: if you're using a CDN in front of the repository be sure to clear the cache at least once a day!

== How do we manage mirrors ==

On the VideoLAN side, in order to provide the best service to our users we're running [https://github.com/etix/mirrorbits Mirrorbits], a mirror management software that will transparently redirect users to the closest mirror.

It is also in charge of scanning the mirrors, ensuring they are up and running and it knows which files are served by your mirror. The system will automatically scan you mirror (using rsync or FTP) every now and then and do some health checks on the HTTP side every minute. If you have any concern related to a high bandwidth usage please tell us, we will reduce the weight of your mirror.

== Contact us ==

Once your mirror is setup, please [mailto:mirrors@videolan.org contact us] and be sure to send:
* A name and contact email address
* HTTP, FTP (if applicable) and rsync URLs to the file tree on your server
* The name, URL and logo of the operator / organization / sponsor you represent (preferably in 137x54)

After reviewing your application your mirror will be added to our load balancer.

[[Category:About VideoLAN]]

Mirrors

2017-02-27T14:09:11Z

Etix: /* Setting up a mirror */

= Mirrors =

Our mirrors are kindly operated by sponsors, you can find the complete list [http://www.videolan.org/videolan/mirrors.html here]. If you would like to provide a mirror to the VideoLAN project please read the following sections.

== Requirements ==

* A public mirror available in HTTP
* About 30 GB of disk space at this time
* At least 1 Gbps connectivity
* At '''least''' 4 rsync per day (more is better!)
* Either an rsync or FTP server access to scan the actual state of your mirror (rsync is preferred)

== Setting up a mirror ==

The first step is to clone the rsync repository using the following command:<br />
'''rsync --verbose --recursive --times --links --hard-links --perms --stats --delete-after --timeout=300 rsync://rsync.videolan.org/videolan-ftp ''/path/to/repository/destination'''''

Edit your crontab (crontab -e) to sync the cron every hour:<br />
'''11 * * * * sleep $(($RANDOM/1024)); rsync --verbose --recursive --times --links --hard-links --perms --stats --delete-after --timeout=300 rsync://rsync.videolan.org/videolan-ftp ''/path/to/repository/destination'''''

Setup a web server to serve the repository preferably with [http://wiki.nginx.org/ nginx] or [http://httpd.apache.org/ Apache].

Finally setup a read-only rsync daemon using a similar configuration:
<nowiki>
[videolan]
path = /path/to/repository/destination
comment = VideoLAN repository
uid = nobody
gid = nogroup
read only = yes</nowiki>

Finally make sure the rsync server daemon is started during system startup!

NOTE: if you're using a CDN in front of the repository be sure to clear the cache at least once a day!

== How do we manage mirrors ==

On the VideoLAN side, in order to provide the best service to our users we're running [https://github.com/etix/mirrorbits Mirrorbits], a mirror management software that will transparently redirect users to the closest mirror.

It is also in charge of scanning the mirrors, ensuring they are up and running and it knows which files are served by your mirror. The system will automatically scan you mirror (using rsync or FTP) every now and then and do some health checks on the HTTP side every minute. If you have any concern related to a high bandwidth usage please tell us, we will reduce the weight of your mirror.

== Contact us ==

Once your mirror is setup, please [mailto:mirrors@videolan.org contact us] and be sure to send:
* A name and contact email address
* HTTP, FTP (if applicable) and rsync URLs to the file tree on your server
* The name, URL and logo of the operator / organization / sponsor you represent (preferably in 137x54)

After reviewing your application your mirror will be added to our load balancer.

[[Category:About VideoLAN]]

User:Etix

2017-02-09T20:21:40Z

Etix:

Hi, I'm Ludovic Fauvet aka etix.
{|
|-
| Email || etix at videolan org
|-
| Blog || http://blog.l0cal.com
|-
| IRC || etix on #videolan (Freenode network)
|-
| Twitter || [http://twitter.com/etixxx etixxx]
|}

SoC 2017

2017-02-09T18:54:04Z

Etix: crypto updates

{{DISPLAYTITLE:Google Summer of Code 2017}}

This page summarize the current list of ideas for VideoLAN project, for [https://summerofcode.withgoogle.com Google Summer Of Code 2017]. The list is not exhaustive, and is not limitative. Feel free to apply with your own idea!

== Introduction & Information ==

This wiki page covers the attempt by the [[VideoLAN]] project to act as a mentoring organization for [http://code.google.com/soc/ Google Summer of Code], in order to improve [[VLMC]] and {{VLC}}.

[[VideoLAN]] was a mentoring organization in [[SoC 2007|2007]], [[SoC 2008|2008]], [[SoC 2009|2009]], [[SoC 2010|2010]], [[SoC 2011|2011]], [[SoC 2013|2013]] and [[SoC 2016|2016]].

This page list the ideas for VLMC and VLC.

=== VideoLAN Movie Creator ===
[[VLMC]] is a cross-platform non-linear video editing software based on VLC technology. It was started as a final year student project at the French IT school [http://www.epitech.eu EPITECH].

[[VLMC]] currently awaits a transition to the current libvlc API and it's actual 1.0 release!

=== libVLC ===

{{VLC}} is a cross-platform multimedia player, encoder and streamer application. It is one of the most successful open-source projects without any professional structure underneath.

{{VLC}} is downloaded at an approximate monthly rate of 23 millions from the main website and that's not including third-party distributions (Linux)!

You can find more information on [http://en.wikipedia.org/wiki/VLC_media_player VLC on Wikipedia] or on this [[Main Page|wiki]].

The engine of VLC is libVLC, and is used by VLMC.

=== Summer of Code ===

If selected and developed, SoC projects for VLMC and VLC will be included in later releases.

All projects are covered by the GPL (v2+) or LGPL (v2.1+) licenses depending on the module.

=== Compile libVLC or VLMC ===
This may sound trivial, but it's harder than many expect. See https://wiki.videolan.org/Category:Building/ for more informations.

=== Provide a small patch ===
To demonstrate your skills, share a small patch with us. This will let you become familiar with [[Git]], in case you don't know it already and our process on [[Sending Patches VLC|merging patches]].

=== Let's get in touch ===
We have 3 major communication channels: Our [https://mailman.videolan.org/mailman/listinfo mailing-lists] to discuss patches and further development related topics. Furthermore, we have our [http://forum.videolan.org web forums] for VLC-related end-user support - a VLMC section will be created once the product is published. Finally, there is our IRC channel ''#videolan'' (for libVLC) and ''#vlmc'' on the ''Freenode'' network. It's open to any kind of discussion. Usage issues, questions how to compile VLC/VLMC, getting to know the fellow developers, etc.

== Key ideas for VLMC ==

=== Port to Android ===

VLMC is now working on the desktop. It would be nice to port it also to the mobile world, starting by Android.

This project would require to adapt to smaller screens, and simplify the UI to fit the Android workflow.

This project requires '''C++/Qt/qml''' knowledge, and access to Android devices.

''Proposed mentors: Geoffrey/Hugo''

=== Workflow rework ===

VLMC is now working on the desktop, but it is quite slow and missing some use cases.

This should be fixed in MLT framework backend for libVLC. See the work from the previous Summer of Code.

''Proposed mentors: Hugo''

=== Workflow audio filters ===

VLMC is now working on the desktop, but it is missing several audio and video filters.

This project would add audio filters on the MLT framework backend using the LADSPA library or a similar open source library.

''Proposed mentors: J-B''

=== Workflow video filters ===

VLMC is now working on the desktop, but it is missing several audio and video filters.

This project would add video filters on the MLT framework backend using the lv2 library or a similar open source library.

''Proposed mentors: Felix''

== Key ideas for libVLC ==

=== Fuzz libVLC with LibFuzzer ===

libFuzzer ((http://llvm.org/docs/LibFuzzer.html).) is a library for coverage-guided fuzz testing.

* The first step of this GSoC project is to implement Fuzz Targets (http://llvm.org/docs/LibFuzzer.html#fuzz-target) to test various parts of the libVLC project. The non exhaustive parts will be the following libVLC modules API: "decoder", "encoder, "access", "packetizer", "demuxer". For each parts, the student will have to understand the module API in order to effectively implement the target.

* The second step is to find valid corpus (http://llvm.org/docs/LibFuzzer.html#corpus) for every module types and for every modules (mkv input for mkv demuxer, mp4 input for mp4 demuxer, h264 input for h264 decoder...).

* The third step is to host and run the fuzzer. It's not decided yet if the fuzzer will be hosted by google (https://github.com/google/oss-fuzz) or by the VideoLan association.

* If there is enough time, the fourth and final step is to fix the issues that has emerged during the previous steps.

This project requires '''C''' and '''C++''' knowledge.

''Proposed mentor: tguillem''

=== libVLC AirPlay support ===

libVLC is now able to send video to the ChromeCast devices. We want to be able to do the same using the Airplay protocol, for Apple devices.

We want to be able to do that from any device, including Android or Windows machines.

This will use the new renderer APIs added in libVLC 3.0.

This project requires '''C''' knowledge.

''Proposed mentor: steve''

=== libVLC UPnP renderer support ===

libVLC is now able to send video to the ChromeCast devices. We want to be able to do the same using the UPnP Renderer protocol, for all the connected TV devices that support this protocol.

We want to be able to do that from any device, including Android, iOS or Windows machines.

This will use the new renderer APIs added in libVLC 3.0.

This project requires '''C''' knowledge.

''Proposed mentor: tguillem''

=== VLC web interface modern look ===

The Web interface of VLC is a very ugly player and we want to improve that quite a bit.

This can be done in React, RxJS or Vue.JS to achieve a modern look, with transparency and cross-platform support.

This project requires '''JavaScript''' knowledge and experience. The choice of the Framework can be changed if needed.

''Proposed mentor: David Loiret''

=== libVLC 3D video support ===

libVLC is able to play most 2D and Side-By-Side videos, but the support of 3D is very limited.

Because of 360 and VR support, the attention about 3D is getting very popular those days. We need to support that in libVLC.

This project requires '''C''' knowledge.

''Proposed mentor: adrien''

=== libVLC VR support ===

libVLC is able to play most 2D and 360 videos, but the support of VR is very limited.

Because of 360 and VR support, the attention about VR is getting very popular those days. We need to support that in libVLC.

This project is mostly connecting a new headset to libVLC to get support in all libVLC applications.

This project requires '''C''' knowledge.

''Proposed mentor: adrien''

=== VLC macOS interface rework ===

The VLC interface is quite outdated on macOS.

This project for the summer is to rework heavily this interface to make it beautiful and useful again.

This project requires '''Obj-C''' knowledge.

''Proposed mentor: David F''

=== VLC Qt interface rework ===

The VLC interface is quite outdated on Linux and Windows

This project for the summer is to rework heavily this interface to make it beautiful and useful again.

This project requires '''Qt/C++''' knowledge.

''Proposed mentor: J-B''

=== VLC cryptographic updates ===

VLC is already using GPG signatures to achieve secure updates on the Windows platform. But the updates are currently signed
with a single master key which is pinned into the source code and VLCs in the wild aren't able to check for revocations of this key.

Therefore we would like to improve this situation by:

* being able to sign developers' keys that can sign VLC binaries on behalf of this master key
* support revocations of these developer's key
* provide a master key upgrade path

This project requires solid notions of '''C and Crypto'''.

''Proposed mentor: ???''

{{GSoC}}

Win32Compile

2016-11-03T09:56:52Z

Etix: /* Prepare 3rd party libraries */

This page will help you to compile {{VLC}} for [[Windows]].

== Building Methods ==

If you want to build VLC from source, you have several choices:

{| class="wikitable"
|-
! Method
! Documentation
! Notes
|-
| '''MinGW on Linux'''
| [[Win32Compile#Obtaining_the_toolchain|Obtaining the toolchain]]
| '''Preferred''' method involving cross-compilation from Linux. On computers running Microsoft Windows, a virtual machine is necessary to run Linux.
|-
| '''[http://www.mingw.org MSYS+MinGW]''' on Windows
| [[Win32CompileMSYS|Compile with MSys]]
| '''Native''' compilation method. MSYS is a minimal build environment to compile Unix-style projects directly on Microsoft Windows. This is '''not officially supported''' by VideoLAN. Best of luck.
|-
| '''Cygwin''' on Windows
| [[Win32CompileCygwinNew|Compile with Cygwin]]
| Cygwin method. Cygwin emulates a POSIX environment to compile on Microsoft Windows. This is '''error'''-prone and '''slow''' and therefore not recommended.
|}

== Obtaining the cross-compilation toolchain ==
All this howto is focused on '''Debian/Ubuntu'''. For other distribution, please find the related package names, but they should be very similar.

'''Ubuntu 14.04''' is too old to compile VLC.

=== Compiler and binary toolchain ===

==== Mingw-w64 ====
To compile VLC for Windows (32-bits or 64-bits), the Mingw-w64 toolchain is required:

For the 32-bit version, run this:
# apt-get install gcc-mingw-w64-i686 g++-mingw-w64-i686 mingw-w64-tools

For the 64-bit version, this becomes:
# apt-get install gcc-mingw-w64-x86-64 g++-mingw-w64-x86-64 mingw-w64-tools

=== Development tools ===
You will also need:
* lua (5.2)
* all autotools: libtool, automake, autoconf, autopoint, make, gettext, pkg-config
* qt4-dev-tools, qt5-default (or qt4-default if qt plugin build fails)
* git, subversion cmake, cvs if you want to rebuild contribs
* wine-dev for creating Win32 packages
* zip [for creating .zip package], p7zip [for .7z package], nsis [for .exe auto-installer], bzip2 [for 'make prebuild]

'''Run:'''
# apt-get install lua5.2 libtool automake autoconf autopoint make gettext pkg-config
# apt-get install qt4-dev-tools qt5-default git subversion cmake cvs
# apt-get install wine64-development-tools zip p7zip nsis bzip2
# apt-get install yasm ragel ant default-jdk protobuf-compiler dos2unix

=== Host triplet ===
A number of example commands below include the toolchain identifier, called the ''host triplet''.

This value is '''essential''': it instructs the build system to use the correct toolchain and compile the program for Windows.
Without the value, the build system will perform a native compilation for Linux (or whatever your computer runs). With an incorrect value, the build will fail.

The exact value depends on your installation of the toolchain.

Notably on Debian/Ubuntu, these values must be used:
* ''i686-w64-mingw32'' for Windows 32-bits, using the Mingw-w64 toolchain
* ''x86_64-w64-mingw32'' for Windows 64-bits, using the Mingw-w64 toolchain

== Get the source code ==
$ git clone http://git.videolan.org/git/vlc.git vlc

See [[Git]] for more information.

== Go into the VLC directory ==
$ cd vlc

== Prepare [[Contrib Status|3rd party libraries]] ==

Before compiling VLC, you need lots of other libraries. Here is how to get them:
$ mkdir -p contrib/win32
$ cd contrib/win32
$ ../bootstrap --host=i686-w64-mingw32
$ make prebuilt

or, if you want to compile the contribs yourself and are feeling adventurous and have lots of time to burn,
# apt-get install subversion yasm cvs cmake ragel autopoint

$ mkdir -p contrib/win32
$ cd contrib/win32
$ ../bootstrap --host=i686-w64-mingw32
$ make fetch
$ make

=== Linux 64-bit ===

If you are on Linux '''64-bit''', you '''SHOULD''' remove some files, or install the lib32 packages (ia32-libs, multilibs, etc...)

$ rm -f ../i686-w64-mingw32/bin/moc ../i686-w64-mingw32/bin/uic ../i686-w64-mingw32/bin/rcc

=== Fix your contrib path ===

If your host triplet is not '''i686-w64-mingw32''' (you are ''not'' compiling for Debian or Ubuntu), create a symlink to contribs:
$ ln -sf '''''insert_your_host_triplet_here''''' ../i686-w64-mingw32
So, for example:
$ ln -sf x86_64-w64-mingw32 ../i686-w64-mingw32
Notice that there is no <code>../</code> before the host triplet. This is intentional, and if done properly, you should see a functioning symbolic link created in the parent directory (try <code>ls -l ..</code> and you should see <code>i686-w64-mingw32 -> x86_64-w64-mingw32/</code>).

=== Go Back ===

Go back to the VLC source directory:

$ cd -

== Configuring the build ==

=== Bootstrap ===
First, prepare the tree:
$ ./bootstrap

=== Configure ===
Then you can to configure the build with the <code>./configure</code> script.

Create a subfolder:
$ mkdir win32 && cd win32

Set your PKG_CONFIG_LIBDIR
$ export PKG_CONFIG_LIBDIR=$HOME/vlc/contrib/i686-w64-mingw32/lib/pkgconfig
$ export PKG_CONFIG_PATH_CUSTOM=$PKG_CONFIG_LIBDIR (for Archlinux only)

Execute the build configuration script:
$ ../extras/package/win32/configure.sh --host=i686-w64-mingw32 --build=x86_64-pc-linux-gnu

'''N.B.''':
Use the host and build tuples respectively corresponding to '''your''' cross-compilation toolchain and build system respectively. The example above assumes you are compiling for ''Windows'' OS and ''Intel 686'' architecture, and the build system is ''GNU/Linux'' OS and ''x86 64-bits'' architecture. See [[#Host_triplet|above]] for list of common values.

Also, if you have a problem here (such as an error about Library dvdread), see the [[Talk:Win32Compile|Talk]] page.

Alternatively, you can run configure manually:
$ ../configure --host=i686-w64-mingw32 --build=x86_64-pc-linux-gnu
See <code>'../configure --help'</code> for more information.

== Building VLC ==

Once configured, to build VLC, just run:
$ make

== Packaging VLC ==
Once the compilation is done, you can build self-contained VLC packages with the following <code>make</code> rules:

{| class="wikitable"
|-
! Command
! Description
|-
| <code>make package-win-common</code>
| Creates a subdirectory named <code>vlc-x.x.x</code> with all the binaries. You can run VLC directly from this directory.
|-
| <code>make package-win-strip</code>
| Same as above but will create 'stripped' binaries (that is, smallest size, unusable with a debugger).
|-
| <code>make package-win32-7zip</code>
| Same as above but will package the directory in a 7z file.
|-
| <code>make package-win32-zip</code>
| Same as above but will package the directory in a zip file.
|-
| <code>make package-win32</code>
| Same as above but will also create an auto-installer package. You must have NSIS installed in its default location for this to work.
|}

'''''Well done—you're ready to use VLC!'''''

== Extra information ==

=== Static compilation of plugins ===
You might want to use the following script to enforce static compilation.
Run as root, and use at your own risk.

#!/bin/sh

# This script enforces statically linking of libgcc, libstdc++-6, and libpthread,
# without needing to rebuild gcc and mingw-w64 from scratch.
# -static-libgcc -static-libstdc++ flags can not be used in a libtool build system,
# as libtool removes flags that it doesn't understand.

move() {
[ -f $1 ] || return 1
mkdir -p old/
mv -v $* old/
return 0
}

for x in i686 x86_64
do
library_path_list=`$x-w64-mingw32-gcc -v /dev/null 2>&1 | grep ^LIBRARY_PATH|cut -d= -f2|sort|uniq`
IFS=':'
for i in $library_path_list
do
cd $i
move libstdc++-6.dll libstdc++.dll.a libgcc_s.a libgcc_s_sjlj-1.dll && ln -s libgcc_eh.a libgcc_s.a
move libpthread.dll.a libwinpthread.dll.a
move libwinpthread-1.dll
[ -d ../bin ] && cd ../bin && move libwinpthread-1.dll
done
done

exit 0

=== Mingw32 ===
Up to versions 2.0.x, VLC was compiled with the older mingw32 toolchain, which only supports 32-bits Windows. If you have problems with mingw-w64, you can try mingw32 instead:

* '''Debian/Ubuntu''': run <code>apt-get install gcc-mingw32 mingw32-binutils</code>. Note that at least version 3.17 of Mingw32 is required, which Debian does not provide. You may obtain mingw32-runtime-3.17 [http://people.videolan.org/~jb/debian/mingw32-runtime_3.17.0-0videolan_all.deb here].
* '''Gentoo''' users can <code>emerge crossdev && crossdev mingw32</code>
* '''ArchLinux''' users can <code>pacman -S mingw32-gcc</code>
* '''Fedora''' users should read [[Win32Compile Under Fedora]]
* Other '''Linux''' systems may attempt http://www.mingw.org/wiki/LinuxCrossMinGW

[[Category:Building]]

Mirrors

2016-10-19T09:13:21Z

Etix: Crontab: change the minutes given as example

= Mirrors =

Our mirrors are kindly operated by sponsors, you can find the complete list [http://www.videolan.org/videolan/mirrors.html here]. If you would like to provide a mirror to the VideoLAN project please read the following sections.

== Requirements ==

* A public mirror available in HTTP
* About 30 GB of disk space at this time
* At least 1 Gbps connectivity
* At '''least''' 4 rsync per day (more is better!)
* Either an rsync or FTP server access to scan the actual state of your mirror (rsync is preferred)

== Setting up a mirror ==

The first step is to clone the rsync repository using the following command:<br />
'''rsync --verbose --recursive --times --links --hard-links --perms --stats --delete-after --timeout=300 rsync://rsync.videolan.org/videolan-ftp ''/path/to/repository/destination'''''

Edit your crontab (crontab -e) to sync the cron every hour:<br />
'''11 * * * * sleep $(($RANDOM/1024)); rsync --verbose --recursive --times --links --hard-links --perms --stats --delete-after --timeout=300 rsync://rsync.videolan.org/videolan-ftp ''/path/to/repository/destination'''''

Setup a web server to serve the repository preferably with [http://wiki.nginx.org/ nginx] or [http://httpd.apache.org/ Apache].

Finally setup a read-only rsync daemon using a similar configuration:
<nowiki>
[videolan]
path = /path/to/repository/destination
comment = VideoLAN repository
uid = nobody
gid = nogroup
read only = yes</nowiki>

NOTE: if you're using a CDN in front of the repository be sure to clear the cache at least once a day!

== How do we manage mirrors ==

On the VideoLAN side, in order to provide the best service to our users we're running [https://github.com/etix/mirrorbits Mirrorbits], a mirror management software that will transparently redirect users to the closest mirror.

It is also in charge of scanning the mirrors, ensuring they are up and running and it knows which files are served by your mirror. The system will automatically scan you mirror (using rsync or FTP) every now and then and do some health checks on the HTTP side every minute. If you have any concern related to a high bandwidth usage please tell us, we will reduce the weight of your mirror.

== Contact us ==

Once your mirror is setup, please [mailto:mirrors@videolan.org contact us] and be sure to send:
* A name and contact email address
* HTTP, FTP (if applicable) and rsync URLs to the file tree on your server
* The name, URL and logo of the operator / organization / sponsor you represent (preferably in 137x54)

After reviewing your application your mirror will be added to our load balancer.

[[Category:About VideoLAN]]

Win32Compile

2016-03-24T14:31:32Z

Etix: Update for Archlinux

This page will help you to compile {{VLC}} for [[Windows]].

== Building Methods ==

If you want to build VLC from source, you have several choices:

{| class="wikitable"
|-
! Method
! Documentation
! Notes
|-
| '''MinGW on Linux'''
| [[Win32Compile#Obtaining_the_toolchain|Obtaining the toolchain]]
| '''Preferred''' method involving cross-compilation from Linux. On computers running Microsoft Windows, a virtual machine is necessary to run Linux.
|-
| '''[http://www.mingw.org MSYS+MinGW]''' on Windows
| [[Win32CompileMSYS|Compile with MSys]]
| '''Native''' compilation method. MSYS is a minimal build environment to compile Unix-style projects directly on Microsoft Windows. This is '''not officially supported''' by VideoLAN. Best of luck.
|-
| '''Cygwin''' on Windows
| [[Win32CompileCygwinNew|Compile with Cygwin]]
| Cygwin method. Cygwin emulates a POSIX environment to compile on Microsoft Windows. This is '''error'''-prone and '''slow''' and therefore not recommended.
|}

== Obtaining the cross-compilation toolchain ==

=== Compiler and binary toolchain ===

==== Mingw-w64 ====
To compile VLC for Windows (32-bits or 64-bits), the Mingw-w64 toolchain is required:

* '''Debian/Ubuntu''': run <code>apt-get install gcc-mingw-w64-i686 g++-mingw-w64-i686 mingw-w64-tools</code>
For the 64-bit version, this becomes <code>apt-get install gcc-mingw-w64-x86-64 g++-mingw-w64-x86-64 mingw-w64-tools</code>

(on Debian you must be on wheezy or above to find this package)

You might want to use the following script to enforce static compilation.
Run as root, and use at your own risk.

#!/bin/sh

# This script enforces statically linking of libgcc, libstdc++-6, and libpthread,
# without needing to rebuild gcc and mingw-w64 from scratch.
# -static-libgcc -static-libstdc++ flags can not be used in a libtool build system,
# as libtool removes flags that it doesn't understand.

move() {
[ -f $1 ] || return 1
mkdir -p old/
mv -v $* old/
return 0
}

for x in i686 x86_64
do
library_path_list=`$x-w64-mingw32-gcc -v /dev/null 2>&1 | grep ^LIBRARY_PATH|cut -d= -f2|sort|uniq`
IFS=':'
for i in $library_path_list
do
cd $i
move libstdc++-6.dll libstdc++.dll.a libgcc_s.a libgcc_s_sjlj-1.dll && ln -s libgcc_eh.a libgcc_s.a
move libpthread.dll.a libwinpthread.dll.a
move libwinpthread-1.dll
[ -d ../bin ] && cd ../bin && move libwinpthread-1.dll
done
done

exit 0

==== Mingw32 ====
Up to versions 2.0.x, VLC was compiled with the older mingw32 toolchain, which only supports 32-bits Windows. If you have problems with mingw-w64, you can try mingw32 instead:

* '''Debian/Ubuntu''': run <code>apt-get install gcc-mingw32 mingw32-binutils</code>. Note that at least version 3.17 of Mingw32 is required, which Debian does not provide. You may obtain mingw32-runtime-3.17 [http://people.videolan.org/~jb/debian/mingw32-runtime_3.17.0-0videolan_all.deb here].
* '''Gentoo''' users can <code>emerge crossdev && crossdev mingw32</code>
* '''ArchLinux''' users can <code>pacman -S mingw32-gcc</code>
* '''Fedora''' users should read [[Win32Compile Under Fedora]]
* Other '''Linux''' systems may attempt http://www.mingw.org/wiki/LinuxCrossMinGW

=== Development tools ===
You will also need:
* lua (5.1 or 5.2)
* all autotools: libtool, automake, autoconf, autopoint, make, gettext
* pkg-config
* qt4-dev-tools, qt5-default (or qt4-default if qt plugin build fails)
* git
* subversion
* cmake, cvs if you want to rebuild contribs
* wine-dev for creating Win32 packages
* zip [for creating .zip package], p7zip [for .7z package], nsis [for .exe auto-installer], bzip2 [for 'make prebuild]

=== Host triplet ===
A number of example commands below include the identifier of the toolchain. This value is '''essential''': it instructs the build system to use the correct toolchain and compile the program for Windows. Without the value, the build system will perform a native compilation for Linux (or whatever your computer runs). With an incorrect value, the build will fail.

This is known as the ''host triplet'', although it's more of a pair than a triplet in the case of Mingw. The exact value depends on your installation of the toolchain. Notably on Debian/Ubuntu, these values must be used:

* ''i686-w64-mingw32'' for Windows 32-bits, using the Mingw-w64 toolchain
* ''x86_64-w64-mingw32'' for Windows 64-bits, using the Mingw-w64 toolchain
* ''i586-mingw32msvc'' for Windows 32-bits, using the Mingw32 toolchain

Again, you '''MUST''' substitute the value in the following command snippets.

== Get the source code ==
$ git clone http://git.videolan.org/git/vlc.git vlc

See [[Git]] for more information.

== Go into the VLC directory ==
$ cd vlc

== Prepare [[Contrib Status|3rd party libraries]] ==

Before compiling VLC, you need lots of other libraries. Here is how to get them:

'''Ubuntu 14.04 LTS''' Mingw32-w64 toolchain has an issue with accepting explicit PKG_CONFIG_PATH.
Patch mentioned in https://bugs.launchpad.net/ubuntu/+source/mingw-w64/+bug/1327242
needs to be applied to /usr/share/pkg-config-crosswrapper

$ mkdir -p contrib/win32
$ cd contrib/win32
$ ../bootstrap --host=i686-w64-mingw32
$ make prebuilt

or, if you want to compile the contribs yourself and are feeling adventurous and have lots of time to burn,
# apt-get install subversion yasm cvs cmake ragel

$ mkdir -p contrib/win32
$ cd contrib/win32
$ ../bootstrap --host=i686-w64-mingw32
$ make fetch
$ make

=== Linux 64-bit ===

If you are on Linux '''64-bit''', you '''SHOULD''' remove some files, or install the lib32 packages (ia32-libs, multilibs, etc...)

$ rm -f ../i686-w64-mingw32/bin/moc ../i686-w64-mingw32/bin/uic ../i686-w64-mingw32/bin/rcc

=== Fix your contrib path ===

If your host triplet is not '''i686-w64-mingw32''' (you are ''not'' compiling for Debian or Ubuntu), create a symlink to contribs:
$ ln -sf '''''insert_your_host_triplet_here''''' ../i686-w64-mingw32
So, for example:
$ ln -sf x86_64-w64-mingw32 ../i686-w64-mingw32
Notice that there is no <code>../</code> before the host triplet. This is intentional, and if done properly, you should see a functioning symbolic link created in the parent directory (try <code>ls -l ..</code> and you should see <code>i686-w64-mingw32 -> x86_64-w64-mingw32/</code>).

=== Go Back ===

Go back to the VLC source directory:

$ cd -

== Configuring the build ==

=== Bootstrap ===
First, prepare the tree:
$ ./bootstrap

=== Configure ===
Then you can to configure the build with the <code>./configure</code> script.

Create a subfolder:
$ mkdir win32 && cd win32

Set your PKG_CONFIG_LIBDIR
$ export PKG_CONFIG_LIBDIR=$HOME/vlc/contrib/i686-w64-mingw32/lib/pkgconfig
$ export PKG_CONFIG_PATH_CUSTOM=$PKG_CONFIG_LIBDIR (for Archlinux only)

Use the standard configuration:
$ ../extras/package/win32/configure.sh --host=i686-w64-mingw32
'''NB''': use '''YOUR''' cross-compiling prefix here, like ''i486-mingw32''

Also, if you have a problem here (such as an error about Library dvdread), see the [[Talk:Win32Compile|Talk]] page.

Alternatively, you can run configure manually:
$ ../configure --host=i686-w64-mingw32
See <code>'../configure --help'</code> for more information.

== Building VLC ==

Once configured, to build VLC, just run:
$ make

== Packaging VLC ==
Once the compilation is done, you can build self-contained VLC packages with the following <code>make</code> rules:

{| class="wikitable"
|-
! Command
! Description
|-
| <code>make package-win-common</code>
| Creates a subdirectory named <code>vlc-x.x.x</code> with all the binaries. You can run VLC directly from this directory.
|-
| <code>make package-win-strip</code>
| Same as above but will create 'stripped' binaries (that is, smallest size, unusable with a debugger).
|-
| <code>make package-win32-7zip</code>
| Same as above but will package the directory in a 7z file.
|-
| <code>make package-win32-zip</code>
| Same as above but will package the directory in a zip file.
|-
| <code>make package-win32</code>
| Same as above but will also create an auto-installer package. You must have NSIS installed in its default location for this to work.
|}

'''''Well done—you're ready to use VLC!'''''

[[Category:Building]]

Outreachy May 2016

2016-02-15T17:44:48Z

Etix: Remove proposal from last year

This wiki page covers the work of the [[VideoLAN]] project as a mentoring organization for [https://wiki.gnome.org/Outreachy Outreachy the successor of the Outreach Program for Women], in order to improve {{VLC}} and [[VLMC]].

To find generic information about the Outreachy program, please see the '''[https://wiki.gnome.org/Outreachy official website]'''.

=== VLC media player ===

{{VLC}} is a cross-platform multimedia player, encoder and streamer application. It is one of the most successful [http://www.videolan.org/videolan/ open-source projects without any professional structure] underneath.

{{VLC}} is downloaded at an approximate monthly rate of 40 millions from the main website and that's not including third-party distributions (like Linux, BSD, Android or iOS)!

You can find more information on [http://en.wikipedia.org/wiki/VLC_media_player VLC on Wikipedia] or on this [[Main Page|wiki]].

=== VideoLAN Movie Creator ===
[[VLMC]] is a cross-platform non-linear video editing software based on VLC technology. It was started as a final year student project at the French IT school [http://www.epitech.eu EPITECH].

[[VLMC]] currently awaits a transition to the current libvlc API and it's actual 1.0 release!

=== Outreachy May 2016 ===

If selected and developed, Outreachy projects for VLC or VLMC will be included in later releases.

All projects are covered by the GPL (v2+) or LGPL (v2.1+) licenses depending on the module.

=== VLC and VLMC Idea categories ===

''''' You should really read this'''''

This page is split in three lists of ideas:

#The ''main ideas'' are what seem to be ''key projects'' for VLC or VLMC and should be more ''thrilling'' than the other ones; we have assigned a potential mentor to each of these.
#The other ideas are less detailed but could be good ideas too.
#[[Mini Projects]] are short-span projects which can be given as Qualification tasks or extended to be a full project.

'''Original good ideas will be valued'''. We don't want to impose anything. This is Free and Open Source software.

If you don't want to apply for Outreachy but want other ideas to develop on, check the [[Mini Projects]] page!

And on the IRC channel ''#videolan'' on the ''Freenode Network'', you can have even more ideas.

== Getting started ==

=== Compile VLC or VLMC ===
This may sound trivial, but it's harder than many expect. VLC's and VLMC's compilation chains are different for every operating system. They don't really use the default toolchains on Windows or OS X, but a simple *nix like ./configure && make doesn't really do the trick either. We have plenty of information available on this wiki and we will happily provide help on our IRC channel.

=== Provide a small patch ===
To demonstrate your skills, share a small patch with us. This will let you become familiar with [[Git]], in case you don't know it already and our process on [[Sending Patches VLC|merging patches]].

=== Let's get in touch ===
We have 3 major communication channels at VideoLAN. Our [https://mailman.videolan.org/mailman/listinfo mailing-lists] to discuss patches and further development related topics. Furthermore, we have our [http://forum.videolan.org web forums] for end-user support. This means 2 things: 1) people using VLC media player on any operating system 2) people using libvlc or the VLC web plugin in their own applications or installations. Finally, there is our IRC channel ''#videolan'' on the ''Freenode'' network. It's open to any kind of discussion. Usage issues, questions how to compile VLC or VLMC, getting to know the fellow developers, etc.

=== How to apply? ===
The application process for the May 2016 rout will open on February 16, 2015 and '''application deadline''' is '''March 22''' (no exceptions!). Please submit your application on the [https://outreachy.gnome.org official program website]. Previously, please check the [https://wiki.gnome.org/Outreachy#Eligibility eligibility requirements] :-)

== Key ideas for VLMC ==

=== Implement a real Audio/Video sync ===

So far, the lip-syncing strategy used by VLMC is pretty much "hope it works".

As you would think, this quite often leads to desync, and thus makes VLMC unusable.

We need to come up with a real synchronization strategy, quite likely based on an abstract clock & PTS

''Proposed mentor: chouquette''

=== Plug-in new libvlcpp & medialibrary ===

VLMC uses a from-sratch C++ binding to libvlc, which is stuck a few years in the past.
Meanwhile, a new binding got written (https://code.videolan.org/videolan/libvlcpp/tree/master), and needs to be plugged in.

We also started working on a cross-platform media library, to replace the low-featured one, present in VLMC.

This media library will handle discovering media for the used, instead of having to manually importing every single file. This should also allow us to kill some of the "Backend" code, as a fair share of it is designed to create thumbnails. This is now done by the medialibrary, and can go away from the VLMC source code.

This probably requires a good C++ knowledge, as both libvlcpp & medialibrary make a heavy use of C++11 & templates meta-programming.

''Proposed mentor: chouquette''

== Key ideas for VLC ==

=== Assembly optimizations in VLC ===

If you are fond of writing ASM and you are fluent in MMX/SSE2/SSE4, there are many interesting things in VLC to speed up.

* Profiling VLC
* video filters ASM speedups (see modules/video_filter/blend.c)
* audio filters ASM speedups (see modules/audio_filter/equalizer.c)
* Porting other ASM video filters to VLC.

This project needs some good ASM knowledge and good C experience.

*Stuff to read: http://www.agner.org/optimize/

''Proposed mentor: [[User:J-b|jb]], flx42''

=== Advanced Audio Filters ===

We are looking for a skilled '''audiophile''' that knows a lot about audio theory and practice to work on new audio filters.

Notably:
* SRS WoW like or other 3D effects;
* channels mixing, notably upmixing, like Prologic-II;
* tracks mixing, and transitions;
* scriptable new audio filters in lua and enable users to create whatever audio filtering function they want in a Lua script;
* LADSPA or other libraries integration.

This project needs some good audio knowledge and good C experience.

''Qualification task'': port any audio filter from MPlayer

''Proposed mentor: [[User:Geal|geal]]''

=== VLC Test Suite ===

This project aims at making automatic tests to improve VLC quality.

*Write a series of tests for vlc-internal
*Integrate a framework for automated plugins testing with the automake build system
*Automate the different codec playback/mux/etc tests
*Automate the subtitles tests
*Write tests for the different bindings: Mac OS X Framework/Python Bindings... etc.

This project is a code project, require good knowledge of C

''Proposed mentor: Rémi''

=== VLC Personal Cloud Project 2.0 ===

The personal cloud project is a simple project to allow people to play their media files anywhere in the world.

Through the http interface of VLC, a user can:

*list the medias from the Media Library,
*play those medias,
*those medias get transcoded and streamed in:
**Flash
**Silverlight
**iPhone format
**Android format
**html5
**A VLC webplugin

A good example of the aim is http://www.vodobox.c.la/

This project has to work on the configuration and NAT traversal.

This projects needs knowledge in HTML and JS; it might require C coding.

''Proposed mentor: [[User:J-b|jb]]''

=== Playlist improvements ===

We need to reinforce the media library capabilities and its integration with external metadata sources, notably for TV shows.

''Proposed mentor: ??''

=== AirPlay streaming ===

We need to be able to stream everything to your Google TV, Apple TV or raspberrypi powered shairport service. Airport is an non-open protocol that allows wireless streaming of audio, video, multimedia to supported devices.

The tasks would consist of:
* Understanding how AirPlay works, try with any device if available.
* Configure a test setup using raspberrypi or your own computer or any TV device if available, play with couple of available players who support AirPlay. This is just to get a feel of what it is you will be trying to implement for vlc-android.
* Study couple of opensource implementations like shairport
* Run/test/deploy VLC on simulator or android device
* Implement an AirPlay aout that would stream audio to your AirPlay supported device (shairport with rpi/computer or Apple TV or Google TV)
* Test with couple of android devices if available, ask mentors and community to test, report bugs, suggestions
* Study how video works, vout for vlc works, if have time implement video streaming as well.

''Proposed mentor: ??''

=== VLC Sync Play across devices ===
By leveraging zeroconf and rtsp make possible to decode in sync in multiple devices a video stored in one.
Tasks:
* Implement a simple protocol for discovery and announce
* Implement the discovery system
* At least one of the following
** Provide a UI for Qt (Windows / Linux)
** Provide a UI for Android
** Provide a UI for OS X
''Proposed mentor: lu_zero''

=== Port VLC's NPAPI web plugin to PPAPI ===
We need to support the PPAPI interfaces this summer to keep playback support within Google Chrome, since they dropped the existing NPAPI architecture. A proof-of-concept was developed already, but needs refactoring, polishing and testing.

Requires good C or/and C++ knowledge and a basic understanding of web browser internals. The ability to test on more than one platform would be a very strong plus.

''Proposed Mentor: [[User:Fkuehne|feepk]]''

=== Add Owncloud, MEGA and Yandex.Disk cloud support to VLC for iOS ===
Following the success of our native integration with Google Drive, Dropbox, OneDrive and Box, we want to integrate with Owncloud, MEGA and Yandex.disk, which are the last remaining major cloud services left to add! :)

Requires good Objective-C and optionally swift knowledge as well as a basic understanding of cloud services and network programming. Additionally, requires a Mac running OS X 10.10 or later.

''Proposed Mentor: [[User:Fkuehne|feepk]]''

=== Add proper audio playback UI to VLC for iOS ===
VLC for iOS is a recognized and well known video player. Few people know that it is actually capable of playing music and podcasts, too and there is a reason for that. The UI is not really suitable for it. Make it so!

Requires good Objective-C and optionally swift knowledge as well as basic design skills. Additionally, requires a Mac running OS X 10.10 or later.

''Proposed Mentor: [[User:Fkuehne|feepk]]''

== Other Ideas for VLC ==

=== DVD audio support ===
Very difficult project for Audio fans
''Proposed mentor: [[User:J-b|jb]]''

=== Device synchronisation===
Sync your mp3 player with the media library
''Proposed mentor: ???''

=== HD DVD support ===
Very difficult project for someone having the right hardware
''Proposed mentor: [[User:J-b|jb]]''

=== Multi-Angle DVD support ===
We need multi-angle DVD support
''Proposed mentor: Meuuh''

Mirrors

2015-12-18T09:44:19Z

Etix: /* Requirements */

= Mirrors =

Our mirrors are kindly operated by sponsors, you can find the complete list [http://www.videolan.org/videolan/mirrors.html here]. If you would like to provide a mirror to the VideoLAN project please read the following sections.

== Requirements ==

* A public mirror available in HTTP
* About 30 GB of disk space at this time
* At least 1 Gbps connectivity
* At '''least''' 4 rsync per day (more is better!)
* Either an rsync or FTP server access to scan the actual state of your mirror (rsync is preferred)

== Setting up a mirror ==

The first step is to clone the rsync repository using the following command:<br />
'''rsync --verbose --recursive --times --links --hard-links --perms --stats --delete-after --timeout=300 rsync://rsync.videolan.org/videolan-ftp ''/path/to/repository/destination'''''

Edit your crontab (crontab -e) to sync the cron every hour:<br />
'''31 * * * * sleep $(($RANDOM/1024)); rsync --verbose --recursive --times --links --hard-links --perms --stats --delete-after --timeout=300 rsync://rsync.videolan.org/videolan-ftp ''/path/to/repository/destination'''''

Setup a web server to serve the repository preferably with [http://wiki.nginx.org/ nginx] or [http://httpd.apache.org/ Apache].

Finally setup a read-only rsync daemon using a similar configuration:
<nowiki>
[videolan]
path = /path/to/repository/destination
comment = VideoLAN repository
uid = nobody
gid = nogroup
read only = yes</nowiki>

NOTE: if you're using a CDN in front of the repository be sure to clear the cache at least once a day!

== How do we manage mirrors ==

On the VideoLAN side, in order to provide the best service to our users we're running [https://github.com/etix/mirrorbits Mirrorbits], a mirror management software that will transparently redirect users to the closest mirror.

It is also in charge of scanning the mirrors, ensuring they are up and running and it knows which files are served by your mirror. The system will automatically scan you mirror (using rsync or FTP) every now and then and do some health checks on the HTTP side every minute. If you have any concern related to a high bandwidth usage please tell us, we will reduce the weight of your mirror.

== Contact us ==

Once your mirror is setup, please [mailto:mirrors@videolan.org contact us] and be sure to send:
* A name and contact email address
* HTTP, FTP (if applicable) and rsync URLs to the file tree on your server
* The name, URL and logo of the operator / organization / sponsor you represent (preferably in 137x54)

After reviewing your application your mirror will be added to our load balancer.

[[Category:About VideoLAN]]

Mirrors

2015-12-18T09:41:44Z

Etix: Add mention of mirrorbits

= Mirrors =

Our mirrors are kindly operated by sponsors, you can find the complete list [http://www.videolan.org/videolan/mirrors.html here]. If you would like to provide a mirror to the VideoLAN project please read the following sections.

== Requirements ==

* A public mirror available in HTTP
* About 30 GB of disk space at this time
* At least 1 Gbps connectivity
* At '''least''' 4 rsync per day (more is better!)
* Either rsync or FTP access to scan the actual state of the mirror

== Setting up a mirror ==

The first step is to clone the rsync repository using the following command:<br />
'''rsync --verbose --recursive --times --links --hard-links --perms --stats --delete-after --timeout=300 rsync://rsync.videolan.org/videolan-ftp ''/path/to/repository/destination'''''

Edit your crontab (crontab -e) to sync the cron every hour:<br />
'''31 * * * * sleep $(($RANDOM/1024)); rsync --verbose --recursive --times --links --hard-links --perms --stats --delete-after --timeout=300 rsync://rsync.videolan.org/videolan-ftp ''/path/to/repository/destination'''''

Setup a web server to serve the repository preferably with [http://wiki.nginx.org/ nginx] or [http://httpd.apache.org/ Apache].

Finally setup a read-only rsync daemon using a similar configuration:
<nowiki>
[videolan]
path = /path/to/repository/destination
comment = VideoLAN repository
uid = nobody
gid = nogroup
read only = yes</nowiki>

NOTE: if you're using a CDN in front of the repository be sure to clear the cache at least once a day!

== How do we manage mirrors ==

On the VideoLAN side, in order to provide the best service to our users we're running [https://github.com/etix/mirrorbits Mirrorbits], a mirror management software that will transparently redirect users to the closest mirror.

It is also in charge of scanning the mirrors, ensuring they are up and running and it knows which files are served by your mirror. The system will automatically scan you mirror (using rsync or FTP) every now and then and do some health checks on the HTTP side every minute. If you have any concern related to a high bandwidth usage please tell us, we will reduce the weight of your mirror.

== Contact us ==

Once your mirror is setup, please [mailto:mirrors@videolan.org contact us] and be sure to send:
* A name and contact email address
* HTTP, FTP (if applicable) and rsync URLs to the file tree on your server
* The name, URL and logo of the operator / organization / sponsor you represent (preferably in 137x54)

After reviewing your application your mirror will be added to our load balancer.

[[Category:About VideoLAN]]

MirrorManagement

2014-05-09T16:45:13Z

Etix: Created page with "= Infrastructure = The current infrastructure is made of: * The master rsync server * The distribution server (aka the redirector) * The actual mirrors (few dozens) The mast..."

= Infrastructure =

The current infrastructure is made of:
* The master rsync server
* The distribution server (aka the redirector)
* The actual mirrors (few dozens)

The master rsync server always contains all the latest version of each file available.

The distribution server replicates the master server via rsync every 15 minutes and also scan the content of each mirrors and their current state every so often.

The mirrors are configured to scan the master at regular interval (at least 4th times a day for most of them).

== Requests handling ==

As soon as a request hits the distribution server, a mirror is chosen depending on the IP address of the client. The selected mirror must contain the latest version of the file and be up at the moment of the request to be selected. The distribution server then issues a 3xx redirection code to the client.

== List of mirrors ==

The most recent list of mirrors can be accessed [https://www.videolan.org/videolan/mirrors.html here]. It is updated after any modification of the mirror list on the distribution server.

= Statistics =

== Files availability ==

You can access the current file availability on each mirror by appending '''?mirrorlist''' to any URL of a file served by the get.videolan.org domain.

For instance the following link will return the list of mirrors handling this file sorted by the most appropriate for the caller (you!).

https://get.videolan.org/vlc/2.1.3/win32/vlc-2.1.3-win32.exe?mirrorlist

To get the view from any other IP address append '''&fromip=x.x.x.x''' to the last URL.

https://get.videolan.org/vlc/2.1.3/win32/vlc-2.1.3-win32.exe?mirrorlist&fromip=80.237.216.0

This will return the same list as the previous call but from the point of view of the ''80.237.216.0'' network (located somewhere in Germany).

== Mirrors statistics ==

A global map of all mirrors, the number of downloads and the total size served by each mirror can be accessed on the following URL:

https://get.videolan.org/?mirrorstats (Beware: URL subject to change)

== Downloads statistics ==

Downloads statistics for each file are available as ''json'' by appending '''?stats''' to any URL of a file served by the get.videolan.org domain.

You can even specify a period if you'd like to:

https://get.videolan.org/vlc/2.1.3/win32/vlc-2.1.3-win32.exe?stats=2014 (for the whole 2014 year)<br/>
https://get.videolan.org/vlc/2.1.3/win32/vlc-2.1.3-win32.exe?stats=2014-03 (for March 2014)<br/>
https://get.videolan.org/vlc/2.1.3/win32/vlc-2.1.3-win32.exe?stats=2014-03-01 (for the 1st of March 2014)

Bounties

2013-10-15T15:03:19Z

Etix: Remove the bounty Opus Encoder since it's done

= WIP =
This is a '''<big>Work In Progress</big>'''. It is NOT a definitive list, nor are the prices!

= Rules =
One must contact us before starting a bounty.

Sending a reasonable patch on a public mailing-list gives a temporary lock for the task.

== Payment ==
The bounties are paid to a legal entity that can create an '''invoice'''. It can be done by an independent worker too.

Money is paid by the VideoLAN non-profit organization in '''Euros'''.

Money is paid on code '''merge''' in the relevant project.

== Join our effort ==
If you feel like adding some money to a special bounty, please [http://www.videolan.org/contact.html Contact us].

= List of bounties =
== VLC bugs ==

=== Screencast ===
==== Audio Loopback for Mac ====
{{Price|300}}
To record the desktop sounds.

* It also requires to ''check that all input are using mdate()-based PTS''

==== Audio Loopback for Windows ====
{{Price|300}}
To record the desktop sounds.

* It also requires to ''check that all input are using mdate()-based PTS''

==== UI for better screencasting ====
{{Price|200}}
See [https://trac.videolan.org/vlc/ticket/4535 #4535] and [https://trac.videolan.org/vlc/ticket/5988 #5988].

=== HTTP/AVI seeking ===
{{Price|500}}
VLC behaves poorly with AVI over http connections.
MPlayer does it way better.

See [https://trac.videolan.org/vlc/ticket/2151 #2151]

'''NB''': A separate bounty of a similar amount can be made for MP4 over HTTP: [https://trac.videolan.org/vlc/ticket/7186 #7186]

=== RTSP/UDP issue ===
{{Price|2000}}
Fix the RTSP output so that the UDP transfers work across client NATs (android clients). This will require interleaving support.

== VLC Features ==
=== libVLC API for filters ===
{{Price|1000}}
This task consist on doing a '''correct''' set of libVLC API for audio filters and video filters.

This should include equalizer configuration.

This would be useful for phonon, tomahawk and other libVLC application.

=== libVLC API for sout and smem ===
{{Price|2000}}
Create a libVLC API to be able to use smem. This will include a libVLC API for sout.

=== libVLC API for imem ===
{{Price|200}}
Create a libVLC API for imem to map to a libvlc_media_t object, in order to use it like the rest of libVLC.

=== Local resampling ===
{{Price|1500}}
Stop resampling the audio when playing local files.

=== RTP packetization ===
{{Price|Each item: 200}}
Do the packetization of ONE of those items:
* Opus
* VP8
* WMA
* WMV
* VC-1
* JPEG
* GSM
* Raw video for I420 and RGB24

See [https://trac.videolan.org/vlc/ticket/1289 #1289], [https://trac.videolan.org/vlc/ticket/1323 #1323], and [https://trac.videolan.org/vlc/ticket/6505 #6505].

=== libVLCcore SD API and Upnp ===
{{Price|800}}
The Upnp SD is very slow because it needs to fetch recusively all nodes. This needs to change.

This task will likely need a change of API for the Service Discoveries.

See [https://trac.videolan.org/vlc/ticket/4437 #4437].

=== DVB scanning ===
{{Price|1000}}
In order to compete with TV software, we need some DVB scanning, working on one platform using the DTV module.

See [https://trac.videolan.org/vlc/ticket/7248 #7248].

See http://nate.dynalias.net/dev/scanchannelsbda.rails and http://nate.deepcreek.org.au/svn/ScanChannelsBDA/trunk/

==== DVB Scanning² ====
{{Price|300}}
Extending the DVB scan to another platform than the main one.

=== HDMI pass-through ===
{{Price|2000}}
Notably for other codecs than the ones we have over S/PDIF.

We need:
* DTS, AC/3 over HDMI?
* DTS extensions over HDMI, notably DTS HD MA
* E-AC3
* MPGA
* Dolby TrueHD

The price is for all of those?

See [https://trac.videolan.org/vlc/ticket/4940 #4940] and other.

=== Preferences for LUA extensions ===
{{Price|2500}}
Be able to add preferences for LUA extensions.

=== Downloader for LUA extensions from addons.v.o ===
{{Price|1000}}
See libattica.

=== Auto-Rotation of the screen ===
{{Price|2000}}
As many MP4 videos and JPEG files we need to rotate those when we detect it.

So far, the demuxer has the info, but that is it.

We should ask the vout if it can transform (OpenGL) else load the right transform filter.

See [https://trac.videolan.org/vlc/ticket/2882 #2882].

=== ARM optimizations ===
ARM optimisation for core and important filters. This is TBD.

Ideas:
* Audio conversions
* Chroma conversions
* Transform filter

=== Add RTP with FEC ===
{{Price|2000}}
Input and output modules (SMPTE 2022).

=== Smooth Streaming output ===
{{Price|1000}}
Write a VLC Smooth Streaming output module

== Libavcodec bugs ==
=== VC-1 interlaced ===
{{Price|1000}}
Fix VC-1 interlaced and adding missing B-frames support in libavcodec.
See [https://trac.videolan.org/vlc/ticket/5887 #5887].

== Libavcodec features ==

=== G2M ===
{{Price|1000}}
Add a G2M2/G2M3/G2M4 Decoder in libavcodec.
See [https://trac.videolan.org/vlc/ticket/2327 #2327].

=== VoxWare ===
{{Price|500}}
Add a VoxWare MetaSound Decoder in libavcodec.

=== DTS-HD Master Audio ===
{{Price|3000}}
Add a [[DTS|DTS-HD Master Audio Decoder]].

This can be either in libavcodec or in libdca, but it must work in VLC in the end, including 8 channels. This is probably the XLL extension to code.

=== AAC ===
{{Price|?}}
Add a native AAC encoder matching the quality of existing implementations by Apple (QuickTime) or Nero (libfaac). Adding support for more channels than just 2.0 is supposed to be covered by an additional bounty.

=== Fallback on multi-threaded decoding if hardware decoding fails ===
{{Price|1000}}
At present, libavcodec will fall back on single-threaded decoding if hardware decoding is enabled and fails during its initialization due to unsupported pixel formats, profiles, etc.. Add support to fallback on multi-threaded decoding if supported by the respective codec.

== BD+ ==
{{Price|2000}}
Work on libbdplus to play BD+ BD in libbluray.

= Past bounties =

=== AC-3 Volume ===
{{Price|1000}}

Fix correctly the AC-3 volume issue. See [https://trac.videolan.org/vlc/ticket/3994 #3994].

The issue can come from a mis-integration with liba52, or could come from some channels being wrongly discarded.

This '''must''' work on Windows.

=== Bug -mt on Mpeg-4 video ===
{{Price|500}}
Fix the Mpeg-4 resolution change for -mt in libavcodec.
See [https://trac.videolan.org/vlc/ticket/6579 #6579] and [https://trac.videolan.org/vlc/ticket/6533 #6533].

=== Bug -mt on H.264 video ===
{{Price|500}}
Fix the H.264 resolution change for -mt in libavcodec.
See [https://trac.videolan.org/vlc/ticket/7306 #7306].

=== Support OGG length calculation ===
{{Price|???}}
See [https://trac.videolan.org/vlc/ticket/6983 #6983].

=== MSS2 ===
{{Price|1000}}
Add a MSS2 Decoder in libavcodec.
See [https://trac.videolan.org/vlc/ticket/750 #750].

[[Category:Coding]]

Mirrors

2013-10-07T15:41:09Z

Etix: /* Requirements */

= Mirrors =

Our mirrors are kindly operated by sponsors, you can find the complete list [http://www.videolan.org/videolan/mirrors.html here]. If you would like to provide a mirror to the VideoLAN project please read the following sections.

== Requirements ==

* A public mirror available in HTTP
* About 30 GB of disk space at this time
* At least 1 Gbps connectivity
* At '''least''' 4 rsync per day (more is better!)
* Either rsync or FTP access to scan the actual state of the mirror

== Setting up a mirror ==

The first step is to clone the rsync repository using the following command:<br />
'''rsync --verbose --recursive --times --links --hard-links --perms --stats --delete-after --timeout=300 rsync://rsync.videolan.org/videolan-ftp ''/path/to/repository/destination'''''

Edit your crontab (crontab -e) to sync the cron every hour:<br />
'''31 * * * * sleep $(($RANDOM/1024)); rsync --verbose --recursive --times --links --hard-links --perms --stats --delete-after --timeout=300 rsync://rsync.videolan.org/videolan-ftp ''/path/to/repository/destination'''''

Setup a web server to serve the repository preferably with [http://wiki.nginx.org/ nginx] or [http://httpd.apache.org/ Apache].

Finally setup a read-only rsync daemon using a similar configuration:
<nowiki>
[videolan]
path = /path/to/repository/destination
comment = VideoLAN repository
uid = nobody
gid = nogroup
read only = yes</nowiki>

NOTE: if you're using a CDN in front of the repository be sure to clear the cache at least once a day!

== Contact us ==

Once your mirror is setup, please [mailto:mirrors@videolan.org contact us] and be sure to send:
* A name and contact email address
* HTTP, FTP (if applicable) and rsync URLs to the file tree on your server
* The name, URL and logo of the operator / organization / sponsor you represent (preferably in 137x54)

After reviewing your application your mirror will be added to our load balancer.

[[Category:About VideoLAN]]

Documentation:Modules/clone

2013-09-27T16:04:26Z

Etix: Add category

{{Module|name=clone|type=Video output filter|description=Clone the video output window}}

You can use this module to play the video in more than one window to test different video outputs or display the same video on multiple screens on the same computer.

== Options ==

{{Option
|name=clone-count
|value=integer
|default=2
|description=Specifies the number of clones}}

{{Option
|name=clone-vout-list
|value=string
|default=""
|description=Comma seperated list of video output modules to use for each clone}}

{{Documentation}}

[[Category:Video Splitters]]

Documentation:Modules/wall

2013-09-27T15:59:40Z

Etix:

{{Module|name=wall|type=Video output splitter|description=Splits the video output in several windows}}

You can use this module to split a video output in several small windows. This is especially useful if you want to display parts of the same video on several computers to make a big video wall.

== Options ==

{{Option
|name=wall-cols
|value=integer
|default=3
|description=Specifies the number of colums in the video wall}}

{{Option
|name=wall-rows
|value=integer
|default=3
|description=Specifies the number of rows in the video wall}}

{{Option
|name=wall-active
|value=integer list
|default=all
|description=comma-separated list of active windows}}

{{Option
|name=wall-element-aspect
|value=string
|default=4:3
|description=Aspect ratio of the individual displays building the wall}}

{{Documentation}}

[[Category:Video Splitters]]

Documentation:Modules/wall

2013-09-27T15:59:20Z

Etix: Filter -> Splitter

{{Module|name=wall|type=Video output filter|description=Splits the video output in several windows}}

You can use this module to split a video output in several small windows. This is especially useful if you want to display parts of the same video on several computers to make a big video wall.

== Options ==

{{Option
|name=wall-cols
|value=integer
|default=3
|description=Specifies the number of colums in the video wall}}

{{Option
|name=wall-rows
|value=integer
|default=3
|description=Specifies the number of rows in the video wall}}

{{Option
|name=wall-active
|value=integer list
|default=all
|description=comma-separated list of active windows}}

{{Option
|name=wall-element-aspect
|value=string
|default=4:3
|description=Aspect ratio of the individual displays building the wall}}

{{Documentation}}

[[Category:Video Splitters]]

Mirrors

2013-09-17T09:17:58Z

Etix: Fix email

= Mirrors =

Our mirrors are kindly operated by sponsors, you can find the complete list [http://www.videolan.org/videolan/mirrors.html here]. If you would like to provide a mirror to the VideoLAN project please read the following sections.

== Requirements ==

* A public mirror available in HTTP
* About 30 GB of disk space at this time
* At least 1 Gbps connectivity
* At least 4 rsync per day (more is better!)
* Either rsync or FTP access to scan the actual state of the mirror

== Setting up a mirror ==

The first step is to clone the rsync repository using the following command:<br />
'''rsync --verbose --recursive --times --links --hard-links --perms --stats --delete-after --timeout=300 rsync://rsync.videolan.org/videolan-ftp ''/path/to/repository/destination'''''

Edit your crontab (crontab -e) to sync the cron every hour:<br />
'''31 * * * * sleep $(($RANDOM/1024)); rsync --verbose --recursive --times --links --hard-links --perms --stats --delete-after --timeout=300 rsync://rsync.videolan.org/videolan-ftp ''/path/to/repository/destination'''''

Setup a web server to serve the repository preferably with [http://wiki.nginx.org/ nginx] or [http://httpd.apache.org/ Apache].

Finally setup a read-only rsync daemon using a similar configuration:
<nowiki>
[videolan]
path = /path/to/repository/destination
comment = VideoLAN repository
uid = nobody
gid = nogroup
read only = yes</nowiki>

NOTE: if you're using a CDN in front of the repository be sure to clear the cache at least once a day!

== Contact us ==

Once your mirror is setup, please [mailto:mirrors@videolan.org contact us] and be sure to send:
* A name and contact email address
* HTTP, FTP (if applicable) and rsync URLs to the file tree on your server
* The name, URL and logo of the operator / organization / sponsor you represent (preferably in 137x54)

After reviewing your application your mirror will be added to our load balancer.

[[Category:About VideoLAN]]

VDD13

2013-08-28T09:07:05Z

Etix: /* Hotel Ibis */

= VideoLAN Dev Days '13 =
'''The Multimedia Conference that frees the cone in you!'''

This is a technical un-conference, please bring laptops, cords, RJ45 cables, and a good mood with you.

=== Nota Bene ===
* The hotel is the [http://www.ibishotel.com/gb/hotel-5543-ibis-paris-avenue-d-italie-13eme/index.shtml Ibis] Avenue d'Italie.

* If you expect us to refund your travel, please bring a printed copy of your tickets, one that shows the total cost. If you are not in our reimbursement database, bring a printed IBAN too.

* On Saturday and Sunday, enter the Free HQ by the '''16 Rue de la Ville-l'Évêque''' ([http://goo.gl/EKHWEc plan]).
** There will be a smoking area inside the building, as the entrance cannot be used once inside the building for security reasons.

* There will be a WiFi connection.

= Schedule =
== Friday, August 30th 2013 ==
[[Image:Asterix VLC.svg|right|270px]]
Friday is an '''<u>optional</u>''' day in the Asterix amusement park to bind together our community. If you wish to attend, the meeting in front of the hotel is at 8:30.
There will be a bus that will be responsible for bringing everyone to and back from the park. More details on the park are available below.

Notes:
* that bus and park entrance fees are paid by us, so there are NO costs with the exception of food and drinks
* do not burden yourself too much with unneeded stuff and particularly '''don't bring your laptop'''!

{| class="wikitable" width="70%"
|-
! Time !! Place !! Description
|-
| 8h30 || [http://www.ibishotel.com/gb/hotel-5543-ibis-paris-avenue-d-italie-13eme/index.shtml Hotel] || Meeting point in front of the hotel
|-
| 10h00 – 18h00 || Visit to Asterix park
|-
| 21h00 || Meeting at a local bar, for the brave... || NB: VideoLAN will not pay for expenses at the bar...
|}

If you cannot be present at the meeting point, you will be able to join us directly there, but you '''MUST''' tell us. For reference here are directions to the park: Take RER B3 from Paris Gare du Nord, platform 43 and get off at “Aéroport Charles De Gaulle Terminal 1, Terminal 3”. Go to the “Parcs de Loisirs” counter and board the Parc Astérix shuttle buses.

== Saturday, August 31st 2013 ==
All the meetings happen in the '''auditorium'''.

=== Morning ===
Schedule information is not currently available.

{| class="wikitable" width="70%"
|-
! Time !! Description
|-
| 9h30 – 10h00 || Welcome, registration, coffee, juice and croissants
|-
| 10h00 – 10h15 || Welcome, VideoLAN, VLC
|-
| 10h20 – 10h45 || TBA
|-
| 10h45 – 11h15 || VLC and DCP
|-
| 11h15 – 11h30 || '''Coffee Break'''
|-
| 11h30 – 11h45 || x265
|-
| 11h45 – 12h05 || TBA
|-
| 12h05 – 12h30 || VLC 2.1.0 and next
|-
|}

=== Lunch ===
Individual tray meal (chicken, salmon, vegetarian or beef) with dessert and drinks.

=== UnConference ===
[[wikipedia:Unconference|What is an UnConference?]]

UnConference schedule to be published...
{| class="wikitable" width="70%"
|-
! Time !! B559 !! B555 !! B551 !! B549 !! B567 !! B312
|-
| 14h00 - 15h00 || TBA || TBA || TBA || || HACKING ROOM || N/A
|-
| 15h00 - 16h00 || TBA || TBA || || || HACKING ROOM || N/A
|-
| 16h00 - 17h00 || TBA ||  || TBA || || HACKING ROOM || N/A
|-
| 17h00 - 18h00 || || TBA || TBA || || HACKING ROOM || N/A
|-
| 18h00 - 19h00 || || TBA || TBA || || HACKING ROOM || N/A
|-
|}

=== Dinner ===
[http://www.tripadvisor.fr/Restaurant_Review-g187147-d2459770-Reviews-Restaurant_Du_Paradis-Paris_Ile_de_France.html Restaurant du Paradis]<br />
66 Rue du Faubourg Poissonniere<br />
75010 Paris<br />

Metro: Line 7, Poissonière

Starting at 20h00, dinner will consist of 2 special menus prepared by the chef. (drinks included - wine and non-alcoholic)

The menu will consist of 4 choices for starters, principal meal and deserts. There is also a vegan menu available.

== Sunday, September 1st 2013 ==
=== Morning ===
Schedule to be posted.
{| class="wikitable" width="70%"
|-
! Time !! B559 !! B555 !! B551 !! B549 !! B567 !! B312
|-
| 9h30 - 11h00 || TBD || TBD || || || HACKING ROOM || N/A
|-
| 11h00 - 12h00 || TBD || TBD  || || || HACKING ROOM || N/A
|-
| 12h00 - 13h00 || TBD || || || || HACKING ROOM || N/A
|-
|}
=== Lunch ===
Location: Cafeteria of Free HQ (a really beautiful and spacious place!)

'''Sandwiches''' with coleslaw or crisps and choices of drinks (including Dr Pepper) + desserts (Pecan pies, Oreo pies, lemon pies, or cheese cakes).

=== Afternoon ===
{| class="wikitable" width="70%"
|-
! Time !! B559 !! B555 !! B551 !! B549 !! B567 !! B312
|-
| 14h00 - 15h00 || TBD || || || || HACKING ROOM || N/A
|-
| 15h00 - 16h00 || Hack || TBD || TBD || || HACKING ROOM || N/A
|-
| 16h00 - 17h00 || Hack || TBD || Hack || Hack || HACKING ROOM || N/A
|-
| 17h00 - 18h00 || Hack || TBD || Hack || Hack || HACKING ROOM || N/A
|-
|}

= Places =

== Asterix Park ==
60128 Plailly, France<br />
Metro / RER: '''B3'''

http://www.parcasterix.fr/

== Free HQ ==
16 Rue de la Ville-l'Évêque<br />
75008 Paris, France ([http://goo.gl/EKHWEc plan])

Metro 8: Madeleine<br />
Metro 12: Madeleine<br />
Metro 14: Madeleine<br />

From CDG airport, take:<br />
the RER B (Paris by train) to Châtelet-les-Halles<br />
then Metro line 14 to Madeleine.

http://www.free.fr/

== Hotel Ibis ==
[http://www.ibishotel.com/gb/hotel-5543-ibis-paris-avenue-d-italie-13eme/index.shtml Hotel IBIS Paris Avenue d'Italie]<br />
15 bis Avenue d'Italie<br />
75013 Paris ([http://goo.gl/MKmwjx plan])

== Emergencies ==

* In case of emergency you can call the European emergency number 112.
* To place a call most credit cards can be used directly in public phones.

[[Category:About VideoLAN]]

VDD13

2013-08-28T09:05:58Z

Etix: Plan

= VideoLAN Dev Days '13 =
'''The Multimedia Conference that frees the cone in you!'''

This is a technical un-conference, please bring laptops, cords, RJ45 cables, and a good mood with you.

=== Nota Bene ===
* The hotel is the [http://www.ibishotel.com/gb/hotel-5543-ibis-paris-avenue-d-italie-13eme/index.shtml Ibis] Avenue d'Italie.

* If you expect us to refund your travel, please bring a printed copy of your tickets, one that shows the total cost. If you are not in our reimbursement database, bring a printed IBAN too.

* On Saturday and Sunday, enter the Free HQ by the '''16 Rue de la Ville-l'Évêque''' ([http://goo.gl/EKHWEc plan]).
** There will be a smoking area inside the building, as the entrance cannot be used once inside the building for security reasons.

* There will be a WiFi connection.

= Schedule =
== Friday, August 30th 2013 ==
[[Image:Asterix VLC.svg|right|270px]]
Friday is an '''<u>optional</u>''' day in the Asterix amusement park to bind together our community. If you wish to attend, the meeting in front of the hotel is at 8:30.
There will be a bus that will be responsible for bringing everyone to and back from the park. More details on the park are available below.

Notes:
* that bus and park entrance fees are paid by us, so there are NO costs with the exception of food and drinks
* do not burden yourself too much with unneeded stuff and particularly '''don't bring your laptop'''!

{| class="wikitable" width="70%"
|-
! Time !! Place !! Description
|-
| 8h30 || [http://www.ibishotel.com/gb/hotel-5543-ibis-paris-avenue-d-italie-13eme/index.shtml Hotel] || Meeting point in front of the hotel
|-
| 10h00 – 18h00 || Visit to Asterix park
|-
| 21h00 || Meeting at a local bar, for the brave... || NB: VideoLAN will not pay for expenses at the bar...
|}

If you cannot be present at the meeting point, you will be able to join us directly there, but you '''MUST''' tell us. For reference here are directions to the park: Take RER B3 from Paris Gare du Nord, platform 43 and get off at “Aéroport Charles De Gaulle Terminal 1, Terminal 3”. Go to the “Parcs de Loisirs” counter and board the Parc Astérix shuttle buses.

== Saturday, August 31st 2013 ==
All the meetings happen in the '''auditorium'''.

=== Morning ===
Schedule information is not currently available.

{| class="wikitable" width="70%"
|-
! Time !! Description
|-
| 9h30 – 10h00 || Welcome, registration, coffee, juice and croissants
|-
| 10h00 – 10h15 || Welcome, VideoLAN, VLC
|-
| 10h20 – 10h45 || TBA
|-
| 10h45 – 11h15 || VLC and DCP
|-
| 11h15 – 11h30 || '''Coffee Break'''
|-
| 11h30 – 11h45 || x265
|-
| 11h45 – 12h05 || TBA
|-
| 12h05 – 12h30 || VLC 2.1.0 and next
|-
|}

=== Lunch ===
Individual tray meal (chicken, salmon, vegetarian or beef) with dessert and drinks.

=== UnConference ===
[[wikipedia:Unconference|What is an UnConference?]]

UnConference schedule to be published...
{| class="wikitable" width="70%"
|-
! Time !! B559 !! B555 !! B551 !! B549 !! B567 !! B312
|-
| 14h00 - 15h00 || TBA || TBA || TBA || || HACKING ROOM || N/A
|-
| 15h00 - 16h00 || TBA || TBA || || || HACKING ROOM || N/A
|-
| 16h00 - 17h00 || TBA ||  || TBA || || HACKING ROOM || N/A
|-
| 17h00 - 18h00 || || TBA || TBA || || HACKING ROOM || N/A
|-
| 18h00 - 19h00 || || TBA || TBA || || HACKING ROOM || N/A
|-
|}

=== Dinner ===
[http://www.tripadvisor.fr/Restaurant_Review-g187147-d2459770-Reviews-Restaurant_Du_Paradis-Paris_Ile_de_France.html Restaurant du Paradis]<br />
66 Rue du Faubourg Poissonniere<br />
75010 Paris<br />

Metro: Line 7, Poissonière

Starting at 20h00, dinner will consist of 2 special menus prepared by the chef. (drinks included - wine and non-alcoholic)

The menu will consist of 4 choices for starters, principal meal and deserts. There is also a vegan menu available.

== Sunday, September 1st 2013 ==
=== Morning ===
Schedule to be posted.
{| class="wikitable" width="70%"
|-
! Time !! B559 !! B555 !! B551 !! B549 !! B567 !! B312
|-
| 9h30 - 11h00 || TBD || TBD || || || HACKING ROOM || N/A
|-
| 11h00 - 12h00 || TBD || TBD  || || || HACKING ROOM || N/A
|-
| 12h00 - 13h00 || TBD || || || || HACKING ROOM || N/A
|-
|}
=== Lunch ===
Location: Cafeteria of Free HQ (a really beautiful and spacious place!)

'''Sandwiches''' with coleslaw or crisps and choices of drinks (including Dr Pepper) + desserts (Pecan pies, Oreo pies, lemon pies, or cheese cakes).

=== Afternoon ===
{| class="wikitable" width="70%"
|-
! Time !! B559 !! B555 !! B551 !! B549 !! B567 !! B312
|-
| 14h00 - 15h00 || TBD || || || || HACKING ROOM || N/A
|-
| 15h00 - 16h00 || Hack || TBD || TBD || || HACKING ROOM || N/A
|-
| 16h00 - 17h00 || Hack || TBD || Hack || Hack || HACKING ROOM || N/A
|-
| 17h00 - 18h00 || Hack || TBD || Hack || Hack || HACKING ROOM || N/A
|-
|}

= Places =

== Asterix Park ==
60128 Plailly, France<br />
Metro / RER: '''B3'''

http://www.parcasterix.fr/

== Free HQ ==
16 Rue de la Ville-l'Évêque<br />
75008 Paris, France ([http://goo.gl/EKHWEc plan])

Metro 8: Madeleine<br />
Metro 12: Madeleine<br />
Metro 14: Madeleine<br />

From CDG airport, take:<br />
the RER B (Paris by train) to Châtelet-les-Halles<br />
then Metro line 14 to Madeleine.

http://www.free.fr/

== Hotel Ibis ==
[http://www.ibishotel.com/gb/hotel-5543-ibis-paris-avenue-d-italie-13eme/index.shtml Hotel IBIS Paris Avenue d'Italie]<br />
15 bis Avenue d'Italie<br />
75013 Paris

== Emergencies ==

* In case of emergency you can call the European emergency number 112.
* To place a call most credit cards can be used directly in public phones.

[[Category:About VideoLAN]]

VDD13

2013-08-28T09:05:35Z

Etix: Add a plan

= VideoLAN Dev Days '13 =
'''The Multimedia Conference that frees the cone in you!'''

This is a technical un-conference, please bring laptops, cords, RJ45 cables, and a good mood with you.

=== Nota Bene ===
* The hotel is the [http://www.ibishotel.com/gb/hotel-5543-ibis-paris-avenue-d-italie-13eme/index.shtml Ibis] Avenue d'Italie.

* If you expect us to refund your travel, please bring a printed copy of your tickets, one that shows the total cost. If you are not in our reimbursement database, bring a printed IBAN too.

* On Saturday and Sunday, enter the Free HQ by the '''16 Rue de la Ville-l'Évêque'''.
** There will be a smoking area inside the building, as the entrance cannot be used once inside the building for security reasons.

* There will be a WiFi connection.

= Schedule =
== Friday, August 30th 2013 ==
[[Image:Asterix VLC.svg|right|270px]]
Friday is an '''<u>optional</u>''' day in the Asterix amusement park to bind together our community. If you wish to attend, the meeting in front of the hotel is at 8:30.
There will be a bus that will be responsible for bringing everyone to and back from the park. More details on the park are available below.

Notes:
* that bus and park entrance fees are paid by us, so there are NO costs with the exception of food and drinks
* do not burden yourself too much with unneeded stuff and particularly '''don't bring your laptop'''!

{| class="wikitable" width="70%"
|-
! Time !! Place !! Description
|-
| 8h30 || [http://www.ibishotel.com/gb/hotel-5543-ibis-paris-avenue-d-italie-13eme/index.shtml Hotel] || Meeting point in front of the hotel
|-
| 10h00 – 18h00 || Visit to Asterix park
|-
| 21h00 || Meeting at a local bar, for the brave... || NB: VideoLAN will not pay for expenses at the bar...
|}

If you cannot be present at the meeting point, you will be able to join us directly there, but you '''MUST''' tell us. For reference here are directions to the park: Take RER B3 from Paris Gare du Nord, platform 43 and get off at “Aéroport Charles De Gaulle Terminal 1, Terminal 3”. Go to the “Parcs de Loisirs” counter and board the Parc Astérix shuttle buses.

== Saturday, August 31st 2013 ==
All the meetings happen in the '''auditorium'''.

=== Morning ===
Schedule information is not currently available.

{| class="wikitable" width="70%"
|-
! Time !! Description
|-
| 9h30 – 10h00 || Welcome, registration, coffee, juice and croissants
|-
| 10h00 – 10h15 || Welcome, VideoLAN, VLC
|-
| 10h20 – 10h45 || TBA
|-
| 10h45 – 11h15 || VLC and DCP
|-
| 11h15 – 11h30 || '''Coffee Break'''
|-
| 11h30 – 11h45 || x265
|-
| 11h45 – 12h05 || TBA
|-
| 12h05 – 12h30 || VLC 2.1.0 and next
|-
|}

=== Lunch ===
Individual tray meal (chicken, salmon, vegetarian or beef) with dessert and drinks.

=== UnConference ===
[[wikipedia:Unconference|What is an UnConference?]]

UnConference schedule to be published...
{| class="wikitable" width="70%"
|-
! Time !! B559 !! B555 !! B551 !! B549 !! B567 !! B312
|-
| 14h00 - 15h00 || TBA || TBA || TBA || || HACKING ROOM || N/A
|-
| 15h00 - 16h00 || TBA || TBA || || || HACKING ROOM || N/A
|-
| 16h00 - 17h00 || TBA ||  || TBA || || HACKING ROOM || N/A
|-
| 17h00 - 18h00 || || TBA || TBA || || HACKING ROOM || N/A
|-
| 18h00 - 19h00 || || TBA || TBA || || HACKING ROOM || N/A
|-
|}

=== Dinner ===
[http://www.tripadvisor.fr/Restaurant_Review-g187147-d2459770-Reviews-Restaurant_Du_Paradis-Paris_Ile_de_France.html Restaurant du Paradis]<br />
66 Rue du Faubourg Poissonniere<br />
75010 Paris<br />

Metro: Line 7, Poissonière

Starting at 20h00, dinner will consist of 2 special menus prepared by the chef. (drinks included - wine and non-alcoholic)

The menu will consist of 4 choices for starters, principal meal and deserts. There is also a vegan menu available.

== Sunday, September 1st 2013 ==
=== Morning ===
Schedule to be posted.
{| class="wikitable" width="70%"
|-
! Time !! B559 !! B555 !! B551 !! B549 !! B567 !! B312
|-
| 9h30 - 11h00 || TBD || TBD || || || HACKING ROOM || N/A
|-
| 11h00 - 12h00 || TBD || TBD  || || || HACKING ROOM || N/A
|-
| 12h00 - 13h00 || TBD || || || || HACKING ROOM || N/A
|-
|}
=== Lunch ===
Location: Cafeteria of Free HQ (a really beautiful and spacious place!)

'''Sandwiches''' with coleslaw or crisps and choices of drinks (including Dr Pepper) + desserts (Pecan pies, Oreo pies, lemon pies, or cheese cakes).

=== Afternoon ===
{| class="wikitable" width="70%"
|-
! Time !! B559 !! B555 !! B551 !! B549 !! B567 !! B312
|-
| 14h00 - 15h00 || TBD || || || || HACKING ROOM || N/A
|-
| 15h00 - 16h00 || Hack || TBD || TBD || || HACKING ROOM || N/A
|-
| 16h00 - 17h00 || Hack || TBD || Hack || Hack || HACKING ROOM || N/A
|-
| 17h00 - 18h00 || Hack || TBD || Hack || Hack || HACKING ROOM || N/A
|-
|}

= Places =

== Asterix Park ==
60128 Plailly, France<br />
Metro / RER: '''B3'''

http://www.parcasterix.fr/

== Free HQ ==
16 Rue de la Ville-l'Évêque<br />
75008 Paris, France ([http://goo.gl/EKHWEc plan])

Metro 8: Madeleine<br />
Metro 12: Madeleine<br />
Metro 14: Madeleine<br />

From CDG airport, take:<br />
the RER B (Paris by train) to Châtelet-les-Halles<br />
then Metro line 14 to Madeleine.

http://www.free.fr/

== Hotel Ibis ==
[http://www.ibishotel.com/gb/hotel-5543-ibis-paris-avenue-d-italie-13eme/index.shtml Hotel IBIS Paris Avenue d'Italie]<br />
15 bis Avenue d'Italie<br />
75013 Paris

== Emergencies ==

* In case of emergency you can call the European emergency number 112.
* To place a call most credit cards can be used directly in public phones.

[[Category:About VideoLAN]]

VDD13

2013-08-28T09:00:01Z

Etix: Emergencies

= VideoLAN Dev Days '13 =
'''The Multimedia Conference that frees the cone in you!'''

This is a technical un-conference, please bring laptops, cords, RJ45 cables, and a good mood with you.

=== Nota Bene ===
* The hotel is the [http://www.ibishotel.com/gb/hotel-5543-ibis-paris-avenue-d-italie-13eme/index.shtml Ibis] Avenue d'Italie.

* If you expect us to refund your travel, please bring a printed copy of your tickets, one that shows the total cost. If you are not in our reimbursement database, bring a printed IBAN too.

* On Saturday and Sunday, enter the Free HQ by the '''16 Rue de la Ville-l'Évêque'''.
** There will be a smoking area inside the building, as the entrance cannot be used once inside the building for security reasons.

* There will be a WiFi connection.

= Schedule =
== Friday, August 30th 2013 ==
[[Image:Asterix VLC.svg|right|270px]]
Friday is an '''<u>optional</u>''' day in the Asterix amusement park to bind together our community. If you wish to attend, the meeting in front of the hotel is at 8:30.
There will be a bus that will be responsible for bringing everyone to and back from the park. More details on the park are available below.

Notes:
* that bus and park entrance fees are paid by us, so there are NO costs with the exception of food and drinks
* do not burden yourself too much with unneeded stuff and particularly '''don't bring your laptop'''!

{| class="wikitable" width="70%"
|-
! Time !! Place !! Description
|-
| 8h30 || [http://www.ibishotel.com/gb/hotel-5543-ibis-paris-avenue-d-italie-13eme/index.shtml Hotel] || Meeting point in front of the hotel
|-
| 10h00 – 18h00 || Visit to Asterix park
|-
| 21h00 || Meeting at a local bar, for the brave... || NB: VideoLAN will not pay for expenses at the bar...
|}

If you cannot be present at the meeting point, you will be able to join us directly there, but you '''MUST''' tell us. For reference here are directions to the park: Take RER B3 from Paris Gare du Nord, platform 43 and get off at “Aéroport Charles De Gaulle Terminal 1, Terminal 3”. Go to the “Parcs de Loisirs” counter and board the Parc Astérix shuttle buses.

== Saturday, August 31st 2013 ==
All the meetings happen in the '''auditorium'''.

=== Morning ===
Schedule information is not currently available.

{| class="wikitable" width="70%"
|-
! Time !! Description
|-
| 9h30 – 10h00 || Welcome, registration, coffee, juice and croissants
|-
| 10h00 – 10h15 || Welcome, VideoLAN, VLC
|-
| 10h20 – 10h45 || TBA
|-
| 10h45 – 11h15 || VLC and DCP
|-
| 11h15 – 11h30 || '''Coffee Break'''
|-
| 11h30 – 11h45 || x265
|-
| 11h45 – 12h05 || TBA
|-
| 12h05 – 12h30 || VLC 2.1.0 and next
|-
|}

=== Lunch ===
Individual tray meal (chicken, salmon, vegetarian or beef) with dessert and drinks.

=== UnConference ===
[[wikipedia:Unconference|What is an UnConference?]]

UnConference schedule to be published...
{| class="wikitable" width="70%"
|-
! Time !! B559 !! B555 !! B551 !! B549 !! B567 !! B312
|-
| 14h00 - 15h00 || TBA || TBA || TBA || || HACKING ROOM || N/A
|-
| 15h00 - 16h00 || TBA || TBA || || || HACKING ROOM || N/A
|-
| 16h00 - 17h00 || TBA ||  || TBA || || HACKING ROOM || N/A
|-
| 17h00 - 18h00 || || TBA || TBA || || HACKING ROOM || N/A
|-
| 18h00 - 19h00 || || TBA || TBA || || HACKING ROOM || N/A
|-
|}

=== Dinner ===
[http://www.tripadvisor.fr/Restaurant_Review-g187147-d2459770-Reviews-Restaurant_Du_Paradis-Paris_Ile_de_France.html Restaurant du Paradis]<br />
66 Rue du Faubourg Poissonniere<br />
75010 Paris<br />

Metro: Line 7, Poissonière

Starting at 20h00, dinner will consist of 2 special menus prepared by the chef. (drinks included - wine and non-alcoholic)

The menu will consist of 4 choices for starters, principal meal and deserts. There is also a vegan menu available.

== Sunday, September 1st 2013 ==
=== Morning ===
Schedule to be posted.
{| class="wikitable" width="70%"
|-
! Time !! B559 !! B555 !! B551 !! B549 !! B567 !! B312
|-
| 9h30 - 11h00 || TBD || TBD || || || HACKING ROOM || N/A
|-
| 11h00 - 12h00 || TBD || TBD  || || || HACKING ROOM || N/A
|-
| 12h00 - 13h00 || TBD || || || || HACKING ROOM || N/A
|-
|}
=== Lunch ===
Location: Cafeteria of Free HQ (a really beautiful and spacious place!)

'''Sandwiches''' with coleslaw or crisps and choices of drinks (including Dr Pepper) + desserts (Pecan pies, Oreo pies, lemon pies, or cheese cakes).

=== Afternoon ===
{| class="wikitable" width="70%"
|-
! Time !! B559 !! B555 !! B551 !! B549 !! B567 !! B312
|-
| 14h00 - 15h00 || TBD || || || || HACKING ROOM || N/A
|-
| 15h00 - 16h00 || Hack || TBD || TBD || || HACKING ROOM || N/A
|-
| 16h00 - 17h00 || Hack || TBD || Hack || Hack || HACKING ROOM || N/A
|-
| 17h00 - 18h00 || Hack || TBD || Hack || Hack || HACKING ROOM || N/A
|-
|}

= Places =

== Asterix Park ==
60128 Plailly, France<br />
Metro / RER: '''B3'''

http://www.parcasterix.fr/

== Free HQ ==
16 Rue de la Ville-l'Évêque<br />
75008 Paris, France

Metro 8: Madeleine<br />
Metro 12: Madeleine<br />
Metro 14: Madeleine<br />

From CDG airport, take:<br />
the RER B (Paris by train) to Châtelet-les-Halles<br />
then Metro line 14 to Madeleine.

http://www.free.fr/

== Hotel Ibis ==
[http://www.ibishotel.com/gb/hotel-5543-ibis-paris-avenue-d-italie-13eme/index.shtml Hotel IBIS Paris Avenue d'Italie]<br />
15 bis Avenue d'Italie<br />
75013 Paris

== Emergencies ==

* In case of emergency you can call the European emergency number 112.
* To place a call most credit cards can be used directly in public phones.

[[Category:About VideoLAN]]

VDD13

2013-08-28T08:47:26Z

Etix: /* Friday, August 30th 2013 */

= VideoLAN Dev Days '13 =
'''The Multimedia Conference that frees the cone in you!'''

This is a technical un-conference, please bring laptops, cords, RJ45 cables, and a good mood with you.

=== Nota Bene ===
* The hotel is the [http://www.ibishotel.com/gb/hotel-5543-ibis-paris-avenue-d-italie-13eme/index.shtml Ibis] Avenue d'Italie.

* If you expect us to refund your travel, please bring a printed copy of your tickets, one that shows the total cost. If you are not in our reimbursement database, bring a printed IBAN too.

* On Saturday and Sunday, enter the Free HQ by the '''16 Rue de la Ville-l'Évêque'''.
** There will be a smoking area inside the building, as the entrance cannot be used once inside the building for security reasons.

* There will be a WiFi connection.

= Schedule =
== Friday, August 30th 2013 ==
[[Image:Asterix VLC.svg|right|270px]]
Friday is an '''<u>optional</u>''' day in the Asterix amusement park to bind together our community. If you wish to attend, the meeting in front of the hotel is at 8:30.
There will be a bus that will be responsible for bringing everyone to and back from the park. More details on the park are available below.

Notes:
* that bus and park entrance fees are paid by us, so there are NO costs with the exception of food and drinks
* do not burden yourself too much with unneeded stuff and particularly '''don't bring your laptop'''!

{| class="wikitable" width="70%"
|-
! Time !! Place !! Description
|-
| 8h30 || [http://www.ibishotel.com/gb/hotel-5543-ibis-paris-avenue-d-italie-13eme/index.shtml Hotel] || Meeting point in front of the hotel
|-
| 10h00 – 18h00 || Visit to Asterix park
|-
| 21h00 || Meeting at a local bar, for the brave... || NB: VideoLAN will not pay for expenses at the bar...
|}

If you cannot be present at the meeting point, you will be able to join us directly there, but you '''MUST''' tell us. For reference here are directions to the park: Take RER B3 from Paris Gare du Nord, platform 43 and get off at “Aéroport Charles De Gaulle Terminal 1, Terminal 3”. Go to the “Parcs de Loisirs” counter and board the Parc Astérix shuttle buses.

== Saturday, August 31st 2013 ==
All the meetings happen in the '''auditorium'''.

=== Morning ===
Schedule information is not currently available.

{| class="wikitable" width="70%"
|-
! Time !! Description
|-
| 9h30 – 10h00 || Welcome, registration, coffee, juice and croissants
|-
| 10h00 – 10h15 || Welcome, VideoLAN, VLC
|-
| 10h20 – 10h45 || TBA
|-
| 10h45 – 11h15 || VLC and DCP
|-
| 11h15 – 11h30 || '''Coffee Break'''
|-
| 11h30 – 11h45 || x265
|-
| 11h45 – 12h05 || TBA
|-
| 12h05 – 12h30 || VLC 2.1.0 and next
|-
|}

=== Lunch ===
Individual tray meal (chicken, salmon, vegetarian or beef) with dessert and drinks.

=== UnConference ===
[[wikipedia:Unconference|What is an UnConference?]]

UnConference schedule to be published...
{| class="wikitable" width="70%"
|-
! Time !! B559 !! B555 !! B551 !! B549 !! B567 !! B312
|-
| 14h00 - 15h00 || TBA || TBA || TBA || || HACKING ROOM || N/A
|-
| 15h00 - 16h00 || TBA || TBA || || || HACKING ROOM || N/A
|-
| 16h00 - 17h00 || TBA ||  || TBA || || HACKING ROOM || N/A
|-
| 17h00 - 18h00 || || TBA || TBA || || HACKING ROOM || N/A
|-
| 18h00 - 19h00 || || TBA || TBA || || HACKING ROOM || N/A
|-
|}

=== Dinner ===
[http://www.tripadvisor.fr/Restaurant_Review-g187147-d2459770-Reviews-Restaurant_Du_Paradis-Paris_Ile_de_France.html Restaurant du Paradis]<br />
66 Rue du Faubourg Poissonniere<br />
75010 Paris<br />

Metro: Line 7, Poissonière

Starting at 20h00, dinner will consist of 2 special menus prepared by the chef. (drinks included - wine and non-alcoholic)

The menu will consist of 4 choices for starters, principal meal and deserts. There is also a vegan menu available.

== Sunday, September 1st 2013 ==
=== Morning ===
Schedule to be posted.
{| class="wikitable" width="70%"
|-
! Time !! B559 !! B555 !! B551 !! B549 !! B567 !! B312
|-
| 9h30 - 11h00 || TBD || TBD || || || HACKING ROOM || N/A
|-
| 11h00 - 12h00 || TBD || TBD  || || || HACKING ROOM || N/A
|-
| 12h00 - 13h00 || TBD || || || || HACKING ROOM || N/A
|-
|}
=== Lunch ===
Location: Cafeteria of Free HQ (a really beautiful and spacious place!)

'''Sandwiches''' with coleslaw or crisps and choices of drinks (including Dr Pepper) + desserts (Pecan pies, Oreo pies, lemon pies, or cheese cakes).

=== Afternoon ===
{| class="wikitable" width="70%"
|-
! Time !! B559 !! B555 !! B551 !! B549 !! B567 !! B312
|-
| 14h00 - 15h00 || TBD || || || || HACKING ROOM || N/A
|-
| 15h00 - 16h00 || Hack || TBD || TBD || || HACKING ROOM || N/A
|-
| 16h00 - 17h00 || Hack || TBD || Hack || Hack || HACKING ROOM || N/A
|-
| 17h00 - 18h00 || Hack || TBD || Hack || Hack || HACKING ROOM || N/A
|-
|}

= Places =

== Asterix Park ==
60128 Plailly, France<br />
Metro / RER: '''B3'''

http://www.parcasterix.fr/

== Free HQ ==
16 Rue de la Ville-l'Évêque<br />
75008 Paris, France

Metro 8: Madeleine<br />
Metro 12: Madeleine<br />
Metro 14: Madeleine<br />

From CDG airport, take:<br />
the RER B (Paris by train) to Châtelet-les-Halles<br />
then Metro line 14 to Madeleine.

http://www.free.fr/

== Hotel Ibis ==
[http://www.ibishotel.com/gb/hotel-5543-ibis-paris-avenue-d-italie-13eme/index.shtml Hotel IBIS Paris Avenue d'Italie]<br />
15 bis Avenue d'Italie<br />
75013 Paris

[[Category:About VideoLAN]]

VDD13

2013-08-28T08:43:52Z

Etix: /* Friday, August 30th 2013 */

= VideoLAN Dev Days '13 =
'''The Multimedia Conference that frees the cone in you!'''

This is a technical un-conference, please bring laptops, cords, RJ45 cables, and a good mood with you.

=== Nota Bene ===
* The hotel is the [http://www.ibishotel.com/gb/hotel-5543-ibis-paris-avenue-d-italie-13eme/index.shtml Ibis] Avenue d'Italie.

* If you expect us to refund your travel, please bring a printed copy of your tickets, one that shows the total cost. If you are not in our reimbursement database, bring a printed IBAN too.

* On Saturday and Sunday, enter the Free HQ by the '''16 Rue de la Ville-l'Évêque'''.
** There will be a smoking area inside the building, as the entrance cannot be used once inside the building for security reasons.

* There will be a WiFi connection.

= Schedule =
== Friday, August 30th 2013 ==
[[Image:Asterix VLC.svg|right|270px]]
Friday is an '''<u>optional</u>''' day in the Asterix amusement park to bind together our community. If you wish to attend, the meeting in front of the hotel is at 8:30.
There will be a bus that will be responsible for bringing everyone to and back from the park. More details on the park are available below.

Notes:
* that bus and park entrance fees are paid by us, so there are NO costs for you.
* do not burden yourself too much with unneeded stuff and particularly '''don't bring your laptop'''!

{| class="wikitable" width="70%"
|-
! Time !! Place !! Description
|-
| 8h30 || [http://www.ibishotel.com/gb/hotel-5543-ibis-paris-avenue-d-italie-13eme/index.shtml Hotel] || Meeting point in front of the hotel
|-
| 10h00 – 18h00 || Visit to Asterix park
|-
| 21h00 || Meeting at a local bar, for the brave... || NB: VideoLAN will not pay for expenses at the bar...
|}

If you cannot be present at the meeting point, you will be able to join us directly there, but you '''MUST''' tell us. For reference here are directions to the park: Take RER B3 from Paris Gare du Nord, platform 43 and get off at “Aéroport Charles De Gaulle Terminal 1, Terminal 3”. Go to the “Parcs de Loisirs” counter and board the Parc Astérix shuttle buses.

== Saturday, August 31st 2013 ==
All the meetings happen in the '''auditorium'''.

=== Morning ===
Schedule information is not currently available.

{| class="wikitable" width="70%"
|-
! Time !! Description
|-
| 9h30 – 10h00 || Welcome, registration, coffee, juice and croissants
|-
| 10h00 – 10h15 || Welcome, VideoLAN, VLC
|-
| 10h20 – 10h45 || TBA
|-
| 10h45 – 11h15 || VLC and DCP
|-
| 11h15 – 11h30 || '''Coffee Break'''
|-
| 11h30 – 11h45 || x265
|-
| 11h45 – 12h05 || TBA
|-
| 12h05 – 12h30 || VLC 2.1.0 and next
|-
|}

=== Lunch ===
Individual tray meal (chicken, salmon, vegetarian or beef) with dessert and drinks.

=== UnConference ===
[[wikipedia:Unconference|What is an UnConference?]]

UnConference schedule to be published...
{| class="wikitable" width="70%"
|-
! Time !! B559 !! B555 !! B551 !! B549 !! B567 !! B312
|-
| 14h00 - 15h00 || TBA || TBA || TBA || || HACKING ROOM || N/A
|-
| 15h00 - 16h00 || TBA || TBA || || || HACKING ROOM || N/A
|-
| 16h00 - 17h00 || TBA ||  || TBA || || HACKING ROOM || N/A
|-
| 17h00 - 18h00 || || TBA || TBA || || HACKING ROOM || N/A
|-
| 18h00 - 19h00 || || TBA || TBA || || HACKING ROOM || N/A
|-
|}

=== Dinner ===
[http://www.tripadvisor.fr/Restaurant_Review-g187147-d2459770-Reviews-Restaurant_Du_Paradis-Paris_Ile_de_France.html Restaurant du Paradis]<br />
66 Rue du Faubourg Poissonniere<br />
75010 Paris<br />

Metro: Line 7, Poissonière

Starting at 20h00, dinner will consist of 2 special menus prepared by the chef. (drinks included - wine and non-alcoholic)

The menu will consist of 4 choices for starters, principal meal and deserts. There is also a vegan menu available.

== Sunday, September 1st 2013 ==
=== Morning ===
Schedule to be posted.
{| class="wikitable" width="70%"
|-
! Time !! B559 !! B555 !! B551 !! B549 !! B567 !! B312
|-
| 9h30 - 11h00 || TBD || TBD || || || HACKING ROOM || N/A
|-
| 11h00 - 12h00 || TBD || TBD  || || || HACKING ROOM || N/A
|-
| 12h00 - 13h00 || TBD || || || || HACKING ROOM || N/A
|-
|}
=== Lunch ===
Location: Cafeteria of Free HQ (a really beautiful and spacious place!)

'''Sandwiches''' with coleslaw or crisps and choices of drinks (including Dr Pepper) + desserts (Pecan pies, Oreo pies, lemon pies, or cheese cakes).

=== Afternoon ===
{| class="wikitable" width="70%"
|-
! Time !! B559 !! B555 !! B551 !! B549 !! B567 !! B312
|-
| 14h00 - 15h00 || TBD || || || || HACKING ROOM || N/A
|-
| 15h00 - 16h00 || Hack || TBD || TBD || || HACKING ROOM || N/A
|-
| 16h00 - 17h00 || Hack || TBD || Hack || Hack || HACKING ROOM || N/A
|-
| 17h00 - 18h00 || Hack || TBD || Hack || Hack || HACKING ROOM || N/A
|-
|}

= Places =

== Asterix Park ==
60128 Plailly, France<br />
Metro / RER: '''B3'''

http://www.parcasterix.fr/

== Free HQ ==
16 Rue de la Ville-l'Évêque<br />
75008 Paris, France

Metro 8: Madeleine<br />
Metro 12: Madeleine<br />
Metro 14: Madeleine<br />

From CDG airport, take:<br />
the RER B (Paris by train) to Châtelet-les-Halles<br />
then Metro line 14 to Madeleine.

http://www.free.fr/

== Hotel Ibis ==
[http://www.ibishotel.com/gb/hotel-5543-ibis-paris-avenue-d-italie-13eme/index.shtml Hotel IBIS Paris Avenue d'Italie]<br />
15 bis Avenue d'Italie<br />
75013 Paris

[[Category:About VideoLAN]]

Win32compile

2013-08-26T10:35:33Z

Etix: Redirected page to Win32Compile

#REDIRECT [[Win32Compile]]

Mirrors

2013-08-01T09:01:33Z

Etix: CDN

Mirrors

2013-04-04T17:13:27Z

Etix:

Mirrors

2013-04-04T13:29:54Z

Etix: Created page with "= Mirrors = Our mirrors are kindly operated by sponsors, you can find the complete list [http://www.videolan.org/videolan/mirrors.html here]. If you would like to provide a m..."

MediaWiki:Common.css

2013-04-04T13:18:43Z

Etix: Disable the cone next to links.

/* Styling links to www.VideoLan.org */
/*#bodyContent a.external, #bodyContent a[href^="http://www.videolan.org/"] {
-moz-background-clip:border;
-moz-background-inline-policy:continuous;
-moz-background-origin:padding;
background:transparent url(//www.videolan.org/favicon.ico) no-repeat scroll right center;
padding-right:13px;
}*/

SoC 2013

2013-02-14T15:28:38Z

Etix: MSI project

'''SoC 2013 ideas. This is an ideas page only.'''

This wiki page covers the work of the [[VideoLAN]] project as a mentoring organization for [http://code.google.com/soc/ Google Summer of Code], in order to improve {{VLC}}.

== Introduction & Information ==

This wiki page covers the attempt by the [[VideoLAN]] project to act as a mentoring organization for [http://code.google.com/soc/ Google Summer of Code], in order to improve {{VLC}}.

[[VideoLAN]] was a mentoring organization in [[SoC 2007|2007]], [[SoC 2008|2008]], [[SoC 2009|2009]], [[SoC 2010|2010]] and [[SoC 2011|2011]].

*This page list the ideas for VLC

=== VLC media player ===

{{VLC}} is a cross-platform multimedia player, encoder and streamer application. It is one of the most successful open-source projects without any professional structure underneath.

{{VLC}} is downloaded at an approximate monthly rate of 5 millions from the main website and that's not including third-party distributions (Linux)!

You can find more information on [http://en.wikipedia.org/wiki/VLC_media_player VLC on Wikipedia] or on this [[Main Page|wiki]].

=== Summer of Code ===

If selected and developed, SoC projects for VLC will be included in later releases.

All projects are covered by the GPL (v2+) or LGPL (v2.1+) licenses depending on the module and student wishes.

== Ideas ==
=== VLC ===

'''''Read this'''''

This page is split in three lists of ideas:

#The ''main ideas'' are what seem to be ''key projects'' for VLC and should be more ''thrilling'' than the other ones; we have assigned a potential mentor to each of these.
#The other ideas are less detailed but could be good ideas too.
#[[Mini Projects]] are short-span projects which can be given as Qualification tasks or extended to be Full Summer of Code project.

*'''Original good ideas will be valued'''. Last year, half of the ideas were given by students. We don't want to impose anything. This is free and Open Source software.

If you don't want to apply for SoC but want other ideas to develop on, check the [[Mini Projects]] page!

And on the IRC channel, you can have even more ideas.

== Key ideas for VLC ==

=== New Audio Filters ===

We are looking for a skilled '''audiophile''' that knows a lot about audio theory and practice:

*to create or implement new algorithms, like SRS WoW or other 3D effects
*to work on channels mixing,
*to work on tracks mixing,
*to create scriptable new audio filters in lua and enable users to create whatever audio filtering function they want in a Lua script.
*LADSPA or other libraries integration will be interesting.

This project needs some good audio knowledge and good C experience.

''Qualification task'': port any audio filter from MPlayer

''Proposed mentor: [[User:Geal|geal]]''

=== Porting Audio Filters ===

We are looking for a skilled '''audiophile''' that knows a lot about audio theory and practice:
* to port open source algorithm for audio filters to VLC.

This project needs some good audio knowledge and good C experience.

''Proposed mentor: [[User:Geal|geal]]''

=== UPNP DLNA Server and Client ===

Test and fix service discovery module for UPNP/DLNA shares done by software (mediatomb, xbmc, etc) and hardware implementations.

Provide DLNA plugin for DLNA server compliant with opensource (xbmc, djmount, etc) and proprietary (PS3, xbox360, etc) DLNA clients. Some of the work is already done by previous SoC students.

The plugin must be smart enough to provide "presets" for known DLNA media clients with limited features (PS3 or XBOX360 for starters) which require additional quirks or hacks or items to be transcoded or streamed.

Requires some VLC knowledge as the project will involve using Media Library (arriving in vlc 1.2) and transcoding with VLC API.

''Proposed mentor: thresh''

=== Assembly optimizations in VLC ===

If you are fond of writing ASM and you are fluent in MMX/SSE2/SSE4, there are many interesting things in VLC to speed up.

* Profiling VLC.
* memcpy implementations in SSE* and MMX (see modules/misc/memcpy/fastmemcpy.h)
* video filters ASM speedups (see modules/video_filter/blend.c)
* audio filters ASM speedups (see modules/audio_filter/equalizer.c)
* Porting other ASM video filters to VLC.

This project needs some good ASM knowledge and good C experience.

*Stuff to read: http://www.agner.org/optimize/

''Proposed mentor: [[User:J-b|jb]]''

=== VLC Android Port ===

Improve the current VLC for [http://git.videolan.org/?p=vlc/vlc-ports/android.git;a=summary Android].

''Proposed mentors: [[User:etix|etix]]''

=== VLC Test Suite ===

This project aims at making automatic tests to improve VLC quality.

*Write a series of tests for vlc-internal
*Integrate a framework for automated plugins testing with the automake build system
*Automate the different codec playback/mux/etc tests
*Automate the subtitles tests
*Write tests for the different bindings: Mac OS X Framework/Python Bindings... etc.

This project is a code project, require good knowledge of C

''Proposed mentor: Rémi''

=== VLC Personal Cloud Project 2.0 ===

The personal cloud project is a simple project to allow people to play their media files anywhere in the world.

Through the http interface of VLC, a user can:

*list the medias from the Media Library,
*play those medias,
*those medias get transcoded and streamed in:
**Flash
**Silverlight
**iPhone format
**Android format
**html5
**A VLC webplugin

A good example of the aim is http://www.vodobox.c.la/

This project has to work on the configuration and NAT traversal.

This projects needs knowledge in HTML and JS; it might require C coding.

''Proposed mentor: jb''

=== Playlist improvements ===

We need to reinforce the media library capabilities and its integration with external metadata sources, notably for TV shows.

''Proposed mentor: jetru''

=== AirPlay streaming ===

We need to be able to stream everything to your Apple TV.

'''Proposed mentor'''

=== MSI Windows Installer ===

The goal of this project is to improve and stabilize the upcoming default installer for the Windows platform. You'll have to work with the [http://wixtoolset.org Wix] toolkit and the autotools building system.

''Proposed mentor: [[User:etix|etix]]''

== Other Ideas for VLC ==

=== Improve messages display ===
When VLC has a problem opening or playing files it shows a messages window on top of the player with the error. This can be annoying if the screen is being controlled remotely as the user has to manually dismiss the message. There are various ways this could be improved:
#Update UI so that messages window will auto-dismiss after x seconds unless it is clicked on (this could be optional behaviour). Clicking on the window would cancel the countdown. If the window was selected from the menu, it would not auto-dismiss.
#Mac OS: Display messages using notification system (if available). Clicking on the notification would open the messages window.
''Suggested by : Confused Vorlon. Proposed mentor: ?''

=== WTV support ===
Wtv format support
''Proposed mentor: Laurent''

=== DVD audio support ===
Very difficult project for Audio fans
''Proposed mentor: jb''

=== Device synchronisation===
Sync your mp3 player with the media library
''Proposed mentor: jetru''

=== HD DVD support ===
Very difficult project for someone having the right hardware
''Proposed mentor: jb''

=== Multi-Angle DVD support ===
We need multi-angle DVD support
''Proposed mentor: Meuuh''

=== VLM UI for the Mac OS X interface ===
Implement an easy-to-use, yet customizable and complete UI for the VideoLAN Media Manager, which allows VLC to stream multiple unicast, multicast and Video-on-Demand streams within a single instance.
You will need a Mac running OS X 10.6 or later and Cocoa programming experience. A basic understanding of media streams is definitely preferable.
Note that this task is too small for an entire summer and should be combined with another topic.
''Proposed mentor: feepk''

== Ideas for VLMC ==

=== VLMC port fixes ===
Fix VLMC building and basic features for Mac OSX, Windows and GNU/Linux. The present code is not in sync with current libvlc, for example it has build failures in some cases and vout is broken on OSX. It's been more than two years since last VLMC release. The task is to fix major blockers and help release version:

- Understand the code, learn about the community and get started (proposed time: 2-3 weeks)
- Fix build system and port specific issues on OSX and GNU/Linux (and Windows as well) (proposed time: 2-3 weeks)
- Fix vout and aout issues for both project and preview rendering (proposed time: 2 weeks)
- Fix blockers for video editing workflow: importing, editing, applying effects (basic ones), project management, saving/reading projects, exporting video as file and to YouTube (proposed time: rest of the time)
''Proposed mentor: bhaisaab''

{{GSoC}}

SoC 2013

2013-02-14T15:23:06Z

Etix:

'''SoC 2013 ideas. This is an ideas page only.'''

This wiki page covers the work of the [[VideoLAN]] project as a mentoring organization for [http://code.google.com/soc/ Google Summer of Code], in order to improve {{VLC}}.

== Introduction & Information ==

This wiki page covers the attempt by the [[VideoLAN]] project to act as a mentoring organization for [http://code.google.com/soc/ Google Summer of Code], in order to improve {{VLC}}.

[[VideoLAN]] was a mentoring organization in [[SoC 2007|2007]], [[SoC 2008|2008]], [[SoC 2009|2009]], [[SoC 2010|2010]] and [[SoC 2011|2011]].

*This page list the ideas for VLC

=== VLC media player ===

{{VLC}} is a cross-platform multimedia player, encoder and streamer application. It is one of the most successful open-source projects without any professional structure underneath.

{{VLC}} is downloaded at an approximate monthly rate of 5 millions from the main website and that's not including third-party distributions (Linux)!

You can find more information on [http://en.wikipedia.org/wiki/VLC_media_player VLC on Wikipedia] or on this [[Main Page|wiki]].

=== Summer of Code ===

If selected and developed, SoC projects for VLC will be included in later releases.

All projects are covered by the GPL (v2+) or LGPL (v2.1+) licenses depending on the module and student wishes.

== Ideas ==
=== VLC ===

'''''Read this'''''

This page is split in three lists of ideas:

#The ''main ideas'' are what seem to be ''key projects'' for VLC and should be more ''thrilling'' than the other ones; we have assigned a potential mentor to each of these.
#The other ideas are less detailed but could be good ideas too.
#[[Mini Projects]] are short-span projects which can be given as Qualification tasks or extended to be Full Summer of Code project.

*'''Original good ideas will be valued'''. Last year, half of the ideas were given by students. We don't want to impose anything. This is free and Open Source software.

If you don't want to apply for SoC but want other ideas to develop on, check the [[Mini Projects]] page!

And on the IRC channel, you can have even more ideas.

== Key ideas for VLC ==

=== New Audio Filters ===

We are looking for a skilled '''audiophile''' that knows a lot about audio theory and practice:

*to create or implement new algorithms, like SRS WoW or other 3D effects
*to work on channels mixing,
*to work on tracks mixing,
*to create scriptable new audio filters in lua and enable users to create whatever audio filtering function they want in a Lua script.
*LADSPA or other libraries integration will be interesting.

This project needs some good audio knowledge and good C experience.

''Qualification task'': port any audio filter from MPlayer

''Proposed mentor: [[User:Geal|geal]]''

=== Porting Audio Filters ===

We are looking for a skilled '''audiophile''' that knows a lot about audio theory and practice:
* to port open source algorithm for audio filters to VLC.

This project needs some good audio knowledge and good C experience.

''Proposed mentor: [[User:Geal|geal]]''

=== UPNP DLNA Server and Client ===

Test and fix service discovery module for UPNP/DLNA shares done by software (mediatomb, xbmc, etc) and hardware implementations.

Provide DLNA plugin for DLNA server compliant with opensource (xbmc, djmount, etc) and proprietary (PS3, xbox360, etc) DLNA clients. Some of the work is already done by previous SoC students.

The plugin must be smart enough to provide "presets" for known DLNA media clients with limited features (PS3 or XBOX360 for starters) which require additional quirks or hacks or items to be transcoded or streamed.

Requires some VLC knowledge as the project will involve using Media Library (arriving in vlc 1.2) and transcoding with VLC API.

''Proposed mentor: thresh''

=== Assembly optimizations in VLC ===

If you are fond of writing ASM and you are fluent in MMX/SSE2/SSE4, there are many interesting things in VLC to speed up.

* Profiling VLC.
* memcpy implementations in SSE* and MMX (see modules/misc/memcpy/fastmemcpy.h)
* video filters ASM speedups (see modules/video_filter/blend.c)
* audio filters ASM speedups (see modules/audio_filter/equalizer.c)
* Porting other ASM video filters to VLC.

This project needs some good ASM knowledge and good C experience.

*Stuff to read: http://www.agner.org/optimize/

''Proposed mentor: [[User:J-b|jb]]''

=== VLC Android Port ===

Improve the current VLC for [http://git.videolan.org/?p=vlc/vlc-ports/android.git;a=summary Android].

''Proposed mentors: [[User:etix|etix]]''

=== VLC Test Suite ===

This project aims at making automatic tests to improve VLC quality.

*Write a series of tests for vlc-internal
*Integrate a framework for automated plugins testing with the automake build system
*Automate the different codec playback/mux/etc tests
*Automate the subtitles tests
*Write tests for the different bindings: Mac OS X Framework/Python Bindings... etc.

This project is a code project, require good knowledge of C

''Proposed mentor: Rémi''

=== VLC Personal Cloud Project 2.0 ===

The personal cloud project is a simple project to allow people to play their media files anywhere in the world.

Through the http interface of VLC, a user can:

*list the medias from the Media Library,
*play those medias,
*those medias get transcoded and streamed in:
**Flash
**Silverlight
**iPhone format
**Android format
**html5
**A VLC webplugin

A good example of the aim is http://www.vodobox.c.la/

This project has to work on the configuration and NAT traversal.

This projects needs knowledge in HTML and JS; it might require C coding.

''Proposed mentor: jb''

=== Playlist improvements ===

We need to reinforce the media library capabilities and its integration with external metadata sources, notably for TV shows.

''Proposed mentor: jetru''

=== AirPlay streaming ===

We need to be able to stream everything to your Apple TV.

'''Proposed mentor'''

== Other Ideas for VLC ==

=== Improve messages display ===
When VLC has a problem opening or playing files it shows a messages window on top of the player with the error. This can be annoying if the screen is being controlled remotely as the user has to manually dismiss the message. There are various ways this could be improved:
#Update UI so that messages window will auto-dismiss after x seconds unless it is clicked on (this could be optional behaviour). Clicking on the window would cancel the countdown. If the window was selected from the menu, it would not auto-dismiss.
#Mac OS: Display messages using notification system (if available). Clicking on the notification would open the messages window.
''Suggested by : Confused Vorlon. Proposed mentor: ?''

=== WTV support ===
Wtv format support
''Proposed mentor: Laurent''

=== DVD audio support ===
Very difficult project for Audio fans
''Proposed mentor: jb''

=== Device synchronisation===
Sync your mp3 player with the media library
''Proposed mentor: jetru''

=== HD DVD support ===
Very difficult project for someone having the right hardware
''Proposed mentor: jb''

=== Multi-Angle DVD support ===
We need multi-angle DVD support
''Proposed mentor: Meuuh''

=== VLM UI for the Mac OS X interface ===
Implement an easy-to-use, yet customizable and complete UI for the VideoLAN Media Manager, which allows VLC to stream multiple unicast, multicast and Video-on-Demand streams within a single instance.
You will need a Mac running OS X 10.6 or later and Cocoa programming experience. A basic understanding of media streams is definitely preferable.
Note that this task is too small for an entire summer and should be combined with another topic.
''Proposed mentor: feepk''

== Ideas for VLMC ==

=== VLMC port fixes ===
Fix VLMC building and basic features for Mac OSX, Windows and GNU/Linux. The present code is not in sync with current libvlc, for example it has build failures in some cases and vout is broken on OSX. It's been more than two years since last VLMC release. The task is to fix major blockers and help release version:

- Understand the code, learn about the community and get started (proposed time: 2-3 weeks)
- Fix build system and port specific issues on OSX and GNU/Linux (and Windows as well) (proposed time: 2-3 weeks)
- Fix vout and aout issues for both project and preview rendering (proposed time: 2 weeks)
- Fix blockers for video editing workflow: importing, editing, applying effects (basic ones), project management, saving/reading projects, exporting video as file and to YouTube (proposed time: rest of the time)
''Proposed mentor: bhaisaab''

{{GSoC}}

Documentation:WebPlugin

2013-01-02T16:56:14Z

Etix: Update the toolbar option

This Documentation speaks about the {{VLC}} Web plugins and how to write pages for it.
{{RightMenu|documentation play howto toc}}

= Introduction: Building Web pages with Video =

The {{VLC}} webplugins are native browser plugins, similar to Flash or Silverlight plugins and allow playback inside the browser of all the videos that {{VLC}} can read.

Additionally to viewing video on all pages, you can build custom pages that will use the advanced features of the plugin, using Javascript functions to control playback or extract information from the plugin.

There are 2 main plugins: one is ActiveX for IE, the other is NPAPI for the other browsers. They feature the same amount of features.

In older versions, those plugins were very crashy. '''We URGE YOU''' to use VLC '''2.0.0''' or newer versions.

=== Browsers support ===
It has been tested with:
{| class="wikitable"
|-
| Mozilla Firefox || [[Image:Firefox-logo.png|40x40px]]
|-
| Internet Explorer || [[Image:20101105053305!Internet Explorer 9.png|40x40px]]
|-
| Safari || [[Image:Apple Safari.png|40x40px]]
|-
| Chrome ||
|-
| Konqueror ||
|-
| Opera ||
|}

It has been tested on GNU/Linux, Windows and MacOS.

= Embed tag attributes =

To embed the plugin into a webpage use the following <embed> template:

<syntaxhighlight lang="javascript" line>
<embed type="application/x-vlc-plugin" pluginspage="http://www.videolan.org" />
<object classid="clsid:9BE31822-FDAD-461B-AD51-BE1D1C159921" codebase="http://download.videolan.org/pub/videolan/vlc/last/win32/axvlc.cab"></object>
</syntaxhighlight>

=== Required elements ===
These are '''required''' attributes for the <embed> tag:

*'''width''': Specifies the width of the plugin.
*'''height''': Specifies the height of the plugin.
*'''target''' (or one of these alias: '''mrl''', '''filename''', '''src'''): Specifies the source location (URL) of the video to load.

=== Optionnal elements ===
These are additional attributes for the <embed> tag:

*'''autoplay''', '''autostart''': Specifies whether the plugin starts playing on load. Default: ''true''
*'''allowfullscreen''': (since VLC version 1.2.0) Specifies whether the user can switch into fullscreen mode. Default: ''true''
*'''windowless''': (since VLC version 2.0.6) Draw the video on a window-less (non-accelerated) surface and allow styling (CSS overlay, 3D transformations, and much more). Default: ''false''
*'''mute''': Specifies whether the audio volume is initially muted. Default: ''false''
*'''loop''', '''autoloop''': Specifies whether the video loops on end. Default: ''false''
*'''controls''' (or '''toolbar'''): Specifies whether the controls are shown by default. Default: ''true''
*'''bgcolor''': Specifies the background color of the video player. Default: ''#000000''

=== Normal DOM elements ===
*'''id''': DOM id
*'''name''': DOM name

= Javascript API description =

The vlc plugin exports several objects that can be accessed for setting and getting information. When used improperly the API's will throw an exception that includes a string that explains what happened. For example when asking for vlc.input.length when there is no playlist item playing.

== VLC objects ==
The vlc plugin knows the following objects:

*'''audio''': Access audio properties.
*'''input''': Access input properties.
*'''playlist''': Access playlist properties.
*'''subtitle''': Access subtitle properties.
*'''video''': Access video properties.
**'''video.marquee''': Access marquee video filter properties.
**'''video.logo''': Access logo video filter properties.
*'''mediaDescription''': Access media info properties (only available in vlc version >= 2.0.2).

The following are deprecated:
*'''log''': Access log properties (only available in vlc version <= 1.0.0-rc1).
*'''messages''': Access to log message properties (only available in vlc version <= 1.0.0-rc1).
*'''iterator''': Access to log iterator properties (only available in vlc version <= 1.0.0-rc1).
*'''message''': Access to log message properties (only available in vlc version <= 1.0.0-rc1).

=== Example ===
The following JavaScript code shows howto get a reference to the vlc plugin. This reference can then be used to access the objects of the vlc plugin.

<syntaxhighlight lang="html5" line>
<html>
<title>VLC Mozilla plugin test page</title>
<body>
<embed type="application/x-vlc-plugin" pluginspage="http://www.videolan.org"
width="640"
height="480"
id="vlc">
</embed>
<script language="Javascript">
</syntaxhighlight><syntaxhighlight lang="javascript" line>

</syntaxhighlight><syntaxhighlight lang="html5" line>
</script>
</body>
</html>
</syntaxhighlight>

== Root object ==

readonly properties

*'''VersionInfo''': returns version information string

read/write properties

*''none''

methods

*'''vlc.versionInfo()''': returns version information string (same as VersionInfo)

*'''vlc.addEventListener(eventname, callback, bubble)''': (only for Mozilla) add a listener for mentioned event name, callback expects a function and bubble influences the order of eventhandling by JS (usually it is set to false).
*'''vlc.removeEventListener(eventname, callback, bubble)''': (only for Mozilla) remove listener for mentioned event name, callback expects a function and bubble influences the order of eventhandling by JS (usually it is set to false).

*'''vlc.attachEvent(eventname, callback)''': (only for ActiveX) add listener for mentioned event name, callback expects a function
*'''vlc.removeEvent(eventname, callback)''': (only for ActiveX) remove listener for mentioned event name, callback expects a function

events

*'''MediaPlayerNothingSpecial''': vlc is in idle state doing nothing but waiting for a command to be issued
*'''MediaPlayerOpening''': vlc is opening an media resource locator (MRL)
*'''MediaPlayerBuffering''': vlc is buffering
*'''MediaPlayerPlaying''': vlc is playing a media
*'''MediaPlayerPaused''': vlc is in paused state
*'''MediaPlayerForward''': vlc is fastforwarding through the media (works only when an input supports forward playback)
*'''MediaPlayerBackward''': vlc is going backwards through the media (works only when an input supports backwards playback)
*'''MediaPlayerEncounteredError''': vlc has encountered an error and is unable to continue
*'''MediaPlayerEndReached''': vlc has reached the end of current playlist
*'''MediaPlayerTimeChanged''': time has changed
*'''MediaPlayerPositionChanged''': media position has changed
*'''MediaPlayerSeekableChanged''': media seekable flag has changed (true means media is seekable, false means it is not)
*'''MediaPlayerPausableChanged''': media pausable flag has changed (true means media is pauseable, false means it is not)

=== Example ===
The following code snippet provides easy functions to register and unregister event callbacks on all supported platforms (currently only Linux mozilla based browsers and windows activeX objects for Internet Explorer).

<syntaxhighlight lang="html5" line>
<script language="javascript">
</syntaxhighlight><syntaxhighlight lang="javascript" line>

</syntaxhighlight><syntaxhighlight lang="html5" line>
</script>
</syntaxhighlight>

== Audio object ==

readonly properties

*'''vlc.audio.count''': (supported in vlc version >= 1.1.0) returns the number of audio track available.

read/write properties

*'''vlc.audio.mute''': boolean value to mute and unmute the audio.
*'''vlc.audio.volume''': a value between [0-200] which indicates a percentage of the volume.
*'''vlc.audio.track''': (supported in vlc version > 0.8.6) a value between [1-65535] which indicates the audio track to play or that is playing. a value of 0 means the audio is/will be disabled.
*'''vlc.audio.channel''': (supported in vlc version > 0.8.6) integer value between [1-5] that indicates which audio channel mode is used, values can be: "1=stereo", "2=reverse stereo", "3=left", "4=right", "5=dolby". Use vlc.audio.channel to check if setting of the audio channel mode has succeeded.

methods

*'''vlc.audio.toggleMute()''': boolean toggle that mutes and unmutes the audio based upon the previous state.
*'''vlc.audio.description(int i)''': (supported in vlc version >= 1.1.0) give the i-th audio track name. 0 corresponds to disable and 1 to the first audio track.

=== Example ===

<syntaxhighlight lang="html5" line>
Audio Channel:
<select readonly onChange='doAudioChannel(this.value)'>
<option value=1>Stereo</option>
<option value=2>Reverse stereo</option>
<option value=3>Left</option>
<option value=4>Right</option>
<option value=5>Dolby</option>
</select>
</syntaxhighlight>
<br />
<syntaxhighlight lang="javascript" line>
<script language="javascript">

</script>
</syntaxhighlight>

== Input object ==

readonly properties

*'''vlc.input.length''': length of the input file in number of milliseconds. 0 is returned for 'live' streams or clips whose length cannot be determined by VLC. It returns -1 if no input is playing.
*'''vlc.input.fps''': frames per second returned as a float (typically 60.0, 50.0, 23.976, etc...)
*'''vlc.input.hasVout''': a boolean that returns true when the video is being displayed, it returns false when video is not displayed

read/write properties

*'''vlc.input.position''': normalized position in multimedia stream item given as a float value between [0.0 - 1.0]
*'''vlc.input.time''': the absolute position in time given in milliseconds, this property can be used to seek through the stream


vlc.input.time = <absolute seek>

vlc.input.time = vlc.input.time + <relative seek>

*'''vlc.input.state''': current state of the input chain given as enumeration:
{| class="wikitable"
|-
| 0 || IDLE
|-
| 1 || OPENING
|-
| 2 || BUFFERING
|-
| 3 || PLAYING
|-
| 4 || PAUSED
|-
| 5 || STOPPING
|-
| 6 || ENDED
|-
| 7 || ERROR
|}

Note: Test for ENDED=6 to catch end of playback. Checking for STOPPING=5 is NOT ENOUGH.
*'''vlc.input.rate''': input speed given as float (1.0 for normal speed, 0.5 for half speed, 2.0 for twice as fast, etc.).

rate > 1  : is fastforward
rate > 0 and rate < 1 : is slow motion
rate < 0  : is rewind

methods

*''none''

== Playlist object ==

readonly properties

*'''vlc.playlist.itemCount''': number that returns the amount of items currently in the playlist ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])
*'''vlc.playlist.isPlaying''': a boolean that returns true if the current playlist item is playing and false when it is not playing
*'''vlc.playlist.items''': return the playlist items collection, see [[#Playlist_items_object|Playlist items]]

read/write properties

*''none''

methods

*'''vlc.playlist.add(mrl)''': add a playlist item as [[MRL]]. The MRL must be given as a string. Returns a number as an item identifier in playlist (this is not a position in playlist).
*'''vlc.playlist.add(mrl,name,options)''': add a playlist item as MRL, with metaname 'name' and options 'options'. options are text arguments which can be provided either as a single string containing space separated values, akin to VLC command line, or as an array of string values. Returns a number as an item identifier in playlist (this is not a position in playlist).

<syntaxhighlight lang="javascript" line>
var options = new Array(":aspect-ratio=4:3", "--rtsp-tcp");
var id = vlc.playlist.add("rtsp://servername/item/to/play", "fancy name", options);
vlc.playlist.playItem(id);
</syntaxhighlight>

*'''vlc.playlist.play()''': start playing the current playlist item
*'''vlc.playlist.playItem(number)''': start playing the item whose identifier is number
*'''vlc.playlist.pause()''': pause the current playlist item
*'''vlc.playlist.togglePause()''': toggle the pause state for the current playlist item
*'''vlc.playlist.stop()''': stop playing the current playlist item
*'''vlc.playlist.next()''': iterate to the next playlist item
*'''vlc.playlist.prev()''': iterate to the previous playlist item
*'''vlc.playlist.clear()''': empty the current playlist, all items will be deleted from the playlist ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])
*'''vlc.playlist.removeItem(number)''': remove the item from playlist whose identifier is number  ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])

=== Playlist items object ===

readonly properties

*'''vlc.playlist.items.count''': number of items currently in the playlist

read/write properties

*''none''

methods

*'''vlc.playlist.items.clear()''': empty the current playlist, all items will be deleted from the playlist. If a movie is playing, it stop. Note that when this method returns, playlist may not have been entirely been cleared as this operation is performed asynchronously; use the ''count'' property to verify/wait until the playlist is empty.
*'''vlc.playlist.items.remove(number)''': remove the item whose identifier is number from playlist. (note: this number isn't the position in the playlist, but the number given by vlc.playlist.add() )

== Subtitle object ==

readonly properties

*'''vlc.subtitle.count''': (supported in vlc version >= 1.1.0) returns the number of subtitle available.

read/write properties

*'''vlc.subtitle.track''': (supported in vlc version >= 1.1.0) get and set the subtitle track to show on the video screen. The property takes an integer as input value [1..65535]. If subtitle track is set to 0, the subtitles will be disabled. If set to a value outside the current subtitle tracks range, then it will return -1 and display an error message.

methods

*'''vlc.subtitle.description(int i)''': (supported in vlc version >= 1.1.0) give the i-th subtitle name. 0 correspond to disable and 1 to the first subtitle.

== Video object ==

readonly properties

*'''vlc.video.width''': returns the horizontal size of the video
*'''vlc.video.height''': returns the vertical size of the video

read/write properties

*'''vlc.video.fullscreen''': when set to true the video will be displayed in fullscreen mode, when set to false the video will be shown inside the video output size. The property takes a boolean as input.
*'''vlc.video.aspectRatio''': get and set the aspect ratio to use in the video screen. The property takes a string as input value. Typical values are: "1:1", "4:3", "16:9", "16:10", "221:100" and "5:4"
*'''vlc.video.subtitle''': (supported in vlc version > 0.8.6a) get and set the subtitle track to show on the video screen. The property takes an integer as input value [1..65535]. If subtitle track is set to 0, the subtitles will be disabled. If set to a value outside the current subtitle tracks range, then it will return -1 and display an error message.
*'''vlc.video.teletext''': (supported in vlc version >= 0.9.0) get and set teletext page to show on the video stream. This will only work if a teletext elementary stream is available in the video stream. The property takes an integer as input value [0..999] for indicating the teletext page to view, setting the value to 0 means hide teletext. On error it will return -1 and display an error message.

methods

*'''vlc.video.toggleFullscreen()''': toggle the fullscreen mode based on the previous setting
*'''vlc.video.toggleTeletext()''': (supported in vlc version >= 0.9.0) toggle the teletext page to overlay transparent or not, based on the previous setting

=== Deinterlace Object ===

readonly properties

*''none''

read/write properties

*''none''

methods

*'''vlc.video.deinterlace.enable("my_mode")''': (supported in vlc version >= 1.1.0) enable deinterlacing with my_mode. You can enable it with "blend", "bob", "discard", "linear", "mean", "x", "yadif" or "yadif2x" mode. Enabling too soon deinterlacing may cause some problems. You have to wait that all variable are available before enabling it.
*'''vlc.video.deinterlace.disable()''': (supported in vlc version >= 1.1.0) disable deinterlacing.

=== Marquee Object ===

readonly properties

*''none''

read/write properties

*'''vlc.video.marquee.text''': (supported in vlc version >= 1.1.0) display my text on the screen.
*'''vlc.video.marquee.color''': (supported in vlc version >= 1.1.0) change the text color. val is the new color to use (WHITE=0x000000, BLACK=0xFFFFFF, RED=0xFF0000, GREEN=0x00FF00, BLUE=0x0000FF...).
*'''vlc.video.marquee.opacity''': (supported in vlc version >= 1.1.0) change the text opacity, val is defined from 0 (completely transparent) to 255 (completely opaque).
*'''vlc.video.marquee.position''': (supported in vlc version >= 1.1.0) change the text position (CENTER=0, LEFT=1, RIGHT=2, TOP=4, TOP-LEFT=5, TOP-RIGHT=6, BOTTOM=8, BOTTOM-LEFT=9, BOTTOM_RIGHT=10).
*'''vlc.video.marquee.refresh''': (supported in vlc version >= 1.1.0) change the marquee refresh period.
*'''vlc.video.marquee.size''': (supported in vlc version >= 1.1.0) val define the new size for the text displayed on the screen. If the text is bigger than the screen then the text is not displayed.
*'''vlc.video.marquee.timeout''': (supported in vlc version >= 1.1.0) change the timeout value. val is defined in ms, but 0 value correspond to unlimited.
*'''vlc.video.marquee.x''': (supported in vlc version >= 1.1.0) change text abscissa.
*'''vlc.video.marquee.y''': (supported in vlc version >= 1.1.0) change text ordinate.

methods

*'''vlc.video.marquee.enable()''': (supported in vlc version >= 1.1.0) enable marquee filter.
*'''vlc.video.marquee.disable()''': (supported in vlc version >= 1.1.0) disable marquee filter.

Some problems may happen (option like color or text will not be applied) because of the VLC asynchronous functioning. To avoid it, after enabling marquee, you have to wait a little time before changing an option. But it should be fixed by the new vout implementation.

NOTE: [http://forum.videolan.org/viewtopic.php?f=16&t=89427#p295058]

=== Logo Object ===

readonly properties

*''none''

read/write properties

*'''vlc.video.logo.opacity''': (supported in vlc version >= 1.1.0) change the picture opacity, val is defined from 0 (completely transparent) to 255 (completely opaque).
*'''vlc.video.logo.position''': (supported in vlc version >= 1.1.0) change the text position ("center", "left", "right", "top", "top-left", "top-right", "bottom", "bottom-left", "bottom-right").
*'''vlc.video.logo.delay''': (supported in vlc version >= 1.1.0) display each picture for a duration of 1000 ms (default) before displaying the next picture.
*'''vlc.video.logo.repeat''': (supported in vlc version >= 1.1.0) number of loops for picture animation (-1=continuous, 0=disabled, n=n-times). The default is -1 (continuous).
*'''vlc.video.logo.x''': (supported in vlc version >= 1.1.0) change the x-offset for displaying the picture counting from top-left on the screen.
*'''vlc.video.logo.y''': (supported in vlc version >= 1.1.0) change the y-offset for displaying the picture counting from top-left on the screen.
*'''vlc.video.logo.width''': (supported in vlc version >= 1.1.0) change the picture width.
*'''vlc.video.logo.height''': (supported in vlc version >= 1.1.0) change the picture height.

methods

*'''vlc.video.logo.enable()''': (supported in vlc version >= 1.1.0) enable logo video filter.
*'''vlc.video.logo.disable()''': (supported in vlc version >= 1.1.0) disable logo video filter.
*'''vlc.video.logo.file("file.png")''': (supported in vlc version >= 1.1.0) display my file.png as logo on the screen.

Some problems may happen because of the VLC asynchronous functioning. To avoid it, after enabling logo video filter, you have to wait a little time before changing an option. But it should be fixed by the new vout implementation.

== MediaDescription Object ==

readonly properties

*'''vlc.mediaDescription.title''': (supported in vlc version >= 2.0.2) returns title meta information field.
*'''vlc.mediaDescription.artist''': (supported in vlc version >= 2.0.2) returns artist meta information field.
*'''vlc.mediaDescription.copyright''': (supported in vlc version >= 2.0.2) returns copyright meta information field.
*'''vlc.mediaDescription.album''': (supported in vlc version >= 2.0.2) returns album meta information field.
*'''vlc.mediaDescription.trackNumber''': (supported in vlc version >= 2.0.2) returns trackNumber meta information field.
*'''vlc.mediaDescription.description''': (supported in vlc version >= 2.0.2) returns description meta information field.
*'''vlc.mediaDescription.rating''': (supported in vlc version >= 2.0.2) returns rating meta information field.
*'''vlc.mediaDescription.date''': (supported in vlc version >= 2.0.2) returns date meta information field.
*'''vlc.mediaDescription.setting''': (supported in vlc version >= 2.0.2) returns setting meta information field.
*'''vlc.mediaDescription.URL''': (supported in vlc version >= 2.0.2) returns URL meta information field.
*'''vlc.mediaDescription.language''': (supported in vlc version >= 2.0.2) returns language meta information field.
*'''vlc.mediaDescription.nowPlaying''': (supported in vlc version >= 2.0.2) returns nowPlaying meta information field.
*'''vlc.mediaDescription.publisher''': (supported in vlc version >= 2.0.2) returns publisher meta information field.
*'''vlc.mediaDescription.encodedBy''': (supported in vlc version >= 2.0.2) returns encodedBy meta information field.

*'''vlc.mediaDescription.artworkURL''': (supported in vlc version >= 2.0.2) returns artworkURL meta information field.

*'''vlc.mediaDescription.trackID''': (supported in vlc version >= 2.0.2) returns trackID meta information field.

read/write properties

*''none''

methods

*''none''

== DEPRECATED APIs ==
=== DEPRECATED: Log object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

This object allows accessing VLC main message logging queue. Typically this queue capacity is very small (no nore than 256 entries) and can easily overflow, therefore messages should be read and cleared as often as possible.

readonly properties

*'''vlc.log.messages''': returns the message collection, see [[#Messages_object|Messages object]]

read/write properties

*'''vlc.log.verbosity''': write number [-1,0,1,2,3] for changing the verbosity level of the log messages; messages whose verbosity is higher than set will be not be logged in the queue. The numbers have the following meaning: -1 disable, 0 info, 1 error, 2 warning, 3 debug.

methods

*''none''

=== DEPRECATED: Messages object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

readonly properties

*'''messages.count''': returns number of messages in the log

read/write properties

*''none''

methods

*'''messages.clear()''': clear the current log buffer. It should be called as frequently as possible to not overflow the message queue. Call this method after the log messages of interest are read.
*'''messages.iterator()''': creates and returns an iterator object, used to iterate over the messages in the log. '''Don't clear the log buffer while holding an iterator object.'''

=== DEPRECATED: Messages Iterator object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

readonly properties

*'''iterator.hasNext''': returns a boolean that indicates whether ''vlc.log.messages.next()'' will return the next message.

read/write properties

*''none''

methods

*'''iterator.next()''': returns the next message object in the log, see [[Message object]]

=== DEPRECATED: Message subobject ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

*'''message.severity''': number that indicates the severity of the log message (0 = info, 1 = error, 2 = warning, 3 = debug)
*'''message.name''': name of VLC module that printed the log message (e.g: main, http, directx, etc...)
*'''message.type''': type of VLC module that printed the log message (eg: input, access, vout, sout, etc...)
*'''message.message''': the message text

{{Documentation}}

[[Category:Embedded]]

Documentation:WebPlugin

2013-01-02T15:18:09Z

Etix: /* Browsers support */

This Documentation speaks about the {{VLC}} Web plugins and how to write pages for it.
{{RightMenu|documentation play howto toc}}

= Introduction: Building Web pages with Video =

The {{VLC}} webplugins are native browser plugins, similar to Flash or Silverlight plugins and allow playback inside the browser of all the videos that {{VLC}} can read.

Additionally to viewing video on all pages, you can build custom pages that will use the advanced features of the plugin, using Javascript functions to control playback or extract information from the plugin.

There are 2 main plugins: one is ActiveX for IE, the other is NPAPI for the other browsers. They feature the same amount of features.

In older versions, those plugins were very crashy. '''We URGE YOU''' to use VLC '''2.0.0''' or newer versions.

=== Browsers support ===
It has been tested with:
{| class="wikitable"
|-
| Mozilla Firefox || [[Image:Firefox-logo.png|40x40px]]
|-
| Internet Explorer || [[Image:20101105053305!Internet Explorer 9.png|40x40px]]
|-
| Safari || [[Image:Apple Safari.png|40x40px]]
|-
| Chrome ||
|-
| Konqueror ||
|-
| Opera ||
|}

It has been tested on GNU/Linux, Windows and MacOS.

= Embed tag attributes =

To embed the plugin into a webpage use the following <embed> template:

<syntaxhighlight lang="javascript" line>
<embed type="application/x-vlc-plugin" pluginspage="http://www.videolan.org" />
<object classid="clsid:9BE31822-FDAD-461B-AD51-BE1D1C159921" codebase="http://download.videolan.org/pub/videolan/vlc/last/win32/axvlc.cab"></object>
</syntaxhighlight>

=== Required elements ===
These are '''required''' attributes for the <embed> tag:

*'''width''': Specifies the width of the plugin.
*'''height''': Specifies the height of the plugin.
*'''target''' (or one of these alias: '''mrl''', '''filename''', '''src'''): Specifies the source location (URL) of the video to load.

=== Optionnal elements ===
These are additional attributes for the <embed> tag:

*'''autoplay''', '''autostart''': Specifies whether the plugin starts playing on load. Default: ''true''
*'''allowfullscreen''': (since VLC version 1.2.0) Specifies whether the user can switch into fullscreen mode. Default: ''true''
*'''windowless''': (since VLC version 2.0.6) Draw the video on a window-less (non-accelerated) surface and allow styling (CSS overlay, 3D transformations, and much more). Default: ''false''
*'''mute''': Specifies whether the audio volume is initially muted. Default: ''false''
*'''loop''', '''autoloop''': Specifies whether the video loops on end. Default: ''false''
*'''toolbar''': Specifies whether the toolbar is shown by default. Default: ''true''
*'''bgcolor''': Specifies the background color of the video player. Default: ''#000000''

=== Normal DOM elements ===
*'''id''': DOM id
*'''name''': DOM name

= Javascript API description =

The vlc plugin exports several objects that can be accessed for setting and getting information. When used improperly the API's will throw an exception that includes a string that explains what happened. For example when asking for vlc.input.length when there is no playlist item playing.

== VLC objects ==
The vlc plugin knows the following objects:

*'''audio''': Access audio properties.
*'''input''': Access input properties.
*'''playlist''': Access playlist properties.
*'''subtitle''': Access subtitle properties.
*'''video''': Access video properties.
**'''video.marquee''': Access marquee video filter properties.
**'''video.logo''': Access logo video filter properties.
*'''mediaDescription''': Access media info properties (only available in vlc version >= 2.0.2).

The following are deprecated:
*'''log''': Access log properties (only available in vlc version <= 1.0.0-rc1).
*'''messages''': Access to log message properties (only available in vlc version <= 1.0.0-rc1).
*'''iterator''': Access to log iterator properties (only available in vlc version <= 1.0.0-rc1).
*'''message''': Access to log message properties (only available in vlc version <= 1.0.0-rc1).

=== Example ===
The following JavaScript code shows howto get a reference to the vlc plugin. This reference can then be used to access the objects of the vlc plugin.

<syntaxhighlight lang="html5" line>
<html>
<title>VLC Mozilla plugin test page</title>
<body>
<embed type="application/x-vlc-plugin" pluginspage="http://www.videolan.org"
width="640"
height="480"
id="vlc">
</embed>
<script language="Javascript">
</syntaxhighlight><syntaxhighlight lang="javascript" line>

</syntaxhighlight><syntaxhighlight lang="html5" line>
</script>
</body>
</html>
</syntaxhighlight>

== Root object ==

readonly properties

*'''VersionInfo''': returns version information string

read/write properties

*''none''

methods

*'''vlc.versionInfo()''': returns version information string (same as VersionInfo)

*'''vlc.addEventListener(eventname, callback, bubble)''': (only for Mozilla) add a listener for mentioned event name, callback expects a function and bubble influences the order of eventhandling by JS (usually it is set to false).
*'''vlc.removeEventListener(eventname, callback, bubble)''': (only for Mozilla) remove listener for mentioned event name, callback expects a function and bubble influences the order of eventhandling by JS (usually it is set to false).

*'''vlc.attachEvent(eventname, callback)''': (only for ActiveX) add listener for mentioned event name, callback expects a function
*'''vlc.removeEvent(eventname, callback)''': (only for ActiveX) remove listener for mentioned event name, callback expects a function

events

*'''MediaPlayerNothingSpecial''': vlc is in idle state doing nothing but waiting for a command to be issued
*'''MediaPlayerOpening''': vlc is opening an media resource locator (MRL)
*'''MediaPlayerBuffering''': vlc is buffering
*'''MediaPlayerPlaying''': vlc is playing a media
*'''MediaPlayerPaused''': vlc is in paused state
*'''MediaPlayerForward''': vlc is fastforwarding through the media (works only when an input supports forward playback)
*'''MediaPlayerBackward''': vlc is going backwards through the media (works only when an input supports backwards playback)
*'''MediaPlayerEncounteredError''': vlc has encountered an error and is unable to continue
*'''MediaPlayerEndReached''': vlc has reached the end of current playlist
*'''MediaPlayerTimeChanged''': time has changed
*'''MediaPlayerPositionChanged''': media position has changed
*'''MediaPlayerSeekableChanged''': media seekable flag has changed (true means media is seekable, false means it is not)
*'''MediaPlayerPausableChanged''': media pausable flag has changed (true means media is pauseable, false means it is not)

=== Example ===
The following code snippet provides easy functions to register and unregister event callbacks on all supported platforms (currently only Linux mozilla based browsers and windows activeX objects for Internet Explorer).

<syntaxhighlight lang="html5" line>
<script language="javascript">
</syntaxhighlight><syntaxhighlight lang="javascript" line>

</syntaxhighlight><syntaxhighlight lang="html5" line>
</script>
</syntaxhighlight>

== Audio object ==

readonly properties

*'''vlc.audio.count''': (supported in vlc version >= 1.1.0) returns the number of audio track available.

read/write properties

*'''vlc.audio.mute''': boolean value to mute and unmute the audio.
*'''vlc.audio.volume''': a value between [0-200] which indicates a percentage of the volume.
*'''vlc.audio.track''': (supported in vlc version > 0.8.6) a value between [1-65535] which indicates the audio track to play or that is playing. a value of 0 means the audio is/will be disabled.
*'''vlc.audio.channel''': (supported in vlc version > 0.8.6) integer value between [1-5] that indicates which audio channel mode is used, values can be: "1=stereo", "2=reverse stereo", "3=left", "4=right", "5=dolby". Use vlc.audio.channel to check if setting of the audio channel mode has succeeded.

methods

*'''vlc.audio.toggleMute()''': boolean toggle that mutes and unmutes the audio based upon the previous state.
*'''vlc.audio.description(int i)''': (supported in vlc version >= 1.1.0) give the i-th audio track name. 0 corresponds to disable and 1 to the first audio track.

=== Example ===

<syntaxhighlight lang="html5" line>
Audio Channel:
<select readonly onChange='doAudioChannel(this.value)'>
<option value=1>Stereo</option>
<option value=2>Reverse stereo</option>
<option value=3>Left</option>
<option value=4>Right</option>
<option value=5>Dolby</option>
</select>
</syntaxhighlight>
<br />
<syntaxhighlight lang="javascript" line>
<script language="javascript">

</script>
</syntaxhighlight>

== Input object ==

readonly properties

*'''vlc.input.length''': length of the input file in number of milliseconds. 0 is returned for 'live' streams or clips whose length cannot be determined by VLC. It returns -1 if no input is playing.
*'''vlc.input.fps''': frames per second returned as a float (typically 60.0, 50.0, 23.976, etc...)
*'''vlc.input.hasVout''': a boolean that returns true when the video is being displayed, it returns false when video is not displayed

read/write properties

*'''vlc.input.position''': normalized position in multimedia stream item given as a float value between [0.0 - 1.0]
*'''vlc.input.time''': the absolute position in time given in milliseconds, this property can be used to seek through the stream


vlc.input.time = <absolute seek>

vlc.input.time = vlc.input.time + <relative seek>

*'''vlc.input.state''': current state of the input chain given as enumeration:
{| class="wikitable"
|-
| 0 || IDLE
|-
| 1 || OPENING
|-
| 2 || BUFFERING
|-
| 3 || PLAYING
|-
| 4 || PAUSED
|-
| 5 || STOPPING
|-
| 6 || ENDED
|-
| 7 || ERROR
|}

Note: Test for ENDED=6 to catch end of playback. Checking for STOPPING=5 is NOT ENOUGH.
*'''vlc.input.rate''': input speed given as float (1.0 for normal speed, 0.5 for half speed, 2.0 for twice as fast, etc.).

rate > 1  : is fastforward
rate > 0 and rate < 1 : is slow motion
rate < 0  : is rewind

methods

*''none''

== Playlist object ==

readonly properties

*'''vlc.playlist.itemCount''': number that returns the amount of items currently in the playlist ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])
*'''vlc.playlist.isPlaying''': a boolean that returns true if the current playlist item is playing and false when it is not playing
*'''vlc.playlist.items''': return the playlist items collection, see [[#Playlist_items_object|Playlist items]]

read/write properties

*''none''

methods

*'''vlc.playlist.add(mrl)''': add a playlist item as [[MRL]]. The MRL must be given as a string. Returns a number as an item identifier in playlist (this is not a position in playlist).
*'''vlc.playlist.add(mrl,name,options)''': add a playlist item as MRL, with metaname 'name' and options 'options'. options are text arguments which can be provided either as a single string containing space separated values, akin to VLC command line, or as an array of string values. Returns a number as an item identifier in playlist (this is not a position in playlist).

<syntaxhighlight lang="javascript" line>
var options = new Array(":aspect-ratio=4:3", "--rtsp-tcp");
var id = vlc.playlist.add("rtsp://servername/item/to/play", "fancy name", options);
vlc.playlist.playItem(id);
</syntaxhighlight>

*'''vlc.playlist.play()''': start playing the current playlist item
*'''vlc.playlist.playItem(number)''': start playing the item whose identifier is number
*'''vlc.playlist.pause()''': pause the current playlist item
*'''vlc.playlist.togglePause()''': toggle the pause state for the current playlist item
*'''vlc.playlist.stop()''': stop playing the current playlist item
*'''vlc.playlist.next()''': iterate to the next playlist item
*'''vlc.playlist.prev()''': iterate to the previous playlist item
*'''vlc.playlist.clear()''': empty the current playlist, all items will be deleted from the playlist ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])
*'''vlc.playlist.removeItem(number)''': remove the item from playlist whose identifier is number  ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])

=== Playlist items object ===

readonly properties

*'''vlc.playlist.items.count''': number of items currently in the playlist

read/write properties

*''none''

methods

*'''vlc.playlist.items.clear()''': empty the current playlist, all items will be deleted from the playlist. If a movie is playing, it stop. Note that when this method returns, playlist may not have been entirely been cleared as this operation is performed asynchronously; use the ''count'' property to verify/wait until the playlist is empty.
*'''vlc.playlist.items.remove(number)''': remove the item whose identifier is number from playlist. (note: this number isn't the position in the playlist, but the number given by vlc.playlist.add() )

== Subtitle object ==

readonly properties

*'''vlc.subtitle.count''': (supported in vlc version >= 1.1.0) returns the number of subtitle available.

read/write properties

*'''vlc.subtitle.track''': (supported in vlc version >= 1.1.0) get and set the subtitle track to show on the video screen. The property takes an integer as input value [1..65535]. If subtitle track is set to 0, the subtitles will be disabled. If set to a value outside the current subtitle tracks range, then it will return -1 and display an error message.

methods

*'''vlc.subtitle.description(int i)''': (supported in vlc version >= 1.1.0) give the i-th subtitle name. 0 correspond to disable and 1 to the first subtitle.

== Video object ==

readonly properties

*'''vlc.video.width''': returns the horizontal size of the video
*'''vlc.video.height''': returns the vertical size of the video

read/write properties

*'''vlc.video.fullscreen''': when set to true the video will be displayed in fullscreen mode, when set to false the video will be shown inside the video output size. The property takes a boolean as input.
*'''vlc.video.aspectRatio''': get and set the aspect ratio to use in the video screen. The property takes a string as input value. Typical values are: "1:1", "4:3", "16:9", "16:10", "221:100" and "5:4"
*'''vlc.video.subtitle''': (supported in vlc version > 0.8.6a) get and set the subtitle track to show on the video screen. The property takes an integer as input value [1..65535]. If subtitle track is set to 0, the subtitles will be disabled. If set to a value outside the current subtitle tracks range, then it will return -1 and display an error message.
*'''vlc.video.teletext''': (supported in vlc version >= 0.9.0) get and set teletext page to show on the video stream. This will only work if a teletext elementary stream is available in the video stream. The property takes an integer as input value [0..999] for indicating the teletext page to view, setting the value to 0 means hide teletext. On error it will return -1 and display an error message.

methods

*'''vlc.video.toggleFullscreen()''': toggle the fullscreen mode based on the previous setting
*'''vlc.video.toggleTeletext()''': (supported in vlc version >= 0.9.0) toggle the teletext page to overlay transparent or not, based on the previous setting

=== Deinterlace Object ===

readonly properties

*''none''

read/write properties

*''none''

methods

*'''vlc.video.deinterlace.enable("my_mode")''': (supported in vlc version >= 1.1.0) enable deinterlacing with my_mode. You can enable it with "blend", "bob", "discard", "linear", "mean", "x", "yadif" or "yadif2x" mode. Enabling too soon deinterlacing may cause some problems. You have to wait that all variable are available before enabling it.
*'''vlc.video.deinterlace.disable()''': (supported in vlc version >= 1.1.0) disable deinterlacing.

=== Marquee Object ===

readonly properties

*''none''

read/write properties

*'''vlc.video.marquee.text''': (supported in vlc version >= 1.1.0) display my text on the screen.
*'''vlc.video.marquee.color''': (supported in vlc version >= 1.1.0) change the text color. val is the new color to use (WHITE=0x000000, BLACK=0xFFFFFF, RED=0xFF0000, GREEN=0x00FF00, BLUE=0x0000FF...).
*'''vlc.video.marquee.opacity''': (supported in vlc version >= 1.1.0) change the text opacity, val is defined from 0 (completely transparent) to 255 (completely opaque).
*'''vlc.video.marquee.position''': (supported in vlc version >= 1.1.0) change the text position (CENTER=0, LEFT=1, RIGHT=2, TOP=4, TOP-LEFT=5, TOP-RIGHT=6, BOTTOM=8, BOTTOM-LEFT=9, BOTTOM_RIGHT=10).
*'''vlc.video.marquee.refresh''': (supported in vlc version >= 1.1.0) change the marquee refresh period.
*'''vlc.video.marquee.size''': (supported in vlc version >= 1.1.0) val define the new size for the text displayed on the screen. If the text is bigger than the screen then the text is not displayed.
*'''vlc.video.marquee.timeout''': (supported in vlc version >= 1.1.0) change the timeout value. val is defined in ms, but 0 value correspond to unlimited.
*'''vlc.video.marquee.x''': (supported in vlc version >= 1.1.0) change text abscissa.
*'''vlc.video.marquee.y''': (supported in vlc version >= 1.1.0) change text ordinate.

methods

*'''vlc.video.marquee.enable()''': (supported in vlc version >= 1.1.0) enable marquee filter.
*'''vlc.video.marquee.disable()''': (supported in vlc version >= 1.1.0) disable marquee filter.

Some problems may happen (option like color or text will not be applied) because of the VLC asynchronous functioning. To avoid it, after enabling marquee, you have to wait a little time before changing an option. But it should be fixed by the new vout implementation.

NOTE: [http://forum.videolan.org/viewtopic.php?f=16&t=89427#p295058]

=== Logo Object ===

readonly properties

*''none''

read/write properties

*'''vlc.video.logo.opacity''': (supported in vlc version >= 1.1.0) change the picture opacity, val is defined from 0 (completely transparent) to 255 (completely opaque).
*'''vlc.video.logo.position''': (supported in vlc version >= 1.1.0) change the text position ("center", "left", "right", "top", "top-left", "top-right", "bottom", "bottom-left", "bottom-right").
*'''vlc.video.logo.delay''': (supported in vlc version >= 1.1.0) display each picture for a duration of 1000 ms (default) before displaying the next picture.
*'''vlc.video.logo.repeat''': (supported in vlc version >= 1.1.0) number of loops for picture animation (-1=continuous, 0=disabled, n=n-times). The default is -1 (continuous).
*'''vlc.video.logo.x''': (supported in vlc version >= 1.1.0) change the x-offset for displaying the picture counting from top-left on the screen.
*'''vlc.video.logo.y''': (supported in vlc version >= 1.1.0) change the y-offset for displaying the picture counting from top-left on the screen.
*'''vlc.video.logo.width''': (supported in vlc version >= 1.1.0) change the picture width.
*'''vlc.video.logo.height''': (supported in vlc version >= 1.1.0) change the picture height.

methods

*'''vlc.video.logo.enable()''': (supported in vlc version >= 1.1.0) enable logo video filter.
*'''vlc.video.logo.disable()''': (supported in vlc version >= 1.1.0) disable logo video filter.
*'''vlc.video.logo.file("file.png")''': (supported in vlc version >= 1.1.0) display my file.png as logo on the screen.

Some problems may happen because of the VLC asynchronous functioning. To avoid it, after enabling logo video filter, you have to wait a little time before changing an option. But it should be fixed by the new vout implementation.

== MediaDescription Object ==

readonly properties

*'''vlc.mediaDescription.title''': (supported in vlc version >= 2.0.2) returns title meta information field.
*'''vlc.mediaDescription.artist''': (supported in vlc version >= 2.0.2) returns artist meta information field.
*'''vlc.mediaDescription.copyright''': (supported in vlc version >= 2.0.2) returns copyright meta information field.
*'''vlc.mediaDescription.album''': (supported in vlc version >= 2.0.2) returns album meta information field.
*'''vlc.mediaDescription.trackNumber''': (supported in vlc version >= 2.0.2) returns trackNumber meta information field.
*'''vlc.mediaDescription.description''': (supported in vlc version >= 2.0.2) returns description meta information field.
*'''vlc.mediaDescription.rating''': (supported in vlc version >= 2.0.2) returns rating meta information field.
*'''vlc.mediaDescription.date''': (supported in vlc version >= 2.0.2) returns date meta information field.
*'''vlc.mediaDescription.setting''': (supported in vlc version >= 2.0.2) returns setting meta information field.
*'''vlc.mediaDescription.URL''': (supported in vlc version >= 2.0.2) returns URL meta information field.
*'''vlc.mediaDescription.language''': (supported in vlc version >= 2.0.2) returns language meta information field.
*'''vlc.mediaDescription.nowPlaying''': (supported in vlc version >= 2.0.2) returns nowPlaying meta information field.
*'''vlc.mediaDescription.publisher''': (supported in vlc version >= 2.0.2) returns publisher meta information field.
*'''vlc.mediaDescription.encodedBy''': (supported in vlc version >= 2.0.2) returns encodedBy meta information field.

*'''vlc.mediaDescription.artworkURL''': (supported in vlc version >= 2.0.2) returns artworkURL meta information field.

*'''vlc.mediaDescription.trackID''': (supported in vlc version >= 2.0.2) returns trackID meta information field.

read/write properties

*''none''

methods

*''none''

== DEPRECATED APIs ==
=== DEPRECATED: Log object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

This object allows accessing VLC main message logging queue. Typically this queue capacity is very small (no nore than 256 entries) and can easily overflow, therefore messages should be read and cleared as often as possible.

readonly properties

*'''vlc.log.messages''': returns the message collection, see [[#Messages_object|Messages object]]

read/write properties

*'''vlc.log.verbosity''': write number [-1,0,1,2,3] for changing the verbosity level of the log messages; messages whose verbosity is higher than set will be not be logged in the queue. The numbers have the following meaning: -1 disable, 0 info, 1 error, 2 warning, 3 debug.

methods

*''none''

=== DEPRECATED: Messages object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

readonly properties

*'''messages.count''': returns number of messages in the log

read/write properties

*''none''

methods

*'''messages.clear()''': clear the current log buffer. It should be called as frequently as possible to not overflow the message queue. Call this method after the log messages of interest are read.
*'''messages.iterator()''': creates and returns an iterator object, used to iterate over the messages in the log. '''Don't clear the log buffer while holding an iterator object.'''

=== DEPRECATED: Messages Iterator object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

readonly properties

*'''iterator.hasNext''': returns a boolean that indicates whether ''vlc.log.messages.next()'' will return the next message.

read/write properties

*''none''

methods

*'''iterator.next()''': returns the next message object in the log, see [[Message object]]

=== DEPRECATED: Message subobject ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

*'''message.severity''': number that indicates the severity of the log message (0 = info, 1 = error, 2 = warning, 3 = debug)
*'''message.name''': name of VLC module that printed the log message (e.g: main, http, directx, etc...)
*'''message.type''': type of VLC module that printed the log message (eg: input, access, vout, sout, etc...)
*'''message.message''': the message text

{{Documentation}}

[[Category:Embedded]]

Documentation:WebPlugin

2013-01-02T15:11:48Z

Etix: Use a table to list the enum.

This Documentation speaks about the {{VLC}} Web plugins and how to write pages for it.
{{RightMenu|documentation play howto toc}}

= Introduction: Building Web pages with Video =

The {{VLC}} webplugins are native browser plugins, similar to Flash or Silverlight plugins and allow playback inside the browser of all the videos that {{VLC}} can read.

Additionally to viewing video on all pages, you can build custom pages that will use the advanced features of the plugin, using Javascript functions to control playback or extract information from the plugin.

There are 2 main plugins: one is ActiveX for IE, the other is NPAPI for the other browsers. They feature the same amount of features.

In older versions, those plugins were very crashy. '''We URGE YOU''' to use VLC '''2.0.0''' or newer versions.

=== Browsers support ===
It has been tested with:
* Mozilla Firefox [[Image:Firefox-logo.png|40x40px]]
* Internet Explorer [[Image:20101105053305!Internet Explorer 9.png|40x40px]]
* Safari [[Image:Apple Safari.png|40x40px]]
* Chrome
* Konqueror
* Opera

It has been tested on GNU/Linux, Windows and MacOS.

= Embed tag attributes =

To embed the plugin into a webpage use the following <embed> template:

<syntaxhighlight lang="javascript" line>
<embed type="application/x-vlc-plugin" pluginspage="http://www.videolan.org" />
<object classid="clsid:9BE31822-FDAD-461B-AD51-BE1D1C159921" codebase="http://download.videolan.org/pub/videolan/vlc/last/win32/axvlc.cab"></object>
</syntaxhighlight>

=== Required elements ===
These are '''required''' attributes for the <embed> tag:

*'''width''': Specifies the width of the plugin.
*'''height''': Specifies the height of the plugin.
*'''target''' (or one of these alias: '''mrl''', '''filename''', '''src'''): Specifies the source location (URL) of the video to load.

=== Optionnal elements ===
These are additional attributes for the <embed> tag:

*'''autoplay''', '''autostart''': Specifies whether the plugin starts playing on load. Default: ''true''
*'''allowfullscreen''': (since VLC version 1.2.0) Specifies whether the user can switch into fullscreen mode. Default: ''true''
*'''windowless''': (since VLC version 2.0.6) Draw the video on a window-less (non-accelerated) surface and allow styling (CSS overlay, 3D transformations, and much more). Default: ''false''
*'''mute''': Specifies whether the audio volume is initially muted. Default: ''false''
*'''loop''', '''autoloop''': Specifies whether the video loops on end. Default: ''false''
*'''toolbar''': Specifies whether the toolbar is shown by default. Default: ''true''
*'''bgcolor''': Specifies the background color of the video player. Default: ''#000000''

=== Normal DOM elements ===
*'''id''': DOM id
*'''name''': DOM name

= Javascript API description =

The vlc plugin exports several objects that can be accessed for setting and getting information. When used improperly the API's will throw an exception that includes a string that explains what happened. For example when asking for vlc.input.length when there is no playlist item playing.

== VLC objects ==
The vlc plugin knows the following objects:

*'''audio''': Access audio properties.
*'''input''': Access input properties.
*'''playlist''': Access playlist properties.
*'''subtitle''': Access subtitle properties.
*'''video''': Access video properties.
**'''video.marquee''': Access marquee video filter properties.
**'''video.logo''': Access logo video filter properties.
*'''mediaDescription''': Access media info properties (only available in vlc version >= 2.0.2).

The following are deprecated:
*'''log''': Access log properties (only available in vlc version <= 1.0.0-rc1).
*'''messages''': Access to log message properties (only available in vlc version <= 1.0.0-rc1).
*'''iterator''': Access to log iterator properties (only available in vlc version <= 1.0.0-rc1).
*'''message''': Access to log message properties (only available in vlc version <= 1.0.0-rc1).

=== Example ===
The following JavaScript code shows howto get a reference to the vlc plugin. This reference can then be used to access the objects of the vlc plugin.

<syntaxhighlight lang="html5" line>
<html>
<title>VLC Mozilla plugin test page</title>
<body>
<embed type="application/x-vlc-plugin" pluginspage="http://www.videolan.org"
width="640"
height="480"
id="vlc">
</embed>
<script language="Javascript">
</syntaxhighlight><syntaxhighlight lang="javascript" line>

</syntaxhighlight><syntaxhighlight lang="html5" line>
</script>
</body>
</html>
</syntaxhighlight>

== Root object ==

readonly properties

*'''VersionInfo''': returns version information string

read/write properties

*''none''

methods

*'''vlc.versionInfo()''': returns version information string (same as VersionInfo)

*'''vlc.addEventListener(eventname, callback, bubble)''': (only for Mozilla) add a listener for mentioned event name, callback expects a function and bubble influences the order of eventhandling by JS (usually it is set to false).
*'''vlc.removeEventListener(eventname, callback, bubble)''': (only for Mozilla) remove listener for mentioned event name, callback expects a function and bubble influences the order of eventhandling by JS (usually it is set to false).

*'''vlc.attachEvent(eventname, callback)''': (only for ActiveX) add listener for mentioned event name, callback expects a function
*'''vlc.removeEvent(eventname, callback)''': (only for ActiveX) remove listener for mentioned event name, callback expects a function

events

*'''MediaPlayerNothingSpecial''': vlc is in idle state doing nothing but waiting for a command to be issued
*'''MediaPlayerOpening''': vlc is opening an media resource locator (MRL)
*'''MediaPlayerBuffering''': vlc is buffering
*'''MediaPlayerPlaying''': vlc is playing a media
*'''MediaPlayerPaused''': vlc is in paused state
*'''MediaPlayerForward''': vlc is fastforwarding through the media (works only when an input supports forward playback)
*'''MediaPlayerBackward''': vlc is going backwards through the media (works only when an input supports backwards playback)
*'''MediaPlayerEncounteredError''': vlc has encountered an error and is unable to continue
*'''MediaPlayerEndReached''': vlc has reached the end of current playlist
*'''MediaPlayerTimeChanged''': time has changed
*'''MediaPlayerPositionChanged''': media position has changed
*'''MediaPlayerSeekableChanged''': media seekable flag has changed (true means media is seekable, false means it is not)
*'''MediaPlayerPausableChanged''': media pausable flag has changed (true means media is pauseable, false means it is not)

=== Example ===
The following code snippet provides easy functions to register and unregister event callbacks on all supported platforms (currently only Linux mozilla based browsers and windows activeX objects for Internet Explorer).

<syntaxhighlight lang="html5" line>
<script language="javascript">
</syntaxhighlight><syntaxhighlight lang="javascript" line>

</syntaxhighlight><syntaxhighlight lang="html5" line>
</script>
</syntaxhighlight>

== Audio object ==

readonly properties

*'''vlc.audio.count''': (supported in vlc version >= 1.1.0) returns the number of audio track available.

read/write properties

*'''vlc.audio.mute''': boolean value to mute and unmute the audio.
*'''vlc.audio.volume''': a value between [0-200] which indicates a percentage of the volume.
*'''vlc.audio.track''': (supported in vlc version > 0.8.6) a value between [1-65535] which indicates the audio track to play or that is playing. a value of 0 means the audio is/will be disabled.
*'''vlc.audio.channel''': (supported in vlc version > 0.8.6) integer value between [1-5] that indicates which audio channel mode is used, values can be: "1=stereo", "2=reverse stereo", "3=left", "4=right", "5=dolby". Use vlc.audio.channel to check if setting of the audio channel mode has succeeded.

methods

*'''vlc.audio.toggleMute()''': boolean toggle that mutes and unmutes the audio based upon the previous state.
*'''vlc.audio.description(int i)''': (supported in vlc version >= 1.1.0) give the i-th audio track name. 0 corresponds to disable and 1 to the first audio track.

=== Example ===

<syntaxhighlight lang="html5" line>
Audio Channel:
<select readonly onChange='doAudioChannel(this.value)'>
<option value=1>Stereo</option>
<option value=2>Reverse stereo</option>
<option value=3>Left</option>
<option value=4>Right</option>
<option value=5>Dolby</option>
</select>
</syntaxhighlight>
<br />
<syntaxhighlight lang="javascript" line>
<script language="javascript">

</script>
</syntaxhighlight>

== Input object ==

readonly properties

*'''vlc.input.length''': length of the input file in number of milliseconds. 0 is returned for 'live' streams or clips whose length cannot be determined by VLC. It returns -1 if no input is playing.
*'''vlc.input.fps''': frames per second returned as a float (typically 60.0, 50.0, 23.976, etc...)
*'''vlc.input.hasVout''': a boolean that returns true when the video is being displayed, it returns false when video is not displayed

read/write properties

*'''vlc.input.position''': normalized position in multimedia stream item given as a float value between [0.0 - 1.0]
*'''vlc.input.time''': the absolute position in time given in milliseconds, this property can be used to seek through the stream


vlc.input.time = <absolute seek>

vlc.input.time = vlc.input.time + <relative seek>

*'''vlc.input.state''': current state of the input chain given as enumeration:
{| class="wikitable"
|-
| 0 || IDLE
|-
| 1 || OPENING
|-
| 2 || BUFFERING
|-
| 3 || PLAYING
|-
| 4 || PAUSED
|-
| 5 || STOPPING
|-
| 6 || ENDED
|-
| 7 || ERROR
|}

Note: Test for ENDED=6 to catch end of playback. Checking for STOPPING=5 is NOT ENOUGH.
*'''vlc.input.rate''': input speed given as float (1.0 for normal speed, 0.5 for half speed, 2.0 for twice as fast, etc.).

rate > 1  : is fastforward
rate > 0 and rate < 1 : is slow motion
rate < 0  : is rewind

methods

*''none''

== Playlist object ==

readonly properties

*'''vlc.playlist.itemCount''': number that returns the amount of items currently in the playlist ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])
*'''vlc.playlist.isPlaying''': a boolean that returns true if the current playlist item is playing and false when it is not playing
*'''vlc.playlist.items''': return the playlist items collection, see [[#Playlist_items_object|Playlist items]]

read/write properties

*''none''

methods

*'''vlc.playlist.add(mrl)''': add a playlist item as [[MRL]]. The MRL must be given as a string. Returns a number as an item identifier in playlist (this is not a position in playlist).
*'''vlc.playlist.add(mrl,name,options)''': add a playlist item as MRL, with metaname 'name' and options 'options'. options are text arguments which can be provided either as a single string containing space separated values, akin to VLC command line, or as an array of string values. Returns a number as an item identifier in playlist (this is not a position in playlist).

<syntaxhighlight lang="javascript" line>
var options = new Array(":aspect-ratio=4:3", "--rtsp-tcp");
var id = vlc.playlist.add("rtsp://servername/item/to/play", "fancy name", options);
vlc.playlist.playItem(id);
</syntaxhighlight>

*'''vlc.playlist.play()''': start playing the current playlist item
*'''vlc.playlist.playItem(number)''': start playing the item whose identifier is number
*'''vlc.playlist.pause()''': pause the current playlist item
*'''vlc.playlist.togglePause()''': toggle the pause state for the current playlist item
*'''vlc.playlist.stop()''': stop playing the current playlist item
*'''vlc.playlist.next()''': iterate to the next playlist item
*'''vlc.playlist.prev()''': iterate to the previous playlist item
*'''vlc.playlist.clear()''': empty the current playlist, all items will be deleted from the playlist ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])
*'''vlc.playlist.removeItem(number)''': remove the item from playlist whose identifier is number  ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])

=== Playlist items object ===

readonly properties

*'''vlc.playlist.items.count''': number of items currently in the playlist

read/write properties

*''none''

methods

*'''vlc.playlist.items.clear()''': empty the current playlist, all items will be deleted from the playlist. If a movie is playing, it stop. Note that when this method returns, playlist may not have been entirely been cleared as this operation is performed asynchronously; use the ''count'' property to verify/wait until the playlist is empty.
*'''vlc.playlist.items.remove(number)''': remove the item whose identifier is number from playlist. (note: this number isn't the position in the playlist, but the number given by vlc.playlist.add() )

== Subtitle object ==

readonly properties

*'''vlc.subtitle.count''': (supported in vlc version >= 1.1.0) returns the number of subtitle available.

read/write properties

*'''vlc.subtitle.track''': (supported in vlc version >= 1.1.0) get and set the subtitle track to show on the video screen. The property takes an integer as input value [1..65535]. If subtitle track is set to 0, the subtitles will be disabled. If set to a value outside the current subtitle tracks range, then it will return -1 and display an error message.

methods

*'''vlc.subtitle.description(int i)''': (supported in vlc version >= 1.1.0) give the i-th subtitle name. 0 correspond to disable and 1 to the first subtitle.

== Video object ==

readonly properties

*'''vlc.video.width''': returns the horizontal size of the video
*'''vlc.video.height''': returns the vertical size of the video

read/write properties

*'''vlc.video.fullscreen''': when set to true the video will be displayed in fullscreen mode, when set to false the video will be shown inside the video output size. The property takes a boolean as input.
*'''vlc.video.aspectRatio''': get and set the aspect ratio to use in the video screen. The property takes a string as input value. Typical values are: "1:1", "4:3", "16:9", "16:10", "221:100" and "5:4"
*'''vlc.video.subtitle''': (supported in vlc version > 0.8.6a) get and set the subtitle track to show on the video screen. The property takes an integer as input value [1..65535]. If subtitle track is set to 0, the subtitles will be disabled. If set to a value outside the current subtitle tracks range, then it will return -1 and display an error message.
*'''vlc.video.teletext''': (supported in vlc version >= 0.9.0) get and set teletext page to show on the video stream. This will only work if a teletext elementary stream is available in the video stream. The property takes an integer as input value [0..999] for indicating the teletext page to view, setting the value to 0 means hide teletext. On error it will return -1 and display an error message.

methods

*'''vlc.video.toggleFullscreen()''': toggle the fullscreen mode based on the previous setting
*'''vlc.video.toggleTeletext()''': (supported in vlc version >= 0.9.0) toggle the teletext page to overlay transparent or not, based on the previous setting

=== Deinterlace Object ===

readonly properties

*''none''

read/write properties

*''none''

methods

*'''vlc.video.deinterlace.enable("my_mode")''': (supported in vlc version >= 1.1.0) enable deinterlacing with my_mode. You can enable it with "blend", "bob", "discard", "linear", "mean", "x", "yadif" or "yadif2x" mode. Enabling too soon deinterlacing may cause some problems. You have to wait that all variable are available before enabling it.
*'''vlc.video.deinterlace.disable()''': (supported in vlc version >= 1.1.0) disable deinterlacing.

=== Marquee Object ===

readonly properties

*''none''

read/write properties

*'''vlc.video.marquee.text''': (supported in vlc version >= 1.1.0) display my text on the screen.
*'''vlc.video.marquee.color''': (supported in vlc version >= 1.1.0) change the text color. val is the new color to use (WHITE=0x000000, BLACK=0xFFFFFF, RED=0xFF0000, GREEN=0x00FF00, BLUE=0x0000FF...).
*'''vlc.video.marquee.opacity''': (supported in vlc version >= 1.1.0) change the text opacity, val is defined from 0 (completely transparent) to 255 (completely opaque).
*'''vlc.video.marquee.position''': (supported in vlc version >= 1.1.0) change the text position (CENTER=0, LEFT=1, RIGHT=2, TOP=4, TOP-LEFT=5, TOP-RIGHT=6, BOTTOM=8, BOTTOM-LEFT=9, BOTTOM_RIGHT=10).
*'''vlc.video.marquee.refresh''': (supported in vlc version >= 1.1.0) change the marquee refresh period.
*'''vlc.video.marquee.size''': (supported in vlc version >= 1.1.0) val define the new size for the text displayed on the screen. If the text is bigger than the screen then the text is not displayed.
*'''vlc.video.marquee.timeout''': (supported in vlc version >= 1.1.0) change the timeout value. val is defined in ms, but 0 value correspond to unlimited.
*'''vlc.video.marquee.x''': (supported in vlc version >= 1.1.0) change text abscissa.
*'''vlc.video.marquee.y''': (supported in vlc version >= 1.1.0) change text ordinate.

methods

*'''vlc.video.marquee.enable()''': (supported in vlc version >= 1.1.0) enable marquee filter.
*'''vlc.video.marquee.disable()''': (supported in vlc version >= 1.1.0) disable marquee filter.

Some problems may happen (option like color or text will not be applied) because of the VLC asynchronous functioning. To avoid it, after enabling marquee, you have to wait a little time before changing an option. But it should be fixed by the new vout implementation.

NOTE: [http://forum.videolan.org/viewtopic.php?f=16&t=89427#p295058]

=== Logo Object ===

readonly properties

*''none''

read/write properties

*'''vlc.video.logo.opacity''': (supported in vlc version >= 1.1.0) change the picture opacity, val is defined from 0 (completely transparent) to 255 (completely opaque).
*'''vlc.video.logo.position''': (supported in vlc version >= 1.1.0) change the text position ("center", "left", "right", "top", "top-left", "top-right", "bottom", "bottom-left", "bottom-right").
*'''vlc.video.logo.delay''': (supported in vlc version >= 1.1.0) display each picture for a duration of 1000 ms (default) before displaying the next picture.
*'''vlc.video.logo.repeat''': (supported in vlc version >= 1.1.0) number of loops for picture animation (-1=continuous, 0=disabled, n=n-times). The default is -1 (continuous).
*'''vlc.video.logo.x''': (supported in vlc version >= 1.1.0) change the x-offset for displaying the picture counting from top-left on the screen.
*'''vlc.video.logo.y''': (supported in vlc version >= 1.1.0) change the y-offset for displaying the picture counting from top-left on the screen.
*'''vlc.video.logo.width''': (supported in vlc version >= 1.1.0) change the picture width.
*'''vlc.video.logo.height''': (supported in vlc version >= 1.1.0) change the picture height.

methods

*'''vlc.video.logo.enable()''': (supported in vlc version >= 1.1.0) enable logo video filter.
*'''vlc.video.logo.disable()''': (supported in vlc version >= 1.1.0) disable logo video filter.
*'''vlc.video.logo.file("file.png")''': (supported in vlc version >= 1.1.0) display my file.png as logo on the screen.

Some problems may happen because of the VLC asynchronous functioning. To avoid it, after enabling logo video filter, you have to wait a little time before changing an option. But it should be fixed by the new vout implementation.

== MediaDescription Object ==

readonly properties

*'''vlc.mediaDescription.title''': (supported in vlc version >= 2.0.2) returns title meta information field.
*'''vlc.mediaDescription.artist''': (supported in vlc version >= 2.0.2) returns artist meta information field.
*'''vlc.mediaDescription.copyright''': (supported in vlc version >= 2.0.2) returns copyright meta information field.
*'''vlc.mediaDescription.album''': (supported in vlc version >= 2.0.2) returns album meta information field.
*'''vlc.mediaDescription.trackNumber''': (supported in vlc version >= 2.0.2) returns trackNumber meta information field.
*'''vlc.mediaDescription.description''': (supported in vlc version >= 2.0.2) returns description meta information field.
*'''vlc.mediaDescription.rating''': (supported in vlc version >= 2.0.2) returns rating meta information field.
*'''vlc.mediaDescription.date''': (supported in vlc version >= 2.0.2) returns date meta information field.
*'''vlc.mediaDescription.setting''': (supported in vlc version >= 2.0.2) returns setting meta information field.
*'''vlc.mediaDescription.URL''': (supported in vlc version >= 2.0.2) returns URL meta information field.
*'''vlc.mediaDescription.language''': (supported in vlc version >= 2.0.2) returns language meta information field.
*'''vlc.mediaDescription.nowPlaying''': (supported in vlc version >= 2.0.2) returns nowPlaying meta information field.
*'''vlc.mediaDescription.publisher''': (supported in vlc version >= 2.0.2) returns publisher meta information field.
*'''vlc.mediaDescription.encodedBy''': (supported in vlc version >= 2.0.2) returns encodedBy meta information field.

*'''vlc.mediaDescription.artworkURL''': (supported in vlc version >= 2.0.2) returns artworkURL meta information field.

*'''vlc.mediaDescription.trackID''': (supported in vlc version >= 2.0.2) returns trackID meta information field.

read/write properties

*''none''

methods

*''none''

== DEPRECATED APIs ==
=== DEPRECATED: Log object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

This object allows accessing VLC main message logging queue. Typically this queue capacity is very small (no nore than 256 entries) and can easily overflow, therefore messages should be read and cleared as often as possible.

readonly properties

*'''vlc.log.messages''': returns the message collection, see [[#Messages_object|Messages object]]

read/write properties

*'''vlc.log.verbosity''': write number [-1,0,1,2,3] for changing the verbosity level of the log messages; messages whose verbosity is higher than set will be not be logged in the queue. The numbers have the following meaning: -1 disable, 0 info, 1 error, 2 warning, 3 debug.

methods

*''none''

=== DEPRECATED: Messages object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

readonly properties

*'''messages.count''': returns number of messages in the log

read/write properties

*''none''

methods

*'''messages.clear()''': clear the current log buffer. It should be called as frequently as possible to not overflow the message queue. Call this method after the log messages of interest are read.
*'''messages.iterator()''': creates and returns an iterator object, used to iterate over the messages in the log. '''Don't clear the log buffer while holding an iterator object.'''

=== DEPRECATED: Messages Iterator object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

readonly properties

*'''iterator.hasNext''': returns a boolean that indicates whether ''vlc.log.messages.next()'' will return the next message.

read/write properties

*''none''

methods

*'''iterator.next()''': returns the next message object in the log, see [[Message object]]

=== DEPRECATED: Message subobject ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

*'''message.severity''': number that indicates the severity of the log message (0 = info, 1 = error, 2 = warning, 3 = debug)
*'''message.name''': name of VLC module that printed the log message (e.g: main, http, directx, etc...)
*'''message.type''': type of VLC module that printed the log message (eg: input, access, vout, sout, etc...)
*'''message.message''': the message text

{{Documentation}}

[[Category:Embedded]]

Documentation:WebPlugin

2013-01-02T14:32:47Z

Etix: Indentation & style

This Documentation speaks about the {{VLC}} Web plugins and how to write pages for it.
{{RightMenu|documentation play howto toc}}

= Introduction: Building Web pages with Video =

The {{VLC}} webplugins are native browser plugins, similar to Flash or Silverlight plugins and allow playback inside the browser of all the videos that {{VLC}} can read.

Additionally to viewing video on all pages, you can build custom pages that will use the advanced features of the plugin, using Javascript functions to control playback or extract information from the plugin.

There are 2 main plugins: one is ActiveX for IE, the other is NPAPI for the other browsers. They feature the same amount of features.

In older versions, those plugins were very crashy. '''We URGE YOU''' to use VLC '''2.0.0''' or newer versions.

=== Browsers support ===
It has been tested with:
* Mozilla Firefox [[Image:Firefox-logo.png|40x40px]]
* Internet Explorer [[Image:20101105053305!Internet Explorer 9.png|40x40px]]
* Safari [[Image:Apple Safari.png|40x40px]]
* Chrome
* Konqueror
* Opera

It has been tested on GNU/Linux, Windows and MacOS.

= Embed tag attributes =

To embed the plugin into a webpage use the following <embed> template:

<syntaxhighlight lang="javascript" line>
<embed type="application/x-vlc-plugin" pluginspage="http://www.videolan.org" />
<object classid="clsid:9BE31822-FDAD-461B-AD51-BE1D1C159921" codebase="http://download.videolan.org/pub/videolan/vlc/last/win32/axvlc.cab"></object>
</syntaxhighlight>

=== Required elements ===
These are '''required''' attributes for the <embed> tag:

*'''width''': Specifies the width of the plugin.
*'''height''': Specifies the height of the plugin.
*'''target''' (or one of these alias: '''mrl''', '''filename''', '''src'''): Specifies the source location (URL) of the video to load.

=== Optionnal elements ===
These are additional attributes for the <embed> tag:

*'''autoplay''', '''autostart''': Specifies whether the plugin starts playing on load. Default: ''true''
*'''allowfullscreen''': (since VLC version 1.2.0) Specifies whether the user can switch into fullscreen mode. Default: ''true''
*'''windowless''': (since VLC version 2.0.6) Draw the video on a window-less (non-accelerated) surface and allow styling (CSS overlay, 3D transformations, and much more). Default: ''false''
*'''mute''': Specifies whether the audio volume is initially muted. Default: ''false''
*'''loop''', '''autoloop''': Specifies whether the video loops on end. Default: ''false''
*'''toolbar''': Specifies whether the toolbar is shown by default. Default: ''true''
*'''bgcolor''': Specifies the background color of the video player. Default: ''#000000''

=== Normal DOM elements ===
*'''id''': DOM id
*'''name''': DOM name

= Javascript API description =

The vlc plugin exports several objects that can be accessed for setting and getting information. When used improperly the API's will throw an exception that includes a string that explains what happened. For example when asking for vlc.input.length when there is no playlist item playing.

== VLC objects ==
The vlc plugin knows the following objects:

*'''audio''': Access audio properties.
*'''input''': Access input properties.
*'''playlist''': Access playlist properties.
*'''subtitle''': Access subtitle properties.
*'''video''': Access video properties.
**'''video.marquee''': Access marquee video filter properties.
**'''video.logo''': Access logo video filter properties.
*'''mediaDescription''': Access media info properties (only available in vlc version >= 2.0.2).

The following are deprecated:
*'''log''': Access log properties (only available in vlc version <= 1.0.0-rc1).
*'''messages''': Access to log message properties (only available in vlc version <= 1.0.0-rc1).
*'''iterator''': Access to log iterator properties (only available in vlc version <= 1.0.0-rc1).
*'''message''': Access to log message properties (only available in vlc version <= 1.0.0-rc1).

=== Example ===
The following JavaScript code shows howto get a reference to the vlc plugin. This reference can then be used to access the objects of the vlc plugin.

<syntaxhighlight lang="html5" line>
<html>
<title>VLC Mozilla plugin test page</title>
<body>
<embed type="application/x-vlc-plugin" pluginspage="http://www.videolan.org"
width="640"
height="480"
id="vlc">
</embed>
<script language="Javascript">
</syntaxhighlight><syntaxhighlight lang="javascript" line>

</syntaxhighlight><syntaxhighlight lang="html5" line>
</script>
</body>
</html>
</syntaxhighlight>

== Root object ==

readonly properties

*'''VersionInfo''': returns version information string

read/write properties

*''none''

methods

*'''vlc.versionInfo()''': returns version information string (same as VersionInfo)

*'''vlc.addEventListener(eventname, callback, bubble)''': (only for Mozilla) add a listener for mentioned event name, callback expects a function and bubble influences the order of eventhandling by JS (usually it is set to false).
*'''vlc.removeEventListener(eventname, callback, bubble)''': (only for Mozilla) remove listener for mentioned event name, callback expects a function and bubble influences the order of eventhandling by JS (usually it is set to false).

*'''vlc.attachEvent(eventname, callback)''': (only for ActiveX) add listener for mentioned event name, callback expects a function
*'''vlc.removeEvent(eventname, callback)''': (only for ActiveX) remove listener for mentioned event name, callback expects a function

events

*'''MediaPlayerNothingSpecial''': vlc is in idle state doing nothing but waiting for a command to be issued
*'''MediaPlayerOpening''': vlc is opening an media resource locator (MRL)
*'''MediaPlayerBuffering''': vlc is buffering
*'''MediaPlayerPlaying''': vlc is playing a media
*'''MediaPlayerPaused''': vlc is in paused state
*'''MediaPlayerForward''': vlc is fastforwarding through the media (works only when an input supports forward playback)
*'''MediaPlayerBackward''': vlc is going backwards through the media (works only when an input supports backwards playback)
*'''MediaPlayerEncounteredError''': vlc has encountered an error and is unable to continue
*'''MediaPlayerEndReached''': vlc has reached the end of current playlist
*'''MediaPlayerTimeChanged''': time has changed
*'''MediaPlayerPositionChanged''': media position has changed
*'''MediaPlayerSeekableChanged''': media seekable flag has changed (true means media is seekable, false means it is not)
*'''MediaPlayerPausableChanged''': media pausable flag has changed (true means media is pauseable, false means it is not)

=== Example ===
The following code snippet provides easy functions to register and unregister event callbacks on all supported platforms (currently only Linux mozilla based browsers and windows activeX objects for Internet Explorer).

<syntaxhighlight lang="html5" line>
<script language="javascript">
</syntaxhighlight><syntaxhighlight lang="javascript" line>

</syntaxhighlight><syntaxhighlight lang="html5" line>
</script>
</syntaxhighlight>

== Audio object ==

readonly properties

*'''vlc.audio.count''': (supported in vlc version >= 1.1.0) returns the number of audio track available.

read/write properties

*'''vlc.audio.mute''': boolean value to mute and unmute the audio.
*'''vlc.audio.volume''': a value between [0-200] which indicates a percentage of the volume.
*'''vlc.audio.track''': (supported in vlc version > 0.8.6) a value between [1-65535] which indicates the audio track to play or that is playing. a value of 0 means the audio is/will be disabled.
*'''vlc.audio.channel''': (supported in vlc version > 0.8.6) integer value between [1-5] that indicates which audio channel mode is used, values can be: "1=stereo", "2=reverse stereo", "3=left", "4=right", "5=dolby". Use vlc.audio.channel to check if setting of the audio channel mode has succeeded.

methods

*'''vlc.audio.toggleMute()''': boolean toggle that mutes and unmutes the audio based upon the previous state.
*'''vlc.audio.description(int i)''': (supported in vlc version >= 1.1.0) give the i-th audio track name. 0 corresponds to disable and 1 to the first audio track.

=== Example ===

<syntaxhighlight lang="html5" line>
Audio Channel:
<select readonly onChange='doAudioChannel(this.value)'>
<option value=1>Stereo</option>
<option value=2>Reverse stereo</option>
<option value=3>Left</option>
<option value=4>Right</option>
<option value=5>Dolby</option>
</select>
</syntaxhighlight>
<br />
<syntaxhighlight lang="javascript" line>
<script language="javascript">

</script>
</syntaxhighlight>

== Input object ==

readonly properties

*'''vlc.input.length''': length of the input file in number of milliseconds. 0 is returned for 'live' streams or clips whose length cannot be determined by VLC. It returns -1 if no input is playing.
*'''vlc.input.fps''': frames per second returned as a float (typically 60.0, 50.0, 23.976, etc...)
*'''vlc.input.hasVout''': a boolean that returns true when the video is being displayed, it returns false when video is not displayed

read/write properties

*'''vlc.input.position''': normalized position in multimedia stream item given as a float value between [0.0 - 1.0]
*'''vlc.input.time''': the absolute position in time given in milliseconds, this property can be used to seek through the stream


vlc.input.time = <absolute seek>

vlc.input.time = vlc.input.time + <relative seek>

*'''vlc.input.state''': current state of the input chain given as enumeration (IDLE=0, OPENING=1, BUFFERING=2, PLAYING=3, PAUSED=4, STOPPING=5, ENDED=6, ERROR=7). Note: Test for ENDED=6 to catch end of playback. Checking for STOPPING=5 is NOT ENOUGH.
*'''vlc.input.rate''': input speed given as float (1.0 for normal speed, 0.5 for half speed, 2.0 for twice as fast, etc.).

rate > 1  : is fastforward
rate > 0 and rate < 1 : is slow motion
rate < 0  : is rewind

methods

*''none''

== Playlist object ==

readonly properties

*'''vlc.playlist.itemCount''': number that returns the amount of items currently in the playlist ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])
*'''vlc.playlist.isPlaying''': a boolean that returns true if the current playlist item is playing and false when it is not playing
*'''vlc.playlist.items''': return the playlist items collection, see [[#Playlist_items_object|Playlist items]]

read/write properties

*''none''

methods

*'''vlc.playlist.add(mrl)''': add a playlist item as [[MRL]]. The MRL must be given as a string. Returns a number as an item identifier in playlist (this is not a position in playlist).
*'''vlc.playlist.add(mrl,name,options)''': add a playlist item as MRL, with metaname 'name' and options 'options'. options are text arguments which can be provided either as a single string containing space separated values, akin to VLC command line, or as an array of string values. Returns a number as an item identifier in playlist (this is not a position in playlist).

<syntaxhighlight lang="javascript" line>
var options = new Array(":aspect-ratio=4:3", "--rtsp-tcp");
var id = vlc.playlist.add("rtsp://servername/item/to/play", "fancy name", options);
vlc.playlist.playItem(id);
</syntaxhighlight>

*'''vlc.playlist.play()''': start playing the current playlist item
*'''vlc.playlist.playItem(number)''': start playing the item whose identifier is number
*'''vlc.playlist.pause()''': pause the current playlist item
*'''vlc.playlist.togglePause()''': toggle the pause state for the current playlist item
*'''vlc.playlist.stop()''': stop playing the current playlist item
*'''vlc.playlist.next()''': iterate to the next playlist item
*'''vlc.playlist.prev()''': iterate to the previous playlist item
*'''vlc.playlist.clear()''': empty the current playlist, all items will be deleted from the playlist ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])
*'''vlc.playlist.removeItem(number)''': remove the item from playlist whose identifier is number  ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])

=== Playlist items object ===

readonly properties

*'''vlc.playlist.items.count''': number of items currently in the playlist

read/write properties

*''none''

methods

*'''vlc.playlist.items.clear()''': empty the current playlist, all items will be deleted from the playlist. If a movie is playing, it stop. Note that when this method returns, playlist may not have been entirely been cleared as this operation is performed asynchronously; use the ''count'' property to verify/wait until the playlist is empty.
*'''vlc.playlist.items.remove(number)''': remove the item whose identifier is number from playlist. (note: this number isn't the position in the playlist, but the number given by vlc.playlist.add() )

== Subtitle object ==

readonly properties

*'''vlc.subtitle.count''': (supported in vlc version >= 1.1.0) returns the number of subtitle available.

read/write properties

*'''vlc.subtitle.track''': (supported in vlc version >= 1.1.0) get and set the subtitle track to show on the video screen. The property takes an integer as input value [1..65535]. If subtitle track is set to 0, the subtitles will be disabled. If set to a value outside the current subtitle tracks range, then it will return -1 and display an error message.

methods

*'''vlc.subtitle.description(int i)''': (supported in vlc version >= 1.1.0) give the i-th subtitle name. 0 correspond to disable and 1 to the first subtitle.

== Video object ==

readonly properties

*'''vlc.video.width''': returns the horizontal size of the video
*'''vlc.video.height''': returns the vertical size of the video

read/write properties

*'''vlc.video.fullscreen''': when set to true the video will be displayed in fullscreen mode, when set to false the video will be shown inside the video output size. The property takes a boolean as input.
*'''vlc.video.aspectRatio''': get and set the aspect ratio to use in the video screen. The property takes a string as input value. Typical values are: "1:1", "4:3", "16:9", "16:10", "221:100" and "5:4"
*'''vlc.video.subtitle''': (supported in vlc version > 0.8.6a) get and set the subtitle track to show on the video screen. The property takes an integer as input value [1..65535]. If subtitle track is set to 0, the subtitles will be disabled. If set to a value outside the current subtitle tracks range, then it will return -1 and display an error message.
*'''vlc.video.teletext''': (supported in vlc version >= 0.9.0) get and set teletext page to show on the video stream. This will only work if a teletext elementary stream is available in the video stream. The property takes an integer as input value [0..999] for indicating the teletext page to view, setting the value to 0 means hide teletext. On error it will return -1 and display an error message.

methods

*'''vlc.video.toggleFullscreen()''': toggle the fullscreen mode based on the previous setting
*'''vlc.video.toggleTeletext()''': (supported in vlc version >= 0.9.0) toggle the teletext page to overlay transparent or not, based on the previous setting

=== Deinterlace Object ===

readonly properties

*''none''

read/write properties

*''none''

methods

*'''vlc.video.deinterlace.enable("my_mode")''': (supported in vlc version >= 1.1.0) enable deinterlacing with my_mode. You can enable it with "blend", "bob", "discard", "linear", "mean", "x", "yadif" or "yadif2x" mode. Enabling too soon deinterlacing may cause some problems. You have to wait that all variable are available before enabling it.
*'''vlc.video.deinterlace.disable()''': (supported in vlc version >= 1.1.0) disable deinterlacing.

=== Marquee Object ===

readonly properties

*''none''

read/write properties

*'''vlc.video.marquee.text''': (supported in vlc version >= 1.1.0) display my text on the screen.
*'''vlc.video.marquee.color''': (supported in vlc version >= 1.1.0) change the text color. val is the new color to use (WHITE=0x000000, BLACK=0xFFFFFF, RED=0xFF0000, GREEN=0x00FF00, BLUE=0x0000FF...).
*'''vlc.video.marquee.opacity''': (supported in vlc version >= 1.1.0) change the text opacity, val is defined from 0 (completely transparent) to 255 (completely opaque).
*'''vlc.video.marquee.position''': (supported in vlc version >= 1.1.0) change the text position (CENTER=0, LEFT=1, RIGHT=2, TOP=4, TOP-LEFT=5, TOP-RIGHT=6, BOTTOM=8, BOTTOM-LEFT=9, BOTTOM_RIGHT=10).
*'''vlc.video.marquee.refresh''': (supported in vlc version >= 1.1.0) change the marquee refresh period.
*'''vlc.video.marquee.size''': (supported in vlc version >= 1.1.0) val define the new size for the text displayed on the screen. If the text is bigger than the screen then the text is not displayed.
*'''vlc.video.marquee.timeout''': (supported in vlc version >= 1.1.0) change the timeout value. val is defined in ms, but 0 value correspond to unlimited.
*'''vlc.video.marquee.x''': (supported in vlc version >= 1.1.0) change text abscissa.
*'''vlc.video.marquee.y''': (supported in vlc version >= 1.1.0) change text ordinate.

methods

*'''vlc.video.marquee.enable()''': (supported in vlc version >= 1.1.0) enable marquee filter.
*'''vlc.video.marquee.disable()''': (supported in vlc version >= 1.1.0) disable marquee filter.

Some problems may happen (option like color or text will not be applied) because of the VLC asynchronous functioning. To avoid it, after enabling marquee, you have to wait a little time before changing an option. But it should be fixed by the new vout implementation.

NOTE: [http://forum.videolan.org/viewtopic.php?f=16&t=89427#p295058]

=== Logo Object ===

readonly properties

*''none''

read/write properties

*'''vlc.video.logo.opacity''': (supported in vlc version >= 1.1.0) change the picture opacity, val is defined from 0 (completely transparent) to 255 (completely opaque).
*'''vlc.video.logo.position''': (supported in vlc version >= 1.1.0) change the text position ("center", "left", "right", "top", "top-left", "top-right", "bottom", "bottom-left", "bottom-right").
*'''vlc.video.logo.delay''': (supported in vlc version >= 1.1.0) display each picture for a duration of 1000 ms (default) before displaying the next picture.
*'''vlc.video.logo.repeat''': (supported in vlc version >= 1.1.0) number of loops for picture animation (-1=continuous, 0=disabled, n=n-times). The default is -1 (continuous).
*'''vlc.video.logo.x''': (supported in vlc version >= 1.1.0) change the x-offset for displaying the picture counting from top-left on the screen.
*'''vlc.video.logo.y''': (supported in vlc version >= 1.1.0) change the y-offset for displaying the picture counting from top-left on the screen.
*'''vlc.video.logo.width''': (supported in vlc version >= 1.1.0) change the picture width.
*'''vlc.video.logo.height''': (supported in vlc version >= 1.1.0) change the picture height.

methods

*'''vlc.video.logo.enable()''': (supported in vlc version >= 1.1.0) enable logo video filter.
*'''vlc.video.logo.disable()''': (supported in vlc version >= 1.1.0) disable logo video filter.
*'''vlc.video.logo.file("file.png")''': (supported in vlc version >= 1.1.0) display my file.png as logo on the screen.

Some problems may happen because of the VLC asynchronous functioning. To avoid it, after enabling logo video filter, you have to wait a little time before changing an option. But it should be fixed by the new vout implementation.

== MediaDescription Object ==

readonly properties

*'''vlc.mediaDescription.title''': (supported in vlc version >= 2.0.2) returns title meta information field.
*'''vlc.mediaDescription.artist''': (supported in vlc version >= 2.0.2) returns artist meta information field.
*'''vlc.mediaDescription.copyright''': (supported in vlc version >= 2.0.2) returns copyright meta information field.
*'''vlc.mediaDescription.album''': (supported in vlc version >= 2.0.2) returns album meta information field.
*'''vlc.mediaDescription.trackNumber''': (supported in vlc version >= 2.0.2) returns trackNumber meta information field.
*'''vlc.mediaDescription.description''': (supported in vlc version >= 2.0.2) returns description meta information field.
*'''vlc.mediaDescription.rating''': (supported in vlc version >= 2.0.2) returns rating meta information field.
*'''vlc.mediaDescription.date''': (supported in vlc version >= 2.0.2) returns date meta information field.
*'''vlc.mediaDescription.setting''': (supported in vlc version >= 2.0.2) returns setting meta information field.
*'''vlc.mediaDescription.URL''': (supported in vlc version >= 2.0.2) returns URL meta information field.
*'''vlc.mediaDescription.language''': (supported in vlc version >= 2.0.2) returns language meta information field.
*'''vlc.mediaDescription.nowPlaying''': (supported in vlc version >= 2.0.2) returns nowPlaying meta information field.
*'''vlc.mediaDescription.publisher''': (supported in vlc version >= 2.0.2) returns publisher meta information field.
*'''vlc.mediaDescription.encodedBy''': (supported in vlc version >= 2.0.2) returns encodedBy meta information field.

*'''vlc.mediaDescription.artworkURL''': (supported in vlc version >= 2.0.2) returns artworkURL meta information field.

*'''vlc.mediaDescription.trackID''': (supported in vlc version >= 2.0.2) returns trackID meta information field.

read/write properties

*''none''

methods

*''none''

== DEPRECATED APIs ==
=== DEPRECATED: Log object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

This object allows accessing VLC main message logging queue. Typically this queue capacity is very small (no nore than 256 entries) and can easily overflow, therefore messages should be read and cleared as often as possible.

readonly properties

*'''vlc.log.messages''': returns the message collection, see [[#Messages_object|Messages object]]

read/write properties

*'''vlc.log.verbosity''': write number [-1,0,1,2,3] for changing the verbosity level of the log messages; messages whose verbosity is higher than set will be not be logged in the queue. The numbers have the following meaning: -1 disable, 0 info, 1 error, 2 warning, 3 debug.

methods

*''none''

=== DEPRECATED: Messages object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

readonly properties

*'''messages.count''': returns number of messages in the log

read/write properties

*''none''

methods

*'''messages.clear()''': clear the current log buffer. It should be called as frequently as possible to not overflow the message queue. Call this method after the log messages of interest are read.
*'''messages.iterator()''': creates and returns an iterator object, used to iterate over the messages in the log. '''Don't clear the log buffer while holding an iterator object.'''

=== DEPRECATED: Messages Iterator object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

readonly properties

*'''iterator.hasNext''': returns a boolean that indicates whether ''vlc.log.messages.next()'' will return the next message.

read/write properties

*''none''

methods

*'''iterator.next()''': returns the next message object in the log, see [[Message object]]

=== DEPRECATED: Message subobject ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

*'''message.severity''': number that indicates the severity of the log message (0 = info, 1 = error, 2 = warning, 3 = debug)
*'''message.name''': name of VLC module that printed the log message (e.g: main, http, directx, etc...)
*'''message.type''': type of VLC module that printed the log message (eg: input, access, vout, sout, etc...)
*'''message.message''': the message text

{{Documentation}}

[[Category:Embedded]]

Documentation:WebPlugin

2013-01-02T14:29:03Z

Etix: Fix style

This Documentation speaks about the {{VLC}} Web plugins and how to write pages for it.
{{RightMenu|documentation play howto toc}}

= Introduction: Building Web pages with Video =

The {{VLC}} webplugins are native browser plugins, similar to Flash or Silverlight plugins and allow playback inside the browser of all the videos that {{VLC}} can read.

Additionally to viewing video on all pages, you can build custom pages that will use the advanced features of the plugin, using Javascript functions to control playback or extract information from the plugin.

There are 2 main plugins: one is ActiveX for IE, the other is NPAPI for the other browsers. They feature the same amount of features.

In older versions, those plugins were very crashy. '''We URGE YOU''' to use VLC '''2.0.0''' or newer versions.

=== Browsers support ===
It has been tested with:
* Mozilla Firefox [[Image:Firefox-logo.png|40x40px]]
* Internet Explorer [[Image:20101105053305!Internet Explorer 9.png|40x40px]]
* Safari [[Image:Apple Safari.png|40x40px]]
* Chrome
* Konqueror
* Opera

It has been tested on GNU/Linux, Windows and MacOS.

= Embed tag attributes =

To embed the plugin into a webpage use the following <embed> template:

<syntaxhighlight lang="javascript" line>
<embed type="application/x-vlc-plugin" pluginspage="http://www.videolan.org" />
<object classid="clsid:9BE31822-FDAD-461B-AD51-BE1D1C159921" codebase="http://download.videolan.org/pub/videolan/vlc/last/win32/axvlc.cab"></object>
</syntaxhighlight>

=== Required elements ===
These are '''required''' attributes for the <embed> tag:

*'''width''': Specifies the width of the plugin.
*'''height''': Specifies the height of the plugin.
*'''target''' (or one of these alias: '''mrl''', '''filename''', '''src'''): Specifies the source location (URL) of the video to load.

=== Optionnal elements ===
These are additional attributes for the <embed> tag:

*'''autoplay''', '''autostart''': Specifies whether the plugin starts playing on load. Default: ''true''
*'''allowfullscreen''': (since VLC version 1.2.0) Specifies whether the user can switch into fullscreen mode. Default: ''true''
*'''windowless''': (since VLC version 2.0.6) Draw the video on a window-less (non-accelerated) surface and allow styling (CSS overlay, 3D transformations, and much more). Default: ''false''
*'''mute''': Specifies whether the audio volume is initially muted. Default: ''false''
*'''loop''', '''autoloop''': Specifies whether the video loops on end. Default: ''false''
*'''toolbar''': Specifies whether the toolbar is shown by default. Default: ''true''
*'''bgcolor''': Specifies the background color of the video player. Default: ''#000000''

=== Normal DOM elements ===
*'''id''': DOM id
*'''name''': DOM name

= Javascript API description =

The vlc plugin exports several objects that can be accessed for setting and getting information. When used improperly the API's will throw an exception that includes a string that explains what happened. For example when asking for vlc.input.length when there is no playlist item playing.

== VLC objects ==
The vlc plugin knows the following objects:

*'''audio''': Access audio properties.
*'''input''': Access input properties.
*'''playlist''': Access playlist properties.
*'''subtitle''': Access subtitle properties.
*'''video''': Access video properties.
**'''video.marquee''': Access marquee video filter properties.
**'''video.logo''': Access logo video filter properties.
*'''mediaDescription''': Access media info properties (only available in vlc version >= 2.0.2).

The following are deprecated:
*'''log''': Access log properties (only available in vlc version <= 1.0.0-rc1).
*'''messages''': Access to log message properties (only available in vlc version <= 1.0.0-rc1).
*'''iterator''': Access to log iterator properties (only available in vlc version <= 1.0.0-rc1).
*'''message''': Access to log message properties (only available in vlc version <= 1.0.0-rc1).

=== Example ===
The following JavaScript code shows howto get a reference to the vlc plugin. This reference can then be used to access the objects of the vlc plugin.

<syntaxhighlight lang="html5" line>
<html>
<title>VLC Mozilla plugin test page</title>
<body>
<embed type="application/x-vlc-plugin" pluginspage="http://www.videolan.org"
width="640"
height="480"
id="vlc">
</embed>
<script language="Javascript">
</syntaxhighlight><syntaxhighlight lang="javascript" line>

</syntaxhighlight><syntaxhighlight lang="html5" line>
</script>
</body>
</html>
</syntaxhighlight>

== Root object ==

readonly properties

*'''VersionInfo''': returns version information string

read/write properties

*''none''

methods

*'''vlc.versionInfo()''': returns version information string (same as VersionInfo)

*'''vlc.addEventListener(eventname, callback, bubble)''': (only for Mozilla) add a listener for mentioned event name, callback expects a function and bubble influences the order of eventhandling by JS (usually it is set to false).
*'''vlc.removeEventListener(eventname, callback, bubble)''': (only for Mozilla) remove listener for mentioned event name, callback expects a function and bubble influences the order of eventhandling by JS (usually it is set to false).

*'''vlc.attachEvent(eventname, callback)''': (only for ActiveX) add listener for mentioned event name, callback expects a function
*'''vlc.removeEvent(eventname, callback)''': (only for ActiveX) remove listener for mentioned event name, callback expects a function

events

*'''MediaPlayerNothingSpecial''': vlc is in idle state doing nothing but waiting for a command to be issued
*'''MediaPlayerOpening''': vlc is opening an media resource locator (MRL)
*'''MediaPlayerBuffering''': vlc is buffering
*'''MediaPlayerPlaying''': vlc is playing a media
*'''MediaPlayerPaused''': vlc is in paused state
*'''MediaPlayerForward''': vlc is fastforwarding through the media (works only when an input supports forward playback)
*'''MediaPlayerBackward''': vlc is going backwards through the media (works only when an input supports backwards playback)
*'''MediaPlayerEncounteredError''': vlc has encountered an error and is unable to continue
*'''MediaPlayerEndReached''': vlc has reached the end of current playlist
*'''MediaPlayerTimeChanged''': time has changed
*'''MediaPlayerPositionChanged''': media position has changed
*'''MediaPlayerSeekableChanged''': media seekable flag has changed (true means media is seekable, false means it is not)
*'''MediaPlayerPausableChanged''': media pausable flag has changed (true means media is pauseable, false means it is not)

=== Example ===
The following code snippet provides easy functions to register and unregister event callbacks on all supported platforms (currently only Linux mozilla based browsers and windows activeX objects for Internet Explorer).

<syntaxhighlight lang="javascript" line>
<script language="javascript">

</script>
</syntaxhighlight>

== Audio object ==

readonly properties

*'''vlc.audio.count''': (supported in vlc version >= 1.1.0) returns the number of audio track available.

read/write properties

*'''vlc.audio.mute''': boolean value to mute and unmute the audio.
*'''vlc.audio.volume''': a value between [0-200] which indicates a percentage of the volume.
*'''vlc.audio.track''': (supported in vlc version > 0.8.6) a value between [1-65535] which indicates the audio track to play or that is playing. a value of 0 means the audio is/will be disabled.
*'''vlc.audio.channel''': (supported in vlc version > 0.8.6) integer value between [1-5] that indicates which audio channel mode is used, values can be: "1=stereo", "2=reverse stereo", "3=left", "4=right", "5=dolby". Use vlc.audio.channel to check if setting of the audio channel mode has succeeded.

methods

*'''vlc.audio.toggleMute()''': boolean toggle that mutes and unmutes the audio based upon the previous state.
*'''vlc.audio.description(int i)''': (supported in vlc version >= 1.1.0) give the i-th audio track name. 0 corresponds to disable and 1 to the first audio track.

=== Example ===

<syntaxhighlight lang="html5" line>
Audio Channel:
<select readonly onChange='doAudioChannel(this.value)'>
<option value=1>Stereo</option>
<option value=2>Reverse stereo</option>
<option value=3>Left</option>
<option value=4>Right</option>
<option value=5>Dolby</option>
</select>
</syntaxhighlight>
<br />
<syntaxhighlight lang="javascript" line>
<script language="javascript">

</script>
</syntaxhighlight>

== Input object ==

readonly properties

*'''vlc.input.length''': length of the input file in number of milliseconds. 0 is returned for 'live' streams or clips whose length cannot be determined by VLC. It returns -1 if no input is playing.
*'''vlc.input.fps''': frames per second returned as a float (typically 60.0, 50.0, 23.976, etc...)
*'''vlc.input.hasVout''': a boolean that returns true when the video is being displayed, it returns false when video is not displayed

read/write properties

*'''vlc.input.position''': normalized position in multimedia stream item given as a float value between [0.0 - 1.0]
*'''vlc.input.time''': the absolute position in time given in milliseconds, this property can be used to seek through the stream


vlc.input.time = <absolute seek>

vlc.input.time = vlc.input.time + <relative seek>

*'''vlc.input.state''': current state of the input chain given as enumeration (IDLE=0, OPENING=1, BUFFERING=2, PLAYING=3, PAUSED=4, STOPPING=5, ENDED=6, ERROR=7). Note: Test for ENDED=6 to catch end of playback. Checking for STOPPING=5 is NOT ENOUGH.
*'''vlc.input.rate''': input speed given as float (1.0 for normal speed, 0.5 for half speed, 2.0 for twice as fast, etc.).

rate > 1  : is fastforward
rate > 0 and rate < 1 : is slow motion
rate < 0  : is rewind

methods

*''none''

== Playlist object ==

readonly properties

*'''vlc.playlist.itemCount''': number that returns the amount of items currently in the playlist ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])
*'''vlc.playlist.isPlaying''': a boolean that returns true if the current playlist item is playing and false when it is not playing
*'''vlc.playlist.items''': return the playlist items collection, see [[#Playlist_items_object|Playlist items]]

read/write properties

*''none''

methods

*'''vlc.playlist.add(mrl)''': add a playlist item as [[MRL]]. The MRL must be given as a string. Returns a number as an item identifier in playlist (this is not a position in playlist).
*'''vlc.playlist.add(mrl,name,options)''': add a playlist item as MRL, with metaname 'name' and options 'options'. options are text arguments which can be provided either as a single string containing space separated values, akin to VLC command line, or as an array of string values. Returns a number as an item identifier in playlist (this is not a position in playlist).

<syntaxhighlight lang="javascript" line>
var options = new Array(":aspect-ratio=4:3", "--rtsp-tcp");
var id = vlc.playlist.add("rtsp://servername/item/to/play", "fancy name", options);
vlc.playlist.playItem(id);
</syntaxhighlight>

*'''vlc.playlist.play()''': start playing the current playlist item
*'''vlc.playlist.playItem(number)''': start playing the item whose identifier is number
*'''vlc.playlist.pause()''': pause the current playlist item
*'''vlc.playlist.togglePause()''': toggle the pause state for the current playlist item
*'''vlc.playlist.stop()''': stop playing the current playlist item
*'''vlc.playlist.next()''': iterate to the next playlist item
*'''vlc.playlist.prev()''': iterate to the previous playlist item
*'''vlc.playlist.clear()''': empty the current playlist, all items will be deleted from the playlist ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])
*'''vlc.playlist.removeItem(number)''': remove the item from playlist whose identifier is number  ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])

=== Playlist items object ===

readonly properties

*'''vlc.playlist.items.count''': number of items currently in the playlist

read/write properties

*''none''

methods

*'''vlc.playlist.items.clear()''': empty the current playlist, all items will be deleted from the playlist. If a movie is playing, it stop. Note that when this method returns, playlist may not have been entirely been cleared as this operation is performed asynchronously; use the ''count'' property to verify/wait until the playlist is empty.
*'''vlc.playlist.items.remove(number)''': remove the item whose identifier is number from playlist. (note: this number isn't the position in the playlist, but the number given by vlc.playlist.add() )

== Subtitle object ==

readonly properties

*'''vlc.subtitle.count''': (supported in vlc version >= 1.1.0) returns the number of subtitle available.

read/write properties

*'''vlc.subtitle.track''': (supported in vlc version >= 1.1.0) get and set the subtitle track to show on the video screen. The property takes an integer as input value [1..65535]. If subtitle track is set to 0, the subtitles will be disabled. If set to a value outside the current subtitle tracks range, then it will return -1 and display an error message.

methods

*'''vlc.subtitle.description(int i)''': (supported in vlc version >= 1.1.0) give the i-th subtitle name. 0 correspond to disable and 1 to the first subtitle.

== Video object ==

readonly properties

*'''vlc.video.width''': returns the horizontal size of the video
*'''vlc.video.height''': returns the vertical size of the video

read/write properties

*'''vlc.video.fullscreen''': when set to true the video will be displayed in fullscreen mode, when set to false the video will be shown inside the video output size. The property takes a boolean as input.
*'''vlc.video.aspectRatio''': get and set the aspect ratio to use in the video screen. The property takes a string as input value. Typical values are: "1:1", "4:3", "16:9", "16:10", "221:100" and "5:4"
*'''vlc.video.subtitle''': (supported in vlc version > 0.8.6a) get and set the subtitle track to show on the video screen. The property takes an integer as input value [1..65535]. If subtitle track is set to 0, the subtitles will be disabled. If set to a value outside the current subtitle tracks range, then it will return -1 and display an error message.
*'''vlc.video.teletext''': (supported in vlc version >= 0.9.0) get and set teletext page to show on the video stream. This will only work if a teletext elementary stream is available in the video stream. The property takes an integer as input value [0..999] for indicating the teletext page to view, setting the value to 0 means hide teletext. On error it will return -1 and display an error message.

methods

*'''vlc.video.toggleFullscreen()''': toggle the fullscreen mode based on the previous setting
*'''vlc.video.toggleTeletext()''': (supported in vlc version >= 0.9.0) toggle the teletext page to overlay transparent or not, based on the previous setting

=== Deinterlace Object ===

readonly properties

*''none''

read/write properties

*''none''

methods

*'''vlc.video.deinterlace.enable("my_mode")''': (supported in vlc version >= 1.1.0) enable deinterlacing with my_mode. You can enable it with "blend", "bob", "discard", "linear", "mean", "x", "yadif" or "yadif2x" mode. Enabling too soon deinterlacing may cause some problems. You have to wait that all variable are available before enabling it.
*'''vlc.video.deinterlace.disable()''': (supported in vlc version >= 1.1.0) disable deinterlacing.

=== Marquee Object ===

readonly properties

*''none''

read/write properties

*'''vlc.video.marquee.text''': (supported in vlc version >= 1.1.0) display my text on the screen.
*'''vlc.video.marquee.color''': (supported in vlc version >= 1.1.0) change the text color. val is the new color to use (WHITE=0x000000, BLACK=0xFFFFFF, RED=0xFF0000, GREEN=0x00FF00, BLUE=0x0000FF...).
*'''vlc.video.marquee.opacity''': (supported in vlc version >= 1.1.0) change the text opacity, val is defined from 0 (completely transparent) to 255 (completely opaque).
*'''vlc.video.marquee.position''': (supported in vlc version >= 1.1.0) change the text position (CENTER=0, LEFT=1, RIGHT=2, TOP=4, TOP-LEFT=5, TOP-RIGHT=6, BOTTOM=8, BOTTOM-LEFT=9, BOTTOM_RIGHT=10).
*'''vlc.video.marquee.refresh''': (supported in vlc version >= 1.1.0) change the marquee refresh period.
*'''vlc.video.marquee.size''': (supported in vlc version >= 1.1.0) val define the new size for the text displayed on the screen. If the text is bigger than the screen then the text is not displayed.
*'''vlc.video.marquee.timeout''': (supported in vlc version >= 1.1.0) change the timeout value. val is defined in ms, but 0 value correspond to unlimited.
*'''vlc.video.marquee.x''': (supported in vlc version >= 1.1.0) change text abscissa.
*'''vlc.video.marquee.y''': (supported in vlc version >= 1.1.0) change text ordinate.

methods

*'''vlc.video.marquee.enable()''': (supported in vlc version >= 1.1.0) enable marquee filter.
*'''vlc.video.marquee.disable()''': (supported in vlc version >= 1.1.0) disable marquee filter.

Some problems may happen (option like color or text will not be applied) because of the VLC asynchronous functioning. To avoid it, after enabling marquee, you have to wait a little time before changing an option. But it should be fixed by the new vout implementation.

NOTE: [http://forum.videolan.org/viewtopic.php?f=16&t=89427#p295058]

=== Logo Object ===

readonly properties

*''none''

read/write properties

*'''vlc.video.logo.opacity''': (supported in vlc version >= 1.1.0) change the picture opacity, val is defined from 0 (completely transparent) to 255 (completely opaque).
*'''vlc.video.logo.position''': (supported in vlc version >= 1.1.0) change the text position ("center", "left", "right", "top", "top-left", "top-right", "bottom", "bottom-left", "bottom-right").
*'''vlc.video.logo.delay''': (supported in vlc version >= 1.1.0) display each picture for a duration of 1000 ms (default) before displaying the next picture.
*'''vlc.video.logo.repeat''': (supported in vlc version >= 1.1.0) number of loops for picture animation (-1=continuous, 0=disabled, n=n-times). The default is -1 (continuous).
*'''vlc.video.logo.x''': (supported in vlc version >= 1.1.0) change the x-offset for displaying the picture counting from top-left on the screen.
*'''vlc.video.logo.y''': (supported in vlc version >= 1.1.0) change the y-offset for displaying the picture counting from top-left on the screen.
*'''vlc.video.logo.width''': (supported in vlc version >= 1.1.0) change the picture width.
*'''vlc.video.logo.height''': (supported in vlc version >= 1.1.0) change the picture height.

methods

*'''vlc.video.logo.enable()''': (supported in vlc version >= 1.1.0) enable logo video filter.
*'''vlc.video.logo.disable()''': (supported in vlc version >= 1.1.0) disable logo video filter.
*'''vlc.video.logo.file("file.png")''': (supported in vlc version >= 1.1.0) display my file.png as logo on the screen.

Some problems may happen because of the VLC asynchronous functioning. To avoid it, after enabling logo video filter, you have to wait a little time before changing an option. But it should be fixed by the new vout implementation.

== MediaDescription Object ==

readonly properties

*'''vlc.mediaDescription.title''': (supported in vlc version >= 2.0.2) returns title meta information field.
*'''vlc.mediaDescription.artist''': (supported in vlc version >= 2.0.2) returns artist meta information field.
*'''vlc.mediaDescription.copyright''': (supported in vlc version >= 2.0.2) returns copyright meta information field.
*'''vlc.mediaDescription.album''': (supported in vlc version >= 2.0.2) returns album meta information field.
*'''vlc.mediaDescription.trackNumber''': (supported in vlc version >= 2.0.2) returns trackNumber meta information field.
*'''vlc.mediaDescription.description''': (supported in vlc version >= 2.0.2) returns description meta information field.
*'''vlc.mediaDescription.rating''': (supported in vlc version >= 2.0.2) returns rating meta information field.
*'''vlc.mediaDescription.date''': (supported in vlc version >= 2.0.2) returns date meta information field.
*'''vlc.mediaDescription.setting''': (supported in vlc version >= 2.0.2) returns setting meta information field.
*'''vlc.mediaDescription.URL''': (supported in vlc version >= 2.0.2) returns URL meta information field.
*'''vlc.mediaDescription.language''': (supported in vlc version >= 2.0.2) returns language meta information field.
*'''vlc.mediaDescription.nowPlaying''': (supported in vlc version >= 2.0.2) returns nowPlaying meta information field.
*'''vlc.mediaDescription.publisher''': (supported in vlc version >= 2.0.2) returns publisher meta information field.
*'''vlc.mediaDescription.encodedBy''': (supported in vlc version >= 2.0.2) returns encodedBy meta information field.

*'''vlc.mediaDescription.artworkURL''': (supported in vlc version >= 2.0.2) returns artworkURL meta information field.

*'''vlc.mediaDescription.trackID''': (supported in vlc version >= 2.0.2) returns trackID meta information field.

read/write properties

*''none''

methods

*''none''

== DEPRECATED APIs ==
=== DEPRECATED: Log object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

This object allows accessing VLC main message logging queue. Typically this queue capacity is very small (no nore than 256 entries) and can easily overflow, therefore messages should be read and cleared as often as possible.

readonly properties

*'''vlc.log.messages''': returns the message collection, see [[#Messages_object|Messages object]]

read/write properties

*'''vlc.log.verbosity''': write number [-1,0,1,2,3] for changing the verbosity level of the log messages; messages whose verbosity is higher than set will be not be logged in the queue. The numbers have the following meaning: -1 disable, 0 info, 1 error, 2 warning, 3 debug.

methods

*''none''

=== DEPRECATED: Messages object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

readonly properties

*'''messages.count''': returns number of messages in the log

read/write properties

*''none''

methods

*'''messages.clear()''': clear the current log buffer. It should be called as frequently as possible to not overflow the message queue. Call this method after the log messages of interest are read.
*'''messages.iterator()''': creates and returns an iterator object, used to iterate over the messages in the log. '''Don't clear the log buffer while holding an iterator object.'''

=== DEPRECATED: Messages Iterator object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

readonly properties

*'''iterator.hasNext''': returns a boolean that indicates whether ''vlc.log.messages.next()'' will return the next message.

read/write properties

*''none''

methods

*'''iterator.next()''': returns the next message object in the log, see [[Message object]]

=== DEPRECATED: Message subobject ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

*'''message.severity''': number that indicates the severity of the log message (0 = info, 1 = error, 2 = warning, 3 = debug)
*'''message.name''': name of VLC module that printed the log message (e.g: main, http, directx, etc...)
*'''message.type''': type of VLC module that printed the log message (eg: input, access, vout, sout, etc...)
*'''message.message''': the message text

{{Documentation}}

[[Category:Embedded]]

Documentation:WebPlugin

2013-01-02T14:21:20Z

Etix: Typo

This Documentation speaks about the {{VLC}} Web plugins and how to write pages for it.
{{RightMenu|documentation play howto toc}}

= Introduction: Building Web pages with Video =

The {{VLC}} webplugins are native browser plugins, similar to Flash or Silverlight plugins and allow playback inside the browser of all the videos that {{VLC}} can read.

Additionally to viewing video on all pages, you can build custom pages that will use the advanced features of the plugin, using Javascript functions to control playback or extract information from the plugin.

There are 2 main plugins: one is ActiveX for IE, the other is NPAPI for the other browsers. They feature the same amount of features.

In older versions, those plugins were very crashy. '''We URGE YOU''' to use VLC '''2.0.0''' or newer versions.

=== Browsers support ===
It has been tested with:
* Mozilla Firefox [[Image:Firefox-logo.png|40x40px]]
* Internet Explorer [[Image:20101105053305!Internet Explorer 9.png|40x40px]]
* Safari [[Image:Apple Safari.png|40x40px]]
* Chrome
* Konqueror
* Opera

It has been tested on GNU/Linux, Windows and MacOS.

= Embed tag attributes =

To embed the plugin into a webpage use the following <embed> template:

<syntaxhighlight lang="javascript" line>
<embed type="application/x-vlc-plugin" pluginspage="http://www.videolan.org" />
<object classid="clsid:9BE31822-FDAD-461B-AD51-BE1D1C159921" codebase="http://download.videolan.org/pub/videolan/vlc/last/win32/axvlc.cab"></object>
</syntaxhighlight>

=== Required elements ===
These are '''required''' attributes for the <embed> tag:

*'''width''': Specifies the width of the plugin.
*'''height''': Specifies the height of the plugin.
*'''target''' (or one of these alias: '''mrl''', '''filename''', '''src'''): Specifies the source location (URL) of the video to load.

=== Optionnal elements ===
These are additional attributes for the <embed> tag:

*'''autoplay''', '''autostart''': Specifies whether the plugin starts playing on load. Default: ''true''
*'''allowfullscreen''': (since VLC version 1.2.0) Specifies whether the user can switch into fullscreen mode. Default: ''true''
*'''windowless''': (since VLC version 2.0.6) Draw the video on a window-less (non-accelerated) surface and allow styling (CSS overlay, 3D transformations, and much more). Default: ''false''
*'''mute''': Specifies whether the audio volume is initially muted. Default: ''false''
*'''loop''', '''autoloop''': Specifies whether the video loops on end. Default: ''false''
*'''toolbar''': Specifies whether the toolbar is shown by default. Default: ''true''
*'''bgcolor''': Specifies the background color of the video player. Default: ''#000000''

=== Normal DOM elements ===
*'''id''': DOM id
*'''name''': DOM name

= Javascript API description =

The vlc plugin exports several objects that can be accessed for setting and getting information. When used improperly the API's will throw an exception that includes a string that explains what happened. For example when asking for vlc.input.length when there is no playlist item playing.

== VLC objects ==
The vlc plugin knows the following objects:

*'''audio''': Access audio properties.
*'''input''': Access input properties.
*'''playlist''': Access playlist properties.
*'''subtitle''': Access subtitle properties.
*'''video''': Access video properties.
**'''video.marquee''': Access marquee video filter properties.
**'''video.logo''': Access logo video filter properties.
*'''mediaDescription''': Access media info properties (only available in vlc version >= 2.0.2).

The following are deprecated:
*'''log''': Access log properties (only available in vlc version <= 1.0.0-rc1).
*'''messages''': Access to log message properties (only available in vlc version <= 1.0.0-rc1).
*'''iterator''': Access to log iterator properties (only available in vlc version <= 1.0.0-rc1).
*'''message''': Access to log message properties (only available in vlc version <= 1.0.0-rc1).

=== Example ===
The following JavaScript code shows howto get a reference to the vlc plugin. This reference can then be used to access the objects of the vlc plugin.

<syntaxhighlight lang="javascript" line>
<html>
<title>VLC Mozilla plugin test page</title>
<body>
<embed type="application/x-vlc-plugin" pluginspage="http://www.videolan.org"
width="640"
height="480"
id="vlc">
</embed>
<script language="Javascript">

</script>
</body>
</html>
</syntaxhighlight>

== Root object ==

readonly properties

*'''VersionInfo''': returns version information string

read/write properties

*''none''

methods

*'''vlc.versionInfo()''': returns version information string (same as VersionInfo)

*'''vlc.addEventListener(eventname, callback, bubble)''': (only for Mozilla) add a listener for mentioned event name, callback expects a function and bubble influences the order of eventhandling by JS (usually it is set to false).
*'''vlc.removeEventListener(eventname, callback, bubble)''': (only for Mozilla) remove listener for mentioned event name, callback expects a function and bubble influences the order of eventhandling by JS (usually it is set to false).

*'''vlc.attachEvent(eventname, callback)''': (only for ActiveX) add listener for mentioned event name, callback expects a function
*'''vlc.removeEvent(eventname, callback)''': (only for ActiveX) remove listener for mentioned event name, callback expects a function

events

*'''MediaPlayerNothingSpecial''': vlc is in idle state doing nothing but waiting for a command to be issued
*'''MediaPlayerOpening''': vlc is opening an media resource locator (MRL)
*'''MediaPlayerBuffering''': vlc is buffering
*'''MediaPlayerPlaying''': vlc is playing a media
*'''MediaPlayerPaused''': vlc is in paused state
*'''MediaPlayerForward''': vlc is fastforwarding through the media (works only when an input supports forward playback)
*'''MediaPlayerBackward''': vlc is going backwards through the media (works only when an input supports backwards playback)
*'''MediaPlayerEncounteredError''': vlc has encountered an error and is unable to continue
*'''MediaPlayerEndReached''': vlc has reached the end of current playlist
*'''MediaPlayerTimeChanged''': time has changed
*'''MediaPlayerPositionChanged''': media position has changed
*'''MediaPlayerSeekableChanged''': media seekable flag has changed (true means media is seekable, false means it is not)
*'''MediaPlayerPausableChanged''': media pausable flag has changed (true means media is pauseable, false means it is not)

=== Example ===
The following code snippet provides easy functions to register and unregister event callbacks on all supported platforms (currently only Linux mozilla based browsers and windows activeX objects for Internet Explorer).

<syntaxhighlight lang="javascript" line>
<script language="javascript">

</script>
</syntaxhighlight>

== Audio object ==

readonly properties

*'''vlc.audio.count''': (supported in vlc version >= 1.1.0) returns the number of audio track available.

read/write properties

*'''vlc.audio.mute''': boolean value to mute and unmute the audio.
*'''vlc.audio.volume''': a value between [0-200] which indicates a percentage of the volume.
*'''vlc.audio.track''': (supported in vlc version > 0.8.6) a value between [1-65535] which indicates the audio track to play or that is playing. a value of 0 means the audio is/will be disabled.
*'''vlc.audio.channel''': (supported in vlc version > 0.8.6) integer value between [1-5] that indicates which audio channel mode is used, values can be: "1=stereo", "2=reverse stereo", "3=left", "4=right", "5=dolby". Use vlc.audio.channel to check if setting of the audio channel mode has succeeded.

methods

*'''vlc.audio.toggleMute()''': boolean toggle that mutes and unmutes the audio based upon the previous state.
*'''vlc.audio.description(int i)''': (supported in vlc version >= 1.1.0) give the i-th audio track name. 0 corresponds to disable and 1 to the first audio track.

=== Example ===

<syntaxhighlight lang="html5" line>
Audio Channel:
<select readonly onChange='doAudioChannel(this.value)'>
<option value=1>Stereo</option>
<option value=2>Reverse stereo</option>
<option value=3>Left</option>
<option value=4>Right</option>
<option value=5>Dolby</option>
</select>
</syntaxhighlight>
<br />
<syntaxhighlight lang="javascript" line>
<script language="javascript">

</script>
</syntaxhighlight>

== Input object ==

readonly properties

*'''vlc.input.length''': length of the input file in number of milliseconds. 0 is returned for 'live' streams or clips whose length cannot be determined by VLC. It returns -1 if no input is playing.
*'''vlc.input.fps''': frames per second returned as a float (typically 60.0, 50.0, 23.976, etc...)
*'''vlc.input.hasVout''': a boolean that returns true when the video is being displayed, it returns false when video is not displayed

read/write properties

*'''vlc.input.position''': normalized position in multimedia stream item given as a float value between [0.0 - 1.0]
*'''vlc.input.time''': the absolute position in time given in milliseconds, this property can be used to seek through the stream


vlc.input.time = <absolute seek>

vlc.input.time = vlc.input.time + <relative seek>

*'''vlc.input.state''': current state of the input chain given as enumeration (IDLE=0, OPENING=1, BUFFERING=2, PLAYING=3, PAUSED=4, STOPPING=5, ENDED=6, ERROR=7). Note: Test for ENDED=6 to catch end of playback. Checking for STOPPING=5 is NOT ENOUGH.
*'''vlc.input.rate''': input speed given as float (1.0 for normal speed, 0.5 for half speed, 2.0 for twice as fast, etc.).

rate > 1  : is fastforward
rate > 0 and rate < 1 : is slow motion
rate < 0  : is rewind

methods

*''none''

== Playlist object ==

readonly properties

*'''vlc.playlist.itemCount''': number that returns the amount of items currently in the playlist ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])
*'''vlc.playlist.isPlaying''': a boolean that returns true if the current playlist item is playing and false when it is not playing
*'''vlc.playlist.items''': return the playlist items collection, see [[#Playlist_items_object|Playlist items]]

read/write properties

*''none''

methods

*'''vlc.playlist.add(mrl)''': add a playlist item as [[MRL]]. The MRL must be given as a string. Returns a number as an item identifier in playlist (this is not a position in playlist).
*'''vlc.playlist.add(mrl,name,options)''': add a playlist item as MRL, with metaname 'name' and options 'options'. options are text arguments which can be provided either as a single string containing space separated values, akin to VLC command line, or as an array of string values. Returns a number as an item identifier in playlist (this is not a position in playlist).

<syntaxhighlight lang="javascript" line>
var options = new Array(":aspect-ratio=4:3", "--rtsp-tcp");
var id = vlc.playlist.add("rtsp://servername/item/to/play", "fancy name", options);
vlc.playlist.playItem(id);
</syntaxhighlight>

*'''vlc.playlist.play()''': start playing the current playlist item
*'''vlc.playlist.playItem(number)''': start playing the item whose identifier is number
*'''vlc.playlist.pause()''': pause the current playlist item
*'''vlc.playlist.togglePause()''': toggle the pause state for the current playlist item
*'''vlc.playlist.stop()''': stop playing the current playlist item
*'''vlc.playlist.next()''': iterate to the next playlist item
*'''vlc.playlist.prev()''': iterate to the previous playlist item
*'''vlc.playlist.clear()''': empty the current playlist, all items will be deleted from the playlist ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])
*'''vlc.playlist.removeItem(number)''': remove the item from playlist whose identifier is number  ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])

=== Playlist items object ===

readonly properties

*'''vlc.playlist.items.count''': number of items currently in the playlist

read/write properties

*''none''

methods

*'''vlc.playlist.items.clear()''': empty the current playlist, all items will be deleted from the playlist. If a movie is playing, it stop. Note that when this method returns, playlist may not have been entirely been cleared as this operation is performed asynchronously; use the ''count'' property to verify/wait until the playlist is empty.
*'''vlc.playlist.items.remove(number)''': remove the item whose identifier is number from playlist. (note: this number isn't the position in the playlist, but the number given by vlc.playlist.add() )

== Subtitle object ==

readonly properties

*'''vlc.subtitle.count''': (supported in vlc version >= 1.1.0) returns the number of subtitle available.

read/write properties

*'''vlc.subtitle.track''': (supported in vlc version >= 1.1.0) get and set the subtitle track to show on the video screen. The property takes an integer as input value [1..65535]. If subtitle track is set to 0, the subtitles will be disabled. If set to a value outside the current subtitle tracks range, then it will return -1 and display an error message.

methods

*'''vlc.subtitle.description(int i)''': (supported in vlc version >= 1.1.0) give the i-th subtitle name. 0 correspond to disable and 1 to the first subtitle.

== Video object ==

readonly properties

*'''vlc.video.width''': returns the horizontal size of the video
*'''vlc.video.height''': returns the vertical size of the video

read/write properties

*'''vlc.video.fullscreen''': when set to true the video will be displayed in fullscreen mode, when set to false the video will be shown inside the video output size. The property takes a boolean as input.
*'''vlc.video.aspectRatio''': get and set the aspect ratio to use in the video screen. The property takes a string as input value. Typical values are: "1:1", "4:3", "16:9", "16:10", "221:100" and "5:4"
*'''vlc.video.subtitle''': (supported in vlc version > 0.8.6a) get and set the subtitle track to show on the video screen. The property takes an integer as input value [1..65535]. If subtitle track is set to 0, the subtitles will be disabled. If set to a value outside the current subtitle tracks range, then it will return -1 and display an error message.
*'''vlc.video.teletext''': (supported in vlc version >= 0.9.0) get and set teletext page to show on the video stream. This will only work if a teletext elementary stream is available in the video stream. The property takes an integer as input value [0..999] for indicating the teletext page to view, setting the value to 0 means hide teletext. On error it will return -1 and display an error message.

methods

*'''vlc.video.toggleFullscreen()''': toggle the fullscreen mode based on the previous setting
*'''vlc.video.toggleTeletext()''': (supported in vlc version >= 0.9.0) toggle the teletext page to overlay transparent or not, based on the previous setting

=== Deinterlace Object ===

readonly properties

*''none''

read/write properties

*''none''

methods

*'''vlc.video.deinterlace.enable("my_mode")''': (supported in vlc version >= 1.1.0) enable deinterlacing with my_mode. You can enable it with "blend", "bob", "discard", "linear", "mean", "x", "yadif" or "yadif2x" mode. Enabling too soon deinterlacing may cause some problems. You have to wait that all variable are available before enabling it.
*'''vlc.video.deinterlace.disable()''': (supported in vlc version >= 1.1.0) disable deinterlacing.

=== Marquee Object ===

readonly properties

*''none''

read/write properties

*'''vlc.video.marquee.text''': (supported in vlc version >= 1.1.0) display my text on the screen.
*'''vlc.video.marquee.color''': (supported in vlc version >= 1.1.0) change the text color. val is the new color to use (WHITE=0x000000, BLACK=0xFFFFFF, RED=0xFF0000, GREEN=0x00FF00, BLUE=0x0000FF...).
*'''vlc.video.marquee.opacity''': (supported in vlc version >= 1.1.0) change the text opacity, val is defined from 0 (completely transparent) to 255 (completely opaque).
*'''vlc.video.marquee.position''': (supported in vlc version >= 1.1.0) change the text position (CENTER=0, LEFT=1, RIGHT=2, TOP=4, TOP-LEFT=5, TOP-RIGHT=6, BOTTOM=8, BOTTOM-LEFT=9, BOTTOM_RIGHT=10).
*'''vlc.video.marquee.refresh''': (supported in vlc version >= 1.1.0) change the marquee refresh period.
*'''vlc.video.marquee.size''': (supported in vlc version >= 1.1.0) val define the new size for the text displayed on the screen. If the text is bigger than the screen then the text is not displayed.
*'''vlc.video.marquee.timeout''': (supported in vlc version >= 1.1.0) change the timeout value. val is defined in ms, but 0 value correspond to unlimited.
*'''vlc.video.marquee.x''': (supported in vlc version >= 1.1.0) change text abscissa.
*'''vlc.video.marquee.y''': (supported in vlc version >= 1.1.0) change text ordinate.

methods

*'''vlc.video.marquee.enable()''': (supported in vlc version >= 1.1.0) enable marquee filter.
*'''vlc.video.marquee.disable()''': (supported in vlc version >= 1.1.0) disable marquee filter.

Some problems may happen (option like color or text will not be applied) because of the VLC asynchronous functioning. To avoid it, after enabling marquee, you have to wait a little time before changing an option. But it should be fixed by the new vout implementation.

NOTE: [http://forum.videolan.org/viewtopic.php?f=16&t=89427#p295058]

=== Logo Object ===

readonly properties

*''none''

read/write properties

*'''vlc.video.logo.opacity''': (supported in vlc version >= 1.1.0) change the picture opacity, val is defined from 0 (completely transparent) to 255 (completely opaque).
*'''vlc.video.logo.position''': (supported in vlc version >= 1.1.0) change the text position ("center", "left", "right", "top", "top-left", "top-right", "bottom", "bottom-left", "bottom-right").
*'''vlc.video.logo.delay''': (supported in vlc version >= 1.1.0) display each picture for a duration of 1000 ms (default) before displaying the next picture.
*'''vlc.video.logo.repeat''': (supported in vlc version >= 1.1.0) number of loops for picture animation (-1=continuous, 0=disabled, n=n-times). The default is -1 (continuous).
*'''vlc.video.logo.x''': (supported in vlc version >= 1.1.0) change the x-offset for displaying the picture counting from top-left on the screen.
*'''vlc.video.logo.y''': (supported in vlc version >= 1.1.0) change the y-offset for displaying the picture counting from top-left on the screen.
*'''vlc.video.logo.width''': (supported in vlc version >= 1.1.0) change the picture width.
*'''vlc.video.logo.height''': (supported in vlc version >= 1.1.0) change the picture height.

methods

*'''vlc.video.logo.enable()''': (supported in vlc version >= 1.1.0) enable logo video filter.
*'''vlc.video.logo.disable()''': (supported in vlc version >= 1.1.0) disable logo video filter.
*'''vlc.video.logo.file("file.png")''': (supported in vlc version >= 1.1.0) display my file.png as logo on the screen.

Some problems may happen because of the VLC asynchronous functioning. To avoid it, after enabling logo video filter, you have to wait a little time before changing an option. But it should be fixed by the new vout implementation.

== MediaDescription Object ==

readonly properties

*'''vlc.mediaDescription.title''': (supported in vlc version >= 2.0.2) returns title meta information field.
*'''vlc.mediaDescription.artist''': (supported in vlc version >= 2.0.2) returns artist meta information field.
*'''vlc.mediaDescription.copyright''': (supported in vlc version >= 2.0.2) returns copyright meta information field.
*'''vlc.mediaDescription.album''': (supported in vlc version >= 2.0.2) returns album meta information field.
*'''vlc.mediaDescription.trackNumber''': (supported in vlc version >= 2.0.2) returns trackNumber meta information field.
*'''vlc.mediaDescription.description''': (supported in vlc version >= 2.0.2) returns description meta information field.
*'''vlc.mediaDescription.rating''': (supported in vlc version >= 2.0.2) returns rating meta information field.
*'''vlc.mediaDescription.date''': (supported in vlc version >= 2.0.2) returns date meta information field.
*'''vlc.mediaDescription.setting''': (supported in vlc version >= 2.0.2) returns setting meta information field.
*'''vlc.mediaDescription.URL''': (supported in vlc version >= 2.0.2) returns URL meta information field.
*'''vlc.mediaDescription.language''': (supported in vlc version >= 2.0.2) returns language meta information field.
*'''vlc.mediaDescription.nowPlaying''': (supported in vlc version >= 2.0.2) returns nowPlaying meta information field.
*'''vlc.mediaDescription.publisher''': (supported in vlc version >= 2.0.2) returns publisher meta information field.
*'''vlc.mediaDescription.encodedBy''': (supported in vlc version >= 2.0.2) returns encodedBy meta information field.

*'''vlc.mediaDescription.artworkURL''': (supported in vlc version >= 2.0.2) returns artworkURL meta information field.

*'''vlc.mediaDescription.trackID''': (supported in vlc version >= 2.0.2) returns trackID meta information field.

read/write properties

*''none''

methods

*''none''

== DEPRECATED APIs ==
=== DEPRECATED: Log object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

This object allows accessing VLC main message logging queue. Typically this queue capacity is very small (no nore than 256 entries) and can easily overflow, therefore messages should be read and cleared as often as possible.

readonly properties

*'''vlc.log.messages''': returns the message collection, see [[#Messages_object|Messages object]]

read/write properties

*'''vlc.log.verbosity''': write number [-1,0,1,2,3] for changing the verbosity level of the log messages; messages whose verbosity is higher than set will be not be logged in the queue. The numbers have the following meaning: -1 disable, 0 info, 1 error, 2 warning, 3 debug.

methods

*''none''

=== DEPRECATED: Messages object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

readonly properties

*'''messages.count''': returns number of messages in the log

read/write properties

*''none''

methods

*'''messages.clear()''': clear the current log buffer. It should be called as frequently as possible to not overflow the message queue. Call this method after the log messages of interest are read.
*'''messages.iterator()''': creates and returns an iterator object, used to iterate over the messages in the log. '''Don't clear the log buffer while holding an iterator object.'''

=== DEPRECATED: Messages Iterator object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

readonly properties

*'''iterator.hasNext''': returns a boolean that indicates whether ''vlc.log.messages.next()'' will return the next message.

read/write properties

*''none''

methods

*'''iterator.next()''': returns the next message object in the log, see [[Message object]]

=== DEPRECATED: Message subobject ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

*'''message.severity''': number that indicates the severity of the log message (0 = info, 1 = error, 2 = warning, 3 = debug)
*'''message.name''': name of VLC module that printed the log message (e.g: main, http, directx, etc...)
*'''message.type''': type of VLC module that printed the log message (eg: input, access, vout, sout, etc...)
*'''message.message''': the message text

{{Documentation}}

[[Category:Embedded]]

Documentation:WebPlugin

2013-01-02T14:15:45Z

Etix: Bump recommended version to 2.0.0

This Documentation speaks about the {{VLC}} Web plugins and how to write pages for it.
{{RightMenu|documentation play howto toc}}

= Introduction: Building Web pages with Video =

The {{VLC}} webplugins are native browser plugins, similar to Flash or Silverlight plugins and allow playback inside the browser of all the videos that {{VLC}} can read.

Additionally to viewing video on all pages, you can build custom pages that will use the advanced features of the plugin, using Javascript functions to control playback or extract information from the plugin.

There are 2 main plugins: one is ActiveX for IE, the other is NPAPI for the other browsers. They feature the same amount of features.

In older versions, those plugins were very crashy. '''We URGE YOU''' to use VLC '''2.0.0''' or newer versions.

=== Browsers support ===
It has been tested with:
* Mozilla Firefox [[Image:Firefox-logo.png|40x40px]]
* Internet Explorer [[Image:20101105053305!Internet Explorer 9.png|40x40px]]
* Safari [[Image:Apple Safari.png|40x40px]]
* Chrome
* Konqueror
* Opera

It has been tested on GNU/Linux, Windows and MacOS.

= Embed tag attributes =

To embed the plugin into a webpage use the following <embed> template:

<syntaxhighlight lang="javascript" line>
<embed type="application/x-vlc-plugin" pluginspage="http://www.videolan.org" />
<object classid="clsid:9BE31822-FDAD-461B-AD51-BE1D1C159921" codebase="http://download.videolan.org/pub/videolan/vlc/last/win32/axvlc.cab"></object>
</syntaxhighlight>

=== Required elements ===
These are '''required''' attributes for the <embed> tag:

*'''width''': Specifies the width of the plugin.
*'''height''': Specifies the height of the plugin.
*'''target''' (or one of these alias: '''mrl''', '''filename''', '''src'''): Specifies the source location (URL) of the video to load.

=== Optionnal elements ===
These are additional attributes for the <embed> tag:

*'''autoplay''', '''autostart''': Specifies whether the plugin starts playing on load. Default: ''true''
*'''allowfullscreen''': (since VLC version 1.2.0) Specifies whether the user can switch into fullscreen mode. Default: ''true''
*'''windowless''': (since VLC version 2.0.6) Draw the video on a window-less (non-accelerated) surface and allow styling (CSS overlay, 3D transformations, and much more). Default: ''false''
*'''mute''': Specifies whether the audio volume is initially muted. Default: ''false''
*'''loop''', '''autoloop''': Specifies whether the video loops on end. Default: ''false''
*'''toolbar''': Specifies whether the toolbar is shown by default. Default: ''true''
*'''bgcolor''': Specifies the background color of the video player. Default: ''#000000''

=== Normal DOM elements ===
*'''id''': DOM id
*'''name''': DOM name

= Javascript API description =

The vlc plugin exports several objects that can be accessed for setting and getting information. When used improperly the API's will throw an exception that includes a string that explains what happened. For example when asking for vlc.input.length when there is no playlist item playing.

== VLC objects ==
The vlc plugin knows the following objects:

*'''audio''': Access audio properties.
*'''input''': Access input properties.
*'''playlist''': Access playlist properties.
*'''subtitle''': Access subtitle properties.
*'''video''': Access video properties.
**'''video.marquee''': Access marquee video filter properties.
**'''video.logo''': Access logo video filter properties.
*'''mediaDescription''': Access media info properties (only available in vlc version >= 2.0.2).

The following are deprecated:
*'''log''': Access log properties (only available in vlc version <= 1.0.0-rc1).
*'''messages''': Access to log message properties (only available in vlc version <= 1.0.0-rc1).
*'''iterator''': Access to log iterator properties (only available in vlc version <= 1.0.0-rc1).
*'''message''': Access to log message properties (only available in vlc version <= 1.0.0-rc1).

=== Example ===
The following JavaScript code shows howto get a reference to the vlc plugin. This reference can then be used to access the objects of the vlc plugin.

<syntaxhighlight lang="javascript" line>
<html>
<title>VLC Mozilla plugin test page</title>
<body>
<embed type="application/x-vlc-plugin" pluginspage="http://www.videolan.org"
width="640"
height="480"
id="vlc">
</embed>
<script language="Javascript">

</script>
</body>
</html>
</syntaxhighlight>

== Root object ==

readonly properties

*'''VersionInfo''': returns version information string

read/write properties

*''none''

methods

*'''vlc.versionInfo()''': returns version information string (same as VersionInfo)

*'''vlc.addEventListener(eventname, callback, bubble)''': (only for Mozilla) add a listener for mentioned event name, callback expects a function and bubble influences the order of eventhandling by JS (usually it is set to false).
*'''vlc.removeEventListener(eventname, callback, bubble)''': (only for Mozilla) remove listener for mentioned event name, callback expects a function and bubble influences the order of eventhandling by JS (usually it is set to false).

*'''vlc.attachEvent(eventname, callback)''': (only for ActiveX) add listener for mentioned event name, callback expects a function
*'''vlc.removeEvent(eventname, callback)''': (only for ActiveX) remove listener for mentioned event name, callback expects a function

events

*'''MediaPlayerNothingSpecial''': vlc is in idle state doing nothing but waiting for a command to be issued
*'''MediaPlayerOpening''': vlc is opening an media resource locator (MRL)
*'''MediaPlayerBuffering''': vlc is buffering
*'''MediaPlayerPlaying''': vlc is playing a media
*'''MediaPlayerPaused''': vlc is in paused state
*'''MediaPlayerForward''': vlc is fastforwarding through the media (works only when an input supports forward playback)
*'''MediaPlayerBackward''': vlc is going backwards through the media (works only when an input supports backwards playback)
*'''MediaPlayerEncounteredError''': vlc has encountered an error and is unable to continue
*'''MediaPlayerEndReached''': vlc has reached the end of current playlist
*'''MediaPlayerTimeChanged''': time has changed
*'''MediaPlayerPositionChanged''': media position has changed
*'''MediaPlayerSeekableChanged''': media seekable flag has changed (true means media is seekable, false means it is not)
*'''MediaPlayerPausableChanged''': media pausable flag has changed (true means media is pauseable, false means it is not)

=== Example ===
The following code snippit provides easy functions to register and unregister event callbacks on all supported platforms (currently only Linux mozilla based browsers and windows activeX objects for Internet Explorer).

<syntaxhighlight lang="javascript" line>
<script language="javascript">

</script>
</syntaxhighlight>

== Audio object ==

readonly properties

*'''vlc.audio.count''': (supported in vlc version >= 1.1.0) returns the number of audio track available.

read/write properties

*'''vlc.audio.mute''': boolean value to mute and unmute the audio.
*'''vlc.audio.volume''': a value between [0-200] which indicates a percentage of the volume.
*'''vlc.audio.track''': (supported in vlc version > 0.8.6) a value between [1-65535] which indicates the audio track to play or that is playing. a value of 0 means the audio is/will be disabled.
*'''vlc.audio.channel''': (supported in vlc version > 0.8.6) integer value between [1-5] that indicates which audio channel mode is used, values can be: "1=stereo", "2=reverse stereo", "3=left", "4=right", "5=dolby". Use vlc.audio.channel to check if setting of the audio channel mode has succeeded.

methods

*'''vlc.audio.toggleMute()''': boolean toggle that mutes and unmutes the audio based upon the previous state.
*'''vlc.audio.description(int i)''': (supported in vlc version >= 1.1.0) give the i-th audio track name. 0 corresponds to disable and 1 to the first audio track.

=== Example ===

<syntaxhighlight lang="html5" line>
Audio Channel:
<select readonly onChange='doAudioChannel(this.value)'>
<option value=1>Stereo</option>
<option value=2>Reverse stereo</option>
<option value=3>Left</option>
<option value=4>Right</option>
<option value=5>Dolby</option>
</select>
</syntaxhighlight>
<br />
<syntaxhighlight lang="javascript" line>
<script language="javascript">

</script>
</syntaxhighlight>

== Input object ==

readonly properties

*'''vlc.input.length''': length of the input file in number of milliseconds. 0 is returned for 'live' streams or clips whose length cannot be determined by VLC. It returns -1 if no input is playing.
*'''vlc.input.fps''': frames per second returned as a float (typically 60.0, 50.0, 23.976, etc...)
*'''vlc.input.hasVout''': a boolean that returns true when the video is being displayed, it returns false when video is not displayed

read/write properties

*'''vlc.input.position''': normalized position in multimedia stream item given as a float value between [0.0 - 1.0]
*'''vlc.input.time''': the absolute position in time given in milliseconds, this property can be used to seek through the stream


vlc.input.time = <absolute seek>

vlc.input.time = vlc.input.time + <relative seek>

*'''vlc.input.state''': current state of the input chain given as enumeration (IDLE=0, OPENING=1, BUFFERING=2, PLAYING=3, PAUSED=4, STOPPING=5, ENDED=6, ERROR=7). Note: Test for ENDED=6 to catch end of playback. Checking for STOPPING=5 is NOT ENOUGH.
*'''vlc.input.rate''': input speed given as float (1.0 for normal speed, 0.5 for half speed, 2.0 for twice as fast, etc.).

rate > 1  : is fastforward
rate > 0 and rate < 1 : is slow motion
rate < 0  : is rewind

methods

*''none''

== Playlist object ==

readonly properties

*'''vlc.playlist.itemCount''': number that returns the amount of items currently in the playlist ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])
*'''vlc.playlist.isPlaying''': a boolean that returns true if the current playlist item is playing and false when it is not playing
*'''vlc.playlist.items''': return the playlist items collection, see [[#Playlist_items_object|Playlist items]]

read/write properties

*''none''

methods

*'''vlc.playlist.add(mrl)''': add a playlist item as [[MRL]]. The MRL must be given as a string. Returns a number as an item identifier in playlist (this is not a position in playlist).
*'''vlc.playlist.add(mrl,name,options)''': add a playlist item as MRL, with metaname 'name' and options 'options'. options are text arguments which can be provided either as a single string containing space separated values, akin to VLC command line, or as an array of string values. Returns a number as an item identifier in playlist (this is not a position in playlist).

<syntaxhighlight lang="javascript" line>
var options = new Array(":aspect-ratio=4:3", "--rtsp-tcp");
var id = vlc.playlist.add("rtsp://servername/item/to/play", "fancy name", options);
vlc.playlist.playItem(id);
</syntaxhighlight>

*'''vlc.playlist.play()''': start playing the current playlist item
*'''vlc.playlist.playItem(number)''': start playing the item whose identifier is number
*'''vlc.playlist.pause()''': pause the current playlist item
*'''vlc.playlist.togglePause()''': toggle the pause state for the current playlist item
*'''vlc.playlist.stop()''': stop playing the current playlist item
*'''vlc.playlist.next()''': iterate to the next playlist item
*'''vlc.playlist.prev()''': iterate to the previous playlist item
*'''vlc.playlist.clear()''': empty the current playlist, all items will be deleted from the playlist ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])
*'''vlc.playlist.removeItem(number)''': remove the item from playlist whose identifier is number  ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])

=== Playlist items object ===

readonly properties

*'''vlc.playlist.items.count''': number of items currently in the playlist

read/write properties

*''none''

methods

*'''vlc.playlist.items.clear()''': empty the current playlist, all items will be deleted from the playlist. If a movie is playing, it stop. Note that when this method returns, playlist may not have been entirely been cleared as this operation is performed asynchronously; use the ''count'' property to verify/wait until the playlist is empty.
*'''vlc.playlist.items.remove(number)''': remove the item whose identifier is number from playlist. (note: this number isn't the position in the playlist, but the number given by vlc.playlist.add() )

== Subtitle object ==

readonly properties

*'''vlc.subtitle.count''': (supported in vlc version >= 1.1.0) returns the number of subtitle available.

read/write properties

*'''vlc.subtitle.track''': (supported in vlc version >= 1.1.0) get and set the subtitle track to show on the video screen. The property takes an integer as input value [1..65535]. If subtitle track is set to 0, the subtitles will be disabled. If set to a value outside the current subtitle tracks range, then it will return -1 and display an error message.

methods

*'''vlc.subtitle.description(int i)''': (supported in vlc version >= 1.1.0) give the i-th subtitle name. 0 correspond to disable and 1 to the first subtitle.

== Video object ==

readonly properties

*'''vlc.video.width''': returns the horizontal size of the video
*'''vlc.video.height''': returns the vertical size of the video

read/write properties

*'''vlc.video.fullscreen''': when set to true the video will be displayed in fullscreen mode, when set to false the video will be shown inside the video output size. The property takes a boolean as input.
*'''vlc.video.aspectRatio''': get and set the aspect ratio to use in the video screen. The property takes a string as input value. Typical values are: "1:1", "4:3", "16:9", "16:10", "221:100" and "5:4"
*'''vlc.video.subtitle''': (supported in vlc version > 0.8.6a) get and set the subtitle track to show on the video screen. The property takes an integer as input value [1..65535]. If subtitle track is set to 0, the subtitles will be disabled. If set to a value outside the current subtitle tracks range, then it will return -1 and display an error message.
*'''vlc.video.teletext''': (supported in vlc version >= 0.9.0) get and set teletext page to show on the video stream. This will only work if a teletext elementary stream is available in the video stream. The property takes an integer as input value [0..999] for indicating the teletext page to view, setting the value to 0 means hide teletext. On error it will return -1 and display an error message.

methods

*'''vlc.video.toggleFullscreen()''': toggle the fullscreen mode based on the previous setting
*'''vlc.video.toggleTeletext()''': (supported in vlc version >= 0.9.0) toggle the teletext page to overlay transparent or not, based on the previous setting

=== Deinterlace Object ===

readonly properties

*''none''

read/write properties

*''none''

methods

*'''vlc.video.deinterlace.enable("my_mode")''': (supported in vlc version >= 1.1.0) enable deinterlacing with my_mode. You can enable it with "blend", "bob", "discard", "linear", "mean", "x", "yadif" or "yadif2x" mode. Enabling too soon deinterlacing may cause some problems. You have to wait that all variable are available before enabling it.
*'''vlc.video.deinterlace.disable()''': (supported in vlc version >= 1.1.0) disable deinterlacing.

=== Marquee Object ===

readonly properties

*''none''

read/write properties

*'''vlc.video.marquee.text''': (supported in vlc version >= 1.1.0) display my text on the screen.
*'''vlc.video.marquee.color''': (supported in vlc version >= 1.1.0) change the text color. val is the new color to use (WHITE=0x000000, BLACK=0xFFFFFF, RED=0xFF0000, GREEN=0x00FF00, BLUE=0x0000FF...).
*'''vlc.video.marquee.opacity''': (supported in vlc version >= 1.1.0) change the text opacity, val is defined from 0 (completely transparent) to 255 (completely opaque).
*'''vlc.video.marquee.position''': (supported in vlc version >= 1.1.0) change the text position (CENTER=0, LEFT=1, RIGHT=2, TOP=4, TOP-LEFT=5, TOP-RIGHT=6, BOTTOM=8, BOTTOM-LEFT=9, BOTTOM_RIGHT=10).
*'''vlc.video.marquee.refresh''': (supported in vlc version >= 1.1.0) change the marquee refresh period.
*'''vlc.video.marquee.size''': (supported in vlc version >= 1.1.0) val define the new size for the text displayed on the screen. If the text is bigger than the screen then the text is not displayed.
*'''vlc.video.marquee.timeout''': (supported in vlc version >= 1.1.0) change the timeout value. val is defined in ms, but 0 value correspond to unlimited.
*'''vlc.video.marquee.x''': (supported in vlc version >= 1.1.0) change text abscissa.
*'''vlc.video.marquee.y''': (supported in vlc version >= 1.1.0) change text ordinate.

methods

*'''vlc.video.marquee.enable()''': (supported in vlc version >= 1.1.0) enable marquee filter.
*'''vlc.video.marquee.disable()''': (supported in vlc version >= 1.1.0) disable marquee filter.

Some problems may happen (option like color or text will not be applied) because of the VLC asynchronous functioning. To avoid it, after enabling marquee, you have to wait a little time before changing an option. But it should be fixed by the new vout implementation.

NOTE: [http://forum.videolan.org/viewtopic.php?f=16&t=89427#p295058]

=== Logo Object ===

readonly properties

*''none''

read/write properties

*'''vlc.video.logo.opacity''': (supported in vlc version >= 1.1.0) change the picture opacity, val is defined from 0 (completely transparent) to 255 (completely opaque).
*'''vlc.video.logo.position''': (supported in vlc version >= 1.1.0) change the text position ("center", "left", "right", "top", "top-left", "top-right", "bottom", "bottom-left", "bottom-right").
*'''vlc.video.logo.delay''': (supported in vlc version >= 1.1.0) display each picture for a duration of 1000 ms (default) before displaying the next picture.
*'''vlc.video.logo.repeat''': (supported in vlc version >= 1.1.0) number of loops for picture animation (-1=continuous, 0=disabled, n=n-times). The default is -1 (continuous).
*'''vlc.video.logo.x''': (supported in vlc version >= 1.1.0) change the x-offset for displaying the picture counting from top-left on the screen.
*'''vlc.video.logo.y''': (supported in vlc version >= 1.1.0) change the y-offset for displaying the picture counting from top-left on the screen.
*'''vlc.video.logo.width''': (supported in vlc version >= 1.1.0) change the picture width.
*'''vlc.video.logo.height''': (supported in vlc version >= 1.1.0) change the picture height.

methods

*'''vlc.video.logo.enable()''': (supported in vlc version >= 1.1.0) enable logo video filter.
*'''vlc.video.logo.disable()''': (supported in vlc version >= 1.1.0) disable logo video filter.
*'''vlc.video.logo.file("file.png")''': (supported in vlc version >= 1.1.0) display my file.png as logo on the screen.

Some problems may happen because of the VLC asynchronous functioning. To avoid it, after enabling logo video filter, you have to wait a little time before changing an option. But it should be fixed by the new vout implementation.

== MediaDescription Object ==

readonly properties

*'''vlc.mediaDescription.title''': (supported in vlc version >= 2.0.2) returns title meta information field.
*'''vlc.mediaDescription.artist''': (supported in vlc version >= 2.0.2) returns artist meta information field.
*'''vlc.mediaDescription.copyright''': (supported in vlc version >= 2.0.2) returns copyright meta information field.
*'''vlc.mediaDescription.album''': (supported in vlc version >= 2.0.2) returns album meta information field.
*'''vlc.mediaDescription.trackNumber''': (supported in vlc version >= 2.0.2) returns trackNumber meta information field.
*'''vlc.mediaDescription.description''': (supported in vlc version >= 2.0.2) returns description meta information field.
*'''vlc.mediaDescription.rating''': (supported in vlc version >= 2.0.2) returns rating meta information field.
*'''vlc.mediaDescription.date''': (supported in vlc version >= 2.0.2) returns date meta information field.
*'''vlc.mediaDescription.setting''': (supported in vlc version >= 2.0.2) returns setting meta information field.
*'''vlc.mediaDescription.URL''': (supported in vlc version >= 2.0.2) returns URL meta information field.
*'''vlc.mediaDescription.language''': (supported in vlc version >= 2.0.2) returns language meta information field.
*'''vlc.mediaDescription.nowPlaying''': (supported in vlc version >= 2.0.2) returns nowPlaying meta information field.
*'''vlc.mediaDescription.publisher''': (supported in vlc version >= 2.0.2) returns publisher meta information field.
*'''vlc.mediaDescription.encodedBy''': (supported in vlc version >= 2.0.2) returns encodedBy meta information field.

*'''vlc.mediaDescription.artworkURL''': (supported in vlc version >= 2.0.2) returns artworkURL meta information field.

*'''vlc.mediaDescription.trackID''': (supported in vlc version >= 2.0.2) returns trackID meta information field.

read/write properties

*''none''

methods

*''none''

== DEPRECATED APIs ==
=== DEPRECATED: Log object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

This object allows accessing VLC main message logging queue. Typically this queue capacity is very small (no nore than 256 entries) and can easily overflow, therefore messages should be read and cleared as often as possible.

readonly properties

*'''vlc.log.messages''': returns the message collection, see [[#Messages_object|Messages object]]

read/write properties

*'''vlc.log.verbosity''': write number [-1,0,1,2,3] for changing the verbosity level of the log messages; messages whose verbosity is higher than set will be not be logged in the queue. The numbers have the following meaning: -1 disable, 0 info, 1 error, 2 warning, 3 debug.

methods

*''none''

=== DEPRECATED: Messages object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

readonly properties

*'''messages.count''': returns number of messages in the log

read/write properties

*''none''

methods

*'''messages.clear()''': clear the current log buffer. It should be called as frequently as possible to not overflow the message queue. Call this method after the log messages of interest are read.
*'''messages.iterator()''': creates and returns an iterator object, used to iterate over the messages in the log. '''Don't clear the log buffer while holding an iterator object.'''

=== DEPRECATED: Messages Iterator object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

readonly properties

*'''iterator.hasNext''': returns a boolean that indicates whether ''vlc.log.messages.next()'' will return the next message.

read/write properties

*''none''

methods

*'''iterator.next()''': returns the next message object in the log, see [[Message object]]

=== DEPRECATED: Message subobject ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

*'''message.severity''': number that indicates the severity of the log message (0 = info, 1 = error, 2 = warning, 3 = debug)
*'''message.name''': name of VLC module that printed the log message (e.g: main, http, directx, etc...)
*'''message.type''': type of VLC module that printed the log message (eg: input, access, vout, sout, etc...)
*'''message.message''': the message text

{{Documentation}}

[[Category:Embedded]]

Documentation:WebPlugin

2013-01-02T14:13:45Z

Etix: Add syntax highlighting

This Documentation speaks about the {{VLC}} Web plugins and how to write pages for it.
{{RightMenu|documentation play howto toc}}

= Introduction: Building Web pages with Video =

The {{VLC}} webplugins are native browser plugins, similar to Flash or Silverlight plugins and allow playback inside the browser of all the videos that {{VLC}} can read.

Additionally to viewing video on all pages, you can build custom pages that will use the advanced features of the plugin, using Javascript functions to control playback or extract information from the plugin.

There are 2 main plugins: one is ActiveX for IE, the other is NPAPI for the other browsers. They feature the same amount of features.

In older versions, those plugins were very crashy. '''We URGE YOU''' to use VLC '''1.2.0''' or newer versions.

=== Browsers support ===
It has been tested with:
* Mozilla Firefox [[Image:Firefox-logo.png|40x40px]]
* Internet Explorer [[Image:20101105053305!Internet Explorer 9.png|40x40px]]
* Safari [[Image:Apple Safari.png|40x40px]]
* Chrome
* Konqueror
* Opera

It has been tested on GNU/Linux, Windows and MacOS.

= Embed tag attributes =

To embed the plugin into a webpage use the following <embed> template:

<syntaxhighlight lang="javascript" line>
<embed type="application/x-vlc-plugin" pluginspage="http://www.videolan.org" />
<object classid="clsid:9BE31822-FDAD-461B-AD51-BE1D1C159921" codebase="http://download.videolan.org/pub/videolan/vlc/last/win32/axvlc.cab"></object>
</syntaxhighlight>

=== Required elements ===
These are '''required''' attributes for the <embed> tag:

*'''width''': Specifies the width of the plugin.
*'''height''': Specifies the height of the plugin.
*'''target''' (or one of these alias: '''mrl''', '''filename''', '''src'''): Specifies the source location (URL) of the video to load.

=== Optionnal elements ===
These are additional attributes for the <embed> tag:

*'''autoplay''', '''autostart''': Specifies whether the plugin starts playing on load. Default: ''true''
*'''allowfullscreen''': (since VLC version 1.2.0) Specifies whether the user can switch into fullscreen mode. Default: ''true''
*'''windowless''': (since VLC version 2.0.6) Draw the video on a window-less (non-accelerated) surface and allow styling (CSS overlay, 3D transformations, and much more). Default: ''false''
*'''mute''': Specifies whether the audio volume is initially muted. Default: ''false''
*'''loop''', '''autoloop''': Specifies whether the video loops on end. Default: ''false''
*'''toolbar''': Specifies whether the toolbar is shown by default. Default: ''true''
*'''bgcolor''': Specifies the background color of the video player. Default: ''#000000''

=== Normal DOM elements ===
*'''id''': DOM id
*'''name''': DOM name

= Javascript API description =

The vlc plugin exports several objects that can be accessed for setting and getting information. When used improperly the API's will throw an exception that includes a string that explains what happened. For example when asking for vlc.input.length when there is no playlist item playing.

== VLC objects ==
The vlc plugin knows the following objects:

*'''audio''': Access audio properties.
*'''input''': Access input properties.
*'''playlist''': Access playlist properties.
*'''subtitle''': Access subtitle properties.
*'''video''': Access video properties.
**'''video.marquee''': Access marquee video filter properties.
**'''video.logo''': Access logo video filter properties.
*'''mediaDescription''': Access media info properties (only available in vlc version >= 2.0.2).

The following are deprecated:
*'''log''': Access log properties (only available in vlc version <= 1.0.0-rc1).
*'''messages''': Access to log message properties (only available in vlc version <= 1.0.0-rc1).
*'''iterator''': Access to log iterator properties (only available in vlc version <= 1.0.0-rc1).
*'''message''': Access to log message properties (only available in vlc version <= 1.0.0-rc1).

=== Example ===
The following JavaScript code shows howto get a reference to the vlc plugin. This reference can then be used to access the objects of the vlc plugin.

<syntaxhighlight lang="javascript" line>
<html>
<title>VLC Mozilla plugin test page</title>
<body>
<embed type="application/x-vlc-plugin" pluginspage="http://www.videolan.org"
width="640"
height="480"
id="vlc">
</embed>
<script language="Javascript">

</script>
</body>
</html>
</syntaxhighlight>

== Root object ==

readonly properties

*'''VersionInfo''': returns version information string

read/write properties

*''none''

methods

*'''vlc.versionInfo()''': returns version information string (same as VersionInfo)

*'''vlc.addEventListener(eventname, callback, bubble)''': (only for Mozilla) add a listener for mentioned event name, callback expects a function and bubble influences the order of eventhandling by JS (usually it is set to false).
*'''vlc.removeEventListener(eventname, callback, bubble)''': (only for Mozilla) remove listener for mentioned event name, callback expects a function and bubble influences the order of eventhandling by JS (usually it is set to false).

*'''vlc.attachEvent(eventname, callback)''': (only for ActiveX) add listener for mentioned event name, callback expects a function
*'''vlc.removeEvent(eventname, callback)''': (only for ActiveX) remove listener for mentioned event name, callback expects a function

events

*'''MediaPlayerNothingSpecial''': vlc is in idle state doing nothing but waiting for a command to be issued
*'''MediaPlayerOpening''': vlc is opening an media resource locator (MRL)
*'''MediaPlayerBuffering''': vlc is buffering
*'''MediaPlayerPlaying''': vlc is playing a media
*'''MediaPlayerPaused''': vlc is in paused state
*'''MediaPlayerForward''': vlc is fastforwarding through the media (works only when an input supports forward playback)
*'''MediaPlayerBackward''': vlc is going backwards through the media (works only when an input supports backwards playback)
*'''MediaPlayerEncounteredError''': vlc has encountered an error and is unable to continue
*'''MediaPlayerEndReached''': vlc has reached the end of current playlist
*'''MediaPlayerTimeChanged''': time has changed
*'''MediaPlayerPositionChanged''': media position has changed
*'''MediaPlayerSeekableChanged''': media seekable flag has changed (true means media is seekable, false means it is not)
*'''MediaPlayerPausableChanged''': media pausable flag has changed (true means media is pauseable, false means it is not)

=== Example ===
The following code snippit provides easy functions to register and unregister event callbacks on all supported platforms (currently only Linux mozilla based browsers and windows activeX objects for Internet Explorer).

<syntaxhighlight lang="javascript" line>
<script language="javascript">

</script>
</syntaxhighlight>

== Audio object ==

readonly properties

*'''vlc.audio.count''': (supported in vlc version >= 1.1.0) returns the number of audio track available.

read/write properties

*'''vlc.audio.mute''': boolean value to mute and unmute the audio.
*'''vlc.audio.volume''': a value between [0-200] which indicates a percentage of the volume.
*'''vlc.audio.track''': (supported in vlc version > 0.8.6) a value between [1-65535] which indicates the audio track to play or that is playing. a value of 0 means the audio is/will be disabled.
*'''vlc.audio.channel''': (supported in vlc version > 0.8.6) integer value between [1-5] that indicates which audio channel mode is used, values can be: "1=stereo", "2=reverse stereo", "3=left", "4=right", "5=dolby". Use vlc.audio.channel to check if setting of the audio channel mode has succeeded.

methods

*'''vlc.audio.toggleMute()''': boolean toggle that mutes and unmutes the audio based upon the previous state.
*'''vlc.audio.description(int i)''': (supported in vlc version >= 1.1.0) give the i-th audio track name. 0 corresponds to disable and 1 to the first audio track.

=== Example ===

<syntaxhighlight lang="html5" line>
Audio Channel:
<select readonly onChange='doAudioChannel(this.value)'>
<option value=1>Stereo</option>
<option value=2>Reverse stereo</option>
<option value=3>Left</option>
<option value=4>Right</option>
<option value=5>Dolby</option>
</select>
</syntaxhighlight>
<br />
<syntaxhighlight lang="javascript" line>
<script language="javascript">

</script>
</syntaxhighlight>

== Input object ==

readonly properties

*'''vlc.input.length''': length of the input file in number of milliseconds. 0 is returned for 'live' streams or clips whose length cannot be determined by VLC. It returns -1 if no input is playing.
*'''vlc.input.fps''': frames per second returned as a float (typically 60.0, 50.0, 23.976, etc...)
*'''vlc.input.hasVout''': a boolean that returns true when the video is being displayed, it returns false when video is not displayed

read/write properties

*'''vlc.input.position''': normalized position in multimedia stream item given as a float value between [0.0 - 1.0]
*'''vlc.input.time''': the absolute position in time given in milliseconds, this property can be used to seek through the stream


vlc.input.time = <absolute seek>

vlc.input.time = vlc.input.time + <relative seek>

*'''vlc.input.state''': current state of the input chain given as enumeration (IDLE=0, OPENING=1, BUFFERING=2, PLAYING=3, PAUSED=4, STOPPING=5, ENDED=6, ERROR=7). Note: Test for ENDED=6 to catch end of playback. Checking for STOPPING=5 is NOT ENOUGH.
*'''vlc.input.rate''': input speed given as float (1.0 for normal speed, 0.5 for half speed, 2.0 for twice as fast, etc.).

rate > 1  : is fastforward
rate > 0 and rate < 1 : is slow motion
rate < 0  : is rewind

methods

*''none''

== Playlist object ==

readonly properties

*'''vlc.playlist.itemCount''': number that returns the amount of items currently in the playlist ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])
*'''vlc.playlist.isPlaying''': a boolean that returns true if the current playlist item is playing and false when it is not playing
*'''vlc.playlist.items''': return the playlist items collection, see [[#Playlist_items_object|Playlist items]]

read/write properties

*''none''

methods

*'''vlc.playlist.add(mrl)''': add a playlist item as [[MRL]]. The MRL must be given as a string. Returns a number as an item identifier in playlist (this is not a position in playlist).
*'''vlc.playlist.add(mrl,name,options)''': add a playlist item as MRL, with metaname 'name' and options 'options'. options are text arguments which can be provided either as a single string containing space separated values, akin to VLC command line, or as an array of string values. Returns a number as an item identifier in playlist (this is not a position in playlist).

<syntaxhighlight lang="javascript" line>
var options = new Array(":aspect-ratio=4:3", "--rtsp-tcp");
var id = vlc.playlist.add("rtsp://servername/item/to/play", "fancy name", options);
vlc.playlist.playItem(id);
</syntaxhighlight>

*'''vlc.playlist.play()''': start playing the current playlist item
*'''vlc.playlist.playItem(number)''': start playing the item whose identifier is number
*'''vlc.playlist.pause()''': pause the current playlist item
*'''vlc.playlist.togglePause()''': toggle the pause state for the current playlist item
*'''vlc.playlist.stop()''': stop playing the current playlist item
*'''vlc.playlist.next()''': iterate to the next playlist item
*'''vlc.playlist.prev()''': iterate to the previous playlist item
*'''vlc.playlist.clear()''': empty the current playlist, all items will be deleted from the playlist ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])
*'''vlc.playlist.removeItem(number)''': remove the item from playlist whose identifier is number  ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])

=== Playlist items object ===

readonly properties

*'''vlc.playlist.items.count''': number of items currently in the playlist

read/write properties

*''none''

methods

*'''vlc.playlist.items.clear()''': empty the current playlist, all items will be deleted from the playlist. If a movie is playing, it stop. Note that when this method returns, playlist may not have been entirely been cleared as this operation is performed asynchronously; use the ''count'' property to verify/wait until the playlist is empty.
*'''vlc.playlist.items.remove(number)''': remove the item whose identifier is number from playlist. (note: this number isn't the position in the playlist, but the number given by vlc.playlist.add() )

== Subtitle object ==

readonly properties

*'''vlc.subtitle.count''': (supported in vlc version >= 1.1.0) returns the number of subtitle available.

read/write properties

*'''vlc.subtitle.track''': (supported in vlc version >= 1.1.0) get and set the subtitle track to show on the video screen. The property takes an integer as input value [1..65535]. If subtitle track is set to 0, the subtitles will be disabled. If set to a value outside the current subtitle tracks range, then it will return -1 and display an error message.

methods

*'''vlc.subtitle.description(int i)''': (supported in vlc version >= 1.1.0) give the i-th subtitle name. 0 correspond to disable and 1 to the first subtitle.

== Video object ==

readonly properties

*'''vlc.video.width''': returns the horizontal size of the video
*'''vlc.video.height''': returns the vertical size of the video

read/write properties

*'''vlc.video.fullscreen''': when set to true the video will be displayed in fullscreen mode, when set to false the video will be shown inside the video output size. The property takes a boolean as input.
*'''vlc.video.aspectRatio''': get and set the aspect ratio to use in the video screen. The property takes a string as input value. Typical values are: "1:1", "4:3", "16:9", "16:10", "221:100" and "5:4"
*'''vlc.video.subtitle''': (supported in vlc version > 0.8.6a) get and set the subtitle track to show on the video screen. The property takes an integer as input value [1..65535]. If subtitle track is set to 0, the subtitles will be disabled. If set to a value outside the current subtitle tracks range, then it will return -1 and display an error message.
*'''vlc.video.teletext''': (supported in vlc version >= 0.9.0) get and set teletext page to show on the video stream. This will only work if a teletext elementary stream is available in the video stream. The property takes an integer as input value [0..999] for indicating the teletext page to view, setting the value to 0 means hide teletext. On error it will return -1 and display an error message.

methods

*'''vlc.video.toggleFullscreen()''': toggle the fullscreen mode based on the previous setting
*'''vlc.video.toggleTeletext()''': (supported in vlc version >= 0.9.0) toggle the teletext page to overlay transparent or not, based on the previous setting

=== Deinterlace Object ===

readonly properties

*''none''

read/write properties

*''none''

methods

*'''vlc.video.deinterlace.enable("my_mode")''': (supported in vlc version >= 1.1.0) enable deinterlacing with my_mode. You can enable it with "blend", "bob", "discard", "linear", "mean", "x", "yadif" or "yadif2x" mode. Enabling too soon deinterlacing may cause some problems. You have to wait that all variable are available before enabling it.
*'''vlc.video.deinterlace.disable()''': (supported in vlc version >= 1.1.0) disable deinterlacing.

=== Marquee Object ===

readonly properties

*''none''

read/write properties

*'''vlc.video.marquee.text''': (supported in vlc version >= 1.1.0) display my text on the screen.
*'''vlc.video.marquee.color''': (supported in vlc version >= 1.1.0) change the text color. val is the new color to use (WHITE=0x000000, BLACK=0xFFFFFF, RED=0xFF0000, GREEN=0x00FF00, BLUE=0x0000FF...).
*'''vlc.video.marquee.opacity''': (supported in vlc version >= 1.1.0) change the text opacity, val is defined from 0 (completely transparent) to 255 (completely opaque).
*'''vlc.video.marquee.position''': (supported in vlc version >= 1.1.0) change the text position (CENTER=0, LEFT=1, RIGHT=2, TOP=4, TOP-LEFT=5, TOP-RIGHT=6, BOTTOM=8, BOTTOM-LEFT=9, BOTTOM_RIGHT=10).
*'''vlc.video.marquee.refresh''': (supported in vlc version >= 1.1.0) change the marquee refresh period.
*'''vlc.video.marquee.size''': (supported in vlc version >= 1.1.0) val define the new size for the text displayed on the screen. If the text is bigger than the screen then the text is not displayed.
*'''vlc.video.marquee.timeout''': (supported in vlc version >= 1.1.0) change the timeout value. val is defined in ms, but 0 value correspond to unlimited.
*'''vlc.video.marquee.x''': (supported in vlc version >= 1.1.0) change text abscissa.
*'''vlc.video.marquee.y''': (supported in vlc version >= 1.1.0) change text ordinate.

methods

*'''vlc.video.marquee.enable()''': (supported in vlc version >= 1.1.0) enable marquee filter.
*'''vlc.video.marquee.disable()''': (supported in vlc version >= 1.1.0) disable marquee filter.

Some problems may happen (option like color or text will not be applied) because of the VLC asynchronous functioning. To avoid it, after enabling marquee, you have to wait a little time before changing an option. But it should be fixed by the new vout implementation.

NOTE: [http://forum.videolan.org/viewtopic.php?f=16&t=89427#p295058]

=== Logo Object ===

readonly properties

*''none''

read/write properties

*'''vlc.video.logo.opacity''': (supported in vlc version >= 1.1.0) change the picture opacity, val is defined from 0 (completely transparent) to 255 (completely opaque).
*'''vlc.video.logo.position''': (supported in vlc version >= 1.1.0) change the text position ("center", "left", "right", "top", "top-left", "top-right", "bottom", "bottom-left", "bottom-right").
*'''vlc.video.logo.delay''': (supported in vlc version >= 1.1.0) display each picture for a duration of 1000 ms (default) before displaying the next picture.
*'''vlc.video.logo.repeat''': (supported in vlc version >= 1.1.0) number of loops for picture animation (-1=continuous, 0=disabled, n=n-times). The default is -1 (continuous).
*'''vlc.video.logo.x''': (supported in vlc version >= 1.1.0) change the x-offset for displaying the picture counting from top-left on the screen.
*'''vlc.video.logo.y''': (supported in vlc version >= 1.1.0) change the y-offset for displaying the picture counting from top-left on the screen.
*'''vlc.video.logo.width''': (supported in vlc version >= 1.1.0) change the picture width.
*'''vlc.video.logo.height''': (supported in vlc version >= 1.1.0) change the picture height.

methods

*'''vlc.video.logo.enable()''': (supported in vlc version >= 1.1.0) enable logo video filter.
*'''vlc.video.logo.disable()''': (supported in vlc version >= 1.1.0) disable logo video filter.
*'''vlc.video.logo.file("file.png")''': (supported in vlc version >= 1.1.0) display my file.png as logo on the screen.

Some problems may happen because of the VLC asynchronous functioning. To avoid it, after enabling logo video filter, you have to wait a little time before changing an option. But it should be fixed by the new vout implementation.

== MediaDescription Object ==

readonly properties

*'''vlc.mediaDescription.title''': (supported in vlc version >= 2.0.2) returns title meta information field.
*'''vlc.mediaDescription.artist''': (supported in vlc version >= 2.0.2) returns artist meta information field.
*'''vlc.mediaDescription.copyright''': (supported in vlc version >= 2.0.2) returns copyright meta information field.
*'''vlc.mediaDescription.album''': (supported in vlc version >= 2.0.2) returns album meta information field.
*'''vlc.mediaDescription.trackNumber''': (supported in vlc version >= 2.0.2) returns trackNumber meta information field.
*'''vlc.mediaDescription.description''': (supported in vlc version >= 2.0.2) returns description meta information field.
*'''vlc.mediaDescription.rating''': (supported in vlc version >= 2.0.2) returns rating meta information field.
*'''vlc.mediaDescription.date''': (supported in vlc version >= 2.0.2) returns date meta information field.
*'''vlc.mediaDescription.setting''': (supported in vlc version >= 2.0.2) returns setting meta information field.
*'''vlc.mediaDescription.URL''': (supported in vlc version >= 2.0.2) returns URL meta information field.
*'''vlc.mediaDescription.language''': (supported in vlc version >= 2.0.2) returns language meta information field.
*'''vlc.mediaDescription.nowPlaying''': (supported in vlc version >= 2.0.2) returns nowPlaying meta information field.
*'''vlc.mediaDescription.publisher''': (supported in vlc version >= 2.0.2) returns publisher meta information field.
*'''vlc.mediaDescription.encodedBy''': (supported in vlc version >= 2.0.2) returns encodedBy meta information field.

*'''vlc.mediaDescription.artworkURL''': (supported in vlc version >= 2.0.2) returns artworkURL meta information field.

*'''vlc.mediaDescription.trackID''': (supported in vlc version >= 2.0.2) returns trackID meta information field.

read/write properties

*''none''

methods

*''none''

== DEPRECATED APIs ==
=== DEPRECATED: Log object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

This object allows accessing VLC main message logging queue. Typically this queue capacity is very small (no nore than 256 entries) and can easily overflow, therefore messages should be read and cleared as often as possible.

readonly properties

*'''vlc.log.messages''': returns the message collection, see [[#Messages_object|Messages object]]

read/write properties

*'''vlc.log.verbosity''': write number [-1,0,1,2,3] for changing the verbosity level of the log messages; messages whose verbosity is higher than set will be not be logged in the queue. The numbers have the following meaning: -1 disable, 0 info, 1 error, 2 warning, 3 debug.

methods

*''none''

=== DEPRECATED: Messages object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

readonly properties

*'''messages.count''': returns number of messages in the log

read/write properties

*''none''

methods

*'''messages.clear()''': clear the current log buffer. It should be called as frequently as possible to not overflow the message queue. Call this method after the log messages of interest are read.
*'''messages.iterator()''': creates and returns an iterator object, used to iterate over the messages in the log. '''Don't clear the log buffer while holding an iterator object.'''

=== DEPRECATED: Messages Iterator object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

readonly properties

*'''iterator.hasNext''': returns a boolean that indicates whether ''vlc.log.messages.next()'' will return the next message.

read/write properties

*''none''

methods

*'''iterator.next()''': returns the next message object in the log, see [[Message object]]

=== DEPRECATED: Message subobject ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

*'''message.severity''': number that indicates the severity of the log message (0 = info, 1 = error, 2 = warning, 3 = debug)
*'''message.name''': name of VLC module that printed the log message (e.g: main, http, directx, etc...)
*'''message.type''': type of VLC module that printed the log message (eg: input, access, vout, sout, etc...)
*'''message.message''': the message text

{{Documentation}}

[[Category:Embedded]]

Documentation:WebPlugin

2013-01-02T13:26:46Z

Etix: /* Optionnal elements */

This Documentation speaks about the {{VLC}} Web plugins and how to write pages for it.
{{RightMenu|documentation play howto toc}}

= Introduction: Building Web pages with Video =

The {{VLC}} webplugins are native browser plugins, similar to Flash or Silverlight plugins and allow playback inside the browser of all the videos that {{VLC}} can read.

Additionally to viewing video on all pages, you can build custom pages that will use the advanced features of the plugin, using Javascript functions to control playback or extract information from the plugin.

There are 2 main plugins: one is ActiveX for IE, the other is NPAPI for the other browsers. They feature the same amount of features.

In older versions, those plugins were very crashy. '''We URGE YOU''' to use VLC '''1.2.0''' or newer versions.

=== Browsers support ===
It has been tested with:
* Mozilla Firefox [[Image:Firefox-logo.png|40x40px]]
* Internet Explorer [[Image:20101105053305!Internet Explorer 9.png|40x40px]]
* Safari [[Image:Apple Safari.png|40x40px]]
* Chrome
* Konqueror
* Opera

It has been tested on GNU/Linux, Windows and MacOS.

= Embed tag attributes =

To embed the plugin into a webpage use the following <embed> template:

<nowiki>
<embed type="application/x-vlc-plugin" pluginspage="http://www.videolan.org" />

<object classid="clsid:9BE31822-FDAD-461B-AD51-BE1D1C159921" codebase="http://download.videolan.org/pub/videolan/vlc/last/win32/axvlc.cab"></object>
</nowiki>

=== Required elements ===
These are '''required''' attributes for the <embed> tag:

*'''width''': Specifies the width of the plugin.
*'''height''': Specifies the height of the plugin.
*'''target''' (or one of these alias: '''mrl''', '''filename''', '''src'''): Specifies the source location (URL) of the video to load.

=== Optionnal elements ===
These are additional attributes for the <embed> tag:

*'''autoplay''', '''autostart''': Specifies whether the plugin starts playing on load. Default: ''true''
*'''allowfullscreen''': (since VLC version 1.2.0) Specifies whether the user can switch into fullscreen mode. Default: ''true''
*'''windowless''': (since VLC version 2.0.6) Draw the video on a window-less (non-accelerated) surface and allow styling (CSS overlay, 3D transformations, and much more). Default: ''false''
*'''mute''': Specifies whether the audio volume is initially muted. Default: ''false''
*'''loop''', '''autoloop''': Specifies whether the video loops on end. Default: ''false''
*'''toolbar''': Specifies whether the toolbar is shown by default. Default: ''true''
*'''bgcolor''': Specifies the background color of the video player. Default: ''#000000''

=== Normal DOM elements ===
*'''id''': DOM id
*'''name''': DOM name

= Javascript API description =

The vlc plugin exports several objects that can be accessed for setting and getting information. When used improperly the API's will throw an exception that includes a string that explains what happened. For example when asking for vlc.input.length when there is no playlist item playing.

== VLC objects ==
The vlc plugin knows the following objects:

*'''audio''': Access audio properties.
*'''input''': Access input properties.
*'''playlist''': Access playlist properties.
*'''subtitle''': Access subtitle properties.
*'''video''': Access video properties.
**'''video.marquee''': Access marquee video filter properties.
**'''video.logo''': Access logo video filter properties.
*'''mediaDescription''': Access media info properties (only available in vlc version >= 2.0.2).

The following are deprecated:
*'''log''': Access log properties (only available in vlc version <= 1.0.0-rc1).
*'''messages''': Access to log message properties (only available in vlc version <= 1.0.0-rc1).
*'''iterator''': Access to log iterator properties (only available in vlc version <= 1.0.0-rc1).
*'''message''': Access to log message properties (only available in vlc version <= 1.0.0-rc1).

=== Example ===
The following JavaScript code shows howto get a reference to the vlc plugin. This reference can then be used to access the objects of the vlc plugin.

<html>
<title>VLC Mozilla plugin test page</title>
<body>
<embed type="application/x-vlc-plugin" pluginspage="http://www.videolan.org"
width="640"
height="480"
id="vlc">
</embed>
<script language="Javascript">

</script>
</body>
</html>

== Root object ==

readonly properties

*'''VersionInfo''': returns version information string

read/write properties

*''none''

methods

*'''vlc.versionInfo()''': returns version information string (same as VersionInfo)

*'''vlc.addEventListener(eventname, callback, bubble)''': (only for Mozilla) add a listener for mentioned event name, callback expects a function and bubble influences the order of eventhandling by JS (usually it is set to false).
*'''vlc.removeEventListener(eventname, callback, bubble)''': (only for Mozilla) remove listener for mentioned event name, callback expects a function and bubble influences the order of eventhandling by JS (usually it is set to false).

*'''vlc.attachEvent(eventname, callback)''': (only for ActiveX) add listener for mentioned event name, callback expects a function
*'''vlc.removeEvent(eventname, callback)''': (only for ActiveX) remove listener for mentioned event name, callback expects a function

events

*'''MediaPlayerNothingSpecial''': vlc is in idle state doing nothing but waiting for a command to be issued
*'''MediaPlayerOpening''': vlc is opening an media resource locator (MRL)
*'''MediaPlayerBuffering''': vlc is buffering
*'''MediaPlayerPlaying''': vlc is playing a media
*'''MediaPlayerPaused''': vlc is in paused state
*'''MediaPlayerForward''': vlc is fastforwarding through the media (works only when an input supports forward playback)
*'''MediaPlayerBackward''': vlc is going backwards through the media (works only when an input supports backwards playback)
*'''MediaPlayerEncounteredError''': vlc has encountered an error and is unable to continue
*'''MediaPlayerEndReached''': vlc has reached the end of current playlist
*'''MediaPlayerTimeChanged''': time has changed
*'''MediaPlayerPositionChanged''': media position has changed
*'''MediaPlayerSeekableChanged''': media seekable flag has changed (true means media is seekable, false means it is not)
*'''MediaPlayerPausableChanged''': media pausable flag has changed (true means media is pauseable, false means it is not)

=== Example ===
The following code snippit provides easy functions to register and unregister event callbacks on all supported platforms (currently only Linux mozilla based browsers and windows activeX objects for Internet Explorer).

<SCRIPT language="javascript">


== Audio object ==

readonly properties

*'''vlc.audio.count''': (supported in vlc version >= 1.1.0) returns the number of audio track available.

read/write properties

*'''vlc.audio.mute''': boolean value to mute and unmute the audio.
*'''vlc.audio.volume''': a value between [0-200] which indicates a percentage of the volume.
*'''vlc.audio.track''': (supported in vlc version > 0.8.6) a value between [1-65535] which indicates the audio track to play or that is playing. a value of 0 means the audio is/will be disabled.
*'''vlc.audio.channel''': (supported in vlc version > 0.8.6) integer value between [1-5] that indicates which audio channel mode is used, values can be: "1=stereo", "2=reverse stereo", "3=left", "4=right", "5=dolby". Use vlc.audio.channel to check if setting of the audio channel mode has succeeded.

methods

*'''vlc.audio.toggleMute()''': boolean toggle that mutes and unmutes the audio based upon the previous state.
*'''vlc.audio.description(int i)''': (supported in vlc version >= 1.1.0) give the i-th audio track name. 0 corresponds to disable and 1 to the first audio track.

=== Example ===
Audio Channel:
<SELECT readonly onChange='doAudioChannel(this.value)'>
<OPTION value=1>Stereo</OPTION>
<OPTION value=2>Reverse stereo</OPTION>
<OPTION value=3>Left</OPTION>
<OPTION value=4>Right</OPTION>
<OPTION value=5>Dolby</OPTION>
</SELECT>

<SCRIPT language="javascript">


== Input object ==

readonly properties

*'''vlc.input.length''': length of the input file in number of milliseconds. 0 is returned for 'live' streams or clips whose length cannot be determined by VLC. It returns -1 if no input is playing.
*'''vlc.input.fps''': frames per second returned as a float (typically 60.0, 50.0, 23.976, etc...)
*'''vlc.input.hasVout''': a boolean that returns true when the video is being displayed, it returns false when video is not displayed

read/write properties

*'''vlc.input.position''': normalized position in multimedia stream item given as a float value between [0.0 - 1.0]
*'''vlc.input.time''': the absolute position in time given in milliseconds, this property can be used to seek through the stream


vlc.input.time = <absolute seek>

vlc.input.time = vlc.input.time + <relative seek>

*'''vlc.input.state''': current state of the input chain given as enumeration (IDLE=0, OPENING=1, BUFFERING=2, PLAYING=3, PAUSED=4, STOPPING=5, ENDED=6, ERROR=7). Note: Test for ENDED=6 to catch end of playback. Checking for STOPPING=5 is NOT ENOUGH.
*'''vlc.input.rate''': input speed given as float (1.0 for normal speed, 0.5 for half speed, 2.0 for twice as fast, etc.).

rate > 1  : is fastforward
rate > 0 and rate < 1 : is slow motion
rate < 0  : is rewind

methods

*''none''

== Playlist object ==

readonly properties

*'''vlc.playlist.itemCount''': number that returns the amount of items currently in the playlist ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])
*'''vlc.playlist.isPlaying''': a boolean that returns true if the current playlist item is playing and false when it is not playing
*'''vlc.playlist.items''': return the playlist items collection, see [[#Playlist_items_object|Playlist items]]

read/write properties

*''none''

methods

*'''vlc.playlist.add(mrl)''': add a playlist item as [[MRL]]. The MRL must be given as a string. Returns a number as an item identifier in playlist (this is not a position in playlist).
*'''vlc.playlist.add(mrl,name,options)''': add a playlist item as MRL, with metaname 'name' and options 'options'. options are text arguments which can be provided either as a single string containing space separated values, akin to VLC command line, or as an array of string values. Returns a number as an item identifier in playlist (this is not a position in playlist).

var options = new Array(":aspect-ratio=4:3", "--rtsp-tcp");
var id = vlc.playlist.add("rtsp://servername/item/to/play", "fancy name", options);
vlc.playlist.playItem(id);

*'''vlc.playlist.play()''': start playing the current playlist item
*'''vlc.playlist.playItem(number)''': start playing the item whose identifier is number
*'''vlc.playlist.pause()''': pause the current playlist item
*'''vlc.playlist.togglePause()''': toggle the pause state for the current playlist item
*'''vlc.playlist.stop()''': stop playing the current playlist item
*'''vlc.playlist.next()''': iterate to the next playlist item
*'''vlc.playlist.prev()''': iterate to the previous playlist item
*'''vlc.playlist.clear()''': empty the current playlist, all items will be deleted from the playlist ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])
*'''vlc.playlist.removeItem(number)''': remove the item from playlist whose identifier is number  ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])

=== Playlist items object ===

readonly properties

*'''vlc.playlist.items.count''': number of items currently in the playlist

read/write properties

*''none''

methods

*'''vlc.playlist.items.clear()''': empty the current playlist, all items will be deleted from the playlist. If a movie is playing, it stop. Note that when this method returns, playlist may not have been entirely been cleared as this operation is performed asynchronously; use the ''count'' property to verify/wait until the playlist is empty.
*'''vlc.playlist.items.remove(number)''': remove the item whose identifier is number from playlist. (note: this number isn't the position in the playlist, but the number given by vlc.playlist.add() )

== Subtitle object ==

readonly properties

*'''vlc.subtitle.count''': (supported in vlc version >= 1.1.0) returns the number of subtitle available.

read/write properties

*'''vlc.subtitle.track''': (supported in vlc version >= 1.1.0) get and set the subtitle track to show on the video screen. The property takes an integer as input value [1..65535]. If subtitle track is set to 0, the subtitles will be disabled. If set to a value outside the current subtitle tracks range, then it will return -1 and display an error message.

methods

*'''vlc.subtitle.description(int i)''': (supported in vlc version >= 1.1.0) give the i-th subtitle name. 0 correspond to disable and 1 to the first subtitle.

== Video object ==

readonly properties

*'''vlc.video.width''': returns the horizontal size of the video
*'''vlc.video.height''': returns the vertical size of the video

read/write properties

*'''vlc.video.fullscreen''': when set to true the video will be displayed in fullscreen mode, when set to false the video will be shown inside the video output size. The property takes a boolean as input.
*'''vlc.video.aspectRatio''': get and set the aspect ratio to use in the video screen. The property takes a string as input value. Typical values are: "1:1", "4:3", "16:9", "16:10", "221:100" and "5:4"
*'''vlc.video.subtitle''': (supported in vlc version > 0.8.6a) get and set the subtitle track to show on the video screen. The property takes an integer as input value [1..65535]. If subtitle track is set to 0, the subtitles will be disabled. If set to a value outside the current subtitle tracks range, then it will return -1 and display an error message.
*'''vlc.video.teletext''': (supported in vlc version >= 0.9.0) get and set teletext page to show on the video stream. This will only work if a teletext elementary stream is available in the video stream. The property takes an integer as input value [0..999] for indicating the teletext page to view, setting the value to 0 means hide teletext. On error it will return -1 and display an error message.

methods

*'''vlc.video.toggleFullscreen()''': toggle the fullscreen mode based on the previous setting
*'''vlc.video.toggleTeletext()''': (supported in vlc version >= 0.9.0) toggle the teletext page to overlay transparent or not, based on the previous setting

=== Deinterlace Object ===

readonly properties

*''none''

read/write properties

*''none''

methods

*'''vlc.video.deinterlace.enable("my_mode")''': (supported in vlc version >= 1.1.0) enable deinterlacing with my_mode. You can enable it with "blend", "bob", "discard", "linear", "mean", "x", "yadif" or "yadif2x" mode. Enabling too soon deinterlacing may cause some problems. You have to wait that all variable are available before enabling it.
*'''vlc.video.deinterlace.disable()''': (supported in vlc version >= 1.1.0) disable deinterlacing.

=== Marquee Object ===

readonly properties

*''none''

read/write properties

*'''vlc.video.marquee.text''': (supported in vlc version >= 1.1.0) display my text on the screen.
*'''vlc.video.marquee.color''': (supported in vlc version >= 1.1.0) change the text color. val is the new color to use (WHITE=0x000000, BLACK=0xFFFFFF, RED=0xFF0000, GREEN=0x00FF00, BLUE=0x0000FF...).
*'''vlc.video.marquee.opacity''': (supported in vlc version >= 1.1.0) change the text opacity, val is defined from 0 (completely transparent) to 255 (completely opaque).
*'''vlc.video.marquee.position''': (supported in vlc version >= 1.1.0) change the text position (CENTER=0, LEFT=1, RIGHT=2, TOP=4, TOP-LEFT=5, TOP-RIGHT=6, BOTTOM=8, BOTTOM-LEFT=9, BOTTOM_RIGHT=10).
*'''vlc.video.marquee.refresh''': (supported in vlc version >= 1.1.0) change the marquee refresh period.
*'''vlc.video.marquee.size''': (supported in vlc version >= 1.1.0) val define the new size for the text displayed on the screen. If the text is bigger than the screen then the text is not displayed.
*'''vlc.video.marquee.timeout''': (supported in vlc version >= 1.1.0) change the timeout value. val is defined in ms, but 0 value correspond to unlimited.
*'''vlc.video.marquee.x''': (supported in vlc version >= 1.1.0) change text abscissa.
*'''vlc.video.marquee.y''': (supported in vlc version >= 1.1.0) change text ordinate.

methods

*'''vlc.video.marquee.enable()''': (supported in vlc version >= 1.1.0) enable marquee filter.
*'''vlc.video.marquee.disable()''': (supported in vlc version >= 1.1.0) disable marquee filter.

Some problems may happen (option like color or text will not be applied) because of the VLC asynchronous functioning. To avoid it, after enabling marquee, you have to wait a little time before changing an option. But it should be fixed by the new vout implementation.

NOTE: [http://forum.videolan.org/viewtopic.php?f=16&t=89427#p295058]

=== Logo Object ===

readonly properties

*''none''

read/write properties

*'''vlc.video.logo.opacity''': (supported in vlc version >= 1.1.0) change the picture opacity, val is defined from 0 (completely transparent) to 255 (completely opaque).
*'''vlc.video.logo.position''': (supported in vlc version >= 1.1.0) change the text position ("center", "left", "right", "top", "top-left", "top-right", "bottom", "bottom-left", "bottom-right").
*'''vlc.video.logo.delay''': (supported in vlc version >= 1.1.0) display each picture for a duration of 1000 ms (default) before displaying the next picture.
*'''vlc.video.logo.repeat''': (supported in vlc version >= 1.1.0) number of loops for picture animation (-1=continuous, 0=disabled, n=n-times). The default is -1 (continuous).
*'''vlc.video.logo.x''': (supported in vlc version >= 1.1.0) change the x-offset for displaying the picture counting from top-left on the screen.
*'''vlc.video.logo.y''': (supported in vlc version >= 1.1.0) change the y-offset for displaying the picture counting from top-left on the screen.
*'''vlc.video.logo.width''': (supported in vlc version >= 1.1.0) change the picture width.
*'''vlc.video.logo.height''': (supported in vlc version >= 1.1.0) change the picture height.

methods

*'''vlc.video.logo.enable()''': (supported in vlc version >= 1.1.0) enable logo video filter.
*'''vlc.video.logo.disable()''': (supported in vlc version >= 1.1.0) disable logo video filter.
*'''vlc.video.logo.file("file.png")''': (supported in vlc version >= 1.1.0) display my file.png as logo on the screen.

Some problems may happen because of the VLC asynchronous functioning. To avoid it, after enabling logo video filter, you have to wait a little time before changing an option. But it should be fixed by the new vout implementation.

== MediaDescription Object ==

readonly properties

*'''vlc.mediaDescription.title''': (supported in vlc version >= 2.0.2) returns title meta information field.
*'''vlc.mediaDescription.artist''': (supported in vlc version >= 2.0.2) returns artist meta information field.
*'''vlc.mediaDescription.copyright''': (supported in vlc version >= 2.0.2) returns copyright meta information field.
*'''vlc.mediaDescription.album''': (supported in vlc version >= 2.0.2) returns album meta information field.
*'''vlc.mediaDescription.trackNumber''': (supported in vlc version >= 2.0.2) returns trackNumber meta information field.
*'''vlc.mediaDescription.description''': (supported in vlc version >= 2.0.2) returns description meta information field.
*'''vlc.mediaDescription.rating''': (supported in vlc version >= 2.0.2) returns rating meta information field.
*'''vlc.mediaDescription.date''': (supported in vlc version >= 2.0.2) returns date meta information field.
*'''vlc.mediaDescription.setting''': (supported in vlc version >= 2.0.2) returns setting meta information field.
*'''vlc.mediaDescription.URL''': (supported in vlc version >= 2.0.2) returns URL meta information field.
*'''vlc.mediaDescription.language''': (supported in vlc version >= 2.0.2) returns language meta information field.
*'''vlc.mediaDescription.nowPlaying''': (supported in vlc version >= 2.0.2) returns nowPlaying meta information field.
*'''vlc.mediaDescription.publisher''': (supported in vlc version >= 2.0.2) returns publisher meta information field.
*'''vlc.mediaDescription.encodedBy''': (supported in vlc version >= 2.0.2) returns encodedBy meta information field.

*'''vlc.mediaDescription.artworkURL''': (supported in vlc version >= 2.0.2) returns artworkURL meta information field.

*'''vlc.mediaDescription.trackID''': (supported in vlc version >= 2.0.2) returns trackID meta information field.

read/write properties

*''none''

methods

*''none''

== DEPRECATED APIs ==
=== DEPRECATED: Log object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

This object allows accessing VLC main message logging queue. Typically this queue capacity is very small (no nore than 256 entries) and can easily overflow, therefore messages should be read and cleared as often as possible.

readonly properties

*'''vlc.log.messages''': returns the message collection, see [[#Messages_object|Messages object]]

read/write properties

*'''vlc.log.verbosity''': write number [-1,0,1,2,3] for changing the verbosity level of the log messages; messages whose verbosity is higher than set will be not be logged in the queue. The numbers have the following meaning: -1 disable, 0 info, 1 error, 2 warning, 3 debug.

methods

*''none''

=== DEPRECATED: Messages object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

readonly properties

*'''messages.count''': returns number of messages in the log

read/write properties

*''none''

methods

*'''messages.clear()''': clear the current log buffer. It should be called as frequently as possible to not overflow the message queue. Call this method after the log messages of interest are read.
*'''messages.iterator()''': creates and returns an iterator object, used to iterate over the messages in the log. '''Don't clear the log buffer while holding an iterator object.'''

=== DEPRECATED: Messages Iterator object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

readonly properties

*'''iterator.hasNext''': returns a boolean that indicates whether ''vlc.log.messages.next()'' will return the next message.

read/write properties

*''none''

methods

*'''iterator.next()''': returns the next message object in the log, see [[Message object]]

=== DEPRECATED: Message subobject ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

*'''message.severity''': number that indicates the severity of the log message (0 = info, 1 = error, 2 = warning, 3 = debug)
*'''message.name''': name of VLC module that printed the log message (e.g: main, http, directx, etc...)
*'''message.type''': type of VLC module that printed the log message (eg: input, access, vout, sout, etc...)
*'''message.message''': the message text

{{Documentation}}

[[Category:Embedded]]

Documentation:WebPlugin

2013-01-02T13:19:15Z

Etix: /* Required elements */

This Documentation speaks about the {{VLC}} Web plugins and how to write pages for it.
{{RightMenu|documentation play howto toc}}

= Introduction: Building Web pages with Video =

The {{VLC}} webplugins are native browser plugins, similar to Flash or Silverlight plugins and allow playback inside the browser of all the videos that {{VLC}} can read.

Additionally to viewing video on all pages, you can build custom pages that will use the advanced features of the plugin, using Javascript functions to control playback or extract information from the plugin.

There are 2 main plugins: one is ActiveX for IE, the other is NPAPI for the other browsers. They feature the same amount of features.

In older versions, those plugins were very crashy. '''We URGE YOU''' to use VLC '''1.2.0''' or newer versions.

=== Browsers support ===
It has been tested with:
* Mozilla Firefox [[Image:Firefox-logo.png|40x40px]]
* Internet Explorer [[Image:20101105053305!Internet Explorer 9.png|40x40px]]
* Safari [[Image:Apple Safari.png|40x40px]]
* Chrome
* Konqueror
* Opera

It has been tested on GNU/Linux, Windows and MacOS.

= Embed tag attributes =

To embed the plugin into a webpage use the following <embed> template:

<nowiki>
<embed type="application/x-vlc-plugin" pluginspage="http://www.videolan.org" />

<object classid="clsid:9BE31822-FDAD-461B-AD51-BE1D1C159921" codebase="http://download.videolan.org/pub/videolan/vlc/last/win32/axvlc.cab"></object>
</nowiki>

=== Required elements ===
These are '''required''' attributes for the <embed> tag:

*'''width''': Specifies the width of the plugin.
*'''height''': Specifies the height of the plugin.
*'''target''' (or one of these alias: '''mrl''', '''filename''', '''src'''): Specifies the source location (URL) of the video to load.

=== Optionnal elements ===
These are additional attributes for the <embed> tag:

*'''autoplay''', '''autostart''': Specifies whether the plugin starts playing on load. Default: ''true''
*'''allowfullscreen''': (available since VLC version 1.2.0) Specifies whether the user can switch into fullscreen mode. Default: ''true''
*'''mute''': Specifies whether the audio volume is initially muted. Default: ''false''
*'''loop''', '''autoloop''': Specifies whether the video loops on end. Default: ''false''
*'''toolbar''': Specifies whether the toolbar is shown by default. Default: ''true''
*'''bgcolor''': Specifies the background color of the video player. Default: ''#000000''

=== Normal DOM elements ===
*'''id''': DOM id
*'''name''': DOM name

= Javascript API description =

The vlc plugin exports several objects that can be accessed for setting and getting information. When used improperly the API's will throw an exception that includes a string that explains what happened. For example when asking for vlc.input.length when there is no playlist item playing.

== VLC objects ==
The vlc plugin knows the following objects:

*'''audio''': Access audio properties.
*'''input''': Access input properties.
*'''playlist''': Access playlist properties.
*'''subtitle''': Access subtitle properties.
*'''video''': Access video properties.
**'''video.marquee''': Access marquee video filter properties.
**'''video.logo''': Access logo video filter properties.
*'''mediaDescription''': Access media info properties (only available in vlc version >= 2.0.2).

The following are deprecated:
*'''log''': Access log properties (only available in vlc version <= 1.0.0-rc1).
*'''messages''': Access to log message properties (only available in vlc version <= 1.0.0-rc1).
*'''iterator''': Access to log iterator properties (only available in vlc version <= 1.0.0-rc1).
*'''message''': Access to log message properties (only available in vlc version <= 1.0.0-rc1).

=== Example ===
The following JavaScript code shows howto get a reference to the vlc plugin. This reference can then be used to access the objects of the vlc plugin.

<html>
<title>VLC Mozilla plugin test page</title>
<body>
<embed type="application/x-vlc-plugin" pluginspage="http://www.videolan.org"
width="640"
height="480"
id="vlc">
</embed>
<script language="Javascript">

</script>
</body>
</html>

== Root object ==

readonly properties

*'''VersionInfo''': returns version information string

read/write properties

*''none''

methods

*'''vlc.versionInfo()''': returns version information string (same as VersionInfo)

*'''vlc.addEventListener(eventname, callback, bubble)''': (only for Mozilla) add a listener for mentioned event name, callback expects a function and bubble influences the order of eventhandling by JS (usually it is set to false).
*'''vlc.removeEventListener(eventname, callback, bubble)''': (only for Mozilla) remove listener for mentioned event name, callback expects a function and bubble influences the order of eventhandling by JS (usually it is set to false).

*'''vlc.attachEvent(eventname, callback)''': (only for ActiveX) add listener for mentioned event name, callback expects a function
*'''vlc.removeEvent(eventname, callback)''': (only for ActiveX) remove listener for mentioned event name, callback expects a function

events

*'''MediaPlayerNothingSpecial''': vlc is in idle state doing nothing but waiting for a command to be issued
*'''MediaPlayerOpening''': vlc is opening an media resource locator (MRL)
*'''MediaPlayerBuffering''': vlc is buffering
*'''MediaPlayerPlaying''': vlc is playing a media
*'''MediaPlayerPaused''': vlc is in paused state
*'''MediaPlayerForward''': vlc is fastforwarding through the media (works only when an input supports forward playback)
*'''MediaPlayerBackward''': vlc is going backwards through the media (works only when an input supports backwards playback)
*'''MediaPlayerEncounteredError''': vlc has encountered an error and is unable to continue
*'''MediaPlayerEndReached''': vlc has reached the end of current playlist
*'''MediaPlayerTimeChanged''': time has changed
*'''MediaPlayerPositionChanged''': media position has changed
*'''MediaPlayerSeekableChanged''': media seekable flag has changed (true means media is seekable, false means it is not)
*'''MediaPlayerPausableChanged''': media pausable flag has changed (true means media is pauseable, false means it is not)

=== Example ===
The following code snippit provides easy functions to register and unregister event callbacks on all supported platforms (currently only Linux mozilla based browsers and windows activeX objects for Internet Explorer).

<SCRIPT language="javascript">


== Audio object ==

readonly properties

*'''vlc.audio.count''': (supported in vlc version >= 1.1.0) returns the number of audio track available.

read/write properties

*'''vlc.audio.mute''': boolean value to mute and unmute the audio.
*'''vlc.audio.volume''': a value between [0-200] which indicates a percentage of the volume.
*'''vlc.audio.track''': (supported in vlc version > 0.8.6) a value between [1-65535] which indicates the audio track to play or that is playing. a value of 0 means the audio is/will be disabled.
*'''vlc.audio.channel''': (supported in vlc version > 0.8.6) integer value between [1-5] that indicates which audio channel mode is used, values can be: "1=stereo", "2=reverse stereo", "3=left", "4=right", "5=dolby". Use vlc.audio.channel to check if setting of the audio channel mode has succeeded.

methods

*'''vlc.audio.toggleMute()''': boolean toggle that mutes and unmutes the audio based upon the previous state.
*'''vlc.audio.description(int i)''': (supported in vlc version >= 1.1.0) give the i-th audio track name. 0 corresponds to disable and 1 to the first audio track.

=== Example ===
Audio Channel:
<SELECT readonly onChange='doAudioChannel(this.value)'>
<OPTION value=1>Stereo</OPTION>
<OPTION value=2>Reverse stereo</OPTION>
<OPTION value=3>Left</OPTION>
<OPTION value=4>Right</OPTION>
<OPTION value=5>Dolby</OPTION>
</SELECT>

<SCRIPT language="javascript">


== Input object ==

readonly properties

*'''vlc.input.length''': length of the input file in number of milliseconds. 0 is returned for 'live' streams or clips whose length cannot be determined by VLC. It returns -1 if no input is playing.
*'''vlc.input.fps''': frames per second returned as a float (typically 60.0, 50.0, 23.976, etc...)
*'''vlc.input.hasVout''': a boolean that returns true when the video is being displayed, it returns false when video is not displayed

read/write properties

*'''vlc.input.position''': normalized position in multimedia stream item given as a float value between [0.0 - 1.0]
*'''vlc.input.time''': the absolute position in time given in milliseconds, this property can be used to seek through the stream


vlc.input.time = <absolute seek>

vlc.input.time = vlc.input.time + <relative seek>

*'''vlc.input.state''': current state of the input chain given as enumeration (IDLE=0, OPENING=1, BUFFERING=2, PLAYING=3, PAUSED=4, STOPPING=5, ENDED=6, ERROR=7). Note: Test for ENDED=6 to catch end of playback. Checking for STOPPING=5 is NOT ENOUGH.
*'''vlc.input.rate''': input speed given as float (1.0 for normal speed, 0.5 for half speed, 2.0 for twice as fast, etc.).

rate > 1  : is fastforward
rate > 0 and rate < 1 : is slow motion
rate < 0  : is rewind

methods

*''none''

== Playlist object ==

readonly properties

*'''vlc.playlist.itemCount''': number that returns the amount of items currently in the playlist ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])
*'''vlc.playlist.isPlaying''': a boolean that returns true if the current playlist item is playing and false when it is not playing
*'''vlc.playlist.items''': return the playlist items collection, see [[#Playlist_items_object|Playlist items]]

read/write properties

*''none''

methods

*'''vlc.playlist.add(mrl)''': add a playlist item as [[MRL]]. The MRL must be given as a string. Returns a number as an item identifier in playlist (this is not a position in playlist).
*'''vlc.playlist.add(mrl,name,options)''': add a playlist item as MRL, with metaname 'name' and options 'options'. options are text arguments which can be provided either as a single string containing space separated values, akin to VLC command line, or as an array of string values. Returns a number as an item identifier in playlist (this is not a position in playlist).

var options = new Array(":aspect-ratio=4:3", "--rtsp-tcp");
var id = vlc.playlist.add("rtsp://servername/item/to/play", "fancy name", options);
vlc.playlist.playItem(id);

*'''vlc.playlist.play()''': start playing the current playlist item
*'''vlc.playlist.playItem(number)''': start playing the item whose identifier is number
*'''vlc.playlist.pause()''': pause the current playlist item
*'''vlc.playlist.togglePause()''': toggle the pause state for the current playlist item
*'''vlc.playlist.stop()''': stop playing the current playlist item
*'''vlc.playlist.next()''': iterate to the next playlist item
*'''vlc.playlist.prev()''': iterate to the previous playlist item
*'''vlc.playlist.clear()''': empty the current playlist, all items will be deleted from the playlist ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])
*'''vlc.playlist.removeItem(number)''': remove the item from playlist whose identifier is number  ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])

=== Playlist items object ===

readonly properties

*'''vlc.playlist.items.count''': number of items currently in the playlist

read/write properties

*''none''

methods

*'''vlc.playlist.items.clear()''': empty the current playlist, all items will be deleted from the playlist. If a movie is playing, it stop. Note that when this method returns, playlist may not have been entirely been cleared as this operation is performed asynchronously; use the ''count'' property to verify/wait until the playlist is empty.
*'''vlc.playlist.items.remove(number)''': remove the item whose identifier is number from playlist. (note: this number isn't the position in the playlist, but the number given by vlc.playlist.add() )

== Subtitle object ==

readonly properties

*'''vlc.subtitle.count''': (supported in vlc version >= 1.1.0) returns the number of subtitle available.

read/write properties

*'''vlc.subtitle.track''': (supported in vlc version >= 1.1.0) get and set the subtitle track to show on the video screen. The property takes an integer as input value [1..65535]. If subtitle track is set to 0, the subtitles will be disabled. If set to a value outside the current subtitle tracks range, then it will return -1 and display an error message.

methods

*'''vlc.subtitle.description(int i)''': (supported in vlc version >= 1.1.0) give the i-th subtitle name. 0 correspond to disable and 1 to the first subtitle.

== Video object ==

readonly properties

*'''vlc.video.width''': returns the horizontal size of the video
*'''vlc.video.height''': returns the vertical size of the video

read/write properties

*'''vlc.video.fullscreen''': when set to true the video will be displayed in fullscreen mode, when set to false the video will be shown inside the video output size. The property takes a boolean as input.
*'''vlc.video.aspectRatio''': get and set the aspect ratio to use in the video screen. The property takes a string as input value. Typical values are: "1:1", "4:3", "16:9", "16:10", "221:100" and "5:4"
*'''vlc.video.subtitle''': (supported in vlc version > 0.8.6a) get and set the subtitle track to show on the video screen. The property takes an integer as input value [1..65535]. If subtitle track is set to 0, the subtitles will be disabled. If set to a value outside the current subtitle tracks range, then it will return -1 and display an error message.
*'''vlc.video.teletext''': (supported in vlc version >= 0.9.0) get and set teletext page to show on the video stream. This will only work if a teletext elementary stream is available in the video stream. The property takes an integer as input value [0..999] for indicating the teletext page to view, setting the value to 0 means hide teletext. On error it will return -1 and display an error message.

methods

*'''vlc.video.toggleFullscreen()''': toggle the fullscreen mode based on the previous setting
*'''vlc.video.toggleTeletext()''': (supported in vlc version >= 0.9.0) toggle the teletext page to overlay transparent or not, based on the previous setting

=== Deinterlace Object ===

readonly properties

*''none''

read/write properties

*''none''

methods

*'''vlc.video.deinterlace.enable("my_mode")''': (supported in vlc version >= 1.1.0) enable deinterlacing with my_mode. You can enable it with "blend", "bob", "discard", "linear", "mean", "x", "yadif" or "yadif2x" mode. Enabling too soon deinterlacing may cause some problems. You have to wait that all variable are available before enabling it.
*'''vlc.video.deinterlace.disable()''': (supported in vlc version >= 1.1.0) disable deinterlacing.

=== Marquee Object ===

readonly properties

*''none''

read/write properties

*'''vlc.video.marquee.text''': (supported in vlc version >= 1.1.0) display my text on the screen.
*'''vlc.video.marquee.color''': (supported in vlc version >= 1.1.0) change the text color. val is the new color to use (WHITE=0x000000, BLACK=0xFFFFFF, RED=0xFF0000, GREEN=0x00FF00, BLUE=0x0000FF...).
*'''vlc.video.marquee.opacity''': (supported in vlc version >= 1.1.0) change the text opacity, val is defined from 0 (completely transparent) to 255 (completely opaque).
*'''vlc.video.marquee.position''': (supported in vlc version >= 1.1.0) change the text position (CENTER=0, LEFT=1, RIGHT=2, TOP=4, TOP-LEFT=5, TOP-RIGHT=6, BOTTOM=8, BOTTOM-LEFT=9, BOTTOM_RIGHT=10).
*'''vlc.video.marquee.refresh''': (supported in vlc version >= 1.1.0) change the marquee refresh period.
*'''vlc.video.marquee.size''': (supported in vlc version >= 1.1.0) val define the new size for the text displayed on the screen. If the text is bigger than the screen then the text is not displayed.
*'''vlc.video.marquee.timeout''': (supported in vlc version >= 1.1.0) change the timeout value. val is defined in ms, but 0 value correspond to unlimited.
*'''vlc.video.marquee.x''': (supported in vlc version >= 1.1.0) change text abscissa.
*'''vlc.video.marquee.y''': (supported in vlc version >= 1.1.0) change text ordinate.

methods

*'''vlc.video.marquee.enable()''': (supported in vlc version >= 1.1.0) enable marquee filter.
*'''vlc.video.marquee.disable()''': (supported in vlc version >= 1.1.0) disable marquee filter.

Some problems may happen (option like color or text will not be applied) because of the VLC asynchronous functioning. To avoid it, after enabling marquee, you have to wait a little time before changing an option. But it should be fixed by the new vout implementation.

NOTE: [http://forum.videolan.org/viewtopic.php?f=16&t=89427#p295058]

=== Logo Object ===

readonly properties

*''none''

read/write properties

*'''vlc.video.logo.opacity''': (supported in vlc version >= 1.1.0) change the picture opacity, val is defined from 0 (completely transparent) to 255 (completely opaque).
*'''vlc.video.logo.position''': (supported in vlc version >= 1.1.0) change the text position ("center", "left", "right", "top", "top-left", "top-right", "bottom", "bottom-left", "bottom-right").
*'''vlc.video.logo.delay''': (supported in vlc version >= 1.1.0) display each picture for a duration of 1000 ms (default) before displaying the next picture.
*'''vlc.video.logo.repeat''': (supported in vlc version >= 1.1.0) number of loops for picture animation (-1=continuous, 0=disabled, n=n-times). The default is -1 (continuous).
*'''vlc.video.logo.x''': (supported in vlc version >= 1.1.0) change the x-offset for displaying the picture counting from top-left on the screen.
*'''vlc.video.logo.y''': (supported in vlc version >= 1.1.0) change the y-offset for displaying the picture counting from top-left on the screen.
*'''vlc.video.logo.width''': (supported in vlc version >= 1.1.0) change the picture width.
*'''vlc.video.logo.height''': (supported in vlc version >= 1.1.0) change the picture height.

methods

*'''vlc.video.logo.enable()''': (supported in vlc version >= 1.1.0) enable logo video filter.
*'''vlc.video.logo.disable()''': (supported in vlc version >= 1.1.0) disable logo video filter.
*'''vlc.video.logo.file("file.png")''': (supported in vlc version >= 1.1.0) display my file.png as logo on the screen.

Some problems may happen because of the VLC asynchronous functioning. To avoid it, after enabling logo video filter, you have to wait a little time before changing an option. But it should be fixed by the new vout implementation.

== MediaDescription Object ==

readonly properties

*'''vlc.mediaDescription.title''': (supported in vlc version >= 2.0.2) returns title meta information field.
*'''vlc.mediaDescription.artist''': (supported in vlc version >= 2.0.2) returns artist meta information field.
*'''vlc.mediaDescription.copyright''': (supported in vlc version >= 2.0.2) returns copyright meta information field.
*'''vlc.mediaDescription.album''': (supported in vlc version >= 2.0.2) returns album meta information field.
*'''vlc.mediaDescription.trackNumber''': (supported in vlc version >= 2.0.2) returns trackNumber meta information field.
*'''vlc.mediaDescription.description''': (supported in vlc version >= 2.0.2) returns description meta information field.
*'''vlc.mediaDescription.rating''': (supported in vlc version >= 2.0.2) returns rating meta information field.
*'''vlc.mediaDescription.date''': (supported in vlc version >= 2.0.2) returns date meta information field.
*'''vlc.mediaDescription.setting''': (supported in vlc version >= 2.0.2) returns setting meta information field.
*'''vlc.mediaDescription.URL''': (supported in vlc version >= 2.0.2) returns URL meta information field.
*'''vlc.mediaDescription.language''': (supported in vlc version >= 2.0.2) returns language meta information field.
*'''vlc.mediaDescription.nowPlaying''': (supported in vlc version >= 2.0.2) returns nowPlaying meta information field.
*'''vlc.mediaDescription.publisher''': (supported in vlc version >= 2.0.2) returns publisher meta information field.
*'''vlc.mediaDescription.encodedBy''': (supported in vlc version >= 2.0.2) returns encodedBy meta information field.

*'''vlc.mediaDescription.artworkURL''': (supported in vlc version >= 2.0.2) returns artworkURL meta information field.

*'''vlc.mediaDescription.trackID''': (supported in vlc version >= 2.0.2) returns trackID meta information field.

read/write properties

*''none''

methods

*''none''

== DEPRECATED APIs ==
=== DEPRECATED: Log object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

This object allows accessing VLC main message logging queue. Typically this queue capacity is very small (no nore than 256 entries) and can easily overflow, therefore messages should be read and cleared as often as possible.

readonly properties

*'''vlc.log.messages''': returns the message collection, see [[#Messages_object|Messages object]]

read/write properties

*'''vlc.log.verbosity''': write number [-1,0,1,2,3] for changing the verbosity level of the log messages; messages whose verbosity is higher than set will be not be logged in the queue. The numbers have the following meaning: -1 disable, 0 info, 1 error, 2 warning, 3 debug.

methods

*''none''

=== DEPRECATED: Messages object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

readonly properties

*'''messages.count''': returns number of messages in the log

read/write properties

*''none''

methods

*'''messages.clear()''': clear the current log buffer. It should be called as frequently as possible to not overflow the message queue. Call this method after the log messages of interest are read.
*'''messages.iterator()''': creates and returns an iterator object, used to iterate over the messages in the log. '''Don't clear the log buffer while holding an iterator object.'''

=== DEPRECATED: Messages Iterator object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

readonly properties

*'''iterator.hasNext''': returns a boolean that indicates whether ''vlc.log.messages.next()'' will return the next message.

read/write properties

*''none''

methods

*'''iterator.next()''': returns the next message object in the log, see [[Message object]]

=== DEPRECATED: Message subobject ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

*'''message.severity''': number that indicates the severity of the log message (0 = info, 1 = error, 2 = warning, 3 = debug)
*'''message.name''': name of VLC module that printed the log message (e.g: main, http, directx, etc...)
*'''message.type''': type of VLC module that printed the log message (eg: input, access, vout, sout, etc...)
*'''message.message''': the message text

{{Documentation}}

[[Category:Embedded]]

Documentation:WebPlugin

2013-01-02T13:11:49Z

Etix: Remove the 0.8.5 section

This Documentation speaks about the {{VLC}} Web plugins and how to write pages for it.
{{RightMenu|documentation play howto toc}}

= Introduction: Building Web pages with Video =

The {{VLC}} webplugins are native browser plugins, similar to Flash or Silverlight plugins and allow playback inside the browser of all the videos that {{VLC}} can read.

Additionally to viewing video on all pages, you can build custom pages that will use the advanced features of the plugin, using Javascript functions to control playback or extract information from the plugin.

There are 2 main plugins: one is ActiveX for IE, the other is NPAPI for the other browsers. They feature the same amount of features.

In older versions, those plugins were very crashy. '''We URGE YOU''' to use VLC '''1.2.0''' or newer versions.

=== Browsers support ===
It has been tested with:
* Mozilla Firefox [[Image:Firefox-logo.png|40x40px]]
* Internet Explorer [[Image:20101105053305!Internet Explorer 9.png|40x40px]]
* Safari [[Image:Apple Safari.png|40x40px]]
* Chrome
* Konqueror
* Opera

It has been tested on GNU/Linux, Windows and MacOS.

= Embed tag attributes =

To embed the plugin into a webpage use the following <embed> template:

<nowiki>
<embed type="application/x-vlc-plugin" pluginspage="http://www.videolan.org" />

<object classid="clsid:9BE31822-FDAD-461B-AD51-BE1D1C159921" codebase="http://download.videolan.org/pub/videolan/vlc/last/win32/axvlc.cab"></object>
</nowiki>

=== Required elements ===
These are '''required''' attributes for the <embed> tag:

*'''width''': Specifies the width of the plugin.
*'''height''': Specifies the height of the plugin.
*'''target''', '''mrl''', '''filename''', '''src''': Specifies the source location (URL) of the video to load.

=== Optionnal elements ===
These are additional attributes for the <embed> tag:

*'''autoplay''', '''autostart''': Specifies whether the plugin starts playing on load. Default: ''true''
*'''allowfullscreen''': (available since VLC version 1.2.0) Specifies whether the user can switch into fullscreen mode. Default: ''true''
*'''mute''': Specifies whether the audio volume is initially muted. Default: ''false''
*'''loop''', '''autoloop''': Specifies whether the video loops on end. Default: ''false''
*'''toolbar''': Specifies whether the toolbar is shown by default. Default: ''true''
*'''bgcolor''': Specifies the background color of the video player. Default: ''#000000''

=== Normal DOM elements ===
*'''id''': DOM id
*'''name''': DOM name

= Javascript API description =

The vlc plugin exports several objects that can be accessed for setting and getting information. When used improperly the API's will throw an exception that includes a string that explains what happened. For example when asking for vlc.input.length when there is no playlist item playing.

== VLC objects ==
The vlc plugin knows the following objects:

*'''audio''': Access audio properties.
*'''input''': Access input properties.
*'''playlist''': Access playlist properties.
*'''subtitle''': Access subtitle properties.
*'''video''': Access video properties.
**'''video.marquee''': Access marquee video filter properties.
**'''video.logo''': Access logo video filter properties.
*'''mediaDescription''': Access media info properties (only available in vlc version >= 2.0.2).

The following are deprecated:
*'''log''': Access log properties (only available in vlc version <= 1.0.0-rc1).
*'''messages''': Access to log message properties (only available in vlc version <= 1.0.0-rc1).
*'''iterator''': Access to log iterator properties (only available in vlc version <= 1.0.0-rc1).
*'''message''': Access to log message properties (only available in vlc version <= 1.0.0-rc1).

=== Example ===
The following JavaScript code shows howto get a reference to the vlc plugin. This reference can then be used to access the objects of the vlc plugin.

<html>
<title>VLC Mozilla plugin test page</title>
<body>
<embed type="application/x-vlc-plugin" pluginspage="http://www.videolan.org"
width="640"
height="480"
id="vlc">
</embed>
<script language="Javascript">

</script>
</body>
</html>

== Root object ==

readonly properties

*'''VersionInfo''': returns version information string

read/write properties

*''none''

methods

*'''vlc.versionInfo()''': returns version information string (same as VersionInfo)

*'''vlc.addEventListener(eventname, callback, bubble)''': (only for Mozilla) add a listener for mentioned event name, callback expects a function and bubble influences the order of eventhandling by JS (usually it is set to false).
*'''vlc.removeEventListener(eventname, callback, bubble)''': (only for Mozilla) remove listener for mentioned event name, callback expects a function and bubble influences the order of eventhandling by JS (usually it is set to false).

*'''vlc.attachEvent(eventname, callback)''': (only for ActiveX) add listener for mentioned event name, callback expects a function
*'''vlc.removeEvent(eventname, callback)''': (only for ActiveX) remove listener for mentioned event name, callback expects a function

events

*'''MediaPlayerNothingSpecial''': vlc is in idle state doing nothing but waiting for a command to be issued
*'''MediaPlayerOpening''': vlc is opening an media resource locator (MRL)
*'''MediaPlayerBuffering''': vlc is buffering
*'''MediaPlayerPlaying''': vlc is playing a media
*'''MediaPlayerPaused''': vlc is in paused state
*'''MediaPlayerForward''': vlc is fastforwarding through the media (works only when an input supports forward playback)
*'''MediaPlayerBackward''': vlc is going backwards through the media (works only when an input supports backwards playback)
*'''MediaPlayerEncounteredError''': vlc has encountered an error and is unable to continue
*'''MediaPlayerEndReached''': vlc has reached the end of current playlist
*'''MediaPlayerTimeChanged''': time has changed
*'''MediaPlayerPositionChanged''': media position has changed
*'''MediaPlayerSeekableChanged''': media seekable flag has changed (true means media is seekable, false means it is not)
*'''MediaPlayerPausableChanged''': media pausable flag has changed (true means media is pauseable, false means it is not)

=== Example ===
The following code snippit provides easy functions to register and unregister event callbacks on all supported platforms (currently only Linux mozilla based browsers and windows activeX objects for Internet Explorer).

<SCRIPT language="javascript">


== Audio object ==

readonly properties

*'''vlc.audio.count''': (supported in vlc version >= 1.1.0) returns the number of audio track available.

read/write properties

*'''vlc.audio.mute''': boolean value to mute and unmute the audio.
*'''vlc.audio.volume''': a value between [0-200] which indicates a percentage of the volume.
*'''vlc.audio.track''': (supported in vlc version > 0.8.6) a value between [1-65535] which indicates the audio track to play or that is playing. a value of 0 means the audio is/will be disabled.
*'''vlc.audio.channel''': (supported in vlc version > 0.8.6) integer value between [1-5] that indicates which audio channel mode is used, values can be: "1=stereo", "2=reverse stereo", "3=left", "4=right", "5=dolby". Use vlc.audio.channel to check if setting of the audio channel mode has succeeded.

methods

*'''vlc.audio.toggleMute()''': boolean toggle that mutes and unmutes the audio based upon the previous state.
*'''vlc.audio.description(int i)''': (supported in vlc version >= 1.1.0) give the i-th audio track name. 0 corresponds to disable and 1 to the first audio track.

=== Example ===
Audio Channel:
<SELECT readonly onChange='doAudioChannel(this.value)'>
<OPTION value=1>Stereo</OPTION>
<OPTION value=2>Reverse stereo</OPTION>
<OPTION value=3>Left</OPTION>
<OPTION value=4>Right</OPTION>
<OPTION value=5>Dolby</OPTION>
</SELECT>

<SCRIPT language="javascript">


== Input object ==

readonly properties

*'''vlc.input.length''': length of the input file in number of milliseconds. 0 is returned for 'live' streams or clips whose length cannot be determined by VLC. It returns -1 if no input is playing.
*'''vlc.input.fps''': frames per second returned as a float (typically 60.0, 50.0, 23.976, etc...)
*'''vlc.input.hasVout''': a boolean that returns true when the video is being displayed, it returns false when video is not displayed

read/write properties

*'''vlc.input.position''': normalized position in multimedia stream item given as a float value between [0.0 - 1.0]
*'''vlc.input.time''': the absolute position in time given in milliseconds, this property can be used to seek through the stream


vlc.input.time = <absolute seek>

vlc.input.time = vlc.input.time + <relative seek>

*'''vlc.input.state''': current state of the input chain given as enumeration (IDLE=0, OPENING=1, BUFFERING=2, PLAYING=3, PAUSED=4, STOPPING=5, ENDED=6, ERROR=7). Note: Test for ENDED=6 to catch end of playback. Checking for STOPPING=5 is NOT ENOUGH.
*'''vlc.input.rate''': input speed given as float (1.0 for normal speed, 0.5 for half speed, 2.0 for twice as fast, etc.).

rate > 1  : is fastforward
rate > 0 and rate < 1 : is slow motion
rate < 0  : is rewind

methods

*''none''

== Playlist object ==

readonly properties

*'''vlc.playlist.itemCount''': number that returns the amount of items currently in the playlist ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])
*'''vlc.playlist.isPlaying''': a boolean that returns true if the current playlist item is playing and false when it is not playing
*'''vlc.playlist.items''': return the playlist items collection, see [[#Playlist_items_object|Playlist items]]

read/write properties

*''none''

methods

*'''vlc.playlist.add(mrl)''': add a playlist item as [[MRL]]. The MRL must be given as a string. Returns a number as an item identifier in playlist (this is not a position in playlist).
*'''vlc.playlist.add(mrl,name,options)''': add a playlist item as MRL, with metaname 'name' and options 'options'. options are text arguments which can be provided either as a single string containing space separated values, akin to VLC command line, or as an array of string values. Returns a number as an item identifier in playlist (this is not a position in playlist).

var options = new Array(":aspect-ratio=4:3", "--rtsp-tcp");
var id = vlc.playlist.add("rtsp://servername/item/to/play", "fancy name", options);
vlc.playlist.playItem(id);

*'''vlc.playlist.play()''': start playing the current playlist item
*'''vlc.playlist.playItem(number)''': start playing the item whose identifier is number
*'''vlc.playlist.pause()''': pause the current playlist item
*'''vlc.playlist.togglePause()''': toggle the pause state for the current playlist item
*'''vlc.playlist.stop()''': stop playing the current playlist item
*'''vlc.playlist.next()''': iterate to the next playlist item
*'''vlc.playlist.prev()''': iterate to the previous playlist item
*'''vlc.playlist.clear()''': empty the current playlist, all items will be deleted from the playlist ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])
*'''vlc.playlist.removeItem(number)''': remove the item from playlist whose identifier is number  ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])

=== Playlist items object ===

readonly properties

*'''vlc.playlist.items.count''': number of items currently in the playlist

read/write properties

*''none''

methods

*'''vlc.playlist.items.clear()''': empty the current playlist, all items will be deleted from the playlist. If a movie is playing, it stop. Note that when this method returns, playlist may not have been entirely been cleared as this operation is performed asynchronously; use the ''count'' property to verify/wait until the playlist is empty.
*'''vlc.playlist.items.remove(number)''': remove the item whose identifier is number from playlist. (note: this number isn't the position in the playlist, but the number given by vlc.playlist.add() )

== Subtitle object ==

readonly properties

*'''vlc.subtitle.count''': (supported in vlc version >= 1.1.0) returns the number of subtitle available.

read/write properties

*'''vlc.subtitle.track''': (supported in vlc version >= 1.1.0) get and set the subtitle track to show on the video screen. The property takes an integer as input value [1..65535]. If subtitle track is set to 0, the subtitles will be disabled. If set to a value outside the current subtitle tracks range, then it will return -1 and display an error message.

methods

*'''vlc.subtitle.description(int i)''': (supported in vlc version >= 1.1.0) give the i-th subtitle name. 0 correspond to disable and 1 to the first subtitle.

== Video object ==

readonly properties

*'''vlc.video.width''': returns the horizontal size of the video
*'''vlc.video.height''': returns the vertical size of the video

read/write properties

*'''vlc.video.fullscreen''': when set to true the video will be displayed in fullscreen mode, when set to false the video will be shown inside the video output size. The property takes a boolean as input.
*'''vlc.video.aspectRatio''': get and set the aspect ratio to use in the video screen. The property takes a string as input value. Typical values are: "1:1", "4:3", "16:9", "16:10", "221:100" and "5:4"
*'''vlc.video.subtitle''': (supported in vlc version > 0.8.6a) get and set the subtitle track to show on the video screen. The property takes an integer as input value [1..65535]. If subtitle track is set to 0, the subtitles will be disabled. If set to a value outside the current subtitle tracks range, then it will return -1 and display an error message.
*'''vlc.video.teletext''': (supported in vlc version >= 0.9.0) get and set teletext page to show on the video stream. This will only work if a teletext elementary stream is available in the video stream. The property takes an integer as input value [0..999] for indicating the teletext page to view, setting the value to 0 means hide teletext. On error it will return -1 and display an error message.

methods

*'''vlc.video.toggleFullscreen()''': toggle the fullscreen mode based on the previous setting
*'''vlc.video.toggleTeletext()''': (supported in vlc version >= 0.9.0) toggle the teletext page to overlay transparent or not, based on the previous setting

=== Deinterlace Object ===

readonly properties

*''none''

read/write properties

*''none''

methods

*'''vlc.video.deinterlace.enable("my_mode")''': (supported in vlc version >= 1.1.0) enable deinterlacing with my_mode. You can enable it with "blend", "bob", "discard", "linear", "mean", "x", "yadif" or "yadif2x" mode. Enabling too soon deinterlacing may cause some problems. You have to wait that all variable are available before enabling it.
*'''vlc.video.deinterlace.disable()''': (supported in vlc version >= 1.1.0) disable deinterlacing.

=== Marquee Object ===

readonly properties

*''none''

read/write properties

*'''vlc.video.marquee.text''': (supported in vlc version >= 1.1.0) display my text on the screen.
*'''vlc.video.marquee.color''': (supported in vlc version >= 1.1.0) change the text color. val is the new color to use (WHITE=0x000000, BLACK=0xFFFFFF, RED=0xFF0000, GREEN=0x00FF00, BLUE=0x0000FF...).
*'''vlc.video.marquee.opacity''': (supported in vlc version >= 1.1.0) change the text opacity, val is defined from 0 (completely transparent) to 255 (completely opaque).
*'''vlc.video.marquee.position''': (supported in vlc version >= 1.1.0) change the text position (CENTER=0, LEFT=1, RIGHT=2, TOP=4, TOP-LEFT=5, TOP-RIGHT=6, BOTTOM=8, BOTTOM-LEFT=9, BOTTOM_RIGHT=10).
*'''vlc.video.marquee.refresh''': (supported in vlc version >= 1.1.0) change the marquee refresh period.
*'''vlc.video.marquee.size''': (supported in vlc version >= 1.1.0) val define the new size for the text displayed on the screen. If the text is bigger than the screen then the text is not displayed.
*'''vlc.video.marquee.timeout''': (supported in vlc version >= 1.1.0) change the timeout value. val is defined in ms, but 0 value correspond to unlimited.
*'''vlc.video.marquee.x''': (supported in vlc version >= 1.1.0) change text abscissa.
*'''vlc.video.marquee.y''': (supported in vlc version >= 1.1.0) change text ordinate.

methods

*'''vlc.video.marquee.enable()''': (supported in vlc version >= 1.1.0) enable marquee filter.
*'''vlc.video.marquee.disable()''': (supported in vlc version >= 1.1.0) disable marquee filter.

Some problems may happen (option like color or text will not be applied) because of the VLC asynchronous functioning. To avoid it, after enabling marquee, you have to wait a little time before changing an option. But it should be fixed by the new vout implementation.

NOTE: [http://forum.videolan.org/viewtopic.php?f=16&t=89427#p295058]

=== Logo Object ===

readonly properties

*''none''

read/write properties

*'''vlc.video.logo.opacity''': (supported in vlc version >= 1.1.0) change the picture opacity, val is defined from 0 (completely transparent) to 255 (completely opaque).
*'''vlc.video.logo.position''': (supported in vlc version >= 1.1.0) change the text position ("center", "left", "right", "top", "top-left", "top-right", "bottom", "bottom-left", "bottom-right").
*'''vlc.video.logo.delay''': (supported in vlc version >= 1.1.0) display each picture for a duration of 1000 ms (default) before displaying the next picture.
*'''vlc.video.logo.repeat''': (supported in vlc version >= 1.1.0) number of loops for picture animation (-1=continuous, 0=disabled, n=n-times). The default is -1 (continuous).
*'''vlc.video.logo.x''': (supported in vlc version >= 1.1.0) change the x-offset for displaying the picture counting from top-left on the screen.
*'''vlc.video.logo.y''': (supported in vlc version >= 1.1.0) change the y-offset for displaying the picture counting from top-left on the screen.
*'''vlc.video.logo.width''': (supported in vlc version >= 1.1.0) change the picture width.
*'''vlc.video.logo.height''': (supported in vlc version >= 1.1.0) change the picture height.

methods

*'''vlc.video.logo.enable()''': (supported in vlc version >= 1.1.0) enable logo video filter.
*'''vlc.video.logo.disable()''': (supported in vlc version >= 1.1.0) disable logo video filter.
*'''vlc.video.logo.file("file.png")''': (supported in vlc version >= 1.1.0) display my file.png as logo on the screen.

Some problems may happen because of the VLC asynchronous functioning. To avoid it, after enabling logo video filter, you have to wait a little time before changing an option. But it should be fixed by the new vout implementation.

== MediaDescription Object ==

readonly properties

*'''vlc.mediaDescription.title''': (supported in vlc version >= 2.0.2) returns title meta information field.
*'''vlc.mediaDescription.artist''': (supported in vlc version >= 2.0.2) returns artist meta information field.
*'''vlc.mediaDescription.copyright''': (supported in vlc version >= 2.0.2) returns copyright meta information field.
*'''vlc.mediaDescription.album''': (supported in vlc version >= 2.0.2) returns album meta information field.
*'''vlc.mediaDescription.trackNumber''': (supported in vlc version >= 2.0.2) returns trackNumber meta information field.
*'''vlc.mediaDescription.description''': (supported in vlc version >= 2.0.2) returns description meta information field.
*'''vlc.mediaDescription.rating''': (supported in vlc version >= 2.0.2) returns rating meta information field.
*'''vlc.mediaDescription.date''': (supported in vlc version >= 2.0.2) returns date meta information field.
*'''vlc.mediaDescription.setting''': (supported in vlc version >= 2.0.2) returns setting meta information field.
*'''vlc.mediaDescription.URL''': (supported in vlc version >= 2.0.2) returns URL meta information field.
*'''vlc.mediaDescription.language''': (supported in vlc version >= 2.0.2) returns language meta information field.
*'''vlc.mediaDescription.nowPlaying''': (supported in vlc version >= 2.0.2) returns nowPlaying meta information field.
*'''vlc.mediaDescription.publisher''': (supported in vlc version >= 2.0.2) returns publisher meta information field.
*'''vlc.mediaDescription.encodedBy''': (supported in vlc version >= 2.0.2) returns encodedBy meta information field.

*'''vlc.mediaDescription.artworkURL''': (supported in vlc version >= 2.0.2) returns artworkURL meta information field.

*'''vlc.mediaDescription.trackID''': (supported in vlc version >= 2.0.2) returns trackID meta information field.

read/write properties

*''none''

methods

*''none''

== DEPRECATED APIs ==
=== DEPRECATED: Log object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

This object allows accessing VLC main message logging queue. Typically this queue capacity is very small (no nore than 256 entries) and can easily overflow, therefore messages should be read and cleared as often as possible.

readonly properties

*'''vlc.log.messages''': returns the message collection, see [[#Messages_object|Messages object]]

read/write properties

*'''vlc.log.verbosity''': write number [-1,0,1,2,3] for changing the verbosity level of the log messages; messages whose verbosity is higher than set will be not be logged in the queue. The numbers have the following meaning: -1 disable, 0 info, 1 error, 2 warning, 3 debug.

methods

*''none''

=== DEPRECATED: Messages object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

readonly properties

*'''messages.count''': returns number of messages in the log

read/write properties

*''none''

methods

*'''messages.clear()''': clear the current log buffer. It should be called as frequently as possible to not overflow the message queue. Call this method after the log messages of interest are read.
*'''messages.iterator()''': creates and returns an iterator object, used to iterate over the messages in the log. '''Don't clear the log buffer while holding an iterator object.'''

=== DEPRECATED: Messages Iterator object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

readonly properties

*'''iterator.hasNext''': returns a boolean that indicates whether ''vlc.log.messages.next()'' will return the next message.

read/write properties

*''none''

methods

*'''iterator.next()''': returns the next message object in the log, see [[Message object]]

=== DEPRECATED: Message subobject ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

*'''message.severity''': number that indicates the severity of the log message (0 = info, 1 = error, 2 = warning, 3 = debug)
*'''message.name''': name of VLC module that printed the log message (e.g: main, http, directx, etc...)
*'''message.type''': type of VLC module that printed the log message (eg: input, access, vout, sout, etc...)
*'''message.message''': the message text

{{Documentation}}

[[Category:Embedded]]

Documentation:WebPlugin

2013-01-02T10:27:42Z

Etix: Add the newly added pause()

This Documentation speaks about the {{VLC}} Web plugins and how to write pages for it.
{{RightMenu|documentation play howto toc}}

= Introduction: Building Web pages with Video =

The {{VLC}} webplugins are native browser plugins, similar to Flash or Silverlight plugins and allow playback inside the browser of all the videos that {{VLC}} can read.

Additionally to viewing video on all pages, you can build custom pages that will use the advanced features of the plugin, using Javascript functions to control playback or extract information from the plugin.

There are 2 main plugins: one is ActiveX for IE, the other is NPAPI for the other browsers. They feature the same amount of features.

In older versions, those plugins were very crashy. '''We URGE YOU''' to use VLC '''1.2.0''' or newer versions.

=== Browsers support ===
It has been tested with:
* Mozilla Firefox [[Image:Firefox-logo.png|40x40px]]
* Internet Explorer [[Image:20101105053305!Internet Explorer 9.png|40x40px]]
* Safari [[Image:Apple Safari.png|40x40px]]
* Chrome
* Konqueror
* Opera

It has been tested on GNU/Linux, Windows and MacOS.

= Embed tag attributes =

To embed the plugin into a webpage use the following <embed> template:

<nowiki>
<embed type="application/x-vlc-plugin" pluginspage="http://www.videolan.org" />

<object classid="clsid:9BE31822-FDAD-461B-AD51-BE1D1C159921" codebase="http://download.videolan.org/pub/videolan/vlc/last/win32/axvlc.cab"></object>
</nowiki>

=== Required elements ===
These are '''required''' attributes for the <embed> tag:

*'''width''': Specifies the width of the plugin.
*'''height''': Specifies the height of the plugin.
*'''target''', '''mrl''', '''filename''', '''src''': Specifies the source location (URL) of the video to load.

=== Optionnal elements ===
These are additional attributes for the <embed> tag:

*'''autoplay''', '''autostart''': Specifies whether the plugin starts playing on load. Default: ''true''
*'''allowfullscreen''': (available since VLC version 1.2.0) Specifies whether the user can switch into fullscreen mode. Default: ''true''
*'''mute''': Specifies whether the audio volume is initially muted. Default: ''false''
*'''loop''', '''autoloop''': Specifies whether the video loops on end. Default: ''false''
*'''toolbar''': Specifies whether the toolbar is shown by default. Default: ''true''
*'''bgcolor''': Specifies the background color of the video player. Default: ''#000000''

=== Normal DOM elements ===
*'''id''': DOM id
*'''name''': DOM name

= Javascript API description =

The vlc plugin exports several objects that can be accessed for setting and getting information. When used improperly the API's will throw an exception that includes a string that explains what happened. For example when asking for vlc.input.length when there is no playlist item playing.

== VLC objects ==
The vlc plugin knows the following objects:

*'''audio''': Access audio properties.
*'''input''': Access input properties.
*'''playlist''': Access playlist properties.
*'''subtitle''': Access subtitle properties.
*'''video''': Access video properties.
**'''video.marquee''': Access marquee video filter properties.
**'''video.logo''': Access logo video filter properties.
*'''mediaDescription''': Access media info properties (only available in vlc version >= 2.0.2).

The following are deprecated:
*'''log''': Access log properties (only available in vlc version <= 1.0.0-rc1).
*'''messages''': Access to log message properties (only available in vlc version <= 1.0.0-rc1).
*'''iterator''': Access to log iterator properties (only available in vlc version <= 1.0.0-rc1).
*'''message''': Access to log message properties (only available in vlc version <= 1.0.0-rc1).

=== Example ===
The following JavaScript code shows howto get a reference to the vlc plugin. This reference can then be used to access the objects of the vlc plugin.

<html>
<title>VLC Mozilla plugin test page</title>
<body>
<embed type="application/x-vlc-plugin" pluginspage="http://www.videolan.org"
width="640"
height="480"
id="vlc">
</embed>
<script language="Javascript">

</script>
</body>
</html>

== Root object ==

readonly properties

*'''VersionInfo''': returns version information string

read/write properties

*''none''

methods

*'''vlc.versionInfo()''': returns version information string (same as VersionInfo)

*'''vlc.addEventListener(eventname, callback, bubble)''': (only for Mozilla) add a listener for mentioned event name, callback expects a function and bubble influences the order of eventhandling by JS (usually it is set to false).
*'''vlc.removeEventListener(eventname, callback, bubble)''': (only for Mozilla) remove listener for mentioned event name, callback expects a function and bubble influences the order of eventhandling by JS (usually it is set to false).

*'''vlc.attachEvent(eventname, callback)''': (only for ActiveX) add listener for mentioned event name, callback expects a function
*'''vlc.removeEvent(eventname, callback)''': (only for ActiveX) remove listener for mentioned event name, callback expects a function

events

*'''MediaPlayerNothingSpecial''': vlc is in idle state doing nothing but waiting for a command to be issued
*'''MediaPlayerOpening''': vlc is opening an media resource locator (MRL)
*'''MediaPlayerBuffering''': vlc is buffering
*'''MediaPlayerPlaying''': vlc is playing a media
*'''MediaPlayerPaused''': vlc is in paused state
*'''MediaPlayerForward''': vlc is fastforwarding through the media (works only when an input supports forward playback)
*'''MediaPlayerBackward''': vlc is going backwards through the media (works only when an input supports backwards playback)
*'''MediaPlayerEncounteredError''': vlc has encountered an error and is unable to continue
*'''MediaPlayerEndReached''': vlc has reached the end of current playlist
*'''MediaPlayerTimeChanged''': time has changed
*'''MediaPlayerPositionChanged''': media position has changed
*'''MediaPlayerSeekableChanged''': media seekable flag has changed (true means media is seekable, false means it is not)
*'''MediaPlayerPausableChanged''': media pausable flag has changed (true means media is pauseable, false means it is not)

=== Example ===
The following code snippit provides easy functions to register and unregister event callbacks on all supported platforms (currently only Linux mozilla based browsers and windows activeX objects for Internet Explorer).

<SCRIPT language="javascript">


== Audio object ==

readonly properties

*'''vlc.audio.count''': (supported in vlc version >= 1.1.0) returns the number of audio track available.

read/write properties

*'''vlc.audio.mute''': boolean value to mute and unmute the audio.
*'''vlc.audio.volume''': a value between [0-200] which indicates a percentage of the volume.
*'''vlc.audio.track''': (supported in vlc version > 0.8.6) a value between [1-65535] which indicates the audio track to play or that is playing. a value of 0 means the audio is/will be disabled.
*'''vlc.audio.channel''': (supported in vlc version > 0.8.6) integer value between [1-5] that indicates which audio channel mode is used, values can be: "1=stereo", "2=reverse stereo", "3=left", "4=right", "5=dolby". Use vlc.audio.channel to check if setting of the audio channel mode has succeeded.

methods

*'''vlc.audio.toggleMute()''': boolean toggle that mutes and unmutes the audio based upon the previous state.
*'''vlc.audio.description(int i)''': (supported in vlc version >= 1.1.0) give the i-th audio track name. 0 corresponds to disable and 1 to the first audio track.

=== Example ===
Audio Channel:
<SELECT readonly onChange='doAudioChannel(this.value)'>
<OPTION value=1>Stereo</OPTION>
<OPTION value=2>Reverse stereo</OPTION>
<OPTION value=3>Left</OPTION>
<OPTION value=4>Right</OPTION>
<OPTION value=5>Dolby</OPTION>
</SELECT>

<SCRIPT language="javascript">


== Input object ==

readonly properties

*'''vlc.input.length''': length of the input file in number of milliseconds. 0 is returned for 'live' streams or clips whose length cannot be determined by VLC. It returns -1 if no input is playing.
*'''vlc.input.fps''': frames per second returned as a float (typically 60.0, 50.0, 23.976, etc...)
*'''vlc.input.hasVout''': a boolean that returns true when the video is being displayed, it returns false when video is not displayed

read/write properties

*'''vlc.input.position''': normalized position in multimedia stream item given as a float value between [0.0 - 1.0]
*'''vlc.input.time''': the absolute position in time given in milliseconds, this property can be used to seek through the stream


vlc.input.time = <absolute seek>

vlc.input.time = vlc.input.time + <relative seek>

*'''vlc.input.state''': current state of the input chain given as enumeration (IDLE=0, OPENING=1, BUFFERING=2, PLAYING=3, PAUSED=4, STOPPING=5, ENDED=6, ERROR=7). Note: Test for ENDED=6 to catch end of playback. Checking for STOPPING=5 is NOT ENOUGH.
*'''vlc.input.rate''': input speed given as float (1.0 for normal speed, 0.5 for half speed, 2.0 for twice as fast, etc.).

rate > 1  : is fastforward
rate > 0 and rate < 1 : is slow motion
rate < 0  : is rewind

methods

*''none''

== Playlist object ==

readonly properties

*'''vlc.playlist.itemCount''': number that returns the amount of items currently in the playlist ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])
*'''vlc.playlist.isPlaying''': a boolean that returns true if the current playlist item is playing and false when it is not playing
*'''vlc.playlist.items''': return the playlist items collection, see [[#Playlist_items_object|Playlist items]]

read/write properties

*''none''

methods

*'''vlc.playlist.add(mrl)''': add a playlist item as [[MRL]]. The MRL must be given as a string. Returns a number as an item identifier in playlist (this is not a position in playlist).
*'''vlc.playlist.add(mrl,name,options)''': add a playlist item as MRL, with metaname 'name' and options 'options'. options are text arguments which can be provided either as a single string containing space separated values, akin to VLC command line, or as an array of string values. Returns a number as an item identifier in playlist (this is not a position in playlist).

var options = new Array(":aspect-ratio=4:3", "--rtsp-tcp");
var id = vlc.playlist.add("rtsp://servername/item/to/play", "fancy name", options);
vlc.playlist.playItem(id);

*'''vlc.playlist.play()''': start playing the current playlist item
*'''vlc.playlist.playItem(number)''': start playing the item whose identifier is number
*'''vlc.playlist.pause()''': pause the current playlist item
*'''vlc.playlist.togglePause()''': toggle the pause state for the current playlist item
*'''vlc.playlist.stop()''': stop playing the current playlist item
*'''vlc.playlist.next()''': iterate to the next playlist item
*'''vlc.playlist.prev()''': iterate to the previous playlist item
*'''vlc.playlist.clear()''': empty the current playlist, all items will be deleted from the playlist ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])
*'''vlc.playlist.removeItem(number)''': remove the item from playlist whose identifier is number  ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])

=== Playlist items object ===

readonly properties

*'''vlc.playlist.items.count''': number of items currently in the playlist

read/write properties

*''none''

methods

*'''vlc.playlist.items.clear()''': empty the current playlist, all items will be deleted from the playlist. If a movie is playing, it stop. Note that when this method returns, playlist may not have been entirely been cleared as this operation is performed asynchronously; use the ''count'' property to verify/wait until the playlist is empty.
*'''vlc.playlist.items.remove(number)''': remove the item whose identifier is number from playlist. (note: this number isn't the position in the playlist, but the number given by vlc.playlist.add() )

== Subtitle object ==

readonly properties

*'''vlc.subtitle.count''': (supported in vlc version >= 1.1.0) returns the number of subtitle available.

read/write properties

*'''vlc.subtitle.track''': (supported in vlc version >= 1.1.0) get and set the subtitle track to show on the video screen. The property takes an integer as input value [1..65535]. If subtitle track is set to 0, the subtitles will be disabled. If set to a value outside the current subtitle tracks range, then it will return -1 and display an error message.

methods

*'''vlc.subtitle.description(int i)''': (supported in vlc version >= 1.1.0) give the i-th subtitle name. 0 correspond to disable and 1 to the first subtitle.

== Video object ==

readonly properties

*'''vlc.video.width''': returns the horizontal size of the video
*'''vlc.video.height''': returns the vertical size of the video

read/write properties

*'''vlc.video.fullscreen''': when set to true the video will be displayed in fullscreen mode, when set to false the video will be shown inside the video output size. The property takes a boolean as input.
*'''vlc.video.aspectRatio''': get and set the aspect ratio to use in the video screen. The property takes a string as input value. Typical values are: "1:1", "4:3", "16:9", "16:10", "221:100" and "5:4"
*'''vlc.video.subtitle''': (supported in vlc version > 0.8.6a) get and set the subtitle track to show on the video screen. The property takes an integer as input value [1..65535]. If subtitle track is set to 0, the subtitles will be disabled. If set to a value outside the current subtitle tracks range, then it will return -1 and display an error message.
*'''vlc.video.teletext''': (supported in vlc version >= 0.9.0) get and set teletext page to show on the video stream. This will only work if a teletext elementary stream is available in the video stream. The property takes an integer as input value [0..999] for indicating the teletext page to view, setting the value to 0 means hide teletext. On error it will return -1 and display an error message.

methods

*'''vlc.video.toggleFullscreen()''': toggle the fullscreen mode based on the previous setting
*'''vlc.video.toggleTeletext()''': (supported in vlc version >= 0.9.0) toggle the teletext page to overlay transparent or not, based on the previous setting

=== Deinterlace Object ===

readonly properties

*''none''

read/write properties

*''none''

methods

*'''vlc.video.deinterlace.enable("my_mode")''': (supported in vlc version >= 1.1.0) enable deinterlacing with my_mode. You can enable it with "blend", "bob", "discard", "linear", "mean", "x", "yadif" or "yadif2x" mode. Enabling too soon deinterlacing may cause some problems. You have to wait that all variable are available before enabling it.
*'''vlc.video.deinterlace.disable()''': (supported in vlc version >= 1.1.0) disable deinterlacing.

=== Marquee Object ===

readonly properties

*''none''

read/write properties

*'''vlc.video.marquee.text''': (supported in vlc version >= 1.1.0) display my text on the screen.
*'''vlc.video.marquee.color''': (supported in vlc version >= 1.1.0) change the text color. val is the new color to use (WHITE=0x000000, BLACK=0xFFFFFF, RED=0xFF0000, GREEN=0x00FF00, BLUE=0x0000FF...).
*'''vlc.video.marquee.opacity''': (supported in vlc version >= 1.1.0) change the text opacity, val is defined from 0 (completely transparent) to 255 (completely opaque).
*'''vlc.video.marquee.position''': (supported in vlc version >= 1.1.0) change the text position (CENTER=0, LEFT=1, RIGHT=2, TOP=4, TOP-LEFT=5, TOP-RIGHT=6, BOTTOM=8, BOTTOM-LEFT=9, BOTTOM_RIGHT=10).
*'''vlc.video.marquee.refresh''': (supported in vlc version >= 1.1.0) change the marquee refresh period.
*'''vlc.video.marquee.size''': (supported in vlc version >= 1.1.0) val define the new size for the text displayed on the screen. If the text is bigger than the screen then the text is not displayed.
*'''vlc.video.marquee.timeout''': (supported in vlc version >= 1.1.0) change the timeout value. val is defined in ms, but 0 value correspond to unlimited.
*'''vlc.video.marquee.x''': (supported in vlc version >= 1.1.0) change text abscissa.
*'''vlc.video.marquee.y''': (supported in vlc version >= 1.1.0) change text ordinate.

methods

*'''vlc.video.marquee.enable()''': (supported in vlc version >= 1.1.0) enable marquee filter.
*'''vlc.video.marquee.disable()''': (supported in vlc version >= 1.1.0) disable marquee filter.

Some problems may happen (option like color or text will not be applied) because of the VLC asynchronous functioning. To avoid it, after enabling marquee, you have to wait a little time before changing an option. But it should be fixed by the new vout implementation.

NOTE: [http://forum.videolan.org/viewtopic.php?f=16&t=89427#p295058]

=== Logo Object ===

readonly properties

*''none''

read/write properties

*'''vlc.video.logo.opacity''': (supported in vlc version >= 1.1.0) change the picture opacity, val is defined from 0 (completely transparent) to 255 (completely opaque).
*'''vlc.video.logo.position''': (supported in vlc version >= 1.1.0) change the text position ("center", "left", "right", "top", "top-left", "top-right", "bottom", "bottom-left", "bottom-right").
*'''vlc.video.logo.delay''': (supported in vlc version >= 1.1.0) display each picture for a duration of 1000 ms (default) before displaying the next picture.
*'''vlc.video.logo.repeat''': (supported in vlc version >= 1.1.0) number of loops for picture animation (-1=continuous, 0=disabled, n=n-times). The default is -1 (continuous).
*'''vlc.video.logo.x''': (supported in vlc version >= 1.1.0) change the x-offset for displaying the picture counting from top-left on the screen.
*'''vlc.video.logo.y''': (supported in vlc version >= 1.1.0) change the y-offset for displaying the picture counting from top-left on the screen.
*'''vlc.video.logo.width''': (supported in vlc version >= 1.1.0) change the picture width.
*'''vlc.video.logo.height''': (supported in vlc version >= 1.1.0) change the picture height.

methods

*'''vlc.video.logo.enable()''': (supported in vlc version >= 1.1.0) enable logo video filter.
*'''vlc.video.logo.disable()''': (supported in vlc version >= 1.1.0) disable logo video filter.
*'''vlc.video.logo.file("file.png")''': (supported in vlc version >= 1.1.0) display my file.png as logo on the screen.

Some problems may happen because of the VLC asynchronous functioning. To avoid it, after enabling logo video filter, you have to wait a little time before changing an option. But it should be fixed by the new vout implementation.

== MediaDescription Object ==

readonly properties

*'''vlc.mediaDescription.title''': (supported in vlc version >= 2.0.2) returns title meta information field.
*'''vlc.mediaDescription.artist''': (supported in vlc version >= 2.0.2) returns artist meta information field.
*'''vlc.mediaDescription.copyright''': (supported in vlc version >= 2.0.2) returns copyright meta information field.
*'''vlc.mediaDescription.album''': (supported in vlc version >= 2.0.2) returns album meta information field.
*'''vlc.mediaDescription.trackNumber''': (supported in vlc version >= 2.0.2) returns trackNumber meta information field.
*'''vlc.mediaDescription.description''': (supported in vlc version >= 2.0.2) returns description meta information field.
*'''vlc.mediaDescription.rating''': (supported in vlc version >= 2.0.2) returns rating meta information field.
*'''vlc.mediaDescription.date''': (supported in vlc version >= 2.0.2) returns date meta information field.
*'''vlc.mediaDescription.setting''': (supported in vlc version >= 2.0.2) returns setting meta information field.
*'''vlc.mediaDescription.URL''': (supported in vlc version >= 2.0.2) returns URL meta information field.
*'''vlc.mediaDescription.language''': (supported in vlc version >= 2.0.2) returns language meta information field.
*'''vlc.mediaDescription.nowPlaying''': (supported in vlc version >= 2.0.2) returns nowPlaying meta information field.
*'''vlc.mediaDescription.publisher''': (supported in vlc version >= 2.0.2) returns publisher meta information field.
*'''vlc.mediaDescription.encodedBy''': (supported in vlc version >= 2.0.2) returns encodedBy meta information field.

*'''vlc.mediaDescription.artworkURL''': (supported in vlc version >= 2.0.2) returns artworkURL meta information field.

*'''vlc.mediaDescription.trackID''': (supported in vlc version >= 2.0.2) returns trackID meta information field.

read/write properties

*''none''

methods

*''none''

== DEPRECATED APIs ==
=== DEPRECATED: Log object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

This object allows accessing VLC main message logging queue. Typically this queue capacity is very small (no nore than 256 entries) and can easily overflow, therefore messages should be read and cleared as often as possible.

readonly properties

*'''vlc.log.messages''': returns the message collection, see [[#Messages_object|Messages object]]

read/write properties

*'''vlc.log.verbosity''': write number [-1,0,1,2,3] for changing the verbosity level of the log messages; messages whose verbosity is higher than set will be not be logged in the queue. The numbers have the following meaning: -1 disable, 0 info, 1 error, 2 warning, 3 debug.

methods

*''none''

=== DEPRECATED: Messages object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

readonly properties

*'''messages.count''': returns number of messages in the log

read/write properties

*''none''

methods

*'''messages.clear()''': clear the current log buffer. It should be called as frequently as possible to not overflow the message queue. Call this method after the log messages of interest are read.
*'''messages.iterator()''': creates and returns an iterator object, used to iterate over the messages in the log. '''Don't clear the log buffer while holding an iterator object.'''

=== DEPRECATED: Messages Iterator object ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

readonly properties

*'''iterator.hasNext''': returns a boolean that indicates whether ''vlc.log.messages.next()'' will return the next message.

read/write properties

*''none''

methods

*'''iterator.next()''': returns the next message object in the log, see [[Message object]]

=== DEPRECATED: Message subobject ===

:'''CAUTION''': For security concern, VLC 1.0.0-rc1 is the latest (near-to-stable) version in which this object and its children are supported.

*'''message.severity''': number that indicates the severity of the log message (0 = info, 1 = error, 2 = warning, 3 = debug)
*'''message.name''': name of VLC module that printed the log message (e.g: main, http, directx, etc...)
*'''message.type''': type of VLC module that printed the log message (eg: input, access, vout, sout, etc...)
*'''message.message''': the message text

= Build HTML pages that use the plugin (VLC version up to 0.8.5) =

'''WARNING:''' the APIs described in this section are '''deprecated''', do not use. They no longer work on recent VLC version (> 0.8.5), either it being the ActiveX (Internet Explorer)/ Safari or Mozilla based browsers.

The following API description is only valid uptill version 0.8.5 of the mozilla plugin.

Additionally to viewing video on all pages, you can build custom pages that will use the advanced features of the plugin, using Javascript functions to control playback or extract information from the plugin.

The vlc plugin supports the following function calls:

*'''play()''': Start playing media in the plugin.
*'''pause()''': Pause playback.
*'''stop()''': Stop media playback.
*'''fullscreen()''': Switch the video to full screen.
*'''set_volume(vol)''': Set the volume. '''vol''' has to be an int in the 0-200 range.
*'''get_volume()''': Get the current volume setting.
*'''mute()''': Toggle volume muting.
*'''set_int_variable(var_name, value)''':
*'''set_bool_variable(var_name, value)''':
*'''set_str_variable(var_name, value)''':
*'''get_int_variable(var_name)''':
*'''get_bool_variable(var_name)''':
*'''get_str_variable(var_name)''':
*'''clear_playlist()''': Clear the playlist.
*'''add_item(mrl)''': Append an item whose location is given by the [[Media resource locator]] to the playlist.
*'''next()'''
*'''previous()'''
*'''isplaying()''': return true if the plugin is playing something.
*'''get_length()''': Get the media's length in seconds.
*'''get_position()''': Get the current position in the media in percent.
*'''get_time()''': Get the current position in the media in seconds.
*'''seek(seconds,is_relative)''': If is_relative is true, seek relatively to current time, else seek from beginning of the stream. Seek time is specified in seconds.

<br> Here are a few examples of HTML pages that use the Mozilla plugin.

=== Example 1 ===

In this example, the plugin will read an HTTP stream inside the web page. If the user goes fullscreen, he will have to press ''f'' or double-click on the video to go back in normal view.

<html>
<head><title>Demo of VLC mozilla plugin</title></head>

<body>

<h1>Demo of VLC mozilla plugin - Example 1</h1>

<embed type="application/x-vlc-plugin"
name="video1"
autoplay="no" loop="yes" width="400" height="300"
target="http://server.example.org/video1.vob" />
<br />
<a href="javascript:;" onclick='document.video1.play()'>Play video1</a>
<a href="javascript:;" onclick='document.video1.pause()'>Pause video1</a>
<a href="javascript:;" onclick='document.video1.stop()'>Stop video1</a>
<a href="javascript:;" onclick='document.video1.fullscreen()'>Fullscreen</a>

</body>
</html>

=== Example 2 ===

In this example, the plugin will read a multicast UDP/RTP stream in a dedicated video output window.

<html>
<head><title>Demo of VLC mozilla plugin</title></head>

<body>

<h1>Demo of VLC mozilla plugin - Example 2</h1>

<embed type="application/x-vlc-plugin"
name="video2"
autoplay="no" loop="no" hidden="yes"
target="rtp://@239.255.12.42:5004" />
<br />
<a href="javascript:;" onclick='document.video2.play()'>Play video2</a>
<a href="javascript:;" onclick='document.video2.stop()'>Stop video2</a>
<a href="javascript:;" onclick='document.video2.fullscreen()'>Fullscreen</a>

</body>
</html>

{{Documentation}}

[[Category:Embedded]]

User:Etix

2012-12-22T19:08:36Z

Etix: Created page with "My name is Ludovic Fauvet, alias etix. {| |- | Email || etix at videolan org |- | IRC || etix on #videolan (Freenode network) |- | Twitter || [http://twitter.com/etixxx etixxx..."

My name is Ludovic Fauvet, alias etix.
{|
|-
| Email || etix at videolan org
|-
| IRC || etix on #videolan (Freenode network)
|-
| Twitter || [http://twitter.com/etixxx etixxx]
|}

VDD12

2012-09-01T10:59:27Z

Etix: /* Sunday, September 2nd 2012 */

= VideoLAN Dev Days '12 =
'''The Multimedia Conference that frees the cone in you!'''

This is a technical un-conference, please bring laptops, cords, RJ45 cables
and good mood with you.

=== Nota Bene ===
* The hotel is the [http://www.ibishotel.com/gb/hotel-5543-ibis-paris-avenue-d-italie-13eme/index.shtml Ibis] Avenue d'Italie.

* If you expect us to refund your travel, please bring a printed copy of your tickets, one that shows the total cost. If you are not in our reimbursement database, bring a printed IBAN too.

* On saturday and sunday, enter the [http://www.mines-telecom.fr Institut Télécom] by the Régnault entrance.

* There will be a wifi connexion, under the EDUROAM ESSID.

= Schedule =

== Friday, August 31st 2012 ==

{| class="wikitable" width="70%"
|-
! Time !! Place !! Description
|-
| 18h00 || [http://www.ibishotel.com/gb/hotel-5543-ibis-paris-avenue-d-italie-13eme/index.shtml Hotel] || Meeting point in front of the hotel
|-
| 18h30 – 23h59 || [http://www.dernierbar.com/ Dernier bar] || Welcome and meet-up for early attenders. Drinks at Paris' newest geek bar.
|}

This bar is at Chatelet subway Station (RER B from airports, and subway Line 7 from the Hotel of Place d'Italie).
19, avenue Victoria 75001 Paris

== Saturday, September 1st 2012 ==

All the meetings happen in the [http://www.mines-telecom.fr/ Institut Telecom].

=== Morning ===
Salle des thèses B312

{| class="wikitable" width="70%"
|-
! Time !! Description
|-
| 9h30 – 10h00 || Welcome, registration, coffee and croissants
|-
| 10h00 – 10h15 || Welcome, VideoLAN, VLC
|-
| 10h20 – 10h45 || Opus
|-
| 10h45 – 11h15 || Reverse engineering codecs
|-
| 11h15 – 11h30 || '''Coffee Break'''
|-
| 11h30 – 11h45 || WebVTT
|-
| 11h45 – 12h05 || xvp8, x262
|-
| 12h05 – 12h30 || VideoLAN bounties, un-conference
|-
|}

=== Lunch ===

Made by [http://www.noon-restaurant.fr/ Noon]. Served in room E200.

=== UnConference ===

[http://en.wikipedia.org/wiki/Unconference What is an UnConference?]

{| class="wikitable" width="70%"
|-
! Time !! B559 !! B555 !! B551 !! B549 !! B567 !! B312
|-
| 14h00 - 15h00 || VLC technical discussion || libav technical discussion || FFmpeg || || HACKING ROOM || N/A
|-
| 15h00 - 16h00 || VLC technical discussion || libav technical discussion || || || HACKING ROOM || N/A
|-
| 16h00 - 17h00 || ffmpeg vs libav || MacOS X || Android || || HACKING ROOM || N/A
|-
| 17h00 - 18h00 || Chromium / libav || || Android || || HACKING ROOM || N/A
|-
| 18h00 - 19h00 || Licensing || || Android || || HACKING ROOM || N/A
|-
|}

=== Diner ===

Secret Place, starting at 20h00.

== Sunday, September 2nd 2012 ==

{| class="wikitable" width="70%"
|-
! Time !! B559 !! B555 !! B551 !! B549 !! B567 !! B312
|-
| 9h30 - 11h00 || VideoLAN association meeting || FFmtech meeting. || || || HACKING ROOM || N/A
|-
| 11h00 - 12h00 || Videolan cont. || SOC || || || HACKING ROOM || N/A
|-
| 12h00 - 13h00 || Bounties || || || || HACKING ROOM || N/A
|-
|}

'''Lunch:''' ''Pizzas''!

{| class="wikitable" width="70%"
|-
! Time !! B559 !! B555 !! B551 !! B549 !! B567 !! B312
|-
| 14h00 - 15h00 || ARM || || || || HACKING ROOM || N/A
|-
| 15h00 - 16h00 || Captions || Broadcasting || MSVC || || HACKING ROOM || N/A
|-
| 16h00 - 17h00 || Hack || Hack || Hack || Hack || HACKING ROOM || N/A
|-
|}

= Places =

== Le dernier bar avant la fin du monde ==
19, avenue Victoria<br />
75001 Paris<br />
Metro / RER: Chatelet

http://www.dernierbar.com/

== Institut Telecom (Saturday / Sunday) ==
49, rue Vergniaud<br />
75013 Paris

Metro 7: Tolbiac<br />
Metro 6: Corvisart<br />
RER B: Cité Universitaire

From CDG airport, take:<br />
the RER B (Paris by train) to Cité Universitaire<br />
or the RER B (Paris by train) to Chatêlet, then Subway line 7

== Hotel Ibis ==
[http://www.ibishotel.com/gb/hotel-5543-ibis-paris-avenue-d-italie-13eme/index.shtml Hotel IBIS Paris Avenue d'Italie]<br />
15 bis Avenue d'Italie<br />
75013 Paris

VDD12

2012-09-01T10:58:40Z

Etix: /* Sunday, September 2nd 2012 */

= VideoLAN Dev Days '12 =
'''The Multimedia Conference that frees the cone in you!'''

This is a technical un-conference, please bring laptops, cords, RJ45 cables
and good mood with you.

=== Nota Bene ===
* The hotel is the [http://www.ibishotel.com/gb/hotel-5543-ibis-paris-avenue-d-italie-13eme/index.shtml Ibis] Avenue d'Italie.

* If you expect us to refund your travel, please bring a printed copy of your tickets, one that shows the total cost. If you are not in our reimbursement database, bring a printed IBAN too.

* On saturday and sunday, enter the [http://www.mines-telecom.fr Institut Télécom] by the Régnault entrance.

* There will be a wifi connexion, under the EDUROAM ESSID.

= Schedule =

== Friday, August 31st 2012 ==

{| class="wikitable" width="70%"
|-
! Time !! Place !! Description
|-
| 18h00 || [http://www.ibishotel.com/gb/hotel-5543-ibis-paris-avenue-d-italie-13eme/index.shtml Hotel] || Meeting point in front of the hotel
|-
| 18h30 – 23h59 || [http://www.dernierbar.com/ Dernier bar] || Welcome and meet-up for early attenders. Drinks at Paris' newest geek bar.
|}

This bar is at Chatelet subway Station (RER B from airports, and subway Line 7 from the Hotel of Place d'Italie).
19, avenue Victoria 75001 Paris

== Saturday, September 1st 2012 ==

All the meetings happen in the [http://www.mines-telecom.fr/ Institut Telecom].

=== Morning ===
Salle des thèses B312

{| class="wikitable" width="70%"
|-
! Time !! Description
|-
| 9h30 – 10h00 || Welcome, registration, coffee and croissants
|-
| 10h00 – 10h15 || Welcome, VideoLAN, VLC
|-
| 10h20 – 10h45 || Opus
|-
| 10h45 – 11h15 || Reverse engineering codecs
|-
| 11h15 – 11h30 || '''Coffee Break'''
|-
| 11h30 – 11h45 || WebVTT
|-
| 11h45 – 12h05 || xvp8, x262
|-
| 12h05 – 12h30 || VideoLAN bounties, un-conference
|-
|}

=== Lunch ===

Made by [http://www.noon-restaurant.fr/ Noon]. Served in room E200.

=== UnConference ===

[http://en.wikipedia.org/wiki/Unconference What is an UnConference?]

{| class="wikitable" width="70%"
|-
! Time !! B559 !! B555 !! B551 !! B549 !! B567 !! B312
|-
| 14h00 - 15h00 || VLC technical discussion || libav technical discussion || FFmpeg || || HACKING ROOM || N/A
|-
| 15h00 - 16h00 || VLC technical discussion || libav technical discussion || || || HACKING ROOM || N/A
|-
| 16h00 - 17h00 || ffmpeg vs libav || MacOS X || Android || || HACKING ROOM || N/A
|-
| 17h00 - 18h00 || Chromium / libav || || Android || || HACKING ROOM || N/A
|-
| 18h00 - 19h00 || Licensing || || Android || || HACKING ROOM || N/A
|-
|}

=== Diner ===

Secret Place, starting at 20h00.

== Sunday, September 2nd 2012 ==

{| class="wikitable" width="70%"
|-
! Time !! B559 !! B555 !! B551 !! B549 !! B567 !! B312
|-
| 9h30 - 11h00 || VideoLAN association meeting || FFmtech meeting. || || || HACKING ROOM || N/A
|-
| 11h00 - 12h00 || Videolan cont. || SOC || || || ||
|-
| 12h00 - 13h00 || Bounties || || || || ||
|-
|}

'''Lunch:''' ''Pizzas''!

{| class="wikitable" width="70%"
|-
! Time !! B559 !! B555 !! B551 !! B549 !! B567 !! B312
|-
| 14h00 - 15h00 || ARM || || || || ||
|-
| 15h00 - 16h00 || Captions || Broadcasting || MSVC || || ||
|-
| 16h00 - 17h00 || Hack || Hack || Hack || Hack || ||
|-
|}

= Places =

== Le dernier bar avant la fin du monde ==
19, avenue Victoria<br />
75001 Paris<br />
Metro / RER: Chatelet

http://www.dernierbar.com/

== Institut Telecom (Saturday / Sunday) ==
49, rue Vergniaud<br />
75013 Paris

Metro 7: Tolbiac<br />
Metro 6: Corvisart<br />
RER B: Cité Universitaire

From CDG airport, take:<br />
the RER B (Paris by train) to Cité Universitaire<br />
or the RER B (Paris by train) to Chatêlet, then Subway line 7

== Hotel Ibis ==
[http://www.ibishotel.com/gb/hotel-5543-ibis-paris-avenue-d-italie-13eme/index.shtml Hotel IBIS Paris Avenue d'Italie]<br />
15 bis Avenue d'Italie<br />
75013 Paris

VDD12

2012-09-01T10:57:55Z

Etix: /* UnConference */

= VideoLAN Dev Days '12 =
'''The Multimedia Conference that frees the cone in you!'''

This is a technical un-conference, please bring laptops, cords, RJ45 cables
and good mood with you.

=== Nota Bene ===
* The hotel is the [http://www.ibishotel.com/gb/hotel-5543-ibis-paris-avenue-d-italie-13eme/index.shtml Ibis] Avenue d'Italie.

* If you expect us to refund your travel, please bring a printed copy of your tickets, one that shows the total cost. If you are not in our reimbursement database, bring a printed IBAN too.

* On saturday and sunday, enter the [http://www.mines-telecom.fr Institut Télécom] by the Régnault entrance.

* There will be a wifi connexion, under the EDUROAM ESSID.

= Schedule =

== Friday, August 31st 2012 ==

{| class="wikitable" width="70%"
|-
! Time !! Place !! Description
|-
| 18h00 || [http://www.ibishotel.com/gb/hotel-5543-ibis-paris-avenue-d-italie-13eme/index.shtml Hotel] || Meeting point in front of the hotel
|-
| 18h30 – 23h59 || [http://www.dernierbar.com/ Dernier bar] || Welcome and meet-up for early attenders. Drinks at Paris' newest geek bar.
|}

This bar is at Chatelet subway Station (RER B from airports, and subway Line 7 from the Hotel of Place d'Italie).
19, avenue Victoria 75001 Paris

== Saturday, September 1st 2012 ==

All the meetings happen in the [http://www.mines-telecom.fr/ Institut Telecom].

=== Morning ===
Salle des thèses B312

{| class="wikitable" width="70%"
|-
! Time !! Description
|-
| 9h30 – 10h00 || Welcome, registration, coffee and croissants
|-
| 10h00 – 10h15 || Welcome, VideoLAN, VLC
|-
| 10h20 – 10h45 || Opus
|-
| 10h45 – 11h15 || Reverse engineering codecs
|-
| 11h15 – 11h30 || '''Coffee Break'''
|-
| 11h30 – 11h45 || WebVTT
|-
| 11h45 – 12h05 || xvp8, x262
|-
| 12h05 – 12h30 || VideoLAN bounties, un-conference
|-
|}

=== Lunch ===

Made by [http://www.noon-restaurant.fr/ Noon]. Served in room E200.

=== UnConference ===

[http://en.wikipedia.org/wiki/Unconference What is an UnConference?]

{| class="wikitable" width="70%"
|-
! Time !! B559 !! B555 !! B551 !! B549 !! B567 !! B312
|-
| 14h00 - 15h00 || VLC technical discussion || libav technical discussion || FFmpeg || || HACKING ROOM || N/A
|-
| 15h00 - 16h00 || VLC technical discussion || libav technical discussion || || || HACKING ROOM || N/A
|-
| 16h00 - 17h00 || ffmpeg vs libav || MacOS X || Android || || HACKING ROOM || N/A
|-
| 17h00 - 18h00 || Chromium / libav || || Android || || HACKING ROOM || N/A
|-
| 18h00 - 19h00 || Licensing || || Android || || HACKING ROOM || N/A
|-
|}

=== Diner ===

Secret Place, starting at 20h00.

== Sunday, September 2nd 2012 ==

{| class="wikitable" width="70%"
|-
! Time !! B559 !! B555 !! B551 !! B549 !! B567 !! B312
|-
| 9h30 - 11h00 || VideoLAN association meeting || FFmtech meeting. || || || ||
|-
| 11h00 - 12h00 || Videolan cont. || SOC || || || ||
|-
| 12h00 - 13h00 || Bounties || || || || ||
|-
|}

'''Lunch:''' ''Pizzas''!

{| class="wikitable" width="70%"
|-
! Time !! B559 !! B555 !! B551 !! B549 !! B567 !! B312
|-
| 14h00 - 15h00 || ARM || || || || ||
|-
| 15h00 - 16h00 || Captions || Broadcasting || MSVC || || ||
|-
| 16h00 - 17h00 || Hack || Hack || Hack || Hack || ||
|-
|}

= Places =

== Le dernier bar avant la fin du monde ==
19, avenue Victoria<br />
75001 Paris<br />
Metro / RER: Chatelet

http://www.dernierbar.com/

== Institut Telecom (Saturday / Sunday) ==
49, rue Vergniaud<br />
75013 Paris

Metro 7: Tolbiac<br />
Metro 6: Corvisart<br />
RER B: Cité Universitaire

From CDG airport, take:<br />
the RER B (Paris by train) to Cité Universitaire<br />
or the RER B (Paris by train) to Chatêlet, then Subway line 7

== Hotel Ibis ==
[http://www.ibishotel.com/gb/hotel-5543-ibis-paris-avenue-d-italie-13eme/index.shtml Hotel IBIS Paris Avenue d'Italie]<br />
15 bis Avenue d'Italie<br />
75013 Paris

VDD12

2012-09-01T10:57:03Z

Etix: /* Sunday, September 2nd 2012 */

= VideoLAN Dev Days '12 =
'''The Multimedia Conference that frees the cone in you!'''

This is a technical un-conference, please bring laptops, cords, RJ45 cables
and good mood with you.

=== Nota Bene ===
* The hotel is the [http://www.ibishotel.com/gb/hotel-5543-ibis-paris-avenue-d-italie-13eme/index.shtml Ibis] Avenue d'Italie.

* If you expect us to refund your travel, please bring a printed copy of your tickets, one that shows the total cost. If you are not in our reimbursement database, bring a printed IBAN too.

* On saturday and sunday, enter the [http://www.mines-telecom.fr Institut Télécom] by the Régnault entrance.

* There will be a wifi connexion, under the EDUROAM ESSID.

= Schedule =

== Friday, August 31st 2012 ==

{| class="wikitable" width="70%"
|-
! Time !! Place !! Description
|-
| 18h00 || [http://www.ibishotel.com/gb/hotel-5543-ibis-paris-avenue-d-italie-13eme/index.shtml Hotel] || Meeting point in front of the hotel
|-
| 18h30 – 23h59 || [http://www.dernierbar.com/ Dernier bar] || Welcome and meet-up for early attenders. Drinks at Paris' newest geek bar.
|}

This bar is at Chatelet subway Station (RER B from airports, and subway Line 7 from the Hotel of Place d'Italie).
19, avenue Victoria 75001 Paris

== Saturday, September 1st 2012 ==

All the meetings happen in the [http://www.mines-telecom.fr/ Institut Telecom].

=== Morning ===
Salle des thèses B312

{| class="wikitable" width="70%"
|-
! Time !! Description
|-
| 9h30 – 10h00 || Welcome, registration, coffee and croissants
|-
| 10h00 – 10h15 || Welcome, VideoLAN, VLC
|-
| 10h20 – 10h45 || Opus
|-
| 10h45 – 11h15 || Reverse engineering codecs
|-
| 11h15 – 11h30 || '''Coffee Break'''
|-
| 11h30 – 11h45 || WebVTT
|-
| 11h45 – 12h05 || xvp8, x262
|-
| 12h05 – 12h30 || VideoLAN bounties, un-conference
|-
|}

=== Lunch ===

Made by [http://www.noon-restaurant.fr/ Noon]. Served in room E200.

=== UnConference ===

[http://en.wikipedia.org/wiki/Unconference What is an UnConference?]

{| class="wikitable" width="70%"
|-
! Time !! B559 !! B555 !! B551 !! B549 !! B567 !! B312
|-
| 14h00 - 15h00 || VLC technical discussion || libav technical discussion || FFmpeg || || HACKING ROOM ||
|-
| 15h00 - 16h00 || VLC technical discussion || libav technical discussion || || || HACKING ROOM ||
|-
| 16h00 - 17h00 || ffmpeg vs libav || MacOS X || Android || || HACKING ROOM ||
|-
| 17h00 - 18h00 || Chromium / libav || || Android || || HACKING ROOM ||
|-
| 18h00 - 19h00 || Licensing || || Android || || HACKING ROOM ||
|-
|}

=== Diner ===

Secret Place, starting at 20h00.

== Sunday, September 2nd 2012 ==

{| class="wikitable" width="70%"
|-
! Time !! B559 !! B555 !! B551 !! B549 !! B567 !! B312
|-
| 9h30 - 11h00 || VideoLAN association meeting || FFmtech meeting. || || || ||
|-
| 11h00 - 12h00 || Videolan cont. || SOC || || || ||
|-
| 12h00 - 13h00 || Bounties || || || || ||
|-
|}

'''Lunch:''' ''Pizzas''!

{| class="wikitable" width="70%"
|-
! Time !! B559 !! B555 !! B551 !! B549 !! B567 !! B312
|-
| 14h00 - 15h00 || ARM || || || || ||
|-
| 15h00 - 16h00 || Captions || Broadcasting || MSVC || || ||
|-
| 16h00 - 17h00 || Hack || Hack || Hack || Hack || ||
|-
|}

= Places =

== Le dernier bar avant la fin du monde ==
19, avenue Victoria<br />
75001 Paris<br />
Metro / RER: Chatelet

http://www.dernierbar.com/

== Institut Telecom (Saturday / Sunday) ==
49, rue Vergniaud<br />
75013 Paris

Metro 7: Tolbiac<br />
Metro 6: Corvisart<br />
RER B: Cité Universitaire

From CDG airport, take:<br />
the RER B (Paris by train) to Cité Universitaire<br />
or the RER B (Paris by train) to Chatêlet, then Subway line 7

== Hotel Ibis ==
[http://www.ibishotel.com/gb/hotel-5543-ibis-paris-avenue-d-italie-13eme/index.shtml Hotel IBIS Paris Avenue d'Italie]<br />
15 bis Avenue d'Italie<br />
75013 Paris