← Back to branch summary

~sipe-collab/sipe-collab/gstreamer-plugins-base

« back to all changes in this revision

Viewing changes to docs/libs/html/gst-plugins-base-libs-gstaudiofilter.html

  • Committer: Sebastian Dröge
  • Date: 2014-04-19 13:47:47 UTC
  • mfrom: (1.1.23)
  • Revision ID: git-v1:d06393f82dba0d5f13ec2e66275d75cf8178fe5c
Merge tag 'upstream/1.2.4'

Upstream version 1.2.4

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/libs/html/gst-plugins-base-libs-gstaudiofilter.html
2
2
<html>
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>gstaudiofilter</title>
 
5
<title>GStreamer Base Plugins 1.0 Library Reference Manual: gstaudiofilter</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Library Reference Manual">
8
8
<link rel="up" href="gstreamer-audio.html" title="Audio Library">
9
9
<link rel="prev" href="gst-plugins-base-libs-gstaudioencoder.html" title="gstaudioencoder">
10
10
<link rel="next" href="gst-plugins-base-libs-gstaudiomixerutils.html" title="gstaudiomixerutils">
11
 
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
 
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16
 
<tr valign="middle">
17
 
<td><a accesskey="p" href="gst-plugins-base-libs-gstaudioencoder.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
 
<td><a accesskey="u" href="gstreamer-audio.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
 
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
 
<th width="100%" align="center">GStreamer Base Plugins 1.0 Library Reference Manual</th>
21
 
<td><a accesskey="n" href="gst-plugins-base-libs-gstaudiomixerutils.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22
 
</tr>
23
 
<tr><td colspan="5" class="shortcuts">
24
 
<a href="#gst-plugins-base-libs-gstaudiofilter.synopsis" class="shortcut">Top</a>
25
 
                   | 
26
 
                  <a href="#gst-plugins-base-libs-gstaudiofilter.description" class="shortcut">Description</a>
27
 
                   | 
28
 
                  <a href="#gst-plugins-base-libs-gstaudiofilter.object-hierarchy" class="shortcut">Object Hierarchy</a>
29
 
</td></tr>
30
 
</table>
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
 
16
<td width="100%" align="left" class="shortcuts">
 
17
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
 
18
                  <a href="#gst-plugins-base-libs-gstaudiofilter.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
 
19
                  <a href="#gst-plugins-base-libs-gstaudiofilter.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
 
20
</td>
 
21
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
 
22
<td><a accesskey="u" href="gstreamer-audio.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
 
23
<td><a accesskey="p" href="gst-plugins-base-libs-gstaudioencoder.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
 
24
<td><a accesskey="n" href="gst-plugins-base-libs-gstaudiomixerutils.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
 
25
</tr></table>
31
26
<div class="refentry">
32
27
<a name="gst-plugins-base-libs-gstaudiofilter"></a><div class="titlepage"></div>
33
28
<div class="refnamediv"><table width="100%"><tr>
35
30
<h2><span class="refentrytitle"><a name="gst-plugins-base-libs-gstaudiofilter.top_of_page"></a>gstaudiofilter</span></h2>
36
31
<p>gstaudiofilter — Base class for simple audio filters</p>
37
32
</td>
38
 
<td valign="top" align="right"></td>
 
33
<td class="gallery_image" valign="top" align="right"></td>
39
34
</tr></table></div>
40
 
<div class="refsynopsisdiv">
41
 
<a name="gst-plugins-base-libs-gstaudiofilter.synopsis"></a><h2>Synopsis</h2>
42
 
<a name="GstAudioFilter"></a><pre class="synopsis">
43
 
#include &lt;gst/audio/gstaudiofilter.h&gt;
44
 
 
45
 
struct              <a class="link" href="gst-plugins-base-libs-gstaudiofilter.html#GstAudioFilter-struct" title="struct GstAudioFilter">GstAudioFilter</a>;
46
 
struct              <a class="link" href="gst-plugins-base-libs-gstaudiofilter.html#GstAudioFilterClass" title="struct GstAudioFilterClass">GstAudioFilterClass</a>;
47
 
<span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstaudiofilter.html#gst-audio-filter-class-add-pad-templates" title="gst_audio_filter_class_add_pad_templates ()">gst_audio_filter_class_add_pad_templates</a>
48
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiofilter.html#GstAudioFilterClass" title="struct GstAudioFilterClass"><span class="type">GstAudioFilterClass</span></a> *klass</code></em>,
49
 
                                                         <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *allowed_caps</code></em>);
50
 
