File: afInitFileFormat.3

package info (click to toggle)
audiofile 0.3.6-7
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,980 kB
  • sloc: cpp: 36,534; sh: 11,090; ansic: 6,060; makefile: 439
file content (140 lines) | stat: -rw-r--r-- 2,847 bytes parent folder | download | duplicates (6)
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
'\" t
.\"     Title: afInitFileFormat
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: 03/06/2013
.\"    Manual: \ \&
.\"    Source: Audio File Library 0.3.6
.\"  Language: English
.\"
.TH "AFINITFILEFORMAT" "3" "03/06/2013" "Audio File Library 0\&.3\&.6" "\ \&"
.\" -----------------------------------------------------------------
.\" * 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"
afInitFileFormat \- initialize file format of an audio file setup
.SH "SYNOPSIS"
.sp
.nf
#include <audiofile\&.h>
.fi
.sp
.nf
void afInitFileFormat(AFfilesetup setup, int fileFormat);
.fi
.SH "PARAMETERS"
.sp
setup is a valid file setup created by \fBafNewFileSetup\fR(3)\&.
.sp
fileFormat is an integer constant specifying a file format\&.
.SH "DESCRIPTION"
.sp
Given an AFfilesetup structure created with \fBafNewFileSetup\fR(3), afInitFileFormat initializes the file format to that specified by fileFormat\&.
.sp
The following file formats are currently supported:
.PP
AF_FILE_RAWDATA
.RS 4
raw audio data
.RE
.PP
AF_FILE_AIFF
.RS 4
Audio Interchange File Format
.RE
.PP
AF_FILE_AIFFC
.RS 4
Audio Interchange File Format AIFF\-C
.RE
.PP
AF_FILE_NEXTSND
.RS 4
NeXT \&.snd/Sun \&.au
.RE
.PP
AF_FILE_WAVE
.RS 4
Microsoft RIFF WAVE
.RE
.PP
AF_FILE_BICSF
.RS 4
Berkeley/IRCAM/CARL Sound File
.RE
.PP
AF_FILE_AVR
.RS 4
Audio Visual Research
.RE
.PP
AF_FILE_IFF_8SVX
.RS 4
Amiga IFF/8SVX
.RE
.PP
AF_FILE_SAMPLEVISION
.RS 4
Sample Vision
.RE
.PP
AF_FILE_VOC
.RS 4
Creative Voice File
.RE
.PP
AF_FILE_NIST_SPHERE
.RS 4
NIST SPHERE
.RE
.PP
AF_FILE_CAF
.RS 4
Core Audio Format
.RE
.SH "ERRORS"
.sp
afInitFileFormat can produce the following errors:
.PP
AF_BAD_FILESETUP
.RS 4

setup
represents an invalid file setup\&.
.RE
.PP
AF_BAD_FILEFMT
.RS 4

fileFormat
represents an unknown file format\&.
.RE
.PP
AF_BAD_NOT_IMPLEMENTED
.RS 4

fileFormat
represents a file format which is not currently implemented\&.
.RE
.SH "SEE ALSO"
.sp
\fBafNewFileSetup\fR(3)
.SH "AUTHOR"
.sp
Michael Pruett <michael@68k\&.org>