1 | .TH "roar_vs_new" "3" "June 2011" "RoarAudio" "RoarAudio Programmer's Manual" |
---|
2 | |
---|
3 | .SH NAME |
---|
4 | roar_vs_stream, roar_vs_new_from_con \- Create new VS objects |
---|
5 | |
---|
6 | .SH SYNOPSIS |
---|
7 | |
---|
8 | #include <roaraudio.h> |
---|
9 | |
---|
10 | roar_vs_t * roar_vs_new(const char * server, const char * name, int * error); |
---|
11 | |
---|
12 | roar_vs_t * roar_vs_new_from_con(struct roar_connection * con, int * error); |
---|
13 | |
---|
14 | .SH "DESCRIPTION" |
---|
15 | These calls are used to create new VS objects without a yet connected data connection. |
---|
16 | They are only helpful if there you want to share a control connection between multiple streams |
---|
17 | (generally recommended if using multiple streams to the same server) or need to use some |
---|
18 | extended parts of the VS API. If you look for a easy way to open a stream see |
---|
19 | \fBroar_vs_new_simple\fR(3) and \fBroar_vs_new_from_file\fR(3). |
---|
20 | |
---|
21 | \fBroar_vs_new()\fR opens a new control connection to server \fBserver\fR. |
---|
22 | \fBname\fR is used as application name. |
---|
23 | |
---|
24 | \fBroar_vs_new_from_con()\fR creates a new VS object from the extsing control connection \fBcon\fR. |
---|
25 | |
---|
26 | VS objects created via roar_vs_new_from_con() will not close the control connection on roar_vs_close(3). |
---|
27 | |
---|
28 | .SH "PARAMETERS" |
---|
29 | .TP |
---|
30 | \fBserver\fR |
---|
31 | The server to connect to. NULL for defaults. |
---|
32 | |
---|
33 | .TP |
---|
34 | \fBname\fR |
---|
35 | The application name. This should be something the user can use to identify the application. |
---|
36 | It MUST NOT be the application's binary name or the value of argv[0]. |
---|
37 | |
---|
38 | .TP |
---|
39 | \fBcon\fR |
---|
40 | The already existing and open control connection to use. |
---|
41 | |
---|
42 | .TP |
---|
43 | \fBerror\fR |
---|
44 | This is a pointer to a integer used to store the error value in case of error. |
---|
45 | This can be NULL if not used but it is very recommended to use this error value to report |
---|
46 | good error messages to the user. |
---|
47 | |
---|
48 | .SH "RETURN VALUE" |
---|
49 | On success these calls return a new VS object. On error, NULL is returned. |
---|
50 | |
---|
51 | .SH "EXAMPLES" |
---|
52 | FIXME |
---|
53 | |
---|
54 | .SH "SEE ALSO" |
---|
55 | \fBroar_vs_new_simple\fR(3), |
---|
56 | \fBroar_vs_new_from_file\fR(3), |
---|
57 | \fBroar_vs_close\fR(3), |
---|
58 | \fBroarvs\fR(7), |
---|
59 | \fBlibroar\fR(7), |
---|
60 | \fBRoarAudio\fR(7). |
---|
61 | |
---|
62 | .\" ll |
---|