1AFREADFRAMES(3)                                                AFREADFRAMES(3)
2
3
4

NAME

6       afReadFrames - read sample frames from a track in an audio file
7

SYNOPSIS

9       #include <audiofile.h>
10
11       AFframecount afReadFrames(AFfilehandle file, int track, void *data,
12           int count);
13

DESCRIPTION

15       afReadFrames attempts to read up to count frames of audio data from the
16       audio file handle file into the buffer at data.
17

PARAMETERS

19       file is a valid file handle returned by afOpenFile(3).
20
21       track is always AF_DEFAULT_TRACK for all currently supported file
22       formats.
23
24       data is a buffer of storing count frames of audio sample data.
25
26       count is the number of sample frames to be read.
27

RETURN VALUE

29       afReadFrames returns the number of frames successfully read from file.
30

ERRORS

32       afReadFrames can produce these errors:
33
34       AF_BAD_FILEHANDLE
35           the file handle was invalid
36
37       AF_BAD_TRACKID
38           the track parameter is not AF_DEFAULT_TRACK
39
40       AF_BAD_READ
41           reading audio data from the file failed
42
43       AF_BAD_LSEEK
44           seeking within the file failed
45

SEE ALSO

47       afWriteFrames(3)
48

AUTHOR

50       Michael Pruett <michael@68k.org>
51
52
53
54Audio File Library 0.3.6          03/06/2013                   AFREADFRAMES(3)