1 | .\" roar_simple_play.3: |
---|
2 | |
---|
3 | .TH "roar_simple_new_stream" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" |
---|
4 | |
---|
5 | .SH NAME |
---|
6 | roar_simple_new_stream, roar_simple_new_stream_obj \- Create a new stream via RoarAudio |
---|
7 | |
---|
8 | .SH SYNOPSIS |
---|
9 | |
---|
10 | #include <roaraudio.h> |
---|
11 | |
---|
12 | int roar_simple_new_stream(struct roar_connection * con, int rate, int channels, int bits, int codec, int dir); |
---|
13 | |
---|
14 | int roar_simple_new_stream_obj(struct roar_connection * con, struct roar_stream * s, int rate, int channels, int bits, int |
---|
15 | codec, int dir); |
---|
16 | |
---|
17 | .SH "DESCRIPTION" |
---|
18 | Opens a new stream to the sound server as a independet file handle (not an execed one). This is useful if you still want |
---|
19 | some meta data or the volume to be updated after the stream is open. |
---|
20 | |
---|
21 | This functions are marked obsolete and will be removed in later releases. |
---|
22 | Please upgrade to VS API. See \fBroar_vs_new_simple\fR(3). |
---|
23 | |
---|
24 | .SH "PARAMETERS" |
---|
25 | .TP |
---|
26 | \fBcon\fR |
---|
27 | The "parent" connection. This is a valid open control connection as opend via \fBroar_simple_connect\fR(3). |
---|
28 | |
---|
29 | .TP |
---|
30 | \fBs\fR |
---|
31 | The stream object to be updated to corresponde to the new stream. This is useful if use want to update some meta data |
---|
32 | after the stream has be opened as you can use all controll commands on this object. |
---|
33 | |
---|
34 | .TP |
---|
35 | \fBrate, channels, bits, codec\fR |
---|
36 | For an explanation on these parameters see \fBroar_simple_play\fR(3). |
---|
37 | |
---|
38 | .TP |
---|
39 | \fBdir\fR |
---|
40 | For an explanation on this parameter see \fBroar_simple_stream\fR(3). |
---|
41 | |
---|
42 | .SH "RETURN VALUE" |
---|
43 | On success these calls return a new filehandle. On error, \-1 is returned. |
---|
44 | |
---|
45 | .SH "EXAMPLES" |
---|
46 | An example of the use of \fBroar_simple_new_stream_obj()\fR can be found on \fBroarvorbis\fR(1) code. |
---|
47 | |
---|
48 | .SH "SEE ALSO" |
---|
49 | \fBroar_vs_new_simple\fR(3), |
---|
50 | \fBroar_simple_connect\fR(3), |
---|
51 | \fBroar_simple_play\fR(3), |
---|
52 | \fBroar_simple_close\fR(3), |
---|
53 | \fBlibroar\fR(7), |
---|
54 | \fBRoarAudio\fR(7). |
---|
55 | |
---|
56 | .\" ll |
---|