| 1 | .\" roar_simple_play.3: |
|---|
| 2 | |
|---|
| 3 | .TH "roar_simple_stream" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" |
|---|
| 4 | |
|---|
| 5 | .SH NAME |
|---|
| 6 | roar_simple_stream \- Opens a stream to RoarAudio's sound server |
|---|
| 7 | |
|---|
| 8 | .SH SYNOPSIS |
|---|
| 9 | |
|---|
| 10 | #include <roaraudio.h> |
|---|
| 11 | |
|---|
| 12 | int roar_simple_stream(int rate, int channels, int bits, int codec, char * server, int dir, char * name); |
|---|
| 13 | |
|---|
| 14 | .SH "DESCRIPTION" |
|---|
| 15 | This creates a new stream to RoarAudio. Normally you want to use one of \fBroar_simple_play\fR(3), \fBroar_simple_monitor\fR(3), \fBroar_simple_record\fR(3) or \fBroar_simple_filter\fR(3). |
|---|
| 16 | |
|---|
| 17 | his functions are marked obsolete and will be removed very soon. |
|---|
| 18 | Please upgrade to VS API. See \fBroar_vs_new_simple\fR(3). |
|---|
| 19 | |
|---|
| 20 | .SH "PARAMETERS" |
|---|
| 21 | .TP |
|---|
| 22 | \fBrate, channels, bits, codec, server, name\fR |
|---|
| 23 | For an explanation on these parameters see \fBroar_simple_play\fR(3). |
|---|
| 24 | |
|---|
| 25 | .TP |
|---|
| 26 | \fBdir\fR |
|---|
| 27 | The direction of the new stream. See below for a list of valid directions. |
|---|
| 28 | |
|---|
| 29 | .SH "STREAM DIRECTIONS" |
|---|
| 30 | |
|---|
| 31 | .TP |
|---|
| 32 | \fBROAR_DIR_PLAY\fR |
|---|
| 33 | This stream directions meens that a player streams data to the server in order to play it back. |
|---|
| 34 | |
|---|
| 35 | .TP |
|---|
| 36 | \fBROAR_DIR_RECORD\fR |
|---|
| 37 | This direction is to record audio from the soundcard. This is used if for example you want to |
|---|
| 38 | get data from your microphon or line in. |
|---|
| 39 | |
|---|
| 40 | .TP |
|---|
| 41 | \fBROAR_DIR_MONITOR\fR |
|---|
| 42 | This direction is used to get a copy of what the server sends to the soundcard. This can for example be used |
|---|
| 43 | to stream the fully mixed data to Icecast (see \fBicecast2\fR(1)). |
|---|
| 44 | |
|---|
| 45 | .TP |
|---|
| 46 | \fBROAR_DIR_FILTER\fR |
|---|
| 47 | This is used to crate a filter stream: A filter stream is a stream used to filter the output of the sound server by some tool. This can for example be used for an software equalizer. The filter stream is the only bi-directional stream. You have to read some data and write back data of exactly the same size. |
|---|
| 48 | |
|---|
| 49 | .TP |
|---|
| 50 | \fBROAR_DIR_OUTPUT\fR |
|---|
| 51 | This is the type of the stream the server sends to the soundcard. You can not create such a stream. It's only listend for completeness. |
|---|
| 52 | |
|---|
| 53 | |
|---|
| 54 | .SH "RETURN VALUE" |
|---|
| 55 | On success these calls return a filehandle. On error, \-1 is returned. |
|---|
| 56 | |
|---|
| 57 | .SH "EXAMPLES" |
|---|
| 58 | FIXME |
|---|
| 59 | |
|---|
| 60 | .SH "SEE ALSO" |
|---|
| 61 | \fBroar_vs_new_simple\fR(3), |
|---|
| 62 | \fBroar_simple_play\fR(3), |
|---|
| 63 | \fBroar_simple_close\fR(3), |
|---|
| 64 | \fBlibroar\fR(7), |
|---|
| 65 | \fBRoarAudio\fR(7). |
|---|
| 66 | |
|---|
| 67 | .\" ll |
|---|
