Line | |
---|
1 | .TH "roar_vs_role" "3" "May 2011" "RoarAudio" "RoarAudio Programmer's Manual" |
---|
2 | |
---|
3 | .SH NAME |
---|
4 | roar_vs_role \- Update role for a stream |
---|
5 | |
---|
6 | .SH SYNOPSIS |
---|
7 | |
---|
8 | #include <roaraudio.h> |
---|
9 | |
---|
10 | int roar_vs_role (roar_vs_t * vss, int role, int * error); |
---|
11 | |
---|
12 | .SH "DESCRIPTION" |
---|
13 | This function updates the role of the stream. |
---|
14 | This should be done before any read or write operation and can be used |
---|
15 | at any time to update the meta data. |
---|
16 | |
---|
17 | .SH "PARAMETERS" |
---|
18 | .TP |
---|
19 | \fBvss\fR |
---|
20 | The VS object to be updated. |
---|
21 | |
---|
22 | .TP |
---|
23 | \fBrole\fR |
---|
24 | The new role of the stream. |
---|
25 | |
---|
26 | .TP |
---|
27 | \fBerror\fR |
---|
28 | This is a pointer to a integer used to store the error value in case of error. |
---|
29 | This can be NULL if not used but it is very recommended to use this error value to report |
---|
30 | good error messages to the user. |
---|
31 | |
---|
32 | .SH "RETURN VALUE" |
---|
33 | On success these calls return 0. On error, \-1 is returned. |
---|
34 | |
---|
35 | .SH "EXAMPLES" |
---|
36 | |
---|
37 | struct roar_keyval kv[2] = { |
---|
38 | {.key = "TITLE", .value = "Some title"}, |
---|
39 | {.key = "ARTIST", .value = "Some artist"} |
---|
40 | }; |
---|
41 | ret = roar_vs_meta(vss, &kv, 2, &err); |
---|
42 | |
---|
43 | .SH "SEE ALSO" |
---|
44 | \fBroarvs\fR(7), |
---|
45 | \fBlibroar\fR(7), |
---|
46 | \fBRoarAudio\fR(7). |
---|
47 | |
---|
48 | .\" ll |
---|
Note: See
TracBrowser
for help on using the repository browser.