source: roaraudio/doc/man3/roar_simple_get_standby.3 @ 5038:9b8c150a0b13

Last change on this file since 5038:9b8c150a0b13 was 5032:b2c8bbc7907f, checked in by phi, 13 years ago

some manpage correction

File size: 694 bytes
Line 
1.\" roar_simple_play.3:
2
3.TH "roar_simple_get_standby" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio"
4
5.SH NAME
6roar_simple_get_standby \- Get RoarAudio's standby state
7
8.SH SYNOPSIS
9
10#include <roaraudio.h>
11
12int roar_simple_get_standby(int fh);
13
14.SH "DESCRIPTION"
15Asks the server for it's standby state.
16
17This function is marked obsolete and will be removed soon. Use \fRroar_get_standby\fR(3).
18
19.SH "PARAMETERS"
20.TP
21\fBfh\fR
22FIXME
23
24.SH "RETURN VALUE"
25On success this call return \fBROAR_STANDBY_ACTIVE\fR or \fBROAR_STANDBY_INACTIVE\fR.  On error, \-1 is returned.
26
27.SH "EXAMPLES"
28FIXME
29
30.SH "SEE ALSO"
31\fRroar_get_standby\fR(3),
32\fBlibroar\fR(7),
33\fBRoarAudio\fR(7).
34
35.\" ll
Note: See TracBrowser for help on using the repository browser.