source: roaraudio/doc/man3/roar_get_vol.3 @ 5878:3b92b0d6ef9b

.\" roar_simple_play.3:

.TH "roar_get_vol" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio"

.SH NAME
roar_get_vol, roar_set_vol, roar_set_vol2 \- Set mixer levels or RoarAudio streams

.SH SYNOPSIS

#include <roaraudio.h>

int roar_set_vol(struct roar_connection * con, int id, struct roar_mixer_settings * mixer, int   channels);

int roar_set_vol2     (struct roar_connection * con, int id, struct roar_mixer_settings * mixer, int   channels, int mode);

int roar_get_vol(struct roar_connection * con, int id, struct roar_mixer_settings * mixer, int * channels);

.SH "DESCRIPTION"
This call gets or sets the mixing levels for a stream.

roar_set_vol() is marked obsolete and will be removed soon, use roar_set_vol2().

.SH "PARAMETERS"
.TP
\fBcon\fR
The connection to the roar audio server.

.TP
\fBid\fR
The ID of the stream to change.

.TP
\fBmixer\fR
The mixer state for the stream.

.TP
\fBchannels\fR
The number of channels to set mixer data for or the number of channels mixer data is returned.

.TP
\fBmode\fR
The mode of operating. Currently the following modes are supported:
ROAR_SET_VOL_ALL, ROAR_SET_VOL_MS, ROAR_SET_VOL_UNMAPPED.

.SH "RETURN VALUE"
On success these calls return 0.  On error, \-1 is returned.

.SH "EXAMPLES"
FIXME

.SH "SEE ALSO"
\fBlibroar\fR(7),
\fBRoarAudio\fR(7).

.\" ll