source: roaraudio/doc/man3/roar_simple_new_stream.3 @ 5032:b2c8bbc7907f

.\" roar_simple_play.3:

.TH "roar_simple_new_stream" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio"

.SH NAME
roar_simple_new_stream, roar_simple_new_stream_obj \- Create a new stream via RoarAudio

.SH SYNOPSIS

#include <roaraudio.h>

int roar_simple_new_stream(struct roar_connection * con, int rate, int channels, int bits, int codec, int dir);

int roar_simple_new_stream_obj(struct roar_connection * con, struct roar_stream * s, int rate, int channels, int bits, int
codec, int dir);

.SH "DESCRIPTION"
Opens a new stream to the sound server as a independet file handle (not an execed one). This is useful if you still want
some meta data or the volume to be updated after the stream is open.

This functions are marked obsolete and will be removed in later releases.
Please upgrade to VS API. See \fBroar_vs_new_simple\fR(3).

.SH "PARAMETERS"
.TP
\fBcon\fR
The "parent" connection. This is a valid open control connection as opend via \fBroar_simple_connect\fR(3).

.TP
\fBs\fR
The stream object to be updated to corresponde to the new stream. This is useful if use want to update some meta data
after the stream has be opened as you can use all controll commands on this object.

.TP
\fBrate, channels, bits, codec\fR
For an explanation on these parameters see \fBroar_simple_play\fR(3).

.TP
\fBdir\fR
For an explanation on this parameter see \fBroar_simple_stream\fR(3).

.SH "RETURN VALUE"
On success these calls return a new filehandle.  On error, \-1 is returned.

.SH "EXAMPLES"
An example of the use of \fBroar_simple_new_stream_obj()\fR can be found on \fBroarvorbis\fR(1) code.

.SH "SEE ALSO"
\fBroar_vs_new_simple\fR(3),
\fBroar_simple_connect\fR(3),
\fBroar_simple_play\fR(3),
\fBroar_simple_close\fR(3),
\fBlibroar\fR(7),
\fBRoarAudio\fR(7).

.\" ll