* ALL: bumped version number to 0.6.3-cvs
[vlc.git] / modules / control / corba / README
1 $Id: README,v 1.1 2003/07/07 16:59:00 sam Exp $
2 * Module (server) side
3 ** Dependencies
4
5 To compile the CORBA plugin, you need the orbit2 developpement files
6 (for Debian, install the package liborbi2-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
17
18 * Client side
19
20 A sample client application is provided, using python-orbit
21
22 **  Dependencies
23
24 The python client uses the pyorbit library developped by James
25 Henstridge <james at daa dot com dot au> (source:
26 http://ftp.gnome.org/pub/GNOME/sources/pyorbit/1.99/pyorbit-1.99.3.tar.gz).
27
28 To interoperate with gtk, the original pyorbit-1.99.3 needs a patch to
29 implement the bindings to OR_work_pending and ORB_perform_work (see
30 pyorbit-1.99.3.patch)
31
32 The gtk simpleplayer example uses the python-glade module by James
33 Henstridge.
34
35 ** Typelib information
36
37 To simply access the server, you do not need any reference to the IDL
38 (CORBA2.0 provides introspection facilities). However, if you want to
39 use the structures defined in the IDL (Position, Origin, ...), you
40 need to use the IDL information, and compile a dynamic lib
41 (MediaControl.so) from the IDL.
42
43 To build the library, you can use the Makefile :
44
45 make corba-generate-typelib
46
47 which will generate MediaControl.so
48
49 * Interesting pointers 
50
51 - GLib reference manual
52 http://developer.gnome.org/doc/API/glib/
53
54 - IDL quickref :
55 http://www.cs.rpi.edu/~musser/dsc/idl/idl-overview.html
56
57 - Python-Bonobo
58 http://www.pycage.de/howto_bonobo.html
59
60 * How to add the module to the original sources (vlc-0.5.x) :
61 - copy the directory modules/control/corba
62 - add configuration lines relative to corba in configure.ac.in
63 - add a reference to  control/corba/Modules.am in
64   modules/Makefile.am