table of contents
roar_vs_file(3) | RoarAudio Programmer's Manual | roar_vs_file(3) |
NAME¶
roar_vs_file, roar_vs_file_simple, roar_vs_new_from_file - File mode for VS APISYNOPSIS¶
#include <roaraudio.h>DESCRIPTION¶
These functions are used to open the VS object in file mode. In the file mode the VS API reads or writes the data from or to the file itself. The file mode uses normal VIO/DSTR so it supports streams as well. Just pass the stream URL as filename.PARAMETERS¶
- server
- The server to connect to. NULL for defaults.
- name
- The application name. This should be something the user can
use to identify the application. It MUST NOT be the application's binary
name or the value of argv[0].
- vio
- The VIO handle to be used by the file mode.
- closefile
- This parameter tells the file mode if the file should be
closed on roar_vio_close(3). Must be ROAR_VS_TRUE (common) or
ROAR_VS_FALSE.
- filename
- The filename used to open the file for file mode. The file
is opend using DSTR API. All kinds of files supported by DSTR are
supported. This includes HTTP streams.
- 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
recommended to use this error value to report good error messages to the
user.
RETURN VALUE¶
On success roar_vs_new_from_file() return a new VS object. On error, NULL is returned. roar_vs_file() and roar_vs_file_simple() returns 0 on success and -1 on error.EXAMPLES¶
roar_vs_t * vss;
int err;
vss = roar_vs_new_from_file(NULL, "MyApp", "http://...", &err);
if ( vss == NULL ) {
//handle error.
}
if ( roar_vs_run(vss, &err) == -1 ) {
//handle error.
}
if ( roar_vs_close(vss, ROAR_VS_FALSE, &err) == -1 ) {
//handle error.
}
SEE ALSO¶
roar_vs_new_simple(3), roar_vs_iterate(3), roar_vs_run(3), roar_vs_close(3), roarvs(7), libroar(7), RoarAudio(7).June 2011 | RoarAudio |