[159] | 1 | .\" roar_simple_play.3: |
---|
| 2 | |
---|
| 3 | .TH "roar_simple_new_stream" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido" |
---|
| 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" |
---|
[4012] | 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 |
---|
[159] | 19 | some meta data or the volume to be updated after the stream is open. |
---|
| 20 | |
---|
| 21 | |
---|
| 22 | .SH "PARAMETERS" |
---|
| 23 | .TP |
---|
| 24 | \fBcon\fR |
---|
| 25 | The "parent" connection. This is a valid open controll connection as opend via \fBroar_simple_connect\fR(3). |
---|
| 26 | |
---|
| 27 | .TP |
---|
| 28 | \fBs\fR |
---|
[4012] | 29 | The stream object to be updated to corresponde to the new stream. This is useful if use want to update some meta data |
---|
[159] | 30 | after the stream has be opened as you can use all controll commands on this object. |
---|
| 31 | |
---|
| 32 | .TP |
---|
| 33 | \fBrate, channels, bits, codec\fR |
---|
| 34 | For an explanation on these parameters see \fBroar_simple_play\fR(3). |
---|
| 35 | |
---|
| 36 | .TP |
---|
| 37 | \fBdir\fR |
---|
| 38 | For an explanation on this parameter see \fBroar_simple_stream\fR(3). |
---|
| 39 | |
---|
| 40 | .SH "RETURN VALUE" |
---|
[4013] | 41 | On success these calls return a new filehandle. On error, \-1 is returned. |
---|
[159] | 42 | |
---|
| 43 | .SH "EXAMPLES" |
---|
| 44 | An example of the use of \fBroar_simple_new_stream_obj()\fR can be found on \fBroarvorbis\fR(1) code. |
---|
| 45 | |
---|
| 46 | .SH "SEE ALSO" |
---|
| 47 | \fBroar_simple_connect\fR(3), |
---|
| 48 | \fBroar_simple_play\fR(3), |
---|
| 49 | \fBroar_simple_close\fR(3), |
---|
| 50 | \fBlibroar\fR(7), |
---|
| 51 | \fBRoarAudio\fR(7). |
---|
| 52 | |
---|
| 53 | .\" ll |
---|