debian man page for muroar_connect

muroar_connect(3)					    muRoar Programmer's Manual						 muroar_connect(3)

NAME
       muroar_connect - Opens a connection to a RoarAudio sound daemon

SYNOPSIS
       #include <muroar.h>

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

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

PARAMETERS
       server The address of the server to connect to.	May be set to NULL to connect to the default server.

       name   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 recommented  to  set
	      this to some useful string.

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

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

HISTORY
       This function first appeared in muRoar version 0.1beta0.

SEE ALSO
       muroar_connect(3), muroar_quit(3), RoarAudio(7).

muRoar								    April 2012							 muroar_connect(3)