/usr/share/doc/libaudiofile-dev/afSeekFrame.3 is in libaudiofile-dev 0.3.3-2.
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 | '\" t
.\" Title: afSeekFrame
.\" 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 "AFSEEKFRAME" "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"
afSeekFrame, afTellFrame \- update or access the current sample frame position for a track in an audio file
.SH "SYNOPSIS"
.sp
.nf
#include <audiofile\&.h>
.fi
.sp
.nf
AFframecount afSeekFrame (AFfilehandle file, int track,
AFframecount frameoffset);
.fi
.sp
.nf
AFframecount afTellFrame (AFfilehandle file, int track);
.fi
.SH "DESCRIPTION"
.sp
afSeekFrame moves the logical file pointer for a specified audio track to a desired sample frame location\&.
.sp
afTellFrame retrieves current value of a file read or write pointer\&.
.SH "PARAMETERS"
.sp
\fIfile\fR is a valid audio file handle created by \fBafOpenFile\fR(3)\&.
.sp
\fItrack\fR is an integer which refers to an audio track within a file\&. The constant AF_DEFAULT_TRACK should always be used for this parameter for all currently supported audio file formats\&.
.sp
\fIframeoffset\fR is a sample frame offset\&. Valid sample frame offsets must be greater than or equal to zero and strictly less than the number of sample frames contained within the specified audio track\&. If frameoffset is \-1, afSeekFrame will not modify the current file offset and will instead return the current frame\&.
.SH "RETURN VALUE"
.sp
On success, afSeekFrame and afTellFrame will return the current file pointer location as measured in sample frames from the start of the audio track\&.
.SH "ERRORS"
.sp
The following error could be generated by afSeekFrame or afTellFrame:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
AF_BAD_LSEEK
.RE
.SH "AUTHOR"
.sp
Michael Pruett <michael@68k\&.org>
|