Changeset 5032:b2c8bbc7907f in roaraudio for doc/man3/roar_get_vol.3

Timestamp:

05/28/11 17:23:34 (13 years ago)

Author:

phi

Branch:

default

Phase:

public

Message:

some manpage correction

File:

• doc/man3/roar_get_vol.3 (modified) (4 diffs)

doc/man3/roar_get_vol.3

@@ -1 +1 @@
 .\" roar_simple_play.3:
 
-.TH "roar_get_vol" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido"
+.TH "roar_get_vol" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio"
 
 .SH NAME
-roar_get_vol, roar_set_vol \- Set mixer levels or RoarAudio streams
+roar_get_vol, roar_set_vol, roar_set_vol2 \- Set mixer levels or RoarAudio streams
 
 .SH SYNOPSIS
@@ -12 +12 @@
 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);
 
@@ -17 +19 @@
 This call gets or sets the mixing levels for a stream.
 
-\fBNOTE: This call is not marked as forzen, it's interface may change in newer versions!\fR
+roar_set_vol() is marked obsolete and will be removed soon, use roar_set_vol2().
 
 .SH "PARAMETERS"
@@ -28 +30 @@
 The ID of the stream to change.
 
-\fBNOTE:\fR the type of this argument may change in newer versions of the lib!
-
 .TP
 \fBmixer\fR
-FIXME
+The mixer state for the stream.
 
 .TP
 \fBchannels\fR
-FIXME
+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"