source: roaraudio/doc/man3/roar_get_vol.3 @ 4013:abd38c189de7

Last change on this file since 4013:abd38c189de7 was 4013:abd38c189de7, checked in by phi, 14 years ago

some manpage fixes

File size: 1023 bytes
Line 
1.\" roar_simple_play.3:
2
3.TH "roar_get_vol" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido"
4
5.SH NAME
6roar_get_vol, roar_set_vol \- Set mixer levels or RoarAudio streams
7
8.SH SYNOPSIS
9
10#include <roaraudio.h>
11
12int roar_set_vol(struct roar_connection * con, int id, struct roar_mixer_settings * mixer, int   channels);
13
14int roar_get_vol(struct roar_connection * con, int id, struct roar_mixer_settings * mixer, int * channels);
15
16.SH "DESCRIPTION"
17This call gets or sets the mixing levels for a stream.
18
19\fBNOTE: This call is not marked as forzen, it's interface may change in newer versions!\fR
20
21.SH "PARAMETERS"
22.TP
23\fBcon\fR
24The connection to the roar audio server.
25
26.TP
27\fBid\fR
28The ID of the stream to change.
29
30\fBNOTE:\fR the type of this argument may change in newer versions of the lib!
31
32.TP
33\fBmixer\fR
34FIXME
35
36.TP
37\fBchannels\fR
38FIXME
39
40.SH "RETURN VALUE"
41On success these calls return 0.  On error, \-1 is returned.
42
43.SH "EXAMPLES"
44FIXME
45
46.SH "SEE ALSO"
47\fBlibroar\fR(7),
48\fBRoarAudio\fR(7).
49
50.\" ll
Note: See TracBrowser for help on using the repository browser.