afInitAESChannelData (3)

Leading comments

    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

(The comments found at the beginning of the groff file "man3/afInitAESChannelData.3".)

NAME

afInitAESChannelDataTo, afInitAESChannelData - initialize AES non-audio data in an audio file setup

SYNOPSIS

#include <audiofile.h>

void afInitAESChannelDataTo(AFfilesetup setup, int track, int willHaveData);
void afInitAESChannelData(AFfilesetup setup, int track);

PARAMETERS

setup is a valid file setup returned by afNewFileSetup(3).

track specifies a track within the audio file setup. track is always AF_DEFAULT_TRACK for all currently supported file formats.

willHaveData is a boolean-valued integer indicating whether AES non-audio data will be present.

DESCRIPTION

Given an AFfilesetup structure created with afNewFileSetup(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.

Currently only AIFF and AIFF-C file formats can store AES non-audio data; this data is ignored in all other file formats.

ERRORS

afInitAESChannelDataTo and afInitAESChannelData can produce the following errors:

AF_BAD_FILESETUP

setup represents an invalid file setup.

AF_BAD_TRACKID

track represents an invalid track identifier.

SEE ALSO

afNewFileSetup(3)

AUTHOR

Michael Pruett <michael@68k.org>