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
AuElementNotifyEvent(3) Library Functions Manual AuElementNotifyEvent(3) Name AuElementNotifyEvent - element notify event structure Structures #include <audio/audiolib.h> typedef union _AuEvent { . . . AuElementNotifyEvent auelementnotify; . . . }AuEvent; typedef struct _AuElementNotifyEvent { int type; AuUint32 serial; AuBool send_event; AuServer *server; AuTime time; AuFlowID flow; unsigned char element_num; unsigned char kind; unsigned char prev_state; unsigned char cur_state; unsigned char reason; AuUint32 num_bytes; }AuElementNotifyEvent; Members type The event type. ElementNotify events are type AuEventTypeElementNotify. serial The serial ID of the event expanded from the 16 bit value sent by the server. send_event AuTrue if the event came from a SendEvent protocol request. server The connection to the audio server that the event was read from. time The server time in milliseconds when the event was generated. flow The ID of the flow that caused the event. element_num The index of the element that caused the event or AuElementAll to indicate the flow. kind The kind of notify event. This will be one of these constants: AuElementNotifyKindLowWater, AuElementNotifyKindHighWater, or AuElementNotifyKindState. prev_state The previous state of the element indexed by element_num. This will be one of these constants: AuStateStop, AuStateStart, or AuStatePause. cur_state The current state of the element indexed by element_num. This will be one of these constants: AuStateStop, AuStateStart, or AuS- tatePause. reason The reason for the notify event. This will be one of these constants: AuReasonUser, AuReasonUnderrun, AuReasonOverrun, AuReaso- nEOF, AuReasonWatermark, or AuReasonHardware. num_bytes The number of bytes to send or receive. Only valid if the the element indexed by element_num is an ImportClient or ExportClient. Description ElementNotify events are sent to client applications to notify them of a watermark condition or state change. If kind is AuElementNoti- fyKindLowWater, the ImportClient element indexed by element_num in flow is ready to receive num_bytes of audio data from the client appli- cation. If kind is AuElementNotifyKindHighWater, the ExportClient element indexed by element_num in flow is ready to send num_bytes of audio data to the client application. If kind is AuElementNotifyKindState, the element indexed by element_num (or flow if element_num is AuElementAll) has made a state transition from prev_state to cur_state triggering the event. Reguardless of kind, prev_state and cur_state contain the old and new states and reason contains the reason for the event. See Also AuAnyEvent, AuErrorEvent, AuGrabNotifyEvent, AuMakeSendNotifyAction, AuMonitorNotifyEvent. audiolib - Network Audio System C Language Interface audiolib - events 1.9.3 AuElementNotifyEvent(3)