Line | |
---|
1 | .\" roar_simple_play.3: |
---|
2 | |
---|
3 | .TH "roar_simple_connect" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" |
---|
4 | |
---|
5 | .SH NAME |
---|
6 | roar_simple_connect, roar_simple_connect2 \- Opens a connection to RoarAudio's sound server |
---|
7 | |
---|
8 | .SH SYNOPSIS |
---|
9 | |
---|
10 | #include <roaraudio.h> |
---|
11 | |
---|
12 | int roar_simple_connect (struct roar_connection * con, char * server, char * name); |
---|
13 | int roar_simple_connect2(struct roar_connection * con, char * server, char * name, int flags, uint_least32_t timeout); |
---|
14 | |
---|
15 | |
---|
16 | .SH "DESCRIPTION" |
---|
17 | This calls opens a connection to the RoarAudio's sound server. |
---|
18 | To disconnect use \fBroar_disconnect\fR(3). |
---|
19 | |
---|
20 | .SH "PARAMETERS" |
---|
21 | .TP |
---|
22 | \fBcon\fR |
---|
23 | The roar_connection object to be filled on success with all data needed for comunicating with the server. |
---|
24 | This is used by nearly all other functions. |
---|
25 | |
---|
26 | .TP |
---|
27 | \fBserver\fR |
---|
28 | The host or filename of the socket of the server. Should normaly be \fBNULL\fR to try default locations. |
---|
29 | |
---|
30 | .TP |
---|
31 | \fBname\fR |
---|
32 | The name of this client. Should be the name of the player without any paths or filenames. |
---|
33 | |
---|
34 | .TP |
---|
35 | \fBflags\fR |
---|
36 | Flags used to connect to the server. Currently only ROAR_ENUM_FLAG_NONE and ROAR_ENUM_FLAG_NONBLOCK are supported. |
---|
37 | ROAR_ENUM_FLAG_NONBLOCK disables some of the server location features. |
---|
38 | |
---|
39 | .TP |
---|
40 | \fBtimeout\fR |
---|
41 | Timeout for the connection. A value of zero means no timeout. Currently timeouts are not supported. |
---|
42 | |
---|
43 | .SH "RETURN VALUE" |
---|
44 | On success these calls return 0. On error, \-1 is returned. |
---|
45 | |
---|
46 | .SH "EXAMPLES" |
---|
47 | FIXME |
---|
48 | |
---|
49 | .SH "SEE ALSO" |
---|
50 | \fBroar_disconnect\fR(3), |
---|
51 | \fBlibroar\fR(7), |
---|
52 | \fBRoarAudio\fR(7). |
---|
53 | |
---|
54 | .\" ll |
---|
Note: See
TracBrowser
for help on using the repository browser.