Changeset 156:a81643c087d9 in roaraudio

Timestamp:

07/19/08 21:55:11 (16 years ago)

Author:

phi

Branch:

default

Phase:

public

Message:

a bit more complete

File:

• doc/man3/roar_simple_play.3 (modified) (3 diffs)

doc/man3/roar_simple_play.3

@@ -20 +20 @@
 .SH "DESCRIPTION"
 Open a connection to the \fBroard\fR(1) and creates a new stream for playback, monetoring, recording or filtering.
+After you are done you need to close the connection via \fBroar_simple_close\fR(3).
+In case you just don't do anything with the stream the server will kick your connection, or, in case of playback
+warns the user avout underruns.
 
 .SH "PARAMETERS"
@@ -51 +54 @@
 If \fBNULL\fR an internal default is used.
 
+.SH "NOTES ON FILTER STREAMS"
+Filtering streams should not expected to work with diffrent audio data than the server works with.
+You should get the values via \fBroar_server_oinfo\fR(3) before opening the stream.
+
 .SH "RETURN VALUE"
 On success these calls return a filehandle for the stream.  On error, -1 is returned.
@@ -61 +68 @@
 .SH "SEE ALSO"
 \fBroarcat\fR(1), \fBroarmon\fR(1), \fBroarrec\fR(1), \fBroarfilt\fR(1),
+\fBroar_server_oinfo\fR(3),
+\fBroar_simple_close\fR(3),
 \fBlibroar\fR(7),
 \fBRoarAudio\fR(7).