Line | |
---|
1 | .TH "roar_vs_connection_obj" "3" "May 2011" "RoarAudio" "RoarAudio Programmer's Manual" |
---|
2 | |
---|
3 | .SH NAME |
---|
4 | roar_vs_connection_obj, roar_vs_stream_obj, roar_vs_vio_obj \- VS API interface for use of main API |
---|
5 | |
---|
6 | .SH SYNOPSIS |
---|
7 | |
---|
8 | #include <roaraudio.h> |
---|
9 | |
---|
10 | struct roar_connection * roar_vs_connection_obj(roar_vs_t * vss, int * error); |
---|
11 | |
---|
12 | struct roar_stream * roar_vs_stream_obj (roar_vs_t * vss, int * error); |
---|
13 | |
---|
14 | struct roar_vio_calls * roar_vs_vio_obj (roar_vs_t * vss, int * error); |
---|
15 | |
---|
16 | |
---|
17 | .SH "DESCRIPTION" |
---|
18 | Those functions return internal connection, stream and VIO object of the VS object. |
---|
19 | They are used to use the main API with a VS opened stream. |
---|
20 | |
---|
21 | \fBroar_vs_connection_obj()\fR returns the connection object used for the control connection |
---|
22 | to the server. |
---|
23 | |
---|
24 | \fBroar_vs_stream_obj()\fR returns the stream object storing information about the stream. |
---|
25 | |
---|
26 | \fBroar_vs_vio_obj()\fR returns the VIO object used to read data from or send data to the |
---|
27 | server. |
---|
28 | |
---|
29 | Returned objects are freed as soon as the VS object is closed. If the VS object was created |
---|
30 | using \fBroar_vs_new_from_con\fR(3) the connection is not closed by the VS object and stay valid |
---|
31 | after close until it is closed by the program or library. |
---|
32 | |
---|
33 | The VIO object MUST NOT be used while in buffered mode. |
---|
34 | |
---|
35 | .SH "PARAMETERS" |
---|
36 | .TP |
---|
37 | \fBvss\fR |
---|
38 | The VS object to return internal objects from. |
---|
39 | |
---|
40 | .TP |
---|
41 | \fBerror\fR |
---|
42 | This is a pointer to a integer used to store the error value in case of error. |
---|
43 | This can be NULL if not used but it is very recommended to use this error value to report |
---|
44 | good error messages to the user. |
---|
45 | |
---|
46 | .SH "RETURN VALUE" |
---|
47 | On success these calls return the described object. On error, NULL is returned. |
---|
48 | |
---|
49 | .SH "EXAMPLES" |
---|
50 | FIXME |
---|
51 | |
---|
52 | .SH "SEE ALSO" |
---|
53 | \fBroarvs\fR(7), |
---|
54 | \fBlibroar\fR(7), |
---|
55 | \fBRoarAudio\fR(7). |
---|
56 | |
---|
57 | .\" ll |
---|
Note: See
TracBrowser
for help on using the repository browser.