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

FreeBSD Manual Pages

  
 
  

home | help 
AuBucketAttributes(3)	    Library Functions Manual	   AuBucketAttributes(3)

Name
     AuBucketAttributes - bucket attributes structure

Structures
     #include <audio/audiolib.h>

     typedef struct _AuBucketAttributes
     {
	 . . .
     }AuBucketAttributes;

Members
     Do  not  dereference  the	members  of the AuBucketAttributes structure di-
     rectly.  Instead use the access macros.

     ba is a pointer to a AuBucketAttributes structure.

     AuBucketValueMask(ba)
	       Accesses  the  AuMask  value  indicating  which	attributes   are
	       present.   This is a bitwise inclusive OR of these constants: Au-
	       CompCommonIDMask, AuCompCommonKindMask, AuCompCommonUseMask,  Au-
	       CompCommonFormatMask,  AuCompCommonNumTracksMask, AuCompCommonAc-
	       cessMask,    AuCompCommonDescriptionMask,    AuCompBucketSampleR-
	       ateMask, and AuCompBucketNumSamplesMask.

     AuBucketChangableMask(ba)
	       Accesses  the AuMask value indicating which of the attributes can
	       be changed.  This is a bitwise inclusive OR of  these  constants:
	       AuCompCommonIDMask,   AuCompCommonKindMask,  AuCompCommonUseMask,
	       AuCompCommonFormatMask,	 AuCompCommonNumTracksMask,   AuCompCom-
	       monAccessMask,  AuCompCommonDescriptionMask, AuCompBucketSampleR-
	       ateMask, and AuCompBucketNumSamplesMask.

     AuBucketIdentifier(ba)
	       Accesses the AuBucketID ID of the bucket.

     AuBucketKind(ba)
	       Accesses the int value indicating the kind of component.  Buckets
	       will always be AuComponentKindBucket.

     AuBucketUse(ba)
	       Accesses the AuMask value indicating what uses of the bucket  are
	       permitted.   This  is  a bitwise inclusive OR of these constants:
	       AuComponentUseImportMask and AuComponentUseExportMask.

     AuBucketFormat(ba)
	       Accesses the int value  indicating  the	audio  data  format  the
	       bucket  uses.   Currently, the following formats are defined: Au-
	       FormatULAW8, AuFormatLinearUnsigned8, AuFormatLinearSigned8,  Au-
	       FormatLinearSigned16MSB,  AuFormatLinearUnsigned16MSB,  AuFormat-
	       LinearSigned16LSB, and AuFormatLinearUnsigned16LSB.

     AuBucketNumTracks(ba)
	       Accesses the int value indicating the number of tracks the bucket
	       supports.

     AuBucketAccess(ba)
	       Accesses the AuMask value indicating what  kinds  of  access  the
	       bucket  allows.	 This  is  a  bitwise inclusive OR of these con-
	       stants: AuAccessImportMask, AuAccessExportMask,	AuAccessDestroy-
	       Mask, and AuAccessListMask.

     AuBucketDescription(ba)
	       Accesses  the AuString structure containing a textual description
	       of the bucket.

     AuBucketSampleRate(ba)
	       Accesses the unsigned int value indicating the sample rate of the
	       bucket.

     AuBucketNumSamples(ba)
	       Accesses the AuUint32 value indicating the number of samples  the
	       bucket contains.

Description
     The  AuBucketAttributes structure describes the server-local storage of au-
     dio data.

See Also
     AuGetBucketAttributes, AuListBuckets.

     audiolib - Network Audio System C Language Interface

audiolib - bucket attributes	      1.9.4		   AuBucketAttributes(3)

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

home | help