</pre>
 
35
<div class="refsect1">
 
36
<a name="gst-plugins-base-libs-gstaudiofilter.functions"></a><h2>Functions</h2>
 
37
<div class="informaltable"><table width="100%" border="0">
 
38
<colgroup>
 
39
<col width="150px" class="functions_return">
 
40
<col class="functions_name">
 
41
</colgroup>
 
42
<tbody><tr>
 
43
<td class="function_type">
 
44
<span class="returnvalue">void</span>
 
45
</td>
 
46
<td class="function_name">
 
47
<a class="link" href="gst-plugins-base-libs-gstaudiofilter.html#gst-audio-filter-class-add-pad-templates" title="gst_audio_filter_class_add_pad_templates ()">gst_audio_filter_class_add_pad_templates</a> <span class="c_punctuation">()</span>
 
48
</td>
 
49
</tr></tbody>
 
50
</table></div>
 
51
</div>
 
52
<a name="GstAudioFilter"></a><div class="refsect1">
 
53
<a name="gst-plugins-base-libs-gstaudiofilter.other"></a><h2>Types and Values</h2>
 
54
<div class="informaltable"><table width="100%" border="0">
 
55
<colgroup>
 
56
<col width="150px" class="name">
 
57
<col class="description">
 
58
</colgroup>
 
59
<tbody>
 
60
<tr>
 
61
<td class="datatype_keyword">struct</td>
 
62
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstaudiofilter.html#GstAudioFilter-struct" title="struct GstAudioFilter">GstAudioFilter</a></td>
 
63
</tr>
 
64
<tr>
 
65
<td class="datatype_keyword">struct</td>
 
66
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstaudiofilter.html#GstAudioFilterClass" title="struct GstAudioFilterClass">GstAudioFilterClass</a></td>
 
67
</tr>
 
68
</tbody>
 
69
</table></div>
51
70
</div>
52
71
<div class="refsect1">
53
72
<a name="gst-plugins-base-libs-gstaudiofilter.object-hierarchy"></a><h2>Object Hierarchy</h2>
54
 
<pre class="synopsis">
55
 
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
56
 
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
57
 
         +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
58
 
               +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
59
 
                     +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseTransform.html">GstBaseTransform</a>
60
 
                           +----GstAudioFilter
 
73
<pre class="screen">    <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
74
    <span class="lineart">╰──</span> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
 
75
        <span class="lineart">╰──</span> <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
 
76
            <span class="lineart">╰──</span> <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
 
77
                <span class="lineart">╰──</span> <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseTransform.html">GstBaseTransform</a>
 
78
                    <span class="lineart">╰──</span> GstAudioFilter
 
79
</pre>
 
80
</div>
 
81
<div class="refsect1">
 
82
<a name="gst-plugins-base-libs-gstaudiofilter.includes"></a><h2>Includes</h2>
 
83
<pre class="synopsis">#include &lt;gst/audio/gstaudiofilter.h&gt;
61
84
</pre>
62
85
</div>
63
86
<div class="refsect1">
64
87
<a name="gst-plugins-base-libs-gstaudiofilter.description"></a><h2>Description</h2>
65
 
<p>
66
 
<a class="link" href="gst-plugins-base-libs-gstaudiofilter.html#GstAudioFilter"><span class="type">GstAudioFilter</span></a> is a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseTransform.html"><span class="type">GstBaseTransform</span></a>-derived base class for simple audio
67
 
filters, ie. those that output the same format that they get as input.
68
 
</p>
69
 
<p>
70
 
<a class="link" href="gst-plugins-base-libs-gstaudiofilter.html#GstAudioFilter"><span class="type">GstAudioFilter</span></a> will parse the input format for you (with error checking)
 
88
<p><a class="link" href="gst-plugins-base-libs-gstaudiofilter.html#GstAudioFilter"><span class="type">GstAudioFilter</span></a> is a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseTransform.html"><span class="type">GstBaseTransform</span></a>-derived base class for simple audio
 
89
filters, ie. those that output the same format that they get as input.</p>
 
90
<p><a class="link" href="gst-plugins-base-libs-gstaudiofilter.html#GstAudioFilter"><span class="type">GstAudioFilter</span></a> will parse the input format for you (with error checking)
71
91
before calling your setup function. Also, elements deriving from
72
 
<a class="link" href="gst-plugins-base-libs-gstaudiofilter.html#GstAudioFilter"><span class="type">GstAudioFilter</span></a> may use <a class="link" href="gst-plugins-base-libs-gstaudiofilter.html#gst-audio-filter-class-add-pad-templates" title="gst_audio_filter_class_add_pad_templates ()"><code class="function">gst_audio_filter_class_add_pad_templates()</code></a> from
 
