Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

aumakeelementimportclient(3) [debian man page]

AuMakeElementImportClient(3)				     Library Functions Manual				      AuMakeElementImportClient(3)

Name
       AuMakeElementImportClient - initialize an ImportClient element

Synopsis
       #include <audio/audiolib.h>

       AuMakeElementImportClient(element, sample_rate, format, num_tracks, discard, max_samples, low_water_mark, num_actions, actions)
	   AuElement *element; /* RETURN */
	   unsigned short sample_rate;
	   unsigned char format;
	   unsigned char num_tracks;
	   unsigned char discard;
	   AuUint32 max_samples;
	   AuUint32 low_water_mark;
	   int num_actions;
	   AuElementAction *actions;

Arguments
       element	 Returns the initialized element.

       sample_rate
		 Specifies the sample rate of the audio data.

       format	 Specifies  the  format  of the audio data.  Currently, the following formats are defined: AuFormatULAW8, AuFormatLinearUnsigned8,
		 AuFormatLinearSigned8, AuFormatLinearSigned16MSB, AuFormatLinearUnsigned16MSB, AuFormatSignedLinear16LSB,  and  AuFormatLinearUn-
		 signed16LSB.

       num_tracks
		 Specifies the number of tracks in the audio data.

       discard	 Specifies if the import should be paused initally.  Normally AuTrue.  AuFalse may crash the server.

       max_samples
		 Specifies the maximum number of samples to accept in a single read.  Ignored for "trivial" flows.

       low_water_mark
		 Specifies when to request additional audio data from the client application.  When this number of samples are left in the buffer,
		 and an EOF hasn't been received, a NotifyEvent with kind set to AuElementNotifyKindLowWater will be sent to the  client  applica-
		 tion.

       num_actions
		 Specifies the number of actions in actions.

       actions	 Specifies  the list of actions to associate with this element.  Entries in this list can be initialized with AuMakeChangeStateAc-
		 tion, AuMakeSendNotifyAction, and AuMakeNoopAction.  May be NULL.

Description
       AuMakeElementImportClient sets the type of element to AuElementTypeImportClient and initializes the importclient member of element with the
       remaining arguments.

       AuMakeElementImportClient is implemented as a macro.

See Also
       AuMakeElementAddConstant,  AuMakeElementBundle, AuMakeElementExportClient, AuMakeElementExportDevice, AuMakeElementExportBucket, AuMakeEle-
       mentExportMonitor, AuMakeElementImportDevice, AuMakeElementImportBucket, AuMakeElementImportWaveForm, AuMakeElementMultiplyConstant,  AuMa-
       keElementSum.

       audiolib - Network Audio System C Language Interface

audiolib - element initialization				       1.9.3					      AuMakeElementImportClient(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