roar_vs_get_avail_write(3) [debian man page]
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)
Check Out this Related Man Page
roar_vs_volume_get(3) RoarAudio Programmer's Manual roar_vs_volume_get(3) NAME
roar_vs_volume_get, roar_vs_volume_mono, roar_vs_volume_stereo - Get or set volume for audio stream SYNOPSIS
#include <roaraudio.h> int roar_vs_volume_get (roar_vs_t * vss, float * l, float * r, int * error); int roar_vs_volume_mono (roar_vs_t * vss, float c, int * error); int roar_vs_volume_stereo (roar_vs_t * vss, float l, float r, int * error); DESCRIPTION
Those functions are used to get or set volume for the given stream. roar_vs_volume_get() gets the volume for the given stream in stereo form as a left and a right component (L/R). If you need the mono volume just devide the sum of both by two. See examples below. roar_vs_volume_mono() sets the mono volume for the stream. Balance information is not kept. roar_vs_volume_stereo() sets the stereo volume for the stream as left and rigth component (L/R). PARAMETERS
vss The VS object for wich volume is get or set. l, r, c The volume for left, right or center (mono) channel. Value is a float in range zero to one. Zero means this channel is fully muted. One means the channel is passed without altering the amplitude. Small numerical errors are detected and corrected. Bigger errors will result in a out of range error. Note that to mute the stream you MUST NOT use volume setting but roar_vs_mute(3). 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. On error, -1 is returned. EXAMPLES
Getting mono volume: float l, r, c; int err; if ( roar_vs_volume_get(vss, &l, &r, &err) == -1 ) { /* handle error */ } c = (l + r)/2.; SEE ALSO
roarvs(7), libroar(7), RoarAudio(7). RoarAudio May 2011 roar_vs_volume_get(3)