Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

roar_simple_record(3) [debian man page]

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)

Check Out this Related Man Page

muroar_stream(3)					    muRoar Programmer's Manual						  muroar_stream(3)

NAME
muroar_stream - Create a stream connected to a RoarAudio sound server SYNOPSIS
#include <muroar.h> muroar_t muroar_stream (muroar_t fh, int dir, int * stream, int codec, int rate, int channels, int bits); DESCRIPTION
This function connects a stream to a sound server supporting the RoarAudio protocol. It takes a connected control connection created with roar_connect(3) and converts it into a connected stream. The socket can no longer be used as control connection. PARAMETERS
fh The connected control connection. dir The stream direction for the new stream. For playback of a waveform stream (PCM data) this is MUROAR_PLAY_WAVE. For all possible values see the offical muRoar manual. stream This is a pointer to an integer muRoar stores the stream ID in. If your application does not need to know the stream ID of the new stream this can be set to NULL. codec This is the codec to be used for the new stream. For signed PCM in host byte order use MUROAR_CODEC_PCM or MUROAR_CODEC_PCM_S. For unsigned PCM use MUROAR_CODEC_PCM_U. There are a lot other codecs defined. However using a codec not supported by the server will result an failure of this call. For all possible values see the offical muRoar manual. rate This is the sample/frame rate the new stream will use. For streams this setting does not make any sense set this to zero. channels This is the number of channels for the new stream. For streams this setting does not make any sense set this to zero. bits This is the number of bits per sample to be used by the data. For streams this setting does not make any sense set this to zero. RETURN VALUE
On success this call return the new stream IO handle. This may be the same as the control connection or a new one and the control connec- tion is closed. On error, MUROAR_HANDLE_INVALID is returned. BUGS
In failure where is no way to tell was was going wrong. HISTORY
This function first appeared in muRoar version 0.1beta0. SEE ALSO
muroar_connect(3), muroar_close(3), RoarAudio(7). muRoar April 2012 muroar_stream(3)
Man Page