.\" muroar_beep.3

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

.SH NAME
muroar_beep \- Send notify beep to RoarAudio sound daemon

.SH SYNOPSIS

#include <muroar.h>

int muroar_beep   (muroar_t fh);

.SH "DESCRIPTION"

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

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

.SH 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.

.SH 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.

.SH HISTORY

This function first appeared in muRoar version 0.1rc2.

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

.\" ll