Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

roar_vs_new(3) [debian man page]

roar_vs_new(3)						   RoarAudio Programmer's Manual					    roar_vs_new(3)

NAME
roar_vs_stream, roar_vs_new_from_con - Create new VS objects SYNOPSIS
#include <roaraudio.h> roar_vs_t * roar_vs_new(const char * server, const char * name, int * error); roar_vs_t * roar_vs_new_from_con(struct roar_connection * con, int * error); DESCRIPTION
These calls are used to create new VS objects without a yet connected data connection. They are only helpful if there you want to share a control connection between multiple streams (generally recommended if using multiple streams to the same server) or need to use some extended parts of the VS API. If you look for a easy way to open a stream see roar_vs_new_simple(3) and roar_vs_new_from_file(3). roar_vs_new() opens a new control connection to server server. name is used as application name. roar_vs_new_from_con() creates a new VS object from the extsing control connection con. VS objects created via roar_vs_new_from_con() will not close the control connection on roar_vs_close(3). PARAMETERS
server The server to connect to. NULL for defaults. name The application name. This should be something the user can use to identify the application. It MUST NOT be the application's binary name or the value of argv[0]. con The already existing and open control connection to use. error This is a pointer to a integer used to store the error value in case of error. This can be NULL if not used but it is very recom- mended to use this error value to report good error messages to the user. RETURN VALUE
On success these calls return a new VS object. On error, NULL is returned. EXAMPLES
FIXME SEE ALSO
roar_vs_new_simple(3), roar_vs_new_from_file(3), roar_vs_close(3), roarvs(7), libroar(7), RoarAudio(7). RoarAudio June 2011 roar_vs_new(3)

Check Out this Related Man Page

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)
Man Page