source: roaraudio/doc/man3/roar_vs_buffer.3 @ 5058:45211d6eeea9

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

.SH NAME
roar_vs_buffer \- Use buffered mode streams

.SH SYNOPSIS

#include <roaraudio.h>

int roar_vs_buffer(roar_vs_t * vss, size_t buffer, int * error);

ssize_t roar_vs_get_avail_read(roar_vs_t * vss, int * error);

ssize_t roar_vs_get_avail_write(roar_vs_t * vss, int * error);

int     roar_vs_reset_buffer(roar_vs_t * vss, int writering, int readring, int * error);

.SH "DESCRIPTION"
These functions controls the buffered mode of the VS object. Using this mode is not recommended.

\fBroar_vs_buffer()\fR initializes the buffered mode. It takes the size for the buffer as argument.
The size should be a power of two. Common values include 2048 and 4096.

\fBroar_vs_get_avail_read()\fR and \fBroar_vs_get_avail_write()\fR return the amount of free space
in the read and write buffer.

\fBroar_vs_reset_buffer()\fR resets the read and/or write buffer. This means the data in the buffers is discarded.
This does not happen frame aligned and may result in broken audio.

Buffers are not flushed automaically. To do this use \fBroar_vs_iterate\fR(3) or \fBroar_vs_run\fR(3).

.SH "PARAMETERS"
.TP
\fBvss\fR
The VS object to be used.

.TP
\fBbuffer\fR
The size of the buffer to be used in bytes.

.TP
\fBwritering\fR, \fBreadring\fR
Selects the buffer to reset. Must be ROAR_VS_TRUE or ROAR_VS_FALSE.

.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 0.
roar_vs_get_avail_read() and roar_vs_get_avail_write() return the free space in the corresponding buffer.
On error, \-1 is returned.

.SH "EXAMPLES"
FIXME

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

.\" ll