roar_vs_write(3) [debian man page]

roar_vs_read(3) 					   RoarAudio Programmer's Manual					   roar_vs_read(3)

NAME

       roar_vs_read, roar_vs_write - Read or write data from or to sound server

SYNOPSIS

       #include <roaraudio.h>

       ssize_t roar_vs_read (roar_vs_t * vss,	    void * buf, size_t len, int * error);

       ssize_t roar_vs_write(roar_vs_t * vss, const void * buf, size_t len, int * error);

DESCRIPTION

       roar_vs_read() reads data from the sound server into buffer buf.

       roar_vs_write() writes data in buffer buf to the sound server.

PARAMETERS

       vss    The VS object data is read from or written to.

       buf    The buffer to read to or write from.

       len    The length of the data to be read or written in byte.

       error  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 recom-
	      mended to use this error value to report good error messages to the user.

RETURN VALUE

       On success these calls return the amount of data read or written.  This can be smaller than the requested size.	On error, -1 is returned.

EXAMPLES

       FIXME

SEE ALSO

       roarvs(7), libroar(7), RoarAudio(7).

RoarAudio							     May 2011							   roar_vs_read(3)

roar_vs_buffer(3)					   RoarAudio Programmer's Manual					 roar_vs_buffer(3)

NAME

       roar_vs_buffer - Use buffered mode streams

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);

DESCRIPTION

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

       roar_vs_buffer()  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.

       roar_vs_get_avail_read() and roar_vs_get_avail_write() return the amount of free space in the read and write buffer.

       roar_vs_reset_buffer() 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 roar_vs_iterate(3) or roar_vs_run(3).

PARAMETERS

       vss    The VS object to be used.

       buffer The size of the buffer to be used in bytes.

       writering, readring
	      Selects the buffer to reset. Must be ROAR_VS_TRUE or ROAR_VS_FALSE.

       error  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 recom-
	      mended to use this error value to report good error messages to the user.

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.

EXAMPLES

       FIXME

SEE ALSO

       roarvs(7), libroar(7), RoarAudio(7).

RoarAudio							     June 2011							 roar_vs_buffer(3)