File: AuDeviceAttributes.3.html

package info (click to toggle)
nas 1.9.4-9
  • links: PTS, VCS
  • area: main
  • in suites: forky, trixie
  • size: 8,640 kB
  • sloc: ansic: 52,144; makefile: 31,376; sh: 8,077; perl: 1,104; yacc: 252; cpp: 216; lex: 68
file content (164 lines) | stat: -rw-r--r-- 7,115 bytes parent folder | download | duplicates (9)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164

<!--
  $NCDId: @(#)AuDAttr.man,v 1.1 1994/09/27 00:25:12 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 Devices, Inc. not be
   * used in advertising or publicity pertaining to distribution of this
   * software without specific, written prior permission.
   * 
   * THIS SOFTWARE IS PROVIDED 'AS-IS'.  NETWORK COMPUTING DEVICES, INC.,
   * DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING WITHOUT
   * LIMITATION ALL IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
   * PARTICULAR PURPOSE, OR NONINFRINGEMENT.  IN NO EVENT SHALL NETWORK
   * COMPUTING DEVICES, INC., BE LIABLE FOR ANY DAMAGES WHATSOEVER, INCLUDING
   * SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES, INCLUDING LOSS OF USE, DATA,
   * OR PROFITS, EVEN IF ADVISED OF THE POSSIBILITY THEREOF, AND REGARDLESS OF
   * WHETHER IN AN ACTION IN CONTRACT, TORT OR NEGLIGENCE, ARISING OUT OF OR IN
   * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
   
   $Id: AuDeviceAttributes.3.html 243 2007-04-07 23:13:43Z jon $
 
-->
<!-- manual page source format generated by PolyglotMan v3.0.8+X.Org, -->
<!-- available at http://polyglotman.sourceforge.net/ -->

<html>
<head>
<title>AuDeviceAttributes(3) manual page</title>
</head>
<body bgcolor='#efefef' text='black' link='blue' vlink='#551A8B' alink='red'>
<a href='#toc'>Table of Contents</a><p>

<h2><a name='sect0' href='#toc0'><b>Name</b></a></h2>
<b>AuDeviceAttributes</b> - device attributes structure

<h2><a name='sect1' href='#toc1'><b>Structures</b></a></h2>
#include &lt;audio/audiolib.h&gt; <p>
typedef struct _AuDeviceAttributes <br>
{ <br>
    . . .<br>
 <br>
}<b>AuDeviceAttributes</b>; 
<h2><a name='sect2' href='#toc2'><b>Members</b></a></h2>
Do not dereference the members of the <b>AuDeviceAttributes</b>
structure directly. Instead use the access macros. <p>
<i>da</i> is a pointer to a <b>AuDeviceAttributes</b>
structure. 
<dl>

<dt><b>AuDeviceValueMask</b>(<i>da</i>)</dt>
<dd>Accesses the <b>AuMask</b> value indicating what
attributes are present. This is a bitwise inclusive OR of these constants:
<b>AuCompCommonIDMask</b>, <b>AuCompCommonKindMask</b>, <b>AuCompCommonUseMask</b>, <b>AuCompCommonFormatMask</b>,
<b>AuCompCommonNumTracksMask</b>, <b>AuCompCommonAccessMask</b>, <b>AuCompCommonDescriptionMask</b>,
<b>AuCompDeviceMinSampleRateMask</b>, <b>AuCompDeviceMaxSampleRateMask</b>, <b>AuCompDeviceLocationMask</b>,
<b>AuCompDeviceGainMask</b>, <b>AuCompDeviceLineModeMask</b>, and <b>AuCompDeviceChildrenMask</b>.
</dd>

<dt><b>AuDeviceChangableMask</b>(<i>da</i>)</dt>
<dd>Accesses the <b>AuMask</b> value indicating which attributes
can be changed. This is a bitwise inclusive OR of these constants: <b>AuCompCommonIDMask</b>,
<b>AuCompCommonKindMask</b>, <b>AuCompCommonUseMask</b>, <b>AuCompCommonFormatMask</b>, <b>AuCompCommonNumTracksMask</b>,
<b>AuCompCommonAccessMask</b>, <b>AuCompCommonDescriptionMask</b>, <b>AuCompDeviceMinSampleRateMask</b>,
<b>AuCompDeviceMaxSampleRateMask</b>, <b>AuCompDeviceLocationMask</b>, <b>AuCompDeviceGainMask</b>,
<b>AuCompDeviceLineModeMask</b>, and <b>AuCompDeviceChildrenMask</b>. </dd>

<dt><b>AuDeviceIdentifier</b>(<i>da</i>)</dt>
<dd>Accesses
the <b>AuFlowID</b> ID of the device. </dd>

<dt><b>AuDeviceKind</b>(<i>da</i>)</dt>
<dd>Accesses the int value indicating
the kind of component. Devices are either <b>AuComponentKindPhysicalInput</b> or
<b>AuComponentKindPhysicalOutput</b>. </dd>

<dt><b>AuDeviceUse</b>(<i>da</i>)</dt>
<dd>Accesses the <b>AuMask</b> value
indicating what uses of the device are permitted. This is a bitwise inclusive
OR of these constants: <b>AuComponentUseImportMask</b> and <b>AuComponentUseExportMask</b>.
</dd>

<dt><b>AuDeviceFormat</b>(<i>da</i>)</dt>
<dd>Accesses the int value indicating the audio data format
the device uses. Currently, the following formats are defined: <b>AuFormatULAW8</b>,
<b>AuFormatLinearUnsigned8</b>, <b>AuFormatLinearSigned8</b>, <b>AuFormatLinearSigned16MSB</b>,
<b>AuFormatLinearUnsigned16MSB</b>, <b>AuFormatLinearSigned16LSB</b>, and <b>AuFormatLinearUnsigned16LSB</b>.
</dd>

<dt><b>AuDeviceNumTracks</b>(<i>da</i>)</dt>
<dd>Accesses the int value indicating the number of tracks
the device supports. </dd>

<dt><b>AuDeviceAccess</b>(<i>da</i>)</dt>
<dd>Accesses the <b>AuMask</b> value indicating
what kinds of access are allowed. This is a bitwise inclusive OR of these
constants: <b>AuAccessImportMask</b>, <b>AuAccessExportMask</b>, <b>AuAccessDestroyMask</b>,
and <b>AuAccessListMask</b>. </dd>

<dt><b>AuDeviceDescription</b>(<i>da</i>)</dt>
<dd>Accesses the <b>AuString</b> structure
containing a textual description of the device. </dd>

<dt><b>AuDeviceMinSampleRate</b>(<i>da</i>)</dt>
<dd>Accesses
the unsigned int value indicating the minimum sample rate supported by
the device. </dd>

<dt><b>AuDeviceMaxSampleRate</b>(<i>da</i>)</dt>
<dd>Accesses the unsigned int value indicating
the maximum sample rate supported by the device. </dd>

<dt><b>AuDeviceLocation</b>(<i>da</i>)</dt>
<dd>Accesses
the <b>AuMask</b> value indicating the location of the device. This is a bitwise
inclusive OR of these constants: <b>AuDeviceLocationLeftMask</b>, <b>AuDeviceLocationCenterMask</b>,
<b>AuDeviceLocationRightMask</b>, <b>AuDeviceLocationTopMask</b>, <b>AuDeviceLocationMiddleMask</b>,
<b>AuDeviceLocationBottomMask</b>, <b>AuDeviceLocationBackMask</b>, <b>AuDeviceLocationFrontMask</b>,
<b>AuDeviceLocationInternalMask</b>, and <b>AuDeviceLocationExternalMask</b> </dd>

<dt><b>AuDeviceGain</b>(<i>da</i>)</dt>
<dd>Accesses
the <b>AuFixedPoint</b> value with the current hardware amplification level. </dd>

<dt><b>AuDeviceLineMode</b>(<i>da</i>)</dt>
<dd>Accesses
the <b>AuInt32</b> value indicating the current line mode (input device only).
</dd>

<dt><b>AuDeviceNumChildren</b>(<i>da</i>)</dt>
<dd>Accesses the int value indicating the number of
subcomponents of the device. </dd>

<dt><b>AuDeviceChildren</b>(<i>da</i>)</dt>
<dd>Accesses the list of <b>AuDeviceID</b>'s
of the subcomponents of the device. </dd>
</dl>

<h2><a name='sect3' href='#toc3'><b>Description</b></a></h2>
The <b>AuDeviceAttributes</b> structure
describes the physical hardware interface. 
<h2><a name='sect4' href='#toc4'><b>See Also</b></a></h2>
<b>AuGetDeviceAttributes</b>,
<b>AuListDevices</b>. <p>
audiolib - <b>Network Audio System</b> C Language Interface 
<p> <p>

<hr><p>
<a name='toc'><b>Table of Contents</b></a><p>
<ul>
<li><a name='toc0' href='#sect0'>Name</a></li>
<li><a name='toc1' href='#sect1'>Structures</a></li>
<li><a name='toc2' href='#sect2'>Members</a></li>
<li><a name='toc3' href='#sect3'>Description</a></li>
<li><a name='toc4' href='#sect4'>See Also</a></li>
</ul>
</body>
</html>