source: roaraudio/doc/man3/roar_stream_connect.3 @ 5038:9b8c150a0b13

Last change on this file since 5038:9b8c150a0b13 was 5032:b2c8bbc7907f, checked in by phi, 13 years ago

some manpage correction

File size: 844 bytes
Line 
1.\" roar_simple_play.3:
2
3.TH "roar_stream_connect" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio"
4
5.SH NAME
6roar_stream_connect \- Connect a stream to RoarAudio's sound server
7
8.SH SYNOPSIS
9
10#include <roaraudio.h>
11
12int roar_stream_connect(struct roar_connection * con, struct roar_stream * s, int dir);
13
14.SH "DESCRIPTION"
15This connects a new stream as created by \fBroar_stream_new\fR(3) to the server.
16
17
18.SH "PARAMETERS"
19.TP
20\fBcon\fR
21The connection to the sound server
22
23.TP
24\fBs\fR
25The stream object to connect.
26
27.TP
28\fBdir\fR
29The direction of the new stream.
30See \fBroar_simple_stream\fR(3) for details.
31
32.SH "RETURN VALUE"
33On success these calls return 0.  On error, \-1 is returned.
34
35.SH "EXAMPLES"
36FIXME
37
38.SH "SEE ALSO"
39\fBroar_stream_new\fR(3),
40\fBroar_simple_stream\fR(3),
41\fBlibroar\fR(7),
42\fBRoarAudio\fR(7).
43
44.\" ll
Note: See TracBrowser for help on using the repository browser.