NAME

       libroar - RoarAudio sound library

SYNOPSIS

        #include <roaraudio.h>

DESCRIPTION

       libroar  is  a central library used to comunicate with RoarAudio servers.  It supports all
       commands from simple commands to play some audio up to complex commands  to  controll  the
       server  and  do  nice  things over the network.  It also includes several useful functions
       from buffer mangement to IO abstraction.

EXAMPLES

       The basic tools shiped with RoarAudio are designed to also work as examples for  the  lib.
       You  may  start  by looking at roarcat(1)s source code as an example on how to simply play
       back some audio. A more complex example is roarvorbis(1) which  also  includes  meta  data
       updates.

       You should also have a look at VS API, see roarvs(7) for a overview.

TUTORIALS

       Tutorials can be found in roartut(7).

ENVIRONMENT VARIABLES

       The following variables are used in libroar itself so they are common to all clients using
       libroar.

       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 Sockets. If a value of '+fork' is
              given a roard is forked and used.  This roard will not listen on any sockets so  it
              is used exclusiv by this client. See roard(1) for more information.

       ROAR_PROXY
              Set  the  type  of the proxy being used to connect to the server.  Valid values are
              'socks4', 'socks4a', 'socks4d', 'http' and 'ssh' for the moment.  You can add  type
              depending options in form 'type/opts'.

       socks_proxy
              The SOCKS4/4a/4d/5 proxy to use in form [user@]host[:port].  Default port is 9050.

       http_proxy, https_proxy
              The  HTTP/HTTPS  Proxy  server. This server needs to understand the CONNECT request
              type.  Give the server name in this  format:  [http://]host[:port][/]  The  default
              port is 8080.

       ssh_proxy
              The  remote  host to use as SSH Proxy server.  Give the server name in this format:
              [user@]host[:port] The default port is 22.  Note that you may need to use publickey
              based  auth or ssh-agent because the application may start SSH in a non interactive
              environment and SSH can not ask you for a password.

FILES

       /etc/roarserver
              This is a symlink to the server socket.  If  all  types  of  server  addresses  are
              supported.  Example:
               ln -s /tmp/roar /etc/roarserver
               ln -s somehost /etc/roarserver
               ln -s mynode:: /etc/roarserver

BUGS

       A lot...

SEE ALSO

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

HISTORY

       See RoarAudio(7).