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)

roarbaseclients(1)					  System Manager's Manual: roard					roarbaseclients(1)

NAME

       roarcat, roarmon - RoarAudio sound server base clients

SYNOPSIS

       roarcat [OPTIONS]... [FILE]

       roarmon [OPTIONS]...

DESCRIPTION

       This  are  some	basic  clients	for  RoarAuido.  Some more complex are listen in the SEE ALSO block.  For controlling roard take a look at
       roarctl(1). For a simple Ogg Vorbis player take a look at roarvorbis(1) (ogg123 supportes RoarAudio via libao plugin).

       roarcat
	      Sends raw PCM audio data from a file or stdin (pipe) to the sound server.

       roarmon
	      Gets a copy of the audio data the server sends to the soundcard. This is useful for streaming to a server like icecast2(1).

GENERAL OPTIONS

       NOTE: This list is incomplete!  In addition to this list all three programs provide compatible options for esdcat,  esdmon.  You  can  just
       replace the "esd" in the name with "roar" or use symlinks. This options are for compatibly only and should not used in new programs.

       --help Print some help text.

AUDIO OPTIONS

       --rate RATE, -R RATE
	      Set server sample rate.

       --bits BITS, -B BITS
	      Set server bits.

       --chans CHANNELS, -C CHANNELS
	      Set server channels.

NETWORK OPTIONS

       --server SERVER
	      The server to connect to.

ENVIRONMENT VARIABLES

       Bellow only the basic environment varibales are listend.  For a complete list see libroar(7).

       HOME   The users home directory.

       ROAR_SERVER
	      The address of the listening server. This may be in form of host:port for TCP/IP connections and /path/to/sock for UNIX Domain Sock-
	      ets or any other supported format. See roartips(7) for a full list.  This is the same as the --server option.

BUGS

       There are a lot of bugs...

SEE ALSO

       roarctl(1), roarvorbis(1), roarfish(1), roartestclients(1), roartips(7), libroar(7), RoarAudio(7).

HISTORY

       For history information see RoarAudio(7).

RoarAudio							     July 2008							roarbaseclients(1)