Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

muroar_stream(3) [debian 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)

Check Out this Related Man Page

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

NAME

       roar_vs_stream - Set up stream parameters for VS object

SYNOPSIS

       #include <roaraudio.h>

       int roar_vs_stream(roar_vs_t * vss, const struct roar_audio_info * info, int dir, int * error);

DESCRIPTION

       This  function  asks a VS object opened by roar_vs_new_from_con(3) or roar_vs_new(3) to open the data connection using the audio parameters
       info and the stream direction dir.

       This function needs to be called before data is read or written if one of the above functions is used to create the VS object.

       This function is also used to provide parameters for the file mode (which is started by using roar_vs_file(3)  or  roar_vs_file_simple(3)).
       To  play  back  a  file	this  is not needed in a common case as the VS API tries to find correct parameters.  It is required for all other
       stream directions. See roar_vs_file(3) and roar_vs_file_simple(3) for more information.

       On failture this function can be called again with diffrent parameters.

PARAMETERS

       vss    The VS object to be updated.

       info   This is a pointer to the roar_audio_info structure storing the audio format parameters.  The structure contains the following  meme-
	      bers: rate (sample rate), bits (bits per sample), channels (channels per frame) and codec.

       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 0.  On error, -1 is returned.

EXAMPLES

	struct roar_audio_info info;
	int err;

	if ( roar_profile2info(&info, "isdn-eu") == -1 ) {
	 // error handling.
	}

	if ( roar_vs_stream(vss, &info, ROAR_DIR_PLAY, &err) == -1 ) {
	 // error handling.
	}

SEE ALSO

       roar_vs_file(3), roar_vs_file_simple(3), roarvs(7), libroar(7), RoarAudio(7).

RoarAudio							     June 2011							 roar_vs_stream(3)
Man Page