File: afReadMisc.3.txt

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 (55 lines) | stat: -rw-r--r-- 1,453 bytes parent folder | download | duplicates (7)
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
afReadMisc(3)
=============

NAME
----
afReadMisc, afWriteMisc, afSeekMisc - access miscellaneous metadata in an audio file

SYNOPSIS
--------
  #include <audiofile.h>

  int afReadMisc (AFfilehandle file, int miscid, void *buffer, int nbytes);

  int afWriteMisc (AFfilehandle file, int miscid, const void *buffer, int nbytes);

  int afSeekMisc (AFfilehandle file, int miscid, int offbytes);

DESCRIPTION
-----------
`afReadMisc` reads up to 'nbytes' from the miscellaneous data chunk
identified by 'miscid' in 'file'.

`afWriteMisc` writes up to 'nbytes' to the miscellaneous data chunk
identified by 'miscid' in 'file'.

`afSeekMisc` changes the current offset within the miscellaneous data
chunk identified by 'miscid' to the offset 'offbytes'.

RETURN VALUE
------------
`afReadMisc` returns the number of bytes read from the specified
miscellaneous chunk into the buffer referred to by 'buffer'.

`afWriteMisc` returns the number of bytes written to the specified
miscellaneous chunk from the buffer referred to by 'buffer'.

`afSeekMisc` returns the new location of the logical data pointer as
measured as an offset in bytes from the beginning of the miscellaneous
chunk's data area.

ERRORS
------
`afReadMisc`, `afWriteMisc`, and `afSeekMisc` can produce the following
error codes:

* `AF_BAD_READ`
* `AF_BAD_WRITE`
* `AF_BAD_MISCSEEK`
* `AF_BAD_MISCID`
* `AF_BAD_TRACKID`
* `AF_BAD_FILEHANDLE`

AUTHOR
------
Michael Pruett <michael@68k.org>