92
<a class="link" href="gst-plugins-base-libs-gstaudiofilter.html#GstAudioFilter"><span class="type">GstAudioFilter</span></a> may use <a class="link" href="gst-plugins-base-libs-gstaudiofilter.html#gst-audio-filter-class-add-pad-templates" title="gst_audio_filter_class_add_pad_templates ()"><code class="function">gst_audio_filter_class_add_pad_templates()</code></a> from
73
93
their class_init function to easily configure the set of caps/formats that
74
 
the element is able to handle.
75
 
</p>
76
 
<p>
77
 
Derived classes should override the <a class="link" href="gst-plugins-base-libs-gstaudiofilter.html#GstAudioFilterClass.setup"><code class="function">GstAudioFilterClass.setup()</code></a> and
 
94
the element is able to handle.</p>
 
95
<p>Derived classes should override the <a class="link" href="gst-plugins-base-libs-gstaudiofilter.html#GstAudioFilterClass.setup"><code class="function">GstAudioFilterClass.setup()</code></a> and
78
96
<code class="function">GstBaseTransformClass.transform_ip()</code> and/or
79
97
<code class="function">GstBaseTransformClass.transform()</code>
80
 
virtual functions in their class_init function.
81
 
</p>
82
 
<p>
83
 
Last reviewed on 2007-02-03 (0.10.11.1)
84
 
</p>
85
 
</div>
86
 
<div class="refsect1">
87
 
<a name="gst-plugins-base-libs-gstaudiofilter.details"></a><h2>Details</h2>
 
98
virtual functions in their class_init function.</p>
 
99
<p>Last reviewed on 2007-02-03 (0.10.11.1)</p>
 
100
</div>
 
101
<div class="refsect1">
 
102
<a name="gst-plugins-base-libs-gstaudiofilter.functions_details"></a><h2>Functions</h2>
 
103
<div class="refsect2">
 
104
<a name="gst-audio-filter-class-add-pad-templates"></a><h3>gst_audio_filter_class_add_pad_templates ()</h3>
 
105
<pre class="programlisting"><span class="returnvalue">void</span>
 
106
gst_audio_filter_class_add_pad_templates
 
107
                               (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiofilter.html#GstAudioFilterClass" title="struct GstAudioFilterClass"><span class="type">GstAudioFilterClass</span></a> *klass</code></em>,
 
108
                                <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *allowed_caps</code></em>);</pre>
 
109
<p>Convenience function to add pad templates to this element class, with
 
110
<em class="parameter"><code>allowed_caps</code></em>
 
111
 as the caps that can be handled.</p>
 
112
<p>This function is usually used from within a GObject class_init function.</p>
 
113
<div class="refsect3">
 
114
<a name="id-1.2.6.9.9.2.6"></a><h4>Parameters</h4>
 
115
<div class="informaltable"><table width="100%" border="0">
 
116
<colgroup>
 
117
<col width="150px" class="parameters_name">
 
118
<col class="parameters_description">
 
119
<col width="200px" class="parameters_annotations">
 
120
</colgroup>
 
121
<tbody>
 
122
<tr>
 
123
<td class="parameter_name"><p>klass</p></td>
 
124
<td class="parameter_description"><p>an <a class="link" href="gst-plugins-base-libs-gstaudiofilter.html#GstAudioFilterClass" title="struct GstAudioFilterClass"><span class="type">GstAudioFilterClass</span></a></p></td>
 
125
<td class="parameter_annotations"> </td>
 
126
</tr>
 
127
<tr>
 
128
<td class="parameter_name"><p>allowed_caps</p></td>
 
129
<td class="parameter_description"><p>what formats the filter can handle, as <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a></p></td>
 
130
<td class="parameter_annotations"> </td>
 
131
</tr>
 
132
</tbody>
 
133
</table></div>
 
134
</div>
 
135
</div>
 
136
</div>
 
137
<div class="refsect1">
 
138
<a name="gst-plugins-base-libs-gstaudiofilter.other_details"></a><h2>Types and Values</h2>
88
139
<div class="refsect2">
89
140
<a name="GstAudioFilter-struct"></a><h3>struct GstAudioFilter</h3>
90
141
<pre class="programlisting">struct GstAudioFilter;</pre>
91
 
<p>
92
 
Base class for audio filters with the same format for input and output.
93
 
</p>
 
