Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

aubucketattributes(3) [debian man page]

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)

Check Out this Related Man Page

AuElement(3)						     Library Functions Manual						      AuElement(3)

Name
       AuElement - AuElement union

Structures
       #include <audio/audiolib.h>

       typedef union _AuElement
       {
	   unsigned short type;
	   AuElementImportClient importclient;
	   AuElementImportDevice importdevice;
	   AuElementImportBucket importbucket;
	   AuElementImportWaveForm importwaveform;
	   AuElementBundle bundle;
	   AuElementMultiplyConstant multiplyconstant;
	   AuElementAddConstant addconstant;
	   AuElementSum sum;
	   AuElementExportClient exportclient;
	   AuElementExportDevice exportdevice;
	   AuElementExportBucket exportbucket;
	   AuElementExportMonitor exportmonitor;
       }AuElement;

Members
       type	 Specifies  the  element type.	Currently, one of these constants: AuElementTypeAddConstant, AuElementTypeBundle, AuElementTypeEx-
		 portBucket, AuElementTypeExportClient, AuElementTypeExportDevice, AuElementTypeExportMonitor,	AuElementTypeImportClient,  AuEle-
		 mentTypeImportDevice, AuElementTypeImportBucket, AuElementTypeImportWaveForm, AuElementTypeMultiplyConstant, or AuElementTypeSum.

       importclient
		 Used to read audio data from a client application.

       importdevice
		 Used to read audio data from a device.

       importbucket
		 Used to read audio data from a bucket.

       importwaveform
		 Used to read audio data from a waveform generator.

       bundle	 Used to access tracks in audio data.

       multiplyconstant
		 Used to scale the value of samples in audio data.

       addconstant
		 Used to offset the value of samples in audio data.

       sum	 Used to merge together samples from different inputs.

       exportclient
		 Used to write audio data to a client application.

       exportdevice
		 Used to write audio data to a device.

       exportbucket
		 Used to write audio data to a bucket.

       exportmonitor
		 Used to write monitor data to a client application.

Description
       Elements are instructions to the server on how to handle the audio data in a flow.

See Also
       AuMakeElementAddConstant,  AuMakeElementBundle, AuMakeElementImportClient, AuMakeElementImportDevice, AuMakeElementImportBucket, AuMakeEle-
       mentImportWaveForm, AuMakeElementExportClient, AuMakeElementExportDevice, AuMakeElementExportBucket, AuMakeElementExportMonitor, AuMakeEle-
       mentMultiplyConstant, AuMakeElementSum, AuReadElement, AuSetElements, AuSetElementParameters, AuWriteElement.

       audiolib - Network Audio System C Language Interface

audiolib - element union					       1.9.3							      AuElement(3)
Man Page