File: afReadMisc.3

package info (click to toggle)
audiofile 0.3.4-2
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 4,192 kB
  • sloc: cpp: 31,691; sh: 11,006; ansic: 3,773; makefile: 271
file content (140 lines) | stat: -rw-r--r-- 3,200 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
'\" t
.\"     Title: afReadMisc
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\"      Date: 04/30/2012
.\"    Manual: \ \&
.\"    Source: Audio File Library 0.3.4
.\"  Language: English
.\"
.TH "AFREADMISC" "3" "04/30/2012" "Audio File Library 0\&.3\&.4" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
afReadMisc, afWriteMisc, afSeekMisc \- access miscellaneous metadata in an audio file
.SH "SYNOPSIS"
.sp
.nf
#include <audiofile\&.h>
.fi
.sp
.nf
int afReadMisc (AFfilehandle file, int miscid, void *buffer, int nbytes);
.fi
.sp
.nf
int afWriteMisc (AFfilehandle file, int miscid, const void *buffer, int nbytes);
.fi
.sp
.nf
int afSeekMisc (AFfilehandle file, int miscid, int offbytes);
.fi
.SH "DESCRIPTION"
.sp
afReadMisc reads up to \fInbytes\fR from the miscellaneous data chunk identified by \fImiscid\fR in \fIfile\fR\&.
.sp
afWriteMisc writes up to \fInbytes\fR to the miscellaneous data chunk identified by \fImiscid\fR in \fIfile\fR\&.
.sp
afSeekMisc changes the current offset within the miscellaneous data chunk identified by \fImiscid\fR to the offset \fIoffbytes\fR\&.
.SH "RETURN VALUE"
.sp
afReadMisc returns the number of bytes read from the specified miscellaneous chunk into the buffer referred to by \fIbuffer\fR\&.
.sp
afWriteMisc returns the number of bytes written to the specified miscellaneous chunk from the buffer referred to by \fIbuffer\fR\&.
.sp
afSeekMisc returns the new location of the logical data pointer as measured as an offset in bytes from the beginning of the miscellaneous chunk\(cqs data area\&.
.SH "ERRORS"
.sp
afReadMisc, afWriteMisc, and afSeekMisc can produce the following error codes:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

AF_BAD_READ
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

AF_BAD_WRITE
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

AF_BAD_MISCSEEK
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

AF_BAD_MISCID
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

AF_BAD_TRACKID
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

AF_BAD_FILEHANDLE
.RE
.SH "AUTHOR"
.sp
Michael Pruett <michael@68k\&.org>