1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>gsttunerchannel</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Library Reference Manual">
8 <link rel="up" href="gstreamer-interfaces.html" title="Interfaces Library">
9 <link rel="prev" href="gst-plugins-base-libs-gsttuner.html" title="gsttuner">
10 <link rel="next" href="gst-plugins-base-libs-gsttunernorm.html" title="gsttunernorm">
11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
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">
17 <td><a accesskey="p" href="gst-plugins-base-libs-gsttuner.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="gstreamer-interfaces.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 0.10 Library Reference Manual</th>
21 <td><a accesskey="n" href="gst-plugins-base-libs-gsttunernorm.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#gst-plugins-base-libs-gsttunerchannel.synopsis" class="shortcut">Top</a>
26 <a href="#gst-plugins-base-libs-gsttunerchannel.description" class="shortcut">Description</a>
28 <a href="#gst-plugins-base-libs-gsttunerchannel.object-hierarchy" class="shortcut">Object Hierarchy</a>
30 <a href="#gst-plugins-base-libs-gsttunerchannel.signals" class="shortcut">Signals</a>
33 <div class="refentry">
34 <a name="gst-plugins-base-libs-gsttunerchannel"></a><div class="titlepage"></div>
35 <div class="refnamediv"><table width="100%"><tr>
37 <h2><span class="refentrytitle"><a name="gst-plugins-base-libs-gsttunerchannel.top_of_page"></a>gsttunerchannel</span></h2>
38 <p>gsttunerchannel — A channel from an element implementing the <a class="link" href="gst-plugins-base-libs-gsttuner.html#GstTuner"><span class="type">GstTuner</span></a>
41 <td valign="top" align="right"></td>
43 <div class="refsynopsisdiv">
44 <a name="gst-plugins-base-libs-gsttunerchannel.synopsis"></a><h2>Synopsis</h2>
45 <a name="GstTunerChannel"></a><pre class="synopsis">
46 #include <gst/interfaces/tuner.h>
48 struct <a class="link" href="gst-plugins-base-libs-gsttunerchannel.html#GstTunerChannel-struct" title="struct GstTunerChannel">GstTunerChannel</a>;
49 enum <a class="link" href="gst-plugins-base-libs-gsttunerchannel.html#GstTunerChannelFlags" title="enum GstTunerChannelFlags">GstTunerChannelFlags</a>;
50 #define <a class="link" href="gst-plugins-base-libs-gsttunerchannel.html#GST-TUNER-CHANNEL-HAS-FLAG:CAPS" title="GST_TUNER_CHANNEL_HAS_FLAG()">GST_TUNER_CHANNEL_HAS_FLAG</a> (channel,
54 <div class="refsect1">
55 <a name="gst-plugins-base-libs-gsttunerchannel.object-hierarchy"></a><h2>Object Hierarchy</h2>
56 <pre class="synopsis">
57 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
61 <div class="refsect1">
62 <a name="gst-plugins-base-libs-gsttunerchannel.signals"></a><h2>Signals</h2>
63 <pre class="synopsis">
64 "<a class="link" href="gst-plugins-base-libs-gsttunerchannel.html#GstTunerChannel-frequency-changed" title='The "frequency-changed" signal'>frequency-changed</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
65 "<a class="link" href="gst-plugins-base-libs-gsttunerchannel.html#GstTunerChannel-signal-changed" title='The "signal-changed" signal'>signal-changed</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
68 <div class="refsect1">
69 <a name="gst-plugins-base-libs-gsttunerchannel.description"></a><h2>Description</h2>
72 <div class="refsect2">
73 <a name="idp7342944"></a><p>The <a class="link" href="gst-plugins-base-libs-gsttunerchannel.html#GstTunerChannel"><span class="type">GstTunerChannel</span></a> object is provided by an element implementing
74 the <a class="link" href="gst-plugins-base-libs-gsttuner.html#GstTuner"><span class="type">GstTuner</span></a> interface.
77 GstTunerChannel provides a name and flags to determine the type and
78 capabilities of the channel. If the GST_TUNER_CHANNEL_FREQUENCY flag is
79 set, then the channel also information about the minimum and maximum
80 frequency, and range of the reported signal strength.
86 <div class="refsect1">
87 <a name="gst-plugins-base-libs-gsttunerchannel.details"></a><h2>Details</h2>
88 <div class="refsect2">
89 <a name="GstTunerChannel-struct"></a><h3>struct GstTunerChannel</h3>
90 <pre class="programlisting">struct GstTunerChannel {
92 GstTunerChannelFlags flags;
93 gfloat freq_multiplicator;
100 <div class="variablelist"><table border="0">
101 <col align="left" valign="top">
104 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GstTunerChannel-struct.label"></a>label</code></em>;</span></p></td>
105 <td>A string containing a descriptive name for this channel</td>
108 <td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gsttunerchannel.html#GstTunerChannelFlags" title="enum GstTunerChannelFlags"><span class="type">GstTunerChannelFlags</span></a> <em class="structfield"><code><a name="GstTunerChannel-struct.flags"></a>flags</code></em>;</span></p></td>
109 <td>A set of <a class="link" href="gst-plugins-base-libs-gsttunerchannel.html#GstTunerChannelFlags" title="enum GstTunerChannelFlags"><span class="type">GstTunerChannelFlags</span></a> for this channel</td>
112 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> <em class="structfield"><code><a name="GstTunerChannel-struct.freq-multiplicator"></a>freq_multiplicator</code></em>;</span></p></td>
113 <td>The step size (in Hz) for the frequency setting.</td>
116 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> <em class="structfield"><code><a name="GstTunerChannel-struct.min-frequency"></a>min_frequency</code></em>;</span></p></td>
117 <td>Minimum valid frequency setting (in Hz).</td>
120 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> <em class="structfield"><code><a name="GstTunerChannel-struct.max-frequency"></a>max_frequency</code></em>;</span></p></td>
121 <td>Maximum valid frequency setting (in Hz).</td>
124 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstTunerChannel-struct.min-signal"></a>min_signal</code></em>;</span></p></td>
125 <td>Minimum reported signal strength value.</td>
128 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstTunerChannel-struct.max-signal"></a>max_signal</code></em>;</span></p></td>
129 <td>Maximum reported signal strength value.</td>
135 <div class="refsect2">
136 <a name="GstTunerChannelFlags"></a><h3>enum GstTunerChannelFlags</h3>
137 <pre class="programlisting">typedef enum {
138 GST_TUNER_CHANNEL_INPUT = (1<<0),
139 GST_TUNER_CHANNEL_OUTPUT = (1<<1),
140 GST_TUNER_CHANNEL_FREQUENCY = (1<<2),
141 GST_TUNER_CHANNEL_AUDIO = (1<<3)
142 } GstTunerChannelFlags;
145 An enumeration for flags indicating the available capabilities
146 of a <a class="link" href="gst-plugins-base-libs-gsttunerchannel.html#GstTunerChannel"><span class="type">GstTunerChannel</span></a>.
148 <div class="variablelist"><table border="0">
149 <col align="left" valign="top">
152 <td><p><a name="GST-TUNER-CHANNEL-INPUT:CAPS"></a><span class="term"><code class="literal">GST_TUNER_CHANNEL_INPUT</code></span></p></td>
153 <td>The channel is for input
157 <td><p><a name="GST-TUNER-CHANNEL-OUTPUT:CAPS"></a><span class="term"><code class="literal">GST_TUNER_CHANNEL_OUTPUT</code></span></p></td>
158 <td>The channel is for output
162 <td><p><a name="GST-TUNER-CHANNEL-FREQUENCY:CAPS"></a><span class="term"><code class="literal">GST_TUNER_CHANNEL_FREQUENCY</code></span></p></td>
163 <td>The channel has a frequency setting
168 <td><p><a name="GST-TUNER-CHANNEL-AUDIO:CAPS"></a><span class="term"><code class="literal">GST_TUNER_CHANNEL_AUDIO</code></span></p></td>
169 <td>The channel carries audio.
176 <div class="refsect2">
177 <a name="GST-TUNER-CHANNEL-HAS-FLAG:CAPS"></a><h3>GST_TUNER_CHANNEL_HAS_FLAG()</h3>
178 <pre class="programlisting">#define GST_TUNER_CHANNEL_HAS_FLAG(channel, flag)</pre>
180 Macro to check if the given flag is set on a channel
182 <div class="variablelist"><table border="0">
183 <col align="left" valign="top">
186 <td><p><span class="term"><em class="parameter"><code>channel</code></em> :</span></p></td>
187 <td>A <a class="link" href="gst-plugins-base-libs-gsttunerchannel.html#GstTunerChannel"><span class="type">GstTunerChannel</span></a>
191 <td><p><span class="term"><em class="parameter"><code>flag</code></em> :</span></p></td>
192 <td>The flag to check for</td>
198 <div class="refsect1">
199 <a name="gst-plugins-base-libs-gsttunerchannel.signal-details"></a><h2>Signal Details</h2>
200 <div class="refsect2">
201 <a name="GstTunerChannel-frequency-changed"></a><h3>The <code class="literal">"frequency-changed"</code> signal</h3>
202 <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="gst-plugins-base-libs-gsttunerchannel.html#GstTunerChannel"><span class="type">GstTunerChannel</span></a> *tunerchannel,
203 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> frequency,
204 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
206 Reports that the current frequency has changed.
208 <div class="variablelist"><table border="0">
209 <col align="left" valign="top">
212 <td><p><span class="term"><em class="parameter"><code>tunerchannel</code></em> :</span></p></td>
213 <td>The <a class="link" href="gst-plugins-base-libs-gsttunerchannel.html#GstTunerChannel"><span class="type">GstTunerChannel</span></a>
217 <td><p><span class="term"><em class="parameter"><code>frequency</code></em> :</span></p></td>
218 <td>The new frequency (an unsigned long)</td>
221 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
222 <td>user data set when the signal handler was connected.</td>
228 <div class="refsect2">
229 <a name="GstTunerChannel-signal-changed"></a><h3>The <code class="literal">"signal-changed"</code> signal</h3>
230 <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="gst-plugins-base-libs-gsttunerchannel.html#GstTunerChannel"><span class="type">GstTunerChannel</span></a> *tunerchannel,
231 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> signal,
232 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
234 Reports that the signal strength has changed.
237 See Also: <a class="link" href="gst-plugins-base-libs-gsttuner.html#gst-tuner-signal-strength" title="gst_tuner_signal_strength ()"><code class="function">gst_tuner_signal_strength()</code></a>
239 <div class="variablelist"><table border="0">
240 <col align="left" valign="top">
243 <td><p><span class="term"><em class="parameter"><code>tunerchannel</code></em> :</span></p></td>
244 <td>The <a class="link" href="gst-plugins-base-libs-gsttunerchannel.html#GstTunerChannel"><span class="type">GstTunerChannel</span></a>
248 <td><p><span class="term"><em class="parameter"><code>signal</code></em> :</span></p></td>
249 <td>The new signal strength (an integer)</td>
252 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
253 <td>user data set when the signal handler was connected.</td>
262 Generated by GTK-Doc V1.18</div>