afReadFrames man page

afReadFrames — read sample frames from a track in an audio file

Synopsis

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

Description

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

Parameters

file is a valid file handle returned by afOpenFile(3).

track is always AF_DEFAULT_TRACK for all currently supported file formats.

data is a buffer of storing count frames of audio sample data.

count is the number of sample frames to be read.

Return Value

afReadFrames returns the number of frames successfully read from file.

Errors

afReadFrames can produce these errors:

AF_BAD_FILEHANDLE

the file handle was invalid

AF_BAD_TRACKID

the track parameter is not AF_DEFAULT_TRACK

AF_BAD_READ

reading audio data from the file failed

AF_BAD_LSEEK

seeking within the file failed

See Also

afWriteFrames(3)

Author

Michael Pruett <michael@68k.org>

Referenced By

afOpenFile(3), afWriteFrames(3).

03/06/2013 Audio File Library 0.3.6