Rev | Line | |
---|
[159] | 1 | .\" roar_simple_play.3: |
---|
| 2 | |
---|
[5032] | 3 | .TH "roar_get_vol" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" |
---|
[159] | 4 | |
---|
| 5 | .SH NAME |
---|
[5032] | 6 | roar_get_vol, roar_set_vol, roar_set_vol2 \- Set mixer levels or RoarAudio streams |
---|
[159] | 7 | |
---|
| 8 | .SH SYNOPSIS |
---|
| 9 | |
---|
| 10 | #include <roaraudio.h> |
---|
| 11 | |
---|
| 12 | int roar_set_vol(struct roar_connection * con, int id, struct roar_mixer_settings * mixer, int channels); |
---|
| 13 | |
---|
[5032] | 14 | int roar_set_vol2 (struct roar_connection * con, int id, struct roar_mixer_settings * mixer, int channels, int mode); |
---|
| 15 | |
---|
[159] | 16 | int roar_get_vol(struct roar_connection * con, int id, struct roar_mixer_settings * mixer, int * channels); |
---|
| 17 | |
---|
| 18 | .SH "DESCRIPTION" |
---|
| 19 | This call gets or sets the mixing levels for a stream. |
---|
| 20 | |
---|
[5032] | 21 | roar_set_vol() is marked obsolete and will be removed soon, use roar_set_vol2(). |
---|
[159] | 22 | |
---|
| 23 | .SH "PARAMETERS" |
---|
| 24 | .TP |
---|
| 25 | \fBcon\fR |
---|
| 26 | The connection to the roar audio server. |
---|
| 27 | |
---|
| 28 | .TP |
---|
| 29 | \fBid\fR |
---|
| 30 | The ID of the stream to change. |
---|
| 31 | |
---|
| 32 | .TP |
---|
| 33 | \fBmixer\fR |
---|
[5032] | 34 | The mixer state for the stream. |
---|
[159] | 35 | |
---|
| 36 | .TP |
---|
| 37 | \fBchannels\fR |
---|
[5032] | 38 | The number of channels to set mixer data for or the number of channels mixer data is returned. |
---|
| 39 | |
---|
| 40 | .TP |
---|
| 41 | \fBmode\fR |
---|
| 42 | The mode of operating. Currently the following modes are supported: |
---|
| 43 | ROAR_SET_VOL_ALL, ROAR_SET_VOL_MS, ROAR_SET_VOL_UNMAPPED. |
---|
[159] | 44 | |
---|
| 45 | .SH "RETURN VALUE" |
---|
[4013] | 46 | On success these calls return 0. On error, \-1 is returned. |
---|
[159] | 47 | |
---|
| 48 | .SH "EXAMPLES" |
---|
| 49 | FIXME |
---|
| 50 | |
---|
| 51 | .SH "SEE ALSO" |
---|
| 52 | \fBlibroar\fR(7), |
---|
| 53 | \fBRoarAudio\fR(7). |
---|
| 54 | |
---|
| 55 | .\" ll |
---|
Note: See
TracBrowser
for help on using the repository browser.