source: roaraudio/doc/man3/roar_simple_connect.3 @ 5032:b2c8bbc7907f

.\" roar_simple_play.3:

.TH "roar_simple_connect" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio"

.SH NAME
roar_simple_connect, roar_simple_connect2 \- Opens a connection to RoarAudio's sound server

.SH SYNOPSIS

#include <roaraudio.h>

int roar_simple_connect (struct roar_connection * con, char * server, char * name);
int roar_simple_connect2(struct roar_connection * con, char * server, char * name, int flags, uint_least32_t timeout);


.SH "DESCRIPTION"
This calls opens a connection to the RoarAudio's sound server.
To disconnect use \fBroar_disconnect\fR(3).

.SH "PARAMETERS"
.TP
\fBcon\fR
The roar_connection object to be filled on success with all data needed for comunicating with the server.
This is used by nearly all other functions.

.TP
\fBserver\fR
The host or filename of the socket of the server. Should normaly be \fBNULL\fR to try default locations.

.TP
\fBname\fR
The name of this client. Should be the name of the player without any paths or filenames.

.TP
\fBflags\fR
Flags used to connect to the server. Currently only ROAR_ENUM_FLAG_NONE and ROAR_ENUM_FLAG_NONBLOCK are supported.
ROAR_ENUM_FLAG_NONBLOCK disables some of the server location features.

.TP
\fBtimeout\fR
Timeout for the connection. A value of zero means no timeout. Currently timeouts are not supported.

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

.SH "EXAMPLES"
FIXME

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

.\" ll