| 1 | .TH "roar_vs_new_simple" "3" "June 2011" "RoarAudio" "RoarAudio Programmer's Manual" |
|---|
| 2 | |
|---|
| 3 | .SH NAME |
|---|
| 4 | roar_vs_new_simple, roar_vs_new_playback \- Create new VS objects |
|---|
| 5 | |
|---|
| 6 | .SH SYNOPSIS |
|---|
| 7 | |
|---|
| 8 | #include <roaraudio.h> |
|---|
| 9 | |
|---|
| 10 | 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); |
|---|
| 11 | |
|---|
| 12 | roar_vs_t * roar_vs_new_playback(const char * server, const char * name, int rate, int channels, int codec, int bits, int * error); |
|---|
| 13 | |
|---|
| 14 | .SH "DESCRIPTION" |
|---|
| 15 | These functions create a new VS object with a already connected data connection. |
|---|
| 16 | The functions connect to the server \fBserver\fR with application name \fBname\fR. |
|---|
| 17 | They take the audio parameters as arguments \fBrate\fR, \fBchannels\fR, \fBcodec\fR, \fBbits\fR. |
|---|
| 18 | |
|---|
| 19 | \fBroar_vs_new_simple()\fR takes the stream direction as parameter \fBdir\fR. |
|---|
| 20 | |
|---|
| 21 | \fBroar_vs_new_playback()\fR 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. |
|---|
| 22 | |
|---|
| 23 | .SH "PARAMETERS" |
|---|
| 24 | .TP |
|---|
| 25 | \fBserver\fR |
|---|
| 26 | The server to connect to. NULL for defaults. |
|---|
| 27 | |
|---|
| 28 | .TP |
|---|
| 29 | \fBname\fR |
|---|
| 30 | The application name. This should be something the user can use to identify the application. |
|---|
| 31 | It MUST NOT be the application's binary name or the value of argv[0]. |
|---|
| 32 | |
|---|
| 33 | .TP |
|---|
| 34 | \fBrate\fR, \fBchannels\fR, \fBcodec\fR, \fBbits\fR |
|---|
| 35 | The audio parameters for the new stream: sampling rate, number of channels per frame, |
|---|
| 36 | used codec and number of bits per sample. |
|---|
| 37 | |
|---|
| 38 | .TP |
|---|
| 39 | \fBdir\fR |
|---|
| 40 | This is the stream direction. Common values include ROAR_DIR_PLAY for waveform playback, |
|---|
| 41 | ROAR_DIR_MONITOR for waveform monitoring, ROAR_DIR_RECORD for waveform recording. |
|---|
| 42 | For MIDI ROAR_DIR_MIDI_IN and ROAR_DIR_MIDI_OUT is used. |
|---|
| 43 | |
|---|
| 44 | .TP |
|---|
| 45 | \fBerror\fR |
|---|
| 46 | This is a pointer to a integer used to store the error value in case of error. |
|---|
| 47 | This can be NULL if not used but it is very recommended to use this error value to report |
|---|
| 48 | good error messages to the user. |
|---|
| 49 | |
|---|
| 50 | .SH "RETURN VALUE" |
|---|
| 51 | On success these calls return a new VS object. On error, NULL is returned. |
|---|
| 52 | |
|---|
| 53 | .SH "EXAMPLES" |
|---|
| 54 | FIXME |
|---|
| 55 | |
|---|
| 56 | .SH "SEE ALSO" |
|---|
| 57 | \fBroar_vs_new\fR(3), |
|---|
| 58 | \fBroar_vs_new_from_file\fR(3), |
|---|
| 59 | \fBroar_vs_close\fR(3), |
|---|
| 60 | \fBroarvs\fR(7), |
|---|
| 61 | \fBlibroar\fR(7), |
|---|
| 62 | \fBRoarAudio\fR(7). |
|---|
| 63 | |
|---|
| 64 | .\" ll |
|---|
