Last change
on this file since 2190:3398d76f0298 was
732:b7411845aff5,
checked in by phi, 16 years ago
|
added info for other protocolls on some places, there are sill a lot to update left
|
File size:
1.0 KB
|
Line | |
---|
1 | .\" roar_simple_play.3: |
---|
2 | |
---|
3 | .TH "roar_connect" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido" |
---|
4 | |
---|
5 | .SH NAME |
---|
6 | roar_connect \- connects to RoarAudio's sound server |
---|
7 | |
---|
8 | .SH SYNOPSIS |
---|
9 | |
---|
10 | #include <roaraudio.h> |
---|
11 | |
---|
12 | int roar_connect(struct roar_connection * con, char * server); |
---|
13 | |
---|
14 | .SH "DESCRIPTION" |
---|
15 | Connects to RoarAudio's sound server. |
---|
16 | This call just connects to the sound server without any auth or identify. |
---|
17 | Do not use this from end user applications. Use \fBroar_simple_connect\fR(3). |
---|
18 | |
---|
19 | |
---|
20 | .SH "PARAMETERS" |
---|
21 | .TP |
---|
22 | \fBcon\fR |
---|
23 | The connection object to be filled with the data needed to talk to the server used by nearly all other calls. |
---|
24 | |
---|
25 | .TP |
---|
26 | \fBserver\fR |
---|
27 | The server to connect to. |
---|
28 | This may be in form "host[:port]" (TCP/IP), "/path/to/sock" (UNIX Domain Socket) or any other supported. |
---|
29 | For a full list see \fBroartips\fR(7). |
---|
30 | |
---|
31 | |
---|
32 | .SH "RETURN VALUE" |
---|
33 | On success these calls return 0. On error, -1 is returned. |
---|
34 | |
---|
35 | .SH "EXAMPLES" |
---|
36 | See libroar/simple.c, \fBroar_simple_connect\fR(3). |
---|
37 | |
---|
38 | .SH "SEE ALSO" |
---|
39 | \fBroar_simple_connect\fR(3), |
---|
40 | \fBlibroar\fR(7), |
---|
41 | \fBRoarAudio\fR(7). |
---|
42 | |
---|
43 | .\" ll |
---|
Note: See
TracBrowser
for help on using the repository browser.