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

AuSoundPlay(3)						     Library Functions Manual						    AuSoundPlay(3)

Name
       AuSoundPlay - create a flow to play audio from any source.

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

       AuEventHandlerRec *AuSoundPlay(server, destination, volume, mode, sound_data, flow ,volume_mult_elem, monitor_element, status)
	   AuServer *server;
	   AuDeviceID destination;
	   AuFixedPoint volume;
	   int mode;
	   AuSoundDataPtr sound_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.

       destination
		 Specifies the device to output the audio data.

       volume	 Specifies the volume.

       mode	 Specifies the line mode for the output device.  Currently the following line modes are defined: AuDeviceOutputModeNone, AuDevice-
		 OutputModeSpeaker, AuDeviceOutputModeHeadphone, AuDeviceOutputModeLineOut.

       sound_data
		 Specifies the sound information.

       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
       AuSoundPlay creates a flow to play audio from any source on device and returns a pointer to the event handler created or NULL if there  was
       an error. The sound_data structure contains the necessary information about the audio format and the data handling function.

Errors
       AuBadDevice.

See Also
       AuSoundPlayFromBucket, AuSoundPlayFromData, AuSoundPlayFromFile, AuSoundPlaySynchronousFromFile.

       audiolib - Network Audio System C Language Interface

soundlib							       1.9.3							    AuSoundPlay(3)
Man Page