Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
AFOPENFILE(3)							 AFOPENFILE(3)

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
	   A call to open failed.

       AF_BAD_READ
	   A call to read failed

       AF_BAD_WRITE
	   A call to write failed.

       AF_BAD_LSEEK
	   A call to lseek failed.

       AF_BAD_MALLOC
	   Memory allocation failed.

       AF_BAD_FILEFMT

	   setup specifies a file format which is unsupported for mode.

       AF_BAD_SAMPFMT
	   The file's sample format is not supported.

       AF_BAD_WIDTH
	   The file's sample width is not supported.

       AF_BAD_RATE
	   The file's sample rate is not supported.

       AF_BAD_CHANNELS
	   The number of channels in the file is not supported.

       AF_BAD_FILESETUP

	   setup specifies an invalid or unsupported configuration.

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

AUTHOR
       Michael Pruett <michael@68k.org>

Audio File Library 0.3.6	  03/06/2013			 AFOPENFILE(3)

NAME | SYNOPSIS | PARAMETERS | RETURN VALUE | ERRORS | SEE ALSO | AUTHOR

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=afOpenFile&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help