6 |
|
|
7 |
This library provides client API for retrieving information and |
This library provides client API for retrieving information and |
8 |
configuring running LinuxSampler instance according to the LinuxSampler |
configuring running LinuxSampler instance according to the LinuxSampler |
9 |
control protocol as specified in the LSCP protocol specification |
control protocol version 1.0 as specified in the LSCP specification written |
10 |
(http://www.linuxsampler.org/api/draft-linuxsampler-protocol.html) |
by Christian Schoenebeck (http://www.linuxsampler.org/api/lscp-1.0.html). |
|
written by Christian Schoenebeck. |
|
11 |
|
|
12 |
For more information about LinuxSampler visit http://www.linuxsampler.org |
For more information about LinuxSampler visit http://www.linuxsampler.org |
13 |
|
|
14 |
|
|
15 |
|
The Latest Version |
16 |
|
================== |
17 |
|
|
18 |
|
The latest version can be downloaded from |
19 |
|
http://sourceforge.net/projects/jlscp/ |
20 |
|
|
21 |
|
See also: http://www.linuxsampler.org/downloads.html |
22 |
|
|
23 |
|
|
24 |
|
License |
25 |
|
======= |
26 |
|
|
27 |
|
This software is licensed under the terms of |
28 |
|
the GNU General Public License Version 2 (see COPYING file). |
29 |
|
|
30 |
|
|
31 |
Requirements |
Requirements |
32 |
------------ |
============ |
33 |
|
|
34 |
To use jlscp you need java version 1.5.0 or higher. |
To use jlscp you need java version 1.5.0 or higher. |
35 |
|
|
36 |
|
To build the library, the documentation or the examples you need |
37 |
|
JDK version 1.5.0 or higher and the Ant tool (http://ant.apache.org/). |
38 |
|
|
39 |
|
|
40 |
Compilation |
Compilation |
41 |
----------- |
=========== |
42 |
|
|
43 |
To compile the library and place the generated class files in the |
Notice that the package contains both the source and the binary files. |
44 |
lib directory, cd to src directory and use the following command: |
So you can skip this section unless you want to rebuild the library or |
45 |
|
you are using version downloaded from cvs. |
46 |
|
|
47 |
|
To build the library, examples or documentation follow the next steps. |
48 |
|
|
49 |
javac org/linuxsampler/lscp/*.java org/linuxsampler/lscp/event/*.java -d ../lib |
1. Set the JAVA_HOME environment variable to point to your JDK directory. |
50 |
|
If the JDK is installed in /opt/jdk1.5.0 directory, this can be done |
51 |
|
with the following command: |
52 |
|
|
53 |
To create the JAR file, cd to lib directory and use the following command: |
export JAVA_HOME=/opt/jdk1.5.0 |
54 |
|
|
55 |
jar -cf jlscp.jar org |
(Windows users must do something like `set JAVA_HOME=c:\jdk1.5.0') |
56 |
|
|
57 |
|
2. Choose one or more of the following options. |
58 |
|
|
59 |
|
- Building the library (jlscp.jar): `ant build-lib' |
60 |
|
|
61 |
|
- Building the documentation: `ant build-doc' |
62 |
|
|
63 |
|
- Building the examples: `ant build-examples' |
64 |
|
|
65 |
|
- Building all (library, examples, documentation): `ant build-all' |
66 |
|
|
67 |
|
Also you may specify more then one target: `ant build-lib build-examples' |
68 |
|
|
69 |
|
|
70 |
Installation |
Installation |
71 |
------------ |
============ |
72 |
|
|
73 |
To install jlscp as an extension just copy jlscp.jar in the following directory: |
To install jlscp as an extension just copy jlscp.jar in the following directory: |
74 |
|
|
81 |
|
|
82 |
|
|
83 |
Documentation |
Documentation |
84 |
------------- |
============= |
85 |
|
|
86 |
The documentation is located in the doc directory. Also you can look at the |
The documentation is located in the doc directory. Also you can look at the |
87 |
examples directory. |
examples directory. |
88 |
|
|
89 |
|
|
90 |
Running examples |
Running examples |
91 |
---------------- |
================ |
92 |
|
|
93 |
To run the examples cd to examples directory |
To run the examples `cd' to examples/build directory |
94 |
and use one of the following commands: |
and use one of the following commands: |
95 |
|
|
96 |
java -cp /path/to/jlscp/jlscp.jar:. Poll |
java -cp /path/to/jlscp/jlscp.jar:. Poll |
100 |
Notice that on Windows platforms class path entries are separated by |
Notice that on Windows platforms class path entries are separated by |
101 |
semicolons (;) instead of colons (:). |
semicolons (;) instead of colons (:). |
102 |
|
|
103 |
|
Thanks for using jlscp. |
104 |
|
|