muroarstream(1) [debian man page]

muroarstream(1) 					System User's Manual: muroarstream					   muroarstream(1)

NAME

       muroarstream - Simple RoarAudio client

SYNOPSIS

       muroarstream [OPTIONS]

DESCRIPTION

       muroarstream is a simple client for the RoarAudio sound system.	It is based on muRoar (libmuroar).  It can only be used to send data to or
       get data from the server.  No control functionality is supported.

OPTIONS

       --help Display a brief help.

       -f --file     FILE
	      Sets the file to read from or write to.

       --server   SERVER
	      Sets the server to SERVER.  Default is to auto detect the server. (see below)

       -R --rate     RATE
	      Sets the sample rate.  This defaults to 44100Hz.

       -C --channels CHANS
	      Sets the number of channels.  this defaults to 2 channels (stereo).  Symbolic names "mono" and "stereo" as well as "default" can	be
	      used.

       -B --bits     BITS
	      Sets the number of bits per sample.  The default is 16bit per sample.

       -E --codec    CODEC
	      Sets  the  codec	to  use.  The default depends on used subsystem.  For Waveform it uses Signed native PCM, for Light DMX512 and for
	      MIDI MIDI.  The following symbolic names can be used: default, pcm, pcm_s, pcm_u, ogg_vorbis, vorbis,  alaw,  mulaw,  ulaw,  dmx512,
	      roardmx, midi.

       --play Use Playback mode (send data to the server).  This is the default.

       --monitor
	      Use monitor mode (get a copy of the played data from the server).

       --wave Use Waveform subsystem (default).

       --midi Use MIDI subsystem.

       --light
	      Use Light Control subsystem.

AUTO DETECTION

       The  server  will be auto located if no server name is given.  First it will look for the environment variable $ROAR_SERVER.  If this vari-
       able is non existing libmuroar will do the auto location based on a list of possible server locations.  This list contains the global  UNIX
       socket address, the user's private socket address and an entry for localhost using TCP/IP.

       The UNIX socket addresses are only compiled in if UNIX socket support is detected.

SEE ALSO

       roarcat(1), RoarAudio(7).

muRoar								 22 February 2010						   muroarstream(1)

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)