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

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

NAME
roarcat2sock, roarcatad, roarsin, roarsockconnect - RoarAudio sound server test clients SYNOPSIS
roarcat2sock [OPTIONS]... roarcatad [OPTIONS]... roarsin roarsockconnect HOST PORT DESCRIPTION
This clients are primary for test perpose but may be useful for someone or can be used as examples. roarcat2sock This is the same as roarcat(1) but uses roar_simple_new_stream(3) to open the audio stream. roarcatad This is also the same as roarcat(1) but uses roar_stream_add_data(3) to fill the server's input buffer. roarsin This is the complete version of the sinus generator from roartut(7). It plays a 5 second middle C (523.2Hz) sine. roarsockconnect This is just a test tool connecting somewhere via roar_socket_connect(3). First the data of stdin is copied to the socket than the data from the socket to stdout. It's a very simlple semi-bi-directional version of netcat(1). GENERAL OPTIONS
NOTE: This list is incomplete! --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. 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), roarbaseclients(1), roartips(7), libroar(7), RoarAudio(7). HISTORY
For history information see RoarAudio(7). RoarAudio July 2008 roartestclients(1)
Man Page

Featured Tech Videos