source: roaraudio/doc/man7/roarvs.7 @ 5058:45211d6eeea9

.\" RoarAudio
.TH "roarvs" "7" "June 2011" "RoarAudio" "System Manager's Manual: RoarAuido"

.SH NAME
libroar \- RoarAudio sound library

roarvs \- RoarAudio very simple API

.SH SYNOPSIS

 #include <roaraudio.h>

 roar_vs_t * vss;

.SH "DESCRIPTION"
The VS (for Very Simple) API is a high level abstraction layer used to allow use of RoarAudio
from very simple programs. The API was designed to help people to easly upgrade existing artsc and pulse-simple
code to RoarAudio. While the API is equivalently simple it is much more powerful than one one by
aRtsc or PulseAudio.

The VS API also has a mode to play back (and record) files easly. As this uses VIO/DSTR it can handle
streams as well.

.\".SH "EXAMPLES"

.SH "TUTORIALS"
Tutorials can be found in \fBroartut\fR(7).

.SH "IMPORTANT FUNCTIONS"
There are several important functions. This is a small list of the most important ones.

.TP
\fBError handlingf\fR
\fBroar_vs_strerr\fR(3)

.TP
\fBOpening\fR
\fBroar_vs_new\fR(3), \fBroar_vs_new_simple\fR(3), \fBroar_vs_new_playback\fR(3),
\fBroar_vs_new_from_file\fR(3)

.TP
\fBClosing\fR
\fBroar_vs_close\fR(3)

.TP
\fBReading and writing\fR
\fBroar_vs_read\fR(3), \fBroar_vs_write\fR(3)

.TP
\fBNon-Blocking and Asyncron IO\fR
\fBroar_vs_blocking\fR(3),
\fBroar_vio_select\fR(3)

.TP
\fBVolume and Flags\fR
\fBroar_vs_pause\fR(3), \fBroar_vs_mute\fR(3),
\fBroar_vs_volume_mono\fR(3), \fBroar_vs_volume_stereo\fR(3), \fBroar_vs_volume_get\fR(3)

.TP
\fBMeta data\fR
\fBroar_vs_meta\fR(3), \fBroar_vs_role\fR(3)

.TP
\fBFile mode\fR
\fBroar_vs_file\fR(3), \fBroar_vs_file_simple\fR(3),
\fBroar_vs_iterate\fR(3), \fBroar_vs_run\fR(3)

.TP
\fBBuffered mode\fR
\fBroar_vs_buffer\fR(3),
\fBroar_vs_iterate\fR(3), \fBroar_vs_run\fR(3)

.SH "BUGS"
A lot...

.SH "SEE ALSO"
\fBroar-config\fR(1),
\fBroartypes\fR(1),
\fBroartut\fR(7),
\fBRoarAudio\fR(7).

.\"ll