source: roaraudio/doc/man3/roar_vs_connection_obj.3 @ 5041:236c1b3b1a30

.TH "roar_vs_connection_obj" "3" "May 2011" "RoarAudio" "RoarAudio Programmer's Manual"

.SH NAME
roar_vs_connection_obj, roar_vs_stream_obj, roar_vs_vio_obj \- VS API interface for use of main API

.SH SYNOPSIS

#include <roaraudio.h>

struct roar_connection * roar_vs_connection_obj(roar_vs_t * vss, int * error);

struct roar_stream     * roar_vs_stream_obj    (roar_vs_t * vss, int * error);

struct roar_vio_calls  * roar_vs_vio_obj       (roar_vs_t * vss, int * error);


.SH "DESCRIPTION"
Those functions return internal connection, stream and VIO object of the VS object.
They are used to use the main API with a VS opened stream.

\fBroar_vs_connection_obj()\fR returns the connection object used for the control connection
to the server.

\fBroar_vs_stream_obj()\fR returns the stream object storing information about the stream.

\fBroar_vs_vio_obj()\fR returns the VIO object used to read data from or send data to the
server.

Returned objects are freed as soon as the VS object is closed. If the VS object was created
using \fBroar_vs_new_from_con\fR(3) the connection is not closed by the VS object and stay valid
after close until it is closed by the program or library.

The VIO object MUST NOT be used while in buffered mode.

.SH "PARAMETERS"
.TP
\fBvss\fR
The VS object to return internal objects from.

.TP
\fBerror\fR
This is a pointer to a integer used to store the error value in case of error.
This can be NULL if not used but it is very recommended to use this error value to report
good error messages to the user.

.SH "RETURN VALUE"
On success these calls return the described object.  On error, NULL is returned.

.SH "EXAMPLES"
FIXME

.SH "SEE ALSO"
\fBroarvs\fR(7),
\fBlibroar\fR(7),
\fBRoarAudio\fR(7).

.\" ll