Statistics
| Revision:

root / tmp / org.txm.backtomedia.rcp / vlcj-2.4.1 / doc / INSTALL @ 1120

History | View | Annotate | Download (2.1 kB)

1 456 mdecorde
Installation for vlcj.
2 456 mdecorde
3 456 mdecorde
0. Manual installation
4 456 mdecorde
5 456 mdecorde
These instructions describe a manual installation of vlcj. You may choose
6 456 mdecorde
instead to use maven to add vlcj to your project.
7 456 mdecorde
8 456 mdecorde
1. Unpack the distribution archive to a local directory, for example:
9 456 mdecorde
10 456 mdecorde
    $mkdir -p /home/java/vlcj
11 456 mdecorde
    $cd /home/java/vlcj
12 456 mdecorde
13 456 mdecorde
1.1 If using the gzipped package:
14 456 mdecorde
15 456 mdecorde
    $tar -xzf vlcj-2.2.0-dist.tar.gz
16 456 mdecorde
17 456 mdecorde
1.2 Or, if using the zipped package:
18 456 mdecorde
19 456 mdecorde
    $unzip -x vlcj-2.2.0-dist.zip
20 456 mdecorde
21 456 mdecorde
1.3 A new directory will be created, for example:
22 456 mdecorde
23 456 mdecorde
    /home/java/vlcj/vlcj-2.2.0
24 456 mdecorde
25 456 mdecorde
Inside this directory you will find all of the vlcj distribution artifacts and
26 456 mdecorde
third-party library dependencies:
27 456 mdecorde
28 456 mdecorde
    jna-3.4.0.jar                   - JNA binary jar file
29 456 mdecorde
    platform-3.4.0.jar              - JNA platform binary jar file
30 456 mdecorde
31 456 mdecorde
    vlcj-2.2.0.jar                  - vlcj binary jar file
32 456 mdecorde
    vlcj-2.2.0-javadoc.jar          - vlcj Javadoc archive
33 456 mdecorde
    vlcj-2.2.0-sources.jar          - vlcj source code archive
34 456 mdecorde
    vlcj-2.2.0-tests.jar            - vlcj tests binary jar file
35 456 mdecorde
    vlcj-2.2.0-test-sources.jar     - vlcj test sources
36 456 mdecorde
37 456 mdecorde
2. Using with Eclipse or some other IDE
38 456 mdecorde
39 456 mdecorde
The vlcj binary jar file contains manifest classpath entries to set up the
40 456 mdecorde
proper run-time classpath automatically. This means you only need add the vlcj
41 456 mdecorde
binary jar to your project and the dependent jar files will be automatically
42 456 mdecorde
included.
43 456 mdecorde
44 456 mdecorde
This will work so long as you keep all of the jar files in the same directory.
45 456 mdecorde
46 456 mdecorde
This works in Eclipse at least, other IDE's may have different behaviour.
47 456 mdecorde
48 456 mdecorde
If it does not work automatically, then you will have to add the JNA and JNA
49 456 mdecorde
platform jars explicitly.
50 456 mdecorde
51 456 mdecorde
3. Run the test application.
52 456 mdecorde
53 456 mdecorde
The tests jar file is executable and when executed the "basic" vlcj media player
54 456 mdecorde
test case will start.
55 456 mdecorde
56 456 mdecorde
    $java -jar vlcj-2.2.0-tests.jar
57 456 mdecorde
58 456 mdecorde
The tests jar contains manifest classpath entries to set up the proper run-time
59 456 mdecorde
classpath automatically.
60 456 mdecorde
61 456 mdecorde
This will work so long as you keep all of the jar files in the same directory.
62 456 mdecorde
63 456 mdecorde
4. Sources
64 456 mdecorde
65 456 mdecorde
The vlcj distribution contains all of the sources for the project (sources for
66 456 mdecorde
main and test classes are included). You are encouraged to link the sources to
67 456 mdecorde
your libraries in your IDE.