| Line | |
|---|
| 1 | .\" roar_simple_play.3: |
|---|
| 2 | |
|---|
| 3 | .TH "roar_stream_new" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" |
|---|
| 4 | |
|---|
| 5 | .SH NAME |
|---|
| 6 | roar_stream_new \- creates a new stream object |
|---|
| 7 | |
|---|
| 8 | .SH SYNOPSIS |
|---|
| 9 | |
|---|
| 10 | #include <roaraudio.h> |
|---|
| 11 | |
|---|
| 12 | int roar_stream_new(struct roar_stream * s, unsigned int rate, unsigned int channels, unsigned int bits, unsigned int codec); |
|---|
| 13 | |
|---|
| 14 | .SH "DESCRIPTION" |
|---|
| 15 | This call create a new stream object. |
|---|
| 16 | |
|---|
| 17 | .SH "PARAMETERS" |
|---|
| 18 | The parameter \fBs\fR is a pointer to the new stream object. |
|---|
| 19 | |
|---|
| 20 | For a description of the other parameters see \fBroar_simple_play\fR(3). |
|---|
| 21 | |
|---|
| 22 | .SH "RETURN VALUE" |
|---|
| 23 | On success these calls return 0. On error, \-1 is returned. |
|---|
| 24 | |
|---|
| 25 | .SH "EXAMPLES" |
|---|
| 26 | FIXME |
|---|
| 27 | |
|---|
| 28 | .SH "SEE ALSO" |
|---|
| 29 | \fBroar_simple_play\fR(3), |
|---|
| 30 | \fBlibroar\fR(7), |
|---|
| 31 | \fBRoarAudio\fR(7). |
|---|
| 32 | |
|---|
| 33 | .\" ll |
|---|
Note: See
TracBrowser
for help on using the repository browser.
