File: GstBtEnvelope.html

package info (click to toggle)
buzztrax 0.10.2-10
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 19,984 kB
  • sloc: ansic: 109,707; sh: 12,875; cpp: 10,882; xml: 6,081; makefile: 508; javascript: 338; asm: 116
file content (190 lines) | stat: -rw-r--r-- 9,261 bytes parent folder | download | duplicates (6) 
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
184
185
186
187
188
189
190
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GstBtEnvelope: GStreamer Buzztrax Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GStreamer Buzztrax Reference Manual">
<link rel="up" href="ch01.html" title="GStreamer Buzztrax classes">
<link rel="prev" href="GstBtDelay.html" title="GstBtDelay">
<link rel="next" href="GstBtEnvelopeAD.html" title="GstBtEnvelopeAD">
<meta name="generator" content="GTK-Doc V1.24.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GstBtEnvelope.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GstBtEnvelope.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GstBtDelay.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GstBtEnvelopeAD.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GstBtEnvelope"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GstBtEnvelope.top_of_page"></a>GstBtEnvelope</span></h2>
<p>GstBtEnvelope — envelope base class</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GstBtEnvelope.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GstBtEnvelope.html#gstbt-envelope-is-running" title="gstbt_envelope_is_running ()">gstbt_envelope_is_running</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GstBtEnvelope.html#gstbt-envelope-reset" title="gstbt_envelope_reset ()">gstbt_envelope_reset</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GstBtEnvelope.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GstBtEnvelope.html#GstBtEnvelope-struct" title="struct GstBtEnvelope">GstBtEnvelope</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GstBtEnvelope.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
        <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstObject.html#GstObject-struct">GstObject</a>
            <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-0.10GstControlSource.html#GstControlSource-struct">GstControlSource</a>
                <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0GstTimedValueControlSource.html#GstTimedValueControlSource-struct">GstTimedValueControlSource</a>
                    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0GstInterpolationControlSource.html#GstInterpolationControlSource-struct">GstInterpolationControlSource</a>
                        <span class="lineart">╰──</span> GstBtEnvelope
                            <span class="lineart">├──</span> <a class="link" href="GstBtEnvelopeAD.html" title="GstBtEnvelopeAD">GstBtEnvelopeAD</a>
                            <span class="lineart">├──</span> <a class="link" href="GstBtEnvelopeADSR.html" title="GstBtEnvelopeASDR">GstBtEnvelopeADSR</a>
                            <span class="lineart">╰──</span> <a class="link" href="GstBtEnvelopeD.html" title="GstBtEnvelopeD">GstBtEnvelopeD</a>
</pre>
</div>
<div class="refsect1">
<a name="GstBtEnvelope.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libgstbuzztrax/envelope.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GstBtEnvelope.description"></a><h2>Description</h2>
<p>Base class for envelopes. The are specialized control sources. Subclsses
provide constructors and configure a <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0GstInterpolationControlSource.html#GstInterpolationControlSource-struct"><span class="type">GstInterpolationControlSource</span></a> according
to the parameters given.</p>
</div>
<div class="refsect1">
<a name="GstBtEnvelope.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gstbt-envelope-is-running"></a><h3>gstbt_envelope_is_running ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gstbt_envelope_is_running (<em class="parameter"><code><a class="link" href="GstBtEnvelope.html" title="GstBtEnvelope"><span class="type">GstBtEnvelope</span></a> *self</code></em>,
                           <em class="parameter"><code><span class="type">guint64</span> offset</code></em>);</pre>
<p>Checks if the end of the envelop has reached. Can be used to skip audio
rendering once the end is reached.</p>
<div class="refsect3">
<a name="id-1.3.5.8.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the envelope</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>offset</p></td>
<td class="parameter_description"><p>the current offset</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.5.8.2.6"></a><h4>Returns</h4>
<p> if the envelope is still running</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gstbt-envelope-reset"></a><h3>gstbt_envelope_reset ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gstbt_envelope_reset (<em class="parameter"><code><a class="link" href="GstBtEnvelope.html" title="GstBtEnvelope"><span class="type">GstBtEnvelope</span></a> *self</code></em>);</pre>
<p>Resets the envelope. Call this to to turn off envelopes before playing a
song another time.</p>
<div class="refsect3">
<a name="id-1.3.5.8.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the envelope</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GstBtEnvelope.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GstBtEnvelope-struct"></a><h3>struct GstBtEnvelope</h3>
<pre class="programlisting">struct GstBtEnvelope {
  guint64 length;
};
</pre>
<p>Class instance data.</p>
<div class="refsect3">
<a name="id-1.3.5.9.2.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p><span class="type">guint64</span> <em class="structfield"><code><a name="GstBtEnvelope-struct.length"></a>length</code></em>;</p></td>
<td class="struct_member_description"><p>length of the envelope in samples</p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24.1</div>
</body>
</html>