Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

roar_vs_new_simple(3) [debian man page]

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

roar_vs_new_simple, roar_vs_new_playback - Create new VS objects SYNOPSIS
#include <roaraudio.h> roar_vs_t * roar_vs_new_simple(const char * server, const char * name, int rate, int channels, int codec, int bits, int dir, int * error); roar_vs_t * roar_vs_new_playback(const char * server, const char * name, int rate, int channels, int codec, int bits, int * error); DESCRIPTION
These functions create a new VS object with a already connected data connection. The functions connect to the server server with applica- tion name name. They take the audio parameters as arguments rate, channels, codec, bits. roar_vs_new_simple() takes the stream direction as parameter dir. roar_vs_new_playback() is equivalent to roar_vs_new_simple() expect that it does not take the direction parameter but uses ROAR_DIR_PLAY (waveform playback). It may be implemented as a macro. 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]. rate, channels, codec, bits The audio parameters for the new stream: sampling rate, number of channels per frame, used codec and number of bits per sample. dir This is the stream direction. Common values include ROAR_DIR_PLAY for waveform playback, ROAR_DIR_MONITOR for waveform monitoring, ROAR_DIR_RECORD for waveform recording. For MIDI ROAR_DIR_MIDI_IN and ROAR_DIR_MIDI_OUT is used. 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
roar_vs_new(3), roar_vs_new_from_file(3), roar_vs_close(3), roarvs(7), libroar(7), RoarAudio(7). RoarAudio June 2011 roar_vs_new_simple(3)

Check Out this Related Man Page

roar_simple_stream(3)					System Manager's Manual: RoarAudio				     roar_simple_stream(3)

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
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