Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

auelement(3) [debian 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)

Check Out this Related Man Page

AuSoundPlayFromData(3)					     Library Functions Manual					    AuSoundPlayFromData(3)

Name
       AuSoundPlayFromData - create a flow to play from memory.

Synopsis
       #include <audio/audiolib.h>
       #include <audio/soundlib.h>

       AuEventHandlerRec  *AuSoundPlayFromData(server,	sound,	data,  destination, volume, callback, callback_data, flow, volume_mult_elem, moni-
       tor_element, status)
	   AuServer *server;
	   Sound sound;
	   AuPointer data;
	   AuDeviceID destination;
	   AuFixedPoint volume;
	   void (*callback) (AuServer *, AuEventHandlerRec *, AuEvent *, AuPointer);
	   AuPointer callback_data;
	   AuFlowID *flow; /* RETURN */
	   int *volume_mult_elem; /* RETURN */
	   int *monitor_element; /* RETURN */
	   AuStatus *status; /* RETURN */

Arguments
       server	 Specifies the connection to the audio server.

       sound	 Specifies the description of the audio data.

       data	 Specifies the audio data to play.

       destination
		 Specifies the device to play the data on.

       volume	 Specifies the volume.

       callback  Specifies the procedure to be called for additional event processing.

       callback_data
		 Specifies any additional arguments to be passed the callback.

       flow	 If non-NULL, returns the flow ID.

       volume_mult_elem
		 If non-NULL, returns the index of the volume multipler element.

       monitor_element
		 If non-NULL, include an ExportMonitor element in the flow and return it's index.

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

Description
       AuSoundPlayFromData creates a flow to play data on device and returns a pointer to the event handler created or NULL if there was an error.

Errors
       AuBadAlloc, AuBadDevice.

See Also
       AuSoundPlay, AuSoundPlayFromBucket, AuSoundPlayFromFile, AuSoundPlaySynchronousFromFile.

       audiolib - Network Audio System C Language Interface

soundlib							       1.9.3						    AuSoundPlayFromData(3)
Man Page