afInitSampleFormat man page

afInitSampleFormat, afInitByteOrder, afInitChannels, afInitRate — initialize audio data format for a track in an audio file setup

Synopsis

#include <audiofile.h>
void afInitSampleFormat(AFfilesetup setup, int track, int sampleFormat,
    int sampleWidth);
void afInitByteOrder(AFfilesetup setup, int track, int byteOrder);
void afInitChannels(AFfilesetup setup, int track, int channels);
void afInitRate(AFfilesetup setup, int track, double rate);

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.

sampleFormat is a symbolic constant specifying the sample format for the audio data in the track. sampleFormat must be one of AF_SAMPFMT_TWOSCOMP, AF_SAMPFMT_UNSIGNED, AF_SAMPFMT_FLOAT, or AF_SAMPFMT_DOUBLE.

sampleWidth is a positive integer specifying the number of bits for each sample in the track.

byteOrder is a symbolic constant specifying the byte order of the track. byteOrder must be one of AF_BYTEORDER_BIGENDIAN or AF_BYTEORDER_LITTLEENDIAN.

channels is a positive integer specifying the number of channels in the track.

rate is a positive double-precision floating-point number specifying the sample rate of the track.

Description

afInitSampleFormat initializes the track to the specified sample format and sample width.

afInitByteOrder initializes the track to the specified byte order.

afInitChannels initializes the track to the specified number of channels.

afInitRate initializes the track to the specified sample rate.

Errors

afInitSampleFormat, afInitByteOrder, afInitChannels, and afInitRate can produce the following errors:

AF_BAD_FILESETUPsetup represents an invalid file setup.
AF_BAD_TRACKtrack represents an invalid track identifier.

afInitSampleFormat can also produce the following errors:

AF_BAD_SAMPFMTsampleFormat does not represent a valid sample format.
AF_BAD_WIDTHsampleWidth is not a valid sample width.

afInitByteOrder can also produce the following error:

AF_BAD_BYTEORDERbyteOrder does not represent a valid byte order.

afInitChannels can also produce the following error:

AF_BAD_CHANNELSchannels specifies an invalid number of channels.

afInitRate can also produce the following error:

AF_BAD_RATErate specifies an invalid sample rate.

See Also

afNewFileSetup(3), afInitFileFormat(3), afInitCompression(3), afOpenFile(3)

Author

Michael Pruett <michael@68k.org>

Referenced By

afInitCompression(3), afOpenFile(3).

afInitByteOrder(3), afInitChannels(3) and afInitRate(3) are aliases of afInitSampleFormat(3).

03/06/2013 Audio File Library 0.3.6