AuWriteElement.3x - Man Page

AuWriteElement - write data to an ImportClient element in a flow

#include <audio/audiolib.h>

void AuWriteElement(server, flow, element, num_bytes, data, end_of_data, status)
   AuServer *server;
   AuFlowID flow;
   int element;
   AuUint32 num_bytes;
   AuPointer data;
   AuBool end_of_data;
   AuStatus *status; /* RETURN */

server

Specifies the connection to the audio server.

flow

Specifies the ID of the flow.

element

Specifies the index of the ImportClient element to write the data to.

num_bytes

Specifies the number of bytes of audio data to write.

data

Specifies the buffer to get the audio data from.

end_of_data

Specifies if this is the last write for this import.

status

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

AuWriteElement transfers audio data from the client application to the server, writing num_bytes from data to the ImportClient specified by element in the audio flow flow. If end_of_data is AuTrue, the ImportClient's eof flag will be set when the write is completed.

If the flow is "trivial" (consisting only of an ImportClient and an ExportBucket), the num_samples fields in the ImportClient and ExportBucket are ignored and a write past the end of the bucket will result in an AuBadLength error.

AuBadFlow, AuBadElement, AuBadValue, AuBadLength.

AuReadElement.

audiolib - Network Audio System C Language Interface

AuElement.3x(3), AuReadElement.3x(3).