Rev | Line | |
---|
[159] | 1 | .\" roar_simple_play.3: |
---|
| 2 | |
---|
[5032] | 3 | .TH "roar_connect" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" |
---|
[159] | 4 | |
---|
| 5 | .SH NAME |
---|
[5032] | 6 | roar_connect, roar_connect2 \- connects to RoarAudio's sound server |
---|
[159] | 7 | |
---|
| 8 | .SH SYNOPSIS |
---|
| 9 | |
---|
| 10 | #include <roaraudio.h> |
---|
| 11 | |
---|
| 12 | int roar_connect(struct roar_connection * con, char * server); |
---|
[5032] | 13 | int roar_connect2 (struct roar_connection * con, char * server, int flags, uint_least32_t timeout); |
---|
[159] | 14 | |
---|
| 15 | .SH "DESCRIPTION" |
---|
| 16 | Connects to RoarAudio's sound server. |
---|
[5032] | 17 | This calls just connects to the sound server without any authentication or identify. |
---|
| 18 | Do not use this from end user applications. Use \fBroar_simple_connect\fR(3) or \fBroar_simple_connect2\fR(3). |
---|
[159] | 19 | |
---|
| 20 | |
---|
| 21 | .SH "PARAMETERS" |
---|
| 22 | .TP |
---|
| 23 | \fBcon\fR |
---|
| 24 | The connection object to be filled with the data needed to talk to the server used by nearly all other calls. |
---|
| 25 | |
---|
| 26 | .TP |
---|
| 27 | \fBserver\fR |
---|
| 28 | The server to connect to. |
---|
| 29 | |
---|
[5032] | 30 | .TP |
---|
| 31 | \fBflags\fR |
---|
| 32 | Flags used to connect to the server. Currently only ROAR_ENUM_FLAG_NONE and ROAR_ENUM_FLAG_NONBLOCK are supported. |
---|
| 33 | ROAR_ENUM_FLAG_NONBLOCK disables some of the server location features. |
---|
| 34 | |
---|
| 35 | .TP |
---|
| 36 | \fBtimeout\fR |
---|
| 37 | Timeout for the connection. A value of zero means no timeout. Currently timeouts are not supported. |
---|
[159] | 38 | |
---|
| 39 | .SH "RETURN VALUE" |
---|
[4013] | 40 | On success these calls return 0. On error, \-1 is returned. |
---|
[159] | 41 | |
---|
| 42 | .SH "EXAMPLES" |
---|
| 43 | See libroar/simple.c, \fBroar_simple_connect\fR(3). |
---|
| 44 | |
---|
| 45 | .SH "SEE ALSO" |
---|
| 46 | \fBroar_simple_connect\fR(3), |
---|
| 47 | \fBlibroar\fR(7), |
---|
| 48 | \fBRoarAudio\fR(7). |
---|
| 49 | |
---|
| 50 | .\" ll |
---|
Note: See
TracBrowser
for help on using the repository browser.