← Back to branch summary

~ubuntu-branches/debian/squeeze/nas/squeeze

« back to all changes in this revision

Viewing changes to doc/html/man3/AuBAttr.html

  • Committer: Bazaar Package Importer
  • Author(s): Steve McIntyre
  • Date: 2004-06-23 01:15:02 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20040623011502-30uqd1dyu47iv2dp
Tags: 1.6d-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/man3/AuBAttr.html
 
1
<!-- manual page source format generated by PolyglotMan v3.0.7, -->
 
2
<!-- available via anonymous ftp from ftp.cs.berkeley.edu:/ucb/people/phelps/tcltk/rman.tar.Z -->
 
3
 
 
4
<HTML>
 
5
<HEAD>
 
6
<TITLE>man page(1)</TITLE>
 
7
</HEAD>
 
8
<BODY bgcolor=white>
 
9
<A HREF="#toc">Table of Contents</A><P>
 
10
 
 
11
<H2><A NAME="sect0" HREF="#toc0">Name</A></H2>
 
12
 
 
13
<P>
 
14
<B>AuBucketAttributes</B> - bucket attributes structure
 
15
 
 
16
<H2><A NAME="sect1" HREF="#toc1"><B>Structures</B></A></H2>
 
17
 
 
18
<P>
 
19
#include &lt;audio/audiolib.h&gt;
 
20
<P>
 
21
typedef struct _AuBucketAttributes<BR>
 
22
 
 
23
{<BR>
 
24
 
 
25
. . .<BR>
 
26
 
 
27
}<B>AuBucketAttributes</B>;
 
28
 
 
29
<H2><A NAME="sect2" HREF="#toc2"><B>Members</B></A></H2>
 
30
 
 
31
<P>
 
32
Do not dereference the members of the <B>AuBucketAttributes</B>
 
33
structure directly. Instead use the access macros.
 
34
<P>
 
35
<I>ba</I> is a pointer to a <B>AuBucketAttributes</B> structure.
 
36
<P>
 
37
<B>AuBucketValueMask</B>(<I>ba</I>)<BR>
 
38
 
 
39
Accesses the <B>AuMask</B> value indicating which
 
40
attributes are present. This is a bitwise
 
41
inclusive OR of these constants: <B>AuCompCommonIDMask</B>,
 
42
<B>AuCompCommonKindMask</B>, <B>AuCompCommonUseMask</B>,
 
43
<B>AuCompCommonFormatMask</B>, <B>AuCompCommonNumTracksMask</B>,
 
44
<B>AuCompCommonAccessMask</B>, <B>AuCompCommonDescriptionMask</B>,
 
45
<B>AuCompBucketSampleRateMask</B>, and
 
46
<B>AuCompBucketNumSamplesMask</B>.
 
47
<P>
 
48
<B>AuBucketChangableMask</B>(<I>ba</I>)<BR>
 
49
 
 
50
Accesses the <B>AuMask</B> value indicating which of
 
51
the attributes can be changed. This is a bitwise
 
52
inclusive OR of these constants: <B>AuCompCommonIDMask</B>,
 
53
 
 
54
<DL>
 
55
 
 
56
<DT><B>AuCompCommonKindMask</B>, </DT></DT>
 
57
<DD>   <B>AuCompCommonUseMask</B>,
 
58
<B>AuCompCommonFormatMask</B>, <B>AuCompCommonNumTracksMask</B>,
 
59
<B>AuCompCommonAccessMask</B>, <B>AuCompCommonDescriptionMask</B>,
 
60
<B>AuCompBucketSampleRateMask</B>,
 
61
and <B>AuCompBucketNumSamplesMask</B>.
 
62
</DD>
 
63
</DL>
 
64
<P>
 
65
<B>AuBucketIdentifier</B>(<I>ba</I>)<BR>
 
66
 
 
67
Accesses the <B>AuBucketID</B> ID of the bucket.
 
68
<P>
 
69
<B>AuBucketKind</B>(<I>ba</I>)<BR>
 
70
 
 
71
Accesses the int value indicating the kind of
 
