doc update
[speexdsp.git] / speexclient / README
1 This is a VERY SIMPLE Speex VoIP client. It is not a complete VoIP application,
2 isn't compatible with anything else (including probably future versions of 
3 itself) and does not support any form of standard protocols. It is intended
4 only as a way to show how to use Speex in a VoIP application.
5
6 To use it:
7
8 On Alices machine:
9 % speexclient plughw:0,0 bob.somewhere.net alice_port bob_port
10
11 On Bob's machine:
12 % speexclient plughw:0,0 alice.somewhere.net bob_port alice_port
13
14 where bob_port is the UDP port on which bob receives and alice_port is the
15 UDP port on which alice receives. In most cases, the two ports can be the same.
16
17 Note that the clients do not even know whether they are connected or not. All
18 they do is send/receive the audio to/from a specific port.