.TH "roar_vs_new_simple" "3" "June 2011" "RoarAudio" "RoarAudio Programmer's Manual"

.SH NAME
roar_vs_new_simple, roar_vs_new_playback \- Create new VS objects

.SH SYNOPSIS

#include <roaraudio.h>

roar_vs_t * roar_vs_new_simple(const char * server, const char * name, int rate, int channels, int codec, int bits, int dir, int * error);

roar_vs_t * roar_vs_new_playback(const char * server, const char * name, int rate, int channels, int codec, int bits, int * error);

.SH "DESCRIPTION"
These functions create a new VS object with a already connected data connection.
The functions connect to the server \fBserver\fR with application name \fBname\fR.
They take the audio parameters as arguments \fBrate\fR, \fBchannels\fR, \fBcodec\fR, \fBbits\fR.

\fBroar_vs_new_simple()\fR takes the stream direction as parameter \fBdir\fR.

\fBroar_vs_new_playback()\fR is equivalent to roar_vs_new_simple() expect that it does not take the direction parameter but uses ROAR_DIR_PLAY (waveform playback). It may be implemented as a macro.

.SH "PARAMETERS"
.TP
\fBserver\fR
The server to connect to. NULL for defaults.

.TP
\fBname\fR
The application name. This should be something the user can use to identify the application.
It MUST NOT be the application's binary name or the value of argv[0].

.TP
\fBrate\fR, \fBchannels\fR, \fBcodec\fR, \fBbits\fR
The audio parameters for the new stream: sampling rate, number of channels per frame,
used codec and number of bits per sample.

.TP
\fBdir\fR
This is the stream direction. Common values include ROAR_DIR_PLAY for waveform playback,
ROAR_DIR_MONITOR for waveform monitoring, ROAR_DIR_RECORD for waveform recording.
For MIDI ROAR_DIR_MIDI_IN and ROAR_DIR_MIDI_OUT is used.

.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 a new VS object.  On error, NULL is returned.

.SH "EXAMPLES"
FIXME

.SH "SEE ALSO"
\fBroar_vs_new\fR(3),
\fBroar_vs_new_from_file\fR(3),
\fBroar_vs_close\fR(3),
\fBroarvs\fR(7),
\fBlibroar\fR(7),
\fBRoarAudio\fR(7).

.\" ll