AuListDevices (3)

Leading comments

$NCDId: @(#)AuListD.man,v 1.1 1994/09/27 00:30:20 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/AuListDevices.3nas".)

Name

AuListDevices - list devices

Synopsis

#include <audio/audiolib.h>

AuDeviceAttributes *AuListDevices(server, valuemask, attributes, ndevices, status)

    AuServer *server;

    AuMask valuemask;

    AuDeviceAttributes *attributes;

    int *ndevices; /* RETURN */

    AuStatus *status; /* RETURN */

Arguments

server

Specifies the connection to the audio server.

valuemask

Specifies which device attributes are defined in the attributes argument. This must be a bitwise inclusive OR of zero or more of these constants: AuCompCommonIDMask, AuCompCommonKindMask, AuCompCommonUseMask, AuCommonFormatMask, AuCommonNumTracksMask, AuCommonAccessMask, AuCommonDescriptionMask, AuCompDeviceMinSampleRateMask, AuCompDeviceMaxSampleRateMask, AuCompDeviceLocationMask, AuCompDeviceGainMask, AuCompDeviceLineModeMask, AuCompDeviceChildrenMask, or AuCompDeviceMasks. If valuemask is zero, the attributes are ignored and are not referenced.

attributes

Specifies the structure from which the values (as specified by the value mask) are to be taken.

ndevices

Returns the number of devices in the returned list.

status

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

Description

AuListDevices returns a list of devices whose attributes match those values in attributes specified by valuemask, or NULL, with ndevices set to 0, if there was an error. Use AuFreeDeviceList to release the memory in the list when its nolonger needed.

Errors

AuBadLength.

See Also

AuGetDeviceAttributes.

audiolib - Network Audio System C Language Interface