Statistics
| Revision:

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

History | View | Annotate | Download (2.1 kB)

1
Installation for vlcj.
2

    
3
0. Manual installation
4

    
5
These instructions describe a manual installation of vlcj. You may choose 
6
instead to use maven to add vlcj to your project.
7

    
8
1. Unpack the distribution archive to a local directory, for example:
9

    
10
    $mkdir -p /home/java/vlcj
11
    $cd /home/java/vlcj
12

    
13
1.1 If using the gzipped package:
14

    
15
    $tar -xzf vlcj-2.2.0-dist.tar.gz
16

    
17
1.2 Or, if using the zipped package:
18

    
19
    $unzip -x vlcj-2.2.0-dist.zip
20

    
21
1.3 A new directory will be created, for example:
22

    
23
    /home/java/vlcj/vlcj-2.2.0
24

    
25
Inside this directory you will find all of the vlcj distribution artifacts and
26
third-party library dependencies:
27

    
28
    jna-3.4.0.jar                   - JNA binary jar file
29
    platform-3.4.0.jar              - JNA platform binary jar file
30
    
31
    vlcj-2.2.0.jar                  - vlcj binary jar file
32
    vlcj-2.2.0-javadoc.jar          - vlcj Javadoc archive
33
    vlcj-2.2.0-sources.jar          - vlcj source code archive
34
    vlcj-2.2.0-tests.jar            - vlcj tests binary jar file
35
    vlcj-2.2.0-test-sources.jar     - vlcj test sources
36

    
37
2. Using with Eclipse or some other IDE
38

    
39
The vlcj binary jar file contains manifest classpath entries to set up the
40
proper run-time classpath automatically. This means you only need add the vlcj
41
binary jar to your project and the dependent jar files will be automatically
42
included.
43

    
44
This will work so long as you keep all of the jar files in the same directory.
45

    
46
This works in Eclipse at least, other IDE's may have different behaviour.
47

    
48
If it does not work automatically, then you will have to add the JNA and JNA
49
platform jars explicitly.
50

    
51
3. Run the test application.
52

    
53
The tests jar file is executable and when executed the "basic" vlcj media player
54
test case will start.
55

    
56
    $java -jar vlcj-2.2.0-tests.jar
57
    
58
The tests jar contains manifest classpath entries to set up the proper run-time
59
classpath automatically.
60

    
61
This will work so long as you keep all of the jar files in the same directory.
62

    
63
4. Sources
64

    
65
The vlcj distribution contains all of the sources for the project (sources for
66
main and test classes are included). You are encouraged to link the sources to
67
your libraries in your IDE.