source: roaraudio/doc/man3/roar_connect.3 @ 4610:5802dc34dda3

.\" roar_simple_play.3:

.TH "roar_connect" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido"

.SH NAME
roar_connect \- connects to RoarAudio's sound server

.SH SYNOPSIS

#include <roaraudio.h>

int roar_connect(struct roar_connection * con, char * server);

.SH "DESCRIPTION"
Connects to RoarAudio's sound server.
This call just connects to the sound server without any auth or identify.
Do not use this from end user applications. Use \fBroar_simple_connect\fR(3).


.SH "PARAMETERS"
.TP
\fBcon\fR
The connection object to be filled with the data needed to talk to the server used by nearly all other calls.

.TP
\fBserver\fR
The server to connect to.
This may be in form "host[:port]" (TCP/IP), "/path/to/sock" (UNIX Domain Socket) or any other supported.
For a full list see \fBroartips\fR(7).


.SH "RETURN VALUE"
On success these calls return 0.  On error, \-1 is returned.

.SH "EXAMPLES"
See libroar/simple.c, \fBroar_simple_connect\fR(3).

.SH "SEE ALSO"
\fBroar_simple_connect\fR(3),
\fBlibroar\fR(7),
\fBRoarAudio\fR(7).

.\" ll