Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

libroar(7) [debian man page]

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

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 Sock-
	      ets. 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).

RoarAudio							     June 2011								libroar(7)

Check Out this Related Man Page

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

NAME

       roartips - Tips for RoarAudio users

SYNOPSIS

	roard [OPTIONS...] ...

	roarclient [OPTIONS...] ...

DESCRIPTION

       This manpage lists some tips for intermedia to advanced users of RoarAudio.

CONTROLLING ROARD

       RoarAudio supports a lot of things you can change on the fly.  This includes the volume for each stream as you may allready noticed: If you
       cange the volume within a player only this stream is changed, other streams keep there loudness. There a a lot other  things  that  can	be
       changed on the fly.  To do this there is a tool called roarctl(1). You may want to play around a bit with it. A good start are to try those
       two commands:
	roarctl --help
	roarctl allinfo

       The later one will show you all information current available of the server it self, the clients and the streams. This may include a lot of
       information.

SERVER ADDRESS

       There  a serverel types of server addresses based on the protocol used to communicate.  This lists the corrently implemented types in order
       of importance:

       /path/to/sock
	      Path to UNIX Domain Socket.  Example:
	       /tmp/roar

       host, host:port
	      This is used for connections over TCP/IP.  If port is omitted the default port is used.  Examples:
	       audio.homeserver.local
	       localhost:7564

       node::, node::object, ::object, ::
	      This is the way to specify a DECnet connection to node node's object object. Both may be omitted to use defaults. Default node  name
	      is local hosts node name.  Examples:
	       mynode::
	       ::roar
	       yournode::yourroard

       +fork  This starts a new roard for every roar_connect(3).  This is used internaly by the lib to emulate EsounD's fallback.

ENVIRONMENT

       ROAR_SERVER
	      This  varibale contains the default server address. If some client does not allow a user to set a server address or to set a default
	      value this one come into play. Examples:
	       ROAR_SERVER=some.host
	       ROAR_SERVER=another.host:port
	       ROAR_SERVER=node::
	       ROAR_SERVER=/tmp/roar

SEE ALSO

       roarcat(1), roarctl(1), roarfilt(1), roarfish(1), roarmon(1), roarvorbis(1), roard(1), libroar(7).

RoarAudio							    August 2008 						       roartips(7)
Man Page