Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Java framework for the vlc media player

README.md

vlcj

vlcj

The vlcj project provides a Java framework to allow an instance of a native VLC media player to be embedded in a Java AWT Window or Swing JFrame.

You get more than just simple bindings, you also get a higher level framework that hides a lot of the complexities of working with LibVLC.

vlcj is primarily developed and therefore extensively tested on Linux - it does also work just fine on Windows and MacOSX.

At least JDK 1.6 is required, and it works without changes on JDK 1.7+.

This is the open source vlcj project page, see also the 'official' home page where you can find more information as well as some new simple tutorials.

Version 3.0.0+ of vlcj requires version 2.1.0+ of VLC, earlier versions of VLC are not supported and will not work.

Version 3.0.0+ of vlcj requires version 3.5.2 of JNA.

Some features of version 3.0.0+ of vlcj (such as the new audio equalizer API) require version 2.2.0+ of VLC (which has not yet been released).

If you still need to use VLC 2.0.x then you must stay with vlcj 2.x.x instead of upgrading to the new vlcj 3.0.0 series.

Maven Dependency

Add the following Maven dependency to your own project pom.xml:

<dependency>
    <groupId>uk.co.caprica</groupId>
    <artifactId>vlcj</artifactId>
    <version>3.5.0</version>
</dependency>

News

02/03/2015 vlcj-pro released, free time-limited trial packages are available from the official vlcj-pro product page.

01/03/2015 Made new release 3.5.0 at Maven Central, check the github issues milestone for details. Mostly minor changes to support vlcj-pro.

26/02/2015 Made new release 3.4.0 at Maven Central, check the github issues milestone for details.

13/02/2015 Made new release 3.3.0 at Maven Central, use SLF4J API rather than bespoke logger, minor bug fixes.

05/02/2015 New product announcement vlcj-pro, a robust out-of-process media player solution for vlcj.

01/02/2015 Made new release 3.2.0 at Maven Central, New meta data attributes, new codec description API, new audio device enumeration API, new media list player end reached event, minor documentation fixes.

26/11/2014 Made new release 3.1.0 at Maven Central.

10/01/2014 Made new release 3.0.0 at Maven Central, new audio equalizer API, new native full-screen implementation for Windows, some little-used deprecated features removed, minor bugs fixed.

Version 3.0.0+ of vlcj requires version 2.1.0+ of vlc, earlier versions of vlc are not supported and will not work.

Some features provided by vlcj depend on the runtime version of vlc. The most current release of vlcj often tracks the bleeding edge of VLC development, consequently some features provided by vlcj will require a very recent version of VLC and in some cases a pre-release version of VLC may be needed. Where the runtime version of VLC is not new enough, in most cases vlcj attempts to fail-safe.

See also vlcj-info for a small library that can extract information from local media files using the MediaInfo library.

You can also follow @capricasoftware on Twitter for more vlcj news.

Documentation

Some new tutorials are available at the official project page.

The vlcj project page is at github.

Online Javadoc is available:

Examples

There are many examples in the vlcj test sources showing how to use vlcj.

For a more complete example of a feature-rich media player built with vlcj, see vlcj-player.

Support

Development of vlcj is carried out by Caprica Software.

Free support for Open Source and non-commercial projects is generally provided - you can use github issues for this purpose.

Support for commercial projects is provided exclusively on commercial terms - send an email to the following address for more information:

mark [dot] lee [at] capricasoftware [dot] co [dot] uk

License

The vlcj framework is provided under the GPL, version 3 or later.

If you want to consider a commercial license for vlcj that allows you to use and redistribute vlcj without complying with the GPL then send your proposal to:

mark [dot] lee [at] capricasoftware [dot] co [dot] uk

Something went wrong with that request. Please try again.