MAN page from OpenSuSE audiofile-doc-0.3.6-1.1.x86_64.rpm

AFSETVIRTUALSAMPLEFO

Section: \ \& (3)
Updated: 03/06/2013
Index

NAME

afSetVirtualByteOrder, afSetVirtualChannels, afSetVirtualPCMMapping, afSetVirtualSampleFormat - set the virtual data format for a track in an audio file

SYNOPSIS

#include <audiofile.h>

int afSetVirtualByteOrder (AFfilehandle file, int track, int byteOrder);

int afSetVirtualChannels (AFfilehandle file, int track, int channels);

int afSetVirtualSampleFormat (AFfilehandle file, int track,    int sampleFormat, int sampleWidth);

int afSetVirtualPCMMapping (AFfilehandle file, int track,    double slope, double intercept, double minclip, double maxclip);

PARAMETERS

: •
fileis an AFfilehandle which refers to an open audio file and is usually created by afOpenFile.

: •
trackis an integer which identifies a particular track in an open audio file. The only valid track isAF_DEFAULT_TRACKfor all currently supported file formats.

: •
sampleFormatis an integer which denotes a virtual sample format. Valid values areAF_SAMPFMT_TWOSCOMP,AF_SAMPFMT_UNSIGNED,AF_SAMPFMT_FLOAT, andAF_SAMPFMT_DOUBLE.

: •
sampleWidthis a positive integer which specifies the number of bits in a sample.

: •
channelsis a positive integer which specifies the number of interleaved audio channels in the given audio track.

: •
byteOrderis an integer which specifies the virtual byte order of samples in the given audio track.byteOrdercan be eitherAF_BYTEORDER_BIGENDIANorAF_BYTEORDER_LITTLEENDIAN.

: •
slopeandinterceptare double-precision floating point values which indicate the audio data sample slope and zero-crossing value, respectively, for the given sample format.

: •
minclipandmaxclipare double-precision floating point values which indicates the minimum or maximum sample values to be returned. Any values less thanminclipwill be set tominclip, and any values greater thanmaxclipwill be set tomaxclip.

RETURN VALUE

These functions return 0 for success and -1 for failure.

AUTHOR

Michael Pruett <michaelAATT68k.org>

This document was created byman2html,using the manual pages.