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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
<html>
<head>
<title>Castle Game Engine: CastleSoundFile: Class TSoundFile</title>
<meta name="generator" content="PasDoc 0.13.0">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<table class="container"><tr><td class="navigation">
<h2>Castle Game Engine</h2><p><a href="introduction.html" class="navigation">Introduction</a></p><p><a href="AllUnits.html" class="navigation">Units</a></p><p><a href="ClassHierarchy.html" class="navigation">Class Hierarchy</a></p><p><a href="AllClasses.html" class="navigation">Classes, Interfaces, Objects and Records</a></p><p><a href="AllTypes.html" class="navigation">Types</a></p><p><a href="AllVariables.html" class="navigation">Variables</a></p><p><a href="AllConstants.html" class="navigation">Constants</a></p><p><a href="AllFunctions.html" class="navigation">Functions and Procedures</a></p><p><a href="AllIdentifiers.html" class="navigation">Identifiers</a></p></td><td class="content">
<a name="TSoundFile"></a><h1 class="cio">Class TSoundFile</h1>
<table class="sections wide_list">
<tr>
<td><a class="section" href="#PasDoc-Description">Description</a></td><td><a class="section" href="#PasDoc-Hierarchy">Hierarchy</a></td><td>Fields</td><td><a class="section" href="#PasDoc-Methods">Methods</a></td><td>Properties</td></tr></table>
<a name="PasDoc-Description"></a><h2 class="unit">Unit</h2>
<p class="unitlink">
<a href="CastleSoundFile.html">CastleSoundFile</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TSoundFile = class(TObject)</code></p>
<h2 class="description">Description</h2>
<a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TObject</li>
<li class="thisitem">TSoundFile</li></ul><h2 class="overview">Overview</h2>
<a name="PasDoc-Methods"></a><h3 class="summary">Methods</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>procedure <b><a href="CastleSoundFile.TSoundFile.html#CheckALExtension">CheckALExtension</a></b>(const S: string);</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>constructor <b><a href="CastleSoundFile.TSoundFile.html#CreateFromStream">CreateFromStream</a></b>(Stream: TStream); virtual; abstract;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>class function <b><a href="CastleSoundFile.TSoundFile.html#CreateFromFile">CreateFromFile</a></b>(const URL: string): <a href="CastleSoundFile.TSoundFile.html">TSoundFile</a>;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <b><a href="CastleSoundFile.TSoundFile.html#PrepareOpenAL">PrepareOpenAL</a></b>; virtual;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a href="CastleSoundFile.TSoundFile.html#Data">Data</a></b>: Pointer; virtual; abstract;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a href="CastleSoundFile.TSoundFile.html#DataSize">DataSize</a></b>: LongWord; virtual; abstract;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a href="CastleSoundFile.TSoundFile.html#DataFormat">DataFormat</a></b>: TALuint; virtual; abstract;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a href="CastleSoundFile.TSoundFile.html#Frequency">Frequency</a></b>: LongWord; virtual; abstract;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a href="CastleSoundFile.TSoundFile.html#Duration">Duration</a></b>: <a href="CastleTimeUtils.html#TFloatTime">TFloatTime</a>;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Methods</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="CheckALExtension"></a><code>procedure <b>CheckALExtension</b>(const S: string);</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="CreateFromStream"></a><code>constructor <b>CreateFromStream</b>(Stream: TStream); virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
This will load a sound from a stream.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="CreateFromFile"></a><code>class function <b>CreateFromFile</b>(const URL: string): <a href="CastleSoundFile.TSoundFile.html">TSoundFile</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Load a sound data, given an URL. This just opens the file as stream and then calls <a class="normal" href="CastleSoundFile.TSoundFile.html#CreateFromStream">CreateFromStream</a> of appropriate class, so see <a class="normal" href="CastleSoundFile.TSoundFile.html#CreateFromStream">CreateFromStream</a> for more info. For now, file format (which <a class="normal" href="CastleSoundFile.TSoundFile.html">TSoundFile</a> to use) is decided by the URL extension.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="PrepareOpenAL"></a><code>procedure <b>PrepareOpenAL</b>; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Call this on this sound always after OpenAL is initialized and before passing this sound data to OpenAL. This may fix or check some things for this sound, checking e.g. whether some OpenAL extensions are supported.
<p></p>
<h6 class="description_section">Exceptions raised</h6>
<dl class="exceptions_raised">
<dt><a class="normal" href="CastleSoundFile.ESoundFormatNotSupportedByOpenAL.html">ESoundFormatNotSupportedByOpenAL</a></dt>
<dd>if some OpenAL extension required to support this format is not present.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Data"></a><code>function <b>Data</b>: Pointer; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
Sound data, according to <a class="normal" href="CastleSoundFile.TSoundFile.html#DataFormat">DataFormat</a>. Contents of Data are readonly.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="DataSize"></a><code>function <b>DataSize</b>: LongWord; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
Bytes allocated for <a class="normal" href="CastleSoundFile.TSoundFile.html#Data">Data</a>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="DataFormat"></a><code>function <b>DataFormat</b>: TALuint; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
Data format, as understood by OpenAL.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Frequency"></a><code>function <b>Frequency</b>: LongWord; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Duration"></a><code>function <b>Duration</b>: <a href="CastleTimeUtils.html#TFloatTime">TFloatTime</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Duration in seconds. Returns -1 if not known (<a class="normal" href="CastleSoundFile.TSoundFile.html#DataSize">DataSize</a> or <a class="normal" href="CastleSoundFile.TSoundFile.html#Frequency">Frequency</a> are zero, or <a class="normal" href="CastleSoundFile.TSoundFile.html#DataFormat">DataFormat</a> is unknown).</p>
</td></tr>
</table>
<!-- Piwik -->
<script type="text/javascript">
var _paq = _paq || [];
_paq.push(["trackPageView"]);
_paq.push(["enableLinkTracking"]);
(function() {
var u=(("https:" == document.location.protocol) ? "https" : "http") + "://michalis.ii.uni.wroc.pl/piwik-castle-engine/";
_paq.push(["setTrackerUrl", u+"piwik.php"]);
_paq.push(["setSiteId", "1"]);
var d=document, g=d.createElement("script"), s=d.getElementsByTagName("script")[0]; g.type="text/javascript";
g.defer=true; g.async=true; g.src=u+"piwik.js"; s.parentNode.insertBefore(g,s);
})();
</script>
<!-- End Piwik Code -->
<noscript>
<!-- Piwik Image Tracker -->
<img src="http://michalis.ii.uni.wroc.pl/piwik-castle-engine/piwik.php?idsite=1&rec=1" style="border:0" alt="" />
<!-- End Piwik -->
</noscript>
<hr noshade size="1"><span class="appinfo"><em>Generated by <a href="http://pasdoc.sourceforge.net/">PasDoc 0.13.0</a> on 2015-06-15 04:43:12</em>
</span>
</td></tr></table></body></html>
|
