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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GstBtPropertyMeta: 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="ch02.html" title="GStreamer Buzztrax interfaces">
<link rel="prev" href="GstBtChildBin.html" title="GstBtChildBin">
<link rel="next" href="GstBtTempo.html" title="GstBtTempo">
<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="#GstBtPropertyMeta.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GstBtPropertyMeta.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_implementations"> <span class="dim">|</span>
<a href="#GstBtPropertyMeta.implementations" class="shortcut">Known Implementations</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GstBtChildBin.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GstBtTempo.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GstBtPropertyMeta"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GstBtPropertyMeta.top_of_page"></a>GstBtPropertyMeta</span></h2>
<p>GstBtPropertyMeta — helper interface for extended gstreamer element meta data</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GstBtPropertyMeta.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#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GstBtPropertyMeta.html#gstbt-property-meta-describe-property" title="gstbt_property_meta_describe_property ()">gstbt_property_meta_describe_property</a> <span class="c_punctuation">()</span>
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GstBtPropertyMeta.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="GstBtPropertyMeta.html#GstBtPropertyMetaInterface" title="struct GstBtPropertyMetaInterface">GstBtPropertyMetaInterface</a></td>
</tr>
<tr>
<td class="variable_type">extern GQuark </td>
<td class="function_name"><a class="link" href="GstBtPropertyMeta.html#gstbt-property-meta-quark" title="gstbt_property_meta_quark">gstbt_property_meta_quark</a></td>
</tr>
<tr>
<td class="variable_type">extern GQuark </td>
<td class="function_name"><a class="link" href="GstBtPropertyMeta.html#gstbt-property-meta-quark-min-val" title="gstbt_property_meta_quark_min_val">gstbt_property_meta_quark_min_val</a></td>
</tr>
<tr>
<td class="variable_type">extern GQuark </td>
<td class="function_name"><a class="link" href="GstBtPropertyMeta.html#gstbt-property-meta-quark-max-val" title="gstbt_property_meta_quark_max_val">gstbt_property_meta_quark_max_val</a></td>
</tr>
<tr>
<td class="variable_type">extern GQuark </td>
<td class="function_name"><a class="link" href="GstBtPropertyMeta.html#gstbt-property-meta-quark-def-val" title="gstbt_property_meta_quark_def_val">gstbt_property_meta_quark_def_val</a></td>
</tr>
<tr>
<td class="variable_type">extern GQuark </td>
<td class="function_name"><a class="link" href="GstBtPropertyMeta.html#gstbt-property-meta-quark-no-val" title="gstbt_property_meta_quark_no_val">gstbt_property_meta_quark_no_val</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="GstBtPropertyMeta.html#GstBtPropertyMetaFlags" title="enum GstBtPropertyMetaFlags">GstBtPropertyMetaFlags</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GstBtPropertyMeta.html#GstBtPropertyMeta-struct" title="GstBtPropertyMeta">GstBtPropertyMeta</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GstBtPropertyMeta.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html">GInterface</a>
<span class="lineart">╰──</span> GstBtPropertyMeta
</pre>
</div>
<div class="refsect1">
<a name="GstBtPropertyMeta.implementations"></a><h2>Known Implementations</h2>
<p>
GstBtPropertyMeta is implemented by
<a class="link" href="GstBtSidSyn.html" title="GstBtSidSyn">GstBtSidSyn</a> and <a class="link" href="GstBtSidSynV.html" title="GstBtSidSynV">GstBtSidSynV</a>.</p>
</div>
<div class="refsect1">
<a name="GstBtPropertyMeta.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libgstbuzztrax/propertymeta.h>
</pre>
</div>
<div class="refsect1">
<a name="GstBtPropertyMeta.description"></a><h2>Description</h2>
<p>This interface standardises some additional meta-data that is attached to
<a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#GObject-struct"><span class="type">GObject</span></a> properties.</p>
<p>Furthermore it adds the <a class="link" href="GstBtPropertyMeta.html#gstbt-property-meta-describe-property" title="gstbt_property_meta_describe_property ()"><code class="function">gstbt_property_meta_describe_property()</code></a> method that
builds a string description of a property value.</p>
</div>
<div class="refsect1">
<a name="GstBtPropertyMeta.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gstbt-property-meta-describe-property"></a><h3>gstbt_property_meta_describe_property ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gstbt_property_meta_describe_property (<em class="parameter"><code><a class="link" href="GstBtPropertyMeta.html" title="GstBtPropertyMeta"><span class="type">GstBtPropertyMeta</span></a> *self</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> property_id</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/gobjectgobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
<p>Formats the gives value as a human readable string. The method is useful to
pretty print a property value to be shown in a user interface.
It provides a default implementation.</p>
<div class="refsect3">
<a name="id-1.4.3.9.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>a <a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#GObject-struct"><span class="type">GObject</span></a> that implements <a class="link" href="GstBtPropertyMeta.html" title="GstBtPropertyMeta"><span class="type">GstBtPropertyMeta</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>property_id</p></td>
<td class="parameter_description"><p>the property index</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>the current property value</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.3.9.2.6"></a><h4>Returns</h4>
<p> a string with the value in human readable form, free memory when
done</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GstBtPropertyMeta.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GstBtPropertyMetaInterface"></a><h3>struct GstBtPropertyMetaInterface</h3>
<pre class="programlisting">struct GstBtPropertyMetaInterface {
GTypeInterface parent;
gchar *(*describe_property) (GstBtPropertyMeta *self, guint property_id, const GValue *value);
};
</pre>
<p>Interface structure.</p>
<div class="refsect3">
<a name="id-1.4.3.10.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><a href="/usr/share/gtk-doc/html/gobjectgobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="GstBtPropertyMetaInterface.parent"></a>parent</code></em>;</p></td>
<td class="struct_member_description"><p>parent type</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstBtPropertyMetaInterface.describe-property"></a>describe_property</code></em> ()</p></td>
<td class="struct_member_description"><p>vmethod for returning a human readable property value
description</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gstbt-property-meta-quark"></a><h3>gstbt_property_meta_quark</h3>
<pre class="programlisting">extern GQuark gstbt_property_meta_quark;
</pre>
<p>Only if this is set to TRUE, there is property meta data for this property..</p>
</div>
<hr>
<div class="refsect2">
<a name="gstbt-property-meta-quark-min-val"></a><h3>gstbt_property_meta_quark_min_val</h3>
<pre class="programlisting">extern GQuark gstbt_property_meta_quark_min_val;
</pre>
<p>Minimum property value (excluding default and no-value).</p>
</div>
<hr>
<div class="refsect2">
<a name="gstbt-property-meta-quark-max-val"></a><h3>gstbt_property_meta_quark_max_val</h3>
<pre class="programlisting">extern GQuark gstbt_property_meta_quark_max_val;
</pre>
<p>Maximum property value (excluding default and no-value).</p>
</div>
<hr>
<div class="refsect2">
<a name="gstbt-property-meta-quark-def-val"></a><h3>gstbt_property_meta_quark_def_val</h3>
<pre class="programlisting">extern GQuark gstbt_property_meta_quark_def_val;
</pre>
<p>Default property value (used initialy).</p>
</div>
<hr>
<div class="refsect2">
<a name="gstbt-property-meta-quark-no-val"></a><h3>gstbt_property_meta_quark_no_val</h3>
<pre class="programlisting">extern GQuark gstbt_property_meta_quark_no_val;
</pre>
<p>Property value (used in trigger style properties, when there is no current
value)</p>
</div>
<hr>
<div class="refsect2">
<a name="GstBtPropertyMetaFlags"></a><h3>enum GstBtPropertyMetaFlags</h3>
<p>Parameter flags to describe their behaviour.</p>
<div class="refsect3">
<a name="id-1.4.3.10.8.4"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GSTBT-PROPERTY-META-WAVE:CAPS"></a>GSTBT_PROPERTY_META_WAVE</p></td>
<td class="enum_member_description">
<p>parameter value references a wavetable slot</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSTBT-PROPERTY-META-STATE:CAPS"></a>GSTBT_PROPERTY_META_STATE</p></td>
<td class="enum_member_description">
<p>parameter is continuously changing (not used for notes and triggers)</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSTBT-PROPERTY-META-TICK-ON-EDIT:CAPS"></a>GSTBT_PROPERTY_META_TICK_ON_EDIT</p></td>
<td class="enum_member_description">
<p>need to call tick after editing it</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="GstBtPropertyMeta-struct"></a><h3>GstBtPropertyMeta</h3>
<pre class="programlisting">typedef struct _GstBtPropertyMeta GstBtPropertyMeta;</pre>
<p>Opaque interface handle.</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24.1</div>
</body>
</html>
|
