.\" muroar_beep.3

.TH "muroar_connect" "3" "April 2012" "muRoar" "muRoar Programmer's Manual"

.SH NAME
muroar_connect \- Opens a connection to a RoarAudio sound daemon

.SH SYNOPSIS

#include <muroar.h>

muroar_t muroar_connect(const char * server, const char * name);

.SH "DESCRIPTION"

This function opens a connection to sound server supporting the RoarAudio protocol.

.SH "PARAMETERS"
.TP
\fBserver\fR
The address of the server to connect to.
May be set to NULL to connect to the default server.

.TP
\fBname\fB
The name for the application.
Should be set to some a string the user will recognize.
For example use "OpenOffice Impress" not "soffice.bin" (process name).
This can be set to NULL to use a generaic default string. However it is
strongly recommended to set this to some useful string.

.SH "RETURN VALUE"
On success this call returns a file handle to a open connection.
On error, MUROAR_HANDLE_INVALID is returned.

.SH BUGS
This function does currently not support DECnet (UNIX Sockets and IPv4 is supported).

.SH HISTORY

This function first appeared in muRoar version 0.1beta0.

.SH "SEE ALSO"
\fBmuroar_connect\fR(3),
\fBmuroar_quit\fR(3),
\fBRoarAudio\fR(7).

.\" ll