72
component. Buckets will always be <B>AuComponentKindBucket</B>.
 
73
<P>
 
74
<B>AuBucketUse</B>(<I>ba</I>)<BR>
 
75
 
 
76
Accesses the <B>AuMask</B> value indicating what uses
 
77
of the bucket are permitted. This is a bitwise
 
78
inclusive OR of these constants: <B>AuComponentUseImportMask</B>
 
79
and <B>AuComponentUseExportMask</B>.
 
80
<P>
 
81
<B>AuBucketFormat</B>(<I>ba</I>)<BR>
 
82
 
 
83
Accesses the int value indicating the audio data
 
84
format the bucket uses.    Currently, the
 
85
following formats are defined: <B>AuFormatULAW8</B>,
 
86
<B>AuFormatLinearUnsigned8</B>, <B>AuFormatLinearSigned8</B>,
 
87
 
 
88
<DL>
 
89
 
 
90
<DT><B>AuFormatLinearSigned16MSB</B>, </DT></DT>
 
91
<DD>    <B>AuFormatLinearUnsigned16MSB</B>,
 
92
</DD>
 
93
 
 
94
<DT><B>AuFormatLinearSigned16LSB</B>, </DT></DT>
 
95
<DD>   and
 
96
<B>AuFormatLinearUnsigned16LSB</B>.
 
97
</DD>
 
98
</DL>
 
99
<P>
 
100
<B>AuBucketNumTracks</B>(<I>ba</I>)<BR>
 
101
 
 
102
Accesses the int value indicating the number of
 
103
tracks the bucket supports.
 
104
<P>
 
105
<B>AuBucketAccess</B>(<I>ba</I>)<BR>
 
106
 
 
107
Accesses the <B>AuMask</B> value indicating what kinds
 
108
of access the bucket allows. This is a bitwise
 
109
inclusive OR of these constants: <B>AuAccessImportMask</B>,
 
110
<B>AuAccessExportMask</B>, <B>AuAccessDestroyMask</B>,
 
111
and <B>AuAccessListMask</B>.
 
112
<P>
 
113
<B>AuBucketDescription</B>(<I>ba</I>)<BR>
 
114
 
 
115
Accesses the <B>AuString</B> structure containing a
 
116
textual description of the bucket.
 
117
<P>
 
118
<B>AuBucketSampleRate</B>(<I>ba</I>)<BR>
 
119
 
 
120
Accesses the unsigned int value indicating the
 
121
sample rate of the bucket.
 
122
<P>
 
123
<B>AuBucketNumSamples</B>(<I>ba</I>)<BR>
 
124
 
 
125
Accesses the <B>AuUint32</B> value indicating the number
 
126
of samples the bucket contains.
 
127
 
 
128
<H2><A NAME="sect3" HREF="#toc3"><B>Description</B></A></H2>
 
129
 
 
130
<P>
 
131
The <B>AuBucketAttributes</B> structure describes the serverlocal
 
132
storage of audio data.
 
133
 
 
134
<H2><A NAME="sect4" HREF="#toc4"><B>See</B> <B>Also</B></A></H2>
 
135
 
 
136
<P>
 
137
<B>AuGetBucketAttributes</B>, <B>AuListBuckets</B>.
 
138
<P>
 
139
audiolib - <B>Network</B> <B>Audio</B> <B>System</B> C Language Interface
 
140
<P>
 
141
 
 
142
<HR><P>
 
143
<A NAME="toc"><B>Table of Contents</B></A><P>
 
144
<UL>
 
145
<LI><A NAME="toc0" HREF="#sect0">Name</A></LI>
 
146
<LI><A NAME="toc1" HREF="#sect1">Structures</A></LI>
 
147
<LI><A NAME="toc2" HREF="#sect2">Members</A></LI>
 
148
<LI><A NAME="toc3" HREF="#sect3">Description</A></LI>
 
149
<LI><A NAME="toc4" HREF="#sect4">See Also</A></LI>
 
150
</UL>
 
151
</BODY></HTML>