Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

aumakeelementexportclient(3) [debian man page]

AuMakeElementExportClient(3)				     Library Functions Manual				      AuMakeElementExportClient(3)

Name
       AuMakeElementExportClient - initialize an ExportClient element

Synopsis
       #include <audio/audiolib.h>

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

Arguments
       element	 Returns the initialized element.

       input	 Specifies the index of the element to supply the audio data to this 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 flow should pause initially.	Normally AuTrue.

       max_samples
		 Specifies the maximum number of samples to send to the client in a single write.  Ignored for "trivial" flows.

       high_water_mark
		 Specifies  when to tell the client application to read the audio data from the server.  When this number of samples is reached in
		 the buffer, an ElementNotify event with kind set to AuElementNotifyKindHighWater will be sent to the client application.

       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
       AuMakeElementExportClient  sets	the type member of element to AuElementTypeExportClient and initializes the exportclient member of element
       with the remaining arguments.

       AuMakeElementExportClient is implemented as a macro.

See Also
       AuElementNotifyEvent, AuMakeElementAddConstant, AuMakeElementBundle, AuMakeElementExportBucket, AuMakeElementExportDevice, AuMakeElementEx-
       portMonitor,  AuMakeElementImportBucket,  AuMakeElementImportClient, AuMakeElementImportDevice, AuMakeElementImportWaveForm, AuMakeElement-
       MultiplyConstant, AuMakeElementSum.

       audiolib - Network Audio System C Language Interface

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