File: Sound.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 (124 lines) | stat: -rw-r--r-- 4,531 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

<!--
  $NCDId: @(#)Sound.man,v 1.2 1995/05/23 23:53:14 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: Sound.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>Sound(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>Sound</b> - audio file description. 
<h2><a name='sect1' href='#toc1'><b>Structures</b></a></h2>
#include
&lt;audio/audiolib.h&gt; <br>
#include &lt;audio/sound.h&gt; <p>
typedef struct <br>
{ <br>
    . . .<br>
 <br>
}<b>SoundRec</b>, *<b>Sound</b>; 
<h2><a name='sect2' href='#toc2'><b>Members</b></a></h2>
Do not dereference the members of the <b>SoundRec</b>
structure directly. Instead use the access macros. <p>
<i>sound</i> is a <b>Sound</b>, a pointer
to a <b>SoundRec</b> structure. 
<dl>

<dt><b>SoundFileFormat<b>(<i>sound</i></b></b>)</dt>
<dd>Accesses the int value giving
the format of the sound file. </dd>

<dt><b>SoundFileFormatString<b>(<i>sound</i></b></b>)</dt>
<dd>Accesses the string
description of the format of the sound file. </dd>

<dt><b>SoundDataFormat<b>(<i>sound</i></b></b>)</dt>
<dd>Accesses
the int value giving the data format of the sound file. </dd>

<dt><b>SoundDataFormatString<b>(<i>sound</i></b></b>)</dt>
<dd>Accesses
the string description of the data format of the sound file. </dd>

<dt><b>SoundNumTracks<b>(<i>sound</i></b></b>)</dt>
<dd>Accesses
the int value giving the number of tracks in the audio data in the sound
file. </dd>

<dt><b>SoundSampleRate<b>(<i>sound</i></b></b>)</dt>
<dd>Accesses the int value giving the samples rate
of the audio data in the sound file. </dd>

<dt><b>SoundNumSamples<b>(<i>sound</i></b></b>)</dt>
<dd>Accesses the
int value giving the total number of samples. </dd>

<dt><b>SoundComment<b>(<i>sound</i></b></b>)</dt>
<dd>Accesses
the string comment. </dd>

<dt><b>SoundBytesPerSample<b>(<i>sound</i></b></b>)</dt>
<dd>Returns the bytes per sample
of audio data. </dd>

<dt><b>SoundNumBytes<b>(<i>sound</i></b></b>)</dt>
<dd>Returns the total number of bytes of
audio data in the sound file. </dd>

<dt><b>SoundValidateDataFormat<b>(<i>sound</i></b></b>)</dt>
<dd>Returns true
if the sound file format is a valid format. </dd>
</dl>

<h2><a name='sect3' href='#toc3'><b>Description</b></a></h2>
The <b>SoundRec</b> structure
describes an audio file. 
<h2><a name='sect4' href='#toc4'><b>See Also</b></a></h2>
<b>SoundCloseFile</b>, <b>SoundCreate</b>, <b>SoundFlushFile</b>,
<b>SoundOpenFileForReading</b>, <b>SoundOpenFileWriting</b>, <b>SoundReadFile</b>, <b>SoundRewindFile</b>,
<b>SoundSeekFile</b>, <b>SoundTellFile</b>, <b>SoundWriteFile</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>