NAME

afOpenFile - open an audio file and create a file handle structure used for subsequent calls to the Audio File Library

SYNOPSIS

#include <audiofile.h>

AFfilehandle afOpenFile(const char *path, const char *mode,
    AFfilesetup setup);

PARAMETERS

path is the path to the file to be opened.

mode specifies a mode for opening the file: "r" for reading or "w" for writing.

setup is an AFfilesetup created by afNewFileSetup(3). This value is ignored for files opened for reading except when the file format is AF_FILE_RAWDATA.

RETURN VALUE

Upon success, afOpenFile returns a valid AFfilehandle which can be used in subsequent calls to the Audio File Library. Upon failure, afOpenFile returns NULL and generates an error.

afCloseFile(3) is used to close the file when it is no longer needed.

ERRORS

afOpenFile can produce the following errors:

AF_BAD_OPEN

AF_BAD_READ

AF_BAD_WRITE

AF_BAD_LSEEK

AF_BAD_MALLOC

AF_BAD_FILEFMT

AF_BAD_SAMPFMT

AF_BAD_WIDTH

AF_BAD_RATE

AF_BAD_CHANNELS

AF_BAD_FILESETUP

SEE ALSO

afCloseFile(3), afNewFileSetup(3), afInitFileFormat(3), afInitSampleFormat(3), afReadFrames(3), afWriteFrames(3)

AUTHOR

Michael Pruett <michael@68k.org>