| 1 | .\" roar_simple_play.3: |
|---|
| 2 | |
|---|
| 3 | .TH "roar_simple_play" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido" |
|---|
| 4 | |
|---|
| 5 | .SH NAME |
|---|
| 6 | roar_simple_play, roar_simple_monitor, roar_simple_record, roar_simple_filter \- Simple playback, monetoring, recording or filtering via RoarAudio |
|---|
| 7 | |
|---|
| 8 | .SH SYNOPSIS |
|---|
| 9 | |
|---|
| 10 | #include <roaraudio.h> |
|---|
| 11 | |
|---|
| 12 | int roar_simple_play(int rate, int channels, int bits, int codec, char * server, char * name); |
|---|
| 13 | |
|---|
| 14 | int roar_simple_monitor(int rate, int channels, int bits, int codec, char * server, char * name); |
|---|
| 15 | |
|---|
| 16 | int roar_simple_record(int rate, int channels, int bits, int codec, char * server, char * name); |
|---|
| 17 | |
|---|
| 18 | int roar_simple_filter(int rate, int channels, int bits, int codec, char * server, char * name); |
|---|
| 19 | |
|---|
| 20 | .SH "DESCRIPTION" |
|---|
| 21 | Open a connection to the \fBroard\fR(1) and creates a new stream for playback, monetoring, recording or filtering. |
|---|
| 22 | After you are done you need to close the connection via \fBroar_simple_close\fR(3). |
|---|
| 23 | In case you just don't do anything with the stream the server will kick your connection, or, in case of playback |
|---|
| 24 | warns the user avout underruns. |
|---|
| 25 | |
|---|
| 26 | .SH "PARAMETERS" |
|---|
| 27 | .TP |
|---|
| 28 | \fBrate\fR |
|---|
| 29 | The sample rate of the stream. |
|---|
| 30 | |
|---|
| 31 | .TP |
|---|
| 32 | \fBchannels\fR |
|---|
| 33 | The nummber of channels in the stream. |
|---|
| 34 | |
|---|
| 35 | .TP |
|---|
| 36 | \fBbits\fR |
|---|
| 37 | The number of bits per sample of the stream. |
|---|
| 38 | Commen values are 8 and 16. |
|---|
| 39 | |
|---|
| 40 | .TP |
|---|
| 41 | \fBcodec\fR |
|---|
| 42 | The Codec of the data you stream to the server. |
|---|
| 43 | This has nothing to do with codec of the file you are playing back or encoding. |
|---|
| 44 | Default (\fBROAR_CODEC_DEFAULT\fR) is \fBROAR_CODEC_PCM_S_BE\fR for signed PCM in big endian. |
|---|
| 45 | |
|---|
| 46 | .TP |
|---|
| 47 | \fBserver\fR |
|---|
| 48 | The name of the server. A value of \fBNULL\fR (common case) is used to try default locations. |
|---|
| 49 | |
|---|
| 50 | .TP |
|---|
| 51 | \fBname\fR |
|---|
| 52 | The name of the process opening this stream to be listend in the servers meta data. |
|---|
| 53 | Should normaly be the name of the player without any path or filename being played. |
|---|
| 54 | If \fBNULL\fR an internal default is used. |
|---|
| 55 | |
|---|
| 56 | .SH "NOTES ON FILTER STREAMS" |
|---|
| 57 | Filtering streams should not expected to work with diffrent audio data than the server works with. |
|---|
| 58 | You should get the values via \fBroar_server_oinfo\fR(3) before opening the stream. |
|---|
| 59 | |
|---|
| 60 | .SH "RETURN VALUE" |
|---|
| 61 | On success these calls return a filehandle for the stream. On error, \-1 is returned. |
|---|
| 62 | |
|---|
| 63 | .SH "EXAMPLES" |
|---|
| 64 | Examples of these calls are the tools \fBroarcat\fR(1), \fBroarmon\fR(1), \fBroarrec\fR(1) and \fBroarfilt\fR(1). |
|---|
| 65 | Just look at there code. They aren't that complex. |
|---|
| 66 | |
|---|
| 67 | |
|---|
| 68 | .SH "SEE ALSO" |
|---|
| 69 | \fBroarcat\fR(1), \fBroarmon\fR(1), \fBroarrec\fR(1), \fBroarfilt\fR(1), |
|---|
| 70 | \fBroar_server_oinfo\fR(3), |
|---|
| 71 | \fBroar_simple_close\fR(3), |
|---|
| 72 | \fBlibroar\fR(7), |
|---|
| 73 | \fBRoarAudio\fR(7). |
|---|
| 74 | |
|---|
| 75 | .\" ll |
|---|
