Fix a bunch of warnings and errors
[vlc.git] / modules / control / corba / README
1 * Corba module (server) side
2
3 ** Dependencies
4
5 To compile the CORBA plugin, you need the orbit2 developpement files
6 (for Debian, install the package liborbit2-dev)
7
8 ** How to run it ?
9
10 You run the CORBA module  with the following command line :
11
12 vlc --intf corba
13
14 The CORBA module is initialized and saves its IOR into the file
15 /tmp/vlc-ior.ref
16 (it will soon move to $HOME/.vlc-ior.ref)
17
18 ** Code architecture
19
20 The binding between VLC and the MediaControl API (at C-level) is done
21 through the mediacontrol-core.c file. This file implements an
22 object-oriented layer API accessible in C. 
23
24 The corba.c itself only translates calls from CORBA to this C API,
25 which makes the code clearer overall. Moreover, the same
26 mediacontrol-core.c file is used by the vlc-python module to implement the
27 same API.
28
29 * Client side
30
31 A sample client code can be found at http://liris.cnrs.fr/advene/
32
33 **  Dependencies
34
35 The python client uses the pyorbit library developped by James
36 Henstridge <james@daa.com.au> 
37
38 ** Typelib information
39
40 To simply access the server, you do not need any reference to the IDL
41 (CORBA2.0 provides introspection facilities). However, if you want to
42 use the structures defined in the IDL (Position, Origin, ...), you
43 need to use the IDL information, and compile a dynamic lib
44 (MediaControl.so) from the IDL.
45
46 * Interesting pointers 
47
48 - GLib reference manual
49 http://developer.gnome.org/doc/API/glib/
50
51 - IDL quickref :
52 http://www.cs.rpi.edu/~musser/dsc/idl/idl-overview.html
53