source: roaraudio/doc/man3/roar_stream_add_data.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: 1.1 KB
Line 
1.\" roar_simple_play.3:
2
3.TH "roar_stream_add_data" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio"
4
5.SH NAME
6roar_stream_add_data \- Adds data to a stream's input buffer using the controll connection
7
8.SH SYNOPSIS
9
10#include <roaraudio.h>
11
12int roar_stream_add_data(struct roar_connection * con, struct roar_stream * s, char * data, size_t len);
13
14.SH "DESCRIPTION"
15This adds data to the input buffer of a stream. It's like doing some thing like this:
16
17 write(stream_fh, data, len);
18
19but uses the controll channel to add the data.
20
21
22.SH "PARAMETERS"
23.TP
24\fBcon\fR
25The connection to the server.
26
27.TP
28\fBs\fR
29The stream to add data to it's input buffer.
30
31.TP
32\fBdata\fR
33The data to add to the buffer.
34
35.TP
36\fBlen\fR
37The length of the data to be added.
38
39.SH "RETURN VALUE"
40On success these calls return 0.  On error, \-1 is returned.
41
42.SH "EXAMPLES"
43FIXME
44
45.SH "BUGS"
46This call doesn't work with the current roard. The server does not use all of the buffer size and
47complains about unterruns.
48
49.SH "SEE ALSO"
50\fBwrite\fR(2),
51\fBlibroar\fR(7),
52\fBRoarAudio\fR(7).
53
54.\" ll
Note: See TracBrowser for help on using the repository browser.