File: afInitAESChannelDataTo.3

package info (click to toggle)
audiofile 0.3.6-2%2Bdeb8u2
  • links: PTS, VCS
  • area: main
  • in suites: jessie
  • size: 4,764 kB
  • ctags: 7,541
  • sloc: cpp: 36,525; sh: 11,090; ansic: 6,013; makefile: 442
file content (76 lines) | stat: -rw-r--r-- 2,744 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
'\" t
.\"     Title: afInitAESChannelDataTo
.\"    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 "AFINITAESCHANNELDATA" "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"
afInitAESChannelDataTo, afInitAESChannelData \- initialize AES non\-audio data in an audio file setup
.SH "SYNOPSIS"
.sp
.nf
#include <audiofile\&.h>
.fi
.sp
.nf
void afInitAESChannelDataTo(AFfilesetup setup, int track, int willHaveData);
void afInitAESChannelData(AFfilesetup setup, int track);
.fi
.SH "PARAMETERS"
.sp
setup is a valid file setup returned by \fBafNewFileSetup\fR(3)\&.
.sp
track specifies a track within the audio file setup\&. track is always AF_DEFAULT_TRACK for all currently supported file formats\&.
.sp
willHaveData is a boolean\-valued integer indicating whether AES non\-audio data will be present\&.
.SH "DESCRIPTION"
.sp
Given an AFfilesetup structure created with \fBafNewFileSetup\fR(3) and a track identified by track (AF_DEFAULT_TRACK for all currently supported file formats), afInitAESChannelDataTo initializes the track to contain or not contain AES non\-audio data\&. afInitAESChannelData behaves similarly but always initializes the track to contain AES non\-audio data\&.
.sp
Currently only AIFF and AIFF\-C file formats can store AES non\-audio data; this data is ignored in all other file formats\&.
.SH "ERRORS"
.sp
afInitAESChannelDataTo and afInitAESChannelData can produce the following errors:
.PP
AF_BAD_FILESETUP
.RS 4

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

track
represents an invalid track identifier\&.
.RE
.SH "SEE ALSO"
.sp
\fBafNewFileSetup\fR(3)
.SH "AUTHOR"
.sp
Michael Pruett <michael@68k\&.org>