Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
AFSETVIRTUALSAMPLEFO(3) 				 AFSETVIRTUALSAMPLEFO(3)

NAME
     afSetVirtualByteOrder,  afSetVirtualChannels,  afSetVirtualPCMMapping,  af-
     SetVirtualSampleFormat - set the virtual data format for a track in an  au-
     dio 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
     *	  file is an AFfilehandle which refers to an open audio file and is usu-
	 ally created by afOpenFile.

     *	  track is an integer which identifies a particular track in an open au-
	 dio  file.  The  only valid track is AF_DEFAULT_TRACK for all currently
	 supported file formats.

     *	  sampleFormat is an integer which  denotes  a	virtual  sample  format.
	 Valid	   values    are    AF_SAMPFMT_TWOSCOMP,    AF_SAMPFMT_UNSIGNED,
	 AF_SAMPFMT_FLOAT, and AF_SAMPFMT_DOUBLE.

     *	  sampleWidth is a positive integer which specifies the number	of  bits
	 in a sample.

     *	   channels  is  a positive integer which specifies the number of inter-
	 leaved audio channels in the given audio track.

     *	  byteOrder is an integer which specifies the virtual byte order of sam-
	 ples in the given  audio  track.   byteOrder  can  be	either	AF_BYTE-
	 ORDER_BIGENDIAN or AF_BYTEORDER_LITTLEENDIAN.

     *	   slope  and intercept are double-precision floating point values which
	 indicate the audio data sample slope and zero-crossing  value,  respec-
	 tively, for the given sample format.

     *	   minclip  and maxclip are double-precision floating point values which
	 indicates the minimum or maximum sample values to be returned. Any val-
	 ues less than minclip will be set to minclip, and  any  values  greater
	 than maxclip will be set to maxclip.

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

AUTHOR
     Michael Pruett <michael@68k.org>

Audio File Library 0.3.6	   03/06/2013		 AFSETVIRTUALSAMPLEFO(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=afSetVirtualByteOrder&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help