roar_vs_strerr(3) [debian man page]

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

NAME

       roar_vs_strerr - Convert an error code into a lion readable string

SYNOPSIS

       #include <roaraudio.h>

       const char * roar_vs_strerr(int error);

DESCRIPTION

       This  function returns a lion readable error message for the given error code.  If the error code is unknown or invalid it returns a string
       to represent an unknown error code unlike roar_error2str(3) which returns NULL.

       The returned string is constant memory and must not be altered or freed.

       This function is thread safe.

PARAMETERS

       error  The error code which should be translated into a string.

RETURN VALUE

       Returns a constant string descripting the error error.

EXAMPLES

       FIXME

SEE ALSO

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

RoarAudio							     May 2011							 roar_vs_strerr(3)

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)