aulistbuckets(3) [debian man page]

AuListBuckets(3)					     Library Functions Manual						  AuListBuckets(3)

Name
       AuListBuckets - list buckets

Synopsis
       #include <audio/audiolib.h>

       AuBucketAttributes *AuListBuckets(server, valuemask, attributes, nbuckets, status)
	   AuServer *server;
	   AuMask valuemask;
	   AuBucketAttributes *attributes;
	   int *nbuckets; /* RETURN */
	   AuStatus *status; /* RETURN */

Arguments
       server	 Specifies the connection to the audio server.

       valuemask Specifies  which  bucket attributes are defined in attributes.  This must be a bitwise inclusive OR of zero or more of these con-
		 stants: AuCompCommonIDMask, AuCompCommonKindMask, AuCompCommonUseMask, AuCommonFormatMask, AuCommonNumTracksMask, AuCommonAccess-
		 Mask,	AuCommonDescriptionMask,  AuCompBucketSampleRateMask, or AuCompBucketNumSamplesMask.  If valuemask is zero, the attributes
		 are ignored and are not referenced.

       attributes
		 Specifies the structure from which the values (as specified by the value mask) are to be taken.

       nbuckets  Returns the number of buckets in the returned list.

       status	 If non-NULL, flush the output buffer and return the status from the server.

Description
       AuListBuckets returns a list of buckets whose attributes match those values in attributes specified by valuemask, or  NULL,  with  nbuckets
       set to 0, if there was an error.  Use AuFreeBucketAttributes to free the list when its nolonger needed.

Errors
       AuBadLength.

See Also
       AuGetBucketAttributes.

       audiolib - Network Audio System C Language Interface

audiolib - bucket attributes					       1.9.3							  AuListBuckets(3)

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 directly.  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: AuCompCom-
		 monIDMask, AuCompCommonKindMask, AuCompCommonUseMask, AuCompCommonFormatMask, AuCompCommonNumTracksMask,  AuCompCommonAccessMask,
		 AuCompCommonDescriptionMask, AuCompBucketSampleRateMask, 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, AuCompCommonAc-
		 cessMask, AuCompCommonDescriptionMask, AuCompBucketSampleRateMask, 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: AuFormat-
		 ULAW8,  AuFormatLinearUnsigned8,  AuFormatLinearSigned8,  AuFormatLinearSigned16MSB, AuFormatLinearUnsigned16MSB, AuFormatLinear-
		 Signed16LSB, 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	constants:
		 AuAccessImportMask, AuAccessExportMask, AuAccessDestroyMask, 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 audio data.

See Also
       AuGetBucketAttributes, AuListBuckets.

       audiolib - Network Audio System C Language Interface

audiolib - bucket attributes					       1.9.3						     AuBucketAttributes(3)