/usr/share/doc/libaudiofile-dev/afReadFrames.3 is in libaudiofile-dev 0.3.3-2ubuntu0.3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 | '\" t
.\" Title: afReadFrames
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 01/11/2012
.\" Manual: \ \&
.\" Source: Audio File Library 0.3.2
.\" Language: English
.\"
.TH "AFREADFRAMES" "3" "01/11/2012" "Audio File Library 0\&.3\&.2" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
afReadFrames \- read sample frames from a track in an audio file
.SH "SYNOPSIS"
.sp
.nf
#include <audiofile\&.h>
.fi
.sp
.nf
AFframecount afReadFrames(AFfilehandle file, int track, void *data,
int count);
.fi
.SH "DESCRIPTION"
.sp
afReadFrames attempts to read up to \fIcount\fR frames of audio data from the audio file handle \fIfile\fR into the buffer at \fIdata\fR\&.
.SH "PARAMETERS"
.sp
\fIfile\fR is a valid file handle returned by \fBafOpenFile\fR(3)\&.
.sp
\fItrack\fR is always AF_DEFAULT_TRACK for all currently supported file formats\&.
.sp
\fIdata\fR is a buffer of storing \fIcount\fR frames of audio sample data\&.
.sp
\fIcount\fR is the number of sample frames to be read\&.
.SH "RETURN VALUE"
.sp
afReadFrames returns the number of frames successfully read from \fIfile\fR\&.
.SH "ERRORS"
.sp
afReadFrames can produce these errors:
.PP
AF_BAD_FILEHANDLE
.RS 4
the file handle was invalid
.RE
.PP
AF_BAD_TRACKID
.RS 4
the track parameter is not
AF_DEFAULT_TRACK
.RE
.PP
AF_BAD_READ
.RS 4
reading audio data from the file failed
.RE
.PP
AF_BAD_LSEEK
.RS 4
seeking within the file failed
.RE
.SH "SEE ALSO"
.sp
\fBafWriteFrames\fR(3)
.SH "AUTHOR"
.sp
Michael Pruett <michael@68k\&.org>
|