roarvs(7) [debian man page]

roarvs(7)						System Manager's Manual: RoarAuido						 roarvs(7)

NAME

       libroar - RoarAudio sound library

       roarvs - RoarAudio very simple API

SYNOPSIS

	#include <roaraudio.h>

	roar_vs_t * vss;

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.

TUTORIALS

       Tutorials can be found in roartut(7).

IMPORTANT FUNCTIONS

       There are several important functions. This is a small list of the most important ones.

       Error handling
	      roar_vs_strerr(3)

       Opening
	      roar_vs_new(3), roar_vs_new_simple(3), roar_vs_new_playback(3), roar_vs_new_from_file(3)

       Closing
	      roar_vs_close(3)

       Reading and writing
	      roar_vs_read(3), roar_vs_write(3)

       Non-Blocking and Asyncron IO
	      roar_vs_blocking(3), roar_vio_select(3)

       Volume and Flags
	      roar_vs_pause(3), roar_vs_mute(3), roar_vs_volume_mono(3), roar_vs_volume_stereo(3), roar_vs_volume_get(3)

       Meta data
	      roar_vs_meta(3), roar_vs_role(3)

       File mode
	      roar_vs_file(3), roar_vs_file_simple(3), roar_vs_iterate(3), roar_vs_run(3)

       Buffered mode
	      roar_vs_buffer(3), roar_vs_iterate(3), roar_vs_run(3)

BUGS

       A lot...

SEE ALSO

       roar-config(1), roartypes(1), roartut(7), RoarAudio(7).

RoarAudio							     June 2011								 roarvs(7)

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)