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
|
<!--
$NCDId: @(#)AuBAttr.man,v 1.1 1994/09/27 00:24:33 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: AuBucketAttributes.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>AuBucketAttributes(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>AuBucketAttributes</b> - bucket attributes structure
<h2><a name='sect1' href='#toc1'><b>Structures</b></a></h2>
#include <audio/audiolib.h> <p>
typedef struct _AuBucketAttributes <br>
{ <br>
. . .<br>
<br>
}<b>AuBucketAttributes</b>;
<h2><a name='sect2' href='#toc2'><b>Members</b></a></h2>
Do not dereference the members of the <b>AuBucketAttributes</b>
structure directly. Instead use the access macros. <p>
<i>ba</i> is a pointer to a <b>AuBucketAttributes</b>
structure.
<dl>
<dt><b>AuBucketValueMask</b>(<i>ba</i>)</dt>
<dd>Accesses the <b>AuMask</b> value indicating which
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>AuCompBucketSampleRateMask</b>, and <b>AuCompBucketNumSamplesMask</b>. </dd>
<dt><b>AuBucketChangableMask</b>(<i>ba</i>)</dt>
<dd>Accesses
the <b>AuMask</b> value indicating which of the 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>AuCompBucketSampleRateMask</b>,
and <b>AuCompBucketNumSamplesMask</b>. </dd>
<dt><b>AuBucketIdentifier</b>(<i>ba</i>)</dt>
<dd>Accesses the <b>AuBucketID</b>
ID of the bucket. </dd>
<dt><b>AuBucketKind</b>(<i>ba</i>)</dt>
<dd>Accesses the int value indicating the
kind of component. Buckets will always be <b>AuComponentKindBucket</b>. </dd>
<dt><b>AuBucketUse</b>(<i>ba</i>)</dt>
<dd>Accesses
the <b>AuMask</b> value indicating what uses of the bucket are permitted. This
is a bitwise inclusive OR of these constants: <b>AuComponentUseImportMask</b>
and <b>AuComponentUseExportMask</b>. </dd>
<dt><b>AuBucketFormat</b>(<i>ba</i>)</dt>
<dd>Accesses the int value indicating
the audio data format the bucket 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>AuBucketNumTracks</b>(<i>ba</i>)</dt>
<dd>Accesses the int value
indicating the number of tracks the bucket supports. </dd>
<dt><b>AuBucketAccess</b>(<i>ba</i>)</dt>
<dd>Accesses
the <b>AuMask</b> value indicating what kinds of access the bucket allows. 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>AuBucketDescription</b>(<i>ba</i>)</dt>
<dd>Accesses
the <b>AuString</b> structure containing a textual description of the bucket. </dd>
<dt><b>AuBucketSampleRate</b>(<i>ba</i>)</dt>
<dd>Accesses
the unsigned int value indicating the sample rate of the bucket. </dd>
<dt><b>AuBucketNumSamples</b>(<i>ba</i>)</dt>
<dd>Accesses
the <b>AuUint32</b> value indicating the number of samples the bucket contains.
</dd>
</dl>
<h2><a name='sect3' href='#toc3'><b>Description</b></a></h2>
The <b>AuBucketAttributes</b> structure describes the server-local storage
of audio data.
<h2><a name='sect4' href='#toc4'><b>See Also</b></a></h2>
<b>AuGetBucketAttributes</b>, <b>AuListBuckets</b>. <p>
audiolib - <b>Network
Audio System</b> C Language Interface <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>
|
