1 | .\" roar_simple_play.3: |
---|
2 | |
---|
3 | .TH "roar_simple_play" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" |
---|
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 about underruns. |
---|
25 | |
---|
26 | All those functions are marked obsolete and will be removed soon. |
---|
27 | Please upgrade to VS API. See \fBroar_vs_new_simple\fR(3). |
---|
28 | |
---|
29 | .SH "PARAMETERS" |
---|
30 | .TP |
---|
31 | \fBrate\fR |
---|
32 | The sample rate of the stream. |
---|
33 | |
---|
34 | .TP |
---|
35 | \fBchannels\fR |
---|
36 | The nummber of channels in the stream. |
---|
37 | |
---|
38 | .TP |
---|
39 | \fBbits\fR |
---|
40 | The number of bits per sample of the stream. |
---|
41 | Commen values are 8 and 16. |
---|
42 | |
---|
43 | .TP |
---|
44 | \fBcodec\fR |
---|
45 | The Codec of the data you stream to the server. |
---|
46 | This has nothing to do with codec of the file you are playing back or encoding. |
---|
47 | Default (\fBROAR_CODEC_DEFAULT\fR) is \fBROAR_CODEC_PCM_S_BE\fR for signed PCM in big endian. |
---|
48 | |
---|
49 | .TP |
---|
50 | \fBserver\fR |
---|
51 | The name of the server. A value of \fBNULL\fR (common case) is used to try default locations. |
---|
52 | |
---|
53 | .TP |
---|
54 | \fBname\fR |
---|
55 | The name of the process opening this stream to be listend in the servers meta data. |
---|
56 | Should normaly be the name of the player without any path or filename being played. |
---|
57 | If \fBNULL\fR an internal default is used. |
---|
58 | |
---|
59 | .SH "NOTES ON FILTER STREAMS" |
---|
60 | Filtering streams should not expected to work with diffrent audio data than the server works with. |
---|
61 | You should get the values via \fBroar_server_oinfo\fR(3) before opening the stream. |
---|
62 | |
---|
63 | .SH "RETURN VALUE" |
---|
64 | On success these calls return a filehandle for the stream. On error, \-1 is returned. |
---|
65 | |
---|
66 | .SH "EXAMPLES" |
---|
67 | Examples of these calls are the tools \fBroarcat\fR(1), \fBroarmon\fR(1), \fBroarrec\fR(1) and \fBroarfilt\fR(1). |
---|
68 | Just look at there code. They aren't that complex. |
---|
69 | |
---|
70 | |
---|
71 | .SH "SEE ALSO" |
---|
72 | \fBroar_vs_new_simple\fR(3), |
---|
73 | \fBroarcat\fR(1), \fBroarmon\fR(1), \fBroarrec\fR(1), \fBroarfilt\fR(1), |
---|
74 | \fBroar_server_oinfo\fR(3), |
---|
75 | \fBroar_simple_close\fR(3), |
---|
76 | \fBlibroar\fR(7), |
---|
77 | \fBRoarAudio\fR(7). |
---|
78 | |
---|
79 | .\" ll |
---|