3
$NCDId: @(#)AuDAttr.man,v 1.1 1994/09/27 00:25:12 greg Exp $
4
Copyright 1994 Steven King
7
* Copyright 1993 Network Computing Devices, Inc.
9
* Permission to use, copy, modify, distribute, and sell this software and its
10
* documentation for any purpose is hereby granted without fee, provided that
11
* the above copyright notice appear in all copies and that both that
12
* copyright notice and this permission notice appear in supporting
13
* documentation, and that the name Network Computing Devices, Inc. not be
14
* used in advertising or publicity pertaining to distribution of this
15
* software without specific, written prior permission.
17
* THIS SOFTWARE IS PROVIDED 'AS-IS'. NETWORK COMPUTING DEVICES, INC.,
18
* DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING WITHOUT
19
* LIMITATION ALL IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
20
* PARTICULAR PURPOSE, OR NONINFRINGEMENT. IN NO EVENT SHALL NETWORK
21
* COMPUTING DEVICES, INC., BE LIABLE FOR ANY DAMAGES WHATSOEVER, INCLUDING
22
* SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES, INCLUDING LOSS OF USE, DATA,
23
* OR PROFITS, EVEN IF ADVISED OF THE POSSIBILITY THEREOF, AND REGARDLESS OF
24
* WHETHER IN AN ACTION IN CONTRACT, TORT OR NEGLIGENCE, ARISING OUT OF OR IN
25
* CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
27
$Id: AuDeviceAttributes.3.html 243 2007-04-07 23:13:43Z jon $
30
<!-- manual page source format generated by PolyglotMan v3.0.8+X.Org, -->
31
<!-- available at http://polyglotman.sourceforge.net/ -->
35
<title>AuDeviceAttributes(3) manual page</title>
37
<body bgcolor='#efefef' text='black' link='blue' vlink='#551A8B' alink='red'>
38
<a href='#toc'>Table of Contents</a><p>
40
<h2><a name='sect0' href='#toc0'><b>Name</b></a></h2>
41
<b>AuDeviceAttributes</b> - device attributes structure
43
<h2><a name='sect1' href='#toc1'><b>Structures</b></a></h2>
44
#include <audio/audiolib.h> <p>
45
typedef struct _AuDeviceAttributes <br>
49
}<b>AuDeviceAttributes</b>;
50
<h2><a name='sect2' href='#toc2'><b>Members</b></a></h2>
51
Do not dereference the members of the <b>AuDeviceAttributes</b>
52
structure directly. Instead use the access macros. <p>
53
<i>da</i> is a pointer to a <b>AuDeviceAttributes</b>
57
<dt><b>AuDeviceValueMask</b>(<i>da</i>)</dt>
58
<dd>Accesses the <b>AuMask</b> value indicating what
59
attributes are present. This is a bitwise inclusive OR of these constants:
60
<b>AuCompCommonIDMask</b>, <b>AuCompCommonKindMask</b>, <b>AuCompCommonUseMask</b>, <b>AuCompCommonFormatMask</b>,
61
<b>AuCompCommonNumTracksMask</b>, <b>AuCompCommonAccessMask</b>, <b>AuCompCommonDescriptionMask</b>,
62
<b>AuCompDeviceMinSampleRateMask</b>, <b>AuCompDeviceMaxSampleRateMask</b>, <b>AuCompDeviceLocationMask</b>,
63
<b>AuCompDeviceGainMask</b>, <b>AuCompDeviceLineModeMask</b>, and <b>AuCompDeviceChildrenMask</b>.
66
<dt><b>AuDeviceChangableMask</b>(<i>da</i>)</dt>
67
<dd>Accesses the <b>AuMask</b> value indicating which attributes
68
can be changed. This is a bitwise inclusive OR of these constants: <b>AuCompCommonIDMask</b>,
69
<b>AuCompCommonKindMask</b>, <b>AuCompCommonUseMask</b>, <b>AuCompCommonFormatMask</b>, <b>AuCompCommonNumTracksMask</b>,
70
<b>AuCompCommonAccessMask</b>, <b>AuCompCommonDescriptionMask</b>, <b>AuCompDeviceMinSampleRateMask</b>,
71
<b>AuCompDeviceMaxSampleRateMask</b>, <b>AuCompDeviceLocationMask</b>, <b>AuCompDeviceGainMask</b>,
72
<b>AuCompDeviceLineModeMask</b>, and <b>AuCompDeviceChildrenMask</b>. </dd>
74
<dt><b>AuDeviceIdentifier</b>(<i>da</i>)</dt>
76
the <b>AuFlowID</b> ID of the device. </dd>
78
<dt><b>AuDeviceKind</b>(<i>da</i>)</dt>
79
<dd>Accesses the int value indicating
80
the kind of component. Devices are either <b>AuComponentKindPhysicalInput</b> or
81
<b>AuComponentKindPhysicalOutput</b>. </dd>
83
<dt><b>AuDeviceUse</b>(<i>da</i>)</dt>
84
<dd>Accesses the <b>AuMask</b> value
85
indicating what uses of the device are permitted. This is a bitwise inclusive
86
OR of these constants: <b>AuComponentUseImportMask</b> and <b>AuComponentUseExportMask</b>.
89
<dt><b>AuDeviceFormat</b>(<i>da</i>)</dt>
90
<dd>Accesses the int value indicating the audio data format
91
the device uses. Currently, the following formats are defined: <b>AuFormatULAW8</b>,
92
<b>AuFormatLinearUnsigned8</b>, <b>AuFormatLinearSigned8</b>, <b>AuFormatLinearSigned16MSB</b>,
93
<b>AuFormatLinearUnsigned16MSB</b>, <b>AuFormatLinearSigned16LSB</b>, and <b>AuFormatLinearUnsigned16LSB</b>.
96
<dt><b>AuDeviceNumTracks</b>(<i>da</i>)</dt>
97
<dd>Accesses the int value indicating the number of tracks
98
the device supports. </dd>
100
<dt><b>AuDeviceAccess</b>(<i>da</i>)</dt>
101
<dd>Accesses the <b>AuMask</b> value indicating
102
what kinds of access are allowed. This is a bitwise inclusive OR of these
103
constants: <b>AuAccessImportMask</b>, <b>AuAccessExportMask</b>, <b>AuAccessDestroyMask</b>,
104
and <b>AuAccessListMask</b>. </dd>
106
<dt><b>AuDeviceDescription</b>(<i>da</i>)</dt>
107
<dd>Accesses the <b>AuString</b> structure
108
containing a textual description of the device. </dd>
110
<dt><b>AuDeviceMinSampleRate</b>(<i>da</i>)</dt>
112
the unsigned int value indicating the minimum sample rate supported by
115
<dt><b>AuDeviceMaxSampleRate</b>(<i>da</i>)</dt>
116
<dd>Accesses the unsigned int value indicating
117
the maximum sample rate supported by the device. </dd>
119
<dt><b>AuDeviceLocation</b>(<i>da</i>)</dt>
121
the <b>AuMask</b> value indicating the location of the device. This is a bitwise
122
inclusive OR of these constants: <b>AuDeviceLocationLeftMask</b>, <b>AuDeviceLocationCenterMask</b>,
123
<b>AuDeviceLocationRightMask</b>, <b>AuDeviceLocationTopMask</b>, <b>AuDeviceLocationMiddleMask</b>,
124
<b>AuDeviceLocationBottomMask</b>, <b>AuDeviceLocationBackMask</b>, <b>AuDeviceLocationFrontMask</b>,
125
<b>AuDeviceLocationInternalMask</b>, and <b>AuDeviceLocationExternalMask</b> </dd>
127
<dt><b>AuDeviceGain</b>(<i>da</i>)</dt>
129
the <b>AuFixedPoint</b> value with the current hardware amplification level. </dd>
131
<dt><b>AuDeviceLineMode</b>(<i>da</i>)</dt>
133
the <b>AuInt32</b> value indicating the current line mode (input device only).
136
<dt><b>AuDeviceNumChildren</b>(<i>da</i>)</dt>
137
<dd>Accesses the int value indicating the number of
138
subcomponents of the device. </dd>
140
<dt><b>AuDeviceChildren</b>(<i>da</i>)</dt>
141
<dd>Accesses the list of <b>AuDeviceID</b>'s
142
of the subcomponents of the device. </dd>
145
<h2><a name='sect3' href='#toc3'><b>Description</b></a></h2>
146
The <b>AuDeviceAttributes</b> structure
147
describes the physical hardware interface.
148
<h2><a name='sect4' href='#toc4'><b>See Also</b></a></h2>
149
<b>AuGetDeviceAttributes</b>,
150
<b>AuListDevices</b>. <p>
151
audiolib - <b>Network Audio System</b> C Language Interface
155
<a name='toc'><b>Table of Contents</b></a><p>
157
<li><a name='toc0' href='#sect0'>Name</a></li>
158
<li><a name='toc1' href='#sect1'>Structures</a></li>
159
<li><a name='toc2' href='#sect2'>Members</a></li>
160
<li><a name='toc3' href='#sect3'>Description</a></li>
161
<li><a name='toc4' href='#sect4'>See Also</a></li>
added
removed
doc/html/AuDeviceAttributes.3.html
