| Line | |
|---|
| 1 | .\" roar_simple_play.3: |
|---|
| 2 | |
|---|
| 3 | .TH "roar_get_standby" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" |
|---|
| 4 | |
|---|
| 5 | .SH NAME |
|---|
| 6 | roar_get_standby, roar_set_standby \- Get and set RoarAudio's sound servers standby state |
|---|
| 7 | |
|---|
| 8 | .SH SYNOPSIS |
|---|
| 9 | |
|---|
| 10 | #include <roaraudio.h> |
|---|
| 11 | |
|---|
| 12 | int roar_get_standby(struct roar_connection * con); |
|---|
| 13 | |
|---|
| 14 | int roar_set_standby(struct roar_connection * con, int state); |
|---|
| 15 | |
|---|
| 16 | .SH "DESCRIPTION" |
|---|
| 17 | Get or set the standby state of the server. If the server is in standby no audio is played. The audio device may be released depending on configuration. |
|---|
| 18 | |
|---|
| 19 | .SH "PARAMETERS" |
|---|
| 20 | .TP |
|---|
| 21 | \fBcon\fR |
|---|
| 22 | The connection to the server. |
|---|
| 23 | |
|---|
| 24 | .TP |
|---|
| 25 | \fBstate\fR |
|---|
| 26 | The new state. This may be \fBROAR_STANDBY_ACTIVE\fR for standby to be set active or \fBROAR_STANDBY_INACTIVE\fR for normal operating mode. |
|---|
| 27 | |
|---|
| 28 | .SH "RETURN VALUE" |
|---|
| 29 | \fBroar_get_standby\fR returns \fBROAR_STANDBY_ACTIVE\fR, \fBROAR_STANDBY_INACTIVE\fR or \-1 on error. |
|---|
| 30 | \fBroar_set_standby\fR returns on success 0. On error, \-1 is returned. |
|---|
| 31 | |
|---|
| 32 | .SH "EXAMPLES" |
|---|
| 33 | FIXME |
|---|
| 34 | |
|---|
| 35 | .SH "SEE ALSO" |
|---|
| 36 | \fBroar_simple_get_standby\fR(3), |
|---|
| 37 | \fBlibroar\fR(7), |
|---|
| 38 | \fBRoarAudio\fR(7). |
|---|
| 39 | |
|---|
| 40 | .\" ll |
|---|
Note: See
TracBrowser
for help on using the repository browser.
