wearable/docs/libs/html/GstControlSource.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>GstControlSource</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GStreamer 0.10 Library Reference Manual">
   8 <link rel="up" href="gstreamer-control.html" title="GStreamer Dynamic Parameter Control">
   9 <link rel="prev" href="GstController.html" title="GstController">
  10 <link rel="next" href="GstInterpolationControlSource.html" title="GstInterpolationControlSource">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  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="GstController.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="gstreamer-control.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 0.10 Library Reference Manual</th>
  21 <td><a accesskey="n" href="GstInterpolationControlSource.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="#GstControlSource.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GstControlSource.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GstControlSource.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="GstControlSource"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="GstControlSource.top_of_page"></a>GstControlSource</span></h2>
  36 <p>GstControlSource — base class for control source sources</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="GstControlSource.synopsis"></a><h2>Synopsis</h2>
  42 <pre class="synopsis">
  43 #include &lt;libs/controller/gstcontrolsource.h&gt;
  44
  45 struct              <a class="link" href="GstControlSource.html#GstControlSource-struct" title="struct GstControlSource">GstControlSource</a>;
  46 struct              <a class="link" href="GstControlSource.html#GstControlSourceClass" title="struct GstControlSourceClass">GstControlSourceClass</a>;
  47 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            (<a class="link" href="GstControlSource.html#GstControlSourceBind" title="GstControlSourceBind ()">*GstControlSourceBind</a>)             (<em class="parameter"><code><a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a> *self</code></em>,
  48                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> *pspec</code></em>);
  49 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            (<a class="link" href="GstControlSource.html#GstControlSourceGetValue" title="GstControlSourceGetValue ()">*GstControlSourceGetValue</a>)         (<em class="parameter"><code><a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a> *self</code></em>,
  50                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> timestamp</code></em>,
  51                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);
  52 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            (<a class="link" href="GstControlSource.html#GstControlSourceGetValueArray" title="GstControlSourceGetValueArray ()">*GstControlSourceGetValueArray</a>)    (<em class="parameter"><code><a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a> *self</code></em>,
  53                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> timestamp</code></em>,
  54                                                          <em class="parameter"><code><a class="link" href="GstControlSource.html#GstValueArray" title="struct GstValueArray"><span class="type">GstValueArray</span></a> *value_array</code></em>);
  55 struct              <a class="link" href="GstControlSource.html#GstTimedValue" title="struct GstTimedValue">GstTimedValue</a>;
  56 struct              <a class="link" href="GstControlSource.html#GstValueArray" title="struct GstValueArray">GstValueArray</a>;
  57 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GstControlSource.html#gst-control-source-bind" title="gst_control_source_bind ()">gst_control_source_bind</a>             (<em class="parameter"><code><a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a> *self</code></em>,
  58                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> *pspec</code></em>);
  59 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GstControlSource.html#gst-control-source-get-value" title="gst_control_source_get_value ()">gst_control_source_get_value</a>        (<em class="parameter"><code><a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a> *self</code></em>,
  60                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> timestamp</code></em>,
  61                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);
  62 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GstControlSource.html#gst-control-source-get-value-array" title="gst_control_source_get_value_array ()">gst_control_source_get_value_array</a>  (<em class="parameter"><code><a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a> *self</code></em>,
  63                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> timestamp</code></em>,
  64                                                          <em class="parameter"><code><a class="link" href="GstControlSource.html#GstValueArray" title="struct GstValueArray"><span class="type">GstValueArray</span></a> *value_array</code></em>);
  65 </pre>
  66 </div>
  67 <div class="refsect1">
  68 <a name="GstControlSource.object-hierarchy"></a><h2>Object Hierarchy</h2>
  69 <pre class="synopsis">
  70   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  71    +----GstControlSource
  72          +----<a class="link" href="GstInterpolationControlSource.html" title="GstInterpolationControlSource">GstInterpolationControlSource</a>
  73          +----<a class="link" href="GstLFOControlSource.html" title="GstLFOControlSource">GstLFOControlSource</a>
  74 </pre>
  75 </div>
  76 <div class="refsect1">
  77 <a name="GstControlSource.description"></a><h2>Description</h2>
  78 <p>
  79 The <a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a> is a base class for control value sources that could
  80 be used by <a class="link" href="GstController.html" title="GstController"><span class="type">GstController</span></a> to get timestamp-value pairs.
  81 </p>
  82 <p>
  83 A <a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a> is used by first getting an instance, binding it to a
  84 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> (for example by using <a class="link" href="GstController.html#gst-controller-set-control-source" title="gst_controller_set_control_source ()"><code class="function">gst_controller_set_control_source()</code></a>) and
  85 then by having it used by the <a class="link" href="GstController.html" title="GstController"><span class="type">GstController</span></a> or calling
  86 <a class="link" href="GstControlSource.html#gst-control-source-get-value" title="gst_control_source_get_value ()"><code class="function">gst_control_source_get_value()</code></a> or <a class="link" href="GstControlSource.html#gst-control-source-get-value-array" title="gst_control_source_get_value_array ()"><code class="function">gst_control_source_get_value_array()</code></a>.
  87 </p>
  88 <p>
  89 For implementing a new <a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a> one has to implement a
  90 <a class="link" href="GstControlSource.html#GstControlSourceBind" title="GstControlSourceBind ()"><span class="type">GstControlSourceBind</span></a> method, which will depending on the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> set up
  91 the control source for use and sets the <a class="link" href="GstControlSource.html#GstControlSourceGetValue" title="GstControlSourceGetValue ()"><span class="type">GstControlSourceGetValue</span></a> and
  92 <a class="link" href="GstControlSource.html#GstControlSourceGetValueArray" title="GstControlSourceGetValueArray ()"><span class="type">GstControlSourceGetValueArray</span></a> functions. These are then used by
  93 <a class="link" href="GstControlSource.html#gst-control-source-get-value" title="gst_control_source_get_value ()"><code class="function">gst_control_source_get_value()</code></a> or <a class="link" href="GstControlSource.html#gst-control-source-get-value-array" title="gst_control_source_get_value_array ()"><code class="function">gst_control_source_get_value_array()</code></a>
  94 to get values for specific timestamps.
  95 </p>
  96 </div>
  97 <div class="refsect1">
  98 <a name="GstControlSource.details"></a><h2>Details</h2>
  99 <div class="refsect2">
 100 <a name="GstControlSource-struct"></a><h3>struct GstControlSource</h3>
 101 <pre class="programlisting">struct GstControlSource {
 102   GstControlSourceGetValue get_value;             /* Returns the value for a property at a given timestamp */
 103   GstControlSourceGetValueArray get_value_array;  /* Returns values for a property in a given timespan */
 104 };
 105 </pre>
 106 <p>
 107 The instance structure of <a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a>.
 108 </p>
 109 <div class="variablelist"><table border="0">
 110 <col align="left" valign="top">
 111 <tbody>
 112 <tr>
 113 <td><p><span class="term"><a class="link" href="GstControlSource.html#GstControlSourceGetValue" title="GstControlSourceGetValue ()"><span class="type">GstControlSourceGetValue</span></a> <em class="structfield"><code><a name="GstControlSource-struct.get-value"></a>get_value</code></em>;</span></p></td>
 114 <td>Function for returning a value for a given timestamp</td>
 115 </tr>
 116 <tr>
 117 <td><p><span class="term"><a class="link" href="GstControlSource.html#GstControlSourceGetValueArray" title="GstControlSourceGetValueArray ()"><span class="type">GstControlSourceGetValueArray</span></a> <em class="structfield"><code><a name="GstControlSource-struct.get-value-array"></a>get_value_array</code></em>;</span></p></td>
 118 <td>Function for returning a <a class="link" href="GstControlSource.html#GstValueArray" title="struct GstValueArray"><span class="type">GstValueArray</span></a> for a given timestamp</td>
 119 </tr>
 120 </tbody>
 121 </table></div>
 122 </div>
 123 <hr>
 124 <div class="refsect2">
 125 <a name="GstControlSourceClass"></a><h3>struct GstControlSourceClass</h3>
 126 <pre class="programlisting">struct GstControlSourceClass {
 127   GObjectClass parent_class;
 128
 129   GstControlSourceBind bind;  /* Binds the GstControlSource to a specific GParamSpec */
 130 };
 131 </pre>
 132 <p>
 133 The class structure of <a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a>.
 134 </p>
 135 <div class="variablelist"><table border="0">
 136 <col align="left" valign="top">
 137 <tbody>
 138 <tr>
 139 <td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="GstControlSourceClass.parent-class"></a>parent_class</code></em>;</span></p></td>
 140 <td>Parent class</td>
 141 </tr>
 142 <tr>
 143 <td><p><span class="term"><a class="link" href="GstControlSource.html#GstControlSourceBind" title="GstControlSourceBind ()"><span class="type">GstControlSourceBind</span></a> <em class="structfield"><code><a name="GstControlSourceClass.bind"></a>bind</code></em>;</span></p></td>
 144 <td>Class method for binding the <a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a> to a specific GParamSpec</td>
 145 </tr>
 146 </tbody>
 147 </table></div>
 148 </div>
 149 <hr>
 150 <div class="refsect2">
 151 <a name="GstControlSourceBind"></a><h3>GstControlSourceBind ()</h3>
 152 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            (*GstControlSourceBind)             (<em class="parameter"><code><a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a> *self</code></em>,
 153                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> *pspec</code></em>);</pre>
 154 <p>
 155 Function for binding a <a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a> to a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a>.
 156 </p>
 157 <div class="variablelist"><table border="0">
 158 <col align="left" valign="top">
 159 <tbody>
 160 <tr>
 161 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 162 <td>the <a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a> instance</td>
 163 </tr>
 164 <tr>
 165 <td><p><span class="term"><em class="parameter"><code>pspec</code></em> :</span></p></td>
 166 <td>
 167 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> that should be bound to</td>
 168 </tr>
 169 <tr>
 170 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 171 <td>
 172 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the property could be bound to the <a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a>, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
 173 </tr>
 174 </tbody>
 175 </table></div>
 176 </div>
 177 <hr>
 178 <div class="refsect2">
 179 <a name="GstControlSourceGetValue"></a><h3>GstControlSourceGetValue ()</h3>
 180 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            (*GstControlSourceGetValue)         (<em class="parameter"><code><a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a> *self</code></em>,
 181                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> timestamp</code></em>,
 182                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
 183 <p>
 184 Function for returning a value for a given timestamp.
 185 </p>
 186 <div class="variablelist"><table border="0">
 187 <col align="left" valign="top">
 188 <tbody>
 189 <tr>
 190 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 191 <td>the <a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a> instance</td>
 192 </tr>
 193 <tr>
 194 <td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
 195 <td>timestamp for which a value should be calculated</td>
 196 </tr>
 197 <tr>
 198 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 199 <td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> which will be set to the result. It must be initialized to the correct type.</td>
 200 </tr>
 201 <tr>
 202 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 203 <td>
 204 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the value was successfully calculated.</td>
 205 </tr>
 206 </tbody>
 207 </table></div>
 208 </div>
 209 <hr>
 210 <div class="refsect2">
 211 <a name="GstControlSourceGetValueArray"></a><h3>GstControlSourceGetValueArray ()</h3>
 212 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            (*GstControlSourceGetValueArray)    (<em class="parameter"><code><a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a> *self</code></em>,
 213                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> timestamp</code></em>,
 214                                                          <em class="parameter"><code><a class="link" href="GstControlSource.html#GstValueArray" title="struct GstValueArray"><span class="type">GstValueArray</span></a> *value_array</code></em>);</pre>
 215 <p>
 216 Function for returning a <a class="link" href="GstControlSource.html#GstValueArray" title="struct GstValueArray"><span class="type">GstValueArray</span></a> for a given timestamp.
 217 </p>
 218 <div class="variablelist"><table border="0">
 219 <col align="left" valign="top">
 220 <tbody>
 221 <tr>
 222 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 223 <td>the <a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a> instance</td>
 224 </tr>
 225 <tr>
 226 <td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
 227 <td>timestamp for which a value should be calculated</td>
 228 </tr>
 229 <tr>
 230 <td><p><span class="term"><em class="parameter"><code>value_array</code></em> :</span></p></td>
 231 <td>array to put control-values in</td>
 232 </tr>
 233 <tr>
 234 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 235 <td>
 236 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the values were successfully calculated.</td>
 237 </tr>
 238 </tbody>
 239 </table></div>
 240 </div>
 241 <hr>
 242 <div class="refsect2">
 243 <a name="GstTimedValue"></a><h3>struct GstTimedValue</h3>
 244 <pre class="programlisting">struct GstTimedValue {
 245   GstClockTime timestamp;
 246   GValue value;
 247 };
 248 </pre>
 249 <p>
 250 Structure for saving a timestamp and a value.
 251 </p>
 252 <div class="variablelist"><table border="0">
 253 <col align="left" valign="top">
 254 <tbody>
 255 <tr>
 256 <td><p><span class="term"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> <em class="structfield"><code><a name="GstTimedValue.timestamp"></a>timestamp</code></em>;</span></p></td>
 257 <td>timestamp of the value change</td>
 258 </tr>
 259 <tr>
 260 <td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> <em class="structfield"><code><a name="GstTimedValue.value"></a>value</code></em>;</span></p></td>
 261 <td>the corresponding value</td>
 262 </tr>
 263 </tbody>
 264 </table></div>
 265 </div>
 266 <hr>
 267 <div class="refsect2">
 268 <a name="GstValueArray"></a><h3>struct GstValueArray</h3>
 269 <pre class="programlisting">struct GstValueArray {
 270   const gchar *property_name;
 271   gint nbsamples;
 272   GstClockTime sample_interval;
 273   gpointer *values;
 274 };
 275 </pre>
 276 <p>
 277 Structure to receive multiple values at once.
 278 </p>
 279 <div class="variablelist"><table border="0">
 280 <col align="left" valign="top">
 281 <tbody>
 282 <tr>
 283 <td><p><span class="term">const <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="GstValueArray.property-name"></a>property_name</code></em>;</span></p></td>
 284 <td>the name of the property this array belongs to</td>
 285 </tr>
 286 <tr>
 287 <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="GstValueArray.nbsamples"></a>nbsamples</code></em>;</span></p></td>
 288 <td>number of samples requested</td>
 289 </tr>
 290 <tr>
 291 <td><p><span class="term"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> <em class="structfield"><code><a name="GstValueArray.sample-interval"></a>sample_interval</code></em>;</span></p></td>
 292 <td>interval between each sample</td>
 293 </tr>
 294 <tr>
 295 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> *<em class="structfield"><code><a name="GstValueArray.values"></a>values</code></em>;</span></p></td>
 296 <td>pointer to the array</td>
 297 </tr>
 298 </tbody>
 299 </table></div>
 300 </div>
 301 <hr>
 302 <div class="refsect2">
 303 <a name="gst-control-source-bind"></a><h3>gst_control_source_bind ()</h3>
 304 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gst_control_source_bind             (<em class="parameter"><code><a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a> *self</code></em>,
 305                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> *pspec</code></em>);</pre>
 306 <p>
 307 Binds a <a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a> to a specific property. This must be called only once for a
 308 <a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a>.
 309 </p>
 310 <div class="variablelist"><table border="0">
 311 <col align="left" valign="top">
 312 <tbody>
 313 <tr>
 314 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 315 <td>the <a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a> object</td>
 316 </tr>
 317 <tr>
 318 <td><p><span class="term"><em class="parameter"><code>pspec</code></em> :</span></p></td>
 319 <td>
 320 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> for the property for which this <a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a> should generate values.</td>
 321 </tr>
 322 <tr>
 323 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 324 <td>
 325 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the <a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a> was bound correctly, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
 326 </tr>
 327 </tbody>
 328 </table></div>
 329 </div>
 330 <hr>
 331 <div class="refsect2">
 332 <a name="gst-control-source-get-value"></a><h3>gst_control_source_get_value ()</h3>
 333 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gst_control_source_get_value        (<em class="parameter"><code><a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a> *self</code></em>,
 334                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> timestamp</code></em>,
 335                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
 336 <p>
 337 Gets the value for this <a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a> at a given timestamp.
 338 </p>
 339 <div class="variablelist"><table border="0">
 340 <col align="left" valign="top">
 341 <tbody>
 342 <tr>
 343 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 344 <td>the <a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a> object</td>
 345 </tr>
 346 <tr>
 347 <td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
 348 <td>the time for which the value should be returned</td>
 349 </tr>
 350 <tr>
 351 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 352 <td>the value</td>
 353 </tr>
 354 <tr>
 355 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 356 <td>FALSE if the value couldn't be returned, TRUE otherwise.</td>
 357 </tr>
 358 </tbody>
 359 </table></div>
 360 </div>
 361 <hr>
 362 <div class="refsect2">
 363 <a name="gst-control-source-get-value-array"></a><h3>gst_control_source_get_value_array ()</h3>
 364 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gst_control_source_get_value_array  (<em class="parameter"><code><a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a> *self</code></em>,
 365                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> timestamp</code></em>,
 366                                                          <em class="parameter"><code><a class="link" href="GstControlSource.html#GstValueArray" title="struct GstValueArray"><span class="type">GstValueArray</span></a> *value_array</code></em>);</pre>
 367 <p>
 368 Gets an array of values for one element property.
 369 </p>
 370 <p>
 371 All fields of <em class="parameter"><code>value_array</code></em> must be filled correctly. Especially the
 372 <em class="parameter"><code>value_array-&gt;values</code></em> array must be big enough to keep the requested amount
 373 of values.
 374 </p>
 375 <p>
 376 The type of the values in the array is the same as the property's type.
 377 </p>
 378 <div class="variablelist"><table border="0">
 379 <col align="left" valign="top">
 380 <tbody>
 381 <tr>
 382 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 383 <td>the <a class="link" href="GstControlSource.html" title="GstControlSource"><span class="type">GstControlSource</span></a> object</td>
 384 </tr>
 385 <tr>
 386 <td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
 387 <td>the time that should be processed</td>
 388 </tr>
 389 <tr>
 390 <td><p><span class="term"><em class="parameter"><code>value_array</code></em> :</span></p></td>
 391 <td>array to put control-values in</td>
 392 </tr>
 393 <tr>
 394 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 395 <td>
 396 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the given array could be filled, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>
 397 </tr>
 398 </tbody>
 399 </table></div>
 400 </div>
 401 </div>
 402 </div>
 403 <div class="footer">
 404 <hr>
 405           Generated by GTK-Doc V1.18</div>
 406 </body>
 407 </html>