Changeset 5032:b2c8bbc7907f in roaraudio for doc/man3/roar_server_oinfo.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_server_oinfo.3 (modified) (4 diffs)

doc/man3/roar_server_oinfo.3

@@ -1 +1 @@
 .\" roar_simple_play.3:
 
-.TH "roar_server_oinfo" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido"
+.TH "roar_server_oinfo2" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio"
 
 .SH NAME
-roar_server_oinfo \- Gets information on the output stream of RoarAudio's sound server
+roar_server_oinfo, roar_server_oinfo2 \- Gets information on the output stream of RoarAudio's sound server
 
 .SH SYNOPSIS
@@ -11 +11 @@
 
 int roar_server_oinfo(struct roar_connection * con, struct roar_stream * s);
+int roar_server_oinfo2(struct roar_connection * con, struct roar_stream * s, int dir);
 
 .SH "DESCRIPTION"
-Gets information on the output stream of the sound server. The output stream is the stream it sends
-to the soundcard. This can be used to get optimal parameters for all operations so the server don't need to resample.
+Gets information about the default mixer stream for the given stream direction.
+This can be used to get optimal parameters for all operations so the server don't need to resample.
+
+roar_server_oinfo() is marked as obsolete and will be removed soon.
 
 .SH "PARAMETERS"
@@ -25 +28 @@
 A stream object to be filled with information on the output stream.
 
+.TP
+\fBdir\fR
+The stream direction to query mixer data for.
+
 .SH "RETURN VALUE"
 On success these calls return 0.  On error, \-1 is returned.
@@ -32 +39 @@
 
 .SH "SEE ALSO"
-\fBroar_simple_filter\fR(3),
-\fBroar_simple_monitor\fR(3),
 \fBlibroar\fR(7),
 \fBRoarAudio\fR(7).