roar_vs_new_simple(3) [debian man page]

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

NAME

       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

       FIXME

SEE ALSO

       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)

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

NAME

       roar_simple_play,  roar_simple_monitor,	roar_simple_record,  roar_simple_filter  - Simple playback, monetoring, recording or filtering via
       RoarAudio

SYNOPSIS

       #include <roaraudio.h>

       int roar_simple_play(int rate, int channels, int bits, int codec, char * server, char * name);

       int roar_simple_monitor(int rate, int channels, int bits, int codec, char * server, char * name);

       int roar_simple_record(int rate, int channels, int bits, int codec, char * server, char * name);

       int roar_simple_filter(int rate, int channels, int bits, int codec, char * server, char * name);

DESCRIPTION

       Open a connection to the roard(1) and creates a new stream for playback, monetoring, recording or filtering.  After you are done  you  need
       to close the connection via roar_simple_close(3).  In case you just don't do anything with the stream the server will kick your connection,
       or, in case of playback warns the user about underruns.

       All those functions are marked obsolete and will be removed soon.  Please upgrade to VS API. See roar_vs_new_simple(3).

PARAMETERS

       rate   The sample rate of the stream.

       channels
	      The nummber of channels in the stream.

       bits   The number of bits per sample of the stream.  Commen values are 8 and 16.

       codec  The Codec of the data you stream to the server.  This has nothing to do with codec of the file you are  playing  back  or  encoding.
	      Default (ROAR_CODEC_DEFAULT) is ROAR_CODEC_PCM_S_BE for signed PCM in big endian.

       server The name of the server. A value of NULL (common case) is used to try default locations.

       name   The  name of the process opening this stream to be listend in the servers meta data.  Should normaly be the name of the player with-
	      out any path or filename being played.  If NULL an internal default is used.

NOTES ON FILTER STREAMS

       Filtering streams should not expected to work with diffrent audio data than  the  server  works	with.	You  should  get  the  values  via
       roar_server_oinfo(3) before opening the stream.

RETURN VALUE

       On success these calls return a filehandle for the stream.  On error, -1 is returned.

EXAMPLES

       Examples  of  these calls are the tools roarcat(1), roarmon(1), roarrec(1) and roarfilt(1).  Just look at there code. They aren't that com-
       plex.

SEE ALSO

       roar_vs_new_simple(3), roarcat(1), roarmon(1), roarrec(1), roarfilt(1),	roar_server_oinfo(3),  roar_simple_close(3),  libroar(7),  RoarAu-
       dio(7).

RoarAudio							     May 2011						       roar_simple_play(3)