AuMakeElementImportClient (3)

Leading comments

$NCDId: @(#)AuMElImC.man,v 1.1 1994/09/27 00:32:04 greg Exp $
copyright 1994 Steven King

portions are
* Copyright 1993 Network Computing Devices, Inc.
*
* Permission to use, copy, modify, distribute, and sell this software and its
* documentation for any purpose is hereby granted without fee, provided that
* the above copyright notice appear in all copies and that both that
* copyright notice and this permission notice appear in supporting
* documentation, and that the name Network Computing...

(The comments found at the beginning of the groff file "man3/AuMakeElementImportClient.3nas".)

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 AuFormatLinearUnsigned16LSB.

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 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 AuMakeChangeStateAction, 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, AuMakeElementExportMonitor, AuMakeElementImportDevice, AuMakeElementImportBucket, AuMakeElementImportWaveForm, AuMakeElementMultiplyConstant, AuMakeElementSum.

audiolib - Network Audio System C Language Interface