muroar_read(3) [debian man page]

muroar_read(3)					     muRoar Programmer's Manual: IO Extension					    muroar_read(3)

NAME

       muroar_read - Read data from a stream in a portable way

SYNOPSIS

       #include <muroar.h>

       ssize_t muroar_read   (muroar_t fh,  void * buf, size_t len);

DESCRIPTION

       This  function  reads  data from a stream connected to a sound server.  It exists to have a portable way to read data from the sound server
       that does not depend on the underlying operating system.

PARAMETERS

       fh     The stream file handle connected to the server.  This must be opend using muroar_stream(3).

       buf    A pointer to the block of data that should be read.

       len    The total length in byte of the data that should be read.

RETURN VALUE

       On success this call return the number of bytes successful read.  On error, -1 is returned.

NOTES

       This function calls the underlying read function in a loop.  If this returns less than the given length you should not re-try directly  but
       wait at least some milisecunds.

HISTORY

       This function first appeared in muRoar version 0.1beta0.

SEE ALSO

       read(2), muroar_write(3), muroar_stream(3), muroar_close(3), RoarAudio(7).

muRoar								    April 2012							    muroar_read(3)

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

NAME

       muroar_beep - Send notify beep to RoarAudio sound daemon

SYNOPSIS

       #include <muroar.h>

       int muroar_beep	 (muroar_t fh);

DESCRIPTION

       This  function  sends  a  notify  beep  to the sound daemon fh is connected to.	fh need to be connected using muroar_connect(3) to a sound
       server supporting the RoarAudio protocol and the BEEP command.

RETURN VALUE

       On success this call return 0. On error, -1 is returned.

NOTES

       The beep is canceld at the server side as soon as the connection is closed. This means that you should not close the connection before  the
       beep is played completely.

BUGS

       This  commands  requests  the server for a default beep. No other kind of beep can be send.  There is in addition no way to tell the actual
       length of the beep.  The application should at least wait a bit more than 512ms before closing the socket.  In case possible it is good	to
       wait a minimum of about one secound to be really sure the beep ended.

HISTORY

       This function first appeared in muRoar version 0.1rc2.

SEE ALSO

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

muRoar								    April 2012							    muroar_beep(3)