source: roaraudio/doc/man3/roar_vs_meta.3 @ 5050:ac5ec473f00c

Last change on this file since 5050:ac5ec473f00c was 5050:ac5ec473f00c, checked in by phi, 13 years ago

added manpage for roar_vs_meta() and roar_vs_role()

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