142
<p>Base class for audio filters with the same format for input and output.</p>
94
143
</div>
95
144
<hr>
96
145
<div class="refsect2">
102
151
  gboolean  (*setup) (GstAudioFilter * filter, const GstAudioInfo * info);
103
152
};
104
153
</pre>
105
 
<p>
106
 
In addition to the <em class="parameter"><code>setup</code></em> virtual function, you should also override the
 
154
<p>In addition to the <em class="parameter"><code>setup</code></em>
 
155
 virtual function, you should also override the
107
156
GstBaseTransform::transform and/or GstBaseTransform::transform_ip virtual
108
 
function.
109
 
</p>
110
 
<div class="variablelist"><table border="0" class="variablelist">
 
157
function.</p>
 
158
<div class="refsect3">
 
159
<a name="id-1.2.6.9.10.3.5"></a><h4>Members</h4>
 
160
<div class="informaltable"><table width="100%" border="0">
111
161
<colgroup>
112
 
<col align="left" valign="top">
113
 
<col>
 
162
<col width="300px" class="struct_members_name">
 
163
<col class="struct_members_description">
 
164
<col width="200px" class="struct_members_annotations">
114
165
</colgroup>
115
166
<tbody>
116
167
<tr>
117
 
<td><p><span class="term"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseTransform.html#GstBaseTransformClass"><span class="type">GstBaseTransformClass</span></a> <em class="structfield"><code><a name="GstAudioFilterClass.basetransformclass"></a>basetransformclass</code></em>;</span></p></td>
118
 
<td>parent class</td>
 
168
<td class="struct_member_name"><p><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseTransform.html#GstBaseTransformClass"><span class="type">GstBaseTransformClass</span></a> <em class="structfield"><code><a name="GstAudioFilterClass.basetransformclass"></a>basetransformclass</code></em>;</p></td>
 
169
<td class="struct_member_description"><p>parent class</p></td>
 
170
<td class="struct_member_annotations"> </td>
119
171
</tr>
120
172
<tr>
121
 
<td><p><span class="term"><em class="structfield"><code><a name="GstAudioFilterClass.setup"></a>setup</code></em> ()</span></p></td>
122
 
<td>virtual function called whenever the format changes</td>
 
173
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstAudioFilterClass.setup"></a>setup</code></em> ()</p></td>
 
174
<td class="struct_member_description"><p>virtual function called whenever the format changes</p></td>
 
175
<td class="struct_member_annotations"> </td>
123
176
</tr>
124
177
</tbody>
125
178
</table></div>
126
179
</div>
127
 
<hr>
128
 
<div class="refsect2">
129
 
<a name="gst-audio-filter-class-add-pad-templates"></a><h3>gst_audio_filter_class_add_pad_templates ()</h3>
130
 
<pre class="programlisting"><span class="returnvalue">void</span>                gst_audio_filter_class_add_pad_templates
131
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstaudiofilter.html#GstAudioFilterClass" title="struct GstAudioFilterClass"><span class="type">GstAudioFilterClass</span></a> *klass</code></em>,
132
 
                                                         <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *allowed_caps</code></em>);</pre>
133
 
<p>
134
 
Convenience function to add pad templates to this element class, with
135
 
<em class="parameter"><code>allowed_caps</code></em> as the caps that can be handled.
136
 
</p>
137
 
<p>
138
 
This function is usually used from within a GObject class_init function.
139
 
</p>
140
 
<div class="variablelist"><table border="0" class="variablelist">
141
 
<colgroup>
142
 
<col align="left" valign="top">
143
 
<col>
144
 
</colgroup>
145
 
<tbody>
146
 
<tr>
147
 
<td><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td>
148
 
<td>an <a class="link" href="gst-plugins-base-libs-gstaudiofilter.html#GstAudioFilterClass" title="struct GstAudioFilterClass"><span class="type">GstAudioFilterClass</span></a>
149
 
</td>
150
 
</tr>
151
 
<tr>
152
 
<td><p><span class="term"><em class="parameter"><code>allowed_caps</code></em> :</span></p></td>
153
 
<td>what formats the filter can handle, as <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a>
154
 
</td>
155
 
</tr>
156
 
</tbody>
157
 
</table></div>
158
180
</div>
159
181
</div>
160
182
</div>
161
183
<div class="footer">
162
184
<hr>
163
 
          Generated by GTK-Doc V1.19</div>
 
185
          Generated by GTK-Doc V1.20</div>
164
186
</body>
165
187
</html>
 
 
b'\\ No newline at end of file'