roarvio(7) [debian man page]

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

NAME

       libroar - RoarAudio sound library

       roarvio - RoarAudio virtual IO layer

SYNOPSIS

	#include <roaraudio.h>

	struct roar_vio_calls;

DESCRIPTION

       The  RoarAudio  VIO interface is RoarAudio's IO abstraction layer. It provides basic IO functions such as read and write independing on the
       underlaying IO. For Example can you open a plain or a gziped file via the VIO layer. After a successful open both objects behave the  same,
       libroar takes care about the compression in the gzip case.

TUTORIALS

       Tutorials can be found in roartutvio(7).

IMPORTANT FUNCTIONS

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

       Opening
	      roar_vio_open_file(3), roar_vio_open_fh(3), roar_vio_open_stdio(3), roar_vio_open_dstr(3), roar_vio_open_proto(3).

	      While there are a lot functions important for opening files the most important one is roar_vio_open_dstr(3). It opens a stream based
	      on URLs that can point to local files or files on remote machines. It also can handle compression and encryption.

       Closing
	      roar_vio_close(3), roar_vio_shutdown(3)

       Reading and writing
	      roar_vio_read(3), roar_vio_write(3)

       Seeking and positioning
	      roar_vio_lseek(3)

       Non-Blocking and Asyncron IO
	      roar_vio_nonblock(3), roar_vio_sync(3), roar_vio_select(3)

       Networking and Sockets
	      roar_vio_accept(3)

       String handling
	      roar_vio_printf(3)

BUGS

       A lot...

SEE ALSO

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

RoarAudio							     May 2011								roarvio(7)

roar_simple_stream(3)					System Manager's Manual: RoarAudio				     roar_simple_stream(3)

NAME

       roar_simple_stream - Opens a stream to RoarAudio's sound server

SYNOPSIS

       #include <roaraudio.h>

       int roar_simple_stream(int rate, int channels, int bits, int codec, char * server, int dir, char * name);

DESCRIPTION

       This  creates a new stream to RoarAudio. Normally you want to use one of roar_simple_play(3), roar_simple_monitor(3), roar_simple_record(3)
       or roar_simple_filter(3).

       his functions are marked obsolete and will be removed very soon.  Please upgrade to VS API. See roar_vs_new_simple(3).

PARAMETERS

       rate, channels, bits, codec, server, name
	      For an explanation on these parameters see roar_simple_play(3).

       dir    The direction of the new stream. See below for a list of valid directions.

STREAM DIRECTIONS

       ROAR_DIR_PLAY
	      This stream directions meens that a player streams data to the server in order to play it back.

       ROAR_DIR_RECORD
	      This direction is to record audio from the soundcard. This is used if for example you want to get data from your microphon  or  line
	      in.

       ROAR_DIR_MONITOR
	      This  direction  is  used  to get a copy of what the server sends to the soundcard. This can for example be used to stream the fully
	      mixed data to Icecast (see icecast2(1)).

       ROAR_DIR_FILTER
	      This is used to crate a filter stream: A filter stream is a stream used to filter the output of the sound server by some tool.  This
	      can  for	example be used for an software equalizer. The filter stream is the only bi-directional stream. You have to read some data
	      and write back data of exactly the same size.

       ROAR_DIR_OUTPUT
	      This is the type of the stream the server sends to the soundcard. You can not create such a stream. It's only listend for  complete-
	      ness.

RETURN VALUE

       On success these calls return a filehandle.  On error, -1 is returned.

EXAMPLES

       FIXME

SEE ALSO

       roar_vs_new_simple(3), roar_simple_play(3), roar_simple_close(3), libroar(7), RoarAudio(7).

RoarAudio							     May 2011						     roar_simple_stream(3)