Line | |
---|
1 | .\" roar_simple_play.3: |
---|
2 | |
---|
3 | .TH "roar_server_oinfo2" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" |
---|
4 | |
---|
5 | .SH NAME |
---|
6 | roar_server_oinfo, roar_server_oinfo2 \- Gets information on the output stream of RoarAudio's sound server |
---|
7 | |
---|
8 | .SH SYNOPSIS |
---|
9 | |
---|
10 | #include <roaraudio.h> |
---|
11 | |
---|
12 | int roar_server_oinfo(struct roar_connection * con, struct roar_stream * s); |
---|
13 | int roar_server_oinfo2(struct roar_connection * con, struct roar_stream * s, int dir); |
---|
14 | |
---|
15 | .SH "DESCRIPTION" |
---|
16 | Gets information about the default mixer stream for the given stream direction. |
---|
17 | This can be used to get optimal parameters for all operations so the server don't need to resample. |
---|
18 | |
---|
19 | roar_server_oinfo() is marked as obsolete and will be removed soon. |
---|
20 | |
---|
21 | .SH "PARAMETERS" |
---|
22 | .TP |
---|
23 | \fBcon\fR |
---|
24 | The connection to the server. |
---|
25 | |
---|
26 | .TP |
---|
27 | \fBs\fR |
---|
28 | A stream object to be filled with information on the output stream. |
---|
29 | |
---|
30 | .TP |
---|
31 | \fBdir\fR |
---|
32 | The stream direction to query mixer data for. |
---|
33 | |
---|
34 | .SH "RETURN VALUE" |
---|
35 | On success these calls return 0. On error, \-1 is returned. |
---|
36 | |
---|
37 | .SH "EXAMPLES" |
---|
38 | FIXME |
---|
39 | |
---|
40 | .SH "SEE ALSO" |
---|
41 | \fBlibroar\fR(7), |
---|
42 | \fBRoarAudio\fR(7). |
---|
43 | |
---|
44 | .\" ll |
---|
Note: See
TracBrowser
for help on using the repository browser.