.TH "roar_vs_role" "3" "May 2011" "RoarAudio" "RoarAudio Programmer's Manual"

.SH NAME
roar_vs_role \- Update role for a stream

.SH SYNOPSIS

#include <roaraudio.h>

int     roar_vs_role          (roar_vs_t * vss, int role, int * error);

.SH "DESCRIPTION"
This function updates the role of the stream.
This should be done before any read or write operation and can be used
at any time to update the meta data.

.SH "PARAMETERS"
.TP
\fBvss\fR
The VS object to be updated.

.TP
\fBrole\fR
The new role of the stream.

.TP
\fBerror\fR
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.

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

.SH "EXAMPLES"

 struct roar_keyval kv[2] = {
  {.key = "TITLE",  .value = "Some title"},
  {.key = "ARTIST", .value = "Some artist"}
 };
 ret = roar_vs_meta(vss, &kv, 2, &err);

.SH "SEE ALSO"
\fBroarvs\fR(7),
\fBlibroar\fR(7),
\fBRoarAudio\fR(7).

.\" ll