AuReadElement(3x)

AuReadElement3x

Read data from an exportclient element in a flow

Usage

#include <audio/audiolib.h>

void AuReadElement(server, flow, element, num_bytes, data, status)

AuServer *server;

AuFlowID flow;

int element;

AuUint32 num_bytes;

AuPointer data;

AuStatus *status; /* RETURN */

Arguments

server

Specifies the connection to the audio server.

flow

Specifies the ID of the flow.

element

Specifies the index of the ExportClient element to read the data from.

num_bytes

Specifies the number of bytes of audio data to read.

data

Specifies the buffer to read the audio data into.

status

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

Overview

AuReadElement transfers audio data from the server to the client application, reading num_bytes from the ExportClient specified by element in audio flow flow into data.

Note

If the flow is "trivial" (consisting only of an ExportClient and an ImportBucket), the num_samples fields in the ExportClient and ImportBucket are ignored.

Errors

AuBadFlow, AuBadElement.

Releases

4 releases since Debian 1.1 (Buzz); the text changed 1 time.

  1. 1.1–1.3
  2. 2.0

From nas 1.2p5-3 in Debian 2.0 (Hamm). Parsed by carta from the page